Berserk
Config.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_IO_CONFIIG_HPP
29 #define BERSERK_IO_CONFIIG_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/Typedefs.hpp>
33 #include <core/string/String.hpp>
35 
36 #include <memory>
37 
39 
49 class Config final {
50 public:
53 
67  BRK_API bool Open(const String &filepath);
68 
78  BRK_API int32 GetProperty(const StringName &section, const StringName &key, int32 defaultValue) const;
79 
89  BRK_API uint32 GetProperty(const StringName &section, const StringName &key, uint32 defaultValue) const;
90 
100  BRK_API float GetProperty(const StringName &section, const StringName &key, float defaultValue) const;
101 
111  BRK_API String GetProperty(const StringName &section, const StringName &key, const String &defaultValue) const;
112 
114  BRK_API const String &GetFilepath() const;
115 
117  BRK_API bool IsOpen() const { return mData != nullptr; }
118 
119 private:
120  std::shared_ptr<class ConfigData> mData;
121 };
122 
128 
129 #endif//BERSERK_IO_CONFIIG_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
std::int32_t int32
Definition: Typedefs.hpp:43
std::uint32_t uint32
Definition: Typedefs.hpp:44
Key-values based config file in plist style.
Definition: Config.hpp:49
BRK_API int32 GetProperty(const StringName &section, const StringName &key, int32 defaultValue) const
Read property int32 from the config.
Definition: Config.cpp:150
BRK_API bool Open(const String &filepath)
Open config file path with specified path.
Definition: Config.cpp:132
BRK_API ~Config()
BRK_API bool IsOpen() const
Definition: Config.hpp:117
BRK_API const String & GetFilepath() const
Definition: Config.cpp:202
BRK_API Config()
Cached shared utf-8 string id.
Definition: StringName.hpp:61
Utf-8 encoded std based default string class.
Definition: GLDevice.cpp:46