[cleanup] cleanup Json interface (#3856)

Author: Jarod42

CodeLite/JSON.cpp

@@ -25,7 +25,6 @@
 
 #include "JSON.h"
 
-#include "StringUtils.h"
 #include "clFontHelper.h"
 #include "fileutils.h"
 
@@ -37,11 +36,6 @@ JSON::JSON(const wxString& text)
     m_json = cJSON_Parse(text.mb_str(wxConvUTF8).data());
 }
 
-JSON::JSON(cJSON* json)
-    : m_json(json)
-{
-}
-
 JSON::JSON(JSONItem item)
     : m_json(item.release())
 {
@@ -95,8 +89,6 @@ JSONItem JSON::toElement() const
     return JSONItem(m_json);
 }
 
-wxString JSON::errorString() const { return _errorString; }
-
 JSONItem JSONItem::namedObject(const wxString& name) const
 {
     if (!m_json) {
@@ -142,33 +134,6 @@ JSONItem::JSONItem(cJSON* json)
     }
 }
 
-JSONItem::JSONItem(const wxString& name, double val)
-    : m_propertyName(name)
-    , m_type(cJSON_Number)
-    , m_valueNumer(val)
-{
-}
-
-JSONItem::JSONItem(const wxString& name, const std::string& val)
-    : m_propertyName(name)
-    , m_type(cJSON_String)
-    , m_valueString(val)
-{
-}
-
-JSONItem::JSONItem(const wxString& name, const char* pval, size_t len)
-    : m_propertyName(name)
-    , m_type(cJSON_String)
-    , m_valueString(pval, len)
-{
-}
-
-JSONItem::JSONItem(const wxString& name, bool val)
-    : m_propertyName(name)
-    , m_type(val ? cJSON_True : cJSON_False)
-{
-}
-
 JSONItem JSONItem::operator[](int index) const
 {
     if (isArray()) {
@@ -471,20 +436,26 @@ int JSONItem::arraySize() const
 
 JSONItem& JSONItem::addProperty(const wxString& name, bool value)
 {
-    append(JSONItem(name, value));
+    if (m_json) {
+        if (value) {
+            cJSON_AddTrueToObject(m_json, name.mb_str(wxConvUTF8).data());
+        } else {
+            cJSON_AddFalseToObject(m_json, name.mb_str(wxConvUTF8).data());
+        }
+    }
     return *this;
 }
 
 JSONItem& JSONItem::addProperty(const wxString& name, const wxString& value)
 {
-    const std::string cstr = value.ToStdString(wxConvUTF8);
-    append(JSONItem(name, cstr.data(), cstr.length()));
-    return *this;
+    return addProperty(name, value.ToStdString(wxConvUTF8));
 }
 
 JSONItem& JSONItem::addProperty(const wxString& name, const std::string& value)
 {
-    append(JSONItem(name, value));
+    if (m_json) {
+        cJSON_AddStringToObject(m_json, name.mb_str(wxConvUTF8).data(), value.data());
+    }
     return *this;
 }
 
@@ -495,7 +466,9 @@ JSONItem& JSONItem::addProperty(const wxString& name, const wxChar* value)
 
 JSONItem& JSONItem::addProperty(const wxString& name, long value)
 {
-    append(JSONItem(name, (double)value));
+    if (m_json) {
+        cJSON_AddNumberToObject(m_json, name.mb_str(wxConvUTF8).data(), value);
+    }
     return *this;
 }
 
@@ -659,31 +632,7 @@ JSONItem& JSONItem::addProperty(const wxString& name, const wxColour& colour)
     return addProperty(name, colourValue);
 }
 #endif
-JSONItem JSONItem::firstChild()
-{
-    m_walker = NULL;
-    if (!m_json) {
-        return JSONItem(NULL);
-    }
-
-    if (!m_json->child) {
-        return JSONItem(NULL);
-    }
-
-    m_walker = m_json->child;
-    return JSONItem(m_walker);
-}
-
-JSONItem JSONItem::nextChild()
-{
-    if (!m_walker) {
-        return JSONItem(NULL);
-    }
 
-    JSONItem element(m_walker->next);
-    m_walker = m_walker->next;
-    return element;
-}
 JSONItem& JSONItem::addProperty(const wxString& name, const char* value, const wxMBConv& conv)
 {
     return addProperty(name, wxString(value, conv));
@@ -729,23 +678,6 @@ bool JSONItem::isNumber() const
     return m_json->type == cJSON_Number;
 }
 
-JSONItem JSONItem::detachProperty(const wxString& name)
-{
-    if (!m_json) {
-        return JSONItem(NULL);
-    }
-    cJSON* j = cJSON_DetachItemFromObject(m_json, name.c_str());
-    return JSONItem(j);
-}
-
-wxFileName JSONItem::toFileName() const
-{
-    if (!m_json) {
-        return wxFileName();
-    }
-    return wxFileName(m_valueString);
-}
-
 JSONItem& JSONItem::addProperty(const wxString& name, const wxFileName& filename)
 {
     return addProperty(name, filename.GetFullPath());
@@ -765,12 +697,12 @@ JSONItem JSONItem::AddObject(const wxString& name)
     return json;
 }
 
-JSONItem& JSONItem::addProperty(const wxString& name, cJSON* pjson)
+JSONItem& JSONItem::addProperty(const wxString& name, JSON&& json)
 {
     if (!m_json) {
         return *this;
     }
-    cJSON_AddItemToObject(m_json, name.mb_str(wxConvUTF8).data(), pjson);
+    cJSON_AddItemToObject(m_json, name.mb_str(wxConvUTF8).data(), json.release());
     return *this;
 }
 

CodeLite/JSON.h

@@ -25,61 +25,40 @@
 
 #ifndef ZJSONNODE_H
 #define ZJSONNODE_H
-// clang-format off
-#include <wx/vector.h>
-#include <wx/string.h>
-#include <wx/variant.h>
-#include <wx/filename.h>
-#include <string_view>
-#include <wx/gdicmn.h>
+
 #include "codelite_exports.h"
-#include <map>
+#include "macros.h"
+
 #include <cJSON.h>
+#include <map>
+#include <string_view>
+#include <type_traits>
+#include <vector>
+#include <wx/filename.h>
+#include <wx/gdicmn.h>
+#include <wx/string.h>
+#include <wx/variant.h>
+#include <wx/vector.h>
+
 #if wxUSE_GUI
 #include <wx/arrstr.h>
 #include <wx/colour.h>
 #include <wx/font.h>
 #endif
-#include "macros.h"
-#include <vector>
-#include <type_traits>
-// clang-format on
 
 //////////////////////////////////////////////////////////////////////////
 //////////////////////////////////////////////////////////////////////////
 
+class JSON;
+
 class WXDLLIMPEXP_CL JSONItem
 {
-protected:
-    cJSON* m_json = nullptr;
-    cJSON* m_walker = nullptr;
-    wxString m_propertyName;
-    int m_type = wxNOT_FOUND;
-
-    // Values
-    wxString m_valueString;
-    double m_valueNumer = 0;
-
+    friend JSON;
 public:
-    JSONItem(cJSON* json);
-    JSONItem(const wxString& name, double val);
-    JSONItem(const wxString& name, const std::string& val);
-    JSONItem(const wxString& name, const char* pval, size_t len);
-    JSONItem(const wxString& name, bool val);
+    explicit JSONItem(cJSON* json);
     JSONItem() = default;
     virtual ~JSONItem() = default;
 
-    // Walkers
-    JSONItem firstChild();
-    JSONItem nextChild();
-
-    // Setters
-    ////////////////////////////////////////////////
-    void setType(int m_type) { this->m_type = m_type; }
-    int getType() const { return m_type; }
-    const wxString& GetPropertyName() const { return m_propertyName; }
-    void SetPropertyName(const wxString& name) { m_propertyName = name; }
-
     // Readers
     ////////////////////////////////////////////////
     JSONItem namedObject(const wxString& name) const;
@@ -154,7 +133,6 @@ class WXDLLIMPEXP_CL JSONItem
     }
     size_t toSize_t(size_t defaultVal = 0) const;
     double toDouble(double defaultVal = -1.0) const;
-    wxFileName toFileName() const;
 
     wxColour toColour(const wxColour& defaultColour = wxNullColour) const;
     wxFont toFont(const wxFont& defaultFont = wxNullFont) const;
@@ -198,7 +176,7 @@ class WXDLLIMPEXP_CL JSONItem
     JSONItem& addProperty(const wxString& name, long value);
     JSONItem& addProperty(const wxString& name, size_t value);
     JSONItem& addProperty(const wxString& name, bool value);
-    JSONItem& addProperty(const wxString& name, cJSON* pjson);
+    JSONItem& addProperty(const wxString& name, JSON&& json);
     JSONItem& addProperty(const wxString& name, const wxFileName& filename);
     JSONItem& addProperty(const wxString& name, const std::vector<int>& arr_int);
     template <class T = int>
@@ -223,11 +201,6 @@ class WXDLLIMPEXP_CL JSONItem
      */
     void removeProperty(const wxString& name);
 
-    /**
-     * @brief detach element from json. Return the detached element
-     */
-    JSONItem detachProperty(const wxString& name);
-
     //////////////////////////////////////////////////
     // Array operations
     //////////////////////////////////////////////////
@@ -245,6 +218,13 @@ class WXDLLIMPEXP_CL JSONItem
 
     bool isOk() const { return m_json != NULL; }
 
+private:
+
+    const wxString& GetPropertyName() const { return m_propertyName; }
+    void SetPropertyName(const wxString& name) { m_propertyName = name; }
+    int getType() const { return m_type; }
+    void setType(int m_type) { this->m_type = m_type; }
+
     /**
      * @brief release the internal pointer
      */
@@ -254,6 +234,14 @@ class WXDLLIMPEXP_CL JSONItem
         m_json = nullptr;
         return temp;
     }
+private:
+    cJSON* m_json = nullptr;
+    wxString m_propertyName;
+    int m_type = wxNOT_FOUND;
+
+    // Values
+    wxString m_valueString;
+    double m_valueNumer = 0;
 };
 
 //////////////////////////////////////////////////////////////////////////
@@ -267,32 +255,27 @@ enum class JsonType
 
 class WXDLLIMPEXP_CL JSON
 {
-protected:
-    cJSON* m_json;
-    wxString _errorString;
-
 public:
     explicit JSON(JsonType type);
     explicit JSON(const wxString& text);
     explicit JSON(const wxFileName& filename);
     explicit JSON(JSONItem item);
-    explicit JSON(cJSON* json);
 
+    // Make this class not copyable
+    JSON(const JSON&) = delete;
+    JSON& operator=(const JSON&) = delete;
     virtual ~JSON();
 
     void save(const wxFileName& fn) const;
-    wxString errorString() const;
     bool isOk() const { return m_json != NULL; }
 
     JSONItem toElement() const;
 
     void clear();
     cJSON* release();
 
-private:
-    // Make this class not copyable
-    JSON(const JSON&) = delete;
-    JSON& operator=(const JSON&) = delete;
+protected:
+    cJSON* m_json = nullptr;
 };
 
 #endif // ZJSONNODE_H

CodeLite/LSP/InitializeRequest.cpp

@@ -16,21 +16,15 @@ JSONItem LSP::InitializeRequest::ToJSON(const wxString& name) const
     JSONItem params = JSONItem::createObject("params");
     json.append(params);
     params.addProperty("processId", GetProcessId());
-    if (GetRootUri().IsEmpty()) {
-        JSON nullItem(JsonType::Null);
-        JSONItem nullObj = nullItem.toElement();
-        params.append(nullObj);
-        (void)nullItem.release(); // don't delete it on destruction, it is now owned by 'params'
-    } else {
+    if (!GetRootUri().IsEmpty()) {
         params.addProperty("rootUri", LSP::FileNameToURI(GetRootUri()));
     }
 
     if (!m_initOptions.empty()) {
         // Parse the JSON string and set it as the 'initializationOptions
         JSON initializationOptions(m_initOptions);
         if (initializationOptions.isOk()) {
-            cJSON* pjson = initializationOptions.release();
-            params.addProperty(wxString("initializationOptions"), (cJSON*)pjson);
+            params.addProperty(wxString("initializationOptions"), std::move(initializationOptions));
         }
     }
 

CodeLite/LSP/json_rpc_params.cpp

@@ -139,7 +139,7 @@ JSONItem ExecuteCommandParams::ToJSON(const wxString& name) const
     // and add them
     JSON root{ m_arguments };
     if(root.isOk()) {
-        json.addProperty("arguments", root.release());
+        json.addProperty("arguments", std::move(root));
     }
     return json;
 }

CodeLite/cl_config.cpp

@@ -173,8 +173,7 @@ bool clConfig::Write(const wxString& name, std::function<JSONItem()> serialiser_
     } else {
         // add it to the global configuration file
         DoDeleteProperty(name);
-        item.SetPropertyName(name);
-        m_root->toElement().append(item);
+        m_root->toElement().addProperty(name, item);
         return true;
     }
 }