tools/genmodule/config.h

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3
   4     Desc: Define the C structure for storing the command line options and the
   5           module config data
   6 */
   7
   8 #ifndef _CONFIG_H
   9 #define _CONFIG_H
  10
  11 #include <assert.h>
  12
  13 #include "functionhead.h"
  14 #include "stringlist.h"
  15
  16 enum command { CMD_UNSPECIFIED, FILES, LIBDEFS, INCLUDES, MAKEFILE, WRITEFUNCLIST, WRITEFD, WRITESKEL };
  17 enum modtype { UNSPECIFIED, LIBRARY, MCC, MUI, MCP, DEVICE, RESOURCE, IMAGE, GADGET,
  18                DATATYPE, CLASS, HIDD, USBCLASS, HANDLER
  19 };
  20
  21 enum optionbit { BIT_NOAUTOLIB, BIT_NOEXPUNGE, BIT_NORESIDENT,
  22                  BIT_DUPBASE, BIT_PERTASKBASE, BIT_INCLUDES, BIT_NOINCLUDES,
  23                  BIT_STUBS, BIT_NOSTUBS, BIT_AUTOINIT, BIT_NOAUTOINIT,
  24                  BIT_RESAUTOINIT, BIT_NOOPENCLOSE, BIT_SELFINIT,
  25                  BIT_STACKCALL
  26 };
  27 enum optionflags
  28 {
  29     OPTION_NOAUTOLIB = 1<<BIT_NOAUTOLIB,
  30     OPTION_NOEXPUNGE = 1<<BIT_NOEXPUNGE,
  31     OPTION_NORESIDENT = 1<<BIT_NORESIDENT,
  32     OPTION_DUPBASE = 1<<BIT_DUPBASE,
  33     OPTION_PERTASKBASE = 1<<BIT_PERTASKBASE,
  34     OPTION_INCLUDES = 1<<BIT_INCLUDES,
  35     OPTION_NOINCLUDES = 1<<BIT_NOINCLUDES,
  36     OPTION_STUBS = 1<<BIT_STUBS,
  37     OPTION_NOSTUBS = 1<<BIT_NOSTUBS,
  38     OPTION_AUTOINIT = 1<<BIT_AUTOINIT,
  39     OPTION_NOAUTOINIT = 1<<BIT_NOAUTOINIT,
  40     OPTION_RESAUTOINIT = 1<<BIT_RESAUTOINIT,
  41     OPTION_NOOPENCLOSE = 1<<BIT_NOOPENCLOSE,
  42     OPTION_SELFINIT = 1<<BIT_SELFINIT,
  43     OPTION_STACKCALL = 1<<BIT_STACKCALL,
  44 };
  45
  46 enum coptionbit { CBIT_PRIVATE };
  47 enum coptionflags { COPTION_PRIVATE = 1<<CBIT_PRIVATE };
  48
  49 enum intcfgbit { BIT_GENASTUBS, BIT_NOREADFUNCS };
  50 enum intcfgflags
  51 {
  52     CFG_GENASTUBS = 1<<BIT_GENASTUBS,
  53     CFG_NOREADFUNCS = 1<<BIT_NOREADFUNCS /* all needed functions are available */
  54 };
  55
  56 /* Classinfo is used to store the information of a BOOPSI class */
  57 struct classinfo
  58 {
  59     struct classinfo *next;
  60
  61     /* Type and name of the class */
  62     enum modtype classtype;
  63     char *basename;
  64
  65     /* Priority with which the class will be initialized */
  66     int initpri;
  67
  68     /* Additional options for the class */
  69     enum coptionflags options;
  70
  71     const char **boopsimprefix;
  72     char *classid, *superclass, *superclass_field, *classptr_field, *classptr_var;
  73     char *dispatcher; /* == NULL when the generated dispatcher is used,
  74                        * otherwise it is the function name of the dispatcher */;
  75     char *classdatatype; /* The type of the data for every object */
  76
  77     struct functionhead *methlist;
  78
  79     /* Interfaces used in this class (only for HIDD classes) */
  80     struct stringlist *interfaces;
  81
  82 };
  83
  84 /* interfaceinfo is used to store the information of a BOOPSI class */
  85 struct interfaceinfo
  86 {
  87     struct interfaceinfo *next;
  88
  89     /* id and base name of the interface */
  90     char *interfaceid;
  91     char *interfacename;
  92     char *methodstub;
  93     char *methodbase;
  94     char *attributebase;
  95
  96     struct functionhead *methodlist;
  97     struct functionhead *attributelist;
  98 };
  99
 100
 101 /* DOS handlers */
 102 struct handlerinfo {
 103     struct handlerinfo *next;
 104
 105     enum {
 106         HANDLER_DOSTYPE,        /* FileSysResource registered */
 107         HANDLER_DOSNODE,        /* Non-bootable DOS device */
 108         HANDLER_RESIDENT,       /* AddSegment() registered */
 109     } type;
 110     unsigned int id;
 111     char *name;
 112     int   autodetect;           /* Autodetect priority (0 for not autodetectable) */
 113     /* DeviceNode overrides */
 114     int bootpri;                /* Boot priority */
 115     int priority;               /* Task priority */
 116     int stacksize;              /* Stacksize information */
 117     int startup;                /* Startup id */
 118 };
 119
 120 struct config
 121 {
 122     /* members that store filename and paths derived from argv */
 123     char *conffile, *gendir, *genincdir;
 124
 125     /* The name and type of the module */
 126     char *modulename, *modulenameupper;
 127     enum modtype modtype;
 128     char *modtypestr;
 129     char *suffix;
 130
 131     /* Extra string to include in version */
 132     char *versionextra;
 133
 134     /* firstlvo is the LVO number of the first user definable function
 135      * in the module
 136      */
 137     unsigned int firstlvo;
 138
 139     /* What to do ? */
 140     enum command command;
 141
 142     /* Name for variables and types */
 143     char *basename, *libbase, *libbasetype, *libbasetypeptrextern;
 144
 145
 146     /* The default path to put the module relative to SYS: */
 147     char *moddir;
 148
 149     /* The names of the fields in the custom library base for storing internal
 150      * information
 151      */
 152     char *sysbase_field, *seglist_field, *rootbase_field, *oopbase_field;
 153
 154     /* Some additional options, see optionsflags enum above */
 155     enum optionflags options;
 156
 157     /* Internal configuration flags */
 158     enum intcfgflags intcfg;
 159
 160     /* Further configuration data for the generated Resident struct */
 161     char *datestring, *copyright;
 162     int residentpri;
 163     unsigned int majorversion, minorversion;
 164     char *addromtag;
 165
 166     /* In forcelist a list of basenames is present that need to be present in the
 167      * static link library so that certain libraries are opened by a program
 168      */
 169     struct stringlist *forcelist;
 170
 171     /* Code to add to the generated files */
 172     struct stringlist *cdeflines, *cdefprivatelines, *startuplines;
 173
 174     /* device specific data */
 175     char *beginiofunc, *abortiofunc;
 176
 177     /* The functions of this module */
 178     struct functionhead *funclist;
 179
 180     /* The classes defined in this module */
 181     struct classinfo *classlist;
 182
 183     /* The interface defined in this module */
 184     struct interfaceinfo *interfacelist;
 185
 186     /* The DOS IDs and handlers for this module */
 187     char *handlerfunc;
 188     struct handlerinfo *handlerlist;
 189
 190     /* Relative libraries used by this library
 191      */
 192     struct stringlist *rellibs;
 193 };
 194
 195 /* Function prototypes */
 196
 197 struct config *initconfig(int, char **);
 198
 199 char* getBanner(struct config*);
 200 void freeBanner(char*);
 201
 202 #endif //_CONFIG_H