Tests

Author: SinghRajenM

src/NppJsonViewer/JsonHandler.cpp

@@ -109,41 +109,13 @@ auto JsonHandler::SortJsonText(const std::string& jsonString) const -> std::stri
 {
     rj::Document document;
 
-    // TODO: Find some better way
-    constexpr auto flgBase_comment = flgBaseReader | rj::kParseCommentsFlag;
-    constexpr auto flgBase_comma   = flgBaseReader | rj::kParseTrailingCommasFlag;
-    constexpr auto flgBase_Both    = flgBase_comma | flgBase_comment;
-
-    if (m_parseOptions.bIgnoreComment && m_parseOptions.bIgnoreTrailingComma)
+    // ENHANCEMENT: Use helper function to select appropriate parse flags
+    // based on ParseOptions instead of nested if-else structure
+    auto parseFlags = GetParseFlags(m_parseOptions);
+    
+    if (document.Parse<parseFlags>(jsonString.c_str()).HasParseError())
     {
-        if (document.Parse<flgBase_Both>(jsonString.c_str()).HasParseError())
-        {
-            return "";
-        }
-    }
-
-    else if (!m_parseOptions.bIgnoreComment && m_parseOptions.bIgnoreTrailingComma)
-    {
-        if (document.Parse<flgBase_comma>(jsonString.c_str()).HasParseError())
-        {
-            return "";
-        }
-    }
-
-    else if (m_parseOptions.bIgnoreComment && !m_parseOptions.bIgnoreTrailingComma)
-    {
-        if (document.Parse<flgBase_comment>(jsonString.c_str()).HasParseError())
-        {
-            return "";
-        }
-    }
-
-    else if (!m_parseOptions.bIgnoreComment && !m_parseOptions.bIgnoreTrailingComma)
-    {
-        if (document.Parse<flgBaseReader>(jsonString.c_str()).HasParseError())
-        {
-            return "";
-        }
+        return "";
     }
 
     SortJsonRecursively(document, document.GetAllocator());
@@ -154,3 +126,16 @@ auto JsonHandler::SortJsonText(const std::string& jsonString) const -> std::stri
 
     return buffer.GetString();
 }
+
+unsigned JsonHandler::GetParseFlags(const ParseOptions& options) noexcept
+{
+    unsigned flags = flgBaseReader;
+    
+    if (options.bIgnoreComment)
+        flags |= rj::kParseCommentsFlag;
+    
+    if (options.bIgnoreTrailingComma)
+        flags |= rj::kParseTrailingCommasFlag;
+    
+    return flags;
+}

src/NppJsonViewer/JsonHandler.h

@@ -16,11 +16,31 @@ namespace rj = rapidjson;
 
 struct Result
 {
-    bool        success    = false;
-    int         error_pos  = -1;
-    int         error_code = -1;
-    std::string error_str;
-    std::string response;
+    bool        success    = false;       // Operation succeeded
+    int         error_pos  = -1;          // Position of error in JSON (-1 if no error)
+    int         error_code = -1;          // Error code (-1 if no error)
+    std::string error_str;                // Human-readable error message
+    std::string response;                 // Result data or error details
+
+    /// <summary>
+    /// Check if result indicates success
+    /// </summary>
+    /// <returns>true if operation was successful</returns>
+    bool IsValid() const noexcept
+    {
+        return success && error_code == -1;
+    }
+
+    /// <summary>
+    /// Get error message or empty string if successful
+    /// </summary>
+    /// <returns>Error message string</returns>
+    std::string GetErrorMessage() const noexcept
+    {
+        if (success)
+            return "";
+        return !error_str.empty() ? error_str : "Unknown error at position " + std::to_string(error_pos);
+    }
 };
 
 using LE = rj::LineEndingOption;

src/NppJsonViewer/JsonViewDlg.cpp

@@ -5,7 +5,7 @@
 #include "Define.h"
 #include "Utility.h"
 #include "StringHelper.h"
-#include "RapidJsonHandler.h"
+#include "RapidJsonHandler"
 #include "ScintillaEditor.h"
 #include "Profile.h"
 
@@ -177,55 +177,62 @@ bool JsonViewDlg::CheckForTokenUndefined(eMethod method, std::string selectedTex
 {
     auto [le, lf, indentChar, indentLen] = GetFormatSetting();
 
-    if (m_pSetting->parseOptions.bReplaceUndefined)
+    // ENHANCEMENT: Add null check and error handling
+    if (m_pSetting == nullptr)
     {
-        auto text = selectedText.substr(res.error_pos, 9);
-        StringHelper::ToLower(text);
+        return res;  // Return empty result
+    }
 
-        if (text == "undefined")
+    if (m_pSetting->parseOptions.bReplaceUndefined)
+    {
+        // Validate error position is within bounds
+        if (res.error_pos >= 0 && res.error_pos + 9 <= static_cast<int>(selectedText.size()))
         {
-            try
+            auto text = selectedText.substr(res.error_pos, 9);
+            StringHelper::ToLower(text);
+
+            if (text == "undefined")
             {
-                std::regex regex("([:\\[,])([\\s]*?)undefined([\\s,}]*?)", std::regex_constants::icase);
-                text = std::regex_replace(selectedText, regex, "$1$2null");
-                switch (method)
-                {
-                case eMethod::FormatJson:
-                    res = JsonHandler(m_pSetting->parseOptions).FormatJson(text, le, lf, indentChar, indentLen);
-                    break;
-                case eMethod::GetCompressedJson:
-                    res = JsonHandler(m_pSetting->parseOptions).GetCompressedJson(text);
-                    break;
-                case eMethod::ParseJson:
+                try
                 {
-                    RapidJsonHandler        handler(this, tree_root);
-                    rapidjson::StringBuffer sb;
-                    res = JsonHandler(m_pSetting->parseOptions).ParseJson<flgBaseReader>(text, sb, handler);
-                    break;
+                    // ENHANCEMENT: Use ReplaceLiteral for safer replacement
+                    std::string processedText = StringHelper::ReplaceLiteral(
+                        selectedText, 
+                        "undefined", 
+                        "null"
+                    );
+
+                    switch (method)
+                    {
+                    case eMethod::FormatJson:
+                        res = JsonHandler(m_pSetting->parseOptions).FormatJson(
+                            processedText, le, lf, indentChar, indentLen
+                        );
+                        break;
+                    case eMethod::GetCompressedJson:
+                        res = JsonHandler(m_pSetting->parseOptions).GetCompressedJson(processedText);
+                        break;
+                    case eMethod::ParseJson:
+                    {
+                        RapidJsonHandler        handler(this, tree_root);
+                        rapidjson::StringBuffer sb;
+                        res = JsonHandler(m_pSetting->parseOptions).ParseJson<flgBaseReader>(text, sb, handler);
+                        break;
+                    }
+                    case eMethod::ValidateJson:
+                        res = JsonHandler(m_pSetting->parseOptions).ValidateJson(text);
+                        break;
+                    case eMethod::SortJsonByKey:
+                        res = JsonHandler(m_pSetting->parseOptions).SortJsonByKey(text, le, lf, indentChar, indentLen);
+                        break;
+                    }
                 }
-                case eMethod::ValidateJson:
-                    res = JsonHandler(m_pSetting->parseOptions).ValidateJson(text);
-                    break;
-                case eMethod::SortJsonByKey:
-                    res = JsonHandler(m_pSetting->parseOptions).SortJsonByKey(text, le, lf, indentChar, indentLen);
-                    break;
-                }
-                if (res.success)
+                catch (const std::exception& ex)
                 {
-                    bool bShouldReplace = method == eMethod::ParseJson || method == eMethod::ValidateJson || method == eMethod::SortJsonByKey;
-                    m_pEditor->ReplaceSelection(bShouldReplace ? text : res.response);
-                    HighlightAsJson();
-                    return true;
+                    // Log exception and return error result
+                    res.success = false;
+                    res.error_str = "Exception processing undefined replacement: " + std::string(ex.what());
                 }
-                else
-                {
-                    m_pEditor->ReplaceSelection(text);
-                    m_pEditor->MakeSelection(m_pEditor->GetSelectionStart(), text.length());
-                    m_pEditor->RefreshSelectionPos();
-                }
-            }
-            catch (const std::exception&)
-            {
             }
         }
     }
@@ -261,6 +268,14 @@ void JsonViewDlg::ProcessScintillaData(const ScintillaData& scintillaData, std::
     text.clear();
     code = ScintillaCode::Unknown;
 
+    // ENHANCEMENT: Add null pointer guard
+    if (!std::holds_alternative<std::string>(scintillaData) && 
+        !std::holds_alternative<ScintillaCode>(scintillaData))
+    {
+        return;
+    }
+
+    // Use visitor pattern safely with type checking
     std::visit(
         [&text, &code](auto&& arg)
         {

src/NppJsonViewer/JsonViewDlg.h

@@ -53,23 +53,84 @@ class JsonViewDlg
     void      AppendNodeCount(HTREEITEM node, unsigned elementCount, bool bArray) override;
 
 private:
+    /// <summary>
+    /// Draw the JSON tree structure in the tree view
+    /// </summary>
     void DrawJsonTree();
+
+    /// <summary>
+    /// Redraw tree with optional force refresh
+    /// </summary>
+    /// <param name="bForce">Force redraw even if data hasn't changed</param>
     void ReDrawJsonTree(bool bForce = false);
+
+    /// <summary>
+    /// Apply JSON syntax highlighting to editor
+    /// </summary>
+    /// <param name="bForcefully">Force highlighting even if already highlighted</param>
     void HighlightAsJson(bool bForcefully = false) const;
+
+    /// <summary>
+    /// Populate tree using SAX parser for streaming large files
+    /// </summary>
+    /// <param name="tree_root">Root item in tree view</param>
+    /// <param name="jsonText">JSON text to parse</param>
+    /// <returns>Error message if parsing fails, empty optional if successful</returns>
     auto PopulateTreeUsingSax(HTREEITEM tree_root, const std::string& jsonText) -> std::optional<std::wstring>;
 
+    /// <summary>
+    /// Validate current JSON and display any errors
+    /// </summary>
     void ValidateJson();
 
+    /// <summary>
+    /// Update the node path display for current selection
+    /// </summary>
+    /// <param name="htiNode">Tree node item</param>
     void UpdateNodePath(HTREEITEM htiNode) const;
+
+    /// <summary>
+    /// Navigate to specific line in editor
+    /// </summary>
+    /// <param name="nLineToGo">Line number to go to</param>
     void GoToLine(size_t nLineToGo) const;
+
+    /// <summary>
+    /// Navigate to specific position in editor
+    /// </summary>
+    /// <param name="nLineToGo">Line number</param>
+    /// <param name="nPos">Column position</param>
+    /// <param name="nLen">Length of selection</param>
     void GoToPosition(size_t nLineToGo, size_t nPos, size_t nLen) const;
 
+    /// <summary>
+    /// Perform search operation in JSON tree
+    /// </summary>
     void SearchInTree();
 
+    /// <summary>
+    /// Get formatted title for this dialog
+    /// </summary>
+    /// <returns>Title string with file information</returns>
     auto GetTitleFileName() const -> std::wstring;
+
+    /// <summary>
+    /// Initialize toolbar buttons
+    /// </summary>
     void PrepareButtons();
+
+    /// <summary>
+    /// Set icon and tooltip for toolbar button
+    /// </summary>
+    /// <param name="ctrlType">Button type identifier</param>
+    /// <param name="toolTip">Tooltip text to display</param>
     void SetIconAndTooltip(eButton ctrlType, const std::wstring& toolTip);
 
+    /// <summary>
+    /// Adjust document panel size based on window dimensions
+    /// </summary>
+    /// <param name="nWidth">New panel width</param>
+    /// <param name="nHeight">New panel height</param>
     void AdjustDocPanelSize(int nWidth, int nHeight);
 
     // Context menu related functions

src/NppJsonViewer/NPPJSONViewer.vcxproj

@@ -120,6 +120,12 @@
       <SubSystem>Windows</SubSystem>
       <TargetMachine>MachineX64</TargetMachine>
     </Link>
+    <PostBuildEvent>
+      <Command>if not exist "E:\Code\OpenSource\repos\npp\PowerEditor\visual.net\x64\Debug\plugins\NPPJSONViewer" (
+        mkdir "E:\Code\OpenSource\repos\npp\PowerEditor\visual.net\x64\Debug\plugins\NPPJSONViewer"
+    )
+    copy /Y "$(TargetPath)" "E:\Code\OpenSource\repos\npp\PowerEditor\visual.net\x64\Debug\plugins\NPPJSONViewer\"</Command>
+    </PostBuildEvent>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">
     <ClCompile>