Added support for DirectDraw overlays using the XVideo extension.
[wine] / include / module.h
1 /*
2  * Module definitions
3  *
4  * Copyright 1995 Alexandre Julliard
5  */
6
7 #ifndef __WINE_MODULE_H
8 #define __WINE_MODULE_H
9
10 #include "windef.h"
11 #include "winbase.h"
12
13   /* In-memory module structure. See 'Windows Internals' p. 219 */
14 typedef struct _NE_MODULE
15 {
16     WORD    magic;            /* 00 'NE' signature */
17     WORD    count;            /* 02 Usage count */
18     WORD    entry_table;      /* 04 Near ptr to entry table */
19     HMODULE16  next;          /* 06 Selector to next module */
20     WORD    dgroup_entry;     /* 08 Near ptr to segment entry for DGROUP */
21     WORD    fileinfo;         /* 0a Near ptr to file info (OFSTRUCT) */
22     WORD    flags;            /* 0c Module flags */
23     WORD    dgroup;           /* 0e Logical segment for DGROUP */
24     WORD    heap_size;        /* 10 Initial heap size */
25     WORD    stack_size;       /* 12 Initial stack size */
26     WORD    ip;               /* 14 Initial ip */
27     WORD    cs;               /* 16 Initial cs (logical segment) */
28     WORD    sp;               /* 18 Initial stack pointer */
29     WORD    ss;               /* 1a Initial ss (logical segment) */
30     WORD    seg_count;        /* 1c Number of segments in segment table */
31     WORD    modref_count;     /* 1e Number of module references */
32     WORD    nrname_size;      /* 20 Size of non-resident names table */
33     WORD    seg_table;        /* 22 Near ptr to segment table */
34     WORD    res_table;        /* 24 Near ptr to resource table */
35     WORD    name_table;       /* 26 Near ptr to resident names table */
36     WORD    modref_table;     /* 28 Near ptr to module reference table */
37     WORD    import_table;     /* 2a Near ptr to imported names table */
38     DWORD   nrname_fpos;      /* 2c File offset of non-resident names table */
39     WORD    moveable_entries; /* 30 Number of moveable entries in entry table*/
40     WORD    alignment;        /* 32 Alignment shift count */
41     WORD    truetype;         /* 34 Set to 2 if TrueType font */
42     BYTE    os_flags;         /* 36 Operating system flags */
43     BYTE    misc_flags;       /* 37 Misc. flags */
44     HANDLE16   dlls_to_init;  /* 38 List of DLLs to initialize */
45     HANDLE16   nrname_handle; /* 3a Handle to non-resident name table */
46     WORD    min_swap_area;    /* 3c Min. swap area size */
47     WORD    expected_version; /* 3e Expected Windows version */
48     /* From here, these are extra fields not present in normal Windows */
49     HMODULE  module32;      /* 40 PE module handle for Win32 modules */
50     HMODULE16  self;          /* 44 Handle for this module */
51     WORD    self_loading_sel; /* 46 Selector used for self-loading apps. */
52     LPVOID  hRsrcMap;         /* HRSRC 16->32 map (for 32-bit modules) */
53 } NE_MODULE;
54
55
56 typedef struct {
57     BYTE type;
58     BYTE flags;
59     BYTE segnum;
60     WORD offs WINE_PACKED;
61 } ET_ENTRY;
62
63 typedef struct {
64     WORD first; /* ordinal */
65     WORD last; /* ordinal */
66     WORD next; /* bundle */
67 } ET_BUNDLE;
68
69
70   /* In-memory segment table */
71 typedef struct
72 {
73     WORD      filepos;   /* Position in file, in sectors */
74     WORD      size;      /* Segment size on disk */
75     WORD      flags;     /* Segment flags */
76     WORD      minsize;   /* Min. size of segment in memory */
77     HANDLE16  hSeg;      /* Selector or handle (selector - 1) */
78                          /* of segment in memory */
79 } SEGTABLEENTRY;
80
81
82   /* Self-loading modules contain this structure in their first segment */
83
84 #include "pshpack1.h"
85
86 typedef struct
87 {
88     WORD      version;       /* Must be "A0" (0x3041) */
89     WORD      reserved;
90     FARPROC16 BootApp;       /* startup procedure */
91     FARPROC16 LoadAppSeg;    /* procedure to load a segment */
92     FARPROC16 reserved2;
93     FARPROC16 MyAlloc;       /* memory allocation procedure, 
94                               * wine must write this field */
95     FARPROC16 EntryAddrProc;
96     FARPROC16 ExitProc;      /* exit procedure */
97     WORD      reserved3[4];
98     FARPROC16 SetOwner;      /* Set Owner procedure, exported by wine */
99 } SELFLOADHEADER;
100
101   /* Parameters for LoadModule() */
102 typedef struct
103 {
104     HGLOBAL16 hEnvironment;         /* Environment segment */
105     SEGPTR    cmdLine WINE_PACKED;  /* Command-line */
106     SEGPTR    showCmd WINE_PACKED;  /* Code for ShowWindow() */
107     SEGPTR    reserved WINE_PACKED;
108 } LOADPARAMS16;
109
110 typedef struct 
111 {
112     LPSTR lpEnvAddress;
113     LPSTR lpCmdLine;
114     UINT16 *lpCmdShow;
115     DWORD dwReserved;
116 } LOADPARAMS;
117
118 #include "poppack.h"
119
120 /* internal representation of 32bit modules. per process. */
121 typedef struct _wine_modref
122 {
123         struct _wine_modref *next;
124         struct _wine_modref *prev;
125         HMODULE              module;
126         void                *dlhandle;  /* handle returned by dlopen() */
127         int                  tlsindex;  /* TLS index or -1 if none */
128
129         FARPROC            (*find_export)( struct _wine_modref *wm, LPCSTR func, BOOL snoop );
130
131         int                     nDeps;
132         struct _wine_modref     **deps;
133
134         int                     flags;
135         int                     refCount;
136
137         char                    *filename;
138         char                    *modname;
139         char                    *short_filename;
140         char                    *short_modname;
141 } WINE_MODREF;
142
143 #define WINE_MODREF_INTERNAL              0x00000001
144 #define WINE_MODREF_NO_DLL_CALLS          0x00000002
145 #define WINE_MODREF_PROCESS_ATTACHED      0x00000004
146 #define WINE_MODREF_DONT_RESOLVE_REFS     0x00000020
147 #define WINE_MODREF_MARKER                0x80000000
148
149
150 /* Resource types */
151 typedef struct resource_typeinfo_s NE_TYPEINFO;
152 typedef struct resource_nameinfo_s NE_NAMEINFO;
153
154 #define NE_SEG_TABLE(pModule) \
155     ((SEGTABLEENTRY *)((char *)(pModule) + (pModule)->seg_table))
156
157 #define NE_MODULE_TABLE(pModule) \
158     ((WORD *)((char *)(pModule) + (pModule)->modref_table))
159
160 #define NE_MODULE_NAME(pModule) \
161     (((OFSTRUCT *)((char*)(pModule) + (pModule)->fileinfo))->szPathName)
162
163 #define PE_HEADER(module) \
164     ((IMAGE_NT_HEADERS*)((LPBYTE)(module) + \
165                          (((IMAGE_DOS_HEADER*)(module))->e_lfanew)))
166
167 #define PE_SECTIONS(module) \
168     ((IMAGE_SECTION_HEADER*)((LPBYTE)&PE_HEADER(module)->OptionalHeader + \
169                            PE_HEADER(module)->FileHeader.SizeOfOptionalHeader))
170
171 /* module.c */
172 extern WINE_MODREF *MODULE_AllocModRef( HMODULE hModule, LPCSTR filename );
173 extern FARPROC MODULE_GetProcAddress( HMODULE hModule, LPCSTR function, BOOL snoop );
174 extern BOOL MODULE_DllProcessAttach( WINE_MODREF *wm, LPVOID lpReserved );
175 extern void MODULE_DllProcessDetach( BOOL bForceDetach, LPVOID lpReserved );
176 extern void MODULE_DllThreadAttach( LPVOID lpReserved );
177 extern void MODULE_DllThreadDetach( LPVOID lpReserved );
178 extern WINE_MODREF *MODULE_LoadLibraryExA( LPCSTR libname, HFILE hfile, DWORD flags );
179 extern BOOL MODULE_FreeLibrary( WINE_MODREF *wm );
180 extern WINE_MODREF *MODULE_FindModule( LPCSTR path );
181 extern BOOL MODULE_GetBinaryType( HANDLE hfile, LPCSTR filename, LPDWORD lpBinaryType );
182 extern HMODULE MODULE_CreateDummyModule( LPCSTR filename, HMODULE module32 );
183 extern FARPROC16 WINAPI WIN32_GetProcAddress16( HMODULE hmodule, LPCSTR name );
184 extern SEGPTR WINAPI HasGPHandler16( SEGPTR address );
185 extern void MODULE_WalkModref( DWORD id );
186
187 /* loader/ne/module.c */
188 extern NE_MODULE *NE_GetPtr( HMODULE16 hModule );
189 extern void NE_DumpModule( HMODULE16 hModule );
190 extern void NE_WalkModules(void);
191 extern void NE_RegisterModule( NE_MODULE *pModule );
192 extern WORD NE_GetOrdinal( HMODULE16 hModule, const char *name );
193 extern FARPROC16 WINAPI NE_GetEntryPoint( HMODULE16 hModule, WORD ordinal );
194 extern FARPROC16 NE_GetEntryPointEx( HMODULE16 hModule, WORD ordinal, BOOL16 snoop );
195 extern BOOL16 NE_SetEntryPoint( HMODULE16 hModule, WORD ordinal, WORD offset );
196 extern HANDLE NE_OpenFile( NE_MODULE *pModule );
197
198 /* loader/ne/resource.c */
199 extern HGLOBAL16 WINAPI NE_DefResourceHandler(HGLOBAL16,HMODULE16,HRSRC16);
200 extern BOOL NE_InitResourceHandler( HMODULE16 hModule );
201 extern HRSRC16 NE_FindResource( NE_MODULE *pModule, LPCSTR name, LPCSTR type );
202 extern DWORD NE_SizeofResource( NE_MODULE *pModule, HRSRC16 hRsrc );
203 extern HGLOBAL16 NE_LoadResource( NE_MODULE *pModule, HRSRC16 hRsrc );
204 extern BOOL16 NE_FreeResource( NE_MODULE *pModule, HGLOBAL16 handle );
205 extern NE_TYPEINFO *NE_FindTypeSection( LPBYTE pResTab, NE_TYPEINFO *pTypeInfo, LPCSTR typeId );
206 extern NE_NAMEINFO *NE_FindResourceFromType( LPBYTE pResTab, NE_TYPEINFO *pTypeInfo, LPCSTR resId );
207
208 /* loader/ne/segment.c */
209 extern BOOL NE_LoadSegment( NE_MODULE *pModule, WORD segnum );
210 extern BOOL NE_LoadAllSegments( NE_MODULE *pModule );
211 extern BOOL NE_CreateSegment( NE_MODULE *pModule, int segnum );
212 extern BOOL NE_CreateAllSegments( NE_MODULE *pModule );
213 extern HINSTANCE16 NE_GetInstance( NE_MODULE *pModule );
214 extern void NE_InitializeDLLs( HMODULE16 hModule );
215 extern void NE_DllProcessAttach( HMODULE16 hModule );
216
217 /* loader/ne/convert.c */
218 HGLOBAL16 NE_LoadPEResource( NE_MODULE *pModule, WORD type, LPVOID bits, DWORD size );
219
220 /* loader/pe_resource.c */
221 extern HRSRC PE_FindResourceW(HMODULE,LPCWSTR,LPCWSTR);
222 extern HRSRC PE_FindResourceExW(HMODULE,LPCWSTR,LPCWSTR,WORD);
223 extern DWORD PE_SizeofResource(HRSRC);
224 extern HGLOBAL PE_LoadResource(HMODULE,HRSRC);
225 extern PIMAGE_RESOURCE_DIRECTORY GetResDirEntryA(PIMAGE_RESOURCE_DIRECTORY,LPCSTR,DWORD,BOOL);
226 extern PIMAGE_RESOURCE_DIRECTORY GetResDirEntryW(PIMAGE_RESOURCE_DIRECTORY,LPCWSTR,DWORD,BOOL);
227
228 /* loader/pe_image.c */
229 extern WINE_MODREF *PE_LoadLibraryExA(LPCSTR, DWORD);
230 extern HMODULE PE_LoadImage( HANDLE hFile, LPCSTR filename, DWORD flags );
231 extern WINE_MODREF *PE_CreateModule( HMODULE hModule, LPCSTR filename,
232                                      DWORD flags, HFILE hFile, BOOL builtin );
233 extern void PE_InitTls(void);
234 extern BOOL PE_InitDLL( HMODULE module, DWORD type, LPVOID lpReserved );
235
236 /* loader/elf.c */
237 extern WINE_MODREF *ELF_LoadLibraryExA( LPCSTR libname, DWORD flags);
238
239 /* relay32/builtin.c */
240 extern WINE_MODREF *BUILTIN32_LoadLibraryExA(LPCSTR name, DWORD flags);
241 extern HMODULE BUILTIN32_LoadExeModule(void);
242 extern void *BUILTIN32_dlopen( const char *name );
243 extern int BUILTIN32_dlclose( void *handle );
244
245 #endif  /* __WINE_MODULE_H */