swg_utils.h
Go to the documentation of this file.
1 /** @file swg_utils.h utility functions for bindings*/
2 
3 /* FAU Discrete Event Systems Library (libfaudes)
4 
5  Copyright (C) 2008-2025 Thomas Moor
6  Exclusive copyright is granted to Klaus Schmidt
7 
8  This library is free software; you can redistribute it and/or
9  modify it under the terms of the GNU Lesser General Public
10  License as published by the Free Software Foundation; either
11  version 2.1 of the License, or (at your option) any later version.
12 
13  This library is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  Lesser General Public License for more details.
17 
18  You should have received a copy of the GNU Lesser General Public
19  License along with this library; if not, write to the Free Software
20  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 
22 */
23 
24 #ifndef FAUDES_SWGUTILS_H
25 #define FAUDES_SWGUTILS_H
26 
27 #include "cfl_definitions.h"
28 #include "cfl_utils.h"
29 #include "cfl_generator.h"
30 
31 namespace faudes {
32 
33 // programatically throw exceptions
34 extern FAUDES_API void faudes_throw_exception(const std::string& msg);
35 
36 // behavioural features
37 extern FAUDES_API void faudes_statenames_on(void);
38 extern FAUDES_API void faudes_statenames_off(void);
39 extern FAUDES_API void faudes_dotexecpath(const std::string& filename);
40 extern FAUDES_API std::string faudes_dotexecpath();
41 extern FAUDES_API std::string faudes_version(void);
42 extern FAUDES_API std::string faudes_build(void);
43 extern FAUDES_API bool faudes_dotready(void);
44 
45 // help: insert topic to dictionary
46 extern FAUDES_API void faudes_dict_insert_topic(const std::string& topic, const std::string& text);
47 
48 // help: insert entry to dictionary
49 extern FAUDES_API void faudes_dict_insert_entry(const std::string& topic, const std::string& key, const std::string& entry);
50 
51 // help: show main text
52 extern FAUDES_API void faudes_help(void);
53 
54 // help: show section text
55 extern FAUDES_API void faudes_help(const std::string& topic);
56 
57 // API wrappers
58 extern FAUDES_API void faudes_gen_version(const Generator& rGen, const std::string& ver, Generator& rRes);
59 extern FAUDES_API void faudes_gen_version(const Generator& rGen, const std::string& pat, const std::string& rep, Generator& rRes);
60 extern FAUDES_API void faudes_set_union(const EventSet& rAlph1, const EventSet& rAlph2, EventSet& rRes);
61 extern FAUDES_API void faudes_set_intersection(const EventSet& rAlph1, const EventSet& rAlph2, EventSet& rRes);
62 extern FAUDES_API void faudes_set_difference(const EventSet& rAlph1, const EventSet& rAlph2, EventSet& rRes);
63 
64 
65 
66 
67 }//namespace
68 
69 #endif // .h
#define FAUDES_API
Definition: cfl_platform.h:80
NameSet EventSet
Definition: cfl_nameset.h:534
vGenerator Generator
void faudes_gen_version(const Generator &rGen, const std::string &ver, Generator &rRes)
Definition: swg_utils.cpp:160
void faudes_help(void)
Definition: swg_utils.cpp:82
void faudes_set_union(const EventSet &rAlph1, const EventSet &rAlph2, EventSet &rRes)
Definition: swg_utils.cpp:166
std::string faudes_version(void)
Definition: swg_utils.cpp:44
void faudes_set_intersection(const EventSet &rAlph1, const EventSet &rAlph2, EventSet &rRes)
Definition: swg_utils.cpp:168
void faudes_dotexecpath(const std::string &filename)
Definition: swg_utils.cpp:42
void faudes_statenames_on(void)
Definition: swg_utils.cpp:40
void faudes_dict_insert_topic(const std::string &topic, const std::string &text)
Definition: swg_utils.cpp:65
std::string faudes_build(void)
Definition: swg_utils.cpp:45
void faudes_statenames_off(void)
Definition: swg_utils.cpp:41
void faudes_dict_insert_entry(const std::string &topic, const std::string &key, const std::string &entry)
Definition: swg_utils.cpp:70
bool faudes_dotready(void)
Definition: swg_utils.cpp:48
void faudes_throw_exception(const std::string &msg)
Definition: swg_utils.cpp:30
void faudes_set_difference(const EventSet &rAlph1, const EventSet &rAlph2, EventSet &rRes)
Definition: swg_utils.cpp:170

libFAUDES 2.33h --- 2025.06.18 --- c++ api documentaion by doxygen