Translated using Weblate (Chinese (Simplified))
[oweals/minetest.git] / src / settings.h
index c4b94d67dcb82811c3c5c2d5d7cc81de82778b1f..0c9a155db4f0ac258259166a13f8a3311490db65 100644 (file)
@@ -17,8 +17,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef SETTINGS_HEADER
-#define SETTINGS_HEADER
+#pragma once
 
 #include "irrlichttypes_bloated.h"
 #include "util/string.h"
@@ -73,7 +72,7 @@ struct ValueSpec {
 };
 
 struct SettingsEntry {
-       SettingsEntry() {}
+       SettingsEntry() = default;
 
        SettingsEntry(const std::string &value_) :
                value(value_)
@@ -93,7 +92,8 @@ typedef std::unordered_map<std::string, SettingsEntry> SettingEntries;
 
 class Settings {
 public:
-       Settings() {}
+       Settings() = default;
+
        ~Settings();
 
        Settings & operator += (const Settings &other);
@@ -129,11 +129,14 @@ public:
         ***********/
 
        const SettingsEntry &getEntry(const std::string &name) const;
+       const SettingsEntry &getEntryDefault(const std::string &name) const;
        Settings *getGroup(const std::string &name) const;
        const std::string &get(const std::string &name) const;
+       const std::string &getDefault(const std::string &name) const;
        bool getBool(const std::string &name) const;
        u16 getU16(const std::string &name) const;
        s16 getS16(const std::string &name) const;
+       u32 getU32(const std::string &name) const;
        s32 getS32(const std::string &name) const;
        u64 getU64(const std::string &name) const;
        float getFloat(const std::string &name) const;
@@ -159,8 +162,10 @@ public:
         ***************************************/
 
        bool getEntryNoEx(const std::string &name, SettingsEntry &val) const;
+       bool getEntryDefaultNoEx(const std::string &name, SettingsEntry &val) const;
        bool getGroupNoEx(const std::string &name, Settings *&val) const;
        bool getNoEx(const std::string &name, std::string &val) const;
+       bool getDefaultNoEx(const std::string &name, std::string &val) const;
        bool getFlag(const std::string &name) const;
        bool getU16NoEx(const std::string &name, u16 &val) const;
        bool getS16NoEx(const std::string &name, s16 &val) const;
@@ -169,10 +174,12 @@ public:
        bool getFloatNoEx(const std::string &name, float &val) const;
        bool getV2FNoEx(const std::string &name, v2f &val) const;
        bool getV3FNoEx(const std::string &name, v3f &val) const;
-       // N.B. getFlagStrNoEx() does not set val, but merely modifies it.  Thus,
-       // val must be initialized before using getFlagStrNoEx().  The intention of
-       // this is to simplify modifying a flags field from a default value.
-       bool getFlagStrNoEx(const std::string &name, u32 &val, FlagDesc *flagdesc) const;
+
+       // Like other getters, but handling each flag individualy:
+       // 1) Read default flags (or 0)
+       // 2) Override using user-defined flags
+       bool getFlagStrNoEx(const std::string &name, u32 &val,
+               const FlagDesc *flagdesc) const;
 
 
        /***********
@@ -196,7 +203,7 @@ public:
        bool setV2F(const std::string &name, v2f value);
        bool setV3F(const std::string &name, v3f value);
        bool setFlagStr(const std::string &name, u32 flags,
-               const FlagDesc *flagdesc, u32 flagmask);
+               const FlagDesc *flagdesc = nullptr, u32 flagmask = U32_MAX);
        bool setNoiseParams(const std::string &name, const NoiseParams &np,
                bool set_default=false);
        // N.B. if setStruct() is used to write a non-POD aggregate type,
@@ -210,6 +217,15 @@ public:
        void updateValue(const Settings &other, const std::string &name);
        void update(const Settings &other);
 
+       /**************
+        * Miscellany *
+        **************/
+
+       void setDefault(const std::string &name, const FlagDesc *flagdesc, u32 flags);
+       // Takes the provided setting values and uses them as new defaults
+       void overrideDefaults(Settings *other);
+       const FlagDesc *getFlagDescFallback(const std::string &name) const;
+
        void registerChangedCallback(const std::string &name,
                SettingsChangedCallback cbf, void *userdata = NULL);
        void deregisterChangedCallback(const std::string &name,
@@ -224,6 +240,7 @@ private:
 
        SettingEntries m_settings;
        SettingEntries m_defaults;
+       std::unordered_map<std::string, const FlagDesc *> m_flags;
 
        SettingsCallbackMap m_callbacks;
 
@@ -233,6 +250,3 @@ private:
        mutable std::mutex m_mutex;
 
 };
-
-#endif
-