README

   1 GTK+ Object Builder (GOB)
   2
   3 Very simple preprocessor for making GTK+ objects with inline C code so that
   4 generatedfiles 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
  20
  21 To use:
  22         run gob with the .gob file on the command line
  23
  24 What's generated:
  25         two (.c and .h) files named by the object name with words
  26         separated by a hyphen (not neccessairly the .gob file prefix)
  27
  28 How to write .gob files?
  29         1) read "man gob" for some documenation on how to use GOB
  30         2) if you can't find what you need, read src/test.gob and
  31            src/lexer.l and src/parse.y (in other words: RTFS)
  32
  33 How to include gob inside your project:
  34
  35         Put the gob distribution into a subdirectory in your main
  36         project directory.  Use the AC_CONFIG_SUBDIRS to include that
  37         directory in your configure run.  And finally add a file called
  38         NOINST_GOB into your toplevel project directory (this can be done
  39         inside your configure script in fact) so that gob doesn't install
  40         itself.  Then just use the made gob binary as you would other
  41         preprocessors.
  42
  43 TODO:
  44         - clean up code
  45         - make it behave nice
  46         - add warnings all over the place
  47         - get a life
  48
  49 George <jirka@5z.com>