System.h

Go to the documentation of this file.

 
#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_SYSTEM_H_
#define ELEMENTSKERNEL_ELEMENTSKERNEL_SYSTEM_H_
 
// STL include files
#include <climits>
#include <memory>
#include <string>
#include <typeinfo>
#include <vector>
 
// Framework include files
#include "ElementsKernel/Export.h"  // ELEMENTS_API
#include "ElementsKernel/Unused.h"  // ELEMENTS_UNUSED
 
namespace Elements {
namespace System {
 
// --------------------------------------------------------------------------------------
// various constants
// --------------------------------------------------------------------------------------
 
#if defined(__APPLE__)
const std::string SHLIB_VAR_NAME{"DYLD_LIBRARY_PATH"};
#else
const std::string SHLIB_VAR_NAME{"LD_LIBRARY_PATH"};
#endif
 
const std::string LIB_PREFIX{"lib"};
 
#ifdef __APPLE__
const std::string LIB_EXTENSION{"dylib"};
#else
const std::string LIB_EXTENSION{"so"};
#endif
 
const std::string LIB_SUFFIX{"." + LIB_EXTENSION};
 
const std::string SHLIB_SUFFIX{LIB_SUFFIX};
 
const std::string DEFAULT_INSTALL_PREFIX{"/usr"};
 
const int STACK_OFFSET{2};
 
#if defined(__linux__) || defined(__APPLE__)
#define TEMPLATE_SPECIALIZATION
#endif
 
#ifndef HOST_NAME_MAX
 
#ifdef _POSIX_HOST_NAME_MAX
#define HOST_NAME_MAX _POSIX_HOST_NAME_MAX
#else
#define HOST_NAME_MAX 255
#endif
 
#endif
 
using ImageHandle = void*;
using ProcessHandle = void*;
using EntryPoint = unsigned long (*)(const unsigned long iid, void** ppvObject);
using Creator = void* (*)();
 
ELEMENTS_API unsigned long loadDynamicLib(const std::string& name, ImageHandle* handle);
ELEMENTS_API unsigned long unloadDynamicLib(ImageHandle handle);
ELEMENTS_API unsigned long getProcedureByName(ImageHandle handle, const std::string& name, EntryPoint* pFunction);
ELEMENTS_API unsigned long getProcedureByName(ImageHandle handle, const std::string& name, Creator* pFunction);
ELEMENTS_API unsigned long getLastError();
ELEMENTS_API const std::string getLastErrorString();
ELEMENTS_API const std::string getErrorString(unsigned long error);
ELEMENTS_API const std::string typeinfoName(const std::type_info&);
ELEMENTS_API const std::string typeinfoName(const char*);
ELEMENTS_API const std::string& hostName();
ELEMENTS_API const std::string& osName();
ELEMENTS_API const std::string& osVersion();
ELEMENTS_API const std::string& machineType();
ELEMENTS_API std::string getEnv(const std::string& var);
ELEMENTS_API bool getEnv(const std::string& var, std::string& value);
ELEMENTS_API std::vector<std::string> getEnv();
ELEMENTS_API int setEnv(const std::string& name, const std::string& value, bool overwrite = true);
ELEMENTS_API int unSetEnv(const std::string& name);
ELEMENTS_API bool isEnvSet(const std::string& var);
 
ELEMENTS_API int   backTrace(ELEMENTS_UNUSED std::shared_ptr<void*> addresses, ELEMENTS_UNUSED const int depth);
ELEMENTS_API const std::vector<std::string> backTrace(const int depth, const int offset = 0);
 
ELEMENTS_API bool getStackLevel(ELEMENTS_UNUSED void* addresses, ELEMENTS_UNUSED void*& addr,
                                ELEMENTS_UNUSED std::string& fnc, ELEMENTS_UNUSED std::string& lib);
 
}  // namespace System
}  // namespace Elements
 
#endif  // ELEMENTSKERNEL_ELEMENTSKERNEL_SYSTEM_H_