MeshLib C++ Docs
Loading...
Searching...
No Matches
MRConfig.h
Go to the documentation of this file.
1#pragma once
3#include "MRMeshFwd.h"
4#include "MRColor.h"
5#include "MRSerializer.h"
6#include "MRPch/MRJson.h"
7#include "MRVector2.h"
8#include "MRLog.h"
9#include <filesystem>
10#include <string>
11
12namespace MR
13{
14
15using FileNamesStack = std::vector<std::filesystem::path>;
16
17class Config
18{
19public:
20 Config( Config const& ) = delete;
21 void operator=( Config const& ) = delete;
22
24
27 MRMESH_API void reset( std::string appName );
28
30 MRMESH_API const std::string& getAppName() const;
31
34
35private:
36 Config();
37
39 void reset( const std::filesystem::path& filePath );
40
41
44 ~Config();
45
46public:
47
49 MRMESH_API bool hasBool( const std::string& key ) const;
50
52 MRMESH_API bool getBool( const std::string& key, bool defaultValue = false ) const;
53
55 MRMESH_API void setBool( const std::string& key, bool keyValue );
56
57
59 MRMESH_API bool hasColor( const std::string& key ) const;
60
62 MRMESH_API Color getColor( const std::string& key, const Color& defaultValue = Color::black() ) const;
63
65 MRMESH_API void setColor( const std::string& key, const Color& keyValue );
66
68 MRMESH_API bool hasFileStack( const std::string& key ) const;
69
71 MRMESH_API FileNamesStack getFileStack( const std::string& key, const FileNamesStack& defaultValue = FileNamesStack() ) const;
72
74 MRMESH_API void setFileStack( const std::string& key, const FileNamesStack& keyValue );
75
76
78 MRMESH_API bool hasVector2i( const std::string& key ) const;
79
81 MRMESH_API Vector2i getVector2i( const std::string& key, const Vector2i& defaultValue = Vector2i() ) const;
82
84 MRMESH_API void setVector2i( const std::string& key, const Vector2i& keyValue );
85
87 typedef std::vector<const char*> Enum;
88
89
91 MRMESH_API bool hasEnum( const Enum &enumeration, const std::string& key ) const;
92
94 MRMESH_API int getEnum( const Enum& enumeration, const std::string& key, int defaultValue = 0 ) const;
95
97 MRMESH_API void setEnum( const Enum& enumeration, const std::string& key, int keyValue );
98
99 MRMESH_API bool hasViewportMask( const std::string& key ) const;
100 MRMESH_API ViewportMask getViewportMask( const std::string& key, ViewportMask defaultValue = {} ) const;
101 MRMESH_API void setViewportMask( const std::string& key, ViewportMask newValue );
102
104 MRMESH_API bool hasJsonValue( const std::string& key );
105
107 MRMESH_API Json::Value getJsonValue( const std::string& key, const Json::Value& defaultValue = {} );
108
110 MRMESH_API void setJsonValue( const std::string& key, const Json::Value& keyValue );
111
113 Json::Value toJson() const { return config_; }
114
116 void fromJson( const Json::Value& config ) { config_ = config; }
117private:
118 std::string appName_;
119
120 Json::Value config_;
121 std::filesystem::path filePath_;
122 // prolong logger life
123 std::shared_ptr<spdlog::logger> loggerHandle_ = Logger::instance().getSpdLogger();
124};
125
126} // namespace MR
#define MRMESH_API
Definition MRMeshFwd.h:80
Definition MRConfig.h:18
MRMESH_API bool getBool(const std::string &key, bool defaultValue=false) const
returns MRColor with presented key
MRMESH_API Color getColor(const std::string &key, const Color &defaultValue=Color::black()) const
returns MRColor with presented key
MRMESH_API void setEnum(const Enum &enumeration, const std::string &key, int keyValue)
sets custom enumeration value
std::vector< const char * > Enum
Description of a enumeration as a map between [0...N) and N strings.
Definition MRConfig.h:87
MRMESH_API void reset(std::string appName)
MRMESH_API bool hasColor(const std::string &key) const
returns true if MRColor with presented key exists
MRMESH_API bool hasVector2i(const std::string &key) const
returns true if Vector2i with presented key exists
MRMESH_API void writeToFile()
writes current config to file. (implicitly called from destructor)
Json::Value toJson() const
returns json with content of this config
Definition MRConfig.h:113
void fromJson(const Json::Value &config)
replace current config content with given one
Definition MRConfig.h:116
MRMESH_API void setVector2i(const std::string &key, const Vector2i &keyValue)
sets Vector2i for presented key
MRMESH_API int getEnum(const Enum &enumeration, const std::string &key, int defaultValue=0) const
returns custom enumeration value
MRMESH_API const std::string & getAppName() const
the name of the application, UTF8 encoded
MRMESH_API void setJsonValue(const std::string &key, const Json::Value &keyValue)
sets custom json value
MRMESH_API bool hasBool(const std::string &key) const
returns true if MRColor with presented key exists
MRMESH_API bool hasViewportMask(const std::string &key) const
MRMESH_API FileNamesStack getFileStack(const std::string &key, const FileNamesStack &defaultValue=FileNamesStack()) const
returns 'recently used' files list
MRMESH_API ViewportMask getViewportMask(const std::string &key, ViewportMask defaultValue={}) const
MRMESH_API bool hasFileStack(const std::string &key) const
returns true if 'recently used' files exist
MRMESH_API void setViewportMask(const std::string &key, ViewportMask newValue)
MRMESH_API Json::Value getJsonValue(const std::string &key, const Json::Value &defaultValue={})
returns custom json value
MRMESH_API Vector2i getVector2i(const std::string &key, const Vector2i &defaultValue=Vector2i()) const
returns Vector2i with presented key
static MRMESH_API Config & instance()
MRMESH_API void setBool(const std::string &key, bool keyValue)
sets MRColor for presented key
void operator=(Config const &)=delete
MRMESH_API void setFileStack(const std::string &key, const FileNamesStack &keyValue)
sets 'recently used' files list
MRMESH_API bool hasEnum(const Enum &enumeration, const std::string &key) const
returns true if given enumeration value with this key exists and is correct
MRMESH_API void setColor(const std::string &key, const Color &keyValue)
sets MRColor for presented key
MRMESH_API bool hasJsonValue(const std::string &key)
returns true if json value with this key exists
Config(Config const &)=delete
static MRMESH_API Logger & instance()
MRMESH_API const std::shared_ptr< spdlog::logger > & getSpdLogger() const
store this pointer if need to prolong logger life time (necessary to log something from destructors)
Definition MRViewportId.h:42
Definition MRCameraOrientationPlugin.h:8
Definition MRMesh/MRColor.h:9
static MR.Color black()