XYplorer Beta Club

#! SCRIPT_ENGINE = 2
/*	SHEBANG!
	To keep backwards compatibility this will be required and specifies
	the version of the script engine to use. Eventually the current engine
	could be removed, but this allows for a smoother transition to the new one.

	We should probably require it be the first line, first column as well.
*/


[GLOBALS]
	/*	GLOBAL VARS (Script File Level)
		We nearly have this, but ideally these variables could be referenced
		like normal variables and not require the use of GetKey() or Global().

		Using the INI format we should be able to leverage SetKey() to keep
		them updated if we want to, otherwise they'd be used for static values.
	*/
G_SCRIPT_NAME = "blah blah"
G_DEFAULT_MENUITEM_STATE = 0


def FunctionName (arg1, arg2="") {
	/*	USER FUNCTIONS
		Essentially a normal script with args and returns.

		Arg1 is required.
		Arg2 is optional with a default value of "".
		Required arguments must always preceed optional ones.

		Use "return [expression]" to return a value.
		If expression or the return command is omitted 1 should be returned.
	*/
}

1. When the file is loaded:
2. If a caption is specified and it matches a functionName (or is an index): Execute "caption"
3. Else If a function is named "main": Execute "main"
4. Else: Execute first function.

1. MenuItem "MenuName"[, "Action", "Caption", "Description", "Icon", "State"];
2. MenuSub "MenuName", "SubMenu"[, "Caption", "Description", "Icon", "State"];
3. DisplayMenu "Menus"[, "Description"];

• Required Args:
  • MenuName
    • This is the name of the menu to add items to.
• Optional Args:
  • Action
    • This is the function name or a small script to execute when this item is selected.
    • If omitted, a separator is inserted.
  • Caption
    • Text to display in the menu for this item. Using & for accelerators.
  • Description
    • A brief description of the item for display in the status bar.
  • Icon
    • Path to an icon to display for this item.
  • State
    • State of this item.
    • Combination of the following OR-ed:
      • 1 = Default
      • 2 = Checked
      • 4 = Disabled

• Required Args:
  • MenuName
    • This is the name of the menu to add a submenu to.
  • SubMenu
    • This is the name of the menu to add as the submenu.
    • You should create the submenu before you add it to another menu.
• Optional Args:
  • Caption
    • Text to display in the menu for this item. Using & for accelerators.
  • Description
    • A brief description of the item for display in the status bar.
  • Icon
    • Path to an icon to display for this item.
  • State
    • State of this item.
    • Combination of the following OR-ed:
      • 1 = Default
      • 2 = Checked
      • 4 = Disabled

• Required Args:
  • Menus
    • This is the name of the menu to display.
    • This can be a list of menus separated by "|" to join them into a single menu.
• Optional Args:
  • Description
    • A brief description that is displayed on the status bar, when the menu is displayed, or not item is highlighted.

admin wrote:The obvious other candidate is function.

admin wrote:The obvious other candidate is function.

j_c_hallgren wrote:The only thing I'd suggest is some way to make the 1+2+4 into some labels, such as Dft/Chk/Dis or combined as DftChk or similar.

TheQwerty wrote:Some preliminary thoughts:...

"!Go C:\Temp|C:\Temp" goto "C:\Temp";
"_noIcons" echo("Hasta la vista, icons! Mwahaha!");
"Go Desktop|Desktop" goto "Desktop";
"Go XY exe|<xypath>\XYplorer.exe" goto "<xypath>\XYplorer.exe";
"-"
"Open With Photoshop|Photoshop" openwith "Photoshop";
"Open With Notepad|Notepad" openwith "Notepad";

admin wrote:How would this menu definition look in the syntax your are proposing?

Code: Select all

"!Go C:\Temp|C:\Temp" goto "C:\Temp";
"_noIcons" echo("Hasta la vista, icons! Mwahaha!");
"Go Desktop|Desktop" goto "Desktop";
"Go XY exe|<xypath>\XYplorer.exe" goto "<xypath>\XYplorer.exe";
"-"
"Open With Photoshop|Photoshop" openwith "Photoshop";
"Open With Notepad|Notepad" openwith "Notepad";

#! SCRIPT_ENGINE = 2

def main() { //Construct and Display the Main Menu
	MenuItem "MainMenu", 'goto "C:\Temp";', "Go C:\Temp",, "C:\Temp", "B";
	MenuItem "MainMenu", 'goto "Desktop";', "Go Desktop",, "Desktop";
	MenuItem "MainMenu", "goto ""<xypath>\XYplorer.exe"";", "Go XY exe",, "<xypath>\XYplorer.exe";
	MenuItem "MainMenu";
	MenuItem "MainMenu", 'openwith "Photoshop"', "Open With Photoshop",, "Photoshop";
	MenuItem "MainMenu", 'openwith "Notepad"', "Open With Notepad",, "Notepad";
	DisplayMenu "MainMenu";
}

def noIcons() { //Display a funny message.
	echo("Hasta la vista, icons! Mwahaha!");
}

#! SCRIPT_ENGINE = 2

def main() { //Construct and Display the Main Menu
	GoItem("C:\Temp",, "B");
	GoItem("Desktop");
	GoItem(, "Go XY exe");
	MenuItem "MainMenu";
	MenuItem "MainMenu", 'openwith "Photoshop"', "Open With Photoshop",, "Photoshop";
	MenuItem "MainMenu", 'openwith "Notepad"', "Open With Notepad",, "Notepad";
	DisplayMenu "MainMenu";
}

def GoItem($path="<xypath>", $caption="", $state="", $menu="MainMenu") { //Add menu items for goto scripts.
	$caption = ($caption) ? $caption : "Go $path";
	MenuItem "$menu", "goto ""$path"";", "$caption",, "$path", "$state"
}

def noIcons() { //Display a funny message.
	echo("Hasta la vista, icons! Mwahaha!");
}

#! SCRIPT_ENGINE = 2

def main() { //Construct and Display the Main Menu
	MenuItem "MainMenu";
	MenuItem "MainMenu", 'openwith "Photoshop"', "Open With Photoshop",, "Photoshop";
	MenuItem "MainMenu", 'openwith "Notepad"', "Open With Notepad",, "Notepad";
	DisplayMenu GoMenu() . "|MainMenu"; //Concatenate the menu created by GoMenu to the MainMenu.
}

def GoMenu($menu="GoMenu") { //Create a menu of just the Goto Items.
	GoItem("$menu", "C:\Temp",, "B");
	GoItem("$menu", "Desktop");
	GoItem("$menu",, "Go XY exe");
	return "$menu";
}

def GoItem($menu="MainMenu", $path="<xypath>", $caption="", $state="") { //Add menu items for goto scripts.
	$caption = ($caption) ? $caption : "Go $path";
	MenuItem "$menu", "goto '$path';", "$caption",, "$path", "$state"
}

def noIcons() { //Display a funny message.
	echo("Hasta la vista, icons! Mwahaha!");
}

#! SCRIPT_ENGINE = 2

def main() { //Construct and Display the Main Menu
	MenuSub "MainMenu", GoMenu(), "Go Submenu";
	MenuSub "MainMenu", OWMenu(), "Open With Submenu";
	DisplayMenu "MainMenu";
}

def GoMenu($menu="GoMenu") { //Create a menu of just the goto items.
	GoItem("$menu", "C:\Temp",, "B");
	GoItem("$menu", "Desktop");
	GoItem("$menu", , "Go XY exe");
	return "$menu";
}

def GoItem($menu="MainMenu", $path="<xypath>", $caption="", $state="") { //Add menu items for goto scripts.
	$caption = ($caption) ? $caption : "Go $path";
	MenuItem "$menu", "goto '$path';", "$caption",, "$path", "$state"
}

def OWMenu() { //Create a menu of just Open With items.
	MenuItem "OWMenu", 'openwith "Photoshop"', "Open With Photoshop",, "Photoshop";
	MenuItem "OWMenu", 'openwith "Notepad"', "Open With Notepad",, "Notepad";
	return "OWMenu";
}

def noIcons() { //Display a funny message.
	echo("Hasta la vista, icons! Mwahaha!");
}

admin wrote:How would this menu definition look in the syntax your are proposing?

#! SCRIPT_ENGINE = 2

function main()
{
	MenuItem 'mnuMain', goto 'C:\Temp', 'Go C:\Temp',, 'C:\Temp', 1;
	MenuItem 'mnuMain', goto 'Desktop', 'Go Desktop',, 'Desktop';
	MenuItem 'mnuMain', goto "<xypath>\XYplorer.exe", 'Go XY exe',, "<xypath>\XYplorer.exe";
	MenuItem 'mnuMain';
	MenuItem 'mnuMain', openwith 'Photoshop', 'Open With Photoshop',, 'Photoshop';
	MenuItem 'mnuMain', openwith 'Notepad', 'Open With Notepad',, 'Notepad';
	DisplayMenu 'mnuMain';
}
function noIcons() { echo("Hasta la vista, icons! Mwahaha!"); }

TheQwerty wrote:

admin wrote:How would this menu definition look in the syntax your are proposing?

Code: Select all

"!Go C:\Temp|C:\Temp" goto "C:\Temp";
"_noIcons" echo("Hasta la vista, icons! Mwahaha!");
"Go Desktop|Desktop" goto "Desktop";
"Go XY exe|<xypath>\XYplorer.exe" goto "<xypath>\XYplorer.exe";
"-"
"Open With Photoshop|Photoshop" openwith "Photoshop";
"Open With Notepad|Notepad" openwith "Notepad";

Well I'm not sure which way I'd go about it, but you'd certainly have a number of options..
(I'd probably lean towards method 2 in this case.)
...

item("Go C:\Temp", "C:\Temp", 1) {goto "C:\Temp";}
item _noIcons() {echo("Hasta la vista, icons! Mwahaha!");}
item("Go Desktop", "Desktop") {goto "Desktop"};
item("Go XY exe", "<xypath>\XYplorer.exe") {goto "<xypath>\XYplorer.exe";}
-
item("Open With Photoshop", "Photoshop") {openwith "Photoshop";}
item("Open With Notepad", "Notepad") {openwith "Notepad";}

jacky wrote:If I got it right, I guess it could look something like this:

jacky wrote:- Yeah, I think I like "function" better than "def"

jacky wrote:- It is "odd" that here we set action first, caption then, while it is the opposite in the current script syntax. I wonder if this shouldn't be switched, to make it less confusing.

jacky wrote:- I'm not sure how that whole "Action" parameter would work. It can't just be a script, otherwise there's no way to use a coma for parameters since they could refer to both command within this script, or command menuitem. I think it might be easier to just say this arg must be a function name (or maybe a script but within { } then, though that could lead to odd-looking things maybe...).

jacky wrote:Nothing to do with this, but I'd disagree with no "return" means returning TRUE (1). I'd say no "return" (or no return value) means returning nothing/empty string.

TheQwerty wrote:The reason I ordered them this way is because the caption is optional, and it's generally less confusing if required parameters come before optional ones. I wouldn't object to changing it, but I think if we did it would work better if the caption was required as well then.

jacky wrote:

TheQwerty wrote:The reason I ordered them this way is because the caption is optional, and it's generally less confusing if required parameters come before optional ones. I wouldn't object to changing it, but I think if we did it would work better if the caption was required as well then.

Yeah I figured as much, but I just kept finding it odd (and checking back) that it was reversed of the usual/current way, where caption comes first even though it is optional...

@Don: Yeah, but the major advantage of TheQwerty's proposal is user-functions!! Sure it has cool things for menus, but also user functions!!

item("Go C:\Temp", "C:\Temp", 1) {goto "C:\Temp";}
item("Go Desktop", "Desktop") {goto "Desktop"};
item("Go XY exe", "<xypath>\XYplorer.exe") {goto "<xypath>\XYplorer.exe";}
item("-")
item("Open With Photoshop", "Photoshop") {openwith "Photoshop";}
item("Open With Notepad", "Notepad") {openwith "Notepad";}
function noIcons() {echo("Hasta la vista, icons! Mwahaha!");}

admin wrote:

Code: Select all

item("Go C:\Temp", "C:\Temp", 1) {goto "C:\Temp";}
item("Go Desktop", "Desktop") {goto "Desktop"};
item("Go XY exe", "<xypath>\XYplorer.exe") {goto "<xypath>\XYplorer.exe";}
item("-")
item("Open With Photoshop", "Photoshop") {openwith "Photoshop";}
item("Open With Notepad", "Notepad") {openwith "Notepad";}
function noIcons() {echo("Hasta la vista, icons! Mwahaha!");}

TheQwerty wrote:

admin wrote:

Code: Select all

item("Go C:\Temp", "C:\Temp", 1) {goto "C:\Temp";}
item("Go Desktop", "Desktop") {goto "Desktop"};
item("Go XY exe", "<xypath>\XYplorer.exe") {goto "<xypath>\XYplorer.exe";}
item("-")
item("Open With Photoshop", "Photoshop") {openwith "Photoshop";}
item("Open With Notepad", "Notepad") {openwith "Notepad";}
function noIcons() {echo("Hasta la vista, icons! Mwahaha!");}

I'm not entirely understanding how you are using item here. Could it be called within a function?
Or for instance how would your script toggle a menu item that is using the check mark?

How would we go about creating dynamic menus or sub-menus?

admin wrote:Dynamic menus or sub-menus? I never said I'd plan that.

TheQwerty wrote:

admin wrote:Dynamic menus or sub-menus? I never said I'd plan that.

Well without Dynamic menus your version is a step backwards as far as menus are concerned. The ability to disable, define a default, and barely use checkmarks isn't worth losing the ability to change the menu on the fly.