Example: LIB_NAME = libgtk-x11-2.0.so, libgdk-x11-2.0.so, libglib-2.0.so, libgobject-2.0.so
Example: INCLUDE = /etc/gtk-extra.cfg
The 'gtk-server.cfg' file may not contain duplicate function definitions. This is verified
by the GTK-server during startup.
Example: FUNCTION_NAME = gtk_window_new, delete-event, WIDGET, 1, LONG
Example: LOG_FILE = /tmp
FUNCTION_NAME = gdk_window_get_pointer, NONE, WIDGET, 4, WIDGET, PTR_LONG, PTR_LONG, NULL
In this case, a call to 'gdk_window_get_pointer' will return a widget but also the values stored in the second and third argument. The returned result will be formatted in S-expression syntax, just as the GTK-server also accepts S-expression syntax. Next to the type PTR_LONG the types PTR_FLOAT, PTR_DOUBLE, PTR_STRING, PTR_BOOL and PTR_WIDGET can be used.
MACRO <name>
$a : GTK_function
GTK_function $1 $2 $3
...
RETURN <value>
ENDMACRO
Each line in the macro may contain only one GTK function. A macro can be invoked with arguments. Within the macro these arguments are denoted with $1, $2, $3 an so on. The $0 points to the macroname itself. It is possible to refer to all arguments at once with $@. A macro can accept up to 9 arguments. If there are more arguments then these are ignored.
Macros may also use variables. Variablenames must start with a dollarsign '$'. After that, only the first letter of the variablename is important, which means that there are at most 26 variables in each macro (lowercase).
Within a macro, it is possible to assign a result of a GTK function to a variable. However, it is important that the colon symbol, which is the assignment operator, is not attached to the variablename or the GTK functionname. For example:
$window : gtk_window_new 0
Also it is possible to assign a string to a variable. To do this, the string should be preceded by the '&' sign. For example:
$var : &Hello world
Variables in macros are initialized to zero automatically, but keep their values after the macro object has been executed. Afterwards the variables can be retrieved in your clientscript by using the call 'gtk_server_macro'. For example:
gtk_server_macro <macroname> var
It is possible to perform a relative jump on the condition of the value of a variable. The command 'VALUE' jumps when a variable is not equal to zero, and the command 'EMPTY' jumps when a variable is zero. The command 'JUMP' always jumps, no matter what condition. For example:
$var EMPTY 3
In this example, the GTK-server will jump three statements forward in case the variable 'var' is equal to zero. The commands 'EMPTY', 'VALUE' and 'JUMP' can jump forward and backward, but only within the macro object. Jumps outside the macro will just go to the end of the macro, or to the beginning if the jump is negative.
It is not allowed to define a macro within a macro. However, macros may invoke other macros. Also, macros may return a value to the client script with the keyword 'RETURN'. For example:
RETURN $window
The Highlevel Universal GUI (HUG) defined in the GTK-server configfile is implemented using macro objects.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
Current version of the GTK-server was created with help of many others - see the CREDITS file in the sourcepackage for credits.