K-Meleon

Important - Work in Progress

K-Meleon Macro Language wiki page reorganization project

This page is my effort to better organize the page so it can display the new and expanded statements coming with the 1.5 version.

It is incomplete.

 
  Many items are shown only with placeholders.  It can and will change from
  time to time.  I will set up a thread in the general forum for discussion
  and comment.

                                                     JamesD

K-Meleon Macro Language


Contents


See also:


Comments

A line starting with # is a comment and is ignored.

# this is a comment


Variables and Macros

Variables are not declared explicitly, but must have a name starting with a dollar sign. A variable can either be global, accessible from any macro, or local to a specific macro. Before a variable can be used in an expression, it must be assigned a value. Integer and string values are available.

    $x = 0; 
    $y = "A text string";


Macro declarations consist of a macro name followed by a compound of statements enclosed in curly braces to execute for that macro. An optional assignment of a string value to 'menu' can be used to set the text shown when the macro is used in menus.

    example { 
        menu = "Menu text"; 
        $x = 0; 
    }


Expressions

The following operators are available:

Operator Meaning Sample Statement Integer Result
= assignement $x = 7; $x = 7
. string concatenation $x = 7 . 3; $x = 73
+ integer addition $x = 7 + 3; $x = 10
- integer subtraction $x = 7 - 3; $x = 4
* integer multiplication $x = 7 * 3; $x = 21
/ integer division $x = 7 / 3; $x = 2
% integer remainder $x = 7 % 3; $x = 1
== equality $x = 7 == 3; $x = 0
!= unequality $x = 7 != 3; $x = 1
<, <=, >, >= string comparison $x = 10 < 2 $x = 1
<, <=, >, >= integer comparison $x = +10 > +2 $x = 1
? : conditional expression $x = $y==1 ? 2:3; $x = 2 if y equals 1, $x = 3 otherwise

Parentheses can be used to alter the evaluation order. By default, addition and subtraction have higher precedence than multiplication, division and remainder operations.

When needed, a variable is automatically converted from a string to an integer, or vice versa.

    $x = 1 + "2";                       $x = 3  
    $y = "The value of x is " . x;      $y = "The value of x is 3"


Special Strings

Strings should be enclosed in double quotes although not required unless the string contains operators. A backslash is used to escape special characters:

\\ backslash (\)
\n newline character
\t tabulator
\" quotation mark (")

The string values "true" and "false" are recognized as boolean values and can be used in place of a conditional expression.

    $z = "false";
    $z ? $x = 1 : $x = 0;               $x = 0
    $z = "true";
    $z ? $x = 1 : $x = 0;               $x = 1


Special Global Variables

There is a number of predefined global variables to let K-Meleon macros access some global state information.

$ARG Argument given from caller plugin (not from caller macro). Since 0.9
$CHARSET Character encoding used for the current page. Since 1.0.
$FrameURL URL for the current frame. Since 0.8.2
$ImageURL URL for the current image. Since 0.8
$LinkURL URL for the current link. Since 0.8
$SelectedText Selected text in the current page. Since 1.0.
$TextZoom Text zoom factor for the current page. Since 1.0.
$TITLE Title for the current page. Since 0.9
$URL URL for the current page. Since 0.7
$URLBAR Contents of the URL bar. Since 1.0.

$ARG

K-Meleon's keyboard accelerators, its menu system and its plugins (but not the macros plugin itself) can call a macro with an argument:

macros(myMacro,"Hello world!")

A macro called this way, can get the argument reading the $ARG variable:

myMacro{
$data=$ARG;
alert($data);
# Don't use $ARG here
}

Never read $ARG after opening one of the Modal Windows (there's a bug). Assign the value of $ARG to a local variable as shown in the example.


Events

    OnActivateWindow
    OnCloseGroup
    OnCloseWindow
    OnInit
    OnLoad
    OnOpenWindow
    OnQuit
    OnSetup
    OnStartup
    OnWMAppExit


Statements

Statements should be finished by a semicolon. Statements may not span several lines!

    # THIS CODE IS INVALID
    $error = 1 +
        1;

Several statements can be lined up on the same line with a semicolon in between.

    $x = 0; $y = "A text string";


Conditional statements

The conditional expression operator (? :) can be used to execute a single statement depending on a certain condition.

A complete "If ... Then ... Else ..." statement would look like this:

    CONDITION ? STATEMENT_CONDITION_TRUE : STATEMENT_CONDITION_FALSE;

A simple "If ... Then ..." statement would look like this:

    CONDITION ? STATEMENT_CONDITION_TRUE : 0;

In the example above, nothing (0 = zero) is executed when the condition is false.

To execute multiple statements depending on a certain condition, these have to be encapsulated in helper macros:

    CONDITION ? &ConditionTrue : &ConditionFalse;

    ConditionTrue {
        ...
    }
    ConditionFalse {
        ...
    }


Documents


Document Manipulation

forcecharset() Since version 0.9
injectCSS() Since version 1.0
injectJS() Since version 1.0


Opening Documents

open() Since version 0.4
opennew() Since version 0.4
openbg() Since version 0.4
opentab() Since version 1.5
openbgtab() Since version 1.5

String Handling


General

    $I = index( s, t );                Since version 0.7

Returns the index of the string t in the string s, or -1 if t is not present.


    $LEN = length( s );                Since version 0.7

Returns the length of the string s.


    $SUB = substr( s, i [, n] );       Since version 0.7

Returns the at most n-character substring of s starting at i. If n is omitted, the rest of s is used.


Substitution


    $TRANSLATION = _( TEXT );      Since version 1.0

Replaces TEXT by the specified translation, if any.


    $SUB = gensub( r, s, h, t );             Since version 0.7

Searches the target string t for matches of the string r. If h is a string beginning with g or G, then all matches of r are replace with s. Otherwise, h is a number indicating which match of r to replace. The modified string is returned.


    $SUB = gsub( r, s, t );                Since version 0.7

Substitutes the string s for each substring matching the string r in the string t, and returns the modified string. This is equivalent to gensub( r, s, "G", t).


    $SUB = sub( r, s, t );                Since version 0.7

Just like gsub(), but only the first matching substring is replaced. This is equivalent to gensub( r, s, 1, t).


URLs

    $BASE = basename( URL [, SUFFIX] );    Since version 0.7

Returns URL with any leading directory components removed. If specified, also remove a trailing SUFFIX.

    $DIR = dirname( URL );               Since version 0.7

Returns URL with its trailing /component removed. If URL contains no '/', output '.' (meaning the current directory).

    $HOST = hostname( URL );            Since version 0.7

Returns the hostname of the given URL.

    $VALID_URL = urlencode( TEXT );        Since version 1.0

Encodes TEXT for use in an URL.


Iteration

    while( CONDITION ) STATEMENT ;                   Since version 1.0 

Executes a single STATEMENT while the CONDITION is true. To execute multiple statements, these have to be encapsulated in a helper macro:

    while( CONDITION ) &Loop;
Loop { ... }
    while( CONDITION ) { STATEMENT1 ; [STATEMENT2 ; [ ... ]] }             Since version 1.5

The syntax was extended to support execution of multiple statements.

    while ( CONDITION ) { 
    STATEMENT1 ;
    STATEMENT2 ;
    }    


Interfaces to


The User


Simple Dialogs / Modal Windows

    alert( MESSAGE [, TITLE [, ICON]] );       Since version 0.8

Shows a messagebox.
ICON = EXCLAIM | INFO | STOP | QUESTION

    $RESULT = confirm( MESSAGE [, TITLE [, BUTTONS [, ICON]]] );      Since version 0.9

Shows a messagebox and asks for confirmation.
BUTTONS = RETRYCANCEL | YESNO | YESNOCANCEL | ABORTRETRYIGNORE
ICON = EXCLAIM | INFO | STOP | QUESTION
RESULT = OK | YES | NO |ABORT | RETRY | IGNORE | 0

    $VALUE = prompt( MESSAGE [, TITLE [, DEFAULT_STRING]] );     Since version 0.7

Shows a modal 'prompt' dialog and returns a string value.


Setting Accelerator Key Definitions

   setaccel( keys [,command]);                 Since version 1.1

This method can be used to set keyboard accelerators instead of editing accel.cfg.

Parameter Required Type Value Meaning
keys YES STRING A key combination(1) The addressed key combination.
command YES STRING A command(2) The command to be associated with the key combination.

(1) A space-separated list of predefined key names.

(2) Command can be "ID_..." or "pluginName(pluginCommand)". If command is an empty string, this is a deletion.


Menus

    setmenu( MENU_NAME, ITEM_TYPE [, LABEL [, COMMAND]] [, WHERE]);    Since version 1.1
Parameter Type Meaning
MENU_NAME string Specifies the name of the addressed menu (required).
ITEM_TYPE predefined Specifies the nature of the addressed item (required).
Can be one of the strings: inline, popup, command, macro, separator.
LABEL (1) string Specifies the name of the addressed item inside the addressed menu.
COMMAND (2) string Specifies the command associated with the addressed item.
WHERE (3) string or integer
string
-1
n=0,1,2,...
Specifies where to insert the addressed item.
Insert before an item specified either by label or by command
Insert at the end of the addressed menu
Insert at position n of the addressed menu (1st position: 0)

(1) LABEL must be specified for all item types except "separator". If LABEL is an empty string, this is a deletion.
(2) COMMAND must be specified for item types "command" and "macro". If COMMAND is an empty string and LABEL is not, this is a deletion.
(3) WHERE can be omitted for all item types except "separator" (-1 is the default).

  menuchecked = boolean expression ;           Since version 1.1

This statement is used inside a macro to set a checkmark for this macro's menu representations. The checkmark's state is dynamically updated according to the value of the boolean expression. The latter is evaluated whenever a menu item representing this macro becomes visible.

Note that local variables are out of scope here, only globally defined variables can be used.

  menugrayed =  boolean expression ;            Since version 1.1

This statement is used inside a macro to enable and disable (gray out) this macro's menu representations. The enabled/disabled state is dynamically updated according to the value of the boolean expression. The latter is evaluated whenever a menu item representing this macro becomes visible.

Note that local variables are out of scope here, only globally defined variables can be used.

  rebuildmenu (menuName);                     Since version 1.1        

This method is used to rebuild a menu that was created by a setmenu() statement. Note that a menu must be rebuilt by rebuildmenu() inside the same macro where it was built by setmenu(). The rebuildmenu() statement takes effect only when the hosting macro is (directly or indirectly) called from the menus. See proxy.kmm for a usage demonstration.

Parameter Required Type Value Meaning
menuName YES STRING A menu name The name of the menu to be rebuilt.



The Operating System

   exec( COMMAND_LINE );        Since version 0.6

Executes an external program. Executes an external program.
Expanded environment variables Since version 1.0

                                
   $PATH = promptforfile( INITIAL_FOLDER, FILE_TYPE_DESCRIPTION, FILE_EXTENSION_PATTERN ); 
                                                                  Since version 1.0

Prompts the user for a file, displaying only the files matching the pattern.

    $PATH = promptforfolder( CAPTION [, INITIAL_FOLDER] );        Since version 1.0

Prompts the user for a folder.

    $CONTENT = readfile( PATH );               Since version 1.0

Returns the contents of the specified file (32 kB maximum). Only for little text files.

    $VALUE = readreg( ROOT, PATH );              Since version 1.0

Returns the value of the specified registry key.
ROOT = HKLM | HKCU | HKCC | HKCR | HKU


The Browser

 
   $PATH = getfolder( FOLDER_TYPE );            Since version 1.1

Returns the path of the specified folder.
FOLDER_TYPE = RootFolder | SettingsFolder | ProfileFolder | ResFolder | SkinFolder | MacroFolder | UserMacroFolder

 
   id( COMMAND_ID );                 Since version 0.7

Sends a message ID to the current window. See the complete list of command IDs.

   macros( MACRO1 );                                       Since version 0.7

Executes another macro.

    &MACRO;

Equivalent to macros( MACRO ).

   macros( MACRO1 [,MACRO2 [,MACRO3 [...]]] );            Since version 1.1 

Expanded to handle Multiple macro execution in version 1.1


The Browser Preference System

   delpref( prefName );                       Since version 0.9

Deletes any user set value of the specified preference. This restores the preference's default value if one is set, otherwise the preference is expunged.

   
   $VALUE = getpref( TYPE, "user.preference.variable" );         Since version 0.7

Gets a user preference.
TYPE = BOOL | INT | STRING

    
   setpref( TYPE, "user.preference.variable", VALUE );                 Since version 0.6

Sets a user preference.
TYPE = BOOL | INT | STRING

 
   togglepref( TYPE, "user.preference.variable", VALUE1, VALUE2, ... );     Since version 0.6        

Toggles a user preference between a series of values (booleans always toggle between true and false).
TYPE = BOOL | INT | STRING

The K-Meleon Plugins

 
   plugin( PLUGIN, COMMAND );                           Since version 0.7

   pluginmsg( PLUGIN, COMMAND, ARGS );      Since version 0.7

 
   $REPLY = pluginmsgex( PLUGIN, COMMAND, ARGS, TYPE );         Since version 0.7

Runs a plugin command. The possible values of COMMAND, ARGS and TYPE depend on the specific plugin. See the complete list of plugin commands.

The Clipboard

    $TEXT = getclipboard();       Since version 0.7

Gets data from the clipboard.

    setclipboard( TEXT );     Since version 0.7

Sets data to the clipboard.

The Statusbar

    statusbar( TEXT );      Since version 0.7

Shows the message text on the status bar.

Alphabetical Index

  
 * $ARG                         
 * $CHARSET                        
 * $FrameURL                                
 * $ImageURL                        
 * $LinkURL                        
 * $SelectedText        
 * $TextZoom        
 * $TITLE                        
 * $URL                        
 * $URLBAR
 * _()                        
 * alert()
 * basename()                
 * confirm()
 * delpref()                        
 * dirname()                
 * exec()
 * forcecharset()        
 * gensub()
 * getclipboard()        
 * getfolder()                
 * getpref()        
 * gsub()
 * hostname()
 * id()        
 * index()        
 * injectCSS()        
 * injectJS()        
 * length()
 * macros()        
 * menu                                                  0.4        depreciated
 * menuchecked        
 * menugrayed
 * open()        
 * openbg() 
 * openbgtab() 
 * opennew() 
 * opentab() 
 * plugin()
 * pluginmsg()
 * pluginmsgex()
 * prompt()                
 * promptforfile()        
 * promptforfolder()        
 * readfile()
 * readreg()        
 * rebuildmenu()
 * setaccel()          
 * setcheck()                                              0.9        depreciated
 * setclipboard()        
 * setmenu()        
 * setpref()        
 * statusbar()        
 * sub()        
 * substr()
 * togglepref()
 * urlencode()                
 * while()        
K-Meleon

(c) 2000-2010 kmeleonbrowser.org. All rights reserved.
design by splif.