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 license given in the file "LICENSE"
   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', 'elf32' 'elf64' 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_ELF32 -DOF_DEFAULT=of_elf32 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,elf32,elf64,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_ELF32
  78 #define OF_ELF32
  79 #endif
  80 #ifndef OF_ELF64
  81 #define OF_ELF64
  82 #endif
  83 #ifndef OF_COFF
  84 #define OF_COFF
  85 #endif
  86 #ifndef OF_AOUT
  87 #define OF_AOUT
  88 #endif
  89 #ifndef OF_AOUTB
  90 #define OF_AOUTB
  91 #endif
  92 #ifndef OF_WIN32
  93 #define OF_WIN32
  94 #endif
  95 #ifndef OF_WIN64
  96 #define OF_WIN64
  97 #endif
  98 #ifndef OF_AS86
  99 #define OF_AS86
 100 #endif
 101 #ifndef OF_RDF2
 102 #define OF_RDF2
 103 #endif
 104 #ifndef OF_IEEE
 105 #define OF_IEEE
 106 #endif
 107 #ifndef OF_MACHO
 108 #define OF_MACHO
 109 #endif
 110 #endif                          /* OF_ALL */
 111
 112 /* turn on groups of formats specified.... */
 113 #ifdef OF_DOS
 114 #ifndef OF_OBJ
 115 #define OF_OBJ
 116 #endif
 117 #ifndef OF_BIN
 118 #define OF_BIN
 119 #endif
 120 #ifndef OF_COFF
 121 #define OF_COFF                 /* COFF is used by DJGPP */
 122 #endif
 123 #ifndef OF_WIN32
 124 #define OF_WIN32
 125 #endif
 126 #ifndef OF_WIN64
 127 #define OF_WIN64
 128 #endif
 129 #endif
 130
 131 #ifdef OF_UNIX
 132 #ifndef OF_AOUT
 133 #define OF_AOUT
 134 #endif
 135 #ifndef OF_AOUTB
 136 #define OF_AOUTB
 137 #endif
 138 #ifndef OF_COFF
 139 #define OF_COFF
 140 #endif
 141 #ifndef OF_ELF32
 142 #define OF_ELF32
 143 #endif
 144 #ifndef OF_ELF64
 145 #define OF_ELF64
 146 #endif
 147 #endif
 148
 149 #ifdef OF_OTHERS
 150 #ifndef OF_BIN
 151 #define OF_BIN
 152 #endif
 153 #ifndef OF_AS86
 154 #define OF_AS86
 155 #endif
 156 #ifndef OF_RDF2
 157 #define OF_RDF2
 158 #endif
 159 #ifndef OF_IEEE
 160 #define OF_IEEE
 161 #endif
 162 #ifndef OF_MACHO
 163 #define OF_MACHO
 164 #endif
 165 #endif
 166
 167 /* finally... override any format specifically specified to be off */
 168 #ifdef OF_NO_BIN
 169 #undef OF_BIN
 170 #endif
 171 #ifdef OF_NO_OBJ
 172 #undef OF_OBJ
 173 #endif
 174 #ifdef OF_NO_ELF32
 175 #undef OF_ELF32
 176 #endif
 177 #ifdef OF_NO_ELF64
 178 #undef OF_ELF64
 179 #endif
 180 #ifdef OF_NO_AOUT
 181 #undef OF_AOUT
 182 #endif
 183 #ifdef OF_NO_AOUTB
 184 #undef OF_AOUTB
 185 #endif
 186 #ifdef OF_NO_COFF
 187 #undef OF_COFF
 188 #endif
 189 #ifdef OF_NO_WIN32
 190 #undef OF_WIN32
 191 #endif
 192 #ifdef OF_NO_WIN64
 193 #undef OF_WIN64
 194 #endif
 195 #ifdef OF_NO_AS86
 196 #undef OF_AS86
 197 #endif
 198 #ifdef OF_NO_RDF2
 199 #undef OF_RDF
 200 #endif
 201 #ifdef OF_NO_IEEE
 202 #undef OF_IEEE
 203 #endif
 204 #ifdef OF_NO_MACHO
 205 #undef OF_MACHO
 206 #endif
 207
 208 #ifndef OF_DEFAULT
 209 #define OF_DEFAULT of_bin
 210 #endif
 211
 212 #ifdef BUILD_DRIVERS_ARRAY      /* only if included from outform.c */
 213
 214 /* pull in the externs for the different formats, then make the *drivers
 215  * array based on the above defines */
 216
 217 extern struct ofmt of_bin;
 218 extern struct ofmt of_aout;
 219 extern struct ofmt of_aoutb;
 220 extern struct ofmt of_coff;
 221 extern struct ofmt of_elf32;
 222 extern struct ofmt of_elf;
 223 extern struct ofmt of_elf64;
 224 extern struct ofmt of_as86;
 225 extern struct ofmt of_obj;
 226 extern struct ofmt of_win32;
 227 extern struct ofmt of_win64;
 228 extern struct ofmt of_rdf2;
 229 extern struct ofmt of_ieee;
 230 extern struct ofmt of_macho;
 231 extern struct ofmt of_dbg;
 232
 233 struct ofmt *drivers[] = {
 234 #ifdef OF_BIN
 235     &of_bin,
 236 #endif
 237 #ifdef OF_AOUT
 238     &of_aout,
 239 #endif
 240 #ifdef OF_AOUTB
 241     &of_aoutb,
 242 #endif
 243 #ifdef OF_COFF
 244     &of_coff,
 245 #endif
 246 #ifdef OF_ELF32
 247     &of_elf32,
 248     &of_elf,
 249 #endif
 250 #ifdef OF_ELF64
 251     &of_elf64,
 252 #endif
 253 #ifdef OF_AS86
 254     &of_as86,
 255 #endif
 256 #ifdef OF_OBJ
 257     &of_obj,
 258 #endif
 259 #ifdef OF_WIN32
 260     &of_win32,
 261 #endif
 262 #ifdef OF_WIN64
 263     &of_win64,
 264 #endif
 265 #ifdef OF_RDF2
 266     &of_rdf2,
 267 #endif
 268 #ifdef OF_IEEE
 269     &of_ieee,
 270 #endif
 271 #ifdef OF_MACHO
 272     &of_macho,
 273 #endif
 274 #ifdef OF_DBG
 275     &of_dbg,
 276 #endif
 277
 278     NULL
 279 };
 280
 281 #endif                          /* BUILD_DRIVERS_ARRAY */
 282
 283 struct ofmt *ofmt_find(char *);
 284 struct dfmt *dfmt_find(struct ofmt *, char *);
 285 void ofmt_list(struct ofmt *, FILE *);
 286 void dfmt_list(struct ofmt *ofmt, FILE * fp);
 287 struct ofmt *ofmt_register(efunc error);
 288
 289 #endif                          /* NASM_OUTFORM_H */