Tulip  4.0.0
Better Visualization Through Research
 All Classes Files Functions Variables Enumerations Enumerator Properties Groups Pages
TlpTools.h
1 /*
2  *
3  * This file is part of Tulip (www.tulip-software.org)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip 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.
16  * See the GNU General Public License for more details.
17  *
18  */
19 
20 #ifndef _TLPTOOLS_H
21 #define _TLPTOOLS_H
22 
23 #include <iostream>
24 #include <tulip/tulipconf.h>
25 
26 namespace tlp {
27 extern TLP_SCOPE const char PATH_DELIMITER;
28 extern TLP_SCOPE std::string TulipLibDir;
29 extern TLP_SCOPE std::string TulipPluginsPath;
30 extern TLP_SCOPE std::string TulipDocProfile;
31 extern TLP_SCOPE std::string TulipUserHandBookIndex;
32 extern TLP_SCOPE std::string TulipBitmapDir;
33 extern TLP_SCOPE std::string TulipShareDir;
34 
35 /**
36  * @ingroup Plugins
37  *
38  * @brief Initializes the Tulip library.
39  * Looks for the Tulip plug-ins directory, and loads the plug-ins from it.
40  * The plug-ins directory can be defined in different ways, given by order of prevalence :
41  * 1. the TLP_DIR environment variable, if it has a value
42  * 2. the appDirPath parameter, if it is not NULL
43  * 3. a fallback value of 'C:/Tulip/lib/' on windows, or '/usr/local/lib/' on unices.
44  */
45 extern TLP_SCOPE void initTulipLib(const char* appDirPath = NULL);
46 
47 /**
48  * @ingroup Plugins
49  *
50  * @brief Demangles the name of a C++ class defined in the tlp namespace.
51  * Simply removes the 'tlp::' prefix from the class name.
52  * @return string The demangled name of a Tulip C++ class.
53  */
54 TLP_SCOPE std::string demangleTlpClassName(const char *className);
55 
56 }
57 
58 #endif