outform.h

   1 /* outform.h    header file for binding output format drivers to the
   2  *              remainder of the code in the Netwide Assembler
   3  *
   4  * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
   5  * Julian Hall. All rights reserved. The software is
   6  * redistributable under the licence given in the file "Licence"
   7  * distributed in the NASM archive.
   8  */
   9
  10 /*
  11  * This header file allows configuration of which output formats
  12  * get compiled into the NASM binary. You can configure by defining
  13  * various preprocessor symbols beginning with "OF_", either on the
  14  * compiler command line or at the top of this file.
  15  *
  16  * OF_ONLY                -- only include specified object formats
  17  * OF_name                -- ensure that output format 'name' is included
  18  * OF_NO_name             -- remove output format 'name'
  19  * OF_DOS                 -- ensure that 'obj', 'bin' & 'win32' are included.
  20  * OF_UNIX                -- ensure that 'aout', 'aoutb', 'coff', 'elf' are in.
  21  * OF_OTHERS              -- ensure that 'bin', 'as86' & 'rdf' are in.
  22  * OF_ALL                 -- ensure that all formats are included.
  23  *                           note that this doesn't include 'dbg', which is
  24  *                           only really useful if you're doing development
  25  *                           work on NASM. Define OF_DBG if you want this.
  26  *
  27  * OF_DEFAULT=of_name     -- ensure that 'name' is the default format.
  28  *
  29  * eg: -DOF_UNIX -DOF_ELF -DOF_DEFAULT=of_elf would be a suitable config
  30  * for an average linux system.
  31  *
  32  * Default config = -DOF_ALL -DOF_DEFAULT=of_bin
  33  *
  34  * You probably only want to set these options while compiling 'nasm.c'. */
  35
  36 #ifndef NASM_OUTFORM_H
  37 #define NASM_OUTFORM_H
  38
  39 #include "nasm.h"
  40
  41 /* -------------- USER MODIFIABLE PART ---------------- */
  42
  43 /*
  44  * Insert #defines here in accordance with the configuration
  45  * instructions above.
  46  *
  47  * E.g.
  48  *
  49  * #define OF_ONLY
  50  * #define OF_OBJ
  51  * #define OF_BIN
  52  *
  53  * for a 16-bit DOS assembler with no extraneous formats.
  54  */
  55
  56 /* ------------ END USER MODIFIABLE PART -------------- */
  57
  58 /* ====configurable info begins here==== */
  59 /* formats configurable:
  60  * bin,obj,elf,aout,aoutb,coff,win32,as86,rdf2,macho */
  61
  62 /* process options... */
  63
  64 #ifndef OF_ONLY
  65 #ifndef OF_ALL
  66 #define OF_ALL                  /* default is to have all formats */
  67 #endif
  68 #endif
  69
  70 #ifdef OF_ALL                   /* set all formats on... */
  71 #ifndef OF_BIN
  72 #define OF_BIN
  73 #endif
  74 #ifndef OF_OBJ
  75 #define OF_OBJ
  76 #endif
  77 #ifndef OF_ELF
  78 #define OF_ELF
  79 #endif
  80 #ifndef OF_COFF
  81 #define OF_COFF
  82 #endif
  83 #ifndef OF_AOUT
  84 #define OF_AOUT
  85 #endif
  86 #ifndef OF_AOUTB
  87 #define OF_AOUTB
  88 #endif
  89 #ifndef OF_WIN32
  90 #define OF_WIN32
  91 #endif
  92 #ifndef OF_WIN64
  93 #define OF_WIN64
  94 #endif
  95 #ifndef OF_AS86
  96 #define OF_AS86
  97 #endif
  98 #ifndef OF_RDF2
  99 #define OF_RDF2
 100 #endif
 101 #ifndef OF_IEEE
 102 #define OF_IEEE
 103 #endif
 104 #ifndef OF_MACHO
 105 #define OF_MACHO
 106 #endif
 107 #endif                          /* OF_ALL */
 108
 109 /* turn on groups of formats specified.... */
 110 #ifdef OF_DOS
 111 #ifndef OF_OBJ
 112 #define OF_OBJ
 113 #endif
 114 #ifndef OF_BIN
 115 #define OF_BIN
 116 #endif
 117 #ifndef OF_WIN32
 118 #define OF_WIN32
 119 #endif
 120 #ifndef OF_WIN64
 121 #define OF_WIN64
 122 #endif
 123 #endif
 124
 125 #ifdef OF_UNIX
 126 #ifndef OF_AOUT
 127 #define OF_AOUT
 128 #endif
 129 #ifndef OF_AOUTB
 130 #define OF_AOUTB
 131 #endif
 132 #ifndef OF_COFF
 133 #define OF_COFF
 134 #endif
 135 #ifndef OF_ELF
 136 #define OF_ELF
 137 #endif
 138 #endif
 139
 140 #ifdef OF_OTHERS
 141 #ifndef OF_BIN
 142 #define OF_BIN
 143 #endif
 144 #ifndef OF_AS86
 145 #define OF_AS86
 146 #endif
 147 #ifndef OF_RDF2
 148 #define OF_RDF2
 149 #endif
 150 #ifndef OF_IEEE
 151 #define OF_IEEE
 152 #endif
 153 #ifndef OF_MACHO
 154 #define OF_MACHO
 155 #endif
 156 #endif
 157
 158 /* finally... override any format specifically specified to be off */
 159 #ifdef OF_NO_BIN
 160 #undef OF_BIN
 161 #endif
 162 #ifdef OF_NO_OBJ
 163 #undef OF_OBJ
 164 #endif
 165 #ifdef OF_NO_ELF
 166 #undef OF_ELF
 167 #endif
 168 #ifdef OF_NO_AOUT
 169 #undef OF_AOUT
 170 #endif
 171 #ifdef OF_NO_AOUTB
 172 #undef OF_AOUTB
 173 #endif
 174 #ifdef OF_NO_COFF
 175 #undef OF_COFF
 176 #endif
 177 #ifdef OF_NO_WIN32
 178 #undef OF_WIN32
 179 #endif
 180 #ifdef OF_NO_WIN64
 181 #undef OF_WIN64
 182 #endif
 183 #ifdef OF_NO_AS86
 184 #undef OF_AS86
 185 #endif
 186 #ifdef OF_NO_RDF2
 187 #undef OF_RDF
 188 #endif
 189 #ifdef OF_NO_IEEE
 190 #undef OF_IEEE
 191 #endif
 192 #ifdef OF_NO_MACHO
 193 #undef OF_MACHO
 194 #endif
 195
 196 #ifndef OF_DEFAULT
 197 #define OF_DEFAULT of_bin
 198 #endif
 199
 200 #ifdef BUILD_DRIVERS_ARRAY      /* only if included from outform.c */
 201
 202 /* pull in the externs for the different formats, then make the *drivers
 203  * array based on the above defines */
 204
 205 extern struct ofmt of_bin;
 206 extern struct ofmt of_aout;
 207 extern struct ofmt of_aoutb;
 208 extern struct ofmt of_coff;
 209 extern struct ofmt of_elf;
 210 extern struct ofmt of_as86;
 211 extern struct ofmt of_obj;
 212 extern struct ofmt of_win32;
 213 extern struct ofmt of_win64;
 214 extern struct ofmt of_rdf2;
 215 extern struct ofmt of_ieee;
 216 extern struct ofmt of_macho;
 217 extern struct ofmt of_dbg;
 218
 219 struct ofmt *drivers[] = {
 220 #ifdef OF_BIN
 221     &of_bin,
 222 #endif
 223 #ifdef OF_AOUT
 224     &of_aout,
 225 #endif
 226 #ifdef OF_AOUTB
 227     &of_aoutb,
 228 #endif
 229 #ifdef OF_COFF
 230     &of_coff,
 231 #endif
 232 #ifdef OF_ELF
 233     &of_elf,
 234 #endif
 235 #ifdef OF_AS86
 236     &of_as86,
 237 #endif
 238 #ifdef OF_OBJ
 239     &of_obj,
 240 #endif
 241 #ifdef OF_WIN32
 242     &of_win32,
 243 #endif
 244 #ifdef OF_WIN64
 245     &of_win64,
 246 #endif
 247 #ifdef OF_RDF2
 248     &of_rdf2,
 249 #endif
 250 #ifdef OF_IEEE
 251     &of_ieee,
 252 #endif
 253 #ifdef OF_MACHO
 254     &of_macho,
 255 #endif
 256 #ifdef OF_DBG
 257     &of_dbg,
 258 #endif
 259
 260     NULL
 261 };
 262
 263 #endif                          /* BUILD_DRIVERS_ARRAY */
 264
 265 struct ofmt *ofmt_find(int8_t *);
 266 struct dfmt *dfmt_find(struct ofmt *, int8_t *);
 267 void ofmt_list(struct ofmt *, FILE *);
 268 void dfmt_list(struct ofmt *ofmt, FILE * fp);
 269 struct ofmt *ofmt_register(efunc error);
 270
 271 #endif                          /* NASM_OUTFORM_H */