2 * Format String Generator for IDL Compiler
4 * Copyright 2005-2006 Eric Kohl
5 * Copyright 2005-2006 Robert Shearman
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
23 #include "wine/port.h"
44 /* round size up to multiple of alignment */
45 #define ROUND_SIZE(size, alignment) (((size) + ((alignment) - 1)) & ~((alignment) - 1))
46 /* value to add on to round size up to a multiple of alignment */
47 #define ROUNDING(size, alignment) (((alignment) - 1) - (((size) + ((alignment) - 1)) & ((alignment) - 1)))
49 static const type_t *current_structure;
50 static const var_t *current_func;
51 static const type_t *current_iface;
53 static struct list expr_eval_routines = LIST_INIT(expr_eval_routines);
54 struct expr_eval_routine
58 const type_t *cont_type;
66 TYPE_CONTEXT_TOPLEVELPARAM,
68 TYPE_CONTEXT_CONTAINER,
69 TYPE_CONTEXT_CONTAINER_NO_POINTERS,
72 static unsigned int field_memsize(const type_t *type, unsigned int *offset);
73 static unsigned int fields_memsize(const var_list_t *fields, unsigned int *align);
74 static unsigned int type_memsize_and_alignment(const type_t *t, unsigned int *align);
75 static unsigned int write_struct_tfs(FILE *file, type_t *type, const char *name, unsigned int *tfsoff);
76 static int write_embedded_types(FILE *file, const attr_list_t *attrs, type_t *type,
77 const char *name, int write_ptr, unsigned int *tfsoff);
78 static const var_t *find_array_or_string_in_struct(const type_t *type);
79 static unsigned int write_string_tfs(FILE *file, const attr_list_t *attrs,
80 type_t *type, int toplevel_param,
81 const char *name, unsigned int *typestring_offset);
83 static const char *string_of_type(unsigned char type)
87 case RPC_FC_BYTE: return "FC_BYTE";
88 case RPC_FC_CHAR: return "FC_CHAR";
89 case RPC_FC_SMALL: return "FC_SMALL";
90 case RPC_FC_USMALL: return "FC_USMALL";
91 case RPC_FC_WCHAR: return "FC_WCHAR";
92 case RPC_FC_SHORT: return "FC_SHORT";
93 case RPC_FC_USHORT: return "FC_USHORT";
94 case RPC_FC_LONG: return "FC_LONG";
95 case RPC_FC_ULONG: return "FC_ULONG";
96 case RPC_FC_FLOAT: return "FC_FLOAT";
97 case RPC_FC_HYPER: return "FC_HYPER";
98 case RPC_FC_DOUBLE: return "FC_DOUBLE";
99 case RPC_FC_ENUM16: return "FC_ENUM16";
100 case RPC_FC_ENUM32: return "FC_ENUM32";
101 case RPC_FC_IGNORE: return "FC_IGNORE";
102 case RPC_FC_ERROR_STATUS_T: return "FC_ERROR_STATUS_T";
103 case RPC_FC_RP: return "FC_RP";
104 case RPC_FC_UP: return "FC_UP";
105 case RPC_FC_OP: return "FC_OP";
106 case RPC_FC_FP: return "FC_FP";
107 case RPC_FC_ENCAPSULATED_UNION: return "FC_ENCAPSULATED_UNION";
108 case RPC_FC_NON_ENCAPSULATED_UNION: return "FC_NON_ENCAPSULATED_UNION";
109 case RPC_FC_STRUCT: return "FC_STRUCT";
110 case RPC_FC_PSTRUCT: return "FC_PSTRUCT";
111 case RPC_FC_CSTRUCT: return "FC_CSTRUCT";
112 case RPC_FC_CPSTRUCT: return "FC_CPSTRUCT";
113 case RPC_FC_CVSTRUCT: return "FC_CVSTRUCT";
114 case RPC_FC_BOGUS_STRUCT: return "FC_BOGUS_STRUCT";
115 case RPC_FC_SMFARRAY: return "FC_SMFARRAY";
116 case RPC_FC_LGFARRAY: return "FC_LGFARRAY";
117 case RPC_FC_SMVARRAY: return "FC_SMVARRAY";
118 case RPC_FC_LGVARRAY: return "FC_LGVARRAY";
119 case RPC_FC_CARRAY: return "FC_CARRAY";
120 case RPC_FC_CVARRAY: return "FC_CVARRAY";
121 case RPC_FC_BOGUS_ARRAY: return "FC_BOGUS_ARRAY";
122 case RPC_FC_ALIGNM2: return "FC_ALIGNM2";
123 case RPC_FC_ALIGNM4: return "FC_ALIGNM4";
124 case RPC_FC_ALIGNM8: return "FC_ALIGNM8";
125 case RPC_FC_POINTER: return "FC_POINTER";
126 case RPC_FC_C_CSTRING: return "FC_C_CSTRING";
127 case RPC_FC_C_WSTRING: return "FC_C_WSTRING";
128 case RPC_FC_CSTRING: return "FC_CSTRING";
129 case RPC_FC_WSTRING: return "FC_WSTRING";
130 case RPC_FC_BYTE_COUNT_POINTER: return "FC_BYTE_COUNT_POINTER";
131 case RPC_FC_TRANSMIT_AS: return "FC_TRANSMIT_AS";
132 case RPC_FC_REPRESENT_AS: return "FC_REPRESENT_AS";
133 case RPC_FC_IP: return "FC_IP";
134 case RPC_FC_BIND_CONTEXT: return "FC_BIND_CONTEXT";
135 case RPC_FC_BIND_GENERIC: return "FC_BIND_GENERIC";
136 case RPC_FC_BIND_PRIMITIVE: return "FC_BIND_PRIMITIVE";
137 case RPC_FC_AUTO_HANDLE: return "FC_AUTO_HANDLE";
138 case RPC_FC_CALLBACK_HANDLE: return "FC_CALLBACK_HANDLE";
139 case RPC_FC_STRUCTPAD1: return "FC_STRUCTPAD1";
140 case RPC_FC_STRUCTPAD2: return "FC_STRUCTPAD2";
141 case RPC_FC_STRUCTPAD3: return "FC_STRUCTPAD3";
142 case RPC_FC_STRUCTPAD4: return "FC_STRUCTPAD4";
143 case RPC_FC_STRUCTPAD5: return "FC_STRUCTPAD5";
144 case RPC_FC_STRUCTPAD6: return "FC_STRUCTPAD6";
145 case RPC_FC_STRUCTPAD7: return "FC_STRUCTPAD7";
146 case RPC_FC_STRING_SIZED: return "FC_STRING_SIZED";
147 case RPC_FC_NO_REPEAT: return "FC_NO_REPEAT";
148 case RPC_FC_FIXED_REPEAT: return "FC_FIXED_REPEAT";
149 case RPC_FC_VARIABLE_REPEAT: return "FC_VARIABLE_REPEAT";
150 case RPC_FC_FIXED_OFFSET: return "FC_FIXED_OFFSET";
151 case RPC_FC_VARIABLE_OFFSET: return "FC_VARIABLE_OFFSET";
152 case RPC_FC_PP: return "FC_PP";
153 case RPC_FC_EMBEDDED_COMPLEX: return "FC_EMBEDDED_COMPLEX";
154 case RPC_FC_DEREFERENCE: return "FC_DEREFERENCE";
155 case RPC_FC_DIV_2: return "FC_DIV_2";
156 case RPC_FC_MULT_2: return "FC_MULT_2";
157 case RPC_FC_ADD_1: return "FC_ADD_1";
158 case RPC_FC_SUB_1: return "FC_SUB_1";
159 case RPC_FC_CALLBACK: return "FC_CALLBACK";
160 case RPC_FC_CONSTANT_IID: return "FC_CONSTANT_IID";
161 case RPC_FC_END: return "FC_END";
162 case RPC_FC_PAD: return "FC_PAD";
163 case RPC_FC_USER_MARSHAL: return "FC_USER_MARSHAL";
164 case RPC_FC_RANGE: return "FC_RANGE";
165 case RPC_FC_INT3264: return "FC_INT3264";
166 case RPC_FC_UINT3264: return "FC_UINT3264";
168 error("string_of_type: unknown type 0x%02x\n", type);
173 static void *get_aliaschain_attrp(const type_t *type, enum attr_type attr)
175 const type_t *t = type;
178 if (is_attr(t->attrs, attr))
179 return get_attrp(t->attrs, attr);
180 else if (type_is_alias(t))
181 t = type_alias_get_aliasee(t);
186 unsigned char get_basic_fc(const type_t *type)
188 int sign = type_basic_get_sign(type);
189 switch (type_basic_get_type(type))
191 case TYPE_BASIC_INT8: return (sign <= 0 ? RPC_FC_SMALL : RPC_FC_USMALL);
192 case TYPE_BASIC_INT16: return (sign <= 0 ? RPC_FC_SHORT : RPC_FC_USHORT);
193 case TYPE_BASIC_INT32: return (sign <= 0 ? RPC_FC_LONG : RPC_FC_ULONG);
194 case TYPE_BASIC_INT64: return RPC_FC_HYPER;
195 case TYPE_BASIC_INT: return (sign <= 0 ? RPC_FC_LONG : RPC_FC_ULONG);
196 case TYPE_BASIC_INT3264: return (sign <= 0 ? RPC_FC_INT3264 : RPC_FC_UINT3264);
197 case TYPE_BASIC_BYTE: return RPC_FC_BYTE;
198 case TYPE_BASIC_CHAR: return RPC_FC_CHAR;
199 case TYPE_BASIC_WCHAR: return RPC_FC_WCHAR;
200 case TYPE_BASIC_HYPER: return RPC_FC_HYPER;
201 case TYPE_BASIC_FLOAT: return RPC_FC_FLOAT;
202 case TYPE_BASIC_DOUBLE: return RPC_FC_DOUBLE;
203 case TYPE_BASIC_ERROR_STATUS_T: return RPC_FC_ERROR_STATUS_T;
204 case TYPE_BASIC_HANDLE: return RPC_FC_BIND_PRIMITIVE;
209 static inline unsigned int clamp_align(unsigned int align)
211 unsigned int packing = (pointer_size == 4) ? win32_packing : win64_packing;
212 if(align > packing) align = packing;
216 unsigned char get_pointer_fc(const type_t *type, const attr_list_t *attrs, int toplevel_param)
221 assert(is_ptr(type) || is_array(type));
223 pointer_type = get_attrv(attrs, ATTR_POINTERTYPE);
227 for (t = type; type_is_alias(t); t = type_alias_get_aliasee(t))
229 pointer_type = get_attrv(t->attrs, ATTR_POINTERTYPE);
236 else if (is_ptr(type))
237 return type_pointer_get_default_fc(type);
239 return type_array_get_ptr_default_fc(type);
242 static unsigned char get_enum_fc(const type_t *type)
244 assert(type_get_type(type) == TYPE_ENUM);
245 if (is_aliaschain_attr(type, ATTR_V1ENUM))
246 return RPC_FC_ENUM32;
248 return RPC_FC_ENUM16;
251 static type_t *get_user_type(const type_t *t, const char **pname)
255 type_t *ut = get_attrp(t->attrs, ATTR_WIREMARSHAL);
263 if (type_is_alias(t))
264 t = type_alias_get_aliasee(t);
270 static int is_user_type(const type_t *t)
272 return get_user_type(t, NULL) != NULL;
275 enum typegen_type typegen_detect_type(const type_t *type, const attr_list_t *attrs, unsigned int flags)
277 if (is_user_type(type))
278 return TGT_USER_TYPE;
280 if (is_aliaschain_attr(type, ATTR_CONTEXTHANDLE))
281 return TGT_CTXT_HANDLE;
283 if (!(flags & TDT_IGNORE_STRINGS) && is_string_type(attrs, type))
286 switch (type_get_type(type))
289 if (!(flags & TDT_IGNORE_RANGES) &&
290 (is_attr(attrs, ATTR_RANGE) || is_aliaschain_attr(type, ATTR_RANGE)))
294 if (!(flags & TDT_IGNORE_RANGES) &&
295 (is_attr(attrs, ATTR_RANGE) || is_aliaschain_attr(type, ATTR_RANGE)))
299 if (type_get_type(type_pointer_get_ref(type)) == TYPE_INTERFACE ||
300 (type_get_type(type_pointer_get_ref(type)) == TYPE_VOID && is_attr(attrs, ATTR_IIDIS)))
301 return TGT_IFACE_POINTER;
302 else if (is_aliaschain_attr(type_pointer_get_ref(type), ATTR_CONTEXTHANDLE))
303 return TGT_CTXT_HANDLE_POINTER;
308 case TYPE_ENCAPSULATED_UNION:
325 static int get_padding(const var_list_t *fields)
327 unsigned short offset = 0;
328 unsigned int salign = 1;
334 LIST_FOR_EACH_ENTRY(f, fields, const var_t, entry)
336 type_t *ft = f->type;
337 unsigned int align = 0;
338 unsigned int size = type_memsize_and_alignment(ft, &align);
339 align = clamp_align(align);
340 if (align > salign) salign = align;
341 offset = ROUND_SIZE(offset, align);
345 return ROUNDING(offset, salign);
348 static unsigned int get_stack_size( const type_t *type, const attr_list_t *attrs, int *by_value )
350 unsigned int stack_size;
353 switch (typegen_detect_type( type, attrs, TDT_ALL_TYPES ))
361 stack_size = type_memsize( type );
362 by_val = (pointer_size < 8 || stack_size <= pointer_size); /* FIXME: should be platform-specific */
368 if (!by_val) stack_size = pointer_size;
369 if (by_value) *by_value = by_val;
370 return ROUND_SIZE( stack_size, pointer_size );
373 static unsigned char get_contexthandle_flags( const type_t *iface, const attr_list_t *attrs,
376 unsigned char flags = 0;
378 if (is_attr(iface->attrs, ATTR_STRICTCONTEXTHANDLE)) flags |= NDR_STRICT_CONTEXT_HANDLE;
381 !is_attr( type->attrs, ATTR_CONTEXTHANDLE ) &&
382 !is_attr( attrs, ATTR_CONTEXTHANDLE ))
385 if (is_attr(attrs, ATTR_IN))
388 if (!is_attr(attrs, ATTR_OUT)) flags |= NDR_CONTEXT_HANDLE_CANNOT_BE_NULL;
390 if (is_attr(attrs, ATTR_OUT)) flags |= 0x20;
395 unsigned char get_struct_fc(const type_t *type)
398 int has_conformance = 0;
399 int has_variance = 0;
403 fields = type_struct_get_fields(type);
405 if (get_padding(fields))
406 return RPC_FC_BOGUS_STRUCT;
408 if (fields) LIST_FOR_EACH_ENTRY( field, fields, var_t, entry )
410 type_t *t = field->type;
411 enum typegen_type typegen_type;
413 typegen_type = typegen_detect_type(t, field->attrs, TDT_IGNORE_STRINGS);
415 if (typegen_type == TGT_ARRAY && !type_array_is_decl_as_ptr(t))
417 if (is_string_type(field->attrs, field->type))
419 if (is_conformant_array(t))
425 if (is_array(type_array_get_element(field->type)))
426 return RPC_FC_BOGUS_STRUCT;
428 if (type_array_has_conformance(field->type))
431 if (list_next(fields, &field->entry))
432 error_loc("field '%s' deriving from a conformant array must be the last field in the structure\n",
435 if (type_array_has_variance(t))
438 t = type_array_get_element(t);
439 typegen_type = typegen_detect_type(t, field->attrs, TDT_IGNORE_STRINGS);
442 switch (typegen_type)
445 case TGT_IFACE_POINTER:
446 return RPC_FC_BOGUS_STRUCT;
448 if (type_basic_get_type(t) == TYPE_BASIC_INT3264 && pointer_size != 4)
449 return RPC_FC_BOGUS_STRUCT;
452 if (get_enum_fc(t) == RPC_FC_ENUM16)
453 return RPC_FC_BOGUS_STRUCT;
457 if (get_pointer_fc(t, field->attrs, FALSE) == RPC_FC_RP || pointer_size != 4)
458 return RPC_FC_BOGUS_STRUCT;
462 return RPC_FC_BOGUS_STRUCT;
465 unsigned char fc = get_struct_fc(t);
470 case RPC_FC_CVSTRUCT:
476 case RPC_FC_CPSTRUCT:
478 if (list_next( fields, &field->entry ))
479 error_loc("field '%s' deriving from a conformant array must be the last field in the structure\n",
486 if (list_next( fields, &field->entry ))
487 error_loc("field '%s' deriving from a conformant array must be the last field in the structure\n",
496 error_loc("Unknown struct member %s with type (0x%02x)\n", field->name, fc);
497 /* fallthru - treat it as complex */
499 /* as soon as we see one of these these members, it's bogus... */
500 case RPC_FC_BOGUS_STRUCT:
501 return RPC_FC_BOGUS_STRUCT;
506 return RPC_FC_BOGUS_STRUCT;
508 /* shouldn't get here because of TDT_IGNORE_STRINGS above. fall through */
510 case TGT_CTXT_HANDLE:
511 case TGT_CTXT_HANDLE_POINTER:
512 /* checking after parsing should mean that we don't get here. if we do,
513 * it's a checker bug */
520 if ( has_conformance )
521 return RPC_FC_CVSTRUCT;
523 return RPC_FC_BOGUS_STRUCT;
525 if( has_conformance && has_pointer )
526 return RPC_FC_CPSTRUCT;
527 if( has_conformance )
528 return RPC_FC_CSTRUCT;
530 return RPC_FC_PSTRUCT;
531 return RPC_FC_STRUCT;
534 static unsigned char get_array_fc(const type_t *type)
537 const expr_t *size_is;
538 const type_t *elem_type;
540 elem_type = type_array_get_element(type);
541 size_is = type_array_get_conformance(type);
545 unsigned int size = type_memsize(elem_type);
546 if (size * type_array_get_dim(type) > 0xffffuL)
547 fc = RPC_FC_LGFARRAY;
549 fc = RPC_FC_SMFARRAY;
554 if (type_array_has_variance(type))
556 if (fc == RPC_FC_SMFARRAY)
557 fc = RPC_FC_SMVARRAY;
558 else if (fc == RPC_FC_LGFARRAY)
559 fc = RPC_FC_LGVARRAY;
560 else if (fc == RPC_FC_CARRAY)
564 switch (typegen_detect_type(elem_type, NULL, TDT_IGNORE_STRINGS))
567 fc = RPC_FC_BOGUS_ARRAY;
570 if (type_basic_get_type(elem_type) == TYPE_BASIC_INT3264 &&
572 fc = RPC_FC_BOGUS_ARRAY;
575 switch (get_struct_fc(elem_type))
577 case RPC_FC_BOGUS_STRUCT:
578 fc = RPC_FC_BOGUS_ARRAY;
583 /* is 16-bit enum - if so, wire size differs from mem size and so
584 * the array cannot be block copied, which means the array is complex */
585 if (get_enum_fc(elem_type) == RPC_FC_ENUM16)
586 fc = RPC_FC_BOGUS_ARRAY;
589 case TGT_IFACE_POINTER:
590 fc = RPC_FC_BOGUS_ARRAY;
593 /* ref pointers cannot just be block copied. unique pointers to
594 * interfaces need special treatment. either case means the array is
596 if (get_pointer_fc(elem_type, NULL, FALSE) == RPC_FC_RP || pointer_size != 4)
597 fc = RPC_FC_BOGUS_ARRAY;
600 fc = RPC_FC_BOGUS_ARRAY;
602 case TGT_CTXT_HANDLE:
603 case TGT_CTXT_HANDLE_POINTER:
607 /* nothing to do for everything else */
614 static int is_non_complex_struct(const type_t *type)
616 return (type_get_type(type) == TYPE_STRUCT &&
617 get_struct_fc(type) != RPC_FC_BOGUS_STRUCT);
620 static int type_has_pointers(const type_t *type)
622 switch (typegen_detect_type(type, NULL, TDT_IGNORE_STRINGS))
629 return type_array_is_decl_as_ptr(type) || type_has_pointers(type_array_get_element(type));
632 var_list_t *fields = type_struct_get_fields(type);
634 if (fields) LIST_FOR_EACH_ENTRY( field, fields, const var_t, entry )
636 if (type_has_pointers(field->type))
645 fields = type_union_get_cases(type);
646 if (fields) LIST_FOR_EACH_ENTRY( field, fields, const var_t, entry )
648 if (field->type && type_has_pointers(field->type))
653 case TGT_CTXT_HANDLE:
654 case TGT_CTXT_HANDLE_POINTER:
656 case TGT_IFACE_POINTER:
667 static int type_has_full_pointer(const type_t *type, const attr_list_t *attrs,
670 switch (typegen_detect_type(type, NULL, TDT_IGNORE_STRINGS))
675 if (get_pointer_fc(type, attrs, toplevel_param) == RPC_FC_FP)
680 if (get_pointer_fc(type, attrs, toplevel_param) == RPC_FC_FP)
683 return type_has_full_pointer(type_array_get_element(type), NULL, FALSE);
686 var_list_t *fields = type_struct_get_fields(type);
688 if (fields) LIST_FOR_EACH_ENTRY( field, fields, const var_t, entry )
690 if (type_has_full_pointer(field->type, field->attrs, FALSE))
699 fields = type_union_get_cases(type);
700 if (fields) LIST_FOR_EACH_ENTRY( field, fields, const var_t, entry )
702 if (field->type && type_has_full_pointer(field->type, field->attrs, FALSE))
707 case TGT_CTXT_HANDLE:
708 case TGT_CTXT_HANDLE_POINTER:
710 case TGT_IFACE_POINTER:
721 static unsigned short user_type_offset(const char *name)
724 unsigned short off = 0;
725 LIST_FOR_EACH_ENTRY(ut, &user_type_list, user_type_t, entry)
727 if (strcmp(name, ut->name) == 0)
731 error("user_type_offset: couldn't find type (%s)\n", name);
735 static void update_tfsoff(type_t *type, unsigned int offset, FILE *file)
737 type->typestring_offset = offset;
738 if (file) type->tfswrite = FALSE;
741 static void guard_rec(type_t *type)
743 /* types that contain references to themselves (like a linked list),
744 need to be shielded from infinite recursion when writing embedded
746 if (type->typestring_offset)
747 type->tfswrite = FALSE;
749 type->typestring_offset = 1;
752 static int is_embedded_complex(const type_t *type)
754 switch (typegen_detect_type(type, NULL, TDT_ALL_TYPES))
760 case TGT_IFACE_POINTER:
767 static const char *get_context_handle_type_name(const type_t *type)
771 is_ptr(t) || type_is_alias(t);
772 t = type_is_alias(t) ? type_alias_get_aliasee(t) : type_pointer_get_ref(t))
773 if (is_attr(t->attrs, ATTR_CONTEXTHANDLE))
779 #define WRITE_FCTYPE(file, fctype, typestring_offset) \
782 fprintf(file, "/* %2u */\n", typestring_offset); \
783 print_file((file), 2, "0x%02x, /* " #fctype " */\n", RPC_##fctype); \
787 static void print_file(FILE *file, int indent, const char *format, ...) __attribute__((format (printf, 3, 4)));
788 static void print_file(FILE *file, int indent, const char *format, ...)
791 va_start(va, format);
792 print(file, indent, format, va);
796 void print(FILE *file, int indent, const char *format, va_list va)
800 if (format[0] != '\n')
803 vfprintf(file, format, va);
808 static void write_var_init(FILE *file, int indent, const type_t *t, const char *n, const char *local_var_prefix)
810 if (decl_indirect(t))
812 print_file(file, indent, "MIDL_memset(&%s%s, 0, sizeof(%s%s));\n",
813 local_var_prefix, n, local_var_prefix, n);
814 print_file(file, indent, "%s_p_%s = &%s%s;\n", local_var_prefix, n, local_var_prefix, n);
816 else if (is_ptr(t) || is_array(t))
817 print_file(file, indent, "%s%s = 0;\n", local_var_prefix, n);
820 void write_parameters_init(FILE *file, int indent, const var_t *func, const char *local_var_prefix)
824 if (!is_void(type_function_get_rettype(func->type)))
825 write_var_init(file, indent, type_function_get_rettype(func->type), "_RetVal", local_var_prefix);
827 if (!type_get_function_args(func->type))
830 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
831 write_var_init(file, indent, var->type, var->name, local_var_prefix);
836 static void write_formatdesc(FILE *f, int indent, const char *str)
838 print_file(f, indent, "typedef struct _MIDL_%s_FORMAT_STRING\n", str);
839 print_file(f, indent, "{\n");
840 print_file(f, indent + 1, "short Pad;\n");
841 print_file(f, indent + 1, "unsigned char Format[%s_FORMAT_STRING_SIZE];\n", str);
842 print_file(f, indent, "} MIDL_%s_FORMAT_STRING;\n", str);
843 print_file(f, indent, "\n");
846 void write_formatstringsdecl(FILE *f, int indent, const statement_list_t *stmts, type_pred_t pred)
850 print_file(f, indent, "#define TYPE_FORMAT_STRING_SIZE %d\n",
851 get_size_typeformatstring(stmts, pred));
853 print_file(f, indent, "#define PROC_FORMAT_STRING_SIZE %d\n",
854 get_size_procformatstring(stmts, pred));
857 write_formatdesc(f, indent, "TYPE");
858 write_formatdesc(f, indent, "PROC");
860 print_file(f, indent, "static const MIDL_TYPE_FORMAT_STRING __MIDL_TypeFormatString;\n");
861 print_file(f, indent, "static const MIDL_PROC_FORMAT_STRING __MIDL_ProcFormatString;\n");
862 print_file(f, indent, "\n");
865 int decl_indirect(const type_t *t)
869 return (type_get_type(t) != TYPE_BASIC &&
870 type_get_type(t) != TYPE_ENUM &&
871 type_get_type(t) != TYPE_POINTER &&
872 type_get_type(t) != TYPE_ARRAY);
875 static unsigned int write_procformatstring_type(FILE *file, int indent,
877 const attr_list_t *attrs,
882 int is_in = is_attr(attrs, ATTR_IN);
883 int is_out = is_attr(attrs, ATTR_OUT);
885 if (!is_in && !is_out) is_in = TRUE;
887 if (type_get_type(type) == TYPE_BASIC ||
888 type_get_type(type) == TYPE_ENUM)
893 print_file(file, indent, "0x53, /* FC_RETURN_PARAM_BASETYPE */\n");
895 print_file(file, indent, "0x4e, /* FC_IN_PARAM_BASETYPE */\n");
897 if (type_get_type(type) == TYPE_ENUM)
899 fc = get_enum_fc(type);
903 fc = get_basic_fc(type);
905 if (fc == RPC_FC_BIND_PRIMITIVE)
909 print_file(file, indent, "0x%02x, /* %s */\n",
910 fc, string_of_type(fc));
911 size = 2; /* includes param type prefix */
916 print_file(file, indent, "0x52, /* FC_RETURN_PARAM */\n");
917 else if (is_in && is_out)
918 print_file(file, indent, "0x50, /* FC_IN_OUT_PARAM */\n");
920 print_file(file, indent, "0x51, /* FC_OUT_PARAM */\n");
922 print_file(file, indent, "0x4d, /* FC_IN_PARAM */\n");
924 size = get_stack_size( type, attrs, NULL );
925 print_file(file, indent, "0x%02x,\n", size / pointer_size );
926 print_file(file, indent, "NdrFcShort(0x%x), /* type offset = %u */\n",
927 type->typestring_offset, type->typestring_offset);
928 size = 4; /* includes param type prefix */
933 int is_interpreted_func( const type_t *iface, const var_t *func )
937 const var_list_t *args = type_get_function_args( func->type );
938 const type_t *ret_type = type_function_get_rettype( func->type );
940 if (type_get_type( ret_type ) == TYPE_BASIC)
942 switch (type_basic_get_type( ret_type ))
944 case TYPE_BASIC_INT64:
945 case TYPE_BASIC_HYPER:
946 /* return value must fit in a long_ptr */
947 if (pointer_size < 8) return 0;
949 case TYPE_BASIC_FLOAT:
950 case TYPE_BASIC_DOUBLE:
951 /* floating point values can't be returned */
957 /* unions passed by value are not supported */
958 if (args) LIST_FOR_EACH_ENTRY( var, args, const var_t, entry )
959 if (type_get_type( var->type ) == TYPE_UNION ||
960 type_get_type( var->type ) == TYPE_ENCAPSULATED_UNION)
963 if ((str = get_attrp( func->attrs, ATTR_OPTIMIZE ))) return !strcmp( str, "i" );
964 if ((str = get_attrp( iface->attrs, ATTR_OPTIMIZE ))) return !strcmp( str, "i" );
965 return (stub_mode != MODE_Os);
968 static void write_procformatstring_func( FILE *file, int indent,
969 const var_t *func, unsigned int *offset )
971 /* emit argument data */
972 if (type_get_function_args(func->type))
975 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
977 print_file( file, 0, "/* %u (parameter %s) */\n", *offset, var->name );
978 *offset += write_procformatstring_type(file, indent, var->type, var->attrs, FALSE);
982 /* emit return value data */
983 if (is_void(type_function_get_rettype(func->type)))
985 print_file(file, 0, "/* %u (void) */\n", *offset);
986 print_file(file, indent, "0x5b, /* FC_END */\n");
987 print_file(file, indent, "0x5c, /* FC_PAD */\n");
992 print_file( file, 0, "/* %u (return value) */\n", *offset );
993 *offset += write_procformatstring_type(file, indent, type_function_get_rettype(func->type), NULL, TRUE);
997 static void write_procformatstring_stmts(FILE *file, int indent, const statement_list_t *stmts,
998 type_pred_t pred, unsigned int *offset)
1000 const statement_t *stmt;
1001 if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
1003 if (stmt->type == STMT_TYPE && type_get_type(stmt->u.type) == TYPE_INTERFACE)
1005 const statement_t *stmt_func;
1006 if (!pred(stmt->u.type))
1008 STATEMENTS_FOR_EACH_FUNC(stmt_func, type_iface_get_stmts(stmt->u.type))
1010 const var_t *func = stmt_func->u.var;
1011 if (is_local(func->attrs)) continue;
1012 write_procformatstring_func( file, indent, func, offset );
1015 else if (stmt->type == STMT_LIBRARY)
1016 write_procformatstring_stmts(file, indent, stmt->u.lib->stmts, pred, offset);
1020 void write_procformatstring(FILE *file, const statement_list_t *stmts, type_pred_t pred)
1023 unsigned int offset = 0;
1025 print_file(file, indent, "static const MIDL_PROC_FORMAT_STRING __MIDL_ProcFormatString =\n");
1026 print_file(file, indent, "{\n");
1028 print_file(file, indent, "0,\n");
1029 print_file(file, indent, "{\n");
1032 write_procformatstring_stmts(file, indent, stmts, pred, &offset);
1034 print_file(file, indent, "0x0\n");
1036 print_file(file, indent, "}\n");
1038 print_file(file, indent, "};\n");
1039 print_file(file, indent, "\n");
1042 void write_procformatstring_offsets( FILE *file, const type_t *iface )
1044 const statement_t *stmt;
1047 print_file( file, indent, "static const unsigned short %s_FormatStringOffsetTable[] =\n",
1049 print_file( file, indent, "{\n" );
1051 STATEMENTS_FOR_EACH_FUNC( stmt, type_iface_get_stmts(iface) )
1053 var_t *func = stmt->u.var;
1054 if (is_local( func->attrs )) continue;
1055 print_file( file, indent, "%u, /* %s */\n", func->procstring_offset, func->name );
1058 print_file( file, indent, "};\n\n" );
1061 static int write_base_type(FILE *file, const type_t *type, int convert_to_signed_type, unsigned int *typestring_offset)
1065 if (type_get_type(type) == TYPE_BASIC)
1066 fc = get_basic_fc(type);
1067 else if (type_get_type(type) == TYPE_ENUM)
1068 fc = get_enum_fc(type);
1072 if (convert_to_signed_type)
1088 print_file(file, 2, "0x%02x,\t/* %s */\n", fc, string_of_type(fc));
1089 *typestring_offset += 1;
1093 /* write conformance / variance descriptor */
1094 static unsigned int write_conf_or_var_desc(FILE *file, const type_t *cont_type,
1095 unsigned int baseoff, const type_t *type,
1098 unsigned char operator_type = 0;
1099 unsigned char conftype = RPC_FC_NORMAL_CONFORMANCE;
1100 const char *conftype_string = "field";
1101 const expr_t *subexpr;
1102 const type_t *iface = NULL;
1107 print_file(file, 2, "NdrFcLong(0xffffffff),\t/* -1 */\n");
1113 if (expr->cval > UCHAR_MAX * (USHRT_MAX + 1) + USHRT_MAX)
1114 error("write_conf_or_var_desc: constant value %d is greater than "
1115 "the maximum constant size of %d\n", expr->cval,
1116 UCHAR_MAX * (USHRT_MAX + 1) + USHRT_MAX);
1118 print_file(file, 2, "0x%x, /* Corr desc: constant, val = %d */\n",
1119 RPC_FC_CONSTANT_CONFORMANCE, expr->cval);
1120 print_file(file, 2, "0x%x,\n", expr->cval >> 16);
1121 print_file(file, 2, "NdrFcShort(0x%hx),\n", (unsigned short)expr->cval);
1126 if (!cont_type) /* top-level conformance */
1128 conftype = RPC_FC_TOP_LEVEL_CONFORMANCE;
1129 conftype_string = "parameter";
1130 cont_type = current_func->type;
1131 name = current_func->name;
1132 iface = current_iface;
1136 name = cont_type->name;
1137 if (is_ptr(type) || (is_array(type) && type_array_is_decl_as_ptr(type)))
1139 conftype = RPC_FC_POINTER_CONFORMANCE;
1140 conftype_string = "field pointer";
1145 switch (subexpr->type)
1148 subexpr = subexpr->ref;
1149 operator_type = RPC_FC_DEREFERENCE;
1152 if (subexpr->u.ext->is_const && (subexpr->u.ext->cval == 2))
1154 subexpr = subexpr->ref;
1155 operator_type = RPC_FC_DIV_2;
1159 if (subexpr->u.ext->is_const && (subexpr->u.ext->cval == 2))
1161 subexpr = subexpr->ref;
1162 operator_type = RPC_FC_MULT_2;
1166 if (subexpr->u.ext->is_const && (subexpr->u.ext->cval == 1))
1168 subexpr = subexpr->ref;
1169 operator_type = RPC_FC_SUB_1;
1173 if (subexpr->u.ext->is_const && (subexpr->u.ext->cval == 1))
1175 subexpr = subexpr->ref;
1176 operator_type = RPC_FC_ADD_1;
1183 if (subexpr->type == EXPR_IDENTIFIER)
1185 const type_t *correlation_variable = NULL;
1186 unsigned char param_type = 0;
1187 unsigned int offset = 0;
1189 struct expr_loc expr_loc;
1191 if (type_get_type(cont_type) == TYPE_FUNCTION)
1193 var_list_t *args = type_get_function_args( cont_type );
1195 if (is_object( iface )) offset += pointer_size;
1196 if (args) LIST_FOR_EACH_ENTRY( var, args, const var_t, entry )
1198 if (var->name && !strcmp(var->name, subexpr->u.sval))
1201 correlation_variable = var->type;
1204 offset += get_stack_size( var->type, var->attrs, NULL );
1209 var_list_t *fields = type_struct_get_fields( cont_type );
1211 if (fields) LIST_FOR_EACH_ENTRY( var, fields, const var_t, entry )
1213 unsigned int size = field_memsize( var->type, &offset );
1214 if (var->name && !strcmp(var->name, subexpr->u.sval))
1217 correlation_variable = var->type;
1224 if (!correlation_variable)
1225 error("write_conf_or_var_desc: couldn't find variable %s in %s\n", subexpr->u.sval, name);
1226 expr_loc.attr = NULL;
1227 correlation_variable = expr_resolve_type(&expr_loc, cont_type, expr);
1231 if (type_get_type(correlation_variable) == TYPE_BASIC)
1233 switch (get_basic_fc(correlation_variable))
1237 param_type = RPC_FC_SMALL;
1241 param_type = RPC_FC_USMALL;
1245 param_type = RPC_FC_SHORT;
1248 param_type = RPC_FC_USHORT;
1251 param_type = RPC_FC_LONG;
1254 param_type = RPC_FC_ULONG;
1257 error("write_conf_or_var_desc: conformance variable type not supported 0x%x\n",
1258 get_basic_fc(correlation_variable));
1261 else if (type_get_type(correlation_variable) == TYPE_ENUM)
1263 if (get_enum_fc(correlation_variable) == RPC_FC_ENUM32)
1264 param_type = RPC_FC_LONG;
1266 param_type = RPC_FC_SHORT;
1268 else if (type_get_type(correlation_variable) == TYPE_POINTER)
1270 if (pointer_size == 8)
1271 param_type = RPC_FC_HYPER;
1273 param_type = RPC_FC_LONG;
1277 error("write_conf_or_var_desc: non-arithmetic type used as correlation variable %s\n",
1282 print_file(file, 2, "0x%x,\t/* Corr desc: %s %s, %s */\n",
1283 conftype | param_type, conftype_string, subexpr->u.sval, string_of_type(param_type));
1284 print_file(file, 2, "0x%x,\t/* %s */\n", operator_type,
1285 operator_type ? string_of_type(operator_type) : "no operators");
1286 print_file(file, 2, "NdrFcShort(0x%hx),\t/* offset = %d */\n",
1287 (unsigned short)offset, offset);
1289 else if (!iface || is_interpreted_func( iface, current_func ))
1291 unsigned int callback_offset = 0;
1292 struct expr_eval_routine *eval;
1295 LIST_FOR_EACH_ENTRY(eval, &expr_eval_routines, struct expr_eval_routine, entry)
1297 if (eval->cont_type == cont_type ||
1298 (type_get_type( eval->cont_type ) == type_get_type( cont_type ) &&
1299 eval->iface == iface &&
1300 eval->name && name && !strcmp(eval->name, name) &&
1301 !compare_expr(eval->expr, expr)))
1311 eval = xmalloc (sizeof(*eval));
1312 eval->iface = iface;
1313 eval->cont_type = cont_type;
1314 eval->name = xstrdup( name );
1315 eval->baseoff = baseoff;
1317 list_add_tail (&expr_eval_routines, &eval->entry);
1320 if (callback_offset > USHRT_MAX)
1321 error("Maximum number of callback routines reached\n");
1323 print_file(file, 2, "0x%x,\t/* Corr desc: %s in %s */\n", conftype, conftype_string, name);
1324 print_file(file, 2, "0x%x,\t/* %s */\n", RPC_FC_CALLBACK, "FC_CALLBACK");
1325 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)callback_offset, callback_offset);
1327 else /* output a dummy corr desc that isn't used */
1329 print_file(file, 2, "0x%x,\t/* Corr desc: unused for %s */\n", conftype, name);
1330 print_file(file, 2, "0x0,\n" );
1331 print_file(file, 2, "NdrFcShort(0x0),\n" );
1336 /* return size and start offset of a data field based on current offset */
1337 static unsigned int field_memsize(const type_t *type, unsigned int *offset)
1339 unsigned int align = 0;
1340 unsigned int size = type_memsize_and_alignment( type, &align );
1342 *offset = ROUND_SIZE( *offset, align );
1346 static unsigned int fields_memsize(const var_list_t *fields, unsigned int *align)
1348 unsigned int size = 0;
1349 unsigned int max_align;
1352 if (!fields) return 0;
1353 LIST_FOR_EACH_ENTRY( v, fields, const var_t, entry )
1355 unsigned int falign = 0;
1356 unsigned int fsize = type_memsize_and_alignment(v->type, &falign);
1357 if (*align < falign) *align = falign;
1358 falign = clamp_align(falign);
1359 size = ROUND_SIZE(size, falign);
1363 max_align = clamp_align(*align);
1364 size = ROUND_SIZE(size, max_align);
1369 static unsigned int union_memsize(const var_list_t *fields, unsigned int *pmaxa)
1371 unsigned int size, maxs = 0;
1372 unsigned int align = *pmaxa;
1375 if (fields) LIST_FOR_EACH_ENTRY( v, fields, const var_t, entry )
1377 /* we could have an empty default field with NULL type */
1380 size = type_memsize_and_alignment(v->type, &align);
1381 if (maxs < size) maxs = size;
1382 if (*pmaxa < align) *pmaxa = align;
1389 static unsigned int type_memsize_and_alignment(const type_t *t, unsigned int *align)
1391 unsigned int size = 0;
1393 switch (type_get_type(t))
1396 switch (get_basic_fc(t))
1403 if (size > *align) *align = size;
1409 if (size > *align) *align = size;
1413 case RPC_FC_ERROR_STATUS_T:
1416 if (size > *align) *align = size;
1421 if (size > *align) *align = size;
1423 case RPC_FC_INT3264:
1424 case RPC_FC_UINT3264:
1425 case RPC_FC_BIND_PRIMITIVE:
1426 assert( pointer_size );
1427 size = pointer_size;
1428 if (size > *align) *align = size;
1431 error("type_memsize: Unknown type 0x%x\n", get_basic_fc(t));
1436 switch (get_enum_fc(t))
1441 if (size > *align) *align = size;
1444 error("type_memsize: Unknown enum type\n");
1449 size = fields_memsize(type_struct_get_fields(t), align);
1451 case TYPE_ENCAPSULATED_UNION:
1452 size = fields_memsize(type_encapsulated_union_get_fields(t), align);
1455 size = union_memsize(type_union_get_cases(t), align);
1458 assert( pointer_size );
1459 size = pointer_size;
1460 if (size > *align) *align = size;
1463 if (!type_array_is_decl_as_ptr(t))
1465 if (is_conformant_array(t))
1467 type_memsize_and_alignment(type_array_get_element(t), align);
1471 size = type_array_get_dim(t) *
1472 type_memsize_and_alignment(type_array_get_element(t), align);
1474 else /* declared as a pointer */
1476 assert( pointer_size );
1477 size = pointer_size;
1478 if (size > *align) *align = size;
1481 case TYPE_INTERFACE:
1488 /* these types should not be encountered here due to language
1489 * restrictions (interface, void, coclass, module), logical
1490 * restrictions (alias - due to type_get_type call above) or
1491 * checking restrictions (function, bitfield). */
1498 unsigned int type_memsize(const type_t *t)
1500 unsigned int align = 0;
1501 return type_memsize_and_alignment( t, &align );
1504 static unsigned int type_buffer_alignment(const type_t *t)
1506 const var_list_t *fields;
1508 unsigned int max = 0, align;
1510 switch (type_get_type(t))
1513 switch (get_basic_fc(t))
1526 case RPC_FC_ERROR_STATUS_T:
1528 case RPC_FC_INT3264:
1529 case RPC_FC_UINT3264:
1535 error("type_buffer_alignment: Unknown type 0x%x\n", get_basic_fc(t));
1539 switch (get_enum_fc(t))
1546 error("type_buffer_alignment: Unknown enum type\n");
1550 if (!(fields = type_struct_get_fields(t))) break;
1551 LIST_FOR_EACH_ENTRY( var, fields, const var_t, entry )
1553 if (!var->type) continue;
1554 align = type_buffer_alignment( var->type );
1555 if (max < align) max = align;
1558 case TYPE_ENCAPSULATED_UNION:
1559 if (!(fields = type_encapsulated_union_get_fields(t))) break;
1560 LIST_FOR_EACH_ENTRY( var, fields, const var_t, entry )
1562 if (!var->type) continue;
1563 align = type_buffer_alignment( var->type );
1564 if (max < align) max = align;
1568 if (!(fields = type_union_get_cases(t))) break;
1569 LIST_FOR_EACH_ENTRY( var, fields, const var_t, entry )
1571 if (!var->type) continue;
1572 align = type_buffer_alignment( var->type );
1573 if (max < align) max = align;
1577 if (!type_array_is_decl_as_ptr(t))
1578 return type_buffer_alignment( type_array_get_element(t) );
1579 /* else fall through */
1582 case TYPE_INTERFACE:
1589 /* these types should not be encountered here due to language
1590 * restrictions (interface, void, coclass, module), logical
1591 * restrictions (alias - due to type_get_type call above) or
1592 * checking restrictions (function, bitfield). */
1598 int is_full_pointer_function(const var_t *func)
1601 if (type_has_full_pointer(type_function_get_rettype(func->type), func->attrs, TRUE))
1603 if (!type_get_function_args(func->type))
1605 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
1606 if (type_has_full_pointer( var->type, var->attrs, TRUE ))
1611 void write_full_pointer_init(FILE *file, int indent, const var_t *func, int is_server)
1613 print_file(file, indent, "__frame->_StubMsg.FullPtrXlatTables = NdrFullPointerXlatInit(0,%s);\n",
1614 is_server ? "XLAT_SERVER" : "XLAT_CLIENT");
1615 fprintf(file, "\n");
1618 void write_full_pointer_free(FILE *file, int indent, const var_t *func)
1620 print_file(file, indent, "NdrFullPointerXlatFree(__frame->_StubMsg.FullPtrXlatTables);\n");
1621 fprintf(file, "\n");
1624 static unsigned int write_nonsimple_pointer(FILE *file, const attr_list_t *attrs,
1627 unsigned int offset,
1628 unsigned int *typeformat_offset)
1630 unsigned int start_offset = *typeformat_offset;
1631 short reloff = offset - (*typeformat_offset + 2);
1632 int in_attr, out_attr;
1634 unsigned char flags = 0;
1636 pointer_type = get_pointer_fc(type, attrs, toplevel_param);
1638 in_attr = is_attr(attrs, ATTR_IN);
1639 out_attr = is_attr(attrs, ATTR_OUT);
1640 if (!in_attr && !out_attr) in_attr = 1;
1642 if (out_attr && !in_attr && pointer_type == RPC_FC_RP)
1643 flags |= RPC_FC_P_ONSTACK;
1647 type_t *ref = type_pointer_get_ref(type);
1648 if(is_declptr(ref) && !is_user_type(ref))
1649 flags |= RPC_FC_P_DEREF;
1652 print_file(file, 2, "0x%x, 0x%x,\t\t/* %s",
1655 string_of_type(pointer_type));
1658 if (flags & RPC_FC_P_ONSTACK)
1659 fprintf(file, " [allocated_on_stack]");
1660 if (flags & RPC_FC_P_DEREF)
1661 fprintf(file, " [pointer_deref]");
1662 fprintf(file, " */\n");
1665 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %hd (%u) */\n", reloff, reloff, offset);
1666 *typeformat_offset += 4;
1668 return start_offset;
1671 static unsigned int write_simple_pointer(FILE *file, const attr_list_t *attrs, const type_t *type, int toplevel_param)
1674 unsigned char pointer_fc;
1676 int in_attr = is_attr(attrs, ATTR_IN);
1677 int out_attr = is_attr(attrs, ATTR_OUT);
1678 unsigned char flags = RPC_FC_P_SIMPLEPOINTER;
1680 /* for historical reasons, write_simple_pointer also handled string types,
1681 * but no longer does. catch bad uses of the function with this check */
1682 if (is_string_type(attrs, type))
1683 error("write_simple_pointer: can't handle type %s which is a string type\n", type->name);
1685 pointer_fc = get_pointer_fc(type, attrs, toplevel_param);
1687 ref = type_pointer_get_ref(type);
1688 if (type_get_type(ref) == TYPE_ENUM)
1689 fc = get_enum_fc(ref);
1691 fc = get_basic_fc(ref);
1693 if (out_attr && !in_attr)
1694 flags |= RPC_FC_P_ONSTACK;
1696 print_file(file, 2, "0x%02x, 0x%x,\t/* %s %s[simple_pointer] */\n",
1697 pointer_fc, flags, string_of_type(pointer_fc),
1698 flags & RPC_FC_P_ONSTACK ? "[allocated_on_stack] " : "");
1699 print_file(file, 2, "0x%02x,\t/* %s */\n", fc, string_of_type(fc));
1700 print_file(file, 2, "0x5c,\t/* FC_PAD */\n");
1704 static void print_start_tfs_comment(FILE *file, type_t *t, unsigned int tfsoff)
1706 print_file(file, 0, "/* %u (", tfsoff);
1707 write_type_decl(file, t, NULL);
1708 print_file(file, 0, ") */\n");
1711 static unsigned int write_pointer_tfs(FILE *file, const attr_list_t *attrs,
1712 type_t *type, unsigned int ref_offset,
1714 unsigned int *typestring_offset)
1716 unsigned int offset = *typestring_offset;
1717 type_t *ref = type_pointer_get_ref(type);
1719 print_start_tfs_comment(file, type, offset);
1720 update_tfsoff(type, offset, file);
1722 switch (typegen_detect_type(ref, attrs, TDT_ALL_TYPES))
1726 *typestring_offset += write_simple_pointer(file, attrs, type,
1731 write_nonsimple_pointer(file, attrs, type,
1741 static int processed(const type_t *type)
1743 return type->typestring_offset && !type->tfswrite;
1746 static int user_type_has_variable_size(const type_t *t)
1750 else if (type_get_type(t) == TYPE_STRUCT)
1752 switch (get_struct_fc(t))
1754 case RPC_FC_PSTRUCT:
1755 case RPC_FC_CSTRUCT:
1756 case RPC_FC_CPSTRUCT:
1757 case RPC_FC_CVSTRUCT:
1761 /* Note: Since this only applies to user types, we can't have a conformant
1762 array here, and strings should get filed under pointer in this case. */
1766 static unsigned int write_user_tfs(FILE *file, type_t *type, unsigned int *tfsoff)
1768 unsigned int start, absoff, flags;
1769 const char *name = NULL;
1770 type_t *utype = get_user_type(type, &name);
1771 unsigned int usize = type_memsize(utype);
1772 unsigned int ualign = type_buffer_alignment(utype);
1773 unsigned int size = type_memsize(type);
1774 unsigned short funoff = user_type_offset(name);
1777 if (processed(type)) return type->typestring_offset;
1781 if(user_type_has_variable_size(utype)) usize = 0;
1783 if (type_get_type(utype) == TYPE_BASIC ||
1784 type_get_type(utype) == TYPE_ENUM)
1788 if (type_get_type(utype) == TYPE_ENUM)
1789 fc = get_enum_fc(utype);
1791 fc = get_basic_fc(utype);
1794 print_start_tfs_comment(file, utype, absoff);
1795 print_file(file, 2, "0x%x,\t/* %s */\n", fc, string_of_type(fc));
1796 print_file(file, 2, "0x5c,\t/* FC_PAD */\n");
1801 if (!processed(utype))
1802 write_embedded_types(file, NULL, utype, utype->name, TRUE, tfsoff);
1803 absoff = utype->typestring_offset;
1806 if (type_get_type(utype) == TYPE_POINTER && get_pointer_fc(utype, NULL, FALSE) == RPC_FC_RP)
1808 else if (type_get_type(utype) == TYPE_POINTER && get_pointer_fc(utype, NULL, FALSE) == RPC_FC_UP)
1814 update_tfsoff(type, start, file);
1815 print_start_tfs_comment(file, type, start);
1816 print_file(file, 2, "0x%x,\t/* FC_USER_MARSHAL */\n", RPC_FC_USER_MARSHAL);
1817 print_file(file, 2, "0x%x,\t/* Alignment= %d, Flags= %02x */\n",
1818 flags | (ualign - 1), ualign - 1, flags);
1819 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Function offset= %hu */\n", funoff, funoff);
1820 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)size, size);
1821 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)usize, usize);
1823 reloff = absoff - *tfsoff;
1824 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %hd (%u) */\n", reloff, reloff, absoff);
1829 static void write_member_type(FILE *file, const type_t *cont,
1830 int cont_is_complex, const attr_list_t *attrs,
1831 const type_t *type, unsigned int *corroff,
1832 unsigned int *tfsoff)
1834 if (is_embedded_complex(type) && !is_conformant_array(type))
1836 unsigned int absoff;
1839 if (type_get_type(type) == TYPE_UNION && is_attr(attrs, ATTR_SWITCHIS))
1846 absoff = type->typestring_offset;
1848 reloff = absoff - (*tfsoff + 2);
1850 print_file(file, 2, "0x4c,\t/* FC_EMBEDDED_COMPLEX */\n");
1851 /* padding is represented using FC_STRUCTPAD* types, so presumably
1852 * this is left over in the format for historical purposes in MIDL
1854 print_file(file, 2, "0x0,\n");
1855 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %hd (%u) */\n",
1856 reloff, reloff, absoff);
1859 else if (is_ptr(type) || is_conformant_array(type))
1861 unsigned char fc = cont_is_complex ? RPC_FC_POINTER : RPC_FC_LONG;
1862 print_file(file, 2, "0x%x,\t/* %s */\n", fc, string_of_type(fc));
1865 else if (!write_base_type(file, type, TRUE, tfsoff))
1866 error("Unsupported member type %d\n", type_get_type(type));
1869 static void write_array_element_type(FILE *file, const type_t *type,
1870 int cont_is_complex, unsigned int *tfsoff)
1872 type_t *elem = type_array_get_element(type);
1874 if (!is_embedded_complex(elem) && is_ptr(elem))
1876 type_t *ref = type_pointer_get_ref(elem);
1880 write_nonsimple_pointer(file, NULL, elem, FALSE, ref->typestring_offset, tfsoff);
1883 if (!is_string_type(NULL, elem) &&
1884 (type_get_type(ref) == TYPE_BASIC || type_get_type(ref) == TYPE_ENUM))
1886 *tfsoff += write_simple_pointer(file, NULL, elem, FALSE);
1890 return write_member_type(file, type, cont_is_complex, NULL, elem, NULL, tfsoff);
1893 static void write_end(FILE *file, unsigned int *tfsoff)
1895 if (*tfsoff % 2 == 0)
1897 print_file(file, 2, "0x%x,\t\t/* FC_PAD */\n", RPC_FC_PAD);
1900 print_file(file, 2, "0x%x,\t\t/* FC_END */\n", RPC_FC_END);
1904 static void write_descriptors(FILE *file, type_t *type, unsigned int *tfsoff)
1906 unsigned int offset = 0;
1907 var_list_t *fs = type_struct_get_fields(type);
1910 if (fs) LIST_FOR_EACH_ENTRY(f, fs, var_t, entry)
1912 type_t *ft = f->type;
1913 unsigned int size = field_memsize( ft, &offset );
1914 if (type_get_type(ft) == TYPE_UNION && is_attr(f->attrs, ATTR_SWITCHIS))
1917 unsigned int absoff = ft->typestring_offset;
1918 if (is_attr(ft->attrs, ATTR_SWITCHTYPE))
1919 absoff += 8; /* we already have a corr descr, skip it */
1920 reloff = absoff - (*tfsoff + 6);
1921 print_file(file, 0, "/* %d */\n", *tfsoff);
1922 print_file(file, 2, "0x%x,\t/* FC_NON_ENCAPSULATED_UNION */\n", RPC_FC_NON_ENCAPSULATED_UNION);
1923 print_file(file, 2, "0x%x,\t/* FIXME: always FC_LONG */\n", RPC_FC_LONG);
1924 write_conf_or_var_desc(file, current_structure, offset, ft,
1925 get_attrp(f->attrs, ATTR_SWITCHIS));
1926 print_file(file, 2, "NdrFcShort(%hd),\t/* Offset= %hd (%u) */\n",
1927 reloff, reloff, absoff);
1934 static int write_pointer_description_offsets(
1935 FILE *file, const attr_list_t *attrs, type_t *type,
1936 unsigned int *offset_in_memory, unsigned int *offset_in_buffer,
1937 unsigned int *typestring_offset)
1941 if ((is_ptr(type) && type_get_type(type_pointer_get_ref(type)) != TYPE_INTERFACE) ||
1942 (is_array(type) && type_array_is_decl_as_ptr(type)))
1944 if (offset_in_memory && offset_in_buffer)
1946 unsigned int memsize;
1950 * note that MSDN states that for pointer layouts in structures,
1951 * this is a negative offset from the end of the structure, but
1952 * this statement is incorrect. all offsets are positive */
1953 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Memory offset = %d */\n", (unsigned short)*offset_in_memory, *offset_in_memory);
1954 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Buffer offset = %d */\n", (unsigned short)*offset_in_buffer, *offset_in_buffer);
1956 memsize = type_memsize(type);
1957 *offset_in_memory += memsize;
1958 /* increment these separately as in the case of conformant (varying)
1959 * structures these start at different values */
1960 *offset_in_buffer += memsize;
1962 *typestring_offset += 4;
1966 type_t *ref = type_pointer_get_ref(type);
1968 if (is_string_type(attrs, type))
1969 write_string_tfs(file, attrs, type, FALSE, NULL, typestring_offset);
1970 else if (processed(ref))
1971 write_nonsimple_pointer(file, attrs, type, FALSE, ref->typestring_offset, typestring_offset);
1972 else if (type_get_type(ref) == TYPE_BASIC || type_get_type(ref) == TYPE_ENUM)
1973 *typestring_offset += write_simple_pointer(file, attrs, type, FALSE);
1975 error("write_pointer_description_offsets: type format string unknown\n");
1979 unsigned int offset = type->typestring_offset;
1980 /* skip over the pointer that is written for strings, since a
1981 * pointer has to be written in-place here */
1982 if (is_string_type(attrs, type))
1984 write_nonsimple_pointer(file, attrs, type, FALSE, offset, typestring_offset);
1992 return write_pointer_description_offsets(
1993 file, attrs, type_array_get_element(type), offset_in_memory,
1994 offset_in_buffer, typestring_offset);
1996 else if (is_non_complex_struct(type))
1998 /* otherwise search for interesting fields to parse */
2000 LIST_FOR_EACH_ENTRY( v, type_struct_get_fields(type), const var_t, entry )
2002 if (offset_in_memory && offset_in_buffer)
2004 unsigned int padding;
2005 unsigned int align = 0;
2006 type_memsize_and_alignment(v->type, &align);
2007 padding = ROUNDING(*offset_in_memory, align);
2008 *offset_in_memory += padding;
2009 *offset_in_buffer += padding;
2011 written += write_pointer_description_offsets(
2012 file, v->attrs, v->type, offset_in_memory, offset_in_buffer,
2018 if (offset_in_memory && offset_in_buffer)
2020 unsigned int memsize = type_memsize(type);
2021 *offset_in_memory += memsize;
2022 /* increment these separately as in the case of conformant (varying)
2023 * structures these start at different values */
2024 *offset_in_buffer += memsize;
2031 static int write_no_repeat_pointer_descriptions(
2032 FILE *file, const attr_list_t *attrs, type_t *type,
2033 unsigned int *offset_in_memory, unsigned int *offset_in_buffer,
2034 unsigned int *typestring_offset)
2039 (is_conformant_array(type) && type_array_is_decl_as_ptr(type)))
2041 print_file(file, 2, "0x%02x, /* FC_NO_REPEAT */\n", RPC_FC_NO_REPEAT);
2042 print_file(file, 2, "0x%02x, /* FC_PAD */\n", RPC_FC_PAD);
2043 *typestring_offset += 2;
2045 return write_pointer_description_offsets(file, attrs, type,
2046 offset_in_memory, offset_in_buffer, typestring_offset);
2049 if (is_non_complex_struct(type))
2052 LIST_FOR_EACH_ENTRY( v, type_struct_get_fields(type), const var_t, entry )
2054 if (offset_in_memory && offset_in_buffer)
2056 unsigned int padding;
2057 unsigned int align = 0;
2058 type_memsize_and_alignment(v->type, &align);
2059 padding = ROUNDING(*offset_in_memory, align);
2060 *offset_in_memory += padding;
2061 *offset_in_buffer += padding;
2063 written += write_no_repeat_pointer_descriptions(
2064 file, v->attrs, v->type,
2065 offset_in_memory, offset_in_buffer, typestring_offset);
2070 unsigned int memsize = type_memsize(type);
2071 *offset_in_memory += memsize;
2072 /* increment these separately as in the case of conformant (varying)
2073 * structures these start at different values */
2074 *offset_in_buffer += memsize;
2080 /* Note: if file is NULL return value is number of pointers to write, else
2081 * it is the number of type format characters written */
2082 static int write_fixed_array_pointer_descriptions(
2083 FILE *file, const attr_list_t *attrs, type_t *type,
2084 unsigned int *offset_in_memory, unsigned int *offset_in_buffer,
2085 unsigned int *typestring_offset)
2087 int pointer_count = 0;
2089 if (type_get_type(type) == TYPE_ARRAY &&
2090 !type_array_has_conformance(type) && !type_array_has_variance(type))
2092 unsigned int temp = 0;
2093 /* unfortunately, this needs to be done in two passes to avoid
2094 * writing out redundant FC_FIXED_REPEAT descriptions */
2095 pointer_count = write_pointer_description_offsets(
2096 NULL, attrs, type_array_get_element(type), NULL, NULL, &temp);
2097 if (pointer_count > 0)
2099 unsigned int increment_size;
2100 unsigned int offset_of_array_pointer_mem = 0;
2101 unsigned int offset_of_array_pointer_buf = 0;
2103 increment_size = type_memsize(type_array_get_element(type));
2105 print_file(file, 2, "0x%02x, /* FC_FIXED_REPEAT */\n", RPC_FC_FIXED_REPEAT);
2106 print_file(file, 2, "0x%02x, /* FC_PAD */\n", RPC_FC_PAD);
2107 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Iterations = %d */\n", (unsigned short)type_array_get_dim(type), type_array_get_dim(type));
2108 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Increment = %d */\n", (unsigned short)increment_size, increment_size);
2109 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset to array = %d */\n", (unsigned short)*offset_in_memory, *offset_in_memory);
2110 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Number of pointers = %d */\n", (unsigned short)pointer_count, pointer_count);
2111 *typestring_offset += 10;
2113 pointer_count = write_pointer_description_offsets(
2114 file, attrs, type, &offset_of_array_pointer_mem,
2115 &offset_of_array_pointer_buf, typestring_offset);
2118 else if (type_get_type(type) == TYPE_STRUCT)
2121 LIST_FOR_EACH_ENTRY( v, type_struct_get_fields(type), const var_t, entry )
2123 if (offset_in_memory && offset_in_buffer)
2125 unsigned int padding;
2126 unsigned int align = 0;
2127 type_memsize_and_alignment(v->type, &align);
2128 padding = ROUNDING(*offset_in_memory, align);
2129 *offset_in_memory += padding;
2130 *offset_in_buffer += padding;
2132 pointer_count += write_fixed_array_pointer_descriptions(
2133 file, v->attrs, v->type, offset_in_memory, offset_in_buffer,
2139 if (offset_in_memory && offset_in_buffer)
2141 unsigned int memsize;
2142 memsize = type_memsize(type);
2143 *offset_in_memory += memsize;
2144 /* increment these separately as in the case of conformant (varying)
2145 * structures these start at different values */
2146 *offset_in_buffer += memsize;
2150 return pointer_count;
2153 /* Note: if file is NULL return value is number of pointers to write, else
2154 * it is the number of type format characters written */
2155 static int write_conformant_array_pointer_descriptions(
2156 FILE *file, const attr_list_t *attrs, type_t *type,
2157 unsigned int offset_in_memory, unsigned int *typestring_offset)
2159 int pointer_count = 0;
2161 if (is_conformant_array(type) && !type_array_has_variance(type))
2163 unsigned int temp = 0;
2164 /* unfortunately, this needs to be done in two passes to avoid
2165 * writing out redundant FC_VARIABLE_REPEAT descriptions */
2166 pointer_count = write_pointer_description_offsets(
2167 NULL, attrs, type_array_get_element(type), NULL, NULL, &temp);
2168 if (pointer_count > 0)
2170 unsigned int increment_size;
2171 unsigned int offset_of_array_pointer_mem = offset_in_memory;
2172 unsigned int offset_of_array_pointer_buf = offset_in_memory;
2174 increment_size = type_memsize(type_array_get_element(type));
2176 if (increment_size > USHRT_MAX)
2177 error("array size of %u bytes is too large\n", increment_size);
2179 print_file(file, 2, "0x%02x, /* FC_VARIABLE_REPEAT */\n", RPC_FC_VARIABLE_REPEAT);
2180 print_file(file, 2, "0x%02x, /* FC_FIXED_OFFSET */\n", RPC_FC_FIXED_OFFSET);
2181 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Increment = %d */\n", (unsigned short)increment_size, increment_size);
2182 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset to array = %d */\n", (unsigned short)offset_in_memory, offset_in_memory);
2183 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Number of pointers = %d */\n", (unsigned short)pointer_count, pointer_count);
2184 *typestring_offset += 8;
2186 pointer_count = write_pointer_description_offsets(
2187 file, attrs, type_array_get_element(type),
2188 &offset_of_array_pointer_mem, &offset_of_array_pointer_buf,
2193 return pointer_count;
2196 /* Note: if file is NULL return value is number of pointers to write, else
2197 * it is the number of type format characters written */
2198 static int write_varying_array_pointer_descriptions(
2199 FILE *file, const attr_list_t *attrs, type_t *type,
2200 unsigned int *offset_in_memory, unsigned int *offset_in_buffer,
2201 unsigned int *typestring_offset)
2203 int pointer_count = 0;
2205 if (is_array(type) && type_array_has_variance(type))
2207 unsigned int temp = 0;
2208 /* unfortunately, this needs to be done in two passes to avoid
2209 * writing out redundant FC_VARIABLE_REPEAT descriptions */
2210 pointer_count = write_pointer_description_offsets(
2211 NULL, attrs, type_array_get_element(type), NULL, NULL, &temp);
2212 if (pointer_count > 0)
2214 unsigned int increment_size;
2216 increment_size = type_memsize(type_array_get_element(type));
2218 if (increment_size > USHRT_MAX)
2219 error("array size of %u bytes is too large\n", increment_size);
2221 print_file(file, 2, "0x%02x, /* FC_VARIABLE_REPEAT */\n", RPC_FC_VARIABLE_REPEAT);
2222 print_file(file, 2, "0x%02x, /* FC_VARIABLE_OFFSET */\n", RPC_FC_VARIABLE_OFFSET);
2223 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Increment = %d */\n", (unsigned short)increment_size, increment_size);
2224 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset to array = %d */\n", (unsigned short)*offset_in_memory, *offset_in_memory);
2225 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Number of pointers = %d */\n", (unsigned short)pointer_count, pointer_count);
2226 *typestring_offset += 8;
2228 pointer_count = write_pointer_description_offsets(
2229 file, attrs, type_array_get_element(type), offset_in_memory,
2230 offset_in_buffer, typestring_offset);
2233 else if (type_get_type(type) == TYPE_STRUCT)
2236 LIST_FOR_EACH_ENTRY( v, type_struct_get_fields(type), const var_t, entry )
2238 if (offset_in_memory && offset_in_buffer)
2240 unsigned int align = 0, padding;
2242 if (is_array(v->type) && type_array_has_variance(v->type))
2244 *offset_in_buffer = ROUND_SIZE(*offset_in_buffer, 4);
2245 /* skip over variance and offset in buffer */
2246 *offset_in_buffer += 8;
2249 type_memsize_and_alignment(v->type, &align);
2250 padding = ROUNDING(*offset_in_memory, align);
2251 *offset_in_memory += padding;
2252 *offset_in_buffer += padding;
2254 pointer_count += write_varying_array_pointer_descriptions(
2255 file, v->attrs, v->type, offset_in_memory, offset_in_buffer,
2261 if (offset_in_memory && offset_in_buffer)
2263 unsigned int memsize = type_memsize(type);
2264 *offset_in_memory += memsize;
2265 /* increment these separately as in the case of conformant (varying)
2266 * structures these start at different values */
2267 *offset_in_buffer += memsize;
2271 return pointer_count;
2274 static void write_pointer_description(FILE *file, type_t *type,
2275 unsigned int *typestring_offset)
2277 unsigned int offset_in_buffer;
2278 unsigned int offset_in_memory;
2280 /* pass 1: search for single instance of a pointer (i.e. don't descend
2282 if (!is_array(type))
2284 offset_in_memory = 0;
2285 offset_in_buffer = 0;
2286 write_no_repeat_pointer_descriptions(
2288 &offset_in_memory, &offset_in_buffer, typestring_offset);
2291 /* pass 2: search for pointers in fixed arrays */
2292 offset_in_memory = 0;
2293 offset_in_buffer = 0;
2294 write_fixed_array_pointer_descriptions(
2296 &offset_in_memory, &offset_in_buffer, typestring_offset);
2298 /* pass 3: search for pointers in conformant only arrays (but don't descend
2299 * into conformant varying or varying arrays) */
2300 if (is_conformant_array(type) &&
2301 (type_array_is_decl_as_ptr(type) || !current_structure))
2302 write_conformant_array_pointer_descriptions(
2303 file, NULL, type, 0, typestring_offset);
2304 else if (type_get_type(type) == TYPE_STRUCT &&
2305 get_struct_fc(type) == RPC_FC_CPSTRUCT)
2307 type_t *carray = find_array_or_string_in_struct(type)->type;
2308 write_conformant_array_pointer_descriptions( file, NULL, carray,
2309 type_memsize(type), typestring_offset);
2312 /* pass 4: search for pointers in varying arrays */
2313 offset_in_memory = 0;
2314 offset_in_buffer = 0;
2315 write_varying_array_pointer_descriptions(
2317 &offset_in_memory, &offset_in_buffer, typestring_offset);
2320 int is_declptr(const type_t *t)
2322 return is_ptr(t) || (type_get_type(t) == TYPE_ARRAY && type_array_is_decl_as_ptr(t));
2325 static unsigned int write_string_tfs(FILE *file, const attr_list_t *attrs,
2326 type_t *type, int toplevel_param,
2327 const char *name, unsigned int *typestring_offset)
2329 unsigned int start_offset;
2330 unsigned char rtype;
2332 int is_processed = processed(type);
2334 start_offset = *typestring_offset;
2336 if (is_declptr(type))
2338 unsigned char flag = is_conformant_array(type) ? 0 : RPC_FC_P_SIMPLEPOINTER;
2339 int pointer_type = get_pointer_fc(type, attrs, toplevel_param);
2341 pointer_type = RPC_FC_RP;
2342 print_start_tfs_comment(file, type, *typestring_offset);
2343 print_file(file, 2,"0x%x, 0x%x,\t/* %s%s */\n",
2344 pointer_type, flag, string_of_type(pointer_type),
2345 flag ? " [simple_pointer]" : "");
2346 *typestring_offset += 2;
2349 print_file(file, 2, "NdrFcShort(0x2),\n");
2350 *typestring_offset += 2;
2352 is_processed = FALSE;
2356 elem_type = type_array_get_element(type);
2358 elem_type = type_pointer_get_ref(type);
2360 if (type_get_type(elem_type) != TYPE_BASIC)
2362 error("write_string_tfs: Unimplemented for non-basic type %s\n", name);
2363 return start_offset;
2366 rtype = get_basic_fc(elem_type);
2367 if ((rtype != RPC_FC_BYTE) && (rtype != RPC_FC_CHAR) && (rtype != RPC_FC_WCHAR))
2369 error("write_string_tfs: Unimplemented for type 0x%x of name: %s\n", rtype, name);
2370 return start_offset;
2373 if (type_get_type(type) == TYPE_ARRAY && !type_array_has_conformance(type))
2375 unsigned int dim = type_array_get_dim(type);
2377 if (is_processed) return start_offset;
2379 /* FIXME: multi-dimensional array */
2381 error("array size for parameter %s exceeds %u bytes by %u bytes\n",
2382 name, 0xffffu, dim - 0xffffu);
2384 if (rtype == RPC_FC_WCHAR)
2385 WRITE_FCTYPE(file, FC_WSTRING, *typestring_offset);
2387 WRITE_FCTYPE(file, FC_CSTRING, *typestring_offset);
2388 print_file(file, 2, "0x%x, /* FC_PAD */\n", RPC_FC_PAD);
2389 *typestring_offset += 2;
2391 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %d */\n", (unsigned short)dim, dim);
2392 *typestring_offset += 2;
2394 update_tfsoff(type, start_offset, file);
2395 return start_offset;
2397 else if (is_conformant_array(type))
2399 if (rtype == RPC_FC_WCHAR)
2400 WRITE_FCTYPE(file, FC_C_WSTRING, *typestring_offset);
2402 WRITE_FCTYPE(file, FC_C_CSTRING, *typestring_offset);
2403 print_file(file, 2, "0x%x, /* FC_STRING_SIZED */\n", RPC_FC_STRING_SIZED);
2404 *typestring_offset += 2;
2406 *typestring_offset += write_conf_or_var_desc(
2407 file, current_structure,
2408 (!type_array_is_decl_as_ptr(type) && current_structure
2409 ? type_memsize(current_structure)
2411 type, type_array_get_conformance(type));
2413 update_tfsoff(type, start_offset, file);
2414 return start_offset;
2418 if (is_processed) return start_offset;
2420 if (rtype == RPC_FC_WCHAR)
2421 WRITE_FCTYPE(file, FC_C_WSTRING, *typestring_offset);
2423 WRITE_FCTYPE(file, FC_C_CSTRING, *typestring_offset);
2424 print_file(file, 2, "0x%x, /* FC_PAD */\n", RPC_FC_PAD);
2425 *typestring_offset += 2;
2427 update_tfsoff(type, start_offset, file);
2428 return start_offset;
2432 static unsigned int write_array_tfs(FILE *file, const attr_list_t *attrs, type_t *type,
2433 const char *name, unsigned int *typestring_offset)
2435 const expr_t *length_is = type_array_get_variance(type);
2436 const expr_t *size_is = type_array_get_conformance(type);
2439 unsigned int start_offset;
2441 int pointer_type = get_attrv(attrs, ATTR_POINTERTYPE);
2442 unsigned int baseoff
2443 = !type_array_is_decl_as_ptr(type) && current_structure
2444 ? type_memsize(current_structure)
2448 pointer_type = RPC_FC_RP;
2450 write_embedded_types(file, attrs, type_array_get_element(type), name, FALSE, typestring_offset);
2452 size = type_memsize(is_conformant_array(type) ? type_array_get_element(type) : type);
2453 align = type_buffer_alignment(is_conformant_array(type) ? type_array_get_element(type) : type);
2454 fc = get_array_fc(type);
2456 start_offset = *typestring_offset;
2457 update_tfsoff(type, start_offset, file);
2458 print_start_tfs_comment(file, type, start_offset);
2459 print_file(file, 2, "0x%02x,\t/* %s */\n", fc, string_of_type(fc));
2460 print_file(file, 2, "0x%x,\t/* %d */\n", align - 1, align - 1);
2461 *typestring_offset += 2;
2464 if (fc != RPC_FC_BOGUS_ARRAY)
2466 if (fc == RPC_FC_LGFARRAY || fc == RPC_FC_LGVARRAY)
2468 print_file(file, 2, "NdrFcLong(0x%x),\t/* %u */\n", size, size);
2469 *typestring_offset += 4;
2473 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)size, size);
2474 *typestring_offset += 2;
2477 if (is_conformant_array(type))
2479 += write_conf_or_var_desc(file, current_structure, baseoff,
2482 if (fc == RPC_FC_SMVARRAY || fc == RPC_FC_LGVARRAY)
2484 unsigned int elsize = type_memsize(type_array_get_element(type));
2485 unsigned int dim = type_array_get_dim(type);
2487 if (fc == RPC_FC_LGVARRAY)
2489 print_file(file, 2, "NdrFcLong(0x%x),\t/* %u */\n", dim, dim);
2490 *typestring_offset += 4;
2494 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)dim, dim);
2495 *typestring_offset += 2;
2498 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)elsize, elsize);
2499 *typestring_offset += 2;
2504 += write_conf_or_var_desc(file, current_structure, baseoff,
2507 if (type_has_pointers(type_array_get_element(type)) &&
2508 (type_array_is_decl_as_ptr(type) || !current_structure))
2510 print_file(file, 2, "0x%x, /* FC_PP */\n", RPC_FC_PP);
2511 print_file(file, 2, "0x%x, /* FC_PAD */\n", RPC_FC_PAD);
2512 *typestring_offset += 2;
2513 write_pointer_description(file, type, typestring_offset);
2514 print_file(file, 2, "0x%x, /* FC_END */\n", RPC_FC_END);
2515 *typestring_offset += 1;
2518 write_array_element_type(file, type, FALSE, typestring_offset);
2519 write_end(file, typestring_offset);
2523 unsigned int dim = size_is ? 0 : type_array_get_dim(type);
2524 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %u */\n", (unsigned short)dim, dim);
2525 *typestring_offset += 2;
2527 += write_conf_or_var_desc(file, current_structure, baseoff,
2530 += write_conf_or_var_desc(file, current_structure, baseoff,
2533 write_array_element_type(file, type, TRUE, typestring_offset);
2534 write_end(file, typestring_offset);
2537 return start_offset;
2540 static const var_t *find_array_or_string_in_struct(const type_t *type)
2542 const var_list_t *fields = type_struct_get_fields(type);
2543 const var_t *last_field;
2546 if (!fields || list_empty(fields))
2549 last_field = LIST_ENTRY( list_tail(fields), const var_t, entry );
2550 ft = last_field->type;
2552 if (is_conformant_array(ft) && !type_array_is_decl_as_ptr(ft))
2555 if (type_get_type(ft) == TYPE_STRUCT)
2556 return find_array_or_string_in_struct(ft);
2561 static void write_struct_members(FILE *file, const type_t *type,
2562 int is_complex, unsigned int *corroff,
2563 unsigned int *typestring_offset)
2566 unsigned short offset = 0;
2567 unsigned int salign = 1;
2569 var_list_t *fields = type_struct_get_fields(type);
2571 if (fields) LIST_FOR_EACH_ENTRY( field, fields, const var_t, entry )
2573 type_t *ft = field->type;
2574 unsigned int align = 0;
2575 unsigned int size = type_memsize_and_alignment(ft, &align);
2576 align = clamp_align(align);
2577 if (salign < align) salign = align;
2579 if (!is_conformant_array(ft) || type_array_is_decl_as_ptr(ft))
2581 if ((align - 1) & offset)
2583 unsigned char fc = 0;
2587 fc = RPC_FC_ALIGNM2;
2590 fc = RPC_FC_ALIGNM4;
2593 fc = RPC_FC_ALIGNM8;
2596 error("write_struct_members: cannot align type %d\n", type_get_type(ft));
2598 print_file(file, 2, "0x%x,\t/* %s */\n", fc, string_of_type(fc));
2599 offset = ROUND_SIZE(offset, align);
2600 *typestring_offset += 1;
2602 write_member_type(file, type, is_complex, field->attrs, field->type, corroff,
2608 padding = ROUNDING(offset, salign);
2611 print_file(file, 2, "0x%x,\t/* FC_STRUCTPAD%d */\n",
2612 RPC_FC_STRUCTPAD1 + padding - 1,
2614 *typestring_offset += 1;
2617 write_end(file, typestring_offset);
2620 static unsigned int write_struct_tfs(FILE *file, type_t *type,
2621 const char *name, unsigned int *tfsoff)
2623 const type_t *save_current_structure = current_structure;
2624 unsigned int total_size;
2626 unsigned int start_offset;
2628 unsigned int corroff;
2630 unsigned char fc = get_struct_fc(type);
2631 var_list_t *fields = type_struct_get_fields(type);
2633 if (processed(type)) return type->typestring_offset;
2636 current_structure = type;
2638 total_size = type_memsize(type);
2639 align = type_buffer_alignment(type);
2640 if (total_size > USHRT_MAX)
2641 error("structure size for %s exceeds %d bytes by %d bytes\n",
2642 name, USHRT_MAX, total_size - USHRT_MAX);
2644 if (fields) LIST_FOR_EACH_ENTRY(f, fields, var_t, entry)
2645 write_embedded_types(file, f->attrs, f->type, f->name, FALSE, tfsoff);
2647 array = find_array_or_string_in_struct(type);
2648 if (array && !processed(array->type))
2650 if(is_string_type(array->attrs, array->type))
2651 write_string_tfs(file, array->attrs, array->type, FALSE, array->name, tfsoff);
2653 write_array_tfs(file, array->attrs, array->type, array->name, tfsoff);
2657 write_descriptors(file, type, tfsoff);
2659 start_offset = *tfsoff;
2660 update_tfsoff(type, start_offset, file);
2661 print_start_tfs_comment(file, type, start_offset);
2662 print_file(file, 2, "0x%x,\t/* %s */\n", fc, string_of_type(fc));
2663 print_file(file, 2, "0x%x,\t/* %d */\n", align - 1, align - 1);
2664 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %d */\n", (unsigned short)total_size, total_size);
2669 unsigned int absoff = array->type->typestring_offset;
2670 short reloff = absoff - *tfsoff;
2671 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %hd (%u) */\n",
2672 reloff, reloff, absoff);
2675 else if (fc == RPC_FC_BOGUS_STRUCT)
2677 print_file(file, 2, "NdrFcShort(0x0),\n");
2681 if (fc == RPC_FC_BOGUS_STRUCT)
2683 /* On the sizing pass, type->ptrdesc may be zero, but it's ok as
2684 nothing is written to file yet. On the actual writing pass,
2685 this will have been updated. */
2686 unsigned int absoff = type->ptrdesc ? type->ptrdesc : *tfsoff;
2687 int reloff = absoff - *tfsoff;
2688 assert( reloff >= 0 );
2689 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %d (%u) */\n",
2690 (unsigned short)reloff, reloff, absoff);
2693 else if ((fc == RPC_FC_PSTRUCT) ||
2694 (fc == RPC_FC_CPSTRUCT) ||
2695 (fc == RPC_FC_CVSTRUCT && type_has_pointers(type)))
2697 print_file(file, 2, "0x%x, /* FC_PP */\n", RPC_FC_PP);
2698 print_file(file, 2, "0x%x, /* FC_PAD */\n", RPC_FC_PAD);
2700 write_pointer_description(file, type, tfsoff);
2701 print_file(file, 2, "0x%x, /* FC_END */\n", RPC_FC_END);
2705 write_struct_members(file, type, fc == RPC_FC_BOGUS_STRUCT, &corroff,
2708 if (fc == RPC_FC_BOGUS_STRUCT)
2712 type->ptrdesc = *tfsoff;
2713 if (fields) LIST_FOR_EACH_ENTRY(f, fields, const var_t, entry)
2715 type_t *ft = f->type;
2716 switch (typegen_detect_type(ft, f->attrs, TDT_IGNORE_STRINGS))
2719 if (is_string_type(f->attrs, ft))
2720 write_string_tfs(file, f->attrs, ft, FALSE, f->name, tfsoff);
2722 write_pointer_tfs(file, f->attrs, ft,
2723 type_pointer_get_ref(ft)->typestring_offset,
2727 if (type_array_is_decl_as_ptr(ft))
2729 unsigned int offset;
2731 print_file(file, 0, "/* %d */\n", *tfsoff);
2733 offset = ft->typestring_offset;
2734 /* skip over the pointer that is written for strings, since a
2735 * pointer has to be written in-place here */
2736 if (is_string_type(f->attrs, ft))
2738 write_nonsimple_pointer(file, f->attrs, ft, FALSE, offset, tfsoff);
2745 if (type->ptrdesc == *tfsoff)
2749 current_structure = save_current_structure;
2750 return start_offset;
2753 static void write_branch_type(FILE *file, const type_t *t, unsigned int *tfsoff)
2757 print_file(file, 2, "NdrFcShort(0x0),\t/* No type */\n");
2761 if (type_get_type(t) == TYPE_BASIC || type_get_type(t) == TYPE_ENUM)
2764 if (type_get_type(t) == TYPE_BASIC)
2765 fc = get_basic_fc(t);
2767 fc = get_enum_fc(t);
2768 print_file(file, 2, "NdrFcShort(0x80%02x),\t/* Simple arm type: %s */\n",
2769 fc, string_of_type(fc));
2771 else if (t->typestring_offset)
2773 short reloff = t->typestring_offset - *tfsoff;
2774 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %d (%d) */\n",
2775 reloff, reloff, t->typestring_offset);
2778 error("write_branch_type: type unimplemented %d\n", type_get_type(t));
2784 static unsigned int write_union_tfs(FILE *file, const attr_list_t *attrs,
2785 type_t *type, unsigned int *tfsoff)
2787 unsigned int start_offset;
2790 unsigned int nbranch = 0;
2791 type_t *deftype = NULL;
2792 short nodeftype = 0xffff;
2795 if (processed(type) &&
2796 (type_get_type(type) == TYPE_ENCAPSULATED_UNION || !is_attr(type->attrs, ATTR_SWITCHTYPE)))
2797 return type->typestring_offset;
2801 size = type_memsize(type);
2803 fields = type_union_get_cases(type);
2805 if (fields) LIST_FOR_EACH_ENTRY(f, fields, var_t, entry)
2807 expr_list_t *cases = get_attrp(f->attrs, ATTR_CASE);
2809 nbranch += list_count(cases);
2811 write_embedded_types(file, f->attrs, f->type, f->name, TRUE, tfsoff);
2814 start_offset = *tfsoff;
2815 update_tfsoff(type, start_offset, file);
2816 print_start_tfs_comment(file, type, start_offset);
2817 if (type_get_type(type) == TYPE_ENCAPSULATED_UNION)
2819 const var_t *sv = type_union_get_switch_value(type);
2820 const type_t *st = sv->type;
2823 if (type_get_type(st) == TYPE_BASIC)
2825 switch (get_basic_fc(st))
2836 fc = get_basic_fc(st);
2840 error("union switch type must be an integer, char, or enum\n");
2843 else if (type_get_type(st) == TYPE_ENUM)
2844 fc = get_enum_fc(st);
2846 error("union switch type must be an integer, char, or enum\n");
2848 print_file(file, 2, "0x%x,\t/* FC_ENCAPSULATED_UNION */\n", RPC_FC_ENCAPSULATED_UNION);
2849 print_file(file, 2, "0x%x,\t/* Switch type= %s */\n",
2850 0x40 | fc, string_of_type(fc));
2853 else if (is_attr(type->attrs, ATTR_SWITCHTYPE))
2855 const expr_t *switch_is = get_attrp(attrs, ATTR_SWITCHIS);
2856 const type_t *st = get_attrp(type->attrs, ATTR_SWITCHTYPE);
2859 if (type_get_type(st) == TYPE_BASIC)
2861 switch (get_basic_fc(st))
2872 fc = get_basic_fc(st);
2876 error("union switch type must be an integer, char, or enum\n");
2879 else if (type_get_type(st) == TYPE_ENUM)
2880 fc = get_enum_fc(st);
2882 error("union switch type must be an integer, char, or enum\n");
2884 print_file(file, 2, "0x%x,\t/* FC_NON_ENCAPSULATED_UNION */\n", RPC_FC_NON_ENCAPSULATED_UNION);
2885 print_file(file, 2, "0x%x,\t/* Switch type= %s */\n",
2886 fc, string_of_type(fc));
2888 *tfsoff += write_conf_or_var_desc(file, current_structure, 0, st, switch_is );
2889 print_file(file, 2, "NdrFcShort(0x2),\t/* Offset= 2 (%u) */\n", *tfsoff + 2);
2891 print_file(file, 0, "/* %u */\n", *tfsoff);
2894 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %d */\n", (unsigned short)size, size);
2895 print_file(file, 2, "NdrFcShort(0x%hx),\t/* %d */\n", (unsigned short)nbranch, nbranch);
2898 if (fields) LIST_FOR_EACH_ENTRY(f, fields, var_t, entry)
2900 type_t *ft = f->type;
2901 expr_list_t *cases = get_attrp(f->attrs, ATTR_CASE);
2902 int deflt = is_attr(f->attrs, ATTR_DEFAULT);
2905 if (cases == NULL && !deflt)
2906 error("union field %s with neither case nor default attribute\n", f->name);
2908 if (cases) LIST_FOR_EACH_ENTRY(c, cases, expr_t, entry)
2910 /* MIDL doesn't check for duplicate cases, even though that seems
2911 like a reasonable thing to do, it just dumps them to the TFS
2912 like we're going to do here. */
2913 print_file(file, 2, "NdrFcLong(0x%x),\t/* %d */\n", c->cval, c->cval);
2915 write_branch_type(file, ft, tfsoff);
2918 /* MIDL allows multiple default branches, even though that seems
2919 illogical, it just chooses the last one, which is what we will
2930 write_branch_type(file, deftype, tfsoff);
2934 print_file(file, 2, "NdrFcShort(0x%hx),\n", nodeftype);
2938 return start_offset;
2941 static unsigned int write_ip_tfs(FILE *file, const attr_list_t *attrs, type_t *type,
2942 unsigned int *typeformat_offset)
2945 unsigned int start_offset = *typeformat_offset;
2946 expr_t *iid = get_attrp(attrs, ATTR_IIDIS);
2948 if (!iid && processed(type)) return type->typestring_offset;
2950 print_start_tfs_comment(file, type, start_offset);
2951 update_tfsoff(type, start_offset, file);
2955 print_file(file, 2, "0x2f, /* FC_IP */\n");
2956 print_file(file, 2, "0x5c, /* FC_PAD */\n");
2958 += write_conf_or_var_desc(file, current_structure, 0, type, iid) + 2;
2962 const type_t *base = is_ptr(type) ? type_pointer_get_ref(type) : type;
2963 const UUID *uuid = get_attrp(base->attrs, ATTR_UUID);
2966 error("%s: interface %s missing UUID\n", __FUNCTION__, base->name);
2968 print_file(file, 2, "0x2f,\t/* FC_IP */\n");
2969 print_file(file, 2, "0x5a,\t/* FC_CONSTANT_IID */\n");
2970 print_file(file, 2, "NdrFcLong(0x%08x),\n", uuid->Data1);
2971 print_file(file, 2, "NdrFcShort(0x%04x),\n", uuid->Data2);
2972 print_file(file, 2, "NdrFcShort(0x%04x),\n", uuid->Data3);
2973 for (i = 0; i < 8; ++i)
2974 print_file(file, 2, "0x%02x,\n", uuid->Data4[i]);
2977 fprintf(file, "\n");
2979 *typeformat_offset += 18;
2981 return start_offset;
2984 static unsigned int write_contexthandle_tfs(FILE *file,
2985 const attr_list_t *attrs,
2988 unsigned int *typeformat_offset)
2990 unsigned int start_offset = *typeformat_offset;
2991 unsigned char flags = get_contexthandle_flags( current_iface, attrs, type );
2993 print_start_tfs_comment(file, type, start_offset);
2995 if (flags & 0x80) /* via ptr */
2997 int pointer_type = get_pointer_fc( type, attrs, toplevel_param );
2998 if (!pointer_type) pointer_type = RPC_FC_RP;
2999 *typeformat_offset += 4;
3000 print_file(file, 2,"0x%x, 0x0,\t/* %s */\n", pointer_type, string_of_type(pointer_type) );
3001 print_file(file, 2, "NdrFcShort(0x2),\t /* Offset= 2 (%u) */\n", *typeformat_offset);
3002 print_file(file, 0, "/* %2u */\n", *typeformat_offset);
3005 print_file(file, 2, "0x%02x,\t/* FC_BIND_CONTEXT */\n", RPC_FC_BIND_CONTEXT);
3006 print_file(file, 2, "0x%x,\t/* Context flags: ", flags);
3007 /* return and can't be null values overlap */
3008 if (((flags & 0x21) != 0x21) && (flags & NDR_CONTEXT_HANDLE_CANNOT_BE_NULL))
3009 print_file(file, 0, "can't be null, ");
3010 if (flags & NDR_CONTEXT_HANDLE_SERIALIZE)
3011 print_file(file, 0, "serialize, ");
3012 if (flags & NDR_CONTEXT_HANDLE_NO_SERIALIZE)
3013 print_file(file, 0, "no serialize, ");
3014 if (flags & NDR_STRICT_CONTEXT_HANDLE)
3015 print_file(file, 0, "strict, ");
3016 if ((flags & 0x21) == 0x20)
3017 print_file(file, 0, "out, ");
3018 if ((flags & 0x21) == 0x21)
3019 print_file(file, 0, "return, ");
3021 print_file(file, 0, "in, ");
3023 print_file(file, 0, "via ptr, ");
3024 print_file(file, 0, "*/\n");
3025 print_file(file, 2, "0x%x,\t/* rundown routine */\n", get_context_handle_offset( type ));
3026 print_file(file, 2, "0, /* FIXME: param num */\n");
3027 *typeformat_offset += 4;
3029 update_tfsoff( type, start_offset, file );
3030 return start_offset;
3033 static unsigned int write_range_tfs(FILE *file, const attr_list_t *attrs,
3034 type_t *type, expr_list_t *range_list,
3035 unsigned int *typeformat_offset)
3038 unsigned int start_offset = *typeformat_offset;
3039 const expr_t *range_min = LIST_ENTRY(list_head(range_list), const expr_t, entry);
3040 const expr_t *range_max = LIST_ENTRY(list_next(range_list, list_head(range_list)), const expr_t, entry);
3042 if (type_get_type(type) == TYPE_BASIC)
3043 fc = get_basic_fc(type);
3045 fc = get_enum_fc(type);
3047 /* fc must fit in lower 4-bits of 8-bit field below */
3050 print_file(file, 0, "/* %u */\n", *typeformat_offset);
3051 print_file(file, 2, "0x%x,\t/* FC_RANGE */\n", RPC_FC_RANGE);
3052 print_file(file, 2, "0x%x,\t/* %s */\n", fc, string_of_type(fc));
3053 print_file(file, 2, "NdrFcLong(0x%x),\t/* %u */\n", range_min->cval, range_min->cval);
3054 print_file(file, 2, "NdrFcLong(0x%x),\t/* %u */\n", range_max->cval, range_max->cval);
3055 update_tfsoff( type, start_offset, file );
3056 *typeformat_offset += 10;
3058 return start_offset;
3061 static unsigned int write_type_tfs(FILE *file, int indent,
3062 const attr_list_t *attrs, type_t *type,
3064 enum type_context context,
3065 unsigned int *typeformat_offset)
3067 unsigned int offset;
3069 switch (typegen_detect_type(type, attrs, TDT_ALL_TYPES))
3071 case TGT_CTXT_HANDLE:
3072 case TGT_CTXT_HANDLE_POINTER:
3073 return write_contexthandle_tfs(file, attrs, type,
3074 context == TYPE_CONTEXT_TOPLEVELPARAM, typeformat_offset);
3076 return write_user_tfs(file, type, typeformat_offset);
3078 return write_string_tfs(file, attrs, type,
3079 context == TYPE_CONTEXT_TOPLEVELPARAM,
3080 name, typeformat_offset);
3084 /* conformant and pointer arrays are handled specially */
3085 if ((context != TYPE_CONTEXT_CONTAINER &&
3086 context != TYPE_CONTEXT_CONTAINER_NO_POINTERS) ||
3087 !is_conformant_array(type) || type_array_is_decl_as_ptr(type))
3088 off = write_array_tfs(file, attrs, type, name, typeformat_offset);
3091 if (context != TYPE_CONTEXT_CONTAINER &&
3092 context != TYPE_CONTEXT_CONTAINER_NO_POINTERS)
3095 ptr_type = get_pointer_fc(type, attrs,
3096 context == TYPE_CONTEXT_TOPLEVELPARAM);
3097 if (ptr_type != RPC_FC_RP)
3099 unsigned int absoff = type->typestring_offset;
3100 short reloff = absoff - (*typeformat_offset + 2);
3101 off = *typeformat_offset;
3102 print_file(file, 0, "/* %d */\n", off);
3103 print_file(file, 2, "0x%x, 0x0,\t/* %s */\n", ptr_type,
3104 string_of_type(ptr_type));
3105 print_file(file, 2, "NdrFcShort(0x%hx),\t/* Offset= %hd (%u) */\n",
3106 reloff, reloff, absoff);
3107 update_tfsoff( type, off, file );
3108 *typeformat_offset += 4;
3114 return write_struct_tfs(file, type, name, typeformat_offset);
3116 return write_union_tfs(file, attrs, type, typeformat_offset);
3123 expr_list_t *range_list = get_attrp(attrs, ATTR_RANGE);
3125 range_list = get_aliaschain_attrp(type, ATTR_RANGE);
3126 return write_range_tfs(file, attrs, type, range_list, typeformat_offset);
3128 case TGT_IFACE_POINTER:
3129 return write_ip_tfs(file, attrs, type, typeformat_offset);
3132 enum type_context ref_context;
3133 if (context == TYPE_CONTEXT_TOPLEVELPARAM)
3134 ref_context = TYPE_CONTEXT_PARAM;
3135 else if (context == TYPE_CONTEXT_CONTAINER_NO_POINTERS)
3136 ref_context = TYPE_CONTEXT_CONTAINER;
3138 ref_context = context;
3139 offset = write_type_tfs( file, indent, attrs, type_pointer_get_ref(type), name,
3140 ref_context, typeformat_offset);
3141 if (context == TYPE_CONTEXT_CONTAINER_NO_POINTERS)
3143 return write_pointer_tfs(file, attrs, type, offset,
3144 context == TYPE_CONTEXT_TOPLEVELPARAM,
3150 error("invalid type %s for var %s\n", type->name, name);
3154 static int write_embedded_types(FILE *file, const attr_list_t *attrs, type_t *type,
3155 const char *name, int write_ptr, unsigned int *tfsoff)
3157 return write_type_tfs(file, 2, attrs, type, name, write_ptr ? TYPE_CONTEXT_CONTAINER : TYPE_CONTEXT_CONTAINER_NO_POINTERS, tfsoff);
3160 static unsigned int process_tfs_stmts(FILE *file, const statement_list_t *stmts,
3161 type_pred_t pred, unsigned int *typeformat_offset)
3164 const statement_t *stmt;
3166 if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
3168 const type_t *iface;
3169 const statement_t *stmt_func;
3171 if (stmt->type == STMT_LIBRARY)
3173 process_tfs_stmts(file, stmt->u.lib->stmts, pred, typeformat_offset);
3176 else if (stmt->type != STMT_TYPE || type_get_type(stmt->u.type) != TYPE_INTERFACE)
3179 iface = stmt->u.type;
3183 current_iface = iface;
3184 STATEMENTS_FOR_EACH_FUNC( stmt_func, type_iface_get_stmts(iface) )
3186 const var_t *func = stmt_func->u.var;
3187 current_func = func;
3188 if (is_local(func->attrs)) continue;
3190 if (!is_void(type_function_get_rettype(func->type)))
3192 write_type_tfs( file, 2, func->attrs, type_function_get_rettype(func->type),
3193 func->name, TYPE_CONTEXT_PARAM, typeformat_offset);
3196 if (type_get_function_args(func->type))
3197 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
3198 write_type_tfs( file, 2, var->attrs, var->type, var->name,
3199 TYPE_CONTEXT_TOPLEVELPARAM, typeformat_offset );
3203 return *typeformat_offset + 1;
3206 static unsigned int process_tfs(FILE *file, const statement_list_t *stmts, type_pred_t pred)
3208 unsigned int typeformat_offset = 2;
3210 return process_tfs_stmts(file, stmts, pred, &typeformat_offset);
3214 void write_typeformatstring(FILE *file, const statement_list_t *stmts, type_pred_t pred)
3218 print_file(file, indent, "static const MIDL_TYPE_FORMAT_STRING __MIDL_TypeFormatString =\n");
3219 print_file(file, indent, "{\n");
3221 print_file(file, indent, "0,\n");
3222 print_file(file, indent, "{\n");
3224 print_file(file, indent, "NdrFcShort(0x0),\n");
3226 set_all_tfswrite(TRUE);
3227 process_tfs(file, stmts, pred);
3229 print_file(file, indent, "0x0\n");
3231 print_file(file, indent, "}\n");
3233 print_file(file, indent, "};\n");
3234 print_file(file, indent, "\n");
3237 static unsigned int get_required_buffer_size_type(
3238 const type_t *type, const char *name, const attr_list_t *attrs, int toplevel_param, unsigned int *alignment)
3241 switch (typegen_detect_type(type, NULL, TDT_IGNORE_RANGES))
3246 const type_t *utype = get_user_type(type, &uname);
3247 return get_required_buffer_size_type(utype, uname, NULL, FALSE, alignment);
3250 switch (get_basic_fc(type))
3268 case RPC_FC_ERROR_STATUS_T:
3277 case RPC_FC_INT3264:
3278 case RPC_FC_UINT3264:
3279 assert( pointer_size );
3280 *alignment = pointer_size;
3281 return pointer_size;
3284 case RPC_FC_BIND_PRIMITIVE:
3288 error("get_required_buffer_size: unknown basic type 0x%02x\n",
3289 get_basic_fc(type));
3295 switch (get_enum_fc(type))
3307 if (get_struct_fc(type) == RPC_FC_STRUCT)
3309 if (!type_struct_get_fields(type)) return 0;
3310 return fields_memsize(type_struct_get_fields(type), alignment);
3316 unsigned int size, align;
3317 const type_t *ref = type_pointer_get_ref(type);
3318 if (is_string_type( attrs, ref )) break;
3319 if (!(size = get_required_buffer_size_type( ref, name, NULL, FALSE, &align ))) break;
3320 if (get_pointer_fc(type, attrs, toplevel_param) != RPC_FC_RP)
3330 if (get_pointer_fc(type, attrs, toplevel_param) == RPC_FC_RP)
3332 switch (get_array_fc(type))
3334 case RPC_FC_SMFARRAY:
3335 case RPC_FC_LGFARRAY:
3336 return type_array_get_dim(type) *
3337 get_required_buffer_size_type(type_array_get_element(type), name,
3338 NULL, FALSE, alignment);
3349 static unsigned int get_required_buffer_size(const var_t *var, unsigned int *alignment, enum pass pass)
3351 int in_attr = is_attr(var->attrs, ATTR_IN);
3352 int out_attr = is_attr(var->attrs, ATTR_OUT);
3354 if (!in_attr && !out_attr)
3359 if ((pass == PASS_IN && in_attr) || (pass == PASS_OUT && out_attr) ||
3360 pass == PASS_RETURN)
3362 if (is_ptrchain_attr(var, ATTR_CONTEXTHANDLE))
3368 if (!is_string_type(var->attrs, var->type))
3369 return get_required_buffer_size_type(var->type, var->name,
3370 var->attrs, TRUE, alignment);
3375 static unsigned int get_function_buffer_size( const var_t *func, enum pass pass )
3378 unsigned int total_size = 0, alignment;
3380 if (type_get_function_args(func->type))
3382 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
3384 total_size += get_required_buffer_size(var, &alignment, pass);
3385 total_size += alignment;
3389 if (pass == PASS_OUT && !is_void(type_function_get_rettype(func->type)))
3392 v.type = type_function_get_rettype(func->type);
3393 total_size += get_required_buffer_size(&v, &alignment, PASS_RETURN);
3394 total_size += alignment;
3399 static void print_phase_function(FILE *file, int indent, const char *type,
3400 const char *local_var_prefix, enum remoting_phase phase,
3401 const var_t *var, unsigned int type_offset)
3403 const char *function;
3406 case PHASE_BUFFERSIZE:
3407 function = "BufferSize";
3410 function = "Marshall";
3412 case PHASE_UNMARSHAL:
3413 function = "Unmarshall";
3423 print_file(file, indent, "Ndr%s%s(\n", type, function);
3425 print_file(file, indent, "&__frame->_StubMsg,\n");
3426 print_file(file, indent, "%s%s%s%s%s,\n",
3427 (phase == PHASE_UNMARSHAL) ? "(unsigned char **)" : "(unsigned char *)",
3428 (phase == PHASE_UNMARSHAL || decl_indirect(var->type)) ? "&" : "",
3430 (phase == PHASE_UNMARSHAL && decl_indirect(var->type)) ? "_p_" : "",
3432 print_file(file, indent, "(PFORMAT_STRING)&__MIDL_TypeFormatString.Format[%d]%s\n",
3433 type_offset, (phase == PHASE_UNMARSHAL) ? "," : ");");
3434 if (phase == PHASE_UNMARSHAL)
3435 print_file(file, indent, "0);\n");
3439 void print_phase_basetype(FILE *file, int indent, const char *local_var_prefix,
3440 enum remoting_phase phase, enum pass pass, const var_t *var,
3441 const char *varname)
3443 type_t *type = var->type;
3444 unsigned int alignment = 0;
3446 /* no work to do for other phases, buffer sizing is done elsewhere */
3447 if (phase != PHASE_MARSHAL && phase != PHASE_UNMARSHAL)
3450 if (type_get_type(type) == TYPE_ENUM ||
3451 (type_get_type(type) == TYPE_BASIC &&
3452 type_basic_get_type(type) == TYPE_BASIC_INT3264 &&
3457 if (type_get_type(type) == TYPE_ENUM)
3458 fc = get_enum_fc(type);
3460 fc = get_basic_fc(type);
3462 if (phase == PHASE_MARSHAL)
3463 print_file(file, indent, "NdrSimpleTypeMarshall(\n");
3465 print_file(file, indent, "NdrSimpleTypeUnmarshall(\n");
3466 print_file(file, indent+1, "&__frame->_StubMsg,\n");
3467 print_file(file, indent+1, "(unsigned char *)&%s%s,\n",
3470 print_file(file, indent+1, "0x%02x /* %s */);\n", fc, string_of_type(fc));
3474 const type_t *ref = is_ptr(type) ? type_pointer_get_ref(type) : type;
3475 switch (get_basic_fc(ref))
3493 case RPC_FC_ERROR_STATUS_T:
3494 /* pointer_size must be 4 if we got here in these two cases */
3495 case RPC_FC_INT3264:
3496 case RPC_FC_UINT3264:
3506 case RPC_FC_BIND_PRIMITIVE:
3507 /* no marshalling needed */
3511 error("print_phase_basetype: Unsupported type: %s (0x%02x, ptr_level: 0)\n",
3512 var->name, get_basic_fc(ref));
3515 if (phase == PHASE_MARSHAL && alignment > 1)
3516 print_file(file, indent, "MIDL_memset(__frame->_StubMsg.Buffer, 0, (0x%x - (ULONG_PTR)__frame->_StubMsg.Buffer) & 0x%x);\n", alignment, alignment - 1);
3517 print_file(file, indent, "__frame->_StubMsg.Buffer = (unsigned char *)(((ULONG_PTR)__frame->_StubMsg.Buffer + %u) & ~0x%x);\n",
3518 alignment - 1, alignment - 1);
3520 if (phase == PHASE_MARSHAL)
3522 print_file(file, indent, "*(");
3523 write_type_decl(file, is_ptr(type) ? type_pointer_get_ref(type) : type, NULL);
3525 fprintf(file, " *)__frame->_StubMsg.Buffer = *");
3527 fprintf(file, " *)__frame->_StubMsg.Buffer = ");
3528 fprintf(file, "%s%s", local_var_prefix, varname);
3529 fprintf(file, ";\n");
3531 else if (phase == PHASE_UNMARSHAL)
3533 print_file(file, indent, "if (__frame->_StubMsg.Buffer + sizeof(");
3534 write_type_decl(file, is_ptr(type) ? type_pointer_get_ref(type) : type, NULL);
3535 fprintf(file, ") > __frame->_StubMsg.BufferEnd)\n");
3536 print_file(file, indent, "{\n");
3537 print_file(file, indent + 1, "RpcRaiseException(RPC_X_BAD_STUB_DATA);\n");
3538 print_file(file, indent, "}\n");
3539 print_file(file, indent, "%s%s%s",
3540 (pass == PASS_IN || pass == PASS_RETURN) ? "" : "*",
3541 local_var_prefix, varname);
3542 if (pass == PASS_IN && is_ptr(type))
3543 fprintf(file, " = (");
3545 fprintf(file, " = *(");
3546 write_type_decl(file, is_ptr(type) ? type_pointer_get_ref(type) : type, NULL);
3547 fprintf(file, " *)__frame->_StubMsg.Buffer;\n");
3550 print_file(file, indent, "__frame->_StubMsg.Buffer += sizeof(");
3551 write_type_decl(file, is_ptr(type) ? type_pointer_get_ref(type) : type, NULL);
3552 fprintf(file, ");\n");
3556 /* returns whether the MaxCount, Offset or ActualCount members need to be
3557 * filled in for the specified phase */
3558 static inline int is_conformance_needed_for_phase(enum remoting_phase phase)
3560 return (phase != PHASE_UNMARSHAL);
3563 expr_t *get_size_is_expr(const type_t *t, const char *name)
3567 for ( ; is_array(t); t = type_array_get_element(t))
3568 if (type_array_has_conformance(t) &&
3569 type_array_get_conformance(t)->type != EXPR_VOID)
3572 x = type_array_get_conformance(t);
3574 error("%s: multidimensional conformant"
3575 " arrays not supported at the top level\n",
3582 static void write_parameter_conf_or_var_exprs(FILE *file, int indent, const char *local_var_prefix,
3583 enum remoting_phase phase, const var_t *var)
3585 const type_t *type = var->type;
3586 /* get fundamental type for the argument */
3589 switch (typegen_detect_type(type, var->attrs, TDT_IGNORE_STRINGS|TDT_IGNORE_RANGES))
3592 if (is_conformance_needed_for_phase(phase))
3594 if (type_array_has_conformance(type) &&
3595 type_array_get_conformance(type)->type != EXPR_VOID)
3597 print_file(file, indent, "__frame->_StubMsg.MaxCount = (ULONG_PTR)");
3598 write_expr(file, type_array_get_conformance(type), 1, 1, NULL, NULL, local_var_prefix);
3599 fprintf(file, ";\n\n");
3601 if (type_array_has_variance(type))
3603 print_file(file, indent, "__frame->_StubMsg.Offset = 0;\n"); /* FIXME */
3604 print_file(file, indent, "__frame->_StubMsg.ActualCount = (ULONG_PTR)");
3605 write_expr(file, type_array_get_variance(type), 1, 1, NULL, NULL, local_var_prefix);
3606 fprintf(file, ";\n\n");
3611 if (type_get_type(type) == TYPE_UNION &&
3612 is_conformance_needed_for_phase(phase))
3614 print_file(file, indent, "__frame->_StubMsg.MaxCount = (ULONG_PTR)");
3615 write_expr(file, get_attrp(var->attrs, ATTR_SWITCHIS), 1, 1, NULL, NULL, local_var_prefix);
3616 fprintf(file, ";\n\n");
3619 case TGT_IFACE_POINTER:
3623 if (is_conformance_needed_for_phase(phase) && (iid = get_attrp( var->attrs, ATTR_IIDIS )))
3625 print_file( file, indent, "__frame->_StubMsg.MaxCount = (ULONG_PTR) " );
3626 write_expr( file, iid, 1, 1, NULL, NULL, local_var_prefix );
3627 fprintf( file, ";\n\n" );
3632 type = type_pointer_get_ref(type);
3636 case TGT_CTXT_HANDLE:
3637 case TGT_CTXT_HANDLE_POINTER:
3649 static void write_remoting_arg(FILE *file, int indent, const var_t *func, const char *local_var_prefix,
3650 enum pass pass, enum remoting_phase phase, const var_t *var)
3652 int in_attr, out_attr, pointer_type;
3653 const char *type_str = NULL;
3654 const type_t *type = var->type;
3655 unsigned int alignment, start_offset = type->typestring_offset;
3657 if (is_ptr(type) || is_array(type))
3658 pointer_type = get_pointer_fc(type, var->attrs, pass != PASS_RETURN);
3662 in_attr = is_attr(var->attrs, ATTR_IN);
3663 out_attr = is_attr(var->attrs, ATTR_OUT);
3664 if (!in_attr && !out_attr)
3667 if (phase != PHASE_FREE)
3671 if (!in_attr) return;
3674 if (!out_attr) return;
3680 if (phase == PHASE_BUFFERSIZE && get_required_buffer_size( var, &alignment, pass )) return;
3682 write_parameter_conf_or_var_exprs(file, indent, local_var_prefix, phase, var);
3684 switch (typegen_detect_type(type, var->attrs, TDT_ALL_TYPES))
3686 case TGT_CTXT_HANDLE:
3687 case TGT_CTXT_HANDLE_POINTER:
3688 if (phase == PHASE_MARSHAL)
3690 if (pass == PASS_IN)
3692 /* if the context_handle attribute appears in the chain of types
3693 * without pointers being followed, then the context handle must
3694 * be direct, otherwise it is a pointer */
3695 int is_ch_ptr = is_aliaschain_attr(type, ATTR_CONTEXTHANDLE) ? FALSE : TRUE;
3696 print_file(file, indent, "NdrClientContextMarshall(\n");
3697 print_file(file, indent + 1, "&__frame->_StubMsg,\n");
3698 print_file(file, indent + 1, "(NDR_CCONTEXT)%s%s%s,\n", is_ch_ptr ? "*" : "", local_var_prefix, var->name);
3699 print_file(file, indent + 1, "%s);\n", in_attr && out_attr ? "1" : "0");
3703 print_file(file, indent, "NdrServerContextNewMarshall(\n");
3704 print_file(file, indent + 1, "&__frame->_StubMsg,\n");
3705 print_file(file, indent + 1, "(NDR_SCONTEXT)%s%s,\n", local_var_prefix, var->name);
3706 print_file(file, indent + 1, "(NDR_RUNDOWN)%s_rundown,\n", get_context_handle_type_name(var->type));
3707 print_file(file, indent + 1, "(PFORMAT_STRING)&__MIDL_TypeFormatString.Format[%d]);\n", start_offset);
3710 else if (phase == PHASE_UNMARSHAL)
3712 if (pass == PASS_OUT)
3715 print_file(file, indent, "*%s%s = 0;\n", local_var_prefix, var->name);
3716 print_file(file, indent, "NdrClientContextUnmarshall(\n");
3717 print_file(file, indent + 1, "&__frame->_StubMsg,\n");
3718 print_file(file, indent + 1, "(NDR_CCONTEXT *)%s%s,\n", local_var_prefix, var->name);
3719 print_file(file, indent + 1, "__frame->_Handle);\n");
3723 print_file(file, indent, "%s%s = NdrServerContextNewUnmarshall(\n", local_var_prefix, var->name);
3724 print_file(file, indent + 1, "&__frame->_StubMsg,\n");
3725 print_file(file, indent + 1, "(PFORMAT_STRING)&__MIDL_TypeFormatString.Format[%d]);\n", start_offset);
3730 print_phase_function(file, indent, "UserMarshal", local_var_prefix, phase, var, start_offset);
3733 if (phase == PHASE_FREE || pass == PASS_RETURN ||
3734 pointer_type != RPC_FC_RP)
3736 if (pointer_type == RPC_FC_RP && phase == PHASE_FREE &&
3737 !in_attr && is_conformant_array(type))
3739 print_file(file, indent, "if (%s%s)\n", local_var_prefix, var->name);
3741 print_file(file, indent, "__frame->_StubMsg.pfnFree(%s%s);\n", local_var_prefix, var->name);
3743 /* strings returned are assumed to be global and hence don't
3745 else if (is_declptr(type) &&
3746 !(phase == PHASE_FREE && pass == PASS_RETURN))
3747 print_phase_function(file, indent, "Pointer", local_var_prefix,
3748 phase, var, start_offset);
3752 unsigned int real_start_offset = start_offset;
3753 /* skip over pointer description straight to string description */
3754 if (is_declptr(type))
3756 if (is_conformant_array(type))
3757 real_start_offset += 4;
3759 real_start_offset += 2;
3761 if (is_array(type) && !is_conformant_array(type))
3762 print_phase_function(file, indent, "NonConformantString",
3763 local_var_prefix, phase, var,
3766 print_phase_function(file, indent, "ConformantString", local_var_prefix,
3767 phase, var, real_start_offset);
3772 unsigned char tc = get_array_fc(type);
3773 const char *array_type = NULL;
3775 /* We already have the size_is expression since it's at the
3776 top level, but do checks for multidimensional conformant
3777 arrays. When we handle them, we'll need to extend this
3778 function to return a list, and then we'll actually use
3779 the return value. */
3780 get_size_is_expr(type, var->name);
3784 case RPC_FC_SMFARRAY:
3785 case RPC_FC_LGFARRAY:
3786 array_type = "FixedArray";
3788 case RPC_FC_SMVARRAY:
3789 case RPC_FC_LGVARRAY:
3790 array_type = "VaryingArray";
3793 array_type = "ConformantArray";
3795 case RPC_FC_CVARRAY:
3796 array_type = "ConformantVaryingArray";
3798 case RPC_FC_BOGUS_ARRAY:
3799 array_type = "ComplexArray";
3803 if (pointer_type != RPC_FC_RP) array_type = "Pointer";
3804 print_phase_function(file, indent, array_type, local_var_prefix, phase, var, start_offset);
3805 if (phase == PHASE_FREE && pointer_type == RPC_FC_RP)
3807 /* these are all unmarshalled by allocating memory */
3808 if (tc == RPC_FC_BOGUS_ARRAY ||
3809 tc == RPC_FC_CVARRAY ||
3810 ((tc == RPC_FC_SMVARRAY || tc == RPC_FC_LGVARRAY) && in_attr) ||
3811 (tc == RPC_FC_CARRAY && !in_attr))
3813 print_file(file, indent, "if (%s%s)\n", local_var_prefix, var->name);
3815 print_file(file, indent, "__frame->_StubMsg.pfnFree(%s%s);\n", local_var_prefix, var->name);
3821 print_phase_basetype(file, indent, local_var_prefix, phase, pass, var, var->name);
3824 print_phase_basetype(file, indent, local_var_prefix, phase, pass, var, var->name);
3827 print_phase_basetype(file, indent, local_var_prefix, phase, pass, var, var->name);
3828 /* Note: this goes beyond what MIDL does - it only supports arguments
3829 * with the [range] attribute in Oicf mode */
3830 if (phase == PHASE_UNMARSHAL)
3832 const expr_t *range_min;
3833 const expr_t *range_max;
3834 expr_list_t *range_list = get_attrp(var->attrs, ATTR_RANGE);
3836 range_list = get_aliaschain_attrp(type, ATTR_RANGE);
3837 range_min = LIST_ENTRY(list_head(range_list), const expr_t, entry);
3838 range_max = LIST_ENTRY(list_next(range_list, list_head(range_list)), const expr_t, entry);
3840 print_file(file, indent, "if ((%s%s < (", local_var_prefix, var->name);
3841 write_type_decl(file, var->type, NULL);
3842 fprintf(file, ")0x%x) || (%s%s > (", range_min->cval, local_var_prefix, var->name);
3843 write_type_decl(file, var->type, NULL);
3844 fprintf(file, ")0x%x))\n", range_max->cval);
3845 print_file(file, indent, "{\n");
3846 print_file(file, indent+1, "RpcRaiseException(RPC_S_INVALID_BOUND);\n");
3847 print_file(file, indent, "}\n");
3851 switch (get_struct_fc(type))
3854 if (phase == PHASE_MARSHAL || phase == PHASE_UNMARSHAL)
3855 print_phase_function(file, indent, "SimpleStruct", local_var_prefix, phase, var, start_offset);
3857 case RPC_FC_PSTRUCT:
3858 print_phase_function(file, indent, "SimpleStruct", local_var_prefix, phase, var, start_offset);
3860 case RPC_FC_CSTRUCT:
3861 case RPC_FC_CPSTRUCT:
3862 print_phase_function(file, indent, "ConformantStruct", local_var_prefix, phase, var, start_offset);
3864 case RPC_FC_CVSTRUCT:
3865 print_phase_function(file, indent, "ConformantVaryingStruct", local_var_prefix, phase, var, start_offset);
3867 case RPC_FC_BOGUS_STRUCT:
3868 print_phase_function(file, indent, "ComplexStruct", local_var_prefix, phase, var, start_offset);
3871 error("write_remoting_arguments: Unsupported type: %s (0x%02x)\n", var->name, get_struct_fc(type));
3876 const char *union_type = NULL;
3878 if (type_get_type(type) == TYPE_UNION)
3879 union_type = "NonEncapsulatedUnion";
3880 else if (type_get_type(type) == TYPE_ENCAPSULATED_UNION)
3881 union_type = "EncapsulatedUnion";
3883 print_phase_function(file, indent, union_type, local_var_prefix,
3884 phase, var, start_offset);
3889 const type_t *ref = type_pointer_get_ref(type);
3890 if (pointer_type == RPC_FC_RP) switch (typegen_detect_type(ref, NULL, TDT_ALL_TYPES))
3893 print_phase_basetype(file, indent, local_var_prefix, phase, pass, var, var->name);
3896 /* base types have known sizes, so don't need a sizing pass
3897 * and don't have any memory to free and so don't need a
3899 if (phase == PHASE_MARSHAL || phase == PHASE_UNMARSHAL)
3900 print_phase_function(file, indent, "Pointer", local_var_prefix, phase, var, start_offset);
3903 switch (get_struct_fc(ref))
3906 /* simple structs have known sizes, so don't need a sizing
3907 * pass and don't have any memory to free and so don't
3908 * need a freeing pass */
3909 if (phase == PHASE_MARSHAL || phase == PHASE_UNMARSHAL)
3910 type_str = "SimpleStruct";
3911 else if (phase == PHASE_FREE && pass == PASS_RETURN)
3913 print_file(file, indent, "if (%s%s)\n", local_var_prefix, var->name);
3915 print_file(file, indent, "__frame->_StubMsg.pfnFree(%s%s);\n", local_var_prefix, var->name);
3919 case RPC_FC_PSTRUCT:
3920 type_str = "SimpleStruct";
3922 case RPC_FC_CSTRUCT:
3923 case RPC_FC_CPSTRUCT:
3924 type_str = "ConformantStruct";
3926 case RPC_FC_CVSTRUCT:
3927 type_str = "ConformantVaryingStruct";
3929 case RPC_FC_BOGUS_STRUCT:
3930 type_str = "ComplexStruct";
3933 error("write_remoting_arguments: Unsupported type: %s (0x%02x)\n", var->name, get_struct_fc(ref));
3938 if (phase == PHASE_FREE)
3939 type_str = "Pointer";
3941 start_offset = ref->typestring_offset;
3942 print_phase_function(file, indent, type_str, local_var_prefix, phase, var, start_offset);
3946 if (phase == PHASE_FREE)
3947 type_str = "Pointer";
3950 if (type_get_type(ref) == TYPE_UNION)
3951 type_str = "NonEncapsulatedUnion";
3952 else if (type_get_type(ref) == TYPE_ENCAPSULATED_UNION)
3953 type_str = "EncapsulatedUnion";
3955 start_offset = ref->typestring_offset;
3958 print_phase_function(file, indent, type_str, local_var_prefix,
3959 phase, var, start_offset);
3962 if (phase != PHASE_FREE)
3964 type_str = "UserMarshal";
3965 start_offset = ref->typestring_offset;
3967 else type_str = "Pointer";
3969 print_phase_function(file, indent, type_str, local_var_prefix, phase, var, start_offset);
3975 case TGT_IFACE_POINTER:
3976 case TGT_CTXT_HANDLE:
3977 case TGT_CTXT_HANDLE_POINTER:
3978 print_phase_function(file, indent, "Pointer", local_var_prefix, phase, var, start_offset);
3985 print_phase_function(file, indent, "Pointer", local_var_prefix, phase, var, start_offset);
3988 case TGT_IFACE_POINTER:
3989 print_phase_function(file, indent, "InterfacePointer", local_var_prefix, phase, var, start_offset);
3995 fprintf(file, "\n");
3998 void write_remoting_arguments(FILE *file, int indent, const var_t *func, const char *local_var_prefix,
3999 enum pass pass, enum remoting_phase phase)
4001 if (phase == PHASE_BUFFERSIZE && pass != PASS_RETURN)
4003 unsigned int size = get_function_buffer_size( func, pass );
4004 print_file(file, indent, "__frame->_StubMsg.BufferLength = %u;\n", size);
4007 if (pass == PASS_RETURN)
4011 var.type = type_function_get_rettype(func->type);
4012 var.name = xstrdup( "_RetVal" );
4013 write_remoting_arg( file, indent, func, local_var_prefix, pass, phase, &var );
4019 if (!type_get_function_args(func->type))
4021 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
4022 write_remoting_arg( file, indent, func, local_var_prefix, pass, phase, var );
4027 unsigned int get_size_procformatstring_func(const var_t *func)
4029 unsigned int offset = 0;
4030 write_procformatstring_func( NULL, 0, func, &offset );
4034 unsigned int get_size_procformatstring(const statement_list_t *stmts, type_pred_t pred)
4036 const statement_t *stmt;
4037 unsigned int size = 1;
4039 if (stmts) LIST_FOR_EACH_ENTRY( stmt, stmts, const statement_t, entry )
4041 const type_t *iface;
4042 const statement_t *stmt_func;
4044 if (stmt->type == STMT_LIBRARY)
4046 size += get_size_procformatstring(stmt->u.lib->stmts, pred) - 1;
4049 else if (stmt->type != STMT_TYPE || type_get_type(stmt->u.type) != TYPE_INTERFACE)
4052 iface = stmt->u.type;
4056 STATEMENTS_FOR_EACH_FUNC( stmt_func, type_iface_get_stmts(iface) )
4058 const var_t *func = stmt_func->u.var;
4059 if (!is_local(func->attrs))
4060 size += get_size_procformatstring_func( func );
4066 unsigned int get_size_typeformatstring(const statement_list_t *stmts, type_pred_t pred)
4068 set_all_tfswrite(FALSE);
4069 return process_tfs(NULL, stmts, pred);
4072 void declare_stub_args( FILE *file, int indent, const var_t *func )
4074 int in_attr, out_attr;
4078 /* declare return value '_RetVal' */
4079 if (!is_void(type_function_get_rettype(func->type)))
4081 print_file(file, indent, "%s", "");
4082 write_type_decl_left(file, type_function_get_rettype(func->type));
4083 fprintf(file, " _RetVal;\n");
4086 if (!type_get_function_args(func->type))
4089 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
4091 in_attr = is_attr(var->attrs, ATTR_IN);
4092 out_attr = is_attr(var->attrs, ATTR_OUT);
4093 if (!out_attr && !in_attr)
4096 if (is_context_handle(var->type))
4097 print_file(file, indent, "NDR_SCONTEXT %s;\n", var->name);
4100 if (!in_attr && !is_conformant_array(var->type))
4102 type_t *type_to_print;
4104 print_file(file, indent, "%s", "");
4105 if (type_get_type(var->type) == TYPE_ARRAY &&
4106 !type_array_is_decl_as_ptr(var->type))
4107 type_to_print = var->type;
4109 type_to_print = type_pointer_get_ref(var->type);
4110 sprintf(name, "_W%u", i++);
4111 write_type_decl(file, type_to_print, name);
4112 fprintf(file, ";\n");
4115 print_file(file, indent, "%s", "");
4116 write_type_decl_left(file, var->type);
4118 if (type_get_type(var->type) == TYPE_ARRAY &&
4119 !type_array_is_decl_as_ptr(var->type)) {
4120 fprintf(file, "(*%s)", var->name);
4122 fprintf(file, "%s", var->name);
4123 write_type_right(file, var->type, FALSE);
4124 fprintf(file, ";\n");
4126 if (decl_indirect(var->type))
4127 print_file(file, indent, "void *_p_%s;\n", var->name);
4133 void assign_stub_out_args( FILE *file, int indent, const var_t *func, const char *local_var_prefix )
4135 int in_attr, out_attr;
4139 if (!type_get_function_args(func->type))
4142 LIST_FOR_EACH_ENTRY( var, type_get_function_args(func->type), const var_t, entry )
4144 in_attr = is_attr(var->attrs, ATTR_IN);
4145 out_attr = is_attr(var->attrs, ATTR_OUT);
4146 if (!out_attr && !in_attr)
4151 print_file(file, indent, "%s%s", local_var_prefix, var->name);
4153 switch (typegen_detect_type(var->type, var->attrs, TDT_IGNORE_STRINGS))
4155 case TGT_CTXT_HANDLE_POINTER:
4156 fprintf(file, " = NdrContextHandleInitialize(\n");
4157 print_file(file, indent + 1, "&__frame->_StubMsg,\n");
4158 print_file(file, indent + 1, "(PFORMAT_STRING)&__MIDL_TypeFormatString.Format[%d]);\n",
4159 var->type->typestring_offset);
4162 if (type_array_has_conformance(var->type))
4167 fprintf(file, " = NdrAllocate(&__frame->_StubMsg, ");
4168 for (type = var->type;
4169 is_array(type) && type_array_has_conformance(type);
4170 type = type_array_get_element(type))
4172 write_expr(file, type_array_get_conformance(type), TRUE,
4173 TRUE, NULL, NULL, local_var_prefix);
4174 fprintf(file, " * ");
4176 size = type_memsize(type);
4177 fprintf(file, "%u);\n", size);
4179 print_file(file, indent, "memset(%s%s, 0, ", local_var_prefix, var->name);
4180 for (type = var->type;
4181 is_array(type) && type_array_has_conformance(type);
4182 type = type_array_get_element(type))
4184 write_expr(file, type_array_get_conformance(type), TRUE,
4185 TRUE, NULL, NULL, local_var_prefix);
4186 fprintf(file, " * ");
4188 size = type_memsize(type);
4189 fprintf(file, "%u);\n", size);
4192 fprintf(file, " = &%s_W%u;\n", local_var_prefix, i++);
4195 fprintf(file, " = &%s_W%u;\n", local_var_prefix, i);
4196 switch (typegen_detect_type(type_pointer_get_ref(var->type), var->attrs, TDT_IGNORE_STRINGS))
4202 case TGT_IFACE_POINTER:
4203 print_file(file, indent, "%s_W%u = 0;\n", local_var_prefix, i);
4206 print_file(file, indent, "memset(&%s_W%u, 0, sizeof(%s_W%u));\n",
4207 local_var_prefix, i, local_var_prefix, i);
4212 case TGT_CTXT_HANDLE:
4213 case TGT_CTXT_HANDLE_POINTER:
4216 /* not initialised */
4229 fprintf(file, "\n");
4233 int write_expr_eval_routines(FILE *file, const char *iface)
4235 static const char *var_name = "pS";
4236 static const char *var_name_expr = "pS->";
4238 struct expr_eval_routine *eval;
4239 unsigned short callback_offset = 0;
4241 LIST_FOR_EACH_ENTRY(eval, &expr_eval_routines, struct expr_eval_routine, entry)
4243 const char *name = eval->name;
4246 print_file(file, 0, "static void __RPC_USER %s_%sExprEval_%04u(PMIDL_STUB_MESSAGE pStubMsg)\n",
4247 iface, name, callback_offset);
4248 print_file(file, 0, "{\n");
4249 if (type_get_type( eval->cont_type ) == TYPE_FUNCTION)
4251 const var_list_t *args = type_get_function_args( eval->cont_type );
4254 print_file(file, 1, "struct _PARAM_STRUCT\n" );
4255 print_file(file, 1, "{\n" );
4256 if (is_object( eval->iface )) print_file(file, 2, "%s *This;\n", eval->iface->name );
4258 if (args) LIST_FOR_EACH_ENTRY( arg, args, const var_t, entry )
4260 print_file(file, 2, "%s", "");
4261 write_type_left( file, (type_t *)arg->type, TRUE );
4262 if (needs_space_after( arg->type )) fputc( ' ', file );
4263 if (is_array( arg->type ) && !type_array_is_decl_as_ptr( arg->type )) fputc( '*', file );
4264 /* FIXME: should check for large args being passed by pointer */
4265 if (is_array( arg->type ) || is_ptr( arg->type ) || type_memsize( arg->type ) == pointer_size)
4266 fprintf( file, "%s;\n", arg->name );
4268 fprintf( file, "%s DECLSPEC_ALIGN(%u);\n", arg->name, pointer_size );
4270 print_file(file, 1, "} *pS = (struct _PARAM_STRUCT *)pStubMsg->StackTop;\n" );
4274 print_file(file, 1, "%s", "");
4275 write_type_left(file, (type_t *)eval->cont_type, TRUE);
4276 fprintf(file, " *%s = (", var_name);
4277 write_type_left(file, (type_t *)eval->cont_type, TRUE);
4278 fprintf(file, " *)(pStubMsg->StackTop - %u);\n", eval->baseoff);
4280 print_file(file, 1, "pStubMsg->Offset = 0;\n"); /* FIXME */
4281 print_file(file, 1, "pStubMsg->MaxCount = (ULONG_PTR)");
4282 write_expr(file, eval->expr, 1, 1, var_name_expr, eval->cont_type, "");
4283 fprintf(file, ";\n");
4284 print_file(file, 0, "}\n\n");
4290 void write_expr_eval_routine_list(FILE *file, const char *iface)
4292 struct expr_eval_routine *eval;
4293 struct expr_eval_routine *cursor;
4294 unsigned short callback_offset = 0;
4296 fprintf(file, "static const EXPR_EVAL ExprEvalRoutines[] =\n");
4297 fprintf(file, "{\n");
4299 LIST_FOR_EACH_ENTRY_SAFE(eval, cursor, &expr_eval_routines, struct expr_eval_routine, entry)
4301 print_file(file, 1, "%s_%sExprEval_%04u,\n", iface, eval->name, callback_offset);
4303 list_remove(&eval->entry);
4308 fprintf(file, "};\n\n");
4311 void write_user_quad_list(FILE *file)
4315 if (list_empty(&user_type_list))
4318 fprintf(file, "static const USER_MARSHAL_ROUTINE_QUADRUPLE UserMarshalRoutines[] =\n");
4319 fprintf(file, "{\n");
4320 LIST_FOR_EACH_ENTRY(ut, &user_type_list, user_type_t, entry)
4322 const char *sep = &ut->entry == list_tail(&user_type_list) ? "" : ",";
4323 print_file(file, 1, "{\n");
4324 print_file(file, 2, "(USER_MARSHAL_SIZING_ROUTINE)%s_UserSize,\n", ut->name);
4325 print_file(file, 2, "(USER_MARSHAL_MARSHALLING_ROUTINE)%s_UserMarshal,\n", ut->name);
4326 print_file(file, 2, "(USER_MARSHAL_UNMARSHALLING_ROUTINE)%s_UserUnmarshal,\n", ut->name);
4327 print_file(file, 2, "(USER_MARSHAL_FREEING_ROUTINE)%s_UserFree\n", ut->name);
4328 print_file(file, 1, "}%s\n", sep);
4330 fprintf(file, "};\n\n");
4333 void write_endpoints( FILE *f, const char *prefix, const str_list_t *list )
4335 const struct str_list_entry_t *endpoint;
4338 /* this should be an array of RPC_PROTSEQ_ENDPOINT but we want const strings */
4339 print_file( f, 0, "static const unsigned char * const %s__RpcProtseqEndpoint[][2] =\n{\n", prefix );
4340 LIST_FOR_EACH_ENTRY( endpoint, list, const struct str_list_entry_t, entry )
4342 print_file( f, 1, "{ (const unsigned char *)\"" );
4343 for (p = endpoint->str; *p && *p != ':'; p++)
4345 if (*p == '"' || *p == '\\') fputc( '\\', f );
4348 if (!*p) goto error;
4349 if (p[1] != '[') goto error;
4351 fprintf( f, "\", (const unsigned char *)\"" );
4352 for (p += 2; *p && *p != ']'; p++)
4354 if (*p == '"' || *p == '\\') fputc( '\\', f );
4357 if (*p != ']') goto error;
4358 fprintf( f, "\" },\n" );
4360 print_file( f, 0, "};\n\n" );
4364 error("Invalid endpoint syntax '%s'\n", endpoint->str);
4367 void write_exceptions( FILE *file )
4369 fprintf( file, "#ifndef USE_COMPILER_EXCEPTIONS\n");
4370 fprintf( file, "\n");
4371 fprintf( file, "#include \"wine/exception.h\"\n");
4372 fprintf( file, "#undef RpcTryExcept\n");
4373 fprintf( file, "#undef RpcExcept\n");
4374 fprintf( file, "#undef RpcEndExcept\n");
4375 fprintf( file, "#undef RpcTryFinally\n");
4376 fprintf( file, "#undef RpcFinally\n");
4377 fprintf( file, "#undef RpcEndFinally\n");
4378 fprintf( file, "#undef RpcExceptionCode\n");
4379 fprintf( file, "#undef RpcAbnormalTermination\n");
4380 fprintf( file, "\n");
4381 fprintf( file, "struct __exception_frame;\n");
4382 fprintf( file, "typedef int (*__filter_func)(struct __exception_frame *);\n");
4383 fprintf( file, "typedef void (*__finally_func)(struct __exception_frame *);\n");
4384 fprintf( file, "\n");
4385 fprintf( file, "#define __DECL_EXCEPTION_FRAME \\\n");
4386 fprintf( file, " EXCEPTION_REGISTRATION_RECORD frame; \\\n");
4387 fprintf( file, " __filter_func filter; \\\n");
4388 fprintf( file, " __finally_func finally; \\\n");
4389 fprintf( file, " sigjmp_buf jmp; \\\n");
4390 fprintf( file, " DWORD code; \\\n");
4391 fprintf( file, " unsigned char abnormal_termination; \\\n");
4392 fprintf( file, " unsigned char filter_level; \\\n");
4393 fprintf( file, " unsigned char finally_level;\n");
4394 fprintf( file, "\n");
4395 fprintf( file, "struct __exception_frame\n{\n");
4396 fprintf( file, " __DECL_EXCEPTION_FRAME\n");
4397 fprintf( file, "};\n");
4398 fprintf( file, "\n");
4399 fprintf( file, "static inline void __widl_unwind_target(void)\n" );
4400 fprintf( file, "{\n");
4401 fprintf( file, " struct __exception_frame *exc_frame = (struct __exception_frame *)__wine_get_frame();\n" );
4402 fprintf( file, " if (exc_frame->finally_level > exc_frame->filter_level)\n" );
4403 fprintf( file, " {\n");
4404 fprintf( file, " exc_frame->abnormal_termination = 1;\n");
4405 fprintf( file, " exc_frame->finally( exc_frame );\n");
4406 fprintf( file, " __wine_pop_frame( &exc_frame->frame );\n");
4407 fprintf( file, " }\n");
4408 fprintf( file, " exc_frame->filter_level = 0;\n");
4409 fprintf( file, " siglongjmp( exc_frame->jmp, 1 );\n");
4410 fprintf( file, "}\n");
4411 fprintf( file, "\n");
4412 fprintf( file, "static DWORD __widl_exception_handler( EXCEPTION_RECORD *record,\n");
4413 fprintf( file, " EXCEPTION_REGISTRATION_RECORD *frame,\n");
4414 fprintf( file, " CONTEXT *context,\n");
4415 fprintf( file, " EXCEPTION_REGISTRATION_RECORD **pdispatcher )\n");
4416 fprintf( file, "{\n");
4417 fprintf( file, " struct __exception_frame *exc_frame = (struct __exception_frame *)frame;\n");
4418 fprintf( file, "\n");
4419 fprintf( file, " if (record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND | EH_NESTED_CALL))\n");
4420 fprintf( file, " {\n" );
4421 fprintf( file, " if (exc_frame->finally_level && (record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)))\n");
4422 fprintf( file, " {\n" );
4423 fprintf( file, " exc_frame->abnormal_termination = 1;\n");
4424 fprintf( file, " exc_frame->finally( exc_frame );\n");
4425 fprintf( file, " }\n" );
4426 fprintf( file, " return ExceptionContinueSearch;\n");
4427 fprintf( file, " }\n" );
4428 fprintf( file, " exc_frame->code = record->ExceptionCode;\n");
4429 fprintf( file, " if (exc_frame->filter_level && exc_frame->filter( exc_frame ) == EXCEPTION_EXECUTE_HANDLER)\n" );
4430 fprintf( file, " __wine_rtl_unwind( frame, record, __widl_unwind_target );\n");
4431 fprintf( file, " return ExceptionContinueSearch;\n");
4432 fprintf( file, "}\n");
4433 fprintf( file, "\n");
4434 fprintf( file, "#define RpcTryExcept \\\n");
4435 fprintf( file, " if (!sigsetjmp( __frame->jmp, 0 )) \\\n");
4436 fprintf( file, " { \\\n");
4437 fprintf( file, " if (!__frame->finally_level) \\\n" );
4438 fprintf( file, " __wine_push_frame( &__frame->frame ); \\\n");
4439 fprintf( file, " __frame->filter_level = __frame->finally_level + 1;\n" );
4440 fprintf( file, "\n");
4441 fprintf( file, "#define RpcExcept(expr) \\\n");
4442 fprintf( file, " if (!__frame->finally_level) \\\n" );
4443 fprintf( file, " __wine_pop_frame( &__frame->frame ); \\\n");
4444 fprintf( file, " __frame->filter_level = 0; \\\n" );
4445 fprintf( file, " } \\\n");
4446 fprintf( file, " else \\\n");
4447 fprintf( file, "\n");
4448 fprintf( file, "#define RpcEndExcept\n");
4449 fprintf( file, "\n");
4450 fprintf( file, "#define RpcExceptionCode() (__frame->code)\n");
4451 fprintf( file, "\n");
4452 fprintf( file, "#define RpcTryFinally \\\n");
4453 fprintf( file, " if (!__frame->filter_level) \\\n");
4454 fprintf( file, " __wine_push_frame( &__frame->frame ); \\\n");
4455 fprintf( file, " __frame->finally_level = __frame->filter_level + 1;\n");
4456 fprintf( file, "\n");
4457 fprintf( file, "#define RpcFinally \\\n");
4458 fprintf( file, " if (!__frame->filter_level) \\\n");
4459 fprintf( file, " __wine_pop_frame( &__frame->frame ); \\\n");
4460 fprintf( file, " __frame->finally_level = 0;\n");
4461 fprintf( file, "\n");
4462 fprintf( file, "#define RpcEndFinally\n");
4463 fprintf( file, "\n");
4464 fprintf( file, "#define RpcAbnormalTermination() (__frame->abnormal_termination)\n");
4465 fprintf( file, "\n");
4466 fprintf( file, "#define RpcExceptionInit(filter_func,finally_func) \\\n");
4467 fprintf( file, " do { \\\n");
4468 fprintf( file, " __frame->frame.Handler = __widl_exception_handler; \\\n");
4469 fprintf( file, " __frame->filter = (__filter_func)(filter_func); \\\n" );
4470 fprintf( file, " __frame->finally = (__finally_func)(finally_func); \\\n");
4471 fprintf( file, " __frame->abnormal_termination = 0; \\\n");
4472 fprintf( file, " __frame->filter_level = 0; \\\n");
4473 fprintf( file, " __frame->finally_level = 0; \\\n");
4474 fprintf( file, " } while (0)\n");
4475 fprintf( file, "\n");
4476 fprintf( file, "#else /* USE_COMPILER_EXCEPTIONS */\n");
4477 fprintf( file, "\n");
4478 fprintf( file, "#define RpcExceptionInit(filter_func,finally_func) \\\n");
4479 fprintf( file, " do { (void)(filter_func); } while(0)\n");
4480 fprintf( file, "\n");
4481 fprintf( file, "#define __DECL_EXCEPTION_FRAME \\\n");
4482 fprintf( file, " DWORD code;\n");
4483 fprintf( file, "\n");
4484 fprintf( file, "#endif /* USE_COMPILER_EXCEPTIONS */\n");