commands.c

LastWave

  "colormap",C_ColorMap,"{{{new [<colorMap>=<currentColorMap>] <nbOfColors>} {Creates/Modifies the <colorMap> so that it can store <nbOfColors> colors.}} \
{{current [<colorMap>]} {Gets/Sets the current color map.}} \
{{size [<colorMap>=<currentColorMap>]} {Gets the size of <colorMap>.}} \
{{delete [<colorMap>=<currentColorMap>]} {Deletes the <colorMap>.}} \
{{list [<nameRegexp>='*']} {Gets a list of all the matching color map names.}}}",

  /*
   * CProcs in window_manager.c 
   */      
   "draw",C_Draw,"{{{lineto *gobject* <x> <y>  [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')]} \
{Draws in the *gobject* a line from the last point that has been drawn to <x> <y>\n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the line. \n\
-line : If 'dash' then the line will be dashed \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the line will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the line}} \
{{line *gobject* <x1> <y1> <x2> <y2> [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')]} \
{Draws in the *gobject* a line from the point <x1>,<y1> to <x2>,<y2> \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the line. \n\
-line : If 'dash' then the line will be dashed \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the line will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the line.}} \
{{ellipse *gobject* <x> <y> <w> <h> [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')] [-pixel] [-rectType <rectType>] \
[-centered] [-fill]} \
{Draws in the *gobject* an ellipse in the rectangle <x> <y> <w> <h>. \n\
-centered : The ellipse is centered at <x>,<y> and the respective radii are <w> and <h>. \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing (and filling) the ellipse. \n\
-fill : The ellipse is filled with the current color. \n\
-rectType : Changes the rectangle type that is used. Read the manual pages about  the 'rectType' field of the gobjects. \n\
-line : If 'dash' then the contour of the ellipse will be drawn using dashed lines \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the ellipse will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the ellipse. \n\
-pixel : The sizes <w> and <h> are given in pixels instead of local coordinates.}} \
{{rect *gobject* <x> <y> <w> <h> [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')] [-pixel] [-rectType <rectType>] \
[-centered] [-fill]} \
{Draws in the *gobject* the rectangle <x> <y> <w> <h>. \n\
-centered : The rectangle is centered at <x>,<y> and the respective radii are <w> and <h>. \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing (and filling) the rectangle. \n\
-fill : The rectangle is filled with the current color. \n\
-rectType : Changes the rectangle type that is used. Read the manual pages about  the 'rectType' field of the gobjects. \n\
-line : If 'dash' then the contour of the rectangle will be drawn using dashed lines \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the rectangle will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the rectangle. \n\
-pixel : The sizes <w> and <h> are given in pixels instead of local coordinates.}} \
{{cross *gobject* <x> <y> <r>  [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')]} \
{Draws in the *gobject* a cross centered at <x> <y> and with a pixel radius of <r>\n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the cross. \n\
-line : If 'dash' then the cross will be dashed. \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the cross will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the cross}} \
{{point *gobject* <x> <y> [-clip] [-color <color>] [-pen <pensize>] [-mode ('normal' | 'inverse')]} \
{Draws in the *gobject* the point <x> <y> \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the point. \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the point will disappear. \n\
-pen : The size of the pen <penSize> is used for drawing the point.}} \
{{string *gobject* <str> [*hPositionMode*=left] <x> [*vPositionMode*=base] <y> [<angle>=0] [-clip] [-color <color>] [-mode ('normal' | 'inverse')] [-font <fontName>]} \
{Draws the (eventually multiple line) string <str> at the position <x> <y> and angle <angle> using the gobject font. The two parameters <hPositionMode> and <vPositionMode> \
fix how these coordinates are used. \n\
if <hPositionMode>=='left' then the string is justified to the left and <x> corresponds to its left position. \n\
if <hPositionMode>=='rightN' then each individual line of the string is justified to the right and <x> corresponds to their right positions. \n\
if <hPositionMode>=='right1' then all the lines (as a group) of the string are justified to the right and <x> corresponds to its right position. \n\
if <hPositionMode>=='middleN' then each individual line of the string is justified to its middle point and <x> corresponds to their middle positions. \n\
if <hPositionMode>=='middle1' then all the lines (as a group) of the string is justified to its middle point and <x> corresponds to its middle position. \n\
if <vPositionMode>=='base' then <y> corresponds to the position of the baseline of the first line. \n\
if <vPositionMode>=='down' then <y> corresponds to the position of the bottom of the last line. \n\
if <vPositionMode>=='up' then <y> corresponds to the position of the top of the first line. \n\
if <vPositionMode>=='middle' then <y> corresponds to the position of the middle of the whole string \n\
if <vPositionMode>=='middleup' in case <str> has just one line, <y> corresponds to the position of the middle of the characters above the baseline (such as '1') \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the string. \n\
-mode : If 'inverse' then the drawing uses the inverse color mode so that if the same drawing command is executed a second time, the string will disappear. \n\
-font : Uses a specified font \
-pen : The size of the pen <penSize> is used for drawing the string.}} \
{{axis *gobject* <x> <y> <w> <h> <xMin> <xMax> <yMin> <yMax> [-title <title>] [-xlabel <label>] [-ylabel <label>] [-margin <nbOfPixels>] [-font] [-clip] [-pen <penSize>] [-color <color>] [-line ('dash' | 'solid')] [-mode ('normal' | 'inverse')] [-reverse (x | y | xy | none)]} \
{Draws x and y-axis around the rectangle <x>, <y>, <w>, <h>. \
These axes correspond to abscissa ranging from <xMin> to <xMax> and ordinate ranging from <yMin> to <yMax> \n\
-reverse : The state that indicates which axis are reversed compared to the regular window coordinate system (y-axis going \
from top to bottom and x-axis going from left to right). Let us note that the same field exists for Views, so that they can be used along with axis. "
"If it is equal to 'y' (the default value at initialization) then the y-axis will be going from bottom of the window to the top, if it is equal to 'x' the x-axis \
will be going from right to left, if it is equal to 'xy' both will be combined and if it is equal to 'none' the y-axis will be top to bottom and the x-axis left to right \
(as for windows and regular glists). \n\
-frame : If not set then only two axis are drawn. If set then the whole rectangle <x>,<y>, <w>, <h> is surrounded by axes (i.e., 4 axes are drawn). \n\
-ticksIn : The ticks on the axis are inside the rectangle instead of outside. \n\
-margin : A margin of size <nbOfPixels> is used around the rectangle <x>, <y>, <w>, <h> to draw each axis. \n\
-clip : The clip rectangle is set to be the *gobject* rectangle. \n\
-color : The color <color> is used for drawing the axis. \n\
-pen : The size of the pen <penSize> is used for drawing the axis. \n\
-font : Uses a specified font}} \
{{gobject *glist* *gclass* [-clip] [list of -<fieldN> [<val1>...<valP>]]} {Draws (without creating it) a gobject of class *gclass* in the <glist> and whose  fields are specified \
by the -<fieldN> [<val1>...<valP>] list. If '-clip' then the current clip rectangle is not used and the entire object is drawn otherwise the current \
clip rectangle is used.}}}",

   "font",C_Font,"{{{info <font>} {Gets an information list about the font. The list is made of 3 numbers : <ascent> <descent> and \
<interline>. <ascent> is the maximum of points (for all characters of the font) above the base line (excluding \
the base line), <descent> is the maximum of points (for all characters of the font) below the base line (including \
the base line) and <interline> is such that 2 base lines of 2 successive lines are vertically spaced by the number \
of points : <ascent>+<descent>+<interline>.}} \
{{exist <fontName>} {Returns 1 if the font named <fontName> exists and 0 if not. The name of the font \
is of the form <name>-<size>-<style> (e.g., Geneva-9-plain) where <style> is either 'plain', 'bold', 'italic', 'boldItalic'.}} \
{{default [<fontName>]} {Gets/Sets the font that is used by default by all the gobjects.}} \
{{size <font>} {Gets the size of the <font>}} \
{{style <font>} {Gets the style of the <font>}} \
{{name <font>} {Gets the basic name (e.g. Geneva, Times...) of the <font>}} \
{{list [<nameRegexp>='*'] [-f]} {Gets a listv of the available fonts matching the name  <nameRegexp>. If '-f', the fonts must be fixed width fonts.}} \
{{rect <font> <string> <hPositionMode> <x> <vPositionMode> <y>  [<angle> = 0] [*gobject*]} {Gets a listv representing the bounding rectangle of the string <string> \
if it were drawn using <font> and using the 'draw string' command in the *gobject* (or any window if *gobject* is not specified) \
along with the arguments <hPositionMode>, <x>, <vPositionMode> and <y>. Read the 'draw string' manual pages to \
learn about these arguments.}}}",

  /*
   * CProcs in event.c 
   */      
  "setbinding",C_SetBinding,"{{{<bindingGroupName> *gclass* ((left | middle | right)Button('' | Up | Down | Motion) | motion | leave | enter | enterLeave | key | keyUp | keyDown | draw | delete | error) ['key1 .. keyN'] [<modifiers>] <script>} \
{Defines event bindings associated to gobjects of class *gclass*. Read the manual pages for examples of bindings.}}}",
  "binding",C_Binding,"{{{delete <groupNameRegexp> [*class*]} {Deletes all the bindings that correspond to all binding groups whose name matches <groupNameRegexp>.}} \
{{activate <groupNameRegexp> [*class*]} {Activates all the bindings that correspond to all binding groups whose name matches <groupNameRegexp>.}} \
{{deactivate <groupNameRegexp> [*class*]} {Deactivates all the bindings that correspond to all binding groups whose name matches <groupNameRegexp>.}} \
{{info <groupNameRegexp> [*class*]} {Get info on the bindings that correspond to a binding group which matches <groupNameRegexp>.}}}",
  "event",C_Event,"{{{process [<time>=0]} {Waits for <time> seconds while processing to events. If <time>==0 then \
it processes all the events in the queue and then returns}}}", 


  /* 
   * In postscript.c.c 
   */
  "ps", C_PS,"{{{csize [<cmXSize> [<cmYSize>=-1]]} {If no argument, it returns a listv made of the x and y sizes of the postscript drawing in centimeters. \
If both arguments are specified, it sets the x and y sizes (centimeters). And if only the first argument is specified (second is -1), \
it sets the x-size and the y-size will be automatically computed using the x/y size proportion of the window to draw.}} \
{{isize [<inchXSize> [<inchYSize>=-1]]} {If no argument, it returns a listv made of the x and y sizes of the postscript drawing in inches. \
If both arguments are specified, it sets the x and y sizes (inches). And if only the first argument is specified (second is -1), \
it sets the x-size and the y-size will be automatically computed using the x/y size proportion of the window to draw.}} \
{{cpos [<cmXPos> <cmYPos>]} {Sets/Gets the x and y distances (in centimeters) of the postscript drawing from the top-left \
corner of the paper. Warning : This is not quite working yet.}} \
{{linewidth [<linewidth>]} {Sets/Gets the linewidth used for postscript. A width of 1 is an average linewidth.}} \
{{ipos [<inchXPos> <inchYPos>]} {Sets/Gets the x and y distances (in inches) of the postscript drawing from the top-left \
corner of the paper. Warning : This is not quite working yet.}}}",
  

  /*
   * CProcs in macwindow.c or X11window.c 
   */      
  "system",C_System,"{\
{{mouse <nbOfButtons> '(left | middle | right) [(opt | meta)] (left | middle | right)' ...} \
{LastWave has been designed for an operating system that deals with a 3 button mouse. If the mouse you are using is a 'real' 3 button mouse \
(i.e., sending left, middle and middle messages) then you do not need to use this command. Everything should work properly. If it has only \
1 'real' button, LastWave considers it is a 'left' button. You then have to assign the two other 'virtual' buttons to the 'left' button \
modified by a modifier key (either 'opt' which corresponds to 'alt' on Windows or 'meta'). The command thus expects 3 arguments, i.e., \
1 'middle [(opt | meta)] left' 'right [(opt | meta)] left'. If it has only 2 'real' buttons, the command thus expects 2 arguments, i.e., \
2 '(left | middle | right) [(opt | meta)] (left | middle | right)'.}} \
{{nEvents} {Gets the total number of events that were managed up to the current time.}}\
}",

  NULL,NULL,NULL        
};



/* The ccommand tables of the kernel */
CProcTable cprocTables[] = {

  interpreterTable,"kernel","Basic interpreter commands",
  graphicsTable,"kernel","Basic graphic commands",

  NULL,NULL,NULL
};