msi: Make TransformView_Create static.
[wine.git] / tools / winedump / winedump.h
blob4561ca3751a232cd0fc8d79c9665901a7124bf81
1 /*
2 * Winedump - A Wine DLL tool
4 * Copyright 2000 Jon Griffiths
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * References:
21 * DLL symbol extraction based on file format from alib (anthonyw.cjb.net).
23 * Option processing shamelessly cadged from winebuild.
25 * All the cool functionality (prototyping, call tracing, forwarding)
26 * relies on Patrik Stridvall's 'function_grep.pl' script to work.
28 * http://www.kegel.com/mangle.html
29 * Gives information on the name mangling scheme used by MS compilers,
30 * used as the starting point for the code here. Contains a few
31 * mistakes and some incorrect assumptions, but the lists of types
32 * are pure gold.
34 #ifndef __WINE_WINEDUMP_H
35 #define __WINE_WINEDUMP_H
37 #include <stdlib.h>
38 #include <stdio.h>
39 #include <string.h>
40 #include <ctype.h>
41 #include <errno.h>
42 #include <assert.h>
43 #include <stdarg.h>
45 #include "../tools.h"
46 #include "windef.h"
47 #include "winbase.h"
48 #include "wine/mscvpdb.h"
50 /* Argument type constants */
51 #define MAX_FUNCTION_ARGS 32
53 #define ARG_VOID 0x0
54 #define ARG_STRING 0x1
55 #define ARG_WIDE_STRING 0x2
56 #define ARG_POINTER 0x3
57 #define ARG_LONG 0x4
58 #define ARG_DOUBLE 0x5
59 #define ARG_STRUCT 0x6 /* By value */
60 #define ARG_FLOAT 0x7
61 #define ARG_VARARGS 0x8
63 /* Compound type flags */
64 #define CT_BY_REFERENCE 0x1
65 #define CT_VOLATILE 0x2
66 #define CT_CONST 0x4
67 #define CT_EXTENDED 0x8
69 /* symbol flags */
70 #define SYM_CDECL 0x1
71 #define SYM_STDCALL 0x2
72 #define SYM_THISCALL 0x4
73 #define SYM_DATA 0x8 /* Data, not a function */
75 typedef enum {NONE, DMGL, SPEC, DUMP} Mode;
77 /* Structure holding a parsed symbol */
78 typedef struct __parsed_symbol
80 char *symbol;
81 int ordinal;
82 char *return_text;
83 char return_type;
84 char *function_name;
85 int varargs;
86 unsigned int argc;
87 unsigned int flags;
88 char arg_type [MAX_FUNCTION_ARGS];
89 char arg_flag [MAX_FUNCTION_ARGS];
90 char *arg_text [MAX_FUNCTION_ARGS];
91 char *arg_name [MAX_FUNCTION_ARGS];
92 } parsed_symbol;
94 /* FIXME: Replace with some hash such as GHashTable */
95 typedef struct __search_symbol
97 struct __search_symbol *next;
98 BOOL found;
99 char symbolname[1]; /* static string, be ANSI C compliant by [1] */
100 } search_symbol;
102 /* All globals */
103 typedef struct __globals
105 Mode mode; /* SPEC, DEMANGLE or DUMP */
107 /* Options: generic */
108 BOOL do_quiet; /* -q */
109 BOOL do_verbose; /* -v */
111 /* Option arguments: generic */
112 const char *input_name; /* */
113 const char *input_module; /* input module name generated after input_name according mode */
115 /* Options: spec mode */
116 BOOL do_code; /* -c, -t, -f */
117 BOOL do_trace; /* -t, -f */
118 BOOL do_cdecl; /* -C */
119 BOOL do_documentation; /* -D */
121 /* Options: dump mode */
122 BOOL do_demangle; /* -d */
123 BOOL do_dumpheader; /* -f */
124 BOOL do_dump_rawdata; /* -x */
125 BOOL do_debug; /* -G == 1, -g == 2 */
126 BOOL do_symbol_table; /* -t */
128 /* Option arguments: spec mode */
129 int start_ordinal; /* -s */
130 int end_ordinal; /* -e */
131 search_symbol *search_symbol; /* -S */
132 char *directory; /* -I */
133 const char *forward_dll; /* -f */
134 const char *dll_name; /* -o */
135 const char *uc_dll_name; /* -o */
137 /* Option arguments: dump mode */
138 const char **dumpsect; /* -j */
139 } _globals;
141 extern _globals globals;
142 extern void *dump_base;
143 extern size_t dump_total_len;
145 BOOL globals_dump_sect(const char*);
147 /* Names to use for output DLL */
148 #define OUTPUT_DLL_NAME \
149 (globals.dll_name ? globals.dll_name : (globals.input_module ? globals.input_module : globals.input_name))
150 #define OUTPUT_UC_DLL_NAME globals.uc_dll_name
152 /* Verbosity levels */
153 #define QUIET (globals.do_quiet)
154 #define NORMAL (!QUIET)
155 #define VERBOSE (globals.do_verbose)
157 /* Default calling convention */
158 #define CALLING_CONVENTION (globals.do_cdecl ? SYM_CDECL : SYM_STDCALL)
160 /* Image functions */
161 void dump_file(const char* name);
163 /* DLL functions */
164 BOOL dll_open (const char *dll_name);
166 BOOL dll_next_symbol (parsed_symbol * sym);
168 /* Symbol functions */
169 void symbol_init(parsed_symbol* symbol, const char* name);
171 BOOL symbol_demangle (parsed_symbol *symbol);
173 BOOL symbol_search (parsed_symbol *symbol);
175 void symbol_clear(parsed_symbol *sym);
177 BOOL symbol_is_valid_c(const parsed_symbol *sym);
179 const char *symbol_get_call_convention(const parsed_symbol *sym);
181 const char *symbol_get_spec_type (const parsed_symbol *sym, size_t arg);
183 void symbol_clean_string (char *string);
185 int symbol_get_type (const char *string);
187 /* Output functions */
188 void output_spec_preamble (void);
190 void output_spec_symbol (const parsed_symbol *sym);
192 void output_header_preamble (void);
194 void output_header_symbol (const parsed_symbol *sym);
196 void output_c_preamble (void);
198 void output_c_symbol (const parsed_symbol *sym);
200 void output_prototype (FILE *file, const parsed_symbol *sym);
202 void output_makefile (void);
204 /* Misc functions */
205 char *str_substring(const char *start, const char *end);
207 char *str_replace (char *str, const char *oldstr, const char *newstr);
209 const char *str_match (const char *str, const char *match, BOOL *found);
211 const char *str_find_set (const char *str, const char *findset);
213 char *str_toupper (char *str);
215 const char *get_machine_str(int mach);
217 /* file dumping functions */
218 enum FileSig {SIG_UNKNOWN, SIG_DOS, SIG_PE, SIG_DBG, SIG_PDB, SIG_NE, SIG_LE, SIG_MDMP, SIG_COFFLIB, SIG_LNK,
219 SIG_EMF, SIG_EMFSPOOL, SIG_MF, SIG_FNT, SIG_TLB, SIG_NLS};
221 const void* PRD(unsigned long prd, unsigned long len);
222 unsigned long Offset(const void* ptr);
224 typedef void (*file_dumper)(void);
225 BOOL dump_analysis(const char*, file_dumper, enum FileSig);
227 void dump_data( const unsigned char *ptr, unsigned int size, const char *prefix );
228 const char* get_time_str( unsigned long );
229 unsigned int strlenW( const unsigned short *str );
230 void dump_unicode_str( const unsigned short *str, int len );
231 const char* get_guid_str(const GUID* guid);
232 const char* get_unicode_str( const WCHAR *str, int len );
233 const char* get_symbol_str(const char* symname);
234 void print_fake_dll(void);
235 void dump_file_header(const IMAGE_FILE_HEADER *, BOOL);
236 void dump_optional_header(const IMAGE_OPTIONAL_HEADER32 *, UINT);
237 void dump_section(const IMAGE_SECTION_HEADER *, const char* strtable);
238 void dump_section_characteristics(DWORD characteristics, const char* sep);
240 enum FileSig get_kind_exec(void);
241 void dos_dump( void );
242 void pe_dump( void );
243 void ne_dump( void );
244 void le_dump( void );
245 enum FileSig get_kind_mdmp(void);
246 void mdmp_dump( void );
247 enum FileSig get_kind_lib(void);
248 void lib_dump( void );
249 enum FileSig get_kind_dbg(void);
250 void dbg_dump( void );
251 enum FileSig get_kind_lnk(void);
252 void lnk_dump( void );
253 enum FileSig get_kind_emf(void);
254 unsigned long dump_emfrecord(const char *pfx, unsigned long offset);
255 void emf_dump( void );
256 enum FileSig get_kind_emfspool(void);
257 void emfspool_dump(void);
258 enum FileSig get_kind_mf(void);
259 void mf_dump(void);
260 enum FileSig get_kind_pdb(void);
261 void pdb_dump(void);
262 enum FileSig get_kind_fnt(void);
263 void fnt_dump( void );
264 enum FileSig get_kind_tlb(void);
265 void tlb_dump(void);
266 enum FileSig get_kind_nls(void);
267 void nls_dump(void);
269 BOOL codeview_dump_symbols(const void* root, unsigned long start, unsigned long size);
270 BOOL codeview_dump_types_from_offsets(const void* table, const DWORD* offsets, unsigned num_types);
271 BOOL codeview_dump_types_from_block(const void* table, unsigned long len);
272 void codeview_dump_linetab(const char* linetab, BOOL pascal_str, const char* pfx);
273 void codeview_dump_linetab2(const char* linetab, DWORD size, const PDB_STRING_TABLE*, const char* pfx);
274 const char* pdb_get_string_table_entry(const PDB_STRING_TABLE* table, unsigned ofs);
276 void dump_stabs(const void* pv_stabs, unsigned szstabs, const char* stabstr, unsigned szstr);
277 void dump_codeview(unsigned long ptr, unsigned long len);
278 void dump_coff(unsigned long coffbase, unsigned long len,
279 const IMAGE_SECTION_HEADER *sectHead);
280 void dump_coff_symbol_table(const IMAGE_SYMBOL *coff_symbols, unsigned num_sym,
281 const IMAGE_SECTION_HEADER *sectHead);
282 void dump_frame_pointer_omission(unsigned long base, unsigned long len);
284 FILE *open_file (const char *name, const char *ext, const char *mode);
286 #ifdef __GNUC__
287 void do_usage (const char *arg) __attribute__ ((noreturn));
288 void fatal (const char *message) __attribute__ ((noreturn));
289 #else
290 void do_usage (const char *arg);
291 void fatal (const char *message);
292 #endif
296 #endif /* __WINE_WINEDUMP_H */