react-native-mmkv 2.8.0 → 2.9.0

package/MMKV/Core/MMKV.h

@@ -89,18 +89,29 @@ class MMKV {
     mmkv::InterProcessLock *m_sharedProcessLock;
     mmkv::InterProcessLock *m_exclusiveProcessLock;
 
+    bool m_enableKeyExpire = false;
+    uint32_t m_expiredInSeconds = ExpireNever;
+
 #ifdef MMKV_APPLE
     using MMKVKey_t = NSString *__unsafe_unretained;
     static bool isKeyEmpty(MMKVKey_t key) { return key.length <= 0; }
+#  define key_length(key) key.length
+#  define retain_key(key) [key retain]
+#  define release_key(key) [key release]
 #else
     using MMKVKey_t = const std::string &;
     static bool isKeyEmpty(MMKVKey_t key) { return key.empty(); }
+#  define key_length(key) key.length()
+#  define retain_key(key) ((void)0)
+#  define release_key(key) ((void)0)
 #endif
 
     void loadFromFile();
 
     void partialLoadFromFile();
 
+    void loadMetaInfoAndCheck();
+
     void checkDataValid(bool &loadFromFile, bool &needFullWriteback);
 
     void checkLoadData();
@@ -121,10 +132,16 @@ class MMKV {
 
     bool ensureMemorySize(size_t newSize);
 
+    bool expandAndWriteBack(size_t newSize, std::pair<mmkv::MMBuffer, size_t> preparedData);
+
     bool fullWriteback(mmkv::AESCrypt *newCrypter = nullptr);
 
     bool doFullWriteBack(std::pair<mmkv::MMBuffer, size_t> preparedData, mmkv::AESCrypt *newCrypter);
 
+    bool doFullWriteBack(mmkv::MMKVVector &&vec);
+
+    mmkv::MMBuffer getRawDataForKey(MMKVKey_t key);
+
     mmkv::MMBuffer getDataForKey(MMKVKey_t key);
 
     // isDataHolder: avoid memory copying
@@ -154,6 +171,11 @@ class MMKV {
     static bool restoreOneFromDirectory(const std::string &mmapKey, const MMKVPath_t &srcPath, const MMKVPath_t &dstPath, bool compareFullPath);
     static size_t restoreAllFromDirectory(const MMKVPath_t &srcDir, const MMKVPath_t &dstDir, bool isInSpecialDir);
 
+    static uint32_t getCurrentTimeInSecond();
+    uint32_t getExpireTimeForKey(MMKVKey_t key);
+    mmkv::MMBuffer getDataWithoutMTimeForKey(MMKVKey_t key);
+    size_t filterExpiredKeys();
+
 public:
     // call this before getting any MMKV instance
     static void initializeMMKV(const MMKVPath_t &rootDir, MMKVLogLevel logLevel = MMKVLogInfo, mmkv::LogHandler handler = nullptr);
@@ -216,35 +238,49 @@ public:
 #endif
 
     bool set(bool value, MMKVKey_t key);
+    bool set(bool value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(int32_t value, MMKVKey_t key);
+    bool set(int32_t value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(uint32_t value, MMKVKey_t key);
+    bool set(uint32_t value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(int64_t value, MMKVKey_t key);
+    bool set(int64_t value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(uint64_t value, MMKVKey_t key);
+    bool set(uint64_t value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(float value, MMKVKey_t key);
+    bool set(float value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(double value, MMKVKey_t key);
+    bool set(double value, MMKVKey_t key, uint32_t expireDuration);
 
     // avoid unexpected type conversion (pointer to bool, etc)
     template <typename T>
     bool set(T value, MMKVKey_t key) = delete;
+    template <typename T>
+    bool set(T value, MMKVKey_t key, uint32_t expireDuration) = delete;
 
 #ifdef MMKV_APPLE
     bool set(NSObject<NSCoding> *__unsafe_unretained obj, MMKVKey_t key);
+    bool set(NSObject<NSCoding> *__unsafe_unretained obj, MMKVKey_t key, uint32_t expireDuration);
 
     NSObject *getObject(MMKVKey_t key, Class cls);
 #else  // !defined(MMKV_APPLE)
     bool set(const char *value, MMKVKey_t key);
+    bool set(const char *value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(const std::string &value, MMKVKey_t key);
+    bool set(const std::string &value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(const mmkv::MMBuffer &value, MMKVKey_t key);
+    bool set(const mmkv::MMBuffer &value, MMKVKey_t key, uint32_t expireDuration);
 
     bool set(const std::vector<std::string> &vector, MMKVKey_t key);
+    bool set(const std::vector<std::string> &vector, MMKVKey_t key, uint32_t expireDuration);
 
     bool getString(MMKVKey_t key, std::string &result);
 
@@ -285,6 +321,14 @@ public:
 
     size_t actualSize();
 
+    static constexpr uint32_t ExpireNever = 0;
+
+    // all keys created (or last modified) longer than expiredInSeconds will be deleted on next full-write-back
+    // expiredInSeconds = MMKV::ExpireNever (0) means no common expiration duration for all keys, aka each key will have it's own expiration duration
+    bool enableAutoKeyExpire(uint32_t expiredInSeconds = 0);
+
+    bool disableAutoKeyExpire();
+
 #ifdef MMKV_APPLE
     NSArray *allKeys();
 

package/MMKV/Core/MMKVMetaInfo.hpp

@@ -39,6 +39,15 @@ enum MMKVVersion : uint32_t {
 
     // store actual size together with crc checksum, try to reduce file corruption
     MMKVVersionActualSize = 3,
+
+    // store extra flags
+    MMKVVersionFlag = 4,
+
+    // preserved for next use
+    MMKVVersionNext = 5,
+
+    // always large than next, a placeholder for error check
+    MMKVVersionHolder = MMKVVersionNext + 1,
 };
 
 struct MMKVMetaInfo {
@@ -55,6 +64,15 @@ struct MMKVMetaInfo {
         uint32_t _reserved[16] = {};
     } m_lastConfirmedMetaInfo;
 
+    uint64_t m_flags = 0;
+
+    enum MMKVMetaInfoFlag : uint64_t {
+        EnableKeyExipre = 1 << 0,
+    };
+    bool hasFlag(MMKVMetaInfoFlag flag) { return (m_flags & flag) != 0; }
+    void setFlag(MMKVMetaInfoFlag flag) { m_flags |= flag; }
+    void unsetFlag(MMKVMetaInfoFlag flag) { m_flags &= ~flag; }
+
     void write(void *ptr) const {
         MMKV_ASSERT(ptr);
         memcpy(ptr, this, sizeof(MMKVMetaInfo));

package/MMKV/Core/MMKVPredef.h

@@ -34,7 +34,7 @@
 #include <vector>
 #include <unordered_map>
 
-constexpr auto MMKV_VERSION = "v1.2.15";
+constexpr auto MMKV_VERSION = "v1.3.0";
 
 #ifdef DEBUG
 #    define MMKV_DEBUG
@@ -84,7 +84,7 @@ constexpr auto MMKV_VERSION = "v1.2.15";
 #    include <windows.h>
 
 constexpr auto MMKV_PATH_SLASH = L"\\";
-#    define MMKV_PATH_FORMAT "%ws"
+#    define MMKV_PATH_FORMAT "%ls"
 using MMKVFileHandle_t = HANDLE;
 using MMKVPath_t = std::wstring;
 extern MMKVPath_t string2MMKVPath_t(const std::string &str);