2 * typelib.h internal wine data structures
3 * used to decode typelib's
5 * Copyright 1999 Rein KLazes
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef _WINE_TYPELIB_H
22 #define _WINE_TYPELIB_H
29 #include "wine/windef16.h"
31 #define HELPDLLFLAG (0x0100)
32 #define DO_NOT_SEEK (-1)
34 #define MSFT_HREFTYPE_INTHISFILE(href) (!((href) & 3))
35 #define MSFT_HREFTYPE_INDEX(href) ((href) /sizeof(MSFT_TypeInfoBase))
37 /*-------------------------FILE STRUCTURES-----------------------------------*/
39 /* There are two known file formats, those created with ICreateTypeLib
40 * have the signature "SLTG" as their first four bytes, while those created
41 * with ICreateTypeLib2 have "MSFT".
44 /*****************************************************
47 * These are TypeLibs created with ICreateTypeLib2
52 * structure of the typelib type2 header
53 * it is at the beginning of a type lib file
56 typedef struct tagMSFT_Header {
57 /*0x00*/INT magic1; /* 0x5446534D "MSFT" */
58 INT magic2; /* 0x00010002 version nr? */
59 INT posguid; /* position of libid in guid table */
60 /* (should be, else -1) */
61 INT lcid; /* locale id */
63 INT varflags; /* (largely) unknown flags ,seems to be always 41 */
64 /* becomes 0x51 with a helpfile defined */
65 /* if help dll defined it's 0x151 */
66 /* update : the lower nibble is syskind */
67 INT version; /* set with SetVersion() */
68 INT flags; /* set with SetFlags() */
69 /*0x20*/INT nrtypeinfos; /* number of typeinfo's (till so far) */
70 INT helpstring; /* position of help string in stringtable */
71 INT helpstringcontext;
73 /*0x30*/INT nametablecount; /* number of names in name table */
74 INT nametablechars; /* nr of characters in name table */
75 INT NameOffset; /* offset of name in name table */
76 INT helpfile; /* position of helpfile in stringtable */
77 /*0x40*/INT CustomDataOffset; /* if -1 no custom data, else it is offset */
78 /* in customer data/guid offset table */
79 INT res44; /* unknown always: 0x20 */
80 INT res48; /* unknown always: 0x80 */
81 INT dispatchpos; /* gets a value (1+n*0x0c) with Idispatch interfaces */
82 /*0x50*/INT res50; /* is zero becomes one when an interface is derived */
85 /* segments in the type lib file have a structure like this: */
86 typedef struct tagMSFT_pSeg {
87 INT offset; /* absolute offset in file */
88 INT length; /* length of segment */
89 INT res08; /* unknown always -1 */
90 INT res0c; /* unknown always 0x0f in the header */
91 /* 0x03 in the typeinfo_data */
94 /* layout of the main segment directory */
95 typedef struct tagMSFT_SegDir {
96 /*1*/MSFT_pSeg pTypeInfoTab; /* each type info get an entry of 0x64 bytes */
98 /*2*/MSFT_pSeg pImpInfo; /* table with info for imported types */
99 /*3*/MSFT_pSeg pImpFiles; /* import libaries */
100 /*4*/MSFT_pSeg pRefTab; /* References table */
101 /*5*/MSFT_pSeg pLibtab; /* always exists, alway same size (0x80) */
102 /* hash table w offsets to guid????? */
103 /*6*/MSFT_pSeg pGuidTab; /* all guids are stored here together with */
104 /* offset in some table???? */
105 /*7*/MSFT_pSeg res07; /* always created, alway same size (0x200) */
106 /* purpose largely unknown */
107 /*8*/MSFT_pSeg pNametab; /* name tables */
108 /*9*/MSFT_pSeg pStringtab; /* string table */
109 /*A*/MSFT_pSeg pTypdescTab; /* table with type descriptors */
110 /*B*/MSFT_pSeg pArrayDescriptions;
111 /*C*/MSFT_pSeg pCustData; /* data table, used for custom data and default */
112 /* parameter values */
113 /*D*/MSFT_pSeg pCDGuids; /* table with offsets for the guids and into */
114 /* the customer data table */
115 /*E*/MSFT_pSeg res0e; /* unknown */
116 /*F*/MSFT_pSeg res0f; /* unknown */
120 /* base type info data */
121 typedef struct tagMSFT_TypeInfoBase {
122 /*000*/ INT typekind; /* it is the TKIND_xxx */
123 /* some byte alignment stuf */
124 INT memoffset; /* points past the file, if no elements */
125 INT res2; /* zero if no element, N*0x40 */
126 INT res3; /* -1 if no lement, (N-1)*0x38 */
127 /*010*/ INT res4; /* always? 3 */
128 INT res5; /* always? zero */
129 INT cElement; /* counts elements, HI=cVars, LO=cFuncs */
130 INT res7; /* always? zero */
131 /*020*/ INT res8; /* always? zero */
132 INT res9; /* always? zero */
133 INT resA; /* always? zero */
134 INT posguid; /* position in guid table */
135 /*030*/ INT flags; /* Typeflags */
136 INT NameOffset; /* offset in name table */
137 INT version; /* element version */
138 INT docstringoffs; /* offset of docstring in string tab */
139 /*040*/ INT helpstringcontext; /* */
140 INT helpcontext; /* */
141 INT oCustData; /* offset in customer data table */
142 #ifdef WORDS_BIGENDIAN
143 INT16 cbSizeVft; /* virtual table size, not including inherits */
144 INT16 cImplTypes; /* nr of implemented interfaces */
146 INT16 cImplTypes; /* nr of implemented interfaces */
147 INT16 cbSizeVft; /* virtual table size, not including inherits */
149 /*050*/ INT size; /* size in bytes, at least for structures */
150 /* FIXME: name of this field */
151 INT datatype1; /* position in type description table */
152 /* or in base intefaces */
153 /* if coclass: offset in reftable */
154 /* if interface: reference to inherited if */
155 INT datatype2; /* if 0x8000, entry above is valid */
157 /* else it is zero? */
158 INT res18; /* always? 0 */
159 /*060*/ INT res19; /* always? -1 */
162 /* layout of an entry with information on imported types */
163 typedef struct tagMSFT_ImpInfo {
164 INT res0; /* unknown */
165 INT oImpFile; /* offset inthe Import File table */
166 INT oGuid; /* offset in Guid table */
169 /* function description data */
171 /* INT recsize; record size including some xtra stuff */
172 INT DataType; /* data type of the memeber, eg return of function */
173 INT Flags; /* something to do with attribute flags (LOWORD) */
174 #ifdef WORDS_BIGENDIAN
175 INT16 res3; /* some offset into dunno what */
176 INT16 VtableOffset; /* offset in vtable */
178 INT16 VtableOffset; /* offset in vtable */
179 INT16 res3; /* some offset into dunno what */
181 INT FKCCIC; /* bit string with the following */
182 /* meaning (bit 0 is the msb): */
183 /* bit 2 indicates that oEntry is numeric */
184 /* bit 3 that parameter has default values */
185 /* calling convention (bits 4-7 ) */
186 /* bit 8 indicates that custom data is present */
187 /* Invokation kind (bits 9-12 ) */
188 /* function kind (eg virtual), bits 13-15 */
189 #ifdef WORDS_BIGENDIAN
190 INT16 nroargs; /* nr of optional arguments */
191 INT16 nrargs; /* number of arguments (including optional ????) */
193 INT16 nrargs; /* number of arguments (including optional ????) */
194 INT16 nroargs; /* nr of optional arguments */
196 /* optional attribute fields, the number of them is variable */
201 2* INT oEntry; // either offset in string table or numeric as it is //
202 3* INT res9; // unknown (-1) //
203 4* INT resA; // unknown (-1) //
204 5* INT HelpStringContext;
205 // these are controlled by a bit set in the FKCCIC field //
206 6* INT oCustData; // custom data for function //
207 7* INT oArgCustData[1]; // custom data per argument //
211 /* after this may follow an array with default value pointers if the
212 * appropriate bit in the FKCCIC field has been set:
213 * INT oDefautlValue[nrargs];
216 /* Parameter info one per argument*/
221 } MSFT_ParameterInfo;
223 /* Variable description data */
225 /* INT recsize; // record size including some xtra stuff */
226 INT DataType; /* data type of the variable */
227 INT Flags; /* VarFlags (LOWORD) */
228 #ifdef WORDS_BIGENDIAN
229 INT16 res3; /* some offset into dunno what */
230 INT16 VarKind; /* VarKind */
232 INT16 VarKind; /* VarKind */
233 INT16 res3; /* some offset into dunno what */
235 INT OffsValue; /* value of the variable or the offset */
236 /* in the data structure */
237 /* optional attribute fields, the number of them is variable */
238 /* controlled by record length */
241 INT res9; /* unknown (-1) */
242 INT oCustData; /* custom data for variable */
243 INT HelpStringContext;
247 /* Structure of the reference data */
249 INT reftype; /* either offset in type info table, then it's */
250 /* a multiple of 64 */
251 /* or offset in the external reference table */
252 /* with an offset of 1 */
254 INT oCustData; /* custom data */
255 INT onext; /* next offset, -1 if last */
258 /* this is how a guid is stored */
261 INT unk10; /* differntiate with libid, classid etc? */
262 /* it's -2 for a libary */
263 /* it's 0 for an interface */
264 INT unk14; /* always? -1 */
266 /* some data preceding entries in the name table */
268 INT unk00; /* sometimes -1 (lib, parameter) ,
269 sometimes 0 (interface, func) */
270 INT unk10; /* sometimes -1 (lib) , sometimes 0 (interface, func),
271 sometimes 0x10 (par) */
272 INT namelen; /* only lower 8 bits are valid */
274 /* the custom data table directory has enties like this */
278 INT next; /* next offset in the table, -1 if it's the last */
282 /***********************************************************
286 * These are created with ICreateTypeLib
290 #include "pshpack1.h"
293 /*00*/ DWORD SLTG_magic; /* 0x47544c53 == "SLTG" */
294 /*04*/ WORD nrOfFileBlks; /* no of SLTG_BlkEntry's + 1 */
295 /*06*/ WORD res06; /* ?? always 9 */
296 /*08*/ WORD res08; /* some kind of len/offset ?? */
297 /*0a*/ WORD first_blk; /* 1 based index into blk entries that
298 corresponds to first block in file */
299 /*0c*/ DWORD res0c; /* always 0x000204ff */
300 /*10*/ DWORD res10; /* always 0x00000000 */
301 /*14*/ DWORD res14; /* always 0x000000c0 */
302 /*18*/ DWORD res18; /* always 0x46000000 */
303 /*1c*/ DWORD res1c; /* always 0x00000044 */
304 /*20*/ DWORD res20; /* always 0xffff0000 */
307 /* This gets followed by a list of block entries */
310 /*04*/ WORD index_string; /* offs from start of SLTG_Magic to index string */
314 /* The order of the blocks in the file is given by starting at Block
315 entry firt_blk and stepping through using the next pointer */
317 /* These then get followed by this magic */
319 /*00*/ BYTE res00; /* always 0x01 */
320 /*01*/ CHAR CompObj_magic[8]; /* always "CompObj" */
321 /*09*/ CHAR dir_magic[4]; /* always "dir" */
324 #define SLTG_COMPOBJ_MAGIC "CompObj"
325 #define SLTG_DIR_MAGIC "dir"
327 /* Next we have SLTG_Header.nrOfFileBlks - 2 of Index strings. These
328 are presumably unique to within the file and look something like
329 "AAAAAAAAAA" with the first character incremented from 'A' to ensure
330 uniqueness. I guess successive chars increment when we need to wrap
334 /*00*/ CHAR string[11];
338 /* This is followed by SLTG_pad9 */
340 /*00*/ CHAR pad[9]; /* 9 '\0's */
344 /* Now we have the noOfFileBlks - 1 worth of blocks. The length of
345 each block is given by its entry in SLTG_BlkEntry. */
347 /* type SLTG_NAME in rather like a BSTR except that the length in
348 bytes is given by the first WORD and the string contains 8bit chars */
350 typedef WORD SLTG_Name;
352 /* The main library block looks like this. This one seems to come last */
355 /*00*/ WORD magic; /* 0x51cc */
356 /*02*/ WORD res02; /* 0x0003, 0x0004 */
357 /*04*/ WORD name; /* offset to name in name table */
358 /*06*/ SLTG_Name res06; /* maybe this is just WORD == 0xffff */
359 SLTG_Name helpstring;
362 WORD syskind; /* == 1 for win32, 0 for win16 */
363 WORD lcid; /* == 0x409, 0x809 etc */
364 DWORD res12; /* == 0 */
365 WORD libflags; /* LIBFLAG_* */
371 #define SLTG_LIBBLK_MAGIC 0x51cc
373 /* we then get 0x40 bytes worth of 0xffff or small numbers followed by
374 nrOfFileBlks - 2 of these */
377 SLTG_Name index_name; /* This refers to a name in the directory */
378 SLTG_Name other_name; /* Another one of these weird names */
379 WORD res1a; /* 0xffff */
380 WORD name_offs; /* offset to name in name table */
381 WORD more_bytes; /* if this is non-zero we get this many
382 bytes before the next element, which seem
383 to reference the docstring of the type ? */
384 WORD res20; /* 0xffff */
386 WORD res26; /* 0xffff */
388 } SLTG_OtherTypeInfo;
390 /* Next we get WORD 0x0003 followed by a DWORD which if we add to
391 0x216 gives the offset to the name table from the start of the LibBlk
395 /*00*/ WORD magic; /* 0x0501 */
396 /*02*/ DWORD href_table; /* if not 0xffffffff, then byte offset from
397 beginning of struct to href table */
398 /*06*/ DWORD res06; /* 0xffffffff */
399 /*0a*/ DWORD elem_table; /* offset to members */
400 /*0e*/ DWORD res0e; /* 0xffffffff */
401 /*12*/ WORD major_version; /* major version number */
402 /*14*/ WORD minor_version; /* minor version number */
403 /*16*/ DWORD res16; /* 0xfffe0000 */
404 /*1a*/ BYTE typeflags1;/* 0x02 | top 5 bits hold l5sbs of TYPEFLAGS */
405 /*1b*/ BYTE typeflags2;/* TYPEFLAGS >> 5 */
406 /*1c*/ BYTE typeflags3;/* 0x02*/
407 /*1d*/ BYTE typekind; /* 0x03 == TKIND_INTERFACE etc. */
408 /*1e*/ DWORD res1e; /* 0x00000000 or 0xffffffff */
409 } SLTG_TypeInfoHeader;
411 #define SLTG_TIHEADER_MAGIC 0x0501
416 /*04*/ WORD cImplTypes;
424 /*14*/ WORD tdescalias_vt; /* for TKIND_ALIAS */
430 /*20*/ WORD cbSizeInstance;
431 /*22*/ WORD cbAlignment;
434 /*28*/ WORD cbSizeVft;
444 /*00*/ WORD res00; /* 0x0001 sometimes 0x0003 ?? */
445 /*02*/ WORD res02; /* 0xffff */
446 /*04*/ BYTE res04; /* 0x01 */
447 /*05*/ DWORD cbExtra; /* No of bytes that follow */
451 /*00*/ WORD magic; /* 0x120a */
452 /*02*/ WORD next; /* offset in bytes to next block from start of block
453 group, 0xffff if last item */
454 /*04*/ WORD name; /* offset to name within name table */
455 /*06*/ WORD value; /* offset to value from start of block group */
456 /*08*/ WORD res08; /* 0x56 */
457 /*0a*/ DWORD memid; /* memid */
458 /*0e*/ WORD helpcontext;/* 0xfffe == no context, 0x0001 == stored in EnumInfo struct, else offset
459 to value from start of block group */
460 /*10*/ WORD helpstring;/* offset from start of block group to string offset */
463 #define SLTG_ENUMITEM_MAGIC 0x120a
466 /*00*/ WORD vt; /* vartype, 0xffff marks end. */
467 /*02*/ WORD res02; /* ?, 0xffff marks end */
470 #define SLTG_ALIASITEM_MAGIC 0x001d
474 BYTE magic; /* 0x4c or 0x6c */
475 BYTE inv; /* high nibble is INVOKE_KIND, low nibble = 2 */
476 WORD next; /* byte offset from beginning of group to next fn */
477 WORD name; /* Offset within name table to name */
478 DWORD dispid; /* dispid */
479 WORD helpcontext; /* helpcontext (again 1 is special) */
480 WORD helpstring;/* helpstring offset to offset */
481 WORD arg_off; /* offset to args from start of block */
482 BYTE nacc; /* lowest 3bits are CALLCONV, rest are no of args */
483 BYTE retnextopt;/* if 0x80 bit set ret type follows else next WORD
484 is offset to ret type. No of optional args is
486 WORD rettype; /* return type VT_?? or offset to ret type */
487 WORD vtblpos; /* position in vtbl? */
488 WORD funcflags; /* present if magic == 0x6c */
489 /* Param list starts, repeat next two as required */
491 WORD name; /* offset to 2nd letter of name */
492 WORD+ type; /* VT_ of param */
496 #define SLTG_FUNCTION_MAGIC 0x4c
497 #define SLTG_FUNCTION_WITH_FLAGS_MAGIC 0x6c
500 /*00*/ BYTE magic; /* 0xdf */
501 /*01*/ BYTE res01; /* 0x00 */
502 /*02*/ DWORD res02; /* 0xffffffff */
503 /*06*/ DWORD res06; /* 0xffffffff */
504 /*0a*/ DWORD res0a; /* 0xffffffff */
505 /*0e*/ DWORD res0e; /* 0xffffffff */
506 /*12*/ DWORD res12; /* 0xffffffff */
507 /*16*/ DWORD res16; /* 0xffffffff */
508 /*1a*/ DWORD res1a; /* 0xffffffff */
509 /*1e*/ DWORD res1e; /* 0xffffffff */
510 /*22*/ DWORD res22; /* 0xffffffff */
511 /*26*/ DWORD res26; /* 0xffffffff */
512 /*2a*/ DWORD res2a; /* 0xffffffff */
513 /*2e*/ DWORD res2e; /* 0xffffffff */
514 /*32*/ DWORD res32; /* 0xffffffff */
515 /*36*/ DWORD res36; /* 0xffffffff */
516 /*3a*/ DWORD res3a; /* 0xffffffff */
517 /*3e*/ DWORD res3e; /* 0xffffffff */
518 /*42*/ WORD res42; /* 0xffff */
519 /*44*/ DWORD number; /* this is 8 times the number of refs */
520 /*48*/ /* Now we have number bytes (8 for each ref) of SLTG_UnknownRefInfo */
522 /*50*/ WORD res50; /* 0xffff */
523 /*52*/ BYTE res52; /* 0x01 */
524 /*53*/ DWORD res53; /* 0x00000000 */
525 /*57*/ SLTG_Name names[1];
526 /* Now we have number/8 SLTG_Names (first WORD is no of bytes in the ascii
527 * string). Strings look like "*\Rxxxx*#n". If xxxx == ffff then the
528 * ref refers to the nth type listed in this library (0 based). Else
529 * the xxxx (which maybe fewer than 4 digits) is the offset into the name
530 * table to a string "*\G{<guid>}#1.0#0#C:\WINNT\System32\stdole32.tlb#"
531 * The guid is the typelib guid; the ref again refers to the nth type of
532 * the imported typelib.
535 /*xx*/ BYTE resxx; /* 0xdf */
539 #define SLTG_REF_MAGIC 0xdf
542 WORD res00; /* 0x0001 */
543 BYTE res02; /* 0x02 */
544 BYTE res03; /* 0x40 if internal ref, 0x00 if external ? */
545 WORD res04; /* 0xffff */
546 WORD res06; /* 0x0000, 0x0013 or 0xffff ?? */
547 } SLTG_UnknownRefInfo;
550 WORD res00; /* 0x004a */
551 WORD next; /* byte offs to next interface */
552 WORD res04; /* 0xffff */
553 BYTE impltypeflags; /* IMPLTYPEFLAG_* */
554 BYTE res07; /* 0x80 */
555 WORD res08; /* 0x0012, 0x0028 ?? */
556 WORD ref; /* number in ref table ? */
557 WORD res0c; /* 0x4000 */
558 WORD res0e; /* 0xfffe */
559 WORD res10; /* 0xffff */
560 WORD res12; /* 0x001d */
561 WORD pos_in_table; /* 0x0, 0x4, ? */
564 #define SLTG_IMPL_MAGIC 0x004a
567 BYTE magic; /* 0x0a */
571 WORD byte_offs; /* pos in struct */
572 WORD type; /* if typepos == 0x02 this is the type, else offset to type */
574 WORD helpcontext; /* ?? */
575 WORD helpstring; /* ?? */
578 #define SLTG_RECORD_MAGIC 0x0a
581 /* CARRAYs look like this
582 WORD type == VT_CARRAY
583 WORD offset from start of block to SAFEARRAY
587 extern DWORD _invoke(FARPROC func,CALLCONV callconv, int nrargs, DWORD *args);
588 extern void dump_Variant(VARIANT * pvar);
591 /*---------------------------END--------------------------------------------*/