/usr/include/tulip/PluginLibraryLoader.h is in libtulip-dev 4.4.0dfsg2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | /*
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
#ifndef PLUGINLIBLOADER_H
#define PLUGINLIBLOADER_H
#ifndef DOXYGEN_NOTFOR_USER
#include <set>
#include <string>
#include <tulip/tulipconf.h>
namespace tlp {
struct PluginLoader;
/**
* @ingroup Plugins
*
* @brief This class takes care of the actual loading of the libraries.
* You can use it to load a single plugin (loadPluginLibrary) or all the plugins in a given folder (loadPlugins).0
*
* It is a singleton to guarantee the currentPluginLibrary member is initialized, but it only shows static functions for syntactic sugar.
**/
class TLP_SCOPE PluginLibraryLoader {
public:
#ifndef EMSCRIPTEN
/**
* @brief Loads all the plugins in each directory contained in TulipPluginsPath.
* This function will not look into subfolders of the specified folder.
*
*
* To load all the plugins in the following example, you need to call this function once for the lib/tulip folder,
* once for the glyph folder, and once for the interactors folder.
*
* lib/tulip/
* -> glyphs
* |-> libBillboard-4.0.0.so
* |-> libWindow-4.0.0.so
* -> interactors
* |-> libInteractorAddEdge-4.0.0.so
* |-> libInteractorSelectionModifier-4.0.0.so
* -> libAdjacencyMatrixImport-4.0.0.so
* -> libColorMapping-4.0.0.so
* -> libCompleteGraph-4.0.0.so
*
*
* @param loader A PluginLoader to output what is going on. Defaults to 0.
* @param pluginPath A folder to append to each path in TulipPluginsPath (e.g. "glyphs/")
*
**/
static void loadPlugins(PluginLoader *loader = NULL, std::string pluginPath = "");
/**
* @brief Loads a single plugin library.
*
* @param filename The name of the plugin file to load.
* @param loader A loader to report what is going on (only its loaded or aborted functions will be called) Defaults to 0.
* @return bool Whether the plugin was sucessfully loaded.
**/
static bool loadPluginLibrary(const std::string & filename, PluginLoader *loader = NULL);
#endif //EMSCRIPTEN
/**
* @brief Gets the name of the plug-in library being loaded.
* If the plugin is statically linked into the tulip library, returns an empty string.
*
* @return :string& The name of the plugin library being loaded.
**/
static const std::string& getCurrentPluginFileName() {
return getInstance()->currentPluginLibrary;
}
private:
PluginLibraryLoader() {}
#ifndef EMSCRIPTEN
bool loadNextPluginLibrary(PluginLoader *loader);
bool initPluginDir(PluginLoader *loader);
#endif
static PluginLibraryLoader* getInstance() {
if(_instance == NULL) {
_instance = new PluginLibraryLoader();
}
return _instance;
}
static PluginLibraryLoader* _instance;
std::string message;
std::string pluginPath;
std::string currentPluginLibrary;
};
}
#endif //DOXYGEN_NOTFOR_USER
#endif //PLUGINLIBLOADER_H
|