/* * Format String Generator for IDL Compiler * * Copyright 2005 Eric Kohl * Copyright 2005 Robert Shearman * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #include "config.h" #include "wine/port.h" #include #include #ifdef HAVE_UNISTD_H # include #endif #include #include #include #include #include "widl.h" #include "utils.h" #include "parser.h" #include "header.h" #include "windef.h" #include "widl.h" #include "typegen.h" static int print_file(FILE *file, int indent, const char *format, ...) { va_list va; int i, r; if (!file) return 0; va_start(va, format); for (i = 0; i < indent; i++) fprintf(file, " "); r = vfprintf(file, format, va); va_end(va); return r; } static size_t write_procformatstring_var(FILE *file, int indent, var_t *var, int is_return, unsigned int *type_offset) { size_t size; if (var->ptr_level == 0 && !var->array) { if (is_return) print_file(file, indent, "0x53, /* FC_RETURN_PARAM_BASETYPE */\n"); else print_file(file, indent, "0x4e, /* FC_IN_PARAM_BASETYPE */\n"); switch(var->type->type) { #define CASE_BASETYPE(fctype) \ case RPC_##fctype: \ print_file(file, indent, "0x%02x, /* " #fctype " */\n", var->type->type); \ size = 2; /* includes param type prefix */ \ break CASE_BASETYPE(FC_BYTE); CASE_BASETYPE(FC_CHAR); CASE_BASETYPE(FC_WCHAR); CASE_BASETYPE(FC_USHORT); CASE_BASETYPE(FC_SHORT); CASE_BASETYPE(FC_ULONG); CASE_BASETYPE(FC_LONG); CASE_BASETYPE(FC_HYPER); CASE_BASETYPE(FC_IGNORE); CASE_BASETYPE(FC_USMALL); CASE_BASETYPE(FC_SMALL); CASE_BASETYPE(FC_FLOAT); CASE_BASETYPE(FC_DOUBLE); CASE_BASETYPE(FC_ERROR_STATUS_T); #undef CASE_BASETYPE default: error("Unknown/unsupported type: %s (0x%02x)\n", var->name, var->type->type); size = 0; } } else { int in_attr = is_attr(var->attrs, ATTR_IN); int out_attr = is_attr(var->attrs, ATTR_OUT); if (is_return) print_file(file, indent, "0x52, /* FC_RETURN_PARAM */\n"); else if (in_attr && out_attr) print_file(file, indent, "0x50, /* FC_IN_OUT_PARAM */\n"); else if (out_attr) print_file(file, indent, "0x51, /* FC_OUT_PARAM */\n"); else print_file(file, indent, "0x4d, /* FC_IN_PARAM */\n"); print_file(file, indent, "0x01,\n"); print_file(file, indent, "NdrFcShort(0x%x),\n", *type_offset); size = 4; /* includes param type prefix */ } *type_offset += get_size_typeformatstring_var(var); return size; } void write_procformatstring(FILE *file, type_t *iface) { int indent = 0; var_t *var; unsigned int type_offset = 2; print_file(file, indent, "static const MIDL_PROC_FORMAT_STRING __MIDL_ProcFormatString =\n"); print_file(file, indent, "{\n"); indent++; print_file(file, indent, "0,\n"); print_file(file, indent, "{\n"); indent++; if (iface->funcs) { func_t *func = iface->funcs; while (NEXT_LINK(func)) func = NEXT_LINK(func); for (; func; func = PREV_LINK(func)) { /* emit argument data */ if (func->args) { var = func->args; while (NEXT_LINK(var)) var = NEXT_LINK(var); while (var) { write_procformatstring_var(file, indent, var, FALSE, &type_offset); var = PREV_LINK(var); } } /* emit return value data */ var = func->def; if (is_void(var->type, NULL)) { print_file(file, indent, "0x5b, /* FC_END */\n"); print_file(file, indent, "0x5c, /* FC_PAD */\n"); } else write_procformatstring_var(file, indent, var, TRUE, &type_offset); } } print_file(file, indent, "0x0\n"); indent--; print_file(file, indent, "}\n"); indent--; print_file(file, indent, "};\n"); print_file(file, indent, "\n"); } static size_t write_typeformatstring_var(FILE *file, int indent, var_t *var) { int ptr_level = var->ptr_level; /* basic types don't need a type format string */ if (ptr_level == 0 && !var->array) return 0; if (ptr_level == 1 || (var->ptr_level == 0 && var->array && !NEXT_LINK(var->array))) { switch (var->type->type) { #define CASE_BASETYPE(fctype) \ case RPC_##fctype: \ print_file(file, indent, "0x11, 0x08, /* FC_RP [simple_pointer] */\n"); \ print_file(file, indent, "0x%02x, /* " #fctype " */\n", var->type->type); \ print_file(file, indent, "0x5c, /* FC_PAD */\n"); \ return 4 CASE_BASETYPE(FC_BYTE); CASE_BASETYPE(FC_CHAR); CASE_BASETYPE(FC_SMALL); CASE_BASETYPE(FC_USMALL); CASE_BASETYPE(FC_WCHAR); CASE_BASETYPE(FC_SHORT); CASE_BASETYPE(FC_USHORT); CASE_BASETYPE(FC_LONG); CASE_BASETYPE(FC_ULONG); CASE_BASETYPE(FC_FLOAT); CASE_BASETYPE(FC_HYPER); CASE_BASETYPE(FC_DOUBLE); CASE_BASETYPE(FC_ENUM16); CASE_BASETYPE(FC_ENUM32); CASE_BASETYPE(FC_IGNORE); CASE_BASETYPE(FC_ERROR_STATUS_T); default: error("write_typeformatstring_var: Unknown/unsupported type: %s (0x%02x)\n", var->name, var->type->type); } } error("write_typeformatstring_var: Pointer level %d not supported for variable %s\n", ptr_level, var->name); return 0; } void write_typeformatstring(FILE *file, type_t *iface) { int indent = 0; var_t *var; print_file(file, indent, "static const MIDL_TYPE_FORMAT_STRING __MIDL_TypeFormatString =\n"); print_file(file, indent, "{\n"); indent++; print_file(file, indent, "0,\n"); print_file(file, indent, "{\n"); indent++; print_file(file, indent, "NdrFcShort(0x0),\n"); if (iface->funcs) { func_t *func = iface->funcs; while (NEXT_LINK(func)) func = NEXT_LINK(func); for (; func; func = PREV_LINK(func)) { if (func->args) { var = func->args; while (NEXT_LINK(var)) var = NEXT_LINK(var); while (var) { write_typeformatstring_var(file, indent, var); var = PREV_LINK(var); } } } } print_file(file, indent, "0x0\n"); indent--; print_file(file, indent, "}\n"); indent--; print_file(file, indent, "};\n"); print_file(file, indent, "\n"); } unsigned int get_required_buffer_size(const var_t *var, unsigned int *alignment) { *alignment = 0; if (var->ptr_level == 0 && !var->array) { switch (var->type->type) { case RPC_FC_BYTE: case RPC_FC_CHAR: case RPC_FC_USMALL: case RPC_FC_SMALL: return 1; case RPC_FC_WCHAR: case RPC_FC_USHORT: case RPC_FC_SHORT: *alignment = 2; return 2; case RPC_FC_ULONG: case RPC_FC_LONG: case RPC_FC_FLOAT: case RPC_FC_ERROR_STATUS_T: *alignment = 4; return 4; case RPC_FC_HYPER: case RPC_FC_DOUBLE: *alignment = 8; return 8; default: error("get_required_buffer_size: Unknown/unsupported type: %s (0x%02x)\n", var->name, var->type->type); return 0; } } return 0; } void marshall_arguments(FILE *file, int indent, func_t *func, unsigned int *type_offset, enum pass pass) { unsigned int last_size = 0; var_t *var; if (!func->args) return; var = func->args; while (NEXT_LINK(var)) var = NEXT_LINK(var); for (; var; *type_offset += get_size_typeformatstring_var(var), var = PREV_LINK(var)) { int in_attr = is_attr(var->attrs, ATTR_IN); int out_attr = is_attr(var->attrs, ATTR_OUT); if (!in_attr && !out_attr) in_attr = 1; switch (pass) { case PASS_IN: if (!in_attr) continue; break; case PASS_OUT: if (!out_attr) continue; break; case PASS_RETURN: break; } if (var->ptr_level == 0 && !var->array) { unsigned int size; unsigned int alignment = 0; switch (var->type->type) { case RPC_FC_BYTE: case RPC_FC_CHAR: case RPC_FC_SMALL: case RPC_FC_USMALL: size = 1; alignment = 0; break; case RPC_FC_WCHAR: case RPC_FC_USHORT: case RPC_FC_SHORT: size = 2; if (last_size != 0 && last_size < 2) alignment = (2 - last_size); break; case RPC_FC_ULONG: case RPC_FC_LONG: case RPC_FC_FLOAT: case RPC_FC_ERROR_STATUS_T: size = 4; if (last_size != 0 && last_size < 4) alignment = (4 - last_size); break; case RPC_FC_HYPER: case RPC_FC_DOUBLE: size = 8; if (last_size != 0 && last_size < 4) alignment = (4 - last_size); break; default: error("marshall_arguments: Unsupported type: %s (0x%02x, ptr_level: 0)\n", var->name, var->type->type); size = 0; } if (alignment != 0) print_file(file, indent, "_StubMsg.Buffer += %u;\n", alignment); print_file(file, indent, "*("); write_type(file, var->type, var, var->tname); fprintf(file, " *)_StubMsg.Buffer = "); write_name(file, var); fprintf(file, ";\n"); fprintf(file, "_StubMsg.Buffer += sizeof("); write_type(file, var->type, var, var->tname); fprintf(file, ");\n"); fprintf(file, "\n"); last_size = size; } else if ((var->ptr_level == 1 && !var->array) || (var->ptr_level == 0 && var->array)) { if (is_attr(var->attrs, ATTR_STRING)) { switch (var->type->type) { case RPC_FC_CHAR: case RPC_FC_WCHAR: print_file(file, indent, "NdrConformantStringMarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d]);\n", var->name, *type_offset); break; default: error("marshall_arguments: Unsupported [string] type: %s (0x%02x, ptr_level: 1)\n", var->name, var->type->type); } } else if (var->array) { const expr_t *length_is = get_attrp(var->attrs, ATTR_LENGTHIS); const expr_t *size_is = get_attrp(var->attrs, ATTR_SIZEIS); const char *array_type; int has_length = length_is && (length_is->type != EXPR_VOID); int has_size = size_is && (size_is->type != EXPR_VOID) && !var->array->is_const; if (NEXT_LINK(var->array)) /* multi-dimensional array */ array_type = "ComplexArray"; else { if (!has_length && !has_size) array_type = "FixedArray"; else if (has_length && !has_size) array_type = "VaryingArray"; else if (!has_length && has_size) array_type = "ConformantArray"; else array_type = "ConformantVaryingArray"; } print_file(file, indent, "Ndr%sMarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d]);\n", array_type, var->name, *type_offset); } else { const char *ndrtype; switch (var->type->type) { case RPC_FC_STRUCT: ndrtype = "SimpleStruct"; break; case RPC_FC_CSTRUCT: case RPC_FC_CPSTRUCT: ndrtype = "ConformantStruct"; break; case RPC_FC_CVSTRUCT: ndrtype = "ConformantVaryingStruct"; break; case RPC_FC_BOGUS_STRUCT: ndrtype = "ComplexStruct"; break; default: error("marshall_arguments: Unsupported type: %s (0x%02x, ptr_level: %d)\n", var->name, var->type->type, var->ptr_level); ndrtype = NULL; } print_file(file, indent, "Ndr%sMarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d]);\n", ndrtype, var->name, *type_offset); } last_size = 1; } else { error("marshall_arguments: Pointer level %d not supported for variable %s\n", var->ptr_level, var->name); last_size = 1; } fprintf(file, "\n"); } } void unmarshall_arguments(FILE *file, int indent, func_t *func, unsigned int *type_offset, enum pass pass) { unsigned int last_size = 0; var_t *var; if (!func->args) return; var = func->args; while (NEXT_LINK(var)) var = NEXT_LINK(var); for (; var; *type_offset += get_size_typeformatstring_var(var), var = PREV_LINK(var)) { int in_attr = is_attr(var->attrs, ATTR_IN); int out_attr = is_attr(var->attrs, ATTR_OUT); if (!in_attr && !out_attr) in_attr = 1; switch (pass) { case PASS_IN: if (!in_attr) continue; break; case PASS_OUT: if (!out_attr) continue; break; case PASS_RETURN: break; } if (var->ptr_level == 0 && !var->array) { unsigned int size; unsigned int alignment = 0; switch (var->type->type) { case RPC_FC_BYTE: case RPC_FC_CHAR: case RPC_FC_SMALL: case RPC_FC_USMALL: size = 1; alignment = 0; break; case RPC_FC_WCHAR: case RPC_FC_USHORT: case RPC_FC_SHORT: size = 2; if (last_size != 0 && last_size < 2) alignment = (2 - last_size); break; case RPC_FC_ULONG: case RPC_FC_LONG: case RPC_FC_FLOAT: case RPC_FC_ERROR_STATUS_T: size = 4; if (last_size != 0 && last_size < 4) alignment = (4 - last_size); break; case RPC_FC_HYPER: case RPC_FC_DOUBLE: size = 8; if (last_size != 0 && last_size < 4) alignment = (4 - last_size); break; default: error("unmarshall_arguments: Unsupported type: %s (0x%02x, ptr_level: 0)\n", var->name, var->type->type); size = 0; } if (alignment != 0) print_file(file, indent, "_StubMsg.Buffer += %u;\n", alignment); print_file(file, indent, ""); write_name(file, var); fprintf(file, " = *("); write_type(file, var->type, var, var->tname); fprintf(file, " *)_StubMsg.Buffer;\n"); fprintf(file, "_StubMsg.Buffer += sizeof("); write_type(file, var->type, var, var->tname); fprintf(file, ");\n"); fprintf(file, "\n"); last_size = size; } else if ((var->ptr_level == 1 && !var->array) || (var->ptr_level == 0 && var->array)) { if (is_attr(var->attrs, ATTR_STRING)) { switch (var->type->type) { case RPC_FC_CHAR: case RPC_FC_WCHAR: print_file(file, indent, "NdrConformantStringUnmarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d], 0);\n", var->name, *type_offset); break; default: error("unmarshall_arguments: Unsupported [string] type: %s (0x%02x, ptr_level: %d)\n", var->name, var->type->type, var->ptr_level); } } else if (var->array) { const expr_t *length_is = get_attrp(var->attrs, ATTR_LENGTHIS); const expr_t *size_is = get_attrp(var->attrs, ATTR_SIZEIS); const char *array_type; int has_length = length_is && (length_is->type != EXPR_VOID); int has_size = size_is && (size_is->type != EXPR_VOID) && !var->array->is_const; if (NEXT_LINK(var->array)) /* multi-dimensional array */ array_type = "ComplexArray"; else { if (!has_length && !has_size) array_type = "FixedArray"; else if (has_length && !has_size) array_type = "VaryingArray"; else if (!has_length && has_size) array_type = "ConformantArray"; else array_type = "ConformantVaryingArray"; } print_file(file, indent, "Ndr%sUnmarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d], 0);\n", array_type, var->name, *type_offset); } else { const char *ndrtype; switch (var->type->type) { case RPC_FC_STRUCT: ndrtype = "SimpleStruct"; break; case RPC_FC_CSTRUCT: case RPC_FC_CPSTRUCT: ndrtype = "ConformantStruct"; break; case RPC_FC_CVSTRUCT: ndrtype = "ConformantVaryingStruct"; break; case RPC_FC_BOGUS_STRUCT: ndrtype = "ComplexStruct"; break; default: error("unmarshall_arguments: Unsupported type: %s (0x%02x, ptr_level: %d)\n", var->name, var->type->type, var->ptr_level); ndrtype = NULL; } print_file(file, indent, "Ndr%sUnmarshall(&_StubMsg, (unsigned char *)%s, &__MIDL_TypeFormatString.Format[%d], 0);\n", ndrtype, var->name, *type_offset); } last_size = 1; } else { error("unmarshall_arguments: Pointer level %d not supported for variable %s\n", var->ptr_level, var->name); last_size = 1; } fprintf(file, "\n"); } } size_t get_size_procformatstring_var(var_t *var) { unsigned int type_offset = 2; return write_procformatstring_var(NULL, 0, var, FALSE, &type_offset); } size_t get_size_typeformatstring_var(var_t *var) { return write_typeformatstring_var(NULL, 0, var); }