TlpTools.h File Reference

#include <iostream>
#include "tulip/tulipconf.h"
#include "tulip/PluginLoader.h"

Include dependency graph for TlpTools.h:

This graph shows which files directly or indirectly include this file:

Namespaces

• namespace tlp

Functions

• TLP_SCOPE void tlp::initTulipLib (char *appDirPath=0)

  Initializes the Tulip library. Looks for the Tulip plug-ins directory, and loads the plug-ins from it. The plug-ins directory can be defined in different ways, given by order of prevalence : 1. the TLP_DIR environment variable, if it has a value 2. the appDirPath parameter, if it is not NULL 3. a fallback value of 'C:/Tulip/lib/' on windows, or '/usr/local/lib/' on unices.
  

• TLP_SCOPE void tlp::loadPlugins (PluginLoader *plug=0)
• TLP_SCOPE bool tlp::loadPlugin (const std::string &filename, PluginLoader *plug=0)
• TLP_SCOPE void tlp::loadPluginsFromDir (std::string dir, std::string type, PluginLoader *loader=0)
• TLP_SCOPE void tlp::loadPluginsCheckDependencies (PluginLoader *loader=0)
• TLP_SCOPE std::string tlp::demangleTlpClassName (const char *className)

  Demangles the name of a C++ class defined in the tlp namespace. Simply removes the 'tlp::' prefix from the class name.
  

• TLP_SCOPE std::istream * tlp::getIgzstream (const char *name, int open_mode=std::ios::in)

  Returns an istream to read from a gzipped file (uses gzstream lib). The stream has to be deleted after use.
  

• TLP_SCOPE std::ostream * tlp::getOgzstream (const char *name, int open_mode=std::ios::out)

  Returns an ostream to write to a gzipped file (uses gzstream lib). The stream has to be deleted after use.
  

• TLP_SCOPE std::string tlp::getMajor (const std::string &release)

  Splits the string and returns everything befor the first dot ('.'). This is used to return major version number, as version numbers are formatted as X.Y.Z, X being the major, Y the minor, and Z the patch version.
  

• TLP_SCOPE std::string tlp::getMinor (const std::string &release)

  Splits the string and return the minor version. If the string does not contain any dot, then 0 is returned. If the string contains only one dot (X.Y), then everything after the first dot is returned (Y). If the string is a full version with two dots (X.Y.Z), everything between the first and last dots is returned (Y). If there are more than two dots, everything between the first and last dots is returned.
  

Variables

• TLP_SCOPE const char tlp::PATH_DELIMITER
• TLP_SCOPE std::string tlp::TulipLibDir
• TLP_SCOPE std::string tlp::TulipPluginsPath
• TLP_SCOPE std::string tlp::TulipDocProfile
• TLP_SCOPE std::string tlp::TulipUserHandBookIndex
• TLP_SCOPE std::string tlp::TulipBitmapDir