[PATCH 0/3] MR8248: widl: Always write WinRT enum type definitions.

[Rémi Bernon (＠rbernon)]

MSVC supports enum type forward declarations and doesn't complain if the
enum is only defined in a later included file, but GCC requires enums to
be defined before being used in parameters or fields.

This emits every WinRT enum definition, unlike MIDL, before any typedef,
so that the generated headers then work with GCC.

[PATCH 1/3] widl: Write apicontracts macros before they are used.

[Rémi Bernon]

From: Rémi Bernon

---
 tools/widl/header.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/tools/widl/header.c b/tools/widl/header.c
index 31b476df677..62ec9022c71 100644
--- a/tools/widl/header.c
+++ b/tools/widl/header.c
@@ -42,6 +42,7 @@ generic_handle_list_t generic_handle_list = LIST_INIT(generic_handle_list);

static void write_type_v(FILE *f, const decl_spec_t *t, int is_field, bool define, const char *name, enum name_type name_type);

+static void write_apicontract( FILE *header, type_t *type );
 static void write_apicontract_guard_start(FILE *header, const expr_t *expr);
 static void write_apicontract_guard_end(FILE *header, const expr_t *expr);

@@ -1574,11 +1575,12 @@ static char *format_apicontract_macro(const type_t *type)

static void write_apicontract_guard_start(FILE *header, const expr_t *expr)
 {
-    const type_t *type;
+    type_t *type;
     char *name;
     int ver;
     if (!winrt_mode) return;
     type = expr->u.tref.type;
+    write_apicontract( header, type );
     ver = expr->ref->u.integer.value;
     name = format_apicontract_macro(type);
     fprintf(header, "#if %s_VERSION >= %#x\n", name, ver);
@@ -1823,11 +1825,14 @@ static void write_coclass_forward(FILE *header, type_t *cocl)

static void write_apicontract(FILE *header, type_t *apicontract)
 {
-    char *name = format_apicontract_macro(apicontract);
+    char *name;
+    if (apicontract->written) return;
+    name = format_apicontract_macro( apicontract );
     fprintf(header, "#if !defined(%s_VERSION)\n", name);
     fprintf(header, "#define %s_VERSION %#x\n", name, get_attrv(apicontract->attrs, ATTR_CONTRACTVERSION));
     fprintf(header, "#endif // defined(%s_VERSION)\n\n", name);
     free(name);
+    apicontract->written = true;
 }

static void write_runtimeclass(FILE *header, type_t *runtimeclass)

[PATCH 2/3] widl: Skip writing type definition if already written.

[Rémi Bernon]

From: Rémi Bernon

---
 tools/widl/header.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tools/widl/header.c b/tools/widl/header.c
index 62ec9022c71..ed3529c9663 100644
--- a/tools/widl/header.c
+++ b/tools/widl/header.c
@@ -560,10 +560,11 @@ static void write_type_v(FILE *h, const decl_spec_t *ds, int is_field, bool defi
 static void write_type_definition(FILE *f, type_t *t, bool define)
 {
     int in_namespace = t->namespace && !is_global_namespace(t->namespace);
-    int save_written = t->written;
     decl_spec_t ds = {.type = t};
     expr_t *contract = get_attrp(t->attrs, ATTR_CONTRACT);

+    if (t->written) return;
+
     if (contract) write_apicontract_guard_start(f, contract);
     if(in_namespace) {
         fprintf(f, "#ifdef __cplusplus\n");
@@ -574,7 +575,7 @@ static void write_type_definition(FILE *f, type_t *t, bool define)
     write_type_left(f, &ds, NAME_DEFAULT, define, TRUE);
     fprintf(f, ";\n");
     if(in_namespace) {
-        t->written = save_written;
+        t->written = false;
         write_namespace_end(f, t->namespace);
         fprintf(f, "extern "C" {\n");
         fprintf(f, "#else\n");

[PATCH 3/3] widl: Always write WinRT enum type definitions.

[Rémi Bernon]

From: Rémi Bernon

MSVC supports enum type forward declarations and doesn't complain if the
enum is only defined in a later included file, but GCC requires enums to
be defined before being used in parameters or fields.

This emits every WinRT enum definition, unlike MIDL, before any typedef,
so that the generated headers then work with GCC.
---
 tools/widl/header.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/tools/widl/header.c b/tools/widl/header.c
index ed3529c9663..e2ce883b788 100644
--- a/tools/widl/header.c
+++ b/tools/widl/header.c
@@ -566,6 +566,11 @@ static void write_type_definition(FILE *f, type_t *t, bool define)
     if (t->written) return;

if (contract) write_apicontract_guard_start(f, contract);
+    if (winrt_mode && define && type_get_type( t ) == TYPE_ENUM)
+    {
+        fprintf( f, "#ifndef __%s_ENUM_DEFINED__\n", t->c_name );
+        fprintf( f, "#define __%s_ENUM_DEFINED__\n", t->c_name );
+    }
     if(in_namespace) {
         fprintf(f, "#ifdef __cplusplus\n");
         fprintf(f, "} /* extern "C" */\n");
@@ -584,6 +589,8 @@ static void write_type_definition(FILE *f, type_t *t, bool define)
         if (winrt_mode) write_widl_using_macros(f, t);
         fprintf(f, "#endif\n\n");
     }
+    if (winrt_mode && define && type_get_type( t ) == TYPE_ENUM)
+        fprintf( f, "#endif /* __%s_ENUM_DEFINED__ */\n", t->c_name );
     if (contract) write_apicontract_guard_end(f, contract);
 }

@@ -818,6 +825,8 @@ static void write_generic_handle_routines(FILE *header)
 static void write_typedef(FILE *header, type_t *type, bool define)
 {
     type_t *t = type_alias_get_aliasee_type(type), *root = type_pointer_get_root_type(t);
+    if (winrt_mode && !define && type_get_type( t ) == TYPE_ENUM)
+        write_type_definition( header, t, TRUE );
     if (winrt_mode && root->namespace && !is_global_namespace(root->namespace))
     {
         fprintf(header, "#ifndef __cplusplus\n");

[Rémi Bernon (＠rbernon)]

Fwiw this is necessary for @vibhavp work on bluetooth WinRT APIs.

[PATCH 0/3] MR8248: widl: Always write WinRT enum type definitions. - approved

[Huw Davies (＠huw)]

This merge request was approved by Huw Davies.