Skip to content

feat: add reference counting to JSON documents #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: rename-yyjson-to-json
Choose a base branch
from
Draft

feat: add reference counting to JSON documents #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions public/IJsonManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,14 @@ class IJsonManager : public SMInterface
*/
virtual size_t GetReadSize(JsonValue* handle) = 0;

/**
* Get the reference count of the document
* @param handle JSON value
* @return Reference count of the document (number of JsonValue objects sharing this document)
* @note Returns 0 if handle is null or has no document
*/
virtual int GetRefCount(JsonValue* handle) = 0;

/**
* Create an empty mutable JSON object
* @return New mutable JSON object or nullptr on failure
Expand Down
70 changes: 65 additions & 5 deletions scripting/include/json.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,23 +381,22 @@ methodmap JSON < Handle
/**
* Returns the JSON value's type description
*
* @param value JSON handle
* @param buffer String buffer to write to
* @param maxlength Maximum length of the string buffer
*
* @return The return value should be one of these strings: "raw", "null", "string",
* "array", "object", "true", "false", "uint", "sint", "real", "unknown"
*/
public static native void GetTypeDesc(const JSON value, char[] buffer, int maxlength);
public native void GetTypeDesc(char[] buffer, int maxlength);

/**
* Returns whether two JSON values are equal (deep compare)
*
* @note This function is recursive and may cause a stack overflow if the object level is too deep
* @note the result may be inaccurate if object has duplicate keys
*
* @param value1 JSON handle
* @param value2 JSON handle
* @param value1 First JSON value to compare
* @param value2 Second JSON value to compare
*
* @return True if they are the same, false otherwise
*/
Expand Down Expand Up @@ -537,6 +536,7 @@ methodmap JSON < Handle
* Get value by a JSON Pointer
*
* @note Needs to be freed using delete or CloseHandle()
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
Expand All @@ -547,6 +547,8 @@ methodmap JSON < Handle
/**
* Get boolean value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return boolean value referenced by the JSON pointer
Expand All @@ -556,6 +558,8 @@ methodmap JSON < Handle
/**
* Get float value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return float value referenced by the JSON pointer
Expand All @@ -565,6 +569,8 @@ methodmap JSON < Handle
/**
* Get integer value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return integer value referenced by the JSON pointer
Expand All @@ -574,17 +580,21 @@ methodmap JSON < Handle
/**
* Get integer64 value by a JSON Pointer (auto-detects signed/unsigned)
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param buffer Buffer to copy to
* @param maxlength Maximum size of the buffer
*
* @return integer64 value referenced by the JSON pointer
* @return True on success, false on failure
*/
public native bool PtrGetInt64(const char[] path, char[] buffer, int maxlength);

/**
* Get string value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param buffer Buffer to copy to
* @param maxlength Maximum size of the buffer
Expand All @@ -596,6 +606,8 @@ methodmap JSON < Handle
/**
* Get value is null by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return True if the value is null, false otherwise
Expand All @@ -605,6 +617,7 @@ methodmap JSON < Handle
/**
* Get JSON content length (string length, array size, object size)
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note For strings: returns string length including null-terminator
* @note For arrays/objects: returns number of elements
* @note Returns 0 if value is null or type is not string/array/object
Expand All @@ -618,6 +631,7 @@ methodmap JSON < Handle
/**
* Set value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -631,6 +645,7 @@ methodmap JSON < Handle
/**
* Set boolean value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -644,6 +659,7 @@ methodmap JSON < Handle
/**
* Set float value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -657,6 +673,7 @@ methodmap JSON < Handle
/**
* Set integer value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -670,6 +687,7 @@ methodmap JSON < Handle
/**
* Set integer64 value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
* @note This function auto-detects whether the value is signed or unsigned
Expand All @@ -684,6 +702,7 @@ methodmap JSON < Handle
/**
* Set string value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -697,6 +716,7 @@ methodmap JSON < Handle
/**
* Set null value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
* @note The parent nodes will be created if they do not exist.
* If the target value already exists, it will be replaced by the new value
*
Expand All @@ -709,6 +729,8 @@ methodmap JSON < Handle
/**
* Add (insert) value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The value to be added
*
Expand All @@ -719,6 +741,8 @@ methodmap JSON < Handle
/**
* Add (insert) boolean value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The boolean value to be added
*
Expand All @@ -729,6 +753,8 @@ methodmap JSON < Handle
/**
* Add (insert) float value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The float value to be added
*
Expand All @@ -739,6 +765,8 @@ methodmap JSON < Handle
/**
* Add (insert) integer value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The int value to be added
*
Expand All @@ -749,6 +777,8 @@ methodmap JSON < Handle
/**
* Add (insert) integer64 value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The integer64 value to be added
*
Expand All @@ -759,6 +789,8 @@ methodmap JSON < Handle
/**
* Add (insert) string value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value The str value to be added
*
Expand All @@ -769,6 +801,8 @@ methodmap JSON < Handle
/**
* Add (insert) null value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return true if JSON pointer is valid and new value is set, false otherwise
Expand All @@ -778,6 +812,8 @@ methodmap JSON < Handle
/**
* Remove value by a JSON pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
*
* @return true if removed value, false otherwise
Expand All @@ -787,6 +823,8 @@ methodmap JSON < Handle
/**
* Try to get value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value Handle to store value
*
Expand All @@ -797,6 +835,8 @@ methodmap JSON < Handle
/**
* Try to get boolean value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value Store the boolean value
*
Expand All @@ -807,6 +847,8 @@ methodmap JSON < Handle
/**
* Try to get float value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value Store the float value
*
Expand All @@ -817,6 +859,8 @@ methodmap JSON < Handle
/**
* Try to get integer value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param value Store the integer value
*
Expand All @@ -827,6 +871,8 @@ methodmap JSON < Handle
/**
* Try to get integer64 value by a JSON Pointer (automatically detects signed/unsigned)
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param buffer Buffer to store the integer64 value
* @param maxlength Maximum length of the buffer
Expand All @@ -838,6 +884,8 @@ methodmap JSON < Handle
/**
* Try to get string value by a JSON Pointer
*
* @note JSON Pointer paths are always resolved from the document root, not from the current value
*
* @param path The JSON pointer string
* @param buffer Buffer to store the string value
* @param maxlength Maximum length of the buffer
Expand Down Expand Up @@ -978,6 +1026,17 @@ methodmap JSON < Handle
property int ReadSize {
public native get();
}

/**
* Get the reference count of the document (debugging purpose)
*
* @return Reference count (number of JSON objects sharing this document)
*
* @note Returns 0 if the handle is invalid
*/
property int RefCount {
public native get();
}
};

methodmap JSONObject < JSON
Expand Down Expand Up @@ -2055,6 +2114,7 @@ public void __pl_json_SetNTVOptional()
MarkNativeAsOptional("JSON.GetTypeDesc");
MarkNativeAsOptional("JSON.GetSerializedSize");
MarkNativeAsOptional("JSON.ReadSize.get");
MarkNativeAsOptional("JSON.RefCount.get");
MarkNativeAsOptional("JSON.Type.get");
MarkNativeAsOptional("JSON.SubType.get");
MarkNativeAsOptional("JSON.IsArray.get");
Expand Down
Loading