tools/c2man.pl: Generate correct html.
[wine] / tools / winebuild / build.h
1 /*
2  * Copyright 1993 Robert J. Amstadt
3  * Copyright 1995 Martin von Loewis
4  * Copyright 1995, 1996, 1997 Alexandre Julliard
5  * Copyright 1997 Eric Youngdale
6  * Copyright 1999 Ulrich Weigand
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __WINE_BUILD_H
24 #define __WINE_BUILD_H
25
26 #ifndef __WINE_CONFIG_H
27 # error You must include config.h to use this header
28 #endif
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 typedef enum
35 {
36     TYPE_VARIABLE,     /* variable */
37     TYPE_PASCAL,       /* pascal function (Win16) */
38     TYPE_ABS,          /* absolute value (Win16) */
39     TYPE_STUB,         /* unimplemented stub */
40     TYPE_STDCALL,      /* stdcall function (Win32) */
41     TYPE_CDECL,        /* cdecl function (Win32) */
42     TYPE_VARARGS,      /* varargs function (Win32) */
43     TYPE_EXTERN,       /* external symbol (Win32) */
44     TYPE_NBTYPES
45 } ORD_TYPE;
46
47 typedef enum
48 {
49     SPEC_WIN16,
50     SPEC_WIN32
51 } SPEC_TYPE;
52
53 typedef struct
54 {
55     int n_values;
56     int *values;
57 } ORD_VARIABLE;
58
59 typedef struct
60 {
61     char arg_types[21];
62 } ORD_FUNCTION;
63
64 typedef struct
65 {
66     unsigned short value;
67 } ORD_ABS;
68
69 typedef struct
70 {
71     ORD_TYPE    type;
72     int         ordinal;
73     int         lineno;
74     int         flags;
75     char       *name;         /* public name of this function */
76     char       *link_name;    /* name of the C symbol to link to */
77     char       *export_name;  /* name exported under for noname exports */
78     union
79     {
80         ORD_VARIABLE   var;
81         ORD_FUNCTION   func;
82         ORD_ABS        abs;
83     } u;
84 } ORDDEF;
85
86 typedef struct
87 {
88     char            *file_name;          /* file name of the dll */
89     char            *dll_name;           /* internal name of the dll */
90     char            *init_func;          /* initialization routine */
91     SPEC_TYPE        type;               /* type of dll (Win16/Win32) */
92     int              base;               /* ordinal base */
93     int              limit;              /* ordinal limit */
94     int              stack_size;         /* exe stack size */
95     int              heap_size;          /* exe heap size */
96     int              nb_entry_points;    /* number of used entry points */
97     int              alloc_entry_points; /* number of allocated entry points */
98     int              nb_names;           /* number of entry points with names */
99     unsigned int     nb_resources;       /* number of resources */
100     int              characteristics;    /* characteristics for the PE header */
101     int              subsystem;          /* subsystem id */
102     int              subsystem_major;    /* subsystem version major number */
103     int              subsystem_minor;    /* subsystem version minor number */
104     ORDDEF          *entry_points;       /* dll entry points */
105     ORDDEF         **names;              /* array of entry point names (points into entry_points) */
106     ORDDEF         **ordinals;           /* array of dll ordinals (points into entry_points) */
107     struct resource *resources;          /* array of dll resources (format differs between Win16/Win32) */
108 } DLLSPEC;
109
110 enum target_cpu
111 {
112     CPU_x86, CPU_x86_64, CPU_SPARC, CPU_ALPHA, CPU_POWERPC
113 };
114
115 enum target_platform
116 {
117     PLATFORM_UNSPECIFIED, PLATFORM_APPLE, PLATFORM_SVR4, PLATFORM_WINDOWS
118 };
119
120 extern enum target_cpu target_cpu;
121 extern enum target_platform target_platform;
122
123 /* entry point flags */
124 #define FLAG_NORELAY   0x01  /* don't use relay debugging for this function */
125 #define FLAG_NONAME    0x02  /* don't import function by name */
126 #define FLAG_RET16     0x04  /* function returns a 16-bit value */
127 #define FLAG_RET64     0x08  /* function returns a 64-bit value */
128 #define FLAG_I386      0x10  /* function is i386 only */
129 #define FLAG_REGISTER  0x20  /* use register calling convention */
130 #define FLAG_PRIVATE   0x40  /* function is private (cannot be imported) */
131
132 #define FLAG_FORWARD   0x80  /* function is a forwarded name */
133 #define FLAG_EXT_LINK  0x100 /* function links to an external symbol */
134
135 #define MAX_ORDINALS  65535
136
137 /* global functions */
138
139 #ifndef __GNUC__
140 #define __attribute__(X)
141 #endif
142
143 extern void *xmalloc (size_t size);
144 extern void *xrealloc (void *ptr, size_t size);
145 extern char *xstrdup( const char *str );
146 extern char *strupper(char *s);
147 extern int strendswith(const char* str, const char* end);
148 extern void fatal_error( const char *msg, ... )
149    __attribute__ ((__format__ (__printf__, 1, 2)));
150 extern void fatal_perror( const char *msg, ... )
151    __attribute__ ((__format__ (__printf__, 1, 2)));
152 extern void error( const char *msg, ... )
153    __attribute__ ((__format__ (__printf__, 1, 2)));
154 extern void warning( const char *msg, ... )
155    __attribute__ ((__format__ (__printf__, 1, 2)));
156 extern char *get_temp_file_name( const char *prefix, const char *suffix );
157 extern void output_standard_file_header( FILE *outfile );
158 extern FILE *open_input_file( const char *srcdir, const char *name );
159 extern void close_input_file( FILE *file );
160 extern void dump_bytes( FILE *outfile, const void *buffer, unsigned int size );
161 extern int remove_stdcall_decoration( char *name );
162 extern void assemble_file( const char *src_file, const char *obj_file );
163 extern DLLSPEC *alloc_dll_spec(void);
164 extern void free_dll_spec( DLLSPEC *spec );
165 extern const char *make_c_identifier( const char *str );
166 extern const char *get_stub_name( const ORDDEF *odp, const DLLSPEC *spec );
167 extern unsigned int get_alignment(unsigned int align);
168 extern unsigned int get_page_size(void);
169 extern unsigned int get_ptr_size(void);
170 extern const char *asm_name( const char *func );
171 extern const char *func_declaration( const char *func );
172 extern const char *asm_globl( const char *func );
173 extern const char *get_asm_ptr_keyword(void);
174 extern const char *get_asm_string_keyword(void);
175 extern const char *get_asm_short_keyword(void);
176 extern const char *get_asm_rodata_section(void);
177 extern const char *get_asm_string_section(void);
178 extern void output_function_size( FILE *outfile, const char *name );
179 extern void output_gnu_stack_note( FILE *outfile );
180
181 extern void add_import_dll( const char *name, const char *filename );
182 extern void add_delayed_import( const char *name );
183 extern void add_ignore_symbol( const char *name );
184 extern void add_extra_ld_symbol( const char *name );
185 extern void read_undef_symbols( DLLSPEC *spec, char **argv );
186 extern int resolve_imports( DLLSPEC *spec );
187 extern int has_imports(void);
188 extern int has_relays( DLLSPEC *spec );
189 extern void output_get_pc_thunk( FILE *outfile );
190 extern void output_stubs( FILE *outfile, DLLSPEC *spec );
191 extern void output_imports( FILE *outfile, DLLSPEC *spec );
192 extern int load_res32_file( const char *name, DLLSPEC *spec );
193 extern void output_resources( FILE *outfile, DLLSPEC *spec );
194 extern void load_res16_file( const char *name, DLLSPEC *spec );
195 extern void output_res16_data( FILE *outfile, DLLSPEC *spec );
196 extern void output_res16_directory( FILE *outfile, DLLSPEC *spec, const char *header_name );
197
198 extern void BuildRelays16( FILE *outfile );
199 extern void BuildRelays32( FILE *outfile );
200 extern void BuildSpec16File( FILE *outfile, DLLSPEC *spec );
201 extern void BuildSpec32File( FILE *outfile, DLLSPEC *spec );
202 extern void BuildDef32File( FILE *outfile, DLLSPEC *spec );
203
204 extern int parse_spec_file( FILE *file, DLLSPEC *spec );
205 extern int parse_def_file( FILE *file, DLLSPEC *spec );
206
207 /* global variables */
208
209 extern int current_line;
210 extern int UsePIC;
211 extern int nb_lib_paths;
212 extern int nb_errors;
213 extern int display_warnings;
214 extern int kill_at;
215 extern int verbose;
216 extern int save_temps;
217
218 extern char *input_file_name;
219 extern char *spec_file_name;
220 extern const char *output_file_name;
221 extern char **lib_path;
222
223 extern char *as_command;
224 extern char *ld_command;
225 extern char *nm_command;
226
227 #endif  /* __WINE_BUILD_H */