home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / rsctoc1 / rsctoc.doc next >
Text File  |  1988-02-29  |  3KB  |  65 lines
  1.     RSCTOC                        VERSION 1.0                        RSCTOC
  2.  
  3.  
  4.     NAME
  5.         rsctoc.ttp - a program to generate C source from a resource file.
  6.  
  7.     AUTHOR
  8.         Bob Silliker
  9.  
  10.     COPYRIGHT
  11.         Copyright (c) 1988 by Robert Joseph Silliker
  12.         All Rights Reserved.
  13.         Permission is granted for unrestricted non-commercial use.
  14.  
  15.     SYNOPSIS
  16.         rsctoc.ttp rsc_file [-p prefix] [-o file]
  17.  
  18.     DESCRIPTION
  19.         Rsctoc is a program to generate C code from a resource file on an
  20.         Atari St computer.  It will handle the following types; OBJECT,
  21.         TEDINFO, ICONBLK and BITBLK.  If the command is executed with only
  22.         a path to the rsc_file then the C code will be displayed on the
  23.         screen.  To send the output to a file you can use the '-o file'
  24.         option or to redirect the output with '>file'.
  25.  
  26.         The C code that is generated includes a small routine to fixup the
  27.         objects by calling rsrc_obfix() on each object to convert the
  28.         object's location size from character coordinates to pixel coordinates. 
  29.         The routine is that is called to fixup the objects is 'fix_objects()'
  30.         and should be called once during program initialization (calling it
  31.         more than once is interesting but not useful).
  32.  
  33.         The -p prefix option is used to add a short unique prefix to the names
  34.         of the structures, routine and macros that rsctoc creates.  This is
  35.         very useful when creating library routines that have trees embedded
  36.         in them (providing a means of preventing name conflicts).
  37.  
  38.         If rsctoc is executed in the following way
  39.  
  40.                    rsctoc rsc_file -p my -o file
  41.  
  42.         Then the C code generated would have 'my' added to the start of the
  43.         structures, routine and macros.
  44.  
  45.                    rs_tedinfo      would be      myrs_tedinfo
  46.                    NUM_TI          would be      myNUM_TI
  47.                    fix_objects     would be      myfix_objects
  48.  
  49.     NOTES
  50.         The program DOES NOT generate the arrays rs_strings[], rs_frstr[],
  51.         rsfrimg[], or rs_imdope[] arrays.  The program DOES generate the
  52.         arrays rs_tedinfo[], rs_object[], rs_trindex[], rs_bitblk[],
  53.         rs_iconblk[] arrays as well as defines the macros NUM_TI, NUMOBS,
  54.         NUM_TREE, NUM_BB and NUM_IB (modified by the prefix of course).
  55.  
  56.         Any names that you assigned to objects, trees, images or icons can
  57.         still be used in your program to access these elements. The program
  58.         will only handle 512 trees (not objects, images or icons which are
  59.         only limited by the resource file structure) in one input resource
  60.         file.
  61.  
  62.     BUGS
  63.         There are no known bugs in V1.0. (:->)
  64.         If you find one fix it.
  65.