* Fixed issue #59: Implement a new type of separator for creating a menu with multiple columns.

end2endzone · end2endzone · commit 962af395d755 · 2021-11-07T09:10:42.000-05:00
diff --git a/CHANGES b/CHANGES
@@ -4,6 +4,7 @@ Changes for 0.7.0
 * Using [File for Windows](https://github.com/Cirn09/file-windows) v5.38 with minimal changes.
 * Using [PCRE2](http://www.pcre.org/) version 10.30
 * Deprecated support for 32-bit Windows.
+* Fixed issue #59: Implement a new type of separator for creating a menu with multiple columns.
 * Fixed issue #91: String encoding in source code.
 * Fixed issue #96: Problems with Files > 2Gb
 * Fixed issue #97: Files and folders together do not start MENU.
diff --git a/UserManual.md b/UserManual.md
@@ -188,10 +188,26 @@ Menu names supports _keyboard mnemonics_, see the [Mnemonics / keyboard shortcut
 
 ### separator attribute: ###
 
-The `separator` attribute allows one to define a separator between menu options. To define a separator, one must set the `separator` attributes to one of the following values: `true`, `yes` or `on`. For example, add the following menu element in a *configuration file*:
+The `separator` attribute allows one to define an *horizontal* separator between menu options. To define an *horizontal* separator, one must set the `separator` attributes to one of the following values: `true`, `yes`, `on` or `horizontal`. For example, the following creates a separator between menu *foo* and *bar* :
 
 ```xml
+<menu name="foo" />
 <menu separator="true" />
+<menu name="bar" />
+```
+
+ShellAnything also support creating *vertical* (or column) separators. When using such a separator, *Windows* renders the popup menu with multiple columns. The menus following a column separator are rendered in a new column. For example, look at [this image](docs/multiple_columns_menu.png?raw=true) to see a multi-column menu. To define a *vertical* separator, one must set the `separator` attributes to value  `vertical` or `column`. For example, the following creates a two column menu :
+
+```xml
+<menu name="Left" />
+<menu name="logical" />
+<menu name="analytical" />
+<menu name="objective" />
+<menu separator="column" />
+<menu name="Right" />
+<menu name="intuitive" />
+<menu name="creativity" />
+<menu name="subjective" />
 ```
 
 
diff --git a/docs/multiple_columns_menu.png b/docs/multiple_columns_menu.png
diff --git a/include/shellanything/Menu.h b/include/shellanything/Menu.h
@@ -79,6 +79,18 @@ namespace shellanything
     /// <param name="separator">True to define the menu as a separator. False otherwise.</param>
     void SetSeparator(bool separator);
 
+    /// <summary>
+    /// Returns true of the menu is a column separator.
+    /// </summary>
+    /// <returns>Returns true of the menu is a column separator. Returns false otherwise.</returns>
+    bool IsColumnSeparator() const;
+
+    /// <summary>
+    /// Sets the menu column separator property.
+    /// </summary>
+    /// <param name="separator">True to define the menu as a column separator. False otherwise.</param>
+    void SetColumnSeparator(bool column_separator);
+
     /// <summary>
     /// Returns true if the menu is a parent menu (if this menu have submenus).
     /// </summary>
@@ -247,6 +259,7 @@ namespace shellanything
     bool mVisible;
     bool mEnabled;
     bool mSeparator;
+    bool mColumnSeparator;
     uint32_t mCommandId;
     std::string mName;
     int mNameMaxLength;
diff --git a/src/Menu.cpp b/src/Menu.cpp
@@ -33,6 +33,7 @@ namespace shellanything
   Menu::Menu() : Node("Menu"),
     mNameMaxLength(DEFAULT_NAME_MAX_LENGTH),
     mSeparator(false),
+    mColumnSeparator(false),
     mCommandId(INVALID_COMMAND_ID),
     mVisible(true),
     mEnabled(true)
@@ -76,6 +77,16 @@ namespace shellanything
     mSeparator = separator;
   }
 
+  bool Menu::IsColumnSeparator() const
+  {
+    return mColumnSeparator;
+  }
+
+  void Menu::SetColumnSeparator(bool column_separator)
+  {
+    mColumnSeparator = column_separator;
+  }
+
   bool Menu::IsParentMenu() const
   {
     Menu::MenuPtrList sub_menus = FilterNodes<Menu*>(this->FindChildren("Menu"));
diff --git a/src/ObjectFactory.cpp b/src/ObjectFactory.cpp
@@ -506,15 +506,30 @@ namespace shellanything
     //parse separator
     std::string menu_separator;
     bool have_separetor = ParseAttribute(element, "separator", true, true, menu_separator, error);
-    bool is_separator = false;
+    bool separator_parsed = false;
     if (have_separetor)
     {
-      is_separator = ra::strings::ParseBoolean(menu_separator);
-      if (is_separator)
+      //try to parse this menu separator as a boolean
+      bool is_horizontal_separator = false;
+      separator_parsed = ra::strings::Parse(menu_separator, is_horizontal_separator);
+      if (separator_parsed && is_horizontal_separator)
       {
         menu->SetSeparator(true);
         return menu;
       }
+
+      //try to parse as a string
+      menu_separator = ra::strings::Lowercase(menu_separator);
+      if (menu_separator == "horizontal")
+      {
+        menu->SetSeparator(true);
+        return menu;
+      }
+      else if (menu_separator == "vertical" || menu_separator == "column")
+      {
+        menu->SetColumnSeparator(true);
+        return menu;
+      }
     }
 
     //parse name
diff --git a/src/shellext.cpp b/src/shellext.cpp
@@ -246,7 +246,7 @@ template <class T> class FlagDescriptor
   }
 };
 
-void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT & insert_pos)
+void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT & insert_pos, bool & next_menu_is_column)
 {
   //Expanded the menu's strings
   shellanything::PropertyManager & pmgr = shellanything::PropertyManager::GetInstance();
@@ -257,6 +257,14 @@ void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT &
   bool menu_visible   = menu->IsVisible();
   bool menu_enabled   = menu->IsEnabled();
   bool menu_separator = menu->IsSeparator();
+  bool menu_column    = menu->IsColumnSeparator();
+
+  //Skip column separator, those are not menu item
+  if (menu_column)
+  {
+    next_menu_is_column = true;
+    return;
+  }
 
   //Skip this menu if not visible
   if (!menu_visible)
@@ -288,6 +296,7 @@ void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT &
   menuinfo.cbSize = sizeof(MENUITEMINFOW);
   menuinfo.fMask = MIIM_FTYPE | MIIM_STATE | MIIM_ID | MIIM_STRING;
   menuinfo.fType = (menu_separator ? MFT_SEPARATOR : MFT_STRING);
+  menuinfo.fType += (next_menu_is_column ? MFT_MENUBARBREAK : 0);
   menuinfo.fState = (menu_enabled ? MFS_ENABLED : MFS_DISABLED);
   menuinfo.wID = menu_command_id;
   menuinfo.dwTypeData = (wchar_t*)title_utf16.c_str();
@@ -375,18 +384,27 @@ void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT &
     }
   }
 
+  //handle column separator
+  if (next_menu_is_column)
+  {
+    menuinfo.fType |= MFT_MENUBARBREAK;
+  }
+  next_menu_is_column = false;
+
   //handle submenus
   if (menu->IsParentMenu())
   {
     menuinfo.fMask |= MIIM_SUBMENU;
     HMENU hSubMenu = CreatePopupMenu();
 
+    bool next_sub_menu_is_column = false;
+
     shellanything::Menu::MenuPtrList subs = menu->GetSubMenus();
     UINT sub_insert_pos = 0;
     for(size_t i=0; i<subs.size(); i++)
     {
       shellanything::Menu * submenu = subs[i];
-      BuildMenuTree(hSubMenu, submenu, sub_insert_pos);
+      BuildMenuTree(hSubMenu, submenu, sub_insert_pos, next_sub_menu_is_column);
     }
 
     menuinfo.hSubMenu = hSubMenu;
@@ -425,6 +443,8 @@ void CContextMenu::BuildMenuTree(HMENU hMenu)
     m_BitmapCache.ResetCounters();
   }
 
+  bool next_menu_is_column = false;
+
   //browse through all shellanything menus and build the win32 popup menus
 
   //for each configuration
@@ -443,7 +463,7 @@ void CContextMenu::BuildMenuTree(HMENU hMenu)
         shellanything::Menu * menu = menus[j];
 
         //Add this menu to the tree
-        BuildMenuTree(hMenu, menu, insert_pos);
+        BuildMenuTree(hMenu, menu, insert_pos, next_menu_is_column);
       }
     }
   }
diff --git a/src/shellext.h b/src/shellext.h
@@ -119,7 +119,7 @@ class CContextMenu : public IContextMenu, IShellExtInit
 
 private:
   void BuildMenuTree(HMENU hMenu);
-  void BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT & insert_pos);
+  void BuildMenuTree(HMENU hMenu, shellanything::Menu * menu, UINT & insert_pos, bool & next_menu_is_column);
 };
 
 #endif //SA_SHELLEXTENSION_H
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -18,6 +18,7 @@ set(CONFIGURATION_TEST_FILES ""
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseActionMessage.xml
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseActionPrompt.xml
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseActionProperty.xml
+  ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseSeparator.xml
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseValidator.xml
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseDefaults.xml
   ${CMAKE_CURRENT_SOURCE_DIR}/test_files/TestObjectFactory.testParseIcon.xml
diff --git a/test/TestConfiguration.cpp b/test/TestConfiguration.cpp
@@ -119,6 +119,7 @@ namespace shellanything { namespace test
       "test_files\\TestObjectFactory.testParseDefaults.xml",
       "test_files\\TestObjectFactory.testParseIcon.xml",
       "test_files\\TestObjectFactory.testParseMenuMaxLength.xml",
+      "test_files\\TestObjectFactory.testParseSeparator.xml",
       "test_files\\TestObjectFactory.testParseValidator.xml",
       "test_files\\tests.xml",
     };
diff --git a/test/TestObjectFactory.cpp b/test/TestObjectFactory.cpp
@@ -705,6 +705,56 @@ namespace shellanything { namespace test
     ASSERT_TRUE(workspace.Cleanup()) << "Failed deleting workspace directory '" << workspace.GetBaseDirectory() << "'.";
   }
   //--------------------------------------------------------------------------------------------------
+  TEST_F(TestObjectFactory, testParseSeparator)
+  {
+    ConfigManager & cmgr = ConfigManager::GetInstance();
+ 
+    //Creating a temporary workspace for the test execution.
+    Workspace workspace;
+    ASSERT_FALSE(workspace.GetBaseDirectory().empty());
+
+    //Import the required files into the workspace
+    static const std::string path_separator = ra::filesystem::GetPathSeparatorStr();
+    std::string test_name = ra::testing::GetTestQualifiedName();
+    std::string template_source_path = std::string("test_files") + path_separator + test_name + ".xml";
+    ASSERT_TRUE(workspace.ImportFileUtf8(template_source_path.c_str()));
+    
+    //Wait to make sure that the next file copy/modification will not have the same timestamp
+    ra::timing::Millisleep(1500);
+ 
+    //Setup ConfigManager to read files from workspace
+    cmgr.ClearSearchPath();
+    cmgr.AddSearchPath(workspace.GetBaseDirectory());
+    cmgr.Refresh();
+ 
+    //ASSERT the file is loaded
+    Configuration::ConfigurationPtrList configs = cmgr.GetConfigurations();
+    ASSERT_EQ( 1, configs.size() );
+ 
+    //ASSERT a multiple menus are available
+    Menu::MenuPtrList menus = cmgr.GetConfigurations()[0]->GetMenus();
+    ASSERT_EQ(6, menus.size());
+
+    //Assert the following menus are separators
+    ASSERT_FALSE(menus[0]->IsSeparator());  // <menu name="menu00" />
+    ASSERT_TRUE (menus[1]->IsSeparator());  // <menu separator="true" />
+    ASSERT_TRUE (menus[2]->IsSeparator());  // <menu separator="horizontal" />
+    ASSERT_FALSE(menus[3]->IsSeparator());  // <menu separator="column" />
+    ASSERT_FALSE(menus[4]->IsSeparator());  // <menu separator="vertical" />
+    ASSERT_FALSE(menus[5]->IsSeparator());  // <menu name="menu05" />
+
+    //Assert the following menus are column separators
+    ASSERT_FALSE(menus[0]->IsColumnSeparator());  // <menu name="menu00" />
+    ASSERT_FALSE(menus[1]->IsColumnSeparator());  // <menu separator="true" />
+    ASSERT_FALSE(menus[2]->IsColumnSeparator());  // <menu separator="horizontal" />
+    ASSERT_TRUE (menus[3]->IsColumnSeparator());  // <menu separator="column" />
+    ASSERT_TRUE (menus[4]->IsColumnSeparator());  // <menu separator="vertical" />
+    ASSERT_FALSE(menus[5]->IsColumnSeparator());  // <menu name="menu05" />
+
+    //Cleanup
+    ASSERT_TRUE(workspace.Cleanup()) << "Failed deleting workspace directory '" << workspace.GetBaseDirectory() << "'.";
+  }
+  //--------------------------------------------------------------------------------------------------
  
 } //namespace test
 } //namespace shellanything
diff --git a/test/test_files/TestObjectFactory.testParseSeparator.xml b/test/test_files/TestObjectFactory.testParseSeparator.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <shell>
+    <menu name="menu00" />
+    <menu separator="true" />
+    <menu separator="horizontal" />
+    <menu separator="column" />
+    <menu separator="vertical" />
+    <menu name="menu05" />
+  </shell>
+</root>
