Bug fixes & Sub-menu improvements

Allow Menu objects representing sub-menus to be inserted anywhere in the
parent menu list. Fixed bug with menu-bar break followed by sub-menu.
Allow sub-menus to be disabled.

Author: JohnHind

Distro/Winsh2-0.zip

@@ -0,0 +1,16 @@
+Generating the Published (read only) version of the documentation TiddlyWiki.
+-----------------------------------------------------------------------------
+
+The internal SaveAs function no longer works, so must process the file manually:
+
+1. Copy the source file to a new file.
+2. Find and edit the "Imprint" tiddler. Add the tag "$$!published!" to its tags.
+3. Find and delete all tiddlers tagged "excludePublished".
+4. Save and close the file.
+5. Open the file in a text editor.
+6. In the "versionArea" script section near the top of the file, edit the title "TiddlyWiki" to "TW".
+7. Save and close the file - it should now reopen in a browser as a read-only published version.
+
+NB: Step 6 prevents the TiddlySaver plugin for FireFox from bothering the user for permission
+to inject saver code into this file. Issue raised on GitHub - hopefully Jeremy will fix at some
+point.

Doc/Publishing.txt

@@ -1902,7 +1902,7 @@
 The ''Help'' menu contains commands to show various pieces of information including an inventory of resources available in the executable file. This information is supplied by functions defined in the '''"""INIT-CMD"""''' resource, which may be customised as required.
 </pre>
 </div>
-<div title="Introduction" creator="John Hind" modifier="John Hind" created="201005272040" modified="201402211438" tags="startup" changecount="10">
+<div title="Introduction" creator="John Hind" modifier="John Hind" created="201005272040" modified="201403240925" tags="startup" changecount="11">
 <pre>Winsh.lua is an advanced runtime for the [[Lua]] language on Windows. With the supplied libraries it is ideal for writing small, self-contained utilities with simple command line or graphical interfaces such as backup automation scripts, installers and portable application menus.
 
 Winsh.lua is compatible with all versions of Windows starting with Windows XP. However a few library features are only supported in later Windows versions. These are noted in this documentation and are designed to degrade as gracefully as possible.
@@ -1921,7 +1921,7 @@
 The [[Interactive Console]] and [[Lua]] topics are good starting points for new users.
 
 ----
-This help file was created using the superb and innovative &quot;&quot;&quot;TiddlyWiKi&quot;&quot;&quot;: http://classic.tiddlywiki.com/.</pre>
+This document was created using the superb and innovative &quot;&quot;&quot;TiddlyWiKi&quot;&quot;&quot;: http://classic.tiddlywiki.com/.</pre>
 </div>
 <div title="JHBackstagePlugin" creator="John Hind" modifier="John Hind" created="201102041649" modified="201102152102" tags="systemConfig excludeLists excludePublished excludeSearch excludeMissing" changecount="9">
 <pre>/***
@@ -3000,23 +3000,25 @@
 };
 //}}}</pre>
 </div>
-<div title="Menu Class" creator="John Hind" modifier="John Hind" created="201311231135" modified="201402211711" changecount="24">
+<div title="Menu Class" creator="John Hind" modifier="John Hind" created="201311231135" modified="201403241042" changecount="29">
 <pre>!menu = winsh.Menu([title] [, onshow] [, gutter])
-The Menu Class generates objects which represent menus of actions. Menu inherits from [[List Class]] and all List methods may be used to create and modify the menu list. The optional parameters initialise the pre-defined fields (see below). A string parameter initialises '''title''', a callable parameter initialises '''onshow''' and a boolean parameter '''gutter'''.
+The Menu Class generates objects which represent menus of actions. Menu inherits the methods of [[List Class]] and all List methods may be used to create and modify the menu list. However [[list:insert]] inserts Menu class objects as objects rather than as lists allowing sub-menus to be created. The optional parameters initialise some of the pre-defined fields (see below). A string parameter initialises '''title''', a callable parameter initialises '''onshow''' and a boolean parameter '''gutter'''.
 
 Each list item must have a value comprising one of the following:
 * A [[Command Class]] object representing a command which may be executed from the menu.
 * A [[Menu Class]] object representing a sub-menu which may be opened from the menu.
 * A string &quot;-&quot; which causes a horizontal separator line to be drawn.
 * A string &quot;|&quot; which specifies a column split dividing the menu into two columns.
 * A string (not one of the above) which becomes a non-selectable menu item (heading) unless it exists in a column on its own, in which case it becomes a vertical side-bar label.
-The pre-defined (read-only) fields are as follows:
+The pre-defined fields are as follows:
 ;'''title'''
 :This string value is the menu text shown for a sub-menu. If a menu object is used to define a sub-menu and this field is missing the default text &quot;sub menu&quot; is used.
 ;'''onshow'''
 :This is an optional field and if present the value can be any callable Lua object (usually a function) which is called immediately prior to showing the menu and passed a single parameter, the Menu object. It can be used to modify the Menu or Command objects to vary the appearance and function of the menu that is shown to the user.
 ;'''gutter'''
 :If present this overrides the default handling which shows a gutter if any Command objects in the menu or any sub-menus have '''icon''' or boolean '''value''' fields and not otherwise. Set to boolean {{{true}}} to show the gutter always, or boolean {{{false}}} to hide it always (in which case icons will be ignored and boolean '''value''' will be rendered using text colour rather than checkmarks). The setting applies globally to the menu and all of its sub-menus, and the '''gutter''' key should be applied in the main Menu table (however '''gutter''' {{{true}}} in a sub-menu will have effect as long as there is no '''gutter''' {{{false}}} in a parent menu or a subsequent sub-menu).
+;'''disabled'''
+:This field is initialised {{{false}}}. It may be changed (usually in an '''onshow''' function). It only has effect for a menu used as a submenu within another menu. If it is true when the menu is shown, the title entry for the sub-menu is shown disabled and the menu itself is not shown.
 </pre>
 </div>
 <div title="Nested Sliders" creator="John Hind" modifier="John Hind" created="201102061601" modified="201105211433" tags="excludeLists excludePublished excludeSearch excludeMissing">
@@ -3821,14 +3823,15 @@
 [[key:deletevalue]] - Delete a named value of the current key.
 </pre>
 </div>
-<div title="Release 2.0" creator="John Hind" modifier="John Hind" created="201102271549" modified="201402181749" tags="imprint excludeLists" changecount="16">
+<div title="Release 2.0" creator="John Hind" modifier="John Hind" created="201102271549" modified="201403251041" tags="imprint excludeLists" changecount="26">
 <pre>|Name|Winsh|
 |Author|[[John Hind]]|
-|Version|2.0|
-|Copyright|&amp;copy;2012 [[John Hind]]|
-|Release Date|26th November 2012|
+|Version|2.0.1|
+|Copyright|&amp;copy;2014 [[John Hind]]|
+|Release Date|25th March 2014|
 {{H3{Release Notes}}}
-&gt;2.0 - Changed object model and added clipboard support.
+&gt;2.0.1 - Added {{{__whole}}} metafield for [[List Class]]. Used this to fix sub-menu insertion. Added {{{disabled}}} field to [[Menu Class]] (for sub-menus).
+&gt;2.0 - Changed object model and added clipboard support. Updated Lua core to 5.2.2. Changed name from Grunt to Winsh.
 &gt;1.2 - Updated the &quot;&quot;&quot;Self-Iterating&quot;&quot;&quot; Objects Lua patch, changed [[winsh.taskicon]].
 &gt;1.1 - Upgraded Lua core to 5.2.1.
 ''&lt;&lt;publish&gt;&gt;''</pre>
@@ -5166,7 +5169,7 @@
 
 %/&lt;&lt;tiddler {{'ShowPopup##'+('$1'=='$'+'1'?'info':'show')}} with: [[$1]] [[$2]] [[$3]] [[$4]] [[$5]] [[$6]]&gt;&gt;</pre>
 </div>
-<div title="Side-by-side Execution" creator="John Hind" modifier="John Hind" created="201005292130" modified="201402211459" changecount="4">
+<div title="Side-by-side Execution" creator="John Hind" modifier="John Hind" created="201005292130" modified="201403061230" changecount="5">
 <pre>This is like [[Command-line Execution]] except that no command-line is required. Winsh will look for a folder or file with the same name as its own executable and in the same folder, but with the extension {{{.lua}}} rather than {{{.exe}}}. Note that the filename of the Winsh Executable may be changed to reflect the application, allowing more than one script system to exist in the same folder.
 
 For example, assuming the following directory layout ({{{myapp.exe}}} being one of the [[Winsh Executables]] renamed):
@@ -5177,11 +5180,11 @@
 Executing {{{myapp.exe}}} will load and run {{{myapp.lua}}}. Alternatively, with the following layout:
 {{{
 C:\test\myapp.exe
-C:\test\myapp\start.lua
-C:\test\myapp\library1.lua
-C:\test\myapp\lib\library2.dll
+C:\test\myapp.lua\start.lua
+C:\test\myapp.lua\library1.lua
+C:\test\myapp.lua\lib\library2.dll
 }}}
-Then executing {{{myapp.exe}}} will load and run {{{myapp\start.lua}}} and that script may contain the following Lua statements:
+Then executing {{{myapp.exe}}} will load and run {{{myapp.lua\start.lua}}} and that script may contain the following Lua statements:
 {{{
 lib1 = require(&quot;library1&quot;)
 lib2 = require(&quot;lib.library2&quot;)
@@ -7687,10 +7690,14 @@
 }}}
 </pre>
 </div>
-<div title="list:insert" creator="John Hind" modifier="John Hind" created="201005152140" modified="201312131731" changecount="6">
+<div title="list:insert" creator="John Hind" modifier="John Hind" created="201005152140" modified="201403241050" changecount="8">
 <pre>!list:insert(index, item)
 
-If ''item'' is a List object, the elements in this list are inserted into the list, otherwise, ''item'' is inserted as a single entry. The elements are inserted into the list starting at the given ''index''. Negative indexes are also supported with {{{-1}}} being the last item in the current List, and {{{0}}} meaning to add the new items at the end of the List. The original item at the specified ''index'', and all the subsequent items, are shifted after the inserted items.
+If ''item'' is a List object, the elements in this list are inserted into the list, otherwise, ''item'' is inserted as a single entry.
+
+The elements are inserted into the list starting at the given ''index''. Negative indexes are also supported with {{{-1}}} being the last item in the current List, and {{{0}}} representing the index after the last item in the current List. The original item at the specified ''index'', and all the subsequent items, are shifted after the inserted items.
+
+Expansion of inserted lists may be overridden for derived classes by providing a {{{__whole}}} metafield. If the object being inserted has this metafield and it tests {{{true}}}, then it is inserted as a single entry, the value being the object itself.
 {{{
 lst = List(&quot;one&quot;, &quot;two&quot;, &quot;three&quot;)
 lst:insert(-2, &quot;one.one&quot;)

Doc/Winsh.html

@@ -14,8 +14,6 @@ Packing options are designed to avoid the need for installation and to be locati
 
 A runtime package containing several alternative pre-built binaries and documentation can be downloaded here:
 
-https://github.com/JohnHind/Winsh.lua/releases/tag/2.0.0
-
 The sources on this site can be built using Visual Studio 2010 or later, or probably in any C++ environment with some work. The sources comprise the following:
 
 Patched Lua sources and a project to build these into an object code library.

README.md

@@ -169,7 +169,7 @@ do  -- Class 'List' (extends partial implementation in C)
 		if ip < 0 then ip = t + ip end
 		if ip == 0 then ip = t end
 		if ip < 1 or ip > t then error("Insert: index out of range") end
-		if T.istype(v, _C) then
+		if T.istype(v, _C) and not v.__whole then
 			local sv = #v
 			local p = t - ip
 			if sv <= p then
@@ -194,20 +194,20 @@ do  -- Class 'List' (extends partial implementation in C)
 			self[ip] = v
 		end
 	end
-        function _TID:remove(p1, p2)
-            T.checkmethod(self, _C)
-            local t = #self + 1
-            p1 = T.tonumber(p1 or t-1)
-            if p1 < 0 then p1 = t + p1 end
-            if p1 < 1 or p1 >= t then error("Remove: index out of range") end
-            p2 = T.tonumber(p2 or p1)
-            if p2 < 0 then p2 = t + p2 end
-            if p2 < p1 then p2 = p1 end
-            local d = p2 - p1 + 1
-            for i=p2+1, t-1 do self[i-d] = self[i] end
-            for i=t-1, t-d, -1 do self[i] = nil end
-        end
-        function _TID:reverse()
+	function _TID:remove(p1, p2)
+		T.checkmethod(self, _C)
+		local t = #self + 1
+		p1 = T.tonumber(p1 or t-1)
+		if p1 < 0 then p1 = t + p1 end
+		if p1 < 1 or p1 >= t then error("Remove: index out of range") end
+		p2 = T.tonumber(p2 or p1)
+		if p2 < 0 then p2 = t + p2 end
+		if p2 < p1 then p2 = p1 end
+		local d = p2 - p1 + 1
+		for i=p2+1, t-1 do self[i-d] = self[i] end
+		for i=t-1, t-d, -1 do self[i] = nil end
+	end
+	function _TID:reverse()
 		T.checkmethod(self, _C)
 		local e = #self
 		for i=1, e/2 do

Winsh/Libraries/LibClass.lua

@@ -10,11 +10,11 @@ WORD GcFirstMenuID = 0;				//The first Menu ID allocated when winsh.taskicon fir
 WORD GcLastMenuID = 0;				//The last Menu ID in the block allocated as above (0 means not done yet)
 WORD GcNRCid = 0;					//The ID of the Notify Icon Right-click message
 WORD GcNLCid = 0;					//The ID of the Notify Icon left-click message
-int GcRefRMenuTable = LUA_NOREF;		//The Registry Table key for the table used to define the Right task icon menu
-int GcRefLMenuTable = LUA_NOREF;     //The Registry Table key for the table used to define the Left task icon menu
-bool m_leftMenu = false;				//Is a menu enabled for notify icon left click?
-bool m_rightMenu = false;               //Is a menu enabled for notify icon right click?
-int GcNextKeyID = 1;					//The next HotKey ID available for allocation
+int GcRefRMenuTable = LUA_NOREF;	//The Registry Table key for the table used to define the Right task icon menu
+int GcRefLMenuTable = LUA_NOREF;    //The Registry Table key for the table used to define the Left task icon menu
+bool m_leftMenu = false;			//Is a menu enabled for notify icon left click?
+bool m_rightMenu = false;           //Is a menu enabled for notify icon right click?
+int GcNextKeyID = 1;				//The next HotKey ID available for allocation
 int GcCmdCount = 0;					//The number of times winsh.commandline has been used from Lua
 int GcRepAct = 0;					//Message code for first of two timer messages for setreport.
 
@@ -115,9 +115,13 @@ int gc_DoPrepMenu(lua_State* L, CMenuHandle m, int mn, WORD* id)
 			lua_getfield(L, -1, "title");		//|text|submenutab|menutab|...
 			CString n(lua_tostring(L, -1));
 			lua_pop(L, 1);						//|submenutab|menutab|...
+			lua_getfield(L, -1, "disabled");	//|da|submenutab|menutab|...
+			da = lua_toboolean(L, -1);
+			lua_pop(L, 1);						//|submenutab|menutab|...
 			HICON h = NULL;
 			CMenuHandle sm; sm.CreatePopupMenu();
 			UINT f = MF_POPUP; f |= (da? MF_GRAYED : MF_ENABLED);
+			if (bk) f |= MF_MENUBARBREAK; bk = false;
 			H->Menu(mn)->AppendCCMenu(m, f, (UINT_PTR)sm.m_hMenu, n, h);
 			if (!da) gt = gc_DoPrepMenu(L, sm, mn, id);	//Recursively call this routine to prepare the sub-menu
 			lua_pop(L, 1);						//|menutab|...
@@ -128,7 +132,7 @@ int gc_DoPrepMenu(lua_State* L, CMenuHandle m, int mn, WORD* id)
 			lua_getfield(L, -1, "title");		//|text|command|menutab|...
 			if (lua_isstring(L, -1)) n = CString(lua_tostring(L, -1));
 			lua_pop(L, 1);						//|command|menutab|...
-			lua_getfield(L, -1, "disabled");	//|df|command|menutab|...
+			lua_getfield(L, -1, "disabled");	//|da|command|menutab|...
 			da = lua_toboolean(L, -1);
 			lua_pop(L, 1);						//|command|menutab|...
 			HICON h = NULL;

Winsh/Libraries/LibGC.cpp

@@ -2,10 +2,11 @@
 local T = ...
 local C = require("class")
 
-do  -- Class 'Menu' (inherits List)
+do  -- Class 'Menu' (inherits List methods, but is not a list)
 	local _TID, _PC = C.newmeta(C.List)
 	local _C = function(...)
 	    local o = _PC()
+		C.rawset(o, "disabled", false)
 		for i=1, 3 do
 			local x = select(i,...)
 			if not o.title and C.istype(x,'string') then
@@ -19,11 +20,12 @@ do  -- Class 'Menu' (inherits List)
 		C.setmetatable(o, _TID)
 		return o
 	end
-	C.rawset(_TID, "__tostring", function()
+	C.rawset(_TID, "__tostring", function(self)
 		return "Menu:" .. (self.title or "anon")
 	end)
-	C.rawset(_TID, "__iter", C.pairs)
+	C.rawset(_TID, "__iter", C.gettid(_PC).__iter)
 	C.rawset(_TID, "__newindex", C.gettid(_PC).__newindex)
+	C.rawset(_TID, "__whole", true)
 	T.Menu = _C
 end -- Class 'Menu'
 

Winsh/Libraries/LibGC.lua

@@ -160,20 +160,24 @@ END
 // Icon
 //
 
-// Icon with lowest ID value placed first to ensure application icon
-// remains consistent on all systems.
+// The application icon - must be first in file, compiler sorts
+// alphabetically, letters before numbers:
+AA.WINSH                ICON                    "res\\lua-std.ico"
+
+// Numbered icons for console commands (menus):
 ID_EDIT_DELETE          ICON                    "res\\delete.ico"
-WINSH.LUA               ICON                    "res\\lua-std.ico"
-LOCK                    ICON                    "res\\lock.ico"
-LOCK2                   ICON                    "res\\lock48.ico"
-KEY                     ICON                    "res\\key.ico"
-SAFE                    ICON                    "res\\safe.ico"
 ID_EDIT_CUT             ICON                    "res\\cut.ico"
 ID_EDIT_COPY            ICON                    "res\\copy.ico"
 ID_EDIT_PASTE           ICON                    "res\\paste.ico"
 ID_EDIT_UNDO            ICON                    "res\\undo.ico"
 ID_HELP                 ICON                    "res\\help.ico"
 
+// Named icons are available to Grunt (freely add or remove):
+LOCK                    ICON                    "res\\lock.ico"
+LOCK2                   ICON                    "res\\lock48.ico"
+KEY                     ICON                    "res\\key.ico"
+SAFE                    ICON                    "res\\safe.ico"
+
 /////////////////////////////////////////////////////////////////////////////
 //
 // LUA

Winsh/Winsh.rc

@@ -82,14 +82,14 @@
     <OutDir Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Debug\</OutDir>
     <IntDir Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Debug\</IntDir>
     <LinkIncremental Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">true</LinkIncremental>
-    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Win)|Win32'">$(Configuration)\</OutDir>
-    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Win)|Win32'">$(Configuration)\</OutDir>
+    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Win)|Win32'">$(SolutionDir)Distro\</OutDir>
+    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Win)|Win32'">$(SolutionDir)Distro\</OutDir>
     <IntDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Win)|Win32'">$(Configuration)\</IntDir>
     <IntDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Win)|Win32'">$(Configuration)\</IntDir>
     <LinkIncremental Condition="'$(Configuration)|$(Platform)'=='Release (Max Win)|Win32'">false</LinkIncremental>
     <LinkIncremental Condition="'$(Configuration)|$(Platform)'=='Release (Std Win)|Win32'">false</LinkIncremental>
-    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Con)|Win32'">$(Configuration)\</OutDir>
-    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Con)|Win32'">$(Configuration)\</OutDir>
+    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Con)|Win32'">$(SolutionDir)Distro\</OutDir>
+    <OutDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Con)|Win32'">$(SolutionDir)Distro\</OutDir>
     <IntDir Condition="'$(Configuration)|$(Platform)'=='Release (Max Con)|Win32'">$(Configuration)\</IntDir>
     <IntDir Condition="'$(Configuration)|$(Platform)'=='Release (Std Con)|Win32'">$(Configuration)\</IntDir>
     <LinkIncremental Condition="'$(Configuration)|$(Platform)'=='Release (Max Con)|Win32'">false</LinkIncremental>