push f98ef5dce4886db1f9801e7c454145e1b633b4ff
[wine/hacks.git] / tools / widl / write_msft.c
blobf5ea2f7f27bbb0ae37410fb8271f43944fd04671
1 /*
2 * Typelib v2 (MSFT) generation
4 * Copyright 2004 Alastair Bridgewater
5 * 2004, 2005 Huw Davies
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * --------------------------------------------------------------------------------------
22 * Known problems:
24 * Badly incomplete.
26 * Only works on little-endian systems.
30 #include "config.h"
31 #include "wine/port.h"
33 #include <stdlib.h>
34 #include <string.h>
35 #include <stdarg.h>
36 #include <stdio.h>
37 #include <ctype.h>
38 #include <time.h>
40 #define NONAMELESSUNION
41 #define NONAMELESSSTRUCT
43 #include "winerror.h"
44 #include "windef.h"
45 #include "winbase.h"
46 #include "winnls.h"
48 #include "widltypes.h"
49 #include "typelib.h"
50 #include "typelib_struct.h"
51 #include "utils.h"
52 #include "header.h"
53 #include "hash.h"
55 enum MSFT_segment_index {
56 MSFT_SEG_TYPEINFO = 0, /* type information */
57 MSFT_SEG_IMPORTINFO, /* import information */
58 MSFT_SEG_IMPORTFILES, /* import filenames */
59 MSFT_SEG_REFERENCES, /* references (?) */
60 MSFT_SEG_GUIDHASH, /* hash table for guids? */
61 MSFT_SEG_GUID, /* guid storage */
62 MSFT_SEG_NAMEHASH, /* hash table for names */
63 MSFT_SEG_NAME, /* name storage */
64 MSFT_SEG_STRING, /* string storage */
65 MSFT_SEG_TYPEDESC, /* type descriptions */
66 MSFT_SEG_ARRAYDESC, /* array descriptions */
67 MSFT_SEG_CUSTDATA, /* custom data */
68 MSFT_SEG_CUSTDATAGUID, /* custom data guids */
69 MSFT_SEG_UNKNOWN, /* ??? */
70 MSFT_SEG_UNKNOWN2, /* ??? */
71 MSFT_SEG_MAX /* total number of segments */
74 typedef struct tagMSFT_ImpFile {
75 int guid;
76 LCID lcid;
77 int version;
78 char filename[0]; /* preceded by two bytes of encoded (length << 2) + flags in the low two bits. */
79 } MSFT_ImpFile;
81 typedef struct _msft_typelib_t
83 typelib_t *typelib;
84 MSFT_Header typelib_header;
85 MSFT_pSeg typelib_segdir[MSFT_SEG_MAX];
86 char *typelib_segment_data[MSFT_SEG_MAX];
87 int typelib_segment_block_length[MSFT_SEG_MAX];
89 INT typelib_typeinfo_offsets[0x200]; /* Hope that's enough. */
91 INT *typelib_namehash_segment;
92 INT *typelib_guidhash_segment;
94 INT help_string_dll_offset;
96 struct _msft_typeinfo_t *typeinfos;
97 struct _msft_typeinfo_t *last_typeinfo;
98 } msft_typelib_t;
100 typedef struct _msft_typeinfo_t
102 msft_typelib_t *typelib;
103 MSFT_TypeInfoBase *typeinfo;
105 int typekind;
107 unsigned int var_data_allocated;
108 int *var_data;
110 unsigned int func_data_allocated;
111 int *func_data;
113 int vars_allocated;
114 int *var_indices;
115 int *var_names;
116 int *var_offsets;
118 int funcs_allocated;
119 int *func_indices;
120 int *func_names;
121 int *func_offsets;
123 int datawidth;
125 struct _msft_typeinfo_t *next_typeinfo;
126 } msft_typeinfo_t;
130 /*================== Internal functions ===================================*/
132 /****************************************************************************
133 * ctl2_init_header
135 * Initializes the type library header of a new typelib.
137 static void ctl2_init_header(
138 msft_typelib_t *typelib) /* [I] The typelib to initialize. */
140 typelib->typelib_header.magic1 = 0x5446534d;
141 typelib->typelib_header.magic2 = 0x00010002;
142 typelib->typelib_header.posguid = -1;
143 typelib->typelib_header.lcid = 0x0409; /* or do we use the current one? */
144 typelib->typelib_header.lcid2 = 0x0;
145 typelib->typelib_header.varflags = 0x40;
146 typelib->typelib_header.version = 0;
147 typelib->typelib_header.flags = 0;
148 typelib->typelib_header.nrtypeinfos = 0;
149 typelib->typelib_header.helpstring = -1;
150 typelib->typelib_header.helpstringcontext = 0;
151 typelib->typelib_header.helpcontext = 0;
152 typelib->typelib_header.nametablecount = 0;
153 typelib->typelib_header.nametablechars = 0;
154 typelib->typelib_header.NameOffset = -1;
155 typelib->typelib_header.helpfile = -1;
156 typelib->typelib_header.CustomDataOffset = -1;
157 typelib->typelib_header.res44 = 0x20;
158 typelib->typelib_header.res48 = 0x80;
159 typelib->typelib_header.dispatchpos = -1;
160 typelib->typelib_header.nimpinfos = 0;
163 /****************************************************************************
164 * ctl2_init_segdir
166 * Initializes the segment directory of a new typelib.
168 static void ctl2_init_segdir(
169 msft_typelib_t *typelib) /* [I] The typelib to initialize. */
171 int i;
172 MSFT_pSeg *segdir;
174 segdir = &typelib->typelib_segdir[MSFT_SEG_TYPEINFO];
176 for (i = 0; i < 15; i++) {
177 segdir[i].offset = -1;
178 segdir[i].length = 0;
179 segdir[i].res08 = -1;
180 segdir[i].res0c = 0x0f;
184 /****************************************************************************
185 * ctl2_hash_guid
187 * Generates a hash key from a GUID.
189 * RETURNS
191 * The hash key for the GUID.
193 static int ctl2_hash_guid(
194 REFGUID guid) /* [I] The guid to hash. */
196 int hash;
197 int i;
199 hash = 0;
200 for (i = 0; i < 8; i ++) {
201 hash ^= ((const short *)guid)[i];
204 return hash & 0x1f;
207 /****************************************************************************
208 * ctl2_find_guid
210 * Locates a guid in a type library.
212 * RETURNS
214 * The offset into the GUID segment of the guid, or -1 if not found.
216 static int ctl2_find_guid(
217 msft_typelib_t *typelib, /* [I] The typelib to operate against. */
218 int hash_key, /* [I] The hash key for the guid. */
219 REFGUID guid) /* [I] The guid to find. */
221 int offset;
222 MSFT_GuidEntry *guidentry;
224 offset = typelib->typelib_guidhash_segment[hash_key];
225 while (offset != -1) {
226 guidentry = (MSFT_GuidEntry *)&typelib->typelib_segment_data[MSFT_SEG_GUID][offset];
228 if (!memcmp(guidentry, guid, sizeof(GUID))) return offset;
230 offset = guidentry->next_hash;
233 return offset;
236 /****************************************************************************
237 * ctl2_find_name
239 * Locates a name in a type library.
241 * RETURNS
243 * The offset into the NAME segment of the name, or -1 if not found.
245 * NOTES
247 * The name must be encoded as with ctl2_encode_name().
249 static int ctl2_find_name(
250 msft_typelib_t *typelib, /* [I] The typelib to operate against. */
251 char *name) /* [I] The encoded name to find. */
253 int offset;
254 int *namestruct;
256 offset = typelib->typelib_namehash_segment[name[2] & 0x7f];
257 while (offset != -1) {
258 namestruct = (int *)&typelib->typelib_segment_data[MSFT_SEG_NAME][offset];
260 if (!((namestruct[2] ^ *((int *)name)) & 0xffff00ff)) {
261 /* hash codes and lengths match, final test */
262 if (!strncasecmp(name+4, (void *)(namestruct+3), name[0])) break;
265 /* move to next item in hash bucket */
266 offset = namestruct[1];
269 return offset;
272 /****************************************************************************
273 * ctl2_encode_name
275 * Encodes a name string to a form suitable for storing into a type library
276 * or comparing to a name stored in a type library.
278 * RETURNS
280 * The length of the encoded name, including padding and length+hash fields.
282 * NOTES
284 * Will throw an exception if name or result are NULL. Is not multithread
285 * safe in the slightest.
287 static int ctl2_encode_name(
288 msft_typelib_t *typelib, /* [I] The typelib to operate against (used for LCID only). */
289 const char *name, /* [I] The name string to encode. */
290 char **result) /* [O] A pointer to a pointer to receive the encoded name. */
292 int length;
293 static char converted_name[0x104];
294 int offset;
295 int value;
297 length = strlen(name);
298 memcpy(converted_name + 4, name, length);
299 converted_name[0] = length & 0xff;
301 converted_name[length + 4] = 0;
303 converted_name[1] = 0x00;
305 value = lhash_val_of_name_sys(typelib->typelib_header.varflags & 0x0f, typelib->typelib_header.lcid, converted_name + 4);
307 converted_name[2] = value;
308 converted_name[3] = value >> 8;
310 for (offset = (4 - length) & 3; offset; offset--) converted_name[length + offset + 3] = 0x57;
312 *result = converted_name;
314 return (length + 7) & ~3;
317 /****************************************************************************
318 * ctl2_encode_string
320 * Encodes a string to a form suitable for storing into a type library or
321 * comparing to a string stored in a type library.
323 * RETURNS
325 * The length of the encoded string, including padding and length fields.
327 * NOTES
329 * Will throw an exception if string or result are NULL. Is not multithread
330 * safe in the slightest.
332 static int ctl2_encode_string(
333 const char *string, /* [I] The string to encode. */
334 char **result) /* [O] A pointer to a pointer to receive the encoded string. */
336 int length;
337 static char converted_string[0x104];
338 int offset;
340 length = strlen(string);
341 memcpy(converted_string + 2, string, length);
342 converted_string[0] = length & 0xff;
343 converted_string[1] = (length >> 8) & 0xff;
345 if(length < 3) { /* strings of this length are padded with up to 8 bytes incl the 2 byte length */
346 for(offset = 0; offset < 4; offset++)
347 converted_string[length + offset + 2] = 0x57;
348 length += 4;
350 for (offset = (4 - (length + 2)) & 3; offset; offset--) converted_string[length + offset + 1] = 0x57;
352 *result = converted_string;
354 return (length + 5) & ~3;
357 /****************************************************************************
358 * ctl2_alloc_segment
360 * Allocates memory from a segment in a type library.
362 * RETURNS
364 * Success: The offset within the segment of the new data area.
366 * BUGS
368 * Does not (yet) handle the case where the allocated segment memory needs to grow.
370 static int ctl2_alloc_segment(
371 msft_typelib_t *typelib, /* [I] The type library in which to allocate. */
372 enum MSFT_segment_index segment, /* [I] The segment in which to allocate. */
373 int size, /* [I] The amount to allocate. */
374 int block_size) /* [I] Initial allocation block size, or 0 for default. */
376 int offset;
378 if(!typelib->typelib_segment_data[segment]) {
379 if (!block_size) block_size = 0x2000;
381 typelib->typelib_segment_block_length[segment] = block_size;
382 typelib->typelib_segment_data[segment] = xmalloc(block_size);
383 if (!typelib->typelib_segment_data[segment]) return -1;
384 memset(typelib->typelib_segment_data[segment], 0x57, block_size);
387 while ((typelib->typelib_segdir[segment].length + size) > typelib->typelib_segment_block_length[segment]) {
388 char *block;
390 block_size = typelib->typelib_segment_block_length[segment];
391 block = xrealloc(typelib->typelib_segment_data[segment], block_size << 1);
393 if (segment == MSFT_SEG_TYPEINFO) {
394 /* TypeInfos have a direct pointer to their memory space, so we have to fix them up. */
395 msft_typeinfo_t *typeinfo;
397 for (typeinfo = typelib->typeinfos; typeinfo; typeinfo = typeinfo->next_typeinfo) {
398 typeinfo->typeinfo = (void *)&block[((char *)typeinfo->typeinfo) - typelib->typelib_segment_data[segment]];
402 memset(block + block_size, 0x57, block_size);
403 typelib->typelib_segment_block_length[segment] = block_size << 1;
404 typelib->typelib_segment_data[segment] = block;
407 offset = typelib->typelib_segdir[segment].length;
408 typelib->typelib_segdir[segment].length += size;
410 return offset;
413 /****************************************************************************
414 * ctl2_alloc_typeinfo
416 * Allocates and initializes a typeinfo structure in a type library.
418 * RETURNS
420 * Success: The offset of the new typeinfo.
421 * Failure: -1 (this is invariably an out of memory condition).
423 static int ctl2_alloc_typeinfo(
424 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
425 int nameoffset) /* [I] The offset of the name for this typeinfo. */
427 int offset;
428 MSFT_TypeInfoBase *typeinfo;
430 offset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEINFO, sizeof(MSFT_TypeInfoBase), 0);
432 typelib->typelib_typeinfo_offsets[typelib->typelib_header.nrtypeinfos++] = offset;
434 typeinfo = (void *)(typelib->typelib_segment_data[MSFT_SEG_TYPEINFO] + offset);
436 typeinfo->typekind = (typelib->typelib_header.nrtypeinfos - 1) << 16;
437 typeinfo->memoffset = -1; /* should be EOF if no elements */
438 typeinfo->res2 = 0;
439 typeinfo->res3 = -1;
440 typeinfo->res4 = 3;
441 typeinfo->res5 = 0;
442 typeinfo->cElement = 0;
443 typeinfo->res7 = 0;
444 typeinfo->res8 = 0;
445 typeinfo->res9 = 0;
446 typeinfo->resA = 0;
447 typeinfo->posguid = -1;
448 typeinfo->flags = 0;
449 typeinfo->NameOffset = nameoffset;
450 typeinfo->version = 0;
451 typeinfo->docstringoffs = -1;
452 typeinfo->helpstringcontext = 0;
453 typeinfo->helpcontext = 0;
454 typeinfo->oCustData = -1;
455 typeinfo->cbSizeVft = 0;
456 typeinfo->cImplTypes = 0;
457 typeinfo->size = 0;
458 typeinfo->datatype1 = -1;
459 typeinfo->datatype2 = 0;
460 typeinfo->res18 = 0;
461 typeinfo->res19 = -1;
463 return offset;
466 /****************************************************************************
467 * ctl2_alloc_guid
469 * Allocates and initializes a GUID structure in a type library. Also updates
470 * the GUID hash table as needed.
472 * RETURNS
474 * Success: The offset of the new GUID.
476 static int ctl2_alloc_guid(
477 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
478 MSFT_GuidEntry *guid) /* [I] The GUID to store. */
480 int offset;
481 MSFT_GuidEntry *guid_space;
482 int hash_key;
484 hash_key = ctl2_hash_guid(&guid->guid);
486 offset = ctl2_find_guid(typelib, hash_key, &guid->guid);
487 if (offset != -1) return offset;
489 offset = ctl2_alloc_segment(typelib, MSFT_SEG_GUID, sizeof(MSFT_GuidEntry), 0);
491 guid_space = (void *)(typelib->typelib_segment_data[MSFT_SEG_GUID] + offset);
492 *guid_space = *guid;
494 guid_space->next_hash = typelib->typelib_guidhash_segment[hash_key];
495 typelib->typelib_guidhash_segment[hash_key] = offset;
497 return offset;
500 /****************************************************************************
501 * ctl2_alloc_name
503 * Allocates and initializes a name within a type library. Also updates the
504 * name hash table as needed.
506 * RETURNS
508 * Success: The offset within the segment of the new name.
509 * Failure: -1 (this is invariably an out of memory condition).
511 static int ctl2_alloc_name(
512 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
513 const char *name) /* [I] The name to store. */
515 int length;
516 int offset;
517 MSFT_NameIntro *name_space;
518 char *encoded_name;
520 length = ctl2_encode_name(typelib, name, &encoded_name);
522 offset = ctl2_find_name(typelib, encoded_name);
523 if (offset != -1) return offset;
525 offset = ctl2_alloc_segment(typelib, MSFT_SEG_NAME, length + 8, 0);
527 name_space = (void *)(typelib->typelib_segment_data[MSFT_SEG_NAME] + offset);
528 name_space->hreftype = -1;
529 name_space->next_hash = -1;
530 memcpy(&name_space->namelen, encoded_name, length);
532 if (typelib->typelib_namehash_segment[encoded_name[2] & 0x7f] != -1)
533 name_space->next_hash = typelib->typelib_namehash_segment[encoded_name[2] & 0x7f];
535 typelib->typelib_namehash_segment[encoded_name[2] & 0x7f] = offset;
537 typelib->typelib_header.nametablecount += 1;
538 typelib->typelib_header.nametablechars += *encoded_name;
540 return offset;
543 /****************************************************************************
544 * ctl2_alloc_string
546 * Allocates and initializes a string in a type library.
548 * RETURNS
550 * Success: The offset within the segment of the new string.
551 * Failure: -1 (this is invariably an out of memory condition).
553 static int ctl2_alloc_string(
554 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
555 const char *string) /* [I] The string to store. */
557 int length;
558 int offset;
559 char *string_space;
560 char *encoded_string;
562 length = ctl2_encode_string(string, &encoded_string);
564 for (offset = 0; offset < typelib->typelib_segdir[MSFT_SEG_STRING].length;
565 offset += ((((typelib->typelib_segment_data[MSFT_SEG_STRING][offset + 1] << 8) & 0xff)
566 | (typelib->typelib_segment_data[MSFT_SEG_STRING][offset + 0] & 0xff)) + 5) & ~3) {
567 if (!memcmp(encoded_string, typelib->typelib_segment_data[MSFT_SEG_STRING] + offset, length)) return offset;
570 offset = ctl2_alloc_segment(typelib, MSFT_SEG_STRING, length, 0);
572 string_space = typelib->typelib_segment_data[MSFT_SEG_STRING] + offset;
573 memcpy(string_space, encoded_string, length);
575 return offset;
578 /****************************************************************************
579 * alloc_msft_importinfo
581 * Allocates and initializes an import information structure in a type library.
583 * RETURNS
585 * Success: The offset of the new importinfo.
586 * Failure: -1 (this is invariably an out of memory condition).
588 static int alloc_msft_importinfo(
589 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
590 MSFT_ImpInfo *impinfo) /* [I] The import information to store. */
592 int offset;
593 MSFT_ImpInfo *impinfo_space;
595 for (offset = 0;
596 offset < typelib->typelib_segdir[MSFT_SEG_IMPORTINFO].length;
597 offset += sizeof(MSFT_ImpInfo)) {
598 if (!memcmp(&(typelib->typelib_segment_data[MSFT_SEG_IMPORTINFO][offset]),
599 impinfo, sizeof(MSFT_ImpInfo))) {
600 return offset;
604 impinfo->flags |= typelib->typelib_header.nimpinfos++;
606 offset = ctl2_alloc_segment(typelib, MSFT_SEG_IMPORTINFO, sizeof(MSFT_ImpInfo), 0);
608 impinfo_space = (void *)(typelib->typelib_segment_data[MSFT_SEG_IMPORTINFO] + offset);
609 *impinfo_space = *impinfo;
611 return offset;
614 /****************************************************************************
615 * alloc_importfile
617 * Allocates and initializes an import file definition in a type library.
619 * RETURNS
621 * Success: The offset of the new importinfo.
622 * Failure: -1 (this is invariably an out of memory condition).
624 static int alloc_importfile(
625 msft_typelib_t *typelib, /* [I] The type library to allocate in. */
626 int guidoffset, /* [I] The offset to the GUID for the imported library. */
627 int major_version, /* [I] The major version number of the imported library. */
628 int minor_version, /* [I] The minor version number of the imported library. */
629 const char *filename) /* [I] The filename of the imported library. */
631 int length;
632 int offset;
633 MSFT_ImpFile *importfile;
634 char *encoded_string;
636 length = ctl2_encode_string(filename, &encoded_string);
638 encoded_string[0] <<= 2;
639 encoded_string[0] |= 1;
641 for (offset = 0; offset < typelib->typelib_segdir[MSFT_SEG_IMPORTFILES].length;
642 offset += ((((typelib->typelib_segment_data[MSFT_SEG_IMPORTFILES][offset + 0xd] << 8) & 0xff)
643 | (typelib->typelib_segment_data[MSFT_SEG_IMPORTFILES][offset + 0xc] & 0xff)) >> 2) + 0xc) {
644 if (!memcmp(encoded_string, typelib->typelib_segment_data[MSFT_SEG_IMPORTFILES] + offset + 0xc, length)) return offset;
647 offset = ctl2_alloc_segment(typelib, MSFT_SEG_IMPORTFILES, length + 0xc, 0);
649 importfile = (MSFT_ImpFile *)&typelib->typelib_segment_data[MSFT_SEG_IMPORTFILES][offset];
650 importfile->guid = guidoffset;
651 importfile->lcid = typelib->typelib_header.lcid2;
652 importfile->version = major_version | (minor_version << 16);
653 memcpy(&importfile->filename, encoded_string, length);
655 return offset;
658 static void alloc_importinfo(msft_typelib_t *typelib, importinfo_t *importinfo)
660 importlib_t *importlib = importinfo->importlib;
662 chat("alloc_importinfo: %s\n", importinfo->name);
664 if(!importlib->allocated) {
665 MSFT_GuidEntry guid;
666 int guid_idx;
668 chat("allocating importlib %s\n", importlib->name);
670 importlib->allocated = -1;
672 memcpy(&guid.guid, &importlib->guid, sizeof(GUID));
673 guid.hreftype = 2;
675 guid_idx = ctl2_alloc_guid(typelib, &guid);
677 alloc_importfile(typelib, guid_idx, importlib->version&0xffff,
678 importlib->version>>16, importlib->name);
681 if(importinfo->offset == -1 || !(importinfo->flags & MSFT_IMPINFO_OFFSET_IS_GUID)) {
682 MSFT_ImpInfo impinfo;
684 impinfo.flags = importinfo->flags;
685 impinfo.oImpFile = 0;
687 if(importinfo->flags & MSFT_IMPINFO_OFFSET_IS_GUID) {
688 MSFT_GuidEntry guid;
690 guid.hreftype = 0;
691 memcpy(&guid.guid, &importinfo->guid, sizeof(GUID));
693 impinfo.oGuid = ctl2_alloc_guid(typelib, &guid);
695 importinfo->offset = alloc_msft_importinfo(typelib, &impinfo);
697 typelib->typelib_segment_data[MSFT_SEG_GUID][impinfo.oGuid+sizeof(GUID)]
698 = importinfo->offset+1;
700 if(!strcmp(importinfo->name, "IDispatch"))
701 typelib->typelib_header.dispatchpos = importinfo->offset+1;
702 }else {
703 impinfo.oGuid = importinfo->id;
704 importinfo->offset = alloc_msft_importinfo(typelib, &impinfo);
709 static importinfo_t *find_importinfo(msft_typelib_t *typelib, const char *name)
711 importlib_t *importlib;
712 int i;
714 chat("search importlib %s\n", name);
716 if(!name)
717 return NULL;
719 LIST_FOR_EACH_ENTRY( importlib, &typelib->typelib->importlibs, importlib_t, entry )
721 for(i=0; i < importlib->ntypeinfos; i++) {
722 if(!strcmp(name, importlib->importinfos[i].name)) {
723 chat("Found %s in importlib.\n", name);
724 return importlib->importinfos+i;
729 return NULL;
732 static void add_structure_typeinfo(msft_typelib_t *typelib, type_t *structure);
733 static void add_interface_typeinfo(msft_typelib_t *typelib, type_t *interface);
734 static void add_enum_typeinfo(msft_typelib_t *typelib, type_t *enumeration);
735 static void add_coclass_typeinfo(msft_typelib_t *typelib, type_t *cls);
736 static void add_dispinterface_typeinfo(msft_typelib_t *typelib, type_t *dispinterface);
739 /****************************************************************************
740 * encode_type
742 * Encodes a type, storing information in the TYPEDESC and ARRAYDESC
743 * segments as needed.
745 * RETURNS
747 * Success: 0.
748 * Failure: -1.
750 static int encode_type(
751 msft_typelib_t *typelib, /* [I] The type library in which to encode the TYPEDESC. */
752 int vt, /* [I] vt to encode */
753 type_t *type, /* [I] type */
754 int *encoded_type, /* [O] The encoded type description. */
755 int *width, /* [O] The width of the type, or NULL. */
756 int *alignment, /* [O] The alignment of the type, or NULL. */
757 int *decoded_size) /* [O] The total size of the unencoded TYPEDESCs, including nested descs. */
759 int default_type;
760 int scratch;
761 int typeoffset;
762 int *typedata;
763 int target_type;
764 int child_size = 0;
766 chat("encode_type vt %d type %p\n", vt, type);
768 default_type = 0x80000000 | (vt << 16) | vt;
769 if (!width) width = &scratch;
770 if (!alignment) alignment = &scratch;
771 if (!decoded_size) decoded_size = &scratch;
774 switch (vt) {
775 case VT_I1:
776 case VT_UI1:
777 *encoded_type = default_type;
778 *width = 1;
779 *alignment = 1;
780 break;
782 case VT_INT:
783 *encoded_type = 0x80000000 | (VT_I4 << 16) | VT_INT;
784 if ((typelib->typelib_header.varflags & 0x0f) == SYS_WIN16) {
785 *width = 2;
786 *alignment = 2;
787 } else {
788 *width = 4;
789 *alignment = 4;
791 break;
793 case VT_UINT:
794 *encoded_type = 0x80000000 | (VT_UI4 << 16) | VT_UINT;
795 if ((typelib->typelib_header.varflags & 0x0f) == SYS_WIN16) {
796 *width = 2;
797 *alignment = 2;
798 } else {
799 *width = 4;
800 *alignment = 4;
802 break;
804 case VT_UI2:
805 case VT_I2:
806 case VT_BOOL:
807 *encoded_type = default_type;
808 *width = 2;
809 *alignment = 2;
810 break;
812 case VT_I4:
813 case VT_UI4:
814 case VT_R4:
815 case VT_ERROR:
816 case VT_BSTR:
817 case VT_HRESULT:
818 *encoded_type = default_type;
819 *width = 4;
820 *alignment = 4;
821 break;
823 case VT_R8:
824 case VT_I8:
825 case VT_UI8:
826 *encoded_type = default_type;
827 *width = 8;
828 *alignment = 8;
829 break;
831 case VT_CY:
832 case VT_DATE:
833 *encoded_type = default_type;
834 *width = 8;
835 *alignment = 8;
836 break;
838 case VT_VOID:
839 *encoded_type = 0x80000000 | (VT_EMPTY << 16) | vt;
840 *width = 0;
841 *alignment = 1;
842 break;
844 case VT_UNKNOWN:
845 case VT_DISPATCH:
846 *encoded_type = default_type;
847 *width = 4;
848 *alignment = 4;
849 break;
851 case VT_VARIANT:
852 *encoded_type = default_type;
853 break;
855 case VT_LPSTR:
856 case VT_LPWSTR:
857 *encoded_type = 0xfffe0000 | vt;
858 *width = 4;
859 *alignment = 4;
860 break;
862 case VT_PTR:
864 int next_vt;
865 for(next_vt = 0; type->ref; type = type->ref) {
866 next_vt = get_type_vt(type->ref);
867 if (next_vt != 0)
868 break;
870 /* if no type found then it must be void */
871 if (next_vt == 0)
872 next_vt = VT_VOID;
874 encode_type(typelib, next_vt, type->ref, &target_type, NULL, NULL, &child_size);
875 if(type->ref && (type->ref->type == RPC_FC_IP)) {
876 chat("encode_type: skipping ptr\n");
877 *encoded_type = target_type;
878 *width = 4;
879 *alignment = 4;
880 *decoded_size = child_size;
881 break;
884 for (typeoffset = 0; typeoffset < typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length; typeoffset += 8) {
885 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
886 if (((typedata[0] & 0xffff) == VT_PTR) && (typedata[1] == target_type)) break;
889 if (typeoffset == typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length) {
890 int mix_field;
892 if (target_type & 0x80000000) {
893 mix_field = ((target_type >> 16) & 0x3fff) | VT_BYREF;
894 } else {
895 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][target_type];
896 mix_field = ((typedata[0] >> 16) == 0x7fff)? 0x7fff: 0x7ffe;
899 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
900 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
902 typedata[0] = (mix_field << 16) | VT_PTR;
903 typedata[1] = target_type;
906 *encoded_type = typeoffset;
908 *width = 4;
909 *alignment = 4;
910 *decoded_size = 8 /*sizeof(TYPEDESC)*/ + child_size;
911 break;
915 case VT_SAFEARRAY:
917 int next_vt;
919 /* skip over SAFEARRAY type straight to element type */
920 type = type->ref;
922 for(next_vt = 0; type->ref; type = type->ref) {
923 next_vt = get_type_vt(type->ref);
924 if (next_vt != 0)
925 break;
928 encode_type(typelib, next_vt, type->ref, &target_type, NULL, NULL, &child_size);
930 for (typeoffset = 0; typeoffset < typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length; typeoffset += 8) {
931 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
932 if (((typedata[0] & 0xffff) == VT_SAFEARRAY) && (typedata[1] == target_type)) break;
935 if (typeoffset == typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length) {
936 int mix_field;
938 if (target_type & 0x80000000) {
939 mix_field = ((target_type >> 16) & VT_TYPEMASK) | VT_ARRAY;
940 } else {
941 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][target_type];
942 mix_field = ((typedata[0] >> 16) == 0x7fff)? 0x7fff: 0x7ffe;
945 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
946 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
948 typedata[0] = (mix_field << 16) | VT_SAFEARRAY;
949 typedata[1] = target_type;
952 *encoded_type = typeoffset;
954 *width = 4;
955 *alignment = 4;
956 *decoded_size = 8 /*sizeof(TYPEDESC)*/ + child_size;
957 break;
961 case VT_USERDEFINED:
963 int typeinfo_offset;
965 /* typedef'd types without attributes aren't included in the typelib */
966 while (type->typelib_idx < 0 && type->kind == TKIND_ALIAS && ! type->attrs)
967 type = type->orig;
969 chat("encode_type: VT_USERDEFINED - type %p name = %s type->type %d idx %d\n", type,
970 type->name, type->type, type->typelib_idx);
972 if(type->typelib_idx == -1) {
973 chat("encode_type: trying to ref not added type\n");
974 switch(type->type) {
975 case RPC_FC_STRUCT:
976 case RPC_FC_PSTRUCT:
977 case RPC_FC_CSTRUCT:
978 case RPC_FC_CPSTRUCT:
979 case RPC_FC_CVSTRUCT:
980 case RPC_FC_BOGUS_STRUCT:
981 add_structure_typeinfo(typelib, type);
982 break;
983 case RPC_FC_IP:
984 add_interface_typeinfo(typelib, type);
985 break;
986 case RPC_FC_ENUM16:
987 add_enum_typeinfo(typelib, type);
988 break;
989 case 0:
990 if (type->kind == TKIND_COCLASS)
991 add_coclass_typeinfo(typelib, type);
992 else if (type->kind == TKIND_DISPATCH)
993 add_dispinterface_typeinfo(typelib, type);
994 else
995 error("encode_type: VT_USERDEFINED - can't yet add typedef's on the fly\n");
996 break;
997 default:
998 error("encode_type: VT_USERDEFINED - unhandled type %d\n", type->type);
1002 typeinfo_offset = typelib->typelib_typeinfo_offsets[type->typelib_idx];
1003 for (typeoffset = 0; typeoffset < typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length; typeoffset += 8) {
1004 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1005 if ((typedata[0] == ((0x7fff << 16) | VT_USERDEFINED)) && (typedata[1] == typeinfo_offset)) break;
1008 if (typeoffset == typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length) {
1009 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
1010 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1012 typedata[0] = (0x7fff << 16) | VT_USERDEFINED;
1013 typedata[1] = typeinfo_offset;
1016 *encoded_type = typeoffset;
1017 *width = 0;
1018 *alignment = 1;
1020 if(type->type == RPC_FC_IP) {
1021 for (typeoffset = 0; typeoffset < typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length; typeoffset += 8) {
1022 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1023 if ((typedata[0] == ((0x7fff << 16) | VT_PTR)) && (typedata[1] == *encoded_type)) break;
1025 if (typeoffset == typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length) {
1026 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
1027 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1029 typedata[0] = (0x7fff << 16) | VT_PTR;
1030 typedata[1] = *encoded_type;
1032 *encoded_type = typeoffset;
1033 *width = 4;
1034 *alignment = 4;
1035 *decoded_size += 8;
1037 break;
1040 default:
1041 error("encode_type: unrecognized type %d.\n", vt);
1042 *encoded_type = default_type;
1043 *width = 0;
1044 *alignment = 1;
1045 break;
1048 return 0;
1051 static void dump_type(type_t *t)
1053 chat("dump_type: %p name %s type %d ref %p attrs %p\n", t, t->name, t->type, t->ref, t->attrs);
1054 if(t->ref) dump_type(t->ref);
1057 static int encode_var(
1058 msft_typelib_t *typelib, /* [I] The type library in which to encode the TYPEDESC. */
1059 type_t *type, /* [I] The type description to encode. */
1060 var_t *var, /* [I] The var to encode. */
1061 int *encoded_type, /* [O] The encoded type description. */
1062 int *width, /* [O] The width of the type, or NULL. */
1063 int *alignment, /* [O] The alignment of the type, or NULL. */
1064 int *decoded_size) /* [O] The total size of the unencoded TYPEDESCs, including nested descs. */
1066 int typeoffset;
1067 int *typedata;
1068 int target_type;
1069 int child_size;
1070 int vt;
1071 int scratch;
1073 if (!width) width = &scratch;
1074 if (!alignment) alignment = &scratch;
1075 if (!decoded_size) decoded_size = &scratch;
1076 *decoded_size = 0;
1078 chat("encode_var: var %p type %p type->name %s type->ref %p\n",
1079 var, type, type->name ? type->name : "NULL", type->ref);
1081 if (type->declarray) {
1082 int num_dims, elements = 1, arrayoffset;
1083 type_t *atype;
1084 int *arraydata;
1086 num_dims = 0;
1087 for (atype = type; atype->declarray; atype = atype->ref)
1088 ++num_dims;
1090 chat("array with %d dimensions\n", num_dims);
1091 encode_var(typelib, atype, var, &target_type, width, alignment, NULL);
1092 arrayoffset = ctl2_alloc_segment(typelib, MSFT_SEG_ARRAYDESC, (2 + 2 * num_dims) * sizeof(long), 0);
1093 arraydata = (void *)&typelib->typelib_segment_data[MSFT_SEG_ARRAYDESC][arrayoffset];
1095 arraydata[0] = target_type;
1096 arraydata[1] = num_dims;
1097 arraydata[1] |= ((num_dims * 2 * sizeof(long)) << 16);
1099 arraydata += 2;
1100 for (atype = type; atype->declarray; atype = atype->ref)
1102 arraydata[0] = atype->dim;
1103 arraydata[1] = 0;
1104 arraydata += 2;
1105 elements *= atype->dim;
1108 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
1109 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1111 typedata[0] = (0x7ffe << 16) | VT_CARRAY;
1112 typedata[1] = arrayoffset;
1114 *encoded_type = typeoffset;
1115 *width = *width * elements;
1116 *decoded_size = 20 /*sizeof(ARRAYDESC)*/ + (num_dims - 1) * 8 /*sizeof(SAFEARRAYBOUND)*/;
1117 return 0;
1120 vt = get_type_vt(type);
1121 if (vt == VT_PTR) {
1122 int skip_ptr = encode_var(typelib, type->ref, var, &target_type, NULL, NULL, &child_size);
1124 if(skip_ptr == 2) {
1125 chat("encode_var: skipping ptr\n");
1126 *encoded_type = target_type;
1127 *decoded_size = child_size;
1128 *width = 4;
1129 *alignment = 4;
1130 return 0;
1133 for (typeoffset = 0; typeoffset < typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length; typeoffset += 8) {
1134 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1135 if (((typedata[0] & 0xffff) == VT_PTR) && (typedata[1] == target_type)) break;
1138 if (typeoffset == typelib->typelib_segdir[MSFT_SEG_TYPEDESC].length) {
1139 int mix_field;
1141 if (target_type & 0x80000000) {
1142 mix_field = ((target_type >> 16) & 0x3fff) | VT_BYREF;
1143 } else {
1144 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][target_type];
1145 mix_field = ((typedata[0] >> 16) == 0x7fff)? 0x7fff: 0x7ffe;
1148 typeoffset = ctl2_alloc_segment(typelib, MSFT_SEG_TYPEDESC, 8, 0);
1149 typedata = (void *)&typelib->typelib_segment_data[MSFT_SEG_TYPEDESC][typeoffset];
1151 typedata[0] = (mix_field << 16) | VT_PTR;
1152 typedata[1] = target_type;
1155 *encoded_type = typeoffset;
1157 *width = 4;
1158 *alignment = 4;
1159 *decoded_size = 8 /*sizeof(TYPEDESC)*/ + child_size;
1160 return 0;
1163 dump_type(type);
1165 encode_type(typelib, vt, type, encoded_type, width, alignment, decoded_size);
1166 if(type->type == RPC_FC_IP) return 2;
1167 return 0;
1170 static unsigned long get_ulong_val(unsigned long val, int vt)
1172 switch(vt) {
1173 case VT_I2:
1174 case VT_BOOL:
1175 case VT_UI2:
1176 return val & 0xffff;
1177 case VT_I1:
1178 case VT_UI1:
1179 return val & 0xff;
1182 return val;
1185 static void write_value(msft_typelib_t* typelib, int *out, int vt, void *value)
1187 switch(vt) {
1188 case VT_I2:
1189 case VT_I4:
1190 case VT_R4:
1191 case VT_BOOL:
1192 case VT_I1:
1193 case VT_UI1:
1194 case VT_UI2:
1195 case VT_UI4:
1196 case VT_INT:
1197 case VT_UINT:
1198 case VT_HRESULT:
1199 case VT_PTR:
1201 const unsigned long lv = get_ulong_val(*(unsigned long*)value, vt);
1202 if((lv & 0x3ffffff) == lv) {
1203 *out = 0x80000000;
1204 *out |= vt << 26;
1205 *out |= lv;
1206 } else {
1207 int offset = ctl2_alloc_segment(typelib, MSFT_SEG_CUSTDATA, 8, 0);
1208 *((unsigned short *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset]) = vt;
1209 memcpy(&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset+2], value, 4);
1210 *((unsigned short *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset+6]) = 0x5757;
1211 *out = offset;
1213 return;
1215 case VT_BSTR:
1217 char *s = (char *) value;
1218 int len = strlen(s), seg_len = (len + 6 + 3) & ~0x3;
1219 int offset = ctl2_alloc_segment(typelib, MSFT_SEG_CUSTDATA, seg_len, 0);
1220 *((unsigned short *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset]) = vt;
1221 *((unsigned int *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset+2]) = len;
1222 memcpy(&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset+6], value, len);
1223 len += 6;
1224 while(len < seg_len) {
1225 *((char *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATA][offset+len]) = 0x57;
1226 len++;
1228 *out = offset;
1229 return;
1232 default:
1233 warning("can't write value of type %d yet\n", vt);
1235 return;
1238 static HRESULT set_custdata(msft_typelib_t *typelib, REFGUID guid,
1239 int vt, void *value, int *offset)
1241 MSFT_GuidEntry guidentry;
1242 int guidoffset;
1243 int custoffset;
1244 int *custdata;
1245 int data_out;
1247 guidentry.guid = *guid;
1249 guidentry.hreftype = -1;
1250 guidentry.next_hash = -1;
1252 guidoffset = ctl2_alloc_guid(typelib, &guidentry);
1253 write_value(typelib, &data_out, vt, value);
1255 custoffset = ctl2_alloc_segment(typelib, MSFT_SEG_CUSTDATAGUID, 12, 0);
1257 custdata = (int *)&typelib->typelib_segment_data[MSFT_SEG_CUSTDATAGUID][custoffset];
1258 custdata[0] = guidoffset;
1259 custdata[1] = data_out;
1260 custdata[2] = *offset;
1261 *offset = custoffset;
1263 return S_OK;
1266 static HRESULT add_func_desc(msft_typeinfo_t* typeinfo, const func_t *func, int index)
1268 int offset, name_offset;
1269 int *typedata, typedata_size;
1270 int i, id, next_idx;
1271 int decoded_size, extra_attr = 0;
1272 int num_params = 0, num_optional = 0, num_defaults = 0;
1273 var_t *arg;
1274 char *namedata;
1275 const attr_t *attr;
1276 unsigned int funcflags = 0, callconv = 4 /* CC_STDCALL */;
1277 unsigned int funckind, invokekind = 1 /* INVOKE_FUNC */;
1278 int help_context = 0, help_string_context = 0, help_string_offset = -1;
1279 int entry = -1, entry_is_ord = 0;
1281 chat("add_func_desc(%p,%d)\n", typeinfo, index);
1283 id = ((0x6000 | (typeinfo->typeinfo->datatype2 & 0xffff)) << 16) | index;
1285 switch(typeinfo->typekind) {
1286 case TKIND_DISPATCH:
1287 funckind = 0x4; /* FUNC_DISPATCH */
1288 break;
1289 case TKIND_MODULE:
1290 funckind = 0x3; /* FUNC_STATIC */
1291 break;
1292 default:
1293 funckind = 0x1; /* FUNC_PUREVIRTUAL */
1294 break;
1297 if (is_local( func->def->attrs )) {
1298 chat("add_func_desc: skipping local function\n");
1299 return S_FALSE;
1302 if (func->args)
1303 LIST_FOR_EACH_ENTRY( arg, func->args, var_t, entry )
1305 num_params++;
1306 if (arg->attrs) LIST_FOR_EACH_ENTRY( attr, arg->attrs, const attr_t, entry ) {
1307 if(attr->type == ATTR_DEFAULTVALUE_EXPR || attr->type == ATTR_DEFAULTVALUE_STRING)
1308 num_defaults++;
1309 else if(attr->type == ATTR_OPTIONAL)
1310 num_optional++;
1314 chat("add_func_desc: num of params %d\n", num_params);
1316 name_offset = ctl2_alloc_name(typeinfo->typelib, func->def->name);
1318 if (func->def->attrs) LIST_FOR_EACH_ENTRY( attr, func->def->attrs, const attr_t, entry ) {
1319 expr_t *expr = attr->u.pval;
1320 switch(attr->type) {
1321 case ATTR_BINDABLE:
1322 funcflags |= 0x4; /* FUNCFLAG_BINDABLE */
1323 break;
1324 case ATTR_DISPLAYBIND:
1325 funcflags |= 0x10; /* FUNCFLAG_DISPLAYBIND */
1326 break;
1327 case ATTR_ENTRY_ORDINAL:
1328 extra_attr = max(extra_attr, 3);
1329 entry = expr->cval;
1330 entry_is_ord = 1;
1331 break;
1332 case ATTR_ENTRY_STRING:
1333 extra_attr = max(extra_attr, 3);
1334 entry = ctl2_alloc_string(typeinfo->typelib, attr->u.pval);
1335 break;
1336 case ATTR_HELPCONTEXT:
1337 extra_attr = max(extra_attr, 1);
1338 help_context = expr->u.lval;
1339 break;
1340 case ATTR_HELPSTRING:
1341 extra_attr = max(extra_attr, 2);
1342 help_string_offset = ctl2_alloc_string(typeinfo->typelib, attr->u.pval);
1343 break;
1344 case ATTR_HELPSTRINGCONTEXT:
1345 extra_attr = max(extra_attr, 6);
1346 help_string_context = expr->u.lval;
1347 break;
1348 case ATTR_HIDDEN:
1349 funcflags |= 0x40; /* FUNCFLAG_FHIDDEN */
1350 break;
1351 case ATTR_ID:
1352 id = expr->cval;
1353 break;
1354 case ATTR_NONBROWSABLE:
1355 funcflags |= 0x400; /* FUNCFLAG_NONBROWSABLE */
1356 break;
1357 case ATTR_OUT:
1358 break;
1359 case ATTR_PROPGET:
1360 invokekind = 0x2; /* INVOKE_PROPERTYGET */
1361 break;
1362 case ATTR_PROPPUT:
1363 invokekind = 0x4; /* INVOKE_PROPERTYPUT */
1364 break;
1365 case ATTR_PROPPUTREF:
1366 invokekind = 0x8; /* INVOKE_PROPERTYPUTREF */
1367 break;
1368 case ATTR_RESTRICTED:
1369 funcflags |= 0x1; /* FUNCFLAG_FRESTRICTED */
1370 break;
1371 case ATTR_VARARG:
1372 if (num_optional || num_defaults)
1373 warning("add_func_desc: ignoring vararg in function with optional or defaultvalue params\n");
1374 else
1375 num_optional = -1;
1376 break;
1377 default:
1378 warning("add_func_desc: ignoring attr %d\n", attr->type);
1379 break;
1383 /* allocate type data space for us */
1384 typedata_size = 0x18 + extra_attr * sizeof(int) + (num_params * (num_defaults ? 16 : 12));
1386 if (!typeinfo->func_data) {
1387 typeinfo->func_data = xmalloc(0x100);
1388 typeinfo->func_data_allocated = 0x100;
1389 typeinfo->func_data[0] = 0;
1392 if(typeinfo->func_data[0] + typedata_size + sizeof(int) > typeinfo->func_data_allocated) {
1393 typeinfo->func_data_allocated = max(typeinfo->func_data_allocated * 2,
1394 typeinfo->func_data[0] + typedata_size + sizeof(int));
1395 typeinfo->func_data = xrealloc(typeinfo->func_data, typeinfo->func_data_allocated);
1398 offset = typeinfo->func_data[0];
1399 typeinfo->func_data[0] += typedata_size;
1400 typedata = typeinfo->func_data + (offset >> 2) + 1;
1403 /* find func with the same name - if it exists use its id */
1404 for(i = 0; i < (typeinfo->typeinfo->cElement & 0xffff); i++) {
1405 if(name_offset == typeinfo->func_names[i]) {
1406 id = typeinfo->func_indices[i];
1407 break;
1411 /* find the first func with the same id and link via the hiword of typedata[4] */
1412 next_idx = index;
1413 for(i = 0; i < (typeinfo->typeinfo->cElement & 0xffff); i++) {
1414 if(id == typeinfo->func_indices[i]) {
1415 next_idx = typeinfo->func_data[(typeinfo->func_offsets[i] >> 2) + 1 + 4] >> 16;
1416 typeinfo->func_data[(typeinfo->func_offsets[i] >> 2) + 1 + 4] &= 0xffff;
1417 typeinfo->func_data[(typeinfo->func_offsets[i] >> 2) + 1 + 4] |= (index << 16);
1418 break;
1422 /* fill out the basic type information */
1423 typedata[0] = typedata_size | (index << 16);
1424 encode_var(typeinfo->typelib, func->def->type, func->def, &typedata[1], NULL, NULL, &decoded_size);
1425 typedata[2] = funcflags;
1426 typedata[3] = ((52 /*sizeof(FUNCDESC)*/ + decoded_size) << 16) | typeinfo->typeinfo->cbSizeVft;
1427 typedata[4] = (next_idx << 16) | (callconv << 8) | (invokekind << 3) | funckind;
1428 if(num_defaults) typedata[4] |= 0x1000;
1429 if(entry_is_ord) typedata[4] |= 0x2000;
1430 typedata[5] = (num_optional << 16) | num_params;
1432 /* NOTE: High word of typedata[3] is total size of FUNCDESC + size of all ELEMDESCs for params + TYPEDESCs for pointer params and return types. */
1433 /* That is, total memory allocation required to reconstitute the FUNCDESC in its entirety. */
1434 typedata[3] += (16 /*sizeof(ELEMDESC)*/ * num_params) << 16;
1435 typedata[3] += (24 /*sizeof(PARAMDESCEX)*/ * num_defaults) << 16;
1437 switch(extra_attr) {
1438 case 6: typedata[11] = help_string_context;
1439 case 5: typedata[10] = -1;
1440 case 4: typedata[9] = -1;
1441 case 3: typedata[8] = entry;
1442 case 2: typedata[7] = help_string_offset;
1443 case 1: typedata[6] = help_context;
1444 case 0:
1445 break;
1446 default:
1447 warning("unknown number of optional attrs\n");
1450 if (func->args)
1452 i = 0;
1453 LIST_FOR_EACH_ENTRY( arg, func->args, var_t, entry )
1455 const attr_t *attr;
1456 int paramflags = 0;
1457 int *paramdata = typedata + 6 + extra_attr + (num_defaults ? num_params : 0) + i * 3;
1458 int *defaultdata = num_defaults ? typedata + 6 + extra_attr + i : NULL;
1460 if(defaultdata) *defaultdata = -1;
1462 encode_var(typeinfo->typelib, arg->type, arg, paramdata, NULL, NULL, &decoded_size);
1463 if (arg->attrs) LIST_FOR_EACH_ENTRY( attr, arg->attrs, const attr_t, entry ) {
1464 switch(attr->type) {
1465 case ATTR_DEFAULTVALUE_EXPR:
1467 int vt;
1468 expr_t *expr = (expr_t *)attr->u.pval;
1469 if (arg->type->type == RPC_FC_ENUM16)
1470 vt = VT_INT;
1471 else
1472 vt = get_type_vt(arg->type);
1473 paramflags |= 0x30; /* PARAMFLAG_FHASDEFAULT | PARAMFLAG_FOPT */
1474 chat("default value %ld\n", expr->cval);
1475 write_value(typeinfo->typelib, defaultdata, vt, &expr->cval);
1476 break;
1478 case ATTR_DEFAULTVALUE_STRING:
1480 char *s = (char *)attr->u.pval;
1481 int vt;
1482 if (arg->type->type == RPC_FC_ENUM16)
1483 vt = VT_INT;
1484 else
1485 vt = get_type_vt(arg->type);
1486 paramflags |= 0x30; /* PARAMFLAG_FHASDEFAULT | PARAMFLAG_FOPT */
1487 chat("default value '%s'\n", s);
1488 write_value(typeinfo->typelib, defaultdata, vt, s);
1489 break;
1491 case ATTR_IN:
1492 paramflags |= 0x01; /* PARAMFLAG_FIN */
1493 break;
1494 case ATTR_OPTIONAL:
1495 paramflags |= 0x10; /* PARAMFLAG_FOPT */
1496 break;
1497 case ATTR_OUT:
1498 paramflags |= 0x02; /* PARAMFLAG_FOUT */
1499 break;
1500 case ATTR_RETVAL:
1501 paramflags |= 0x08; /* PARAMFLAG_FRETVAL */
1502 typedata[4] |= 0x4000;
1503 break;
1504 default:
1505 chat("unhandled param attr %d\n", attr->type);
1506 break;
1509 paramdata[1] = -1;
1510 paramdata[2] = paramflags;
1511 typedata[3] += decoded_size << 16;
1512 i++;
1516 if(typeinfo->funcs_allocated == 0) {
1517 typeinfo->funcs_allocated = 10;
1518 typeinfo->func_indices = xmalloc(typeinfo->funcs_allocated * sizeof(int));
1519 typeinfo->func_names = xmalloc(typeinfo->funcs_allocated * sizeof(int));
1520 typeinfo->func_offsets = xmalloc(typeinfo->funcs_allocated * sizeof(int));
1522 if(typeinfo->funcs_allocated == (typeinfo->typeinfo->cElement & 0xffff)) {
1523 typeinfo->funcs_allocated *= 2;
1524 typeinfo->func_indices = xrealloc(typeinfo->func_indices, typeinfo->funcs_allocated * sizeof(int));
1525 typeinfo->func_names = xrealloc(typeinfo->func_names, typeinfo->funcs_allocated * sizeof(int));
1526 typeinfo->func_offsets = xrealloc(typeinfo->func_offsets, typeinfo->funcs_allocated * sizeof(int));
1529 /* update the index data */
1530 typeinfo->func_indices[typeinfo->typeinfo->cElement & 0xffff] = id;
1531 typeinfo->func_offsets[typeinfo->typeinfo->cElement & 0xffff] = offset;
1532 typeinfo->func_names[typeinfo->typeinfo->cElement & 0xffff] = name_offset;
1534 /* ??? */
1535 if (!typeinfo->typeinfo->res2) typeinfo->typeinfo->res2 = 0x20;
1536 typeinfo->typeinfo->res2 <<= 1;
1537 /* ??? */
1538 if (index < 2) typeinfo->typeinfo->res2 += num_params << 4;
1540 if (typeinfo->typeinfo->res3 == -1) typeinfo->typeinfo->res3 = 0;
1541 typeinfo->typeinfo->res3 += 0x38 + num_params * 0x10;
1542 if(num_defaults) typeinfo->typeinfo->res3 += num_params * 0x4;
1544 /* adjust size of VTBL */
1545 if(funckind != 0x3 /* FUNC_STATIC */)
1546 typeinfo->typeinfo->cbSizeVft += 4;
1548 /* Increment the number of function elements */
1549 typeinfo->typeinfo->cElement += 1;
1551 namedata = typeinfo->typelib->typelib_segment_data[MSFT_SEG_NAME] + name_offset;
1552 if (*((INT *)namedata) == -1) {
1553 *((INT *)namedata) = typeinfo->typelib->typelib_typeinfo_offsets[typeinfo->typeinfo->typekind >> 16];
1554 if(typeinfo->typekind == TKIND_MODULE)
1555 namedata[9] |= 0x10;
1556 } else
1557 namedata[9] &= ~0x10;
1559 if(typeinfo->typekind == TKIND_MODULE)
1560 namedata[9] |= 0x20;
1562 if (func->args)
1564 i = 0;
1565 LIST_FOR_EACH_ENTRY( arg, func->args, var_t, entry )
1567 /* don't give the last arg of a [propput*] func a name */
1568 if(i != num_params - 1 || (invokekind != 0x4 /* INVOKE_PROPERTYPUT */ && invokekind != 0x8 /* INVOKE_PROPERTYPUTREF */))
1570 int *paramdata = typedata + 6 + extra_attr + (num_defaults ? num_params : 0) + i * 3;
1571 offset = ctl2_alloc_name(typeinfo->typelib, arg->name);
1572 paramdata[1] = offset;
1574 i++;
1577 return S_OK;
1580 static HRESULT add_var_desc(msft_typeinfo_t *typeinfo, UINT index, var_t* var)
1582 int offset, id;
1583 unsigned int typedata_size;
1584 INT *typedata;
1585 int var_datawidth;
1586 int var_alignment;
1587 int var_type_size, var_kind = 0 /* VAR_PERINSTANCE */;
1588 int alignment;
1589 int varflags = 0;
1590 const attr_t *attr;
1591 char *namedata;
1592 int var_num = (typeinfo->typeinfo->cElement >> 16) & 0xffff;
1594 chat("add_var_desc(%d, %s)\n", index, var->name);
1596 id = 0x40000000 + index;
1598 if (var->attrs) LIST_FOR_EACH_ENTRY( attr, var->attrs, const attr_t, entry ) {
1599 expr_t *expr = attr->u.pval;
1600 switch(attr->type) {
1601 case ATTR_HIDDEN:
1602 varflags |= 0x40; /* VARFLAG_FHIDDEN */
1603 break;
1604 case ATTR_ID:
1605 id = expr->cval;
1606 break;
1607 case ATTR_READONLY:
1608 varflags |= 0x01; /* VARFLAG_FREADONLY */
1609 break;
1610 case ATTR_RESTRICTED:
1611 varflags |= 0x80; /* VARFLAG_FRESTRICTED */
1612 break;
1613 case ATTR_SOURCE:
1614 varflags |= 0x02; /* VARFLAG_FSOURCE */
1615 break;
1616 default:
1617 warning("AddVarDesc: unhandled attr type %d\n", attr->type);
1618 break;
1622 /* allocate type data space for us */
1623 typedata_size = 0x14;
1625 if (!typeinfo->var_data) {
1626 typeinfo->var_data = xmalloc(0x100);
1627 typeinfo->var_data_allocated = 0x100;
1628 typeinfo->var_data[0] = 0;
1631 if(typeinfo->var_data[0] + typedata_size + sizeof(int) > typeinfo->var_data_allocated) {
1632 typeinfo->var_data_allocated = max(typeinfo->var_data_allocated * 2,
1633 typeinfo->var_data[0] + typedata_size + sizeof(int));
1634 typeinfo->var_data = xrealloc(typeinfo->var_data, typeinfo->var_data_allocated);
1637 offset = typeinfo->var_data[0];
1638 typeinfo->var_data[0] += typedata_size;
1639 typedata = typeinfo->var_data + (offset >> 2) + 1;
1641 /* fill out the basic type information */
1642 typedata[0] = typedata_size | (index << 16);
1643 typedata[2] = varflags;
1644 typedata[3] = (36 /*sizeof(VARDESC)*/ << 16) | 0;
1646 if(typeinfo->vars_allocated == 0) {
1647 typeinfo->vars_allocated = 10;
1648 typeinfo->var_indices = xmalloc(typeinfo->vars_allocated * sizeof(int));
1649 typeinfo->var_names = xmalloc(typeinfo->vars_allocated * sizeof(int));
1650 typeinfo->var_offsets = xmalloc(typeinfo->vars_allocated * sizeof(int));
1652 if(typeinfo->vars_allocated == var_num) {
1653 typeinfo->vars_allocated *= 2;
1654 typeinfo->var_indices = xrealloc(typeinfo->var_indices, typeinfo->vars_allocated * sizeof(int));
1655 typeinfo->var_names = xrealloc(typeinfo->var_names, typeinfo->vars_allocated * sizeof(int));
1656 typeinfo->var_offsets = xrealloc(typeinfo->var_offsets, typeinfo->vars_allocated * sizeof(int));
1658 /* update the index data */
1659 typeinfo->var_indices[var_num] = id;
1660 typeinfo->var_names[var_num] = -1;
1661 typeinfo->var_offsets[var_num] = offset;
1663 /* figure out type widths and whatnot */
1664 encode_var(typeinfo->typelib, var->type, var, &typedata[1], &var_datawidth,
1665 &var_alignment, &var_type_size);
1667 /* pad out starting position to data width */
1668 typeinfo->datawidth += var_alignment - 1;
1669 typeinfo->datawidth &= ~(var_alignment - 1);
1671 switch(typeinfo->typekind) {
1672 case TKIND_ENUM:
1673 write_value(typeinfo->typelib, &typedata[4], VT_I4, &var->eval->cval);
1674 var_kind = 2; /* VAR_CONST */
1675 var_type_size += 16; /* sizeof(VARIANT) */
1676 typeinfo->datawidth = var_datawidth;
1677 break;
1678 case TKIND_RECORD:
1679 typedata[4] = typeinfo->datawidth;
1680 typeinfo->datawidth += var_datawidth;
1681 break;
1682 case TKIND_DISPATCH:
1683 var_kind = 3; /* VAR_DISPATCH */
1684 typeinfo->datawidth = 4;
1685 var_alignment = 4;
1686 break;
1687 default:
1688 error("add_var_desc: unhandled type kind %d\n", typeinfo->typekind);
1689 break;
1692 /* add type description size to total required allocation */
1693 typedata[3] += var_type_size << 16 | var_kind;
1695 /* fix type alignment */
1696 alignment = (typeinfo->typeinfo->typekind >> 11) & 0x1f;
1697 if (alignment < var_alignment) {
1698 alignment = var_alignment;
1699 typeinfo->typeinfo->typekind &= ~0xffc0;
1700 typeinfo->typeinfo->typekind |= alignment << 11 | alignment << 6;
1703 /* ??? */
1704 if (!typeinfo->typeinfo->res2) typeinfo->typeinfo->res2 = 0x1a;
1705 if ((index == 0) || (index == 1) || (index == 2) || (index == 4) || (index == 9)) {
1706 typeinfo->typeinfo->res2 <<= 1;
1709 /* ??? */
1710 if (typeinfo->typeinfo->res3 == -1) typeinfo->typeinfo->res3 = 0;
1711 typeinfo->typeinfo->res3 += 0x2c;
1713 /* increment the number of variable elements */
1714 typeinfo->typeinfo->cElement += 0x10000;
1716 /* pad data width to alignment */
1717 typeinfo->typeinfo->size = (typeinfo->datawidth + (alignment - 1)) & ~(alignment - 1);
1719 offset = ctl2_alloc_name(typeinfo->typelib, var->name);
1720 if (offset == -1) return E_OUTOFMEMORY;
1722 namedata = typeinfo->typelib->typelib_segment_data[MSFT_SEG_NAME] + offset;
1723 if (*((INT *)namedata) == -1) {
1724 *((INT *)namedata) = typeinfo->typelib->typelib_typeinfo_offsets[typeinfo->typeinfo->typekind >> 16];
1725 if(typeinfo->typekind != TKIND_DISPATCH)
1726 namedata[9] |= 0x10;
1727 } else
1728 namedata[9] &= ~0x10;
1730 if (typeinfo->typekind == TKIND_ENUM) {
1731 namedata[9] |= 0x20;
1733 typeinfo->var_names[var_num] = offset;
1735 return S_OK;
1738 static HRESULT add_impl_type(msft_typeinfo_t *typeinfo, type_t *ref, importinfo_t *importinfo)
1740 if(importinfo) {
1741 alloc_importinfo(typeinfo->typelib, importinfo);
1742 typeinfo->typeinfo->datatype1 = importinfo->offset+1;
1743 }else {
1744 if(ref->typelib_idx == -1)
1745 add_interface_typeinfo(typeinfo->typelib, ref);
1746 if(ref->typelib_idx == -1)
1747 error("add_impl_type: unable to add inherited interface\n");
1749 typeinfo->typeinfo->datatype1 = typeinfo->typelib->typelib_typeinfo_offsets[ref->typelib_idx];
1752 typeinfo->typeinfo->cImplTypes++;
1753 return S_OK;
1756 static msft_typeinfo_t *create_msft_typeinfo(msft_typelib_t *typelib, enum type_kind kind,
1757 const char *name, const attr_list_t *attrs)
1759 const attr_t *attr;
1760 msft_typeinfo_t *msft_typeinfo;
1761 int nameoffset;
1762 int typeinfo_offset;
1763 MSFT_TypeInfoBase *typeinfo;
1764 MSFT_GuidEntry guidentry;
1766 chat("create_msft_typeinfo: name %s kind %d\n", name, kind);
1768 msft_typeinfo = xmalloc(sizeof(*msft_typeinfo));
1769 memset( msft_typeinfo, 0, sizeof(*msft_typeinfo) );
1771 msft_typeinfo->typelib = typelib;
1773 nameoffset = ctl2_alloc_name(typelib, name);
1774 typeinfo_offset = ctl2_alloc_typeinfo(typelib, nameoffset);
1775 typeinfo = (MSFT_TypeInfoBase *)&typelib->typelib_segment_data[MSFT_SEG_TYPEINFO][typeinfo_offset];
1777 typelib->typelib_segment_data[MSFT_SEG_NAME][nameoffset + 9] = 0x38;
1778 *((int *)&typelib->typelib_segment_data[MSFT_SEG_NAME][nameoffset]) = typeinfo_offset;
1780 msft_typeinfo->typekind = kind;
1781 msft_typeinfo->typeinfo = typeinfo;
1783 typeinfo->typekind |= kind | 0x20;
1785 if(kind == TKIND_COCLASS)
1786 typeinfo->flags |= 0x2; /* TYPEFLAG_FCANCREATE */
1788 if (attrs) LIST_FOR_EACH_ENTRY( attr, attrs, const attr_t, entry ) {
1789 switch(attr->type) {
1790 case ATTR_AGGREGATABLE:
1791 if (kind == TKIND_COCLASS)
1792 typeinfo->flags |= 0x400; /* TYPEFLAG_FAGGREGATABLE */
1793 break;
1795 case ATTR_APPOBJECT:
1796 if (kind == TKIND_COCLASS)
1797 typeinfo->flags |= 0x1; /* TYPEFLAG_FAPPOBJECT */
1798 break;
1800 case ATTR_CONTROL:
1801 if (kind == TKIND_COCLASS)
1802 typeinfo->flags |= 0x20; /* TYPEFLAG_FCONTROL */
1803 break;
1805 case ATTR_DISPINTERFACE:
1806 break;
1808 case ATTR_DLLNAME:
1810 int offset = ctl2_alloc_string(typelib, attr->u.pval);
1811 typeinfo->datatype1 = offset;
1812 break;
1815 case ATTR_DUAL:
1816 /* FIXME: check interface is compatible */
1817 typeinfo->typekind = (typeinfo->typekind & ~0xff) | 0x34;
1818 typeinfo->flags |= 0x140; /* TYPEFLAG_FDUAL | TYPEFLAG_FOLEAUTOMATION */
1819 break;
1821 case ATTR_HELPCONTEXT:
1823 expr_t *expr = (expr_t*)attr->u.pval;
1824 typeinfo->helpcontext = expr->cval;
1825 break;
1827 case ATTR_HELPSTRING:
1829 int offset = ctl2_alloc_string(typelib, attr->u.pval);
1830 if (offset == -1) break;
1831 typeinfo->docstringoffs = offset;
1832 break;
1834 case ATTR_HELPSTRINGCONTEXT:
1836 expr_t *expr = (expr_t*)attr->u.pval;
1837 typeinfo->helpstringcontext = expr->cval;
1838 break;
1840 case ATTR_HIDDEN:
1841 typeinfo->flags |= 0x10; /* TYPEFLAG_FHIDDEN */
1842 break;
1844 case ATTR_NONCREATABLE:
1845 typeinfo->flags &= ~0x2; /* TYPEFLAG_FCANCREATE */
1846 break;
1848 case ATTR_NONEXTENSIBLE:
1849 typeinfo->flags |= 0x80; /* TYPEFLAG_FNONEXTENSIBLE */
1850 break;
1852 case ATTR_OBJECT:
1853 break;
1855 case ATTR_ODL:
1856 break;
1858 case ATTR_OLEAUTOMATION:
1859 typeinfo->flags |= 0x100; /* TYPEFLAG_FOLEAUTOMATION */
1860 break;
1862 case ATTR_PUBLIC:
1863 break;
1865 case ATTR_RESTRICTED:
1866 typeinfo->flags |= 0x200; /* TYPEFLAG_FRESTRICTED */
1867 break;
1869 case ATTR_UUID:
1870 guidentry.guid = *(GUID*)attr->u.pval;
1871 guidentry.hreftype = typelib->typelib_typeinfo_offsets[typeinfo->typekind >> 16];
1872 guidentry.next_hash = -1;
1873 typeinfo->posguid = ctl2_alloc_guid(typelib, &guidentry);
1874 #if 0
1875 if (IsEqualIID(guid, &IID_IDispatch)) {
1876 typelib->typelib_header.dispatchpos = typelib->typelib_typeinfo_offsets[typeinfo->typekind >> 16];
1878 #endif
1879 break;
1881 case ATTR_VERSION:
1882 typeinfo->version = attr->u.ival;
1883 break;
1885 default:
1886 warning("create_msft_typeinfo: ignoring attr %d\n", attr->type);
1887 break;
1891 if (typelib->last_typeinfo) typelib->last_typeinfo->next_typeinfo = msft_typeinfo;
1892 typelib->last_typeinfo = msft_typeinfo;
1893 if (!typelib->typeinfos) typelib->typeinfos = msft_typeinfo;
1896 return msft_typeinfo;
1899 static void add_dispatch(msft_typelib_t *typelib)
1901 int guid_offset, impfile_offset;
1902 MSFT_GuidEntry guidentry;
1903 MSFT_ImpInfo impinfo;
1904 GUID stdole = {0x00020430,0x0000,0x0000,{0xc0,0x00,0x00,0x00,0x00,0x00,0x00,0x46}};
1905 GUID iid_idispatch = {0x00020400,0x0000,0x0000,{0xc0,0x00,0x00,0x00,0x00,0x00,0x00,0x46}};
1907 if(typelib->typelib_header.dispatchpos != -1) return;
1909 guidentry.guid = stdole;
1910 guidentry.hreftype = 2;
1911 guidentry.next_hash = -1;
1912 guid_offset = ctl2_alloc_guid(typelib, &guidentry);
1913 impfile_offset = alloc_importfile(typelib, guid_offset, 2, 0, "stdole2.tlb");
1915 guidentry.guid = iid_idispatch;
1916 guidentry.hreftype = 1;
1917 guidentry.next_hash = -1;
1918 impinfo.flags = TKIND_INTERFACE << 24 | MSFT_IMPINFO_OFFSET_IS_GUID;
1919 impinfo.oImpFile = impfile_offset;
1920 impinfo.oGuid = ctl2_alloc_guid(typelib, &guidentry);
1921 typelib->typelib_header.dispatchpos = alloc_msft_importinfo(typelib, &impinfo) | 0x01;
1924 static void add_dispinterface_typeinfo(msft_typelib_t *typelib, type_t *dispinterface)
1926 int idx = 0;
1927 const func_t *func;
1928 var_t *var;
1929 msft_typeinfo_t *msft_typeinfo;
1931 if (-1 < dispinterface->typelib_idx)
1932 return;
1934 dispinterface->typelib_idx = typelib->typelib_header.nrtypeinfos;
1935 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_DISPATCH, dispinterface->name,
1936 dispinterface->attrs);
1938 msft_typeinfo->typeinfo->size = 4;
1939 msft_typeinfo->typeinfo->typekind |= 0x2100;
1941 msft_typeinfo->typeinfo->flags |= 0x1000; /* TYPEFLAG_FDISPATCHABLE */
1942 add_dispatch(typelib);
1943 msft_typeinfo->typeinfo->cImplTypes = 1;
1945 /* count the no of funcs, as the variable indices come after the funcs */
1946 if (dispinterface->funcs)
1947 LIST_FOR_EACH_ENTRY( func, dispinterface->funcs, const func_t, entry ) idx++;
1949 if (dispinterface->fields)
1950 LIST_FOR_EACH_ENTRY( var, dispinterface->fields, var_t, entry )
1951 add_var_desc(msft_typeinfo, idx++, var);
1953 if (dispinterface->funcs)
1955 idx = 0;
1956 LIST_FOR_EACH_ENTRY( func, dispinterface->funcs, const func_t, entry )
1957 if(add_func_desc(msft_typeinfo, func, idx) == S_OK)
1958 idx++;
1962 static void add_interface_typeinfo(msft_typelib_t *typelib, type_t *interface)
1964 int idx = 0;
1965 const func_t *func;
1966 type_t *ref;
1967 msft_typeinfo_t *msft_typeinfo;
1968 importinfo_t *ref_importinfo = NULL;
1969 int num_parents = 0, num_funcs = 0;
1970 const type_t *derived;
1972 if (-1 < interface->typelib_idx)
1973 return;
1975 if (is_attr(interface->attrs, ATTR_DISPINTERFACE))
1976 return add_dispinterface_typeinfo(typelib, interface);
1978 /* midl adds the parent interface first, unless the parent itself
1979 has no parent (i.e. it stops before IUnknown). */
1981 if(interface->ref) {
1982 ref_importinfo = find_importinfo(typelib, interface->ref->name);
1984 if(!ref_importinfo && interface->ref->ref && interface->ref->typelib_idx == -1)
1985 add_interface_typeinfo(typelib, interface->ref);
1988 interface->typelib_idx = typelib->typelib_header.nrtypeinfos;
1989 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_INTERFACE, interface->name, interface->attrs);
1990 msft_typeinfo->typeinfo->size = 4;
1991 msft_typeinfo->typeinfo->typekind |= 0x2200;
1993 for (derived = interface->ref; derived; derived = derived->ref)
1994 if (derived->name && !strcmp(derived->name, "IDispatch"))
1995 msft_typeinfo->typeinfo->flags |= 0x1000; /* TYPEFLAG_FDISPATCHABLE */
1997 /* can't be dual if it doesn't derive from IDispatch */
1998 if (!(msft_typeinfo->typeinfo->flags & 0x1000)) /* TYPEFLAG_FDISPATCHABLE */
1999 msft_typeinfo->typeinfo->flags &= ~0x40; /* TYPEFLAG_FDUAL */
2001 if(interface->ref)
2002 add_impl_type(msft_typeinfo, interface->ref, ref_importinfo);
2004 /* count the number of inherited interfaces and non-local functions */
2005 for(ref = interface->ref; ref; ref = ref->ref) {
2006 num_parents++;
2007 if (ref->funcs)
2008 LIST_FOR_EACH_ENTRY( func, ref->funcs, const func_t, entry )
2009 if (!is_local(func->def->attrs)) num_funcs++;
2011 msft_typeinfo->typeinfo->datatype2 = num_funcs << 16 | num_parents;
2012 msft_typeinfo->typeinfo->cbSizeVft = num_funcs * 4;
2014 if (interface->funcs)
2015 LIST_FOR_EACH_ENTRY( func, interface->funcs, const func_t, entry )
2016 if(add_func_desc(msft_typeinfo, func, idx) == S_OK)
2017 idx++;
2020 static void add_structure_typeinfo(msft_typelib_t *typelib, type_t *structure)
2022 int idx = 0;
2023 var_t *cur;
2024 msft_typeinfo_t *msft_typeinfo;
2026 if (-1 < structure->typelib_idx)
2027 return;
2029 structure->typelib_idx = typelib->typelib_header.nrtypeinfos;
2030 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_RECORD, structure->name, structure->attrs);
2031 msft_typeinfo->typeinfo->size = 0;
2033 if (structure->fields)
2034 LIST_FOR_EACH_ENTRY( cur, structure->fields, var_t, entry )
2035 add_var_desc(msft_typeinfo, idx++, cur);
2038 static void add_enum_typeinfo(msft_typelib_t *typelib, type_t *enumeration)
2040 int idx = 0;
2041 var_t *cur;
2042 msft_typeinfo_t *msft_typeinfo;
2044 enumeration->typelib_idx = typelib->typelib_header.nrtypeinfos;
2045 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_ENUM, enumeration->name, enumeration->attrs);
2046 msft_typeinfo->typeinfo->size = 0;
2048 if (enumeration->fields)
2049 LIST_FOR_EACH_ENTRY( cur, enumeration->fields, var_t, entry )
2050 add_var_desc(msft_typeinfo, idx++, cur);
2053 static void add_typedef_typeinfo(msft_typelib_t *typelib, type_t *tdef)
2055 msft_typeinfo_t *msft_typeinfo;
2056 int alignment;
2058 if (-1 < tdef->typelib_idx)
2059 return;
2061 tdef->typelib_idx = typelib->typelib_header.nrtypeinfos;
2062 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_ALIAS, tdef->name, tdef->attrs);
2063 encode_type(typelib, get_type_vt(tdef->orig), tdef->orig, &msft_typeinfo->typeinfo->datatype1, &msft_typeinfo->typeinfo->size,
2064 &alignment, &msft_typeinfo->typeinfo->datatype2);
2065 msft_typeinfo->typeinfo->typekind |= (alignment << 11 | alignment << 6);
2068 static void add_coclass_typeinfo(msft_typelib_t *typelib, type_t *cls)
2070 msft_typeinfo_t *msft_typeinfo;
2071 ifref_t *iref;
2072 int num_ifaces = 0, offset, i;
2073 MSFT_RefRecord *ref, *first = NULL, *first_source = NULL;
2074 int have_default = 0, have_default_source = 0;
2075 const attr_t *attr;
2077 if (-1 < cls->typelib_idx)
2078 return;
2080 cls->typelib_idx = typelib->typelib_header.nrtypeinfos;
2081 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_COCLASS, cls->name, cls->attrs);
2083 if (cls->ifaces) LIST_FOR_EACH_ENTRY( iref, cls->ifaces, ifref_t, entry ) num_ifaces++;
2085 offset = msft_typeinfo->typeinfo->datatype1 = ctl2_alloc_segment(typelib, MSFT_SEG_REFERENCES,
2086 num_ifaces * sizeof(*ref), 0);
2088 i = 0;
2089 if (cls->ifaces) LIST_FOR_EACH_ENTRY( iref, cls->ifaces, ifref_t, entry ) {
2090 if(iref->iface->typelib_idx == -1)
2091 add_interface_typeinfo(typelib, iref->iface);
2092 ref = (MSFT_RefRecord*) (typelib->typelib_segment_data[MSFT_SEG_REFERENCES] + offset + i * sizeof(*ref));
2093 ref->reftype = typelib->typelib_typeinfo_offsets[iref->iface->typelib_idx];
2094 ref->flags = 0;
2095 ref->oCustData = -1;
2096 ref->onext = -1;
2097 if(i < num_ifaces - 1)
2098 ref->onext = offset + (i + 1) * sizeof(*ref);
2100 if (iref->attrs) LIST_FOR_EACH_ENTRY( attr, iref->attrs, const attr_t, entry ) {
2101 switch(attr->type) {
2102 case ATTR_DEFAULT:
2103 ref->flags |= 0x1; /* IMPLTYPEFLAG_FDEFAULT */
2104 break;
2105 case ATTR_RESTRICTED:
2106 ref->flags |= 0x4; /* IMPLTYPEFLAG_FRESTRICTED */
2107 break;
2108 case ATTR_SOURCE:
2109 ref->flags |= 0x2; /* IMPLTYPEFLAG_FSOURCE */
2110 break;
2111 default:
2112 warning("add_coclass_typeinfo: unhandled attr %d\n", attr->type);
2115 if(ref->flags & 0x1) { /* IMPLTYPEFLAG_FDEFAULT */
2116 if(ref->flags & 0x2) /* IMPLTYPEFLAG_SOURCE */
2117 have_default_source = 1;
2118 else
2119 have_default = 1;
2122 /* If the interface is non-restricted and we haven't already had one then
2123 remember it so that we can use it as a default later */
2124 if((ref->flags & 0x4) == 0) { /* IMPLTYPEFLAG_FRESTRICTED */
2125 if(ref->flags & 0x2) { /* IMPLTYPEFLAG_FSOURCE */
2126 if(!first_source)
2127 first_source = ref;
2129 else if(!first)
2130 first = ref;
2132 i++;
2135 /* If we haven't had a default interface, then set the default flags on the
2136 first ones */
2137 if(!have_default && first)
2138 first->flags |= 0x1;
2139 if(!have_default_source && first_source)
2140 first_source->flags |= 0x1;
2142 msft_typeinfo->typeinfo->cImplTypes = num_ifaces;
2143 msft_typeinfo->typeinfo->size = 4;
2144 msft_typeinfo->typeinfo->typekind |= 0x2200;
2147 static void add_module_typeinfo(msft_typelib_t *typelib, type_t *module)
2149 int idx = 0;
2150 const func_t *func;
2151 msft_typeinfo_t *msft_typeinfo;
2153 if (-1 < module->typelib_idx)
2154 return;
2156 module->typelib_idx = typelib->typelib_header.nrtypeinfos;
2157 msft_typeinfo = create_msft_typeinfo(typelib, TKIND_MODULE, module->name, module->attrs);
2158 msft_typeinfo->typeinfo->typekind |= 0x0a00;
2160 if (module->funcs)
2161 LIST_FOR_EACH_ENTRY( func, module->funcs, const func_t, entry )
2162 if(add_func_desc(msft_typeinfo, func, idx) == S_OK)
2163 idx++;
2165 msft_typeinfo->typeinfo->size = idx;
2168 static void add_entry(msft_typelib_t *typelib, typelib_entry_t *entry)
2170 switch(entry->type->kind) {
2171 case TKIND_INTERFACE:
2172 case TKIND_DISPATCH:
2173 add_interface_typeinfo(typelib, entry->type);
2174 break;
2176 case TKIND_RECORD:
2177 add_structure_typeinfo(typelib, entry->type);
2178 break;
2180 case TKIND_ENUM:
2181 add_enum_typeinfo(typelib, entry->type);
2182 break;
2184 case TKIND_ALIAS:
2185 add_typedef_typeinfo(typelib, entry->type);
2186 break;
2188 case TKIND_COCLASS:
2189 add_coclass_typeinfo(typelib, entry->type);
2190 break;
2192 case TKIND_MODULE:
2193 add_module_typeinfo(typelib, entry->type);
2194 break;
2196 default:
2197 error("add_entry: unhandled type %d\n", entry->type->kind);
2198 break;
2202 static void set_name(msft_typelib_t *typelib)
2204 int offset;
2206 offset = ctl2_alloc_name(typelib, typelib->typelib->name);
2207 if (offset == -1) return;
2208 typelib->typelib_header.NameOffset = offset;
2209 return;
2212 static void set_version(msft_typelib_t *typelib)
2214 typelib->typelib_header.version = get_attrv( typelib->typelib->attrs, ATTR_VERSION );
2217 static void set_guid(msft_typelib_t *typelib)
2219 MSFT_GuidEntry guidentry;
2220 int offset;
2221 void *ptr;
2222 GUID guid = {0,0,0,{0,0,0,0,0,0}};
2224 guidentry.guid = guid;
2225 guidentry.hreftype = -2;
2226 guidentry.next_hash = -1;
2228 ptr = get_attrp( typelib->typelib->attrs, ATTR_UUID );
2229 if (ptr) guidentry.guid = *(GUID *)ptr;
2231 offset = ctl2_alloc_guid(typelib, &guidentry);
2232 typelib->typelib_header.posguid = offset;
2234 return;
2237 static void set_doc_string(msft_typelib_t *typelib)
2239 char *str = get_attrp( typelib->typelib->attrs, ATTR_HELPSTRING );
2241 if (str)
2243 int offset = ctl2_alloc_string(typelib, str);
2244 if (offset != -1) typelib->typelib_header.helpstring = offset;
2248 static void set_help_file_name(msft_typelib_t *typelib)
2250 char *str = get_attrp( typelib->typelib->attrs, ATTR_HELPFILE );
2252 if (str)
2254 int offset = ctl2_alloc_string(typelib, str);
2255 if (offset != -1)
2257 typelib->typelib_header.helpfile = offset;
2258 typelib->typelib_header.varflags |= 0x10;
2263 static void set_help_context(msft_typelib_t *typelib)
2265 const expr_t *expr = get_attrp( typelib->typelib->attrs, ATTR_HELPCONTEXT );
2266 if (expr) typelib->typelib_header.helpcontext = expr->cval;
2269 static void set_help_string_dll(msft_typelib_t *typelib)
2271 char *str = get_attrp( typelib->typelib->attrs, ATTR_HELPSTRINGDLL );
2273 if (str)
2275 int offset = ctl2_alloc_string(typelib, str);
2276 if (offset != -1)
2278 typelib->help_string_dll_offset = offset;
2279 typelib->typelib_header.varflags |= 0x100;
2284 static void set_help_string_context(msft_typelib_t *typelib)
2286 const expr_t *expr = get_attrp( typelib->typelib->attrs, ATTR_HELPSTRINGCONTEXT );
2287 if (expr) typelib->typelib_header.helpstringcontext = expr->cval;
2290 static void set_lcid(msft_typelib_t *typelib)
2292 typelib->typelib_header.lcid2 = 0x0;
2293 return;
2296 static void set_lib_flags(msft_typelib_t *typelib)
2298 const attr_t *attr;
2300 typelib->typelib_header.flags = 0;
2301 if (!typelib->typelib->attrs) return;
2302 LIST_FOR_EACH_ENTRY( attr, typelib->typelib->attrs, const attr_t, entry )
2304 switch(attr->type) {
2305 case ATTR_CONTROL:
2306 typelib->typelib_header.flags |= 0x02; /* LIBFLAG_FCONTROL */
2307 break;
2308 case ATTR_HIDDEN:
2309 typelib->typelib_header.flags |= 0x04; /* LIBFLAG_FHIDDEN */
2310 break;
2311 case ATTR_RESTRICTED:
2312 typelib->typelib_header.flags |= 0x01; /* LIBFLAG_FRESTRICTED */
2313 break;
2314 default:
2315 break;
2318 return;
2321 static int ctl2_write_chunk(int fd, void *segment, int length)
2323 if (write(fd, segment, length) != length) {
2324 close(fd);
2325 return 0;
2327 return -1;
2330 static int ctl2_write_segment(msft_typelib_t *typelib, int fd, int segment)
2332 if (write(fd, typelib->typelib_segment_data[segment], typelib->typelib_segdir[segment].length)
2333 != typelib->typelib_segdir[segment].length) {
2334 close(fd);
2335 return 0;
2338 return -1;
2341 static void ctl2_finalize_typeinfos(msft_typelib_t *typelib, int filesize)
2343 msft_typeinfo_t *typeinfo;
2345 for (typeinfo = typelib->typeinfos; typeinfo; typeinfo = typeinfo->next_typeinfo) {
2346 typeinfo->typeinfo->memoffset = filesize;
2347 if (typeinfo->func_data)
2348 filesize += typeinfo->func_data[0] + ((typeinfo->typeinfo->cElement & 0xffff) * 12);
2349 if (typeinfo->var_data)
2350 filesize += typeinfo->var_data[0] + (((typeinfo->typeinfo->cElement >> 16) & 0xffff) * 12);
2351 if (typeinfo->func_data || typeinfo->var_data)
2352 filesize += 4;
2356 static int ctl2_finalize_segment(msft_typelib_t *typelib, int filepos, int segment)
2358 if (typelib->typelib_segdir[segment].length) {
2359 typelib->typelib_segdir[segment].offset = filepos;
2360 } else {
2361 typelib->typelib_segdir[segment].offset = -1;
2364 return typelib->typelib_segdir[segment].length;
2368 static void ctl2_write_typeinfos(msft_typelib_t *typelib, int fd)
2370 msft_typeinfo_t *typeinfo;
2371 int typedata_size;
2373 for (typeinfo = typelib->typeinfos; typeinfo; typeinfo = typeinfo->next_typeinfo) {
2374 if (!typeinfo->func_data && !typeinfo->var_data) continue;
2375 typedata_size = 0;
2376 if (typeinfo->func_data)
2377 typedata_size = typeinfo->func_data[0];
2378 if (typeinfo->var_data)
2379 typedata_size += typeinfo->var_data[0];
2380 ctl2_write_chunk(fd, &typedata_size, sizeof(int));
2381 if (typeinfo->func_data)
2382 ctl2_write_chunk(fd, typeinfo->func_data + 1, typeinfo->func_data[0]);
2383 if (typeinfo->var_data)
2384 ctl2_write_chunk(fd, typeinfo->var_data + 1, typeinfo->var_data[0]);
2385 if (typeinfo->func_indices)
2386 ctl2_write_chunk(fd, typeinfo->func_indices, (typeinfo->typeinfo->cElement & 0xffff) * 4);
2387 if (typeinfo->var_indices)
2388 ctl2_write_chunk(fd, typeinfo->var_indices, (typeinfo->typeinfo->cElement >> 16) * 4);
2389 if (typeinfo->func_names)
2390 ctl2_write_chunk(fd, typeinfo->func_names, (typeinfo->typeinfo->cElement & 0xffff) * 4);
2391 if (typeinfo->var_names)
2392 ctl2_write_chunk(fd, typeinfo->var_names, (typeinfo->typeinfo->cElement >> 16) * 4);
2393 if (typeinfo->func_offsets)
2394 ctl2_write_chunk(fd, typeinfo->func_offsets, (typeinfo->typeinfo->cElement & 0xffff) * 4);
2395 if (typeinfo->var_offsets) {
2396 int add = 0, i, offset;
2397 if(typeinfo->func_data)
2398 add = typeinfo->func_data[0];
2399 for(i = 0; i < (typeinfo->typeinfo->cElement >> 16); i++) {
2400 offset = typeinfo->var_offsets[i];
2401 offset += add;
2402 ctl2_write_chunk(fd, &offset, 4);
2408 static int save_all_changes(msft_typelib_t *typelib)
2410 int retval;
2411 int filepos;
2412 int fd;
2414 chat("save_all_changes(%p)\n", typelib);
2416 retval = TYPE_E_IOERROR;
2418 fd = creat(typelib->typelib->filename, 0666);
2419 if (fd == -1) return retval;
2421 filepos = sizeof(MSFT_Header) + sizeof(MSFT_SegDir);
2422 if(typelib->typelib_header.varflags & 0x100) filepos += 4; /* helpstringdll */
2423 filepos += typelib->typelib_header.nrtypeinfos * 4;
2425 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_TYPEINFO);
2426 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_GUIDHASH);
2427 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_GUID);
2428 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_REFERENCES);
2429 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_IMPORTINFO);
2430 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_IMPORTFILES);
2431 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_NAMEHASH);
2432 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_NAME);
2433 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_STRING);
2434 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_TYPEDESC);
2435 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_ARRAYDESC);
2436 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_CUSTDATA);
2437 filepos += ctl2_finalize_segment(typelib, filepos, MSFT_SEG_CUSTDATAGUID);
2439 ctl2_finalize_typeinfos(typelib, filepos);
2441 if (!ctl2_write_chunk(fd, &typelib->typelib_header, sizeof(typelib->typelib_header))) return retval;
2442 if(typelib->typelib_header.varflags & 0x100)
2443 if (!ctl2_write_chunk(fd, &typelib->help_string_dll_offset, sizeof(typelib->help_string_dll_offset)))
2444 return retval;
2446 if (!ctl2_write_chunk(fd, typelib->typelib_typeinfo_offsets, typelib->typelib_header.nrtypeinfos * 4)) return retval;
2447 if (!ctl2_write_chunk(fd, &typelib->typelib_segdir, sizeof(typelib->typelib_segdir))) return retval;
2448 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_TYPEINFO )) return retval;
2449 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_GUIDHASH )) return retval;
2450 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_GUID )) return retval;
2451 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_REFERENCES )) return retval;
2452 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_IMPORTINFO )) return retval;
2453 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_IMPORTFILES )) return retval;
2454 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_NAMEHASH )) return retval;
2455 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_NAME )) return retval;
2456 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_STRING )) return retval;
2457 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_TYPEDESC )) return retval;
2458 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_ARRAYDESC )) return retval;
2459 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_CUSTDATA )) return retval;
2460 if (!ctl2_write_segment(typelib, fd, MSFT_SEG_CUSTDATAGUID)) return retval;
2462 ctl2_write_typeinfos(typelib, fd);
2464 if (close(fd) == -1) return retval;
2466 retval = S_OK;
2467 return retval;
2470 int create_msft_typelib(typelib_t *typelib)
2472 msft_typelib_t *msft;
2473 int failed = 0;
2474 typelib_entry_t *entry;
2475 time_t cur_time;
2476 char *time_override;
2477 unsigned int version = 5 << 24 | 1 << 16 | 164; /* 5.01.0164 */
2478 GUID midl_time_guid = {0xde77ba63,0x517c,0x11d1,{0xa2,0xda,0x00,0x00,0xf8,0x77,0x3c,0xe9}};
2479 GUID midl_version_guid = {0xde77ba64,0x517c,0x11d1,{0xa2,0xda,0x00,0x00,0xf8,0x77,0x3c,0xe9}};
2481 msft = xmalloc(sizeof(*msft));
2482 memset(msft, 0, sizeof(*msft));
2483 msft->typelib = typelib;
2485 ctl2_init_header(msft);
2486 ctl2_init_segdir(msft);
2488 msft->typelib_header.varflags |= SYS_WIN32;
2491 * The following two calls return an offset or -1 if out of memory. We
2492 * specifically need an offset of 0, however, so...
2494 if (ctl2_alloc_segment(msft, MSFT_SEG_GUIDHASH, 0x80, 0x80)) { failed = 1; }
2495 if (ctl2_alloc_segment(msft, MSFT_SEG_NAMEHASH, 0x200, 0x200)) { failed = 1; }
2497 if(failed)
2499 free(msft);
2500 return 0;
2503 msft->typelib_guidhash_segment = (int *)msft->typelib_segment_data[MSFT_SEG_GUIDHASH];
2504 msft->typelib_namehash_segment = (int *)msft->typelib_segment_data[MSFT_SEG_NAMEHASH];
2506 memset(msft->typelib_guidhash_segment, 0xff, 0x80);
2507 memset(msft->typelib_namehash_segment, 0xff, 0x200);
2509 set_lib_flags(msft);
2510 set_lcid(msft);
2511 set_help_file_name(msft);
2512 set_doc_string(msft);
2513 set_guid(msft);
2514 set_version(msft);
2515 set_name(msft);
2516 set_help_context(msft);
2517 set_help_string_dll(msft);
2518 set_help_string_context(msft);
2520 /* midl adds two sets of custom data to the library: the current unix time
2521 and midl's version number */
2522 time_override = getenv( "WIDL_TIME_OVERRIDE");
2523 cur_time = time_override ? atol( time_override) : time(NULL);
2524 set_custdata(msft, &midl_time_guid, VT_UI4, &cur_time, &msft->typelib_header.CustomDataOffset);
2525 set_custdata(msft, &midl_version_guid, VT_UI4, &version, &msft->typelib_header.CustomDataOffset);
2527 LIST_FOR_EACH_ENTRY( entry, &typelib->entries, typelib_entry_t, entry )
2528 add_entry(msft, entry);
2530 save_all_changes(msft);
2531 free(msft);
2532 return 1;