wnaspi32: Make winaspi.dll into a stand-alone 16-bit module.
[wine] / tools / widl / header.c
1 /*
2  * IDL Compiler
3  *
4  * Copyright 2002 Ove Kaaven
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include "config.h"
22
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #ifdef HAVE_UNISTD_H
27 # include <unistd.h>
28 #endif
29 #include <string.h>
30 #include <ctype.h>
31
32 #include "widl.h"
33 #include "utils.h"
34 #include "parser.h"
35 #include "header.h"
36 #include "expr.h"
37 #include "typetree.h"
38
39 typedef struct _user_type_t generic_handle_t;
40
41 static int indentation = 0;
42 user_type_list_t user_type_list = LIST_INIT(user_type_list);
43 static context_handle_list_t context_handle_list = LIST_INIT(context_handle_list);
44 static struct list generic_handle_list = LIST_INIT(generic_handle_list);
45
46 static void indent(FILE *h, int delta)
47 {
48   int c;
49   if (delta < 0) indentation += delta;
50   for (c=0; c<indentation; c++) fprintf(h, "    ");
51   if (delta > 0) indentation += delta;
52 }
53
54 int is_ptrchain_attr(const var_t *var, enum attr_type t)
55 {
56     if (is_attr(var->attrs, t))
57         return 1;
58     else
59     {
60         type_t *type = var->type;
61         for (;;)
62         {
63             if (is_attr(type->attrs, t))
64                 return 1;
65             else if (type_is_alias(type))
66                 type = type_alias_get_aliasee(type);
67             else if (is_ptr(type))
68                 type = type_pointer_get_ref(type);
69             else return 0;
70         }
71     }
72 }
73
74 int is_aliaschain_attr(const type_t *type, enum attr_type attr)
75 {
76     const type_t *t = type;
77     for (;;)
78     {
79         if (is_attr(t->attrs, attr))
80             return 1;
81         else if (type_is_alias(t))
82             t = type_alias_get_aliasee(t);
83         else return 0;
84     }
85 }
86
87 int is_attr(const attr_list_t *list, enum attr_type t)
88 {
89     const attr_t *attr;
90     if (list) LIST_FOR_EACH_ENTRY( attr, list, const attr_t, entry )
91         if (attr->type == t) return 1;
92     return 0;
93 }
94
95 void *get_attrp(const attr_list_t *list, enum attr_type t)
96 {
97     const attr_t *attr;
98     if (list) LIST_FOR_EACH_ENTRY( attr, list, const attr_t, entry )
99         if (attr->type == t) return attr->u.pval;
100     return NULL;
101 }
102
103 unsigned long get_attrv(const attr_list_t *list, enum attr_type t)
104 {
105     const attr_t *attr;
106     if (list) LIST_FOR_EACH_ENTRY( attr, list, const attr_t, entry )
107         if (attr->type == t) return attr->u.ival;
108     return 0;
109 }
110
111 int is_void(const type_t *t)
112 {
113     return type_get_type(t) == TYPE_VOID;
114 }
115
116 int is_conformant_array(const type_t *t)
117 {
118     return is_array(t) && type_array_has_conformance(t);
119 }
120
121 void write_guid(FILE *f, const char *guid_prefix, const char *name, const UUID *uuid)
122 {
123   if (!uuid) return;
124   fprintf(f, "DEFINE_GUID(%s_%s, 0x%08x, 0x%04x, 0x%04x, 0x%02x,0x%02x, 0x%02x,"
125         "0x%02x,0x%02x,0x%02x,0x%02x,0x%02x);\n",
126         guid_prefix, name, uuid->Data1, uuid->Data2, uuid->Data3, uuid->Data4[0],
127         uuid->Data4[1], uuid->Data4[2], uuid->Data4[3], uuid->Data4[4], uuid->Data4[5],
128         uuid->Data4[6], uuid->Data4[7]);
129 }
130
131 const char *get_name(const var_t *v)
132 {
133     static char buffer[256];
134
135     if (is_attr( v->attrs, ATTR_PROPGET ))
136         strcpy( buffer, "get_" );
137     else if (is_attr( v->attrs, ATTR_PROPPUT ))
138         strcpy( buffer, "put_" );
139     else if (is_attr( v->attrs, ATTR_PROPPUTREF ))
140         strcpy( buffer, "putref_" );
141     else
142         buffer[0] = 0;
143     strcat( buffer, v->name );
144     return buffer;
145 }
146
147 static void write_field(FILE *h, var_t *v)
148 {
149   if (!v) return;
150   if (v->type) {
151     indent(h, 0);
152     write_type_def_or_decl(h, v->type, TRUE, v->name);
153     fprintf(h, ";\n");
154   }
155 }
156
157 static void write_fields(FILE *h, var_list_t *fields)
158 {
159     var_t *v;
160     if (!fields) return;
161     LIST_FOR_EACH_ENTRY( v, fields, var_t, entry ) write_field(h, v);
162 }
163
164 static void write_enums(FILE *h, var_list_t *enums)
165 {
166   var_t *v;
167   if (!enums) return;
168   LIST_FOR_EACH_ENTRY( v, enums, var_t, entry )
169   {
170     if (v->name) {
171       indent(h, 0);
172       fprintf(h, "%s", get_name(v));
173       if (v->eval) {
174         fprintf(h, " = ");
175         write_expr(h, v->eval, 0, 1, NULL, NULL, "");
176       }
177     }
178     if (list_next( enums, &v->entry )) fprintf(h, ",\n");
179   }
180   fprintf(h, "\n");
181 }
182
183 int needs_space_after(type_t *t)
184 {
185   return (type_is_alias(t) ||
186           (!is_ptr(t) && (!is_array(t) || !type_array_is_decl_as_ptr(t) || t->name)));
187 }
188
189 void write_type_left(FILE *h, type_t *t, int declonly)
190 {
191   if (!h) return;
192
193   if (is_attr(t->attrs, ATTR_CONST) &&
194       (type_is_alias(t) || !is_ptr(t)))
195     fprintf(h, "const ");
196
197   if (type_is_alias(t)) fprintf(h, "%s", t->name);
198   else {
199     switch (type_get_type_detect_alias(t)) {
200       case TYPE_ENUM:
201         if (!declonly && t->defined && !t->written) {
202           if (t->name) fprintf(h, "enum %s {\n", t->name);
203           else fprintf(h, "enum {\n");
204           t->written = TRUE;
205           indentation++;
206           write_enums(h, type_enum_get_values(t));
207           indent(h, -1);
208           fprintf(h, "}");
209         }
210         else fprintf(h, "enum %s", t->name ? t->name : "");
211         break;
212       case TYPE_STRUCT:
213       case TYPE_ENCAPSULATED_UNION:
214         if (!declonly && t->defined && !t->written) {
215           if (t->name) fprintf(h, "struct %s {\n", t->name);
216           else fprintf(h, "struct {\n");
217           t->written = TRUE;
218           indentation++;
219           if (type_get_type(t) != TYPE_STRUCT)
220             write_fields(h, type_encapsulated_union_get_fields(t));
221           else
222             write_fields(h, type_struct_get_fields(t));
223           indent(h, -1);
224           fprintf(h, "}");
225         }
226         else fprintf(h, "struct %s", t->name ? t->name : "");
227         break;
228       case TYPE_UNION:
229         if (!declonly && t->defined && !t->written) {
230           if (t->name) fprintf(h, "union %s {\n", t->name);
231           else fprintf(h, "union {\n");
232           t->written = TRUE;
233           indentation++;
234           write_fields(h, type_union_get_cases(t));
235           indent(h, -1);
236           fprintf(h, "}");
237         }
238         else fprintf(h, "union %s", t->name ? t->name : "");
239         break;
240       case TYPE_POINTER:
241         write_type_left(h, type_pointer_get_ref(t), declonly);
242         fprintf(h, "%s*", needs_space_after(type_pointer_get_ref(t)) ? " " : "");
243         if (is_attr(t->attrs, ATTR_CONST)) fprintf(h, "const ");
244         break;
245       case TYPE_ARRAY:
246         if (t->name && type_array_is_decl_as_ptr(t))
247           fprintf(h, "%s", t->name);
248         else
249         {
250           write_type_left(h, type_array_get_element(t), declonly);
251           if (type_array_is_decl_as_ptr(t))
252             fprintf(h, "%s*", needs_space_after(type_array_get_element(t)) ? " " : "");
253         }
254         break;
255       case TYPE_BASIC:
256         if (type_basic_get_type(t) != TYPE_BASIC_INT32 &&
257             type_basic_get_type(t) != TYPE_BASIC_HYPER)
258         {
259           if (type_basic_get_sign(t) < 0) fprintf(h, "signed ");
260           else if (type_basic_get_sign(t) > 0) fprintf(h, "unsigned ");
261         }
262         switch (type_basic_get_type(t))
263         {
264         case TYPE_BASIC_INT8: fprintf(h, "small"); break;
265         case TYPE_BASIC_INT16: fprintf(h, "short"); break;
266         case TYPE_BASIC_INT: fprintf(h, "int"); break;
267         case TYPE_BASIC_INT64: fprintf(h, "__int64"); break;
268         case TYPE_BASIC_BYTE: fprintf(h, "byte"); break;
269         case TYPE_BASIC_CHAR: fprintf(h, "char"); break;
270         case TYPE_BASIC_WCHAR: fprintf(h, "wchar_t"); break;
271         case TYPE_BASIC_FLOAT: fprintf(h, "float"); break;
272         case TYPE_BASIC_DOUBLE: fprintf(h, "double"); break;
273         case TYPE_BASIC_ERROR_STATUS_T: fprintf(h, "error_status_t"); break;
274         case TYPE_BASIC_HANDLE: fprintf(h, "handle_t"); break;
275         case TYPE_BASIC_INT32:
276           if (type_basic_get_sign(t) > 0)
277             fprintf(h, "ULONG");
278           else
279             fprintf(h, "LONG");
280           break;
281         case TYPE_BASIC_HYPER:
282           if (type_basic_get_sign(t) > 0)
283             fprintf(h, "MIDL_uhyper");
284           else
285             fprintf(h, "hyper");
286           break;
287         }
288         break;
289       case TYPE_INTERFACE:
290       case TYPE_MODULE:
291       case TYPE_COCLASS:
292         fprintf(h, "%s", t->name);
293         break;
294       case TYPE_VOID:
295         fprintf(h, "void");
296         break;
297       case TYPE_ALIAS:
298       case TYPE_FUNCTION:
299         /* handled elsewhere */
300         assert(0);
301         break;
302     }
303   }
304 }
305
306 void write_type_right(FILE *h, type_t *t, int is_field)
307 {
308   if (!h) return;
309
310   if (type_get_type(t) == TYPE_ARRAY && !type_array_is_decl_as_ptr(t)) {
311     if (is_conformant_array(t)) {
312       fprintf(h, "[%s]", is_field ? "1" : "");
313       t = type_array_get_element(t);
314     }
315     for ( ;
316          type_get_type(t) == TYPE_ARRAY && !type_array_is_decl_as_ptr(t);
317          t = type_array_get_element(t))
318       fprintf(h, "[%u]", type_array_get_dim(t));
319   }
320 }
321
322 static void write_type_v(FILE *h, type_t *t, int is_field, int declonly, const char *name)
323 {
324   type_t *pt;
325   int ptr_level = 0;
326
327   if (!h) return;
328
329   for (pt = t; is_ptr(pt); pt = type_pointer_get_ref(pt), ptr_level++)
330     ;
331
332   if (type_get_type_detect_alias(pt) == TYPE_FUNCTION) {
333     int i;
334     const char *callconv = get_attrp(pt->attrs, ATTR_CALLCONV);
335     if (!callconv) callconv = "";
336     if (is_attr(pt->attrs, ATTR_INLINE)) fprintf(h, "inline ");
337     write_type_left(h, type_function_get_rettype(pt), declonly);
338     fputc(' ', h);
339     if (ptr_level) fputc('(', h);
340     fprintf(h, "%s ", callconv);
341     for (i = 0; i < ptr_level; i++)
342       fputc('*', h);
343   } else
344     write_type_left(h, t, declonly);
345
346   if (name) fprintf(h, "%s%s", needs_space_after(t) ? " " : "", name );
347
348   if (type_get_type_detect_alias(pt) == TYPE_FUNCTION) {
349     if (ptr_level) fputc(')', h);
350     fputc('(', h);
351     write_args(h, type_function_get_args(pt), NULL, 0, FALSE);
352     fputc(')', h);
353   } else
354     write_type_right(h, t, is_field);
355 }
356
357 void write_type_def_or_decl(FILE *f, type_t *t, int field, const char *name)
358 {
359   write_type_v(f, t, field, FALSE, name);
360 }
361
362 void write_type_decl(FILE *f, type_t *t, const char *name)
363 {
364   write_type_v(f, t, FALSE, TRUE, name);
365 }
366
367 void write_type_decl_left(FILE *f, type_t *t)
368 {
369   write_type_left(f, t, TRUE);
370 }
371
372 static int user_type_registered(const char *name)
373 {
374   user_type_t *ut;
375   LIST_FOR_EACH_ENTRY(ut, &user_type_list, user_type_t, entry)
376     if (!strcmp(name, ut->name))
377       return 1;
378   return 0;
379 }
380
381 static int context_handle_registered(const char *name)
382 {
383   context_handle_t *ch;
384   LIST_FOR_EACH_ENTRY(ch, &context_handle_list, context_handle_t, entry)
385     if (!strcmp(name, ch->name))
386       return 1;
387   return 0;
388 }
389
390 static int generic_handle_registered(const char *name)
391 {
392   generic_handle_t *gh;
393   LIST_FOR_EACH_ENTRY(gh, &generic_handle_list, generic_handle_t, entry)
394     if (!strcmp(name, gh->name))
395       return 1;
396   return 0;
397 }
398
399 /* check for types which require additional prototypes to be generated in the
400  * header */
401 void check_for_additional_prototype_types(const var_list_t *list)
402 {
403   const var_t *v;
404
405   if (!list) return;
406   LIST_FOR_EACH_ENTRY( v, list, const var_t, entry )
407   {
408     type_t *type = v->type;
409     if (!type) continue;
410     for (;;) {
411       const char *name = type->name;
412       if (type->user_types_registered) break;
413       type->user_types_registered = 1;
414       if (is_attr(type->attrs, ATTR_CONTEXTHANDLE)) {
415         if (!context_handle_registered(name))
416         {
417           context_handle_t *ch = xmalloc(sizeof(*ch));
418           ch->name = xstrdup(name);
419           list_add_tail(&context_handle_list, &ch->entry);
420         }
421         /* don't carry on parsing fields within this type */
422         break;
423       }
424       if ((type_get_type(type) != TYPE_BASIC ||
425            type_basic_get_type(type) != TYPE_BASIC_HANDLE) &&
426           is_attr(type->attrs, ATTR_HANDLE)) {
427         if (!generic_handle_registered(name))
428         {
429           generic_handle_t *gh = xmalloc(sizeof(*gh));
430           gh->name = xstrdup(name);
431           list_add_tail(&generic_handle_list, &gh->entry);
432         }
433         /* don't carry on parsing fields within this type */
434         break;
435       }
436       if (is_attr(type->attrs, ATTR_WIREMARSHAL)) {
437         if (!user_type_registered(name))
438         {
439           user_type_t *ut = xmalloc(sizeof *ut);
440           ut->name = xstrdup(name);
441           list_add_tail(&user_type_list, &ut->entry);
442         }
443         /* don't carry on parsing fields within this type as we are already
444          * using a wire marshaled type */
445         break;
446       }
447       else if (type_is_complete(type))
448       {
449         var_list_t *vars;
450         switch (type_get_type_detect_alias(type))
451         {
452         case TYPE_ENUM:
453           vars = type_enum_get_values(type);
454           break;
455         case TYPE_STRUCT:
456           vars = type_struct_get_fields(type);
457           break;
458         case TYPE_UNION:
459           vars = type_union_get_cases(type);
460           break;
461         default:
462           vars = NULL;
463           break;
464         }
465         check_for_additional_prototype_types(vars);
466       }
467
468       if (type_is_alias(type))
469         type = type_alias_get_aliasee(type);
470       else if (is_ptr(type))
471         type = type_pointer_get_ref(type);
472       else if (is_array(type))
473         type = type_array_get_element(type);
474       else
475         break;
476     }
477   }
478 }
479
480 static void write_user_types(FILE *header)
481 {
482   user_type_t *ut;
483   LIST_FOR_EACH_ENTRY(ut, &user_type_list, user_type_t, entry)
484   {
485     const char *name = ut->name;
486     fprintf(header, "ULONG           __RPC_USER %s_UserSize     (ULONG *, ULONG, %s *);\n", name, name);
487     fprintf(header, "unsigned char * __RPC_USER %s_UserMarshal  (ULONG *, unsigned char *, %s *);\n", name, name);
488     fprintf(header, "unsigned char * __RPC_USER %s_UserUnmarshal(ULONG *, unsigned char *, %s *);\n", name, name);
489     fprintf(header, "void            __RPC_USER %s_UserFree     (ULONG *, %s *);\n", name, name);
490   }
491 }
492
493 static void write_context_handle_rundowns(FILE *header)
494 {
495   context_handle_t *ch;
496   LIST_FOR_EACH_ENTRY(ch, &context_handle_list, context_handle_t, entry)
497   {
498     const char *name = ch->name;
499     fprintf(header, "void __RPC_USER %s_rundown(%s);\n", name, name);
500   }
501 }
502
503 static void write_generic_handle_routines(FILE *header)
504 {
505   generic_handle_t *gh;
506   LIST_FOR_EACH_ENTRY(gh, &generic_handle_list, generic_handle_t, entry)
507   {
508     const char *name = gh->name;
509     fprintf(header, "handle_t __RPC_USER %s_bind(%s);\n", name, name);
510     fprintf(header, "void __RPC_USER %s_unbind(%s, handle_t);\n", name, name);
511   }
512 }
513
514 static void write_typedef(FILE *header, type_t *type)
515 {
516   fprintf(header, "typedef ");
517   write_type_def_or_decl(header, type_alias_get_aliasee(type), FALSE, type->name);
518   fprintf(header, ";\n");
519 }
520
521 int is_const_decl(const var_t *var)
522 {
523   const type_t *t;
524   /* strangely, MIDL accepts a const attribute on any pointer in the
525   * declaration to mean that data isn't being instantiated. this appears
526   * to be a bug, but there is no benefit to being incompatible with MIDL,
527   * so we'll do the same thing */
528   for (t = var->type; ; )
529   {
530     if (is_attr(t->attrs, ATTR_CONST))
531       return TRUE;
532     else if (is_ptr(t))
533       t = type_pointer_get_ref(t);
534     else break;
535   }
536   return FALSE;
537 }
538
539 static void write_declaration(FILE *header, const var_t *v)
540 {
541   if (is_const_decl(v) && v->eval)
542   {
543     fprintf(header, "#define %s (", v->name);
544     write_expr(header, v->eval, 0, 1, NULL, NULL, "");
545     fprintf(header, ")\n\n");
546   }
547   else
548   {
549     switch (v->stgclass)
550     {
551       case STG_NONE:
552       case STG_REGISTER: /* ignored */
553         break;
554       case STG_STATIC:
555         fprintf(header, "static ");
556         break;
557       case STG_EXTERN:
558         fprintf(header, "extern ");
559         break;
560     }
561     write_type_def_or_decl(header, v->type, FALSE, v->name);
562     fprintf(header, ";\n\n");
563   }
564 }
565
566 static void write_library(FILE *header, const typelib_t *typelib)
567 {
568   const UUID *uuid = get_attrp(typelib->attrs, ATTR_UUID);
569   fprintf(header, "\n");
570   write_guid(header, "LIBID", typelib->name, uuid);
571   fprintf(header, "\n");
572 }
573
574
575 const var_t* get_explicit_handle_var(const var_t *func)
576 {
577     const var_t* var;
578
579     if (!type_get_function_args(func->type))
580         return NULL;
581
582     LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
583     {
584         const type_t *type = var->type;
585         if (type_get_type(type) == TYPE_BASIC && type_basic_get_type(type) == TYPE_BASIC_HANDLE)
586             return var;
587     }
588
589     return NULL;
590 }
591
592 const type_t* get_explicit_generic_handle_type(const var_t* var)
593 {
594     const type_t *t;
595     for (t = var->type;
596          is_ptr(t) || type_is_alias(t);
597          t = type_is_alias(t) ? type_alias_get_aliasee(t) : type_pointer_get_ref(t))
598         if ((type_get_type_detect_alias(t) != TYPE_BASIC || type_basic_get_type(t) != TYPE_BASIC_HANDLE) &&
599             is_attr(t->attrs, ATTR_HANDLE))
600             return t;
601     return NULL;
602 }
603
604 const var_t* get_explicit_generic_handle_var(const var_t *func)
605 {
606     const var_t* var;
607
608     if (!type_get_function_args(func->type))
609         return NULL;
610
611     LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
612         if (get_explicit_generic_handle_type(var))
613             return var;
614
615     return NULL;
616 }
617
618 const var_t* get_context_handle_var(const var_t *func)
619 {
620     const var_t* var;
621
622     if (!type_get_function_args(func->type))
623         return NULL;
624
625     LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
626         if (is_attr(var->attrs, ATTR_IN) && is_context_handle(var->type))
627             return var;
628
629     return NULL;
630 }
631
632 int has_out_arg_or_return(const var_t *func)
633 {
634     const var_t *var;
635
636     if (!is_void(type_function_get_rettype(func->type)))
637         return 1;
638
639     if (!type_get_function_args(func->type))
640         return 0;
641
642     LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
643         if (is_attr(var->attrs, ATTR_OUT))
644             return 1;
645
646     return 0;
647 }
648
649
650 /********** INTERFACES **********/
651
652 int is_object(const attr_list_t *list)
653 {
654     const attr_t *attr;
655     if (list) LIST_FOR_EACH_ENTRY( attr, list, const attr_t, entry )
656         if (attr->type == ATTR_OBJECT || attr->type == ATTR_ODL) return 1;
657     return 0;
658 }
659
660 int is_local(const attr_list_t *a)
661 {
662   return is_attr(a, ATTR_LOCAL);
663 }
664
665 const var_t *is_callas(const attr_list_t *a)
666 {
667   return get_attrp(a, ATTR_CALLAS);
668 }
669
670 static void write_method_macro(FILE *header, const type_t *iface, const char *name)
671 {
672   const statement_t *stmt;
673   int first_iface = 1;
674
675   if (type_iface_get_inherit(iface))
676     write_method_macro(header, type_iface_get_inherit(iface), name);
677
678   STATEMENTS_FOR_EACH_FUNC(stmt, type_iface_get_stmts(iface))
679   {
680     const var_t *func = stmt->u.var;
681
682     if (first_iface)
683     {
684       fprintf(header, "/*** %s methods ***/\n", iface->name);
685       first_iface = 0;
686     }
687
688     if (!is_callas(func->attrs)) {
689       const var_t *arg;
690
691       fprintf(header, "#define %s_%s(This", name, get_name(func));
692       if (type_get_function_args(func->type))
693           LIST_FOR_EACH_ENTRY( arg, type_get_function_args(func->type), const var_t, entry )
694               fprintf(header, ",%s", arg->name);
695       fprintf(header, ") ");
696
697       fprintf(header, "(This)->lpVtbl->%s(This", get_name(func));
698       if (type_get_function_args(func->type))
699           LIST_FOR_EACH_ENTRY( arg, type_get_function_args(func->type), const var_t, entry )
700               fprintf(header, ",%s", arg->name);
701       fprintf(header, ")\n");
702     }
703   }
704 }
705
706 void write_args(FILE *h, const var_list_t *args, const char *name, int method, int do_indent)
707 {
708   const var_t *arg;
709   int count = 0;
710
711   if (do_indent)
712   {
713       indentation++;
714       indent(h, 0);
715   }
716   if (method == 1) {
717     fprintf(h, "%s* This", name);
718     count++;
719   }
720   if (args) LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry ) {
721     if (count) {
722         if (do_indent)
723         {
724             fprintf(h, ",\n");
725             indent(h, 0);
726         }
727         else fprintf(h, ",");
728     }
729     write_type_decl(h, arg->type, arg->name);
730     count++;
731   }
732   if (do_indent) indentation--;
733 }
734
735 static void write_cpp_method_def(FILE *header, const type_t *iface)
736 {
737   const statement_t *stmt;
738
739   STATEMENTS_FOR_EACH_FUNC(stmt, type_iface_get_stmts(iface))
740   {
741     const var_t *func = stmt->u.var;
742     if (!is_callas(func->attrs)) {
743       const char *callconv = get_attrp(func->type->attrs, ATTR_CALLCONV);
744       if (!callconv) callconv = "";
745       indent(header, 0);
746       fprintf(header, "virtual ");
747       write_type_decl_left(header, type_function_get_rettype(func->type));
748       fprintf(header, " %s %s(\n", callconv, get_name(func));
749       write_args(header, type_get_function_args(func->type), iface->name, 2, TRUE);
750       fprintf(header, ") = 0;\n");
751       fprintf(header, "\n");
752     }
753   }
754 }
755
756 static void do_write_c_method_def(FILE *header, const type_t *iface, const char *name)
757 {
758   const statement_t *stmt;
759   int first_iface = 1;
760
761   if (type_iface_get_inherit(iface))
762     do_write_c_method_def(header, type_iface_get_inherit(iface), name);
763
764   STATEMENTS_FOR_EACH_FUNC(stmt, type_iface_get_stmts(iface))
765   {
766     const var_t *func = stmt->u.var;
767     if (first_iface) {
768       indent(header, 0);
769       fprintf(header, "/*** %s methods ***/\n", iface->name);
770       first_iface = 0;
771     }
772     if (!is_callas(func->attrs)) {
773       const char *callconv = get_attrp(func->type->attrs, ATTR_CALLCONV);
774       if (!callconv) callconv = "";
775       indent(header, 0);
776       write_type_decl_left(header, type_function_get_rettype(func->type));
777       fprintf(header, " (%s *%s)(\n", callconv, get_name(func));
778       write_args(header, type_get_function_args(func->type), name, 1, TRUE);
779       fprintf(header, ");\n");
780       fprintf(header, "\n");
781     }
782   }
783 }
784
785 static void write_c_method_def(FILE *header, const type_t *iface)
786 {
787   do_write_c_method_def(header, iface, iface->name);
788 }
789
790 static void write_c_disp_method_def(FILE *header, const type_t *iface)
791 {
792   do_write_c_method_def(header, type_iface_get_inherit(iface), iface->name);
793 }
794
795 static void write_method_proto(FILE *header, const type_t *iface)
796 {
797   const statement_t *stmt;
798
799   STATEMENTS_FOR_EACH_FUNC(stmt, type_iface_get_stmts(iface))
800   {
801     const var_t *func = stmt->u.var;
802
803     if (!is_local(func->attrs)) {
804       const char *callconv = get_attrp(func->type->attrs, ATTR_CALLCONV);
805       if (!callconv) callconv = "";
806       /* proxy prototype */
807       write_type_decl_left(header, type_function_get_rettype(func->type));
808       fprintf(header, " %s %s_%s_Proxy(\n", callconv, iface->name, get_name(func));
809       write_args(header, type_get_function_args(func->type), iface->name, 1, TRUE);
810       fprintf(header, ");\n");
811       /* stub prototype */
812       fprintf(header, "void __RPC_STUB %s_%s_Stub(\n", iface->name, get_name(func));
813       fprintf(header, "    IRpcStubBuffer* This,\n");
814       fprintf(header, "    IRpcChannelBuffer* pRpcChannelBuffer,\n");
815       fprintf(header, "    PRPC_MESSAGE pRpcMessage,\n");
816       fprintf(header, "    DWORD* pdwStubPhase);\n");
817     }
818   }
819 }
820
821 static void write_locals(FILE *fp, const type_t *iface, int body)
822 {
823   static const char comment[]
824     = "/* WIDL-generated stub.  You must provide an implementation for this.  */";
825   const statement_t *stmt;
826
827   if (!is_object(iface->attrs))
828     return;
829
830   STATEMENTS_FOR_EACH_FUNC(stmt, type_iface_get_stmts(iface)) {
831     const var_t *func = stmt->u.var;
832     const var_t *cas = is_callas(func->attrs);
833
834     if (cas) {
835       const statement_t *stmt2 = NULL;
836       STATEMENTS_FOR_EACH_FUNC(stmt2, type_iface_get_stmts(iface))
837         if (!strcmp(stmt2->u.var->name, cas->name))
838           break;
839       if (&stmt2->entry != type_iface_get_stmts(iface)) {
840         const var_t *m = stmt2->u.var;
841         /* proxy prototype - use local prototype */
842         write_type_decl_left(fp, type_function_get_rettype(m->type));
843         fprintf(fp, " CALLBACK %s_%s_Proxy(\n", iface->name, get_name(m));
844         write_args(fp, type_get_function_args(m->type), iface->name, 1, TRUE);
845         fprintf(fp, ")");
846         if (body) {
847           type_t *rt = type_function_get_rettype(m->type);
848           fprintf(fp, "\n{\n");
849           fprintf(fp, "    %s\n", comment);
850           if (rt->name && strcmp(rt->name, "HRESULT") == 0)
851             fprintf(fp, "    return E_NOTIMPL;\n");
852           else if (type_get_type(rt) != TYPE_VOID) {
853             fprintf(fp, "    ");
854             write_type_decl(fp, rt, "rv");
855             fprintf(fp, ";\n");
856             fprintf(fp, "    memset(&rv, 0, sizeof rv);\n");
857             fprintf(fp, "    return rv;\n");
858           }
859           fprintf(fp, "}\n\n");
860         }
861         else
862           fprintf(fp, ";\n");
863         /* stub prototype - use remotable prototype */
864         write_type_decl_left(fp, type_function_get_rettype(func->type));
865         fprintf(fp, " __RPC_STUB %s_%s_Stub(\n", iface->name, get_name(m));
866         write_args(fp, type_get_function_args(func->type), iface->name, 1, TRUE);
867         fprintf(fp, ")");
868         if (body)
869           /* Remotable methods must all return HRESULTs.  */
870           fprintf(fp, "\n{\n    %s\n    return E_NOTIMPL;\n}\n\n", comment);
871         else
872           fprintf(fp, ";\n");
873       }
874       else
875         error_loc("invalid call_as attribute (%s -> %s)\n", func->name, cas->name);
876     }
877   }
878 }
879
880 static void write_local_stubs_stmts(FILE *local_stubs, const statement_list_t *stmts)
881 {
882   const statement_t *stmt;
883   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
884   {
885     if (stmt->type == STMT_TYPE && type_get_type(stmt->u.type) == TYPE_INTERFACE)
886       write_locals(local_stubs, stmt->u.type, TRUE);
887     else if (stmt->type == STMT_LIBRARY)
888       write_local_stubs_stmts(local_stubs, stmt->u.lib->stmts);
889   }
890 }
891
892 void write_local_stubs(const statement_list_t *stmts)
893 {
894   FILE *local_stubs;
895
896   if (!local_stubs_name) return;
897
898   local_stubs = fopen(local_stubs_name, "w");
899   if (!local_stubs) {
900     error("Could not open %s for output\n", local_stubs_name);
901     return;
902   }
903   fprintf(local_stubs, "/* call_as/local stubs for %s */\n\n", input_name);
904   fprintf(local_stubs, "#include <objbase.h>\n");
905   fprintf(local_stubs, "#include \"%s\"\n\n", header_name);
906
907   write_local_stubs_stmts(local_stubs, stmts);
908
909   fclose(local_stubs);
910 }
911
912 static void write_function_proto(FILE *header, const type_t *iface, const var_t *fun, const char *prefix)
913 {
914   const char *callconv = get_attrp(fun->type->attrs, ATTR_CALLCONV);
915
916   /* FIXME: do we need to handle call_as? */
917   write_type_decl_left(header, type_function_get_rettype(fun->type));
918   fprintf(header, " ");
919   if (callconv) fprintf(header, "%s ", callconv);
920   fprintf(header, "%s%s(\n", prefix, get_name(fun));
921   if (type_get_function_args(fun->type))
922     write_args(header, type_get_function_args(fun->type), iface->name, 0, TRUE);
923   else
924     fprintf(header, "    void");
925   fprintf(header, ");\n\n");
926 }
927
928 static void write_forward(FILE *header, type_t *iface)
929 {
930   fprintf(header, "#ifndef __%s_FWD_DEFINED__\n", iface->name);
931   fprintf(header, "#define __%s_FWD_DEFINED__\n", iface->name);
932   fprintf(header, "typedef interface %s %s;\n", iface->name, iface->name);
933   fprintf(header, "#endif\n\n" );
934 }
935
936 static void write_iface_guid(FILE *header, const type_t *iface)
937 {
938   const UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
939   write_guid(header, "IID", iface->name, uuid);
940
941
942 static void write_dispiface_guid(FILE *header, const type_t *iface)
943 {
944   const UUID *uuid = get_attrp(iface->attrs, ATTR_UUID);
945   write_guid(header, "DIID", iface->name, uuid);
946 }
947
948 static void write_coclass_guid(FILE *header, const type_t *cocl)
949 {
950   const UUID *uuid = get_attrp(cocl->attrs, ATTR_UUID);
951   write_guid(header, "CLSID", cocl->name, uuid);
952 }
953
954 static void write_com_interface_start(FILE *header, const type_t *iface)
955 {
956   int dispinterface = is_attr(iface->attrs, ATTR_DISPINTERFACE);
957   fprintf(header, "/*****************************************************************************\n");
958   fprintf(header, " * %s %sinterface\n", iface->name, dispinterface ? "disp" : "");
959   fprintf(header, " */\n");
960   fprintf(header,"#ifndef __%s_%sINTERFACE_DEFINED__\n", iface->name, dispinterface ? "DISP" : "");
961   fprintf(header,"#define __%s_%sINTERFACE_DEFINED__\n\n", iface->name, dispinterface ? "DISP" : "");
962 }
963
964 static void write_com_interface_end(FILE *header, type_t *iface)
965 {
966   int dispinterface = is_attr(iface->attrs, ATTR_DISPINTERFACE);
967   if (dispinterface)
968     write_dispiface_guid(header, iface);
969   else
970     write_iface_guid(header, iface);
971   /* C++ interface */
972   fprintf(header, "#if defined(__cplusplus) && !defined(CINTERFACE)\n");
973   if (type_iface_get_inherit(iface))
974   {
975     fprintf(header, "interface %s : public %s\n", iface->name,
976             type_iface_get_inherit(iface)->name);
977     fprintf(header, "{\n");
978   }
979   else
980   {
981     fprintf(header, "interface %s\n", iface->name);
982     fprintf(header, "{\n");
983     fprintf(header, "    BEGIN_INTERFACE\n");
984     fprintf(header, "\n");
985   }
986   /* dispinterfaces don't have real functions, so don't write C++ functions for
987    * them */
988   if (!dispinterface)
989   {
990     indentation++;
991     write_cpp_method_def(header, iface);
992     indentation--;
993   }
994   if (!type_iface_get_inherit(iface))
995     fprintf(header, "    END_INTERFACE\n");
996   fprintf(header, "};\n");
997   fprintf(header, "#else\n");
998   /* C interface */
999   fprintf(header, "typedef struct %sVtbl {\n", iface->name);
1000   indentation++;
1001   fprintf(header, "    BEGIN_INTERFACE\n");
1002   fprintf(header, "\n");
1003   if (dispinterface)
1004     write_c_disp_method_def(header, iface);
1005   else
1006     write_c_method_def(header, iface);
1007   indentation--;
1008   fprintf(header, "    END_INTERFACE\n");
1009   fprintf(header, "} %sVtbl;\n", iface->name);
1010   fprintf(header, "interface %s {\n", iface->name);
1011   fprintf(header, "    CONST_VTBL %sVtbl* lpVtbl;\n", iface->name);
1012   fprintf(header, "};\n");
1013   fprintf(header, "\n");
1014   fprintf(header, "#ifdef COBJMACROS\n");
1015   /* dispinterfaces don't have real functions, so don't write macros for them,
1016    * only for the interface this interface inherits from, i.e. IDispatch */
1017   write_method_macro(header, dispinterface ? type_iface_get_inherit(iface) : iface, iface->name);
1018   fprintf(header, "#endif\n");
1019   fprintf(header, "\n");
1020   fprintf(header, "#endif\n");
1021   fprintf(header, "\n");
1022   /* dispinterfaces don't have real functions, so don't write prototypes for
1023    * them */
1024   if (!dispinterface)
1025   {
1026     write_method_proto(header, iface);
1027     write_locals(header, iface, FALSE);
1028     fprintf(header, "\n");
1029   }
1030   fprintf(header,"#endif  /* __%s_%sINTERFACE_DEFINED__ */\n\n", iface->name, dispinterface ? "DISP" : "");
1031 }
1032
1033 static void write_rpc_interface_start(FILE *header, const type_t *iface)
1034 {
1035   unsigned int ver = get_attrv(iface->attrs, ATTR_VERSION);
1036   const char *var = get_attrp(iface->attrs, ATTR_IMPLICIT_HANDLE);
1037   static int allocate_written = 0;
1038
1039   if (!allocate_written)
1040   {
1041     allocate_written = 1;
1042     fprintf(header, "void * __RPC_USER MIDL_user_allocate(SIZE_T);\n");
1043     fprintf(header, "void __RPC_USER MIDL_user_free(void *);\n\n");
1044   }
1045
1046   fprintf(header, "/*****************************************************************************\n");
1047   fprintf(header, " * %s interface (v%d.%d)\n", iface->name, MAJORVERSION(ver), MINORVERSION(ver));
1048   fprintf(header, " */\n");
1049   fprintf(header,"#ifndef __%s_INTERFACE_DEFINED__\n", iface->name);
1050   fprintf(header,"#define __%s_INTERFACE_DEFINED__\n\n", iface->name);
1051   if (var) fprintf(header, "extern handle_t %s;\n", var);
1052   if (old_names)
1053   {
1054       fprintf(header, "extern RPC_IF_HANDLE %s%s_ClientIfHandle;\n", prefix_client, iface->name);
1055       fprintf(header, "extern RPC_IF_HANDLE %s%s_ServerIfHandle;\n", prefix_server, iface->name);
1056   }
1057   else
1058   {
1059       fprintf(header, "extern RPC_IF_HANDLE %s%s_v%d_%d_c_ifspec;\n",
1060               prefix_client, iface->name, MAJORVERSION(ver), MINORVERSION(ver));
1061       fprintf(header, "extern RPC_IF_HANDLE %s%s_v%d_%d_s_ifspec;\n",
1062               prefix_server, iface->name, MAJORVERSION(ver), MINORVERSION(ver));
1063   }
1064 }
1065
1066 static void write_rpc_interface_end(FILE *header, const type_t *iface)
1067 {
1068   fprintf(header,"\n#endif  /* __%s_INTERFACE_DEFINED__ */\n\n", iface->name);
1069 }
1070
1071 static void write_coclass(FILE *header, type_t *cocl)
1072 {
1073   fprintf(header, "/*****************************************************************************\n");
1074   fprintf(header, " * %s coclass\n", cocl->name);
1075   fprintf(header, " */\n\n");
1076   write_coclass_guid(header, cocl);
1077   fprintf(header, "\n");
1078 }
1079
1080 static void write_coclass_forward(FILE *header, type_t *cocl)
1081 {
1082   fprintf(header, "#ifndef __%s_FWD_DEFINED__\n", cocl->name);
1083   fprintf(header, "#define __%s_FWD_DEFINED__\n", cocl->name);
1084   fprintf(header, "typedef struct %s %s;\n", cocl->name, cocl->name);
1085   fprintf(header, "#endif /* defined __%s_FWD_DEFINED__ */\n\n", cocl->name );
1086 }
1087
1088 static void write_import(FILE *header, const char *fname)
1089 {
1090   char *hname, *p;
1091
1092   hname = dup_basename(fname, ".idl");
1093   p = hname + strlen(hname) - 2;
1094   if (p <= hname || strcmp( p, ".h" )) strcat(hname, ".h");
1095
1096   fprintf(header, "#include <%s>\n", hname);
1097   free(hname);
1098 }
1099
1100 static void write_imports(FILE *header, const statement_list_t *stmts)
1101 {
1102   const statement_t *stmt;
1103   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
1104   {
1105     switch (stmt->type)
1106     {
1107       case STMT_TYPE:
1108         if (type_get_type(stmt->u.type) == TYPE_INTERFACE)
1109           write_imports(header, type_iface_get_stmts(stmt->u.type));
1110         break;
1111       case STMT_TYPEREF:
1112       case STMT_IMPORTLIB:
1113         /* not included in header */
1114         break;
1115       case STMT_IMPORT:
1116         write_import(header, stmt->u.str);
1117         break;
1118       case STMT_TYPEDEF:
1119       case STMT_MODULE:
1120       case STMT_CPPQUOTE:
1121       case STMT_DECLARATION:
1122         /* not processed here */
1123         break;
1124       case STMT_LIBRARY:
1125         write_imports(header, stmt->u.lib->stmts);
1126         break;
1127     }
1128   }
1129 }
1130
1131 static void write_forward_decls(FILE *header, const statement_list_t *stmts)
1132 {
1133   const statement_t *stmt;
1134   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
1135   {
1136     switch (stmt->type)
1137     {
1138       case STMT_TYPE:
1139         if (type_get_type(stmt->u.type) == TYPE_INTERFACE)
1140         {
1141           if (is_object(stmt->u.type->attrs) || is_attr(stmt->u.type->attrs, ATTR_DISPINTERFACE))
1142             write_forward(header, stmt->u.type);
1143         }
1144         else if (type_get_type(stmt->u.type) == TYPE_COCLASS)
1145           write_coclass_forward(header, stmt->u.type);
1146         break;
1147       case STMT_TYPEREF:
1148       case STMT_IMPORTLIB:
1149         /* not included in header */
1150         break;
1151       case STMT_IMPORT:
1152       case STMT_TYPEDEF:
1153       case STMT_MODULE:
1154       case STMT_CPPQUOTE:
1155       case STMT_DECLARATION:
1156         /* not processed here */
1157         break;
1158       case STMT_LIBRARY:
1159         write_forward_decls(header, stmt->u.lib->stmts);
1160         break;
1161     }
1162   }
1163 }
1164
1165 static void write_header_stmts(FILE *header, const statement_list_t *stmts, const type_t *iface, int ignore_funcs)
1166 {
1167   const statement_t *stmt;
1168   if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
1169   {
1170     switch (stmt->type)
1171     {
1172       case STMT_TYPE:
1173         if (type_get_type(stmt->u.type) == TYPE_INTERFACE)
1174         {
1175           type_t *iface = stmt->u.type;
1176           if (is_attr(stmt->u.type->attrs, ATTR_DISPINTERFACE) || is_object(stmt->u.type->attrs))
1177           {
1178             write_com_interface_start(header, iface);
1179             write_header_stmts(header, type_iface_get_stmts(iface), stmt->u.type, TRUE);
1180             write_com_interface_end(header, iface);
1181           }
1182           else
1183           {
1184             write_rpc_interface_start(header, iface);
1185             write_header_stmts(header, type_iface_get_stmts(iface), iface, FALSE);
1186             write_rpc_interface_end(header, iface);
1187           }
1188         }
1189         else if (type_get_type(stmt->u.type) == TYPE_COCLASS)
1190           write_coclass(header, stmt->u.type);
1191         else
1192         {
1193           write_type_def_or_decl(header, stmt->u.type, FALSE, NULL);
1194           fprintf(header, ";\n\n");
1195         }
1196         break;
1197       case STMT_TYPEREF:
1198         /* FIXME: shouldn't write out forward declarations for undefined
1199         * interfaces but a number of our IDL files depend on this */
1200         if (type_get_type(stmt->u.type) == TYPE_INTERFACE && !stmt->u.type->written)
1201           write_forward(header, stmt->u.type);
1202         break;
1203       case STMT_IMPORTLIB:
1204       case STMT_MODULE:
1205         /* not included in header */
1206         break;
1207       case STMT_IMPORT:
1208         /* not processed here */
1209         break;
1210       case STMT_TYPEDEF:
1211       {
1212         const type_list_t *type_entry = stmt->u.type_list;
1213         for (; type_entry; type_entry = type_entry->next)
1214           write_typedef(header, type_entry->type);
1215         break;
1216       }
1217       case STMT_LIBRARY:
1218         write_library(header, stmt->u.lib);
1219         write_header_stmts(header, stmt->u.lib->stmts, NULL, FALSE);
1220         break;
1221       case STMT_CPPQUOTE:
1222         fprintf(header, "%s\n", stmt->u.str);
1223         break;
1224       case STMT_DECLARATION:
1225         if (iface && type_get_type(stmt->u.var->type) == TYPE_FUNCTION)
1226         {
1227           if (!ignore_funcs)
1228           {
1229             int prefixes_differ = strcmp(prefix_client, prefix_server);
1230
1231             if (prefixes_differ)
1232             {
1233               fprintf(header, "/* client prototype */\n");
1234               write_function_proto(header, iface, stmt->u.var, prefix_client);
1235               fprintf(header, "/* server prototype */\n");
1236             }
1237             write_function_proto(header, iface, stmt->u.var, prefix_server);
1238           }
1239         }
1240         else
1241           write_declaration(header, stmt->u.var);
1242         break;
1243     }
1244   }
1245 }
1246
1247 void write_header(const statement_list_t *stmts)
1248 {
1249   FILE *header;
1250
1251   if (!do_header) return;
1252
1253   if(!(header = fopen(header_name, "w"))) {
1254     error("Could not open %s for output\n", header_name);
1255     return;
1256   }
1257   fprintf(header, "/*** Autogenerated by WIDL %s from %s - Do not edit ***/\n\n", PACKAGE_VERSION, input_name);
1258   fprintf(header, "#include <rpc.h>\n" );
1259   fprintf(header, "#include <rpcndr.h>\n\n" );
1260
1261   fprintf(header, "#ifndef __WIDL_%s\n", header_token);
1262   fprintf(header, "#define __WIDL_%s\n\n", header_token);
1263   start_cplusplus_guard(header);
1264
1265   fprintf(header, "/* Headers for imported files */\n\n");
1266   write_imports(header, stmts);
1267   fprintf(header, "\n");
1268
1269   /* FIXME: should be before imported file includes */
1270   fprintf(header, "/* Forward declarations */\n\n");
1271   write_forward_decls(header, stmts);
1272   fprintf(header, "\n");
1273
1274   write_header_stmts(header, stmts, NULL, FALSE);
1275
1276   fprintf(header, "/* Begin additional prototypes for all interfaces */\n");
1277   fprintf(header, "\n");
1278   write_user_types(header);
1279   write_generic_handle_routines(header);
1280   write_context_handle_rundowns(header);
1281   fprintf(header, "\n");
1282   fprintf(header, "/* End additional prototypes */\n");
1283   fprintf(header, "\n");
1284
1285   end_cplusplus_guard(header);
1286   fprintf(header, "#endif /* __WIDL_%s */\n", header_token);
1287
1288   fclose(header);
1289 }