tools/genmodule/config.h

   1 /*
   2     Copyright © 1995-2019, 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, WRITETHUNK };
  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, BIT_RELLINKLIB
  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     OPTION_RELLINKLIB = 1<<BIT_RELLINKLIB,
  45 };
  46
  47 enum coptionbit { CBIT_PRIVATE };
  48 enum coptionflags { COPTION_PRIVATE = 1<<CBIT_PRIVATE };
  49
  50 enum intcfgbit { BIT_GENASTUBS, BIT_NOREADFUNCS };
  51 enum intcfgflags
  52 {
  53     CFG_GENASTUBS = 1<<BIT_GENASTUBS,
  54     CFG_NOREADFUNCS = 1<<BIT_NOREADFUNCS /* all needed functions are available */
  55 };
  56
  57 /* Classinfo is used to store the information of a BOOPSI class */
  58 struct classinfo
  59 {
  60     struct classinfo *next;
  61
  62     /* Type and name of the class */
  63     enum modtype classtype;
  64     char *basename;
  65
  66     /* Priority with which the class will be initialized */
  67     int initpri;
  68
  69     /* Additional options for the class */
  70     enum coptionflags options;
  71
  72     const char **boopsimprefix;
  73     char *classid, *superclass, *superclass_field, *classptr_field, *classptr_var;
  74     char *dispatcher; /* == NULL when the generated dispatcher is used,
  75                        * otherwise it is the function name of the dispatcher */;
  76     char *classdatatype; /* The type of the data for every object */
  77
  78     struct functionhead *methlist;
  79
  80     /* Interfaces used in this class (only for HIDD classes) */
  81     struct stringlist *interfaces;
  82
  83 };
  84
  85 /* interfaceinfo is used to store the information of a BOOPSI class */
  86 struct interfaceinfo
  87 {
  88     struct interfaceinfo *next;
  89
  90     /* id and base name of the interface */
  91     char *interfaceid;
  92     char *interfacename;
  93     char *methodstub;
  94     char *methodbase;
  95     char *attributebase;
  96
  97     struct functionhead *methodlist;
  98     struct functionhead *attributelist;
  99 };
 100
 101
 102 /* DOS handlers */
 103 struct handlerinfo {
 104     struct handlerinfo *next;
 105
 106     enum {
 107         HANDLER_DOSTYPE,        /* FileSysResource registered */
 108         HANDLER_DOSNODE,        /* Non-bootable DOS device */
 109         HANDLER_RESIDENT,       /* AddSegment() registered */
 110     } type;
 111     unsigned int id;
 112     char *name;
 113     int   autodetect;           /* Autodetect priority (0 for not autodetectable) */
 114     /* DeviceNode overrides */
 115     int bootpri;                /* Boot priority */
 116     int priority;               /* Task priority */
 117     int stacksize;              /* Stacksize information */
 118     int startup;                /* Startup id */
 119 };
 120
 121 struct config
 122 {
 123     /* members that store filename and paths derived from argv */
 124     char *conffile, *confoverridefile, *gendir, *libgendir, *genincdir;
 125
 126     /* The name and type of the module */
 127     char *modulename, *modulenameupper;
 128     enum modtype modtype;
 129     char *modtypestr;
 130     char *suffix;
 131     char *includename, *includenameupper;
 132
 133     /* Flavour (sub-build) of the module */
 134     char *flavour;
 135
 136     /* Extra string to include in version */
 137     char *versionextra;
 138
 139     /* firstlvo is the LVO number of the first user definable function
 140      * in the module
 141      */
 142     unsigned int firstlvo;
 143
 144     /* What to do ? */
 145     enum command command;
 146
 147     /* Name for variables and types */
 148     char *basename, *libbase, *libbasetype, *libbasetypeptrextern;
 149
 150
 151     /* The default path to put the module relative to SYS: */
 152     char *moddir;
 153
 154     /* The names of the fields in the custom library base for storing internal
 155      * information
 156      */
 157     char *sysbase_field, *seglist_field, *rootbase_field, *oopbase_field;
 158
 159     /* Some additional options, see optionsflags enum above */
 160     enum optionflags options;
 161
 162     /* Internal configuration flags */
 163     enum intcfgflags intcfg;
 164
 165     /* Further configuration data for the generated Resident struct */
 166     char *datestring, *copyright;
 167     int residentpri;
 168     unsigned int majorversion, minorversion;
 169     char *addromtag;
 170
 171     /* In forcelist a list of basenames is present that need to be present in the
 172      * static link library so that certain libraries are opened by a program
 173      */
 174     struct stringlist *forcelist;
 175
 176     /* Code to add to the generated files */
 177     struct stringlist *cdeflines, *cdefprivatelines, *stubprivatelines, *startuplines;
 178
 179     /* device specific data */
 180     char *beginiofunc, *abortiofunc;
 181
 182     /* The functions of this module */
 183     struct functionhead *funclist;
 184
 185     /* The classes defined in this module */
 186     struct classinfo *classlist;
 187
 188     /* The interface defined in this module */
 189     struct interfaceinfo *interfacelist;
 190
 191     /* The DOS IDs and handlers for this module */
 192     char *handlerfunc;
 193     struct handlerinfo *handlerlist;
 194
 195     /* Relative libraries used by this library
 196      */
 197     struct stringlist *rellibs;
 198 };
 199
 200 /* Function prototypes */
 201
 202 struct config *initconfig(int, char **);
 203
 204 char* getBanner(struct config*);
 205 void freeBanner(char*);
 206
 207 #endif //_CONFIG_H