Menu-Framework-SMP

A helper script for Spider Monkey Panel and foobar2000 which allows to easily create customizable menus on demand which can be easily refactored, moved or edited without working with static ids. A lifesaver.

The problem with current SMP menus

Menus are usually coded at multiple places which must be linked by ID, storing and sharing the different variables for menus and submenus when you have multiple objects using them, etc. It leads to 2 clear problems: non readability and maintenance nightmare.

Using this framework it would translate into this:

Features

• Creates menus on demand on panels without needing to create specific methods for every script, calculate IDs, etc.
• Menus are pushed to a list and created automatically on demand, linking the entries to their idx without needing a 'switch' block or leaving holes to ensure idx get enough numbers to expand the script.
• The main utility of this helper is greatly reducing coding for simple menus and having both, the menu logic creation and the menus' functions on the same place. Creation order is done following entry/menus addition.
• Can concatenate multiple menus on btn_up().
• Full support for Context and Main menu managers.
• Coverage of all native SMP features, flags, checks, etc.

Usage

First create the menu object. That's the main one and also includes a 'main menu' to append items to it:

const menu = new _menu();
menu.newEntry({menu, entryText: 'hello', func: () => {console.log('hello')}}); // Shorthand notation
menu.newEntry({entryText: 'hello2', func: () => {console.log('hello2')}}); // Or omit the menu, to append directly to main one
menu.newEntry({entryText: 'sep'}); // You can also add a separator

Then, you may want to create sub-menus linked to it. To do that, just create a new menu entry within the object:

const subMenu = menu.newMenu('This is a submenu'); // It will be added just after the last declared entry!
menu.newEntry({menuName: subMenu, entryText: 'This is my func', func: yourFunc);

Sub-menus can also be dynamically created:

var bSubMenu = true;
const funct = () => {return (bSubMenu) ? 'SubMenu 1' : 'SubMenu 2';};
menu.newMenu(funct);
menu.newEntry({menuName: funct, entryText: 'Change SubMenu', func: () => {bSubMenu = !bSubMenu}});
menu.newEntry({menuName: funct, entryText:'Hola 3', func: () => {console.log('Hola3')}, flags: () => {return (bSubMenu) ? MF_STRING : MF_GRAYED}});

Finally, lets call it with a callback:

function on_mouse_rbtn_up(x, y) {return menu.btn_up(x, y);}

Or an event listener:

addEventListener('on_mouse_rbtn_up', menu.btn_up);

There are more usage examples on the 'examples' folder and full documentation on the header of 'menu_xxx.js'.

Other implementations

1. Playlist-Tools-SMP: Different tools for foobar2000. The dynamic configurable menu is built using this.
2. Playlist-Manager-SMP: A playlist manager for foobar2000. The static menus use this.

Installation

Since the framework only requires 1 file, i.e. the main one, you can simply include it along any other script where you will use the menu.