GTK-server

GTK-server

Original author(s)	Peter van Eerten
Developer(s)	Peter van Eerten
Initial release	2003 (2003)
Stable release	2.4.6 / November 1, 2024 (2024-11-01)
Operating system	Cross-platform
License	GNU General Public License
Website	www.gtk-server.org

The GTK-server project aims to bring graphical user interface (GUI) programming to any interpreted language using the GNU Image Manipulation Program (GIMP) ToolKit (GTK) or XForms. It releases free and open-source software under the GNU General Public License.

Philosophy

The GTK-server provides a stream-oriented interface to GTK. If the GTK-server is compiled as a standalone program binary, it allows five different interfaces: standard input (stdin), first in, first out (FIFO) (named pipe), inter-process communication (IPC) (message queue), Transmission Control Protocol (TCP), or User Datagram Protocol (UDP). Any interpreted language or shell script with input/output (I/O) abilities can start the GTK-server with an argument specifying the type of interface, and can start sending GTK function calls in S-expression format. After each request, the GTK-server returns a result, depending on the type of GTK function invoked.

If the GTK-server is compiled as a shared object, it exports the function 'gtk', which must be imported in the client program first. After that, the client program can start sending GTK function calls in S-expression format as argument to the imported 'gtk' function.

Before the GTK-server can execute GTK functions, it must read a configuration file in which the prototypes of the GTK functions are described. Since version 2.2.3 this also can be done on-the-fly, allowing the GTK-server to run without configuration file.

Implementation

Implementing the GTK-server leads to the following considerations.

• Accessing foreign functions is only possible when the accessed libraries are created with a non object oriented programming language like C or Pascal. Libraries created with C++ for example, use name mangling to unify overloaded functions. This means that the functionname in a C++ library cannot be known once the shared library has been compiled. Hence the functions in such a library cannot be accessed. Therefore, libraries like wxWidgets, the Qt toolkit, Fast Light Toolkit (FLTK) which are programmed in C++, cannot be accessed with the GTK-server concept.
• The GTK library was implemented in the programming language C. Since C is a strongly typed programming language, the interpreted program needs to know the data type of arguments and the type of the return value for each GTK function during runtime. These can be defined on-the-fly or in a configuration file, which is parsed by the GTK-server during startup. However, the GTK-server does not know the functions which are going to be used by the interpreted client program, so for GTK-server all arguments and return values for each GTK function are variable types.

This leads to a problem for the implementation, because the GTK functions and the corresponding arguments and return values cannot be hardcoded into the GTK-server binary.

The way to resolve this is by using a foreign function interface. Currently, four external foreign function interfaces are supported by GTK-server: libffi, FFCALL, C/Invoke and dyncall. One of these libraries should be available on the target system, to compile the GTK-server successfully.

Example

The following KornShell script starts the GTK-server in stdin mode, and creates a simple window with an exit button:

#!/bin/ksh

# Start GTK-server
gtk-server -stdin |&

# Communicate with GTK-server and assign function
function gtk { print -p $1; read -p GTK; }
function define { $2 "$3"; eval $1="$GTK"; }

# Setup GUI
gtk "gtk_init NULL NULL"
define WINDOW gtk "gtk_window_new 0"
gtk "gtk_window_set_title $WINDOW 'Korn GTK-server demo'"
gtk "gtk_window_set_default_size $WINDOW 400 200"
define TABLE gtk "gtk_table_new 10 10 1"
gtk "gtk_container_add $WINDOW $TABLE"
define BUTTON gtk "gtk_button_new_with_label 'Click to Quit'"
gtk "gtk_table_attach_defaults $TABLE $BUTTON 5 9 5 9"
gtk "gtk_widget_show_all $WINDOW"

# Mainloop
until [[ $EVENT = $BUTTON || $EVENT = $WINDOW ]]
do 
    define EVENT gtk "gtk_server_callback wait"
done

# Exit GTK-server
gtk "gtk_server_exit"

Advantages and limitations

Although GTK was meant to be used with the C programming language, it is now possible to use GTK from any interpreted language without changing the implementation of the interpreter. Also, GTK 1.x, GTK2.x, GTK 3.x and GTK 4.x can be reached. Optionally, any other shared library can be used, like OpenGL related libraries, Poppler, Mozilla, but also libc, sqlite and a music library like MikMod.

When using the GTK-server as a standalone binary, it inevitably creates an additional process in the processlist. Also, GTK functions defined as a macro cannot be reached by a client program.