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 (guid hash size?) */
80 INT res48
; /* unknown always: 0x80 (name hash size?) */
81 INT dispatchpos
; /* HREFTYPE to IDispatch, or -1 if no IDispatch */
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 flags
; /* bits 0 - 15: count */
165 /* bit 16: if set oGuid is an offset to Guid */
166 /* if clear oGuid is a typeinfo index in the specified typelib */
167 /* bits 24 - 31: TKIND of reference */
168 INT oImpFile
; /* offset in the Import File table */
169 INT oGuid
; /* offset in Guid table or typeinfo index (see bit 16 of res0) */
172 #define MSFT_IMPINFO_OFFSET_IS_GUID 0x00010000
174 /* function description data */
176 /* INT recsize; record size including some xtra stuff */
177 INT DataType
; /* data type of the member, eg return of function */
178 INT Flags
; /* something to do with attribute flags (LOWORD) */
179 #ifdef WORDS_BIGENDIAN
180 INT16 funcdescsize
; /* size of reconstituted FUNCDESC and related structs */
181 INT16 VtableOffset
; /* offset in vtable */
183 INT16 VtableOffset
; /* offset in vtable */
184 INT16 funcdescsize
; /* size of reconstituted FUNCDESC and related structs */
186 INT FKCCIC
; /* bit string with the following */
187 /* meaning (bit 0 is the msb): */
188 /* bit 2 indicates that oEntry is numeric */
189 /* bit 3 that parameter has default values */
190 /* calling convention (bits 4-7 ) */
191 /* bit 8 indicates that custom data is present */
192 /* Invocation kind (bits 9-12 ) */
193 /* function kind (eg virtual), bits 13-15 */
194 #ifdef WORDS_BIGENDIAN
195 INT16 nroargs
; /* nr of optional arguments */
196 INT16 nrargs
; /* number of arguments (including optional ????) */
198 INT16 nrargs
; /* number of arguments (including optional ????) */
199 INT16 nroargs
; /* nr of optional arguments */
201 /* optional attribute fields, the number of them is variable */
206 2* INT oEntry; // either offset in string table or numeric as it is //
207 3* INT res9; // unknown (-1) //
208 4* INT resA; // unknown (-1) //
209 5* INT HelpStringContext;
210 // these are controlled by a bit set in the FKCCIC field //
211 6* INT oCustData; // custom data for function //
212 7* INT oArgCustData[1]; // custom data per argument //
216 /* after this may follow an array with default value pointers if the
217 * appropriate bit in the FKCCIC field has been set:
218 * INT oDefautlValue[nrargs];
221 /* Parameter info one per argument*/
226 } MSFT_ParameterInfo
;
228 /* Variable description data */
230 /* INT recsize; // record size including some xtra stuff */
231 INT DataType
; /* data type of the variable */
232 INT Flags
; /* VarFlags (LOWORD) */
233 #ifdef WORDS_BIGENDIAN
234 INT16 vardescsize
; /* size of reconstituted VARDESC and related structs */
235 INT16 VarKind
; /* VarKind */
237 INT16 VarKind
; /* VarKind */
238 INT16 vardescsize
; /* size of reconstituted VARDESC and related structs */
240 INT OffsValue
; /* value of the variable or the offset */
241 /* in the data structure */
242 /* optional attribute fields, the number of them is variable */
243 /* controlled by record length */
246 INT res9
; /* unknown (-1) */
247 INT oCustData
; /* custom data for variable */
248 INT HelpStringContext
;
252 /* Structure of the reference data */
254 INT reftype
; /* either offset in type info table, then it's */
255 /* a multiple of 64 */
256 /* or offset in the external reference table */
257 /* with an offset of 1 */
259 INT oCustData
; /* custom data */
260 INT onext
; /* next offset, -1 if last */
263 /* this is how a guid is stored */
266 INT hreftype
; /* -2 for the typelib guid, typeinfo offset
267 for typeinfo guid, low two bits are 01 if
268 this is an imported typeinfo, low two bits
269 are 10 if this is an imported typelib (used
270 by imported typeinfos) */
271 INT next_hash
; /* offset to next guid in the hash bucket */
273 /* some data preceding entries in the name table */
275 INT hreftype
; /* is -1 if name is for neither a typeinfo,
276 a variable, or a function (that is, name
277 is for a typelib or a function parameter).
278 otherwise is the offset of the first
279 typeinfo that this name refers to (either
280 to the typeinfo itself or to a member of
282 INT next_hash
; /* offset to next name in the hash bucket */
283 INT namelen
; /* only lower 8 bits are valid,
284 lower-middle 8 bits are unknown (flags?),
285 upper 16 bits are hash code */
287 /* the custom data table directory has enties like this */
291 INT next
; /* next offset in the table, -1 if it's the last */
295 /***********************************************************
299 * These are created with ICreateTypeLib
303 #include "pshpack1.h"
306 /*00*/ DWORD SLTG_magic
; /* 0x47544c53 == "SLTG" */
307 /*04*/ WORD nrOfFileBlks
; /* no of SLTG_BlkEntry's + 1 */
308 /*06*/ WORD res06
; /* ?? always 9 */
309 /*08*/ WORD res08
; /* some kind of len/offset ?? */
310 /*0a*/ WORD first_blk
; /* 1 based index into blk entries that
311 corresponds to first block in file */
312 /*0c*/ DWORD res0c
; /* always 0x000204ff */
313 /*10*/ DWORD res10
; /* always 0x00000000 */
314 /*14*/ DWORD res14
; /* always 0x000000c0 */
315 /*18*/ DWORD res18
; /* always 0x46000000 */
316 /*1c*/ DWORD res1c
; /* always 0x00000044 */
317 /*20*/ DWORD res20
; /* always 0xffff0000 */
320 /* This gets followed by a list of block entries */
323 /*04*/ WORD index_string
; /* offs from start of SLTG_Magic to index string */
327 /* The order of the blocks in the file is given by starting at Block
328 entry firt_blk and stepping through using the next pointer */
330 /* These then get followed by this magic */
332 /*00*/ BYTE res00
; /* always 0x01 */
333 /*01*/ CHAR CompObj_magic
[8]; /* always "CompObj" */
334 /*09*/ CHAR dir_magic
[4]; /* always "dir" */
337 #define SLTG_COMPOBJ_MAGIC "CompObj"
338 #define SLTG_DIR_MAGIC "dir"
340 /* Next we have SLTG_Header.nrOfFileBlks - 2 of Index strings. These
341 are presumably unique to within the file and look something like
342 "AAAAAAAAAA" with the first character incremented from 'A' to ensure
343 uniqueness. I guess successive chars increment when we need to wrap
347 /*00*/ CHAR string
[11];
351 /* This is followed by SLTG_pad9 */
353 /*00*/ CHAR pad
[9]; /* 9 '\0's */
357 /* Now we have the noOfFileBlks - 1 worth of blocks. The length of
358 each block is given by its entry in SLTG_BlkEntry. */
360 /* type SLTG_NAME in rather like a BSTR except that the length in
361 bytes is given by the first WORD and the string contains 8bit chars */
363 typedef WORD SLTG_Name
;
365 /* The main library block looks like this. This one seems to come last */
368 /*00*/ WORD magic
; /* 0x51cc */
369 /*02*/ WORD res02
; /* 0x0003, 0x0004 */
370 /*04*/ WORD name
; /* offset to name in name table */
371 /*06*/ SLTG_Name res06
; /* maybe this is just WORD == 0xffff */
372 SLTG_Name helpstring
;
375 WORD syskind
; /* == 1 for win32, 0 for win16 */
376 WORD lcid
; /* == 0x409, 0x809 etc */
377 DWORD res12
; /* == 0 */
378 WORD libflags
; /* LIBFLAG_* */
384 #define SLTG_LIBBLK_MAGIC 0x51cc
386 /* we then get 0x40 bytes worth of 0xffff or small numbers followed by
387 nrOfFileBlks - 2 of these */
390 SLTG_Name index_name
; /* This refers to a name in the directory */
391 SLTG_Name other_name
; /* Another one of these weird names */
392 WORD res1a
; /* 0xffff */
393 WORD name_offs
; /* offset to name in name table */
394 WORD more_bytes
; /* if this is non-zero we get this many
395 bytes before the next element, which seem
396 to reference the docstring of the type ? */
397 WORD res20
; /* 0xffff */
399 WORD res26
; /* 0xffff */
401 } SLTG_OtherTypeInfo
;
403 /* Next we get WORD 0x0003 followed by a DWORD which if we add to
404 0x216 gives the offset to the name table from the start of the LibBlk
408 /*00*/ WORD magic
; /* 0x0501 */
409 /*02*/ DWORD href_table
; /* if not 0xffffffff, then byte offset from
410 beginning of struct to href table */
411 /*06*/ DWORD res06
; /* 0xffffffff */
412 /*0a*/ DWORD elem_table
; /* offset to members */
413 /*0e*/ DWORD res0e
; /* 0xffffffff */
414 /*12*/ WORD major_version
; /* major version number */
415 /*14*/ WORD minor_version
; /* minor version number */
416 /*16*/ DWORD res16
; /* 0xfffe0000 */
417 /*1a*/ BYTE typeflags1
;/* 0x02 | top 5 bits hold l5sbs of TYPEFLAGS */
418 /*1b*/ BYTE typeflags2
;/* TYPEFLAGS >> 5 */
419 /*1c*/ BYTE typeflags3
;/* 0x02*/
420 /*1d*/ BYTE typekind
; /* 0x03 == TKIND_INTERFACE etc. */
421 /*1e*/ DWORD res1e
; /* 0x00000000 or 0xffffffff */
422 } SLTG_TypeInfoHeader
;
424 #define SLTG_TIHEADER_MAGIC 0x0501
429 /*04*/ WORD cImplTypes
;
437 /*14*/ WORD tdescalias_vt
; /* for TKIND_ALIAS */
443 /*20*/ WORD cbSizeInstance
;
444 /*22*/ WORD cbAlignment
;
447 /*28*/ WORD cbSizeVft
;
457 /*00*/ WORD res00
; /* 0x0001 sometimes 0x0003 ?? */
458 /*02*/ WORD res02
; /* 0xffff */
459 /*04*/ BYTE res04
; /* 0x01 */
460 /*05*/ DWORD cbExtra
; /* No of bytes that follow */
464 /*00*/ WORD magic
; /* 0x120a */
465 /*02*/ WORD next
; /* offset in bytes to next block from start of block
466 group, 0xffff if last item */
467 /*04*/ WORD name
; /* offset to name within name table */
468 /*06*/ WORD value
; /* offset to value from start of block group */
469 /*08*/ WORD res08
; /* 0x56 */
470 /*0a*/ DWORD memid
; /* memid */
471 /*0e*/ WORD helpcontext
;/* 0xfffe == no context, 0x0001 == stored in EnumInfo struct, else offset
472 to value from start of block group */
473 /*10*/ WORD helpstring
;/* offset from start of block group to string offset */
476 #define SLTG_ENUMITEM_MAGIC 0x120a
479 /*00*/ WORD vt
; /* vartype, 0xffff marks end. */
480 /*02*/ WORD res02
; /* ?, 0xffff marks end */
483 #define SLTG_ALIASITEM_MAGIC 0x001d
487 BYTE magic
; /* 0x4c or 0x6c */
488 BYTE inv
; /* high nibble is INVOKE_KIND, low nibble = 2 */
489 WORD next
; /* byte offset from beginning of group to next fn */
490 WORD name
; /* Offset within name table to name */
491 DWORD dispid
; /* dispid */
492 WORD helpcontext
; /* helpcontext (again 1 is special) */
493 WORD helpstring
;/* helpstring offset to offset */
494 WORD arg_off
; /* offset to args from start of block */
495 BYTE nacc
; /* lowest 3bits are CALLCONV, rest are no of args */
496 BYTE retnextopt
;/* if 0x80 bit set ret type follows else next WORD
497 is offset to ret type. No of optional args is
499 WORD rettype
; /* return type VT_?? or offset to ret type */
500 WORD vtblpos
; /* position in vtbl? */
501 WORD funcflags
; /* present if magic == 0x6c */
502 /* Param list starts, repeat next two as required */
504 WORD name
; /* offset to 2nd letter of name */
505 WORD
+ type
; /* VT_ of param */
509 #define SLTG_FUNCTION_MAGIC 0x4c
510 #define SLTG_FUNCTION_WITH_FLAGS_MAGIC 0x6c
513 /*00*/ BYTE magic
; /* 0xdf */
514 /*01*/ BYTE res01
; /* 0x00 */
515 /*02*/ DWORD res02
; /* 0xffffffff */
516 /*06*/ DWORD res06
; /* 0xffffffff */
517 /*0a*/ DWORD res0a
; /* 0xffffffff */
518 /*0e*/ DWORD res0e
; /* 0xffffffff */
519 /*12*/ DWORD res12
; /* 0xffffffff */
520 /*16*/ DWORD res16
; /* 0xffffffff */
521 /*1a*/ DWORD res1a
; /* 0xffffffff */
522 /*1e*/ DWORD res1e
; /* 0xffffffff */
523 /*22*/ DWORD res22
; /* 0xffffffff */
524 /*26*/ DWORD res26
; /* 0xffffffff */
525 /*2a*/ DWORD res2a
; /* 0xffffffff */
526 /*2e*/ DWORD res2e
; /* 0xffffffff */
527 /*32*/ DWORD res32
; /* 0xffffffff */
528 /*36*/ DWORD res36
; /* 0xffffffff */
529 /*3a*/ DWORD res3a
; /* 0xffffffff */
530 /*3e*/ DWORD res3e
; /* 0xffffffff */
531 /*42*/ WORD res42
; /* 0xffff */
532 /*44*/ DWORD number
; /* this is 8 times the number of refs */
533 /*48*/ /* Now we have number bytes (8 for each ref) of SLTG_UnknownRefInfo */
535 /*50*/ WORD res50
; /* 0xffff */
536 /*52*/ BYTE res52
; /* 0x01 */
537 /*53*/ DWORD res53
; /* 0x00000000 */
538 /*57*/ SLTG_Name names
[1];
539 /* Now we have number/8 SLTG_Names (first WORD is no of bytes in the ascii
540 * string). Strings look like "*\Rxxxx*#n". If xxxx == ffff then the
541 * ref refers to the nth type listed in this library (0 based). Else
542 * the xxxx (which maybe fewer than 4 digits) is the offset into the name
543 * table to a string "*\G{<guid>}#1.0#0#C:\WINNT\System32\stdole32.tlb#"
544 * The guid is the typelib guid; the ref again refers to the nth type of
545 * the imported typelib.
548 /*xx*/ BYTE resxx
; /* 0xdf */
552 #define SLTG_REF_MAGIC 0xdf
555 WORD res00
; /* 0x0001 */
556 BYTE res02
; /* 0x02 */
557 BYTE res03
; /* 0x40 if internal ref, 0x00 if external ? */
558 WORD res04
; /* 0xffff */
559 WORD res06
; /* 0x0000, 0x0013 or 0xffff ?? */
560 } SLTG_UnknownRefInfo
;
563 WORD res00
; /* 0x004a */
564 WORD next
; /* byte offs to next interface */
565 WORD res04
; /* 0xffff */
566 BYTE impltypeflags
; /* IMPLTYPEFLAG_* */
567 BYTE res07
; /* 0x80 */
568 WORD res08
; /* 0x0012, 0x0028 ?? */
569 WORD ref
; /* number in ref table ? */
570 WORD res0c
; /* 0x4000 */
571 WORD res0e
; /* 0xfffe */
572 WORD res10
; /* 0xffff */
573 WORD res12
; /* 0x001d */
574 WORD pos_in_table
; /* 0x0, 0x4, ? */
577 #define SLTG_IMPL_MAGIC 0x004a
580 BYTE magic
; /* 0x0a */
584 WORD byte_offs
; /* pos in struct */
585 WORD type
; /* if typepos == 0x02 this is the type, else offset to type */
587 WORD helpcontext
; /* ?? */
588 WORD helpstring
; /* ?? */
591 #define SLTG_RECORD_MAGIC 0x0a
594 /* CARRAYs look like this
595 WORD type == VT_CARRAY
596 WORD offset from start of block to SAFEARRAY
600 extern DWORD
_invoke(FARPROC func
,CALLCONV callconv
, int nrargs
, DWORD
*args
);
601 extern void dump_Variant(VARIANT
* pvar
);
604 /*---------------------------END--------------------------------------------*/