1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2025-02-12 07:47:12 +01:00
SqMod/vendor/POCO/Util/include/Poco/Util/SystemConfiguration.h
Sandu Liviu Catalin 4a6bfc086c Major plugin refactor and cleanup.
Switched to POCO library for unified platform/library interface.
Deprecated the external module API. It was creating more problems than solving.
Removed most built-in libraries in favor of system libraries for easier maintenance.
Cleaned and secured code with help from static analyzers.
2021-01-30 08:51:39 +02:00

100 lines
3.4 KiB
C++

//
// SystemConfiguration.h
//
// Library: Util
// Package: Configuration
// Module: SystemConfiguration
//
// Definition of the SystemConfiguration class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Util_SystemConfiguration_INCLUDED
#define Util_SystemConfiguration_INCLUDED
#include "Poco/Util/Util.h"
#include "Poco/Util/AbstractConfiguration.h"
namespace Poco {
namespace Util {
class Util_API SystemConfiguration: public AbstractConfiguration
/// This class implements a Configuration interface to
/// various system properties and environment variables.
///
/// The following properties are supported:
/// - system.osName: the operating system name
/// - system.osVersion: the operating system version
/// - system.osArchitecture: the operating system architecture
/// - system.nodeName: the node (or host) name
/// - system.nodeId: system ID, based on the Ethernet address (format "xxxxxxxxxxxx")
/// of the first Ethernet adapter found on the system.
/// - system.currentDir: the current working directory
/// - system.homeDir: the user's home directory
/// - system.configHomeDir: the base directory relative to which user specific configuration files should be stored
/// - system.cacheHomeDir: the base directory relative to which user specific non-essential data files should be stored
/// - system.dataHomeDir: the base directory relative to which user specific data files should be stored
/// - system.tempHomeDir: the base directory relative to which user-specific temporary files and other file objects should be placed
/// - system.tempDir: the system's temporary directory
/// - system.configDir: the system's configuration directory
/// - system.dateTime: the current UTC date and time, formatted in ISO 8601 format.
/// - system.pid: the current process ID.
/// - system.env.<NAME>: the environment variable with the given <NAME>.
///
/// An attempt to set a system variable will result in an
/// InvalidAccessException being thrown.
///
/// Enumerating environment variables is not supported.
/// An attempt to call keys("system.env") will return an empty range.
///
/// Removing key is not supported. An attempt to remove a key results
/// in a NotImplementedException being thrown.
{
public:
SystemConfiguration();
/// Creates the SystemConfiguration.
protected:
bool getRaw(const std::string& key, std::string& value) const;
void setRaw(const std::string& key, const std::string& value);
void enumerate(const std::string& key, Keys& range) const;
void removeRaw(const std::string& key);
~SystemConfiguration();
private:
static bool getEnv(const std::string& name, std::string& value);
static const std::string OSNAME;
static const std::string OSVERSION;
static const std::string OSARCHITECTURE;
static const std::string NODENAME;
static const std::string NODEID;
static const std::string CURRENTDIR;
static const std::string HOMEDIR;
static const std::string CONFIGHOMEDIR;
static const std::string CACHEHOMEDIR;
static const std::string DATAHOMEDIR;
static const std::string TEMPHOMEDIR;
static const std::string TEMPDIR;
static const std::string CONFIGDIR;
static const std::string DATETIME;
#if !defined(POCO_VXWORKS)
static const std::string PID;
#endif
static const std::string ENV;
};
} } // namespace Poco::Util
#endif // Util_SystemConfiguration_INCLUDED