- many new Path* stubs
[wine] / include / toolhelp.h
1 #ifndef __WINE_TOOLHELP_H
2 #define __WINE_TOOLHELP_H
3
4 #include "windef.h"
5
6 #define MAX_DATA        11
7 #define MAX_MODULE_NAME 9
8 #define MAX_PATH16      255
9 #define MAX_CLASSNAME   255
10
11 #include "pshpack1.h"
12
13 /* Global heap */
14
15 typedef struct
16 {
17     DWORD dwSize;
18     WORD  wcItems;
19     WORD  wcItemsFree;
20     WORD  wcItemsLRU;
21 } GLOBALINFO;
22
23 typedef struct
24 {
25     DWORD     dwSize;
26     DWORD     dwAddress;
27     DWORD     dwBlockSize;
28     HGLOBAL16 hBlock;
29     WORD      wcLock;
30     WORD      wcPageLock;
31     WORD      wFlags;
32     BOOL16    wHeapPresent;
33     HGLOBAL16 hOwner;
34     WORD      wType;
35     WORD      wData;
36     DWORD     dwNext;
37     DWORD     dwNextAlt;
38 } GLOBALENTRY;
39
40   /* GlobalFirst()/GlobalNext() flags */
41 #define GLOBAL_ALL      0
42 #define GLOBAL_LRU      1
43 #define GLOBAL_FREE     2
44
45   /* wType values */
46 #define GT_UNKNOWN      0
47 #define GT_DGROUP       1
48 #define GT_DATA         2
49 #define GT_CODE         3
50 #define GT_TASK         4
51 #define GT_RESOURCE     5
52 #define GT_MODULE       6
53 #define GT_FREE         7
54 #define GT_INTERNAL     8
55 #define GT_SENTINEL     9
56 #define GT_BURGERMASTER 10
57
58 /* wData values */
59 #define GD_USERDEFINED      0
60 #define GD_CURSORCOMPONENT  1
61 #define GD_BITMAP           2
62 #define GD_ICONCOMPONENT    3
63 #define GD_MENU             4
64 #define GD_DIALOG           5
65 #define GD_STRING           6
66 #define GD_FONTDIR          7
67 #define GD_FONT             8
68 #define GD_ACCELERATORS     9
69 #define GD_RCDATA           10
70 #define GD_ERRTABLE         11
71 #define GD_CURSOR           12
72 #define GD_ICON             14
73 #define GD_NAMETABLE        15
74 #define GD_MAX_RESOURCE     15
75
76 /* wFlags values */
77 #define GF_PDB_OWNER        0x0100      /* Low byte is KERNEL flags */
78
79 WORD   WINAPI GlobalHandleToSel16( HGLOBAL16 handle );
80 BOOL16 WINAPI GlobalInfo16( GLOBALINFO *pInfo );
81 BOOL16 WINAPI GlobalFirst16( GLOBALENTRY *pGlobal, WORD wFlags );
82 BOOL16 WINAPI GlobalNext16( GLOBALENTRY *pGlobal, WORD wFlags) ;
83 BOOL16 WINAPI GlobalEntryHandle16( GLOBALENTRY *pGlobal, HGLOBAL16 hItem );
84 BOOL16 WINAPI GlobalEntryModule16( GLOBALENTRY *pGlobal, HMODULE16 hModule,
85                                  WORD wSeg );
86
87 /* Local heap */
88
89 typedef struct
90 {
91     DWORD   dwSize;
92     WORD    wcItems;
93 } LOCALINFO;
94
95 typedef struct
96 {
97     DWORD   dwSize;
98     HLOCAL16  hHandle;
99     WORD    wAddress;
100     WORD    wSize;
101     WORD    wFlags;
102     WORD    wcLock;
103     WORD    wType;
104     WORD    hHeap;
105     WORD    wHeapType;
106     WORD    wNext;
107 } LOCALENTRY;
108
109 /* wHeapType values */
110 #define NORMAL_HEAP     0
111 #define USER_HEAP       1
112 #define GDI_HEAP        2
113
114 /* wFlags values */
115 #define LF_FIXED        1
116 #define LF_FREE         2
117 #define LF_MOVEABLE     4
118
119 /* wType values */
120 #define LT_NORMAL                   0
121 #define LT_FREE                     0xff
122 #define LT_GDI_PEN                  1   /* LT_GDI_* is for GDI's heap */
123 #define LT_GDI_BRUSH                2
124 #define LT_GDI_FONT                 3
125 #define LT_GDI_PALETTE              4
126 #define LT_GDI_BITMAP               5
127 #define LT_GDI_RGN                  6
128 #define LT_GDI_DC                   7
129 #define LT_GDI_DISABLED_DC          8
130 #define LT_GDI_METADC               9
131 #define LT_GDI_METAFILE             10
132 #define LT_GDI_MAX                  LT_GDI_METAFILE
133 #define LT_USER_CLASS               1   /* LT_USER_* is for USER's heap */
134 #define LT_USER_WND                 2
135 #define LT_USER_STRING              3
136 #define LT_USER_MENU                4
137 #define LT_USER_CLIP                5
138 #define LT_USER_CBOX                6
139 #define LT_USER_PALETTE             7
140 #define LT_USER_ED                  8
141 #define LT_USER_BWL                 9
142 #define LT_USER_OWNERDRAW           10
143 #define LT_USER_SPB                 11
144 #define LT_USER_CHECKPOINT          12
145 #define LT_USER_DCE                 13
146 #define LT_USER_MWP                 14
147 #define LT_USER_PROP                15
148 #define LT_USER_LBIV                16
149 #define LT_USER_MISC                17
150 #define LT_USER_ATOMS               18
151 #define LT_USER_LOCKINPUTSTATE      19
152 #define LT_USER_HOOKLIST            20
153 #define LT_USER_USERSEEUSERDOALLOC  21
154 #define LT_USER_HOTKEYLIST          22
155 #define LT_USER_POPUPMENU           23
156 #define LT_USER_HANDLETABLE         32
157 #define LT_USER_MAX                 LT_USER_HANDLETABLE
158
159 BOOL16 WINAPI LocalInfo16( LOCALINFO *pLocalInfo, HGLOBAL16 handle );
160 BOOL16 WINAPI LocalFirst16( LOCALENTRY *pLocalEntry, HGLOBAL16 handle );
161 BOOL16 WINAPI LocalNext16( LOCALENTRY *pLocalEntry );
162
163 /* Local 32-bit heap */
164
165 typedef struct
166 {
167     DWORD dwSize;                /* 00 */
168     DWORD dwMemReserved;         /* 04 */
169     DWORD dwMemCommitted;        /* 08 */
170     DWORD dwTotalFree;           /* 0C */
171     DWORD dwLargestFreeBlock;    /* 10 */
172     DWORD dwcFreeHandles;        /* 14 */
173 } LOCAL32INFO;
174
175 typedef struct
176 {
177     DWORD dwSize;                /* 00 */
178     WORD hHandle;                /* 04 */
179     DWORD dwAddress;             /* 06 */
180     DWORD dwSizeBlock;           /* 0A */
181     WORD wFlags;                 /* 0E */
182     WORD wType;                  /* 10 */
183     WORD hHeap;                  /* 12 */
184     WORD wHeapType;              /* 14 */
185     DWORD dwNext;                /* 16 */
186     DWORD dwNextAlt;             /* 1A */
187 } LOCAL32ENTRY;
188
189 /* LOCAL32ENTRY.wHeapType flags same as LOCALENTRY.wHeapType flags */
190 /* LOCAL32ENTRY.wFlags same as LOCALENTRY.wFlags */
191 /* LOCAL32ENTRY.wType same as LOCALENTRY.wType */
192
193 BOOL16 WINAPI Local32Info16( LOCAL32INFO *pLocal32Info, HGLOBAL16 handle );
194 BOOL16 WINAPI Local32First16( LOCAL32ENTRY *pLocal32Entry, HGLOBAL16 handle );
195 BOOL16 WINAPI Local32Next16( LOCAL32ENTRY *pLocal32Entry );
196
197
198 /* modules */
199
200 typedef struct
201 {
202     DWORD      dwSize;
203     char       szModule[MAX_MODULE_NAME + 1];
204     HMODULE16  hModule;
205     WORD       wcUsage;
206     char       szExePath[MAX_PATH16 + 1];
207     HANDLE16   wNext;
208 } MODULEENTRY, *LPMODULEENTRY;
209
210 BOOL16 WINAPI ModuleFirst16(MODULEENTRY *lpModule);
211 BOOL16 WINAPI ModuleNext16(MODULEENTRY *lpModule);
212 BOOL16 WINAPI ModuleFindName16(MODULEENTRY *lpModule, LPCSTR lpstrName);
213 BOOL16 WINAPI ModuleFindHandle16(MODULEENTRY *lpModule, HMODULE16 hModule);
214
215 /* tasks */
216
217 typedef struct
218 {
219     DWORD        dwSize;
220     HTASK16      hTask;
221     HTASK16      hTaskParent;
222     HINSTANCE16  hInst;
223     HMODULE16    hModule;
224     WORD         wSS;
225     WORD         wSP;
226     WORD         wStackTop;
227     WORD         wStackMinimum;
228     WORD         wStackBottom;
229     WORD         wcEvents;
230     HGLOBAL16    hQueue;
231     char         szModule[MAX_MODULE_NAME + 1];
232     WORD         wPSPOffset;
233     HANDLE16     hNext;
234 } TASKENTRY, *LPTASKENTRY;
235
236 BOOL16 WINAPI TaskFirst16(LPTASKENTRY lpTask);
237 BOOL16 WINAPI TaskNext16(LPTASKENTRY lpTask);
238 BOOL16 WINAPI TaskFindHandle16(LPTASKENTRY lpTask, HTASK16 hTask);
239 DWORD  WINAPI TaskSetCSIP(HTASK16 hTask, WORD wCS, WORD wIP);
240 DWORD  WINAPI TaskGetCSIP(HTASK16 hTask);
241 BOOL16 WINAPI TaskSwitch(HTASK16 hTask, DWORD dwNewCSIP);
242
243 /* mem info */
244
245 typedef struct tagMEMMANINFO {
246         DWORD dwSize;
247         DWORD dwLargestFreeBlock;
248         DWORD dwMaxPagesAvailable;
249         DWORD dwMaxPagesLockable;
250         DWORD dwTotalLinearSpace;
251         DWORD dwTotalUnlockedPages;
252         DWORD dwFreePages;
253         DWORD dwTotalPages;
254         DWORD dwFreeLinearSpace;
255         DWORD dwSwapFilePages;
256         WORD wPageSize;
257 } MEMMANINFO;
258 typedef MEMMANINFO *LPMEMMANINFO;
259
260 typedef struct
261 {
262     DWORD     dwSize;
263     WORD      wUserFreePercent;
264     WORD      wGDIFreePercent;
265     HGLOBAL16 hUserSegment;
266     HGLOBAL16 hGDISegment;
267 } SYSHEAPINFO;
268
269 BOOL16 WINAPI MemManInfo16(LPMEMMANINFO lpEnhMode);
270 BOOL16 WINAPI SystemHeapInfo16( SYSHEAPINFO *pHeapInfo );
271
272 /* timer info */
273
274 typedef struct tagTIMERINFO {
275         DWORD dwSize;
276         DWORD dwmsSinceStart;
277         DWORD dwmsThisVM;
278 } TIMERINFO;
279
280 BOOL16 WINAPI TimerCount16( TIMERINFO *pTimerInfo );
281
282 /* Window classes */
283
284 typedef struct
285 {
286     DWORD     dwSize;
287     HMODULE16 hInst;              /* This is really an hModule */
288     char      szClassName[MAX_CLASSNAME + 1];
289     HANDLE16  wNext;
290 } CLASSENTRY;
291
292 BOOL16 WINAPI ClassFirst16( CLASSENTRY *pClassEntry );
293 BOOL16 WINAPI ClassNext16( CLASSENTRY *pClassEntry );
294
295
296 /* Memory read/write */
297
298 DWORD WINAPI MemoryRead16( WORD sel, DWORD offset, void *buffer, DWORD count );
299 DWORD WINAPI MemoryWrite16( WORD sel, DWORD offset, void *buffer, DWORD count );
300
301 /* flags to NotifyRegister() */
302 #define NF_NORMAL       0       /* everything except taskswitches, debugerrors,
303                                  * debugstrings
304                                  */
305 #define NF_TASKSWITCH   1       /* get taskswitch information */
306 #define NF_RIP          2       /* get debugerrors of system */
307
308 BOOL16 WINAPI NotifyRegister16(HTASK16 htask,FARPROC16 lpfnCallback,WORD wFlags);
309
310 #define NFY_UNKNOWN     0
311 #define NFY_LOADSEG     1
312 /* DATA is a pointer to following struct: */
313 typedef struct {
314         DWORD   dwSize;
315         WORD    wSelector;
316         WORD    wSegNum;
317         WORD    wType;          /* bit 0 set if this is a code segment */
318         WORD    wcInstance;     /* only valid for data segment */
319 } NFYLOADSEG;
320 /* called when freeing a segment. LOWORD(dwData) is the freed selector */
321 #define NFY_FREESEG     2
322
323 /* called when loading/starting a DLL */
324 #define NFY_STARTDLL    3
325 typedef struct {
326     DWORD      dwSize;
327     HMODULE16  hModule;
328     WORD       wCS;
329     WORD       wIP;
330 } NFYSTARTDLL;
331
332 /* called when starting a task. dwData is CS:IP */
333 #define NFY_STARTTASK   4
334
335 /* called when a task terminates. dwData is the return code */
336 #define NFY_EXITTASK    5
337
338 /* called when module is removed. LOWORD(dwData) is the handle */
339 #define NFY_DELMODULE   6
340
341 /* RIP? debugevent */
342 #define NFY_RIP         7
343 typedef struct {
344         DWORD   dwSize;
345         WORD    wIP;
346         WORD    wCS;
347         WORD    wSS;
348         WORD    wBP;
349         WORD    wExitCode;
350 } NFYRIP;
351
352 /* called before (after?) switching to a task
353  * no data, callback should call GetCurrentTask
354  */
355 #define NFY_TASKIN      8
356
357 /* called before(after?) switching from a task
358  * no data, callback should call GetCurrentTask
359 */
360 #define NFY_TASKOUT     9
361
362 /* returns ASCII input value, dwData not set */
363 #define NFY_INCHAR      10
364
365 /* output debugstring (pointed to by dwData) */
366 #define NFY_OUTSTRING   11
367
368 /* log errors */
369 #define NFY_LOGERROR    12
370 typedef struct {
371         DWORD   dwSize;
372         UINT16  wErrCode;
373         VOID   *lpInfo; /* depends on wErrCode */
374 } NFYLOGERROR;
375
376 /* called for parameter errors? */
377 #define NFY_LOGPARAMERROR       13
378 typedef struct {
379     DWORD       dwSize;
380     UINT16      wErrCode;
381     FARPROC16   lpfnErrorAddr;
382     void      **lpBadParam;
383 } NFYLOGPARAMERROR;
384
385 typedef struct {
386     DWORD dwSize;
387     HTASK16 hTask;
388     WORD wSS;
389     WORD wBP;
390     WORD wCS;
391     WORD wIP;
392     HMODULE16 hModule;
393     WORD wSegment;
394     WORD wFlags;
395 } STACKTRACEENTRY;
396
397 #include "poppack.h"
398
399 #endif /* __WINE_TOOLHELP_H */