Merge pull request #166 from end2endzone/feature-issue109

Replaced using CRLF by LF in IObject::ToLongString() implementations.

Author: end2endzone

src/core/ConfigFile.cpp

@@ -525,24 +525,22 @@ namespace shellanything
 
   void ConfigFile::ToLongString(std::string& str, int indent) const
   {
-    static const char* NEW_LINE = ra::environment::GetLineSeparator();
     const bool have_children = (mMenus.size() > 0);
     const std::string indent_str = std::string(indent, ' ');
 
     const std::string short_string = ToShortString();
     str += indent_str + short_string;
     if (have_children)
     {
-      str += " {";
-      str += NEW_LINE;
+      str += " {\n";
 
       // print children
       for (size_t i = 0; i < mMenus.size(); i++)
       {
         Menu* menu = mMenus[i];
         menu->ToLongString(str, indent + 2);
 
-        str += NEW_LINE;
+        str += "\n";
       }
 
       str += indent_str + "}";

src/core/ConfigManager.cpp

@@ -237,24 +237,22 @@ namespace shellanything
 
   void ConfigManager::ToLongString(std::string& str, int indent) const
   {
-    static const char* NEW_LINE = ra::environment::GetLineSeparator();
     const bool have_children = (mConfigurations.size() > 0);
     const std::string indent_str = std::string(indent, ' ');
 
     const std::string short_string = ToShortString();
     str += indent_str + short_string;
     if (have_children)
     {
-      str += " {";
-      str += NEW_LINE;
+      str += " {\n";
 
       // print config children
       for (size_t i = 0; i < mConfigurations.size(); i++)
       {
         ConfigFile* config = mConfigurations[i];
         config->ToLongString(str, indent + 2);
 
-        str += NEW_LINE;
+        str += "\n";
       }
 
       str += indent_str + "}";

src/core/IObject.h

@@ -49,6 +49,7 @@ namespace shellanything
 
     /// <summary>
     /// Get a string representation of this object and its children.
+    /// The output string is multiple lines. Each line separated by '\n' (LF) character.
     /// </summary>
     /// <param name="str">The string to append this object's description to.</param>
     /// <param name="indent">The indentation (spaces) to add before each line describing this object.</param>

src/core/Icon.cpp

@@ -175,7 +175,6 @@ namespace shellanything
 
   void Icon::ToLongString(std::string& str, int indent) const
   {
-    static const char* NEW_LINE = ra::environment::GetLineSeparator();
     const std::string indent_str = std::string(indent, ' ');
 
     const std::string short_string = ToShortString();

src/core/Menu.cpp

@@ -516,50 +516,46 @@ namespace shellanything
 
   void Menu::ToLongString(std::string& str, int indent) const
   {
-    static const char* NEW_LINE = ra::environment::GetLineSeparator();
     const bool have_children = (mVisibilities.size() + mValidities.size() + mSubMenus.size() > 0);
     const std::string indent_str = std::string(indent, ' ');
 
     const std::string short_string = ToShortString();
     str += indent_str + short_string;
     if (have_children)
     {
-      str += " {";
-      str += NEW_LINE;
+      str += " {\n";
 
       // print visibility children
       if (mVisibilities.size())
       {
-        str += indent_str + "  Visibilities:";
-        str += NEW_LINE;
+        str += indent_str + "  Visibilities:\n";
       }
       for (size_t i = 0; i < mVisibilities.size(); i++)
       {
         Validator* validator = mVisibilities[i];
         validator->ToLongString(str, indent + 4);
 
-        str += NEW_LINE;
+        str += "\n";
       }
       // print validity children
       if (mValidities.size())
       {
-        str += indent_str + "  Validities:";
-        str += NEW_LINE;
+        str += indent_str + "  Validities:\n";
       }
       for (size_t i = 0; i < mValidities.size(); i++)
       {
         Validator* validator = mValidities[i];
         validator->ToLongString(str, indent + 4);
 
-        str += NEW_LINE;
+        str += "\n";
       }
       // print menu children
       for (size_t i = 0; i < mSubMenus.size(); i++)
       {
         Menu* submenu = mSubMenus[i];
         submenu->ToLongString(str, indent + 2);
 
-        str += NEW_LINE;
+        str += "\n";
       }
 
       str += indent_str + "}";

src/core/Validator.cpp

@@ -1323,7 +1323,6 @@ namespace shellanything
 
   void Validator::ToLongString(std::string& str, int indent) const
   {
-    static const char* NEW_LINE = ra::environment::GetLineSeparator();
     const std::string indent_str = std::string(indent, ' ');
 
     const std::string short_string = ToShortString();

src/shellextension/CContextMenu.cpp

@@ -321,6 +321,23 @@ void CContextMenu::BuildTopMenuTree(HMENU hMenu)
   }
 }
 
+void CContextMenu::PrintVerboseMenuStructure() const
+{
+  if (!shellanything::LoggerHelper::IsVerboseLoggingEnabled())
+    return;
+
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
+  sli.verbose = true;
+  sli.instance = this;
+  shellanything::ScopeLogger logger(&sli);
+
+  shellanything::ConfigManager& cmgr = shellanything::ConfigManager::GetInstance();
+
+  std::string menu_tree;
+  cmgr.ToLongString(menu_tree, 0);
+  SA_VERBOSE_LOG(INFO) << __FUNCTION__ "(), Menu tree:\n" << menu_tree.c_str();
+}
+
 CContextMenu::CContextMenu()
 {
   SA_VERBOSE_LOG(INFO) << __FUNCTION__ "(), new instance " << ToHexString(this);
@@ -421,13 +438,8 @@ HRESULT STDMETHODCALLTYPE CContextMenu::QueryContextMenu(HMENU hMenu, UINT menu_
   UINT num_menu_items = next_command_id - first_command_id;
   SA_VERBOSE_LOG(INFO) << __FUNCTION__ "(), statistics: first_command_id=" << first_command_id << " menu_last_command_id=" << menu_last_command_id << " next_command_id=" << next_command_id << " num_menu_items=" << num_menu_items << ".\n";
 
-  //debug the constructed menu tree
-  if (shellanything::LoggerHelper::IsVerboseLoggingEnabled())
-  {
-    std::string menu_tree;
-    cmgr.ToLongString(menu_tree, 0);
-    SA_VERBOSE_LOG(INFO) << __FUNCTION__ "(), Menu tree:\n" << menu_tree.c_str();
-  }
+  //debug the constructed menu tree, if required
+  PrintVerboseMenuStructure();
 
   HRESULT hr = MAKE_HRESULT(SEVERITY_SUCCESS, FACILITY_NULL, num_menu_items);
   return hr;

src/shellextension/CContextMenu.h

@@ -81,6 +81,7 @@ class ATL_NO_VTABLE CContextMenu :
 private:
   void BuildTopMenuTree(HMENU hMenu);
   void BuildSubMenuTree(HMENU hMenu, shellanything::Menu* menu, UINT& insert_pos, bool& next_menu_is_column);
+  void PrintVerboseMenuStructure() const;
 
   CCriticalSection            m_CS; //protects class members
   ULONG                       m_refCount;

src/tests/TestIObject.cpp

@@ -25,6 +25,7 @@
 #include "TestIObject.h"
 #include "ConfigManager.h"
 #include "ConfigFile.h"
+#include "LoggerHelper.h"
 
 #include "rapidassist/strings.h"
 #include "rapidassist/testing.h"
@@ -281,7 +282,6 @@ namespace shellanything
       //Get actual
       std::string longstring_actual;
       cmgr.ToLongString(longstring_actual, 0);
-      ra::strings::Replace(longstring_actual, "\r\n", "\n"); // Replace CRLF by LF to display properly in GoogleTest diff view
 
       //Get expected long string from file
       std::string expected_source_path = std::string("test_files") + path_separator + test_name + ".expected.txt";
@@ -300,6 +300,9 @@ namespace shellanything
       //Do the actual comparison
       ASSERT_EQ(longstring_expected, longstring_actual);
 
+      // Add to logs to show how it prints
+      SA_LOG(INFO) << __FUNCTION__ << "() Menu Tree:\n" << longstring_actual;
+      
       //Cleanup
       ASSERT_TRUE(workspace.Cleanup()) << "Failed deleting workspace directory '" << workspace.GetBaseDirectory() << "'.";
     }