README

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