README

   1 GTK+ Object Builder (GOB)
   2
   3 Very simple preprocessor for making GTK+ objects with inline C code so that
   4 generated files are not editted.  Syntax is inspired by java and yacc or lex.
   5 The implementation is intentionaly kept simple, and no C code parsing is done.
   6
   7 Reasons:
   8         - C is a perfect (well mostly) language, no need for another language
   9         - Writing a fully featured GTK+ object is a hassle
  10         - Need for a generator that doesn't require changes to generated code
  11         - I like how Java writes method code directly into the class
  12           definition.
  13
  14 To build:
  15         (the usual drill :)
  16         run "./configure;make"
  17
  18 To install:
  19         run "make install" as root, or just take the gob binary and place
  20         it anywhere you want.
  21
  22 To use:
  23         run gob with the .gob file on the command line
  24
  25 What's generated:
  26         two (.c and .h) files named by the object name with words
  27         separated by a hyphen (not neccessairly the .gob file prefix)
  28
  29 How to write .gob files?
  30         1) read "man gob" for some documenation on how to use GOB
  31         2) if you can't find what you need, read src/test.gob for an
  32            example of GOB code
  33         3) If you still can't find what you need, read src/lexer.l
  34            and src/parse.y (in other words: RTFS)
  35
  36 How to include gob inside your project:
  37
  38         Put the gob distribution into a subdirectory in your main
  39         project directory.  Use the AC_CONFIG_SUBDIRS to include that
  40         directory in your configure run.  And finally add a file called
  41         NOINST_GOB into your toplevel project directory (this can be done
  42         inside your configure script in fact) so that gob doesn't install
  43         itself.  Then just use the made gob binary as you would other
  44         preprocessors.
  45
  46 TODO:
  47         - clean up code
  48         - make it behave nice
  49         - add warnings all over the place
  50         - get a life
  51
  52 George <jirka@5z.com>