JeepToolkit.hh File Reference

Auxiliary methods for handling file names, type names and environment. More...

#include <string>
#include <fstream>
#include <sstream>
#include <cstdlib>
#include <map>
#include "JLang/gzstream.h"
#include "JLang/JException.hh"

Go to the source code of this file.

Namespaces
namespace	JEEP
	General puprpose classes and methods.
namespace	JPP
	This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).

Functions
bool	JEEP::hasWildCard (const std::string &file_name)
	Check presence of wild card.
std::string	JEEP::setWildCard (const std::string &file_name, const std::string &value)
	Get file name by setting wild card to given value.
std::string	JEEP::strip (const std::string &file_name)
	Strip leading and trailing white spaces from file name.
std::string	JEEP::getFilenameExtension (const std::string &file_name)
	Get file name extension, i.e. part after last JEEP::FILENAME_SEPARATOR if any.
std::string	JEEP::getFilename (const std::string &file_name)
	Get file name part, i.e. part after last JEEP::PATHNAME_SEPARATOR if any.
std::string	JEEP::getPath (const std::string &file_name)
	Get path, i.e. part before last JEEP::PATHNAME_SEPARATOR if any.
std::string	JEEP::getFullPath (const std::string &path)
	Get full path, i.e. add JEEP::PATHNAME_SEPARATOR if necessary.
std::string	JEEP::getFilename (const std::string &path, const std::string &file_name)
	Compose full file name and introduce JEEP::PATHNAME_SEPARATOR if needed.
std::string	JEEP::getPath (const std::string &variable, const std::string &file_name)
	Get selected path from environment variable for given file name.
std::string	JEEP::getFullFilename (const std::string &variable, const std::string &file_name)
	Get full file name (see JEEP::getPath).
std::string	JEEP::getNamespace (const std::string &type_name)
	Get name space, i.e. part before JEEP::TYPENAME_SEPARATOR.
std::string	JEEP::getClassname (const std::string &type_name)
	Get type name, i.e. part after JEEP::TYPENAME_SEPARATOR.
std::string	JEEP::getProtocol (const std::string &file_name)
	Get protocol, i.e. part before first JEEP::PROTOCOL_SEPARATOR if any.
std::string	JEEP::getURL ()
	Get URL of document pages.
template<class T >
T *	JEEP::open (const std::string &file_name)
	Open file.
template<>
std::istream *	JEEP::open (const std::string &file_name)
	Open file.
template<>
std::ostream *	JEEP::open (const std::string &file_name)
	Open file.
void	JEEP::close (std::istream *pf)
	Close file.
void	JEEP::close (std::ostream *pf)
	Close file.

Variables
static const char *const	JEEP::LD_LIBRARY_PATH = "LD_LIBRARY_PATH"
	Nick names of environment variables.
static const char *const	JEEP::PATH = "PATH"
	binary file paths
static const char *const	JEEP::SHELL = "SHELL"
	SHELL.
static const char *const	JEEP::JPP_PAGES = "JPP_PAGES"
	Jpp document pages.
static const char	JEEP::PATHNAME_SEPARATOR = '/'
	path name separator
static const char	JEEP::PATHLIST_SEPARATOR = ':'
	path list separator
static const char	JEEP::FILENAME_SEPARATOR = '.'
	file name separator
static const char *const	JEEP::TYPENAME_SEPARATOR = "::"
	type name separator
static const char	JEEP::PROTOCOL_SEPARATOR = ':'
	protocol separator
static const char	JEEP::FILENAME_WILDCARD = '%'
	wild card character for file name substitution

Detailed Description

Auxiliary methods for handling file names, type names and environment.

Author

mdejong

Definition in file JeepToolkit.hh.