diff mbox

add __attribute__ ((designated_init))

Message ID 87r47y1bta.fsf@fleche.redhat.com
State New
Headers show

Commit Message

Tom Tromey Jan. 24, 2014, 12:08 a.m. UTC
Joseph> I think the test should also cover cases with designators such
Joseph> as .d.x = 1.

>> +static tree handle_designated_init (tree *, tree, tree, int, bool *);

Joseph> handle_designated_init_attribute would seem a better name.

>> +      error ("designated_init attribute is only valid on struct type");

Joseph> %<designated_init%> (or use %qE with the attribute name as
Joseph> passed to the function, as is usual for such diagnostics).

FWIW I just noticed that handle_returns_nonnull_attribute doesn't do
this.

In this error, should I use "%<struct%>" rather than just plain "struct"
as well?

I've fixed up the patch according to your comments.

Tom

b/gcc/ChangeLog:
2014-01-23  Tom Tromey  <tromey@redhat.com>

	PR c/59855
	* doc/invoke.texi (Warning Options): Document -Wdesignated-init.
	* doc/extend.texi (Type Attributes): Document designated_init
	attribute.

b/gcc/c-family/ChangeLog:
2014-01-23  Tom Tromey  <tromey@redhat.com>

	PR c/59855
	* c.opt (Wdesignated-init): New option.
	* c-common.c (c_common_attribute_table): Add "designated_init".
	(handle_designated_init): New function.

b/gcc/c/ChangeLog:
2014-01-23  Tom Tromey  <tromey@redhat.com>

	* c-typeck.c (struct constructor_stack) <designator_depth>: New
	field.
	(really_start_incremental_init, push_init_level): Initialize
	designator_depth.
	(pop_init_level): Set global designator_depth.
	(process_init_element): Check for designated_init attribute.

b/gcc/testsuite/ChangeLog:
2014-01-23  Tom Tromey  <tromey@redhat.com>

	PR c/59855
	* gcc.dg/Wdesignated-init.c: New file.

Comments

Joseph Myers Jan. 24, 2014, 5:07 p.m. UTC | #1
On Thu, 23 Jan 2014, Tom Tromey wrote:

> In this error, should I use "%<struct%>" rather than just plain "struct"
> as well?

I think that's best (generally, %<%> or %q with anything quoting a 
source-code construct - anything that would go in a fixed-width font in 
documentation - "struct" is such a case, the English word is "structure").

> +  if (!implicit && warn_designated_init && !was_designated
> +      && TREE_CODE (constructor_type) == RECORD_TYPE
> +      && lookup_attribute ("designated_init",
> +			   TYPE_ATTRIBUTES (constructor_type)))
> +    warning_init (OPT_Wdesignated_init,
> +		  "positional initialization of field "
> +		  "in struct declared with designated_init attribute");

Also %<struct%> and %<designated_init%> here.

> +@item designated_init
> +This attribute may only be applied to struct types.  It indicates that

And @code{struct} (or "structure") here.

Is there a reason someone using the attribute might not want the warning?  
That is, why isn't -Wdesignated-init enabled by default, given that it's 
only relevant to people using an attribute whose sole function relates to 
the warning?
Tom Tromey Jan. 24, 2014, 5:26 p.m. UTC | #2
Joseph> I think that's best (generally, %<%> or %q with anything quoting
Joseph> a source-code construct - anything that would go in a
Joseph> fixed-width font in documentation - "struct" is such a case, the
Joseph> English word is "structure").

Makes sense.  I'll fix it all up.

Joseph> Is there a reason someone using the attribute might not want the
Joseph> warning?  That is, why isn't -Wdesignated-init enabled by
Joseph> default, given that it's only relevant to people using an
Joseph> attribute whose sole function relates to the warning?

Yes, good point -- and sparse enables this by default as well, which
somehow I hadn't noticed before.  I will do the same for gcc.

Tom
Tom Tromey Jan. 24, 2014, 11:01 p.m. UTC | #3
Joseph> Is there a reason someone using the attribute might not want the
Joseph> warning?  That is, why isn't -Wdesignated-init enabled by
Joseph> default, given that it's only relevant to people using an
Joseph> attribute whose sole function relates to the warning?

In making this change, I also removed the new option from -Wall.
It seemed like that would be the best approach; but I thought I'd note
it just to be sure.

Tom
diff mbox

Patch

diff --git a/gcc/c-family/c-common.c b/gcc/c-family/c-common.c
index 35958ea..a50d6d9 100644
--- a/gcc/c-family/c-common.c
+++ b/gcc/c-family/c-common.c
@@ -377,6 +377,7 @@  static tree handle_omp_declare_simd_attribute (tree *, tree, tree, int,
 					       bool *);
 static tree handle_omp_declare_target_attribute (tree *, tree, tree, int,
 						 bool *);
+static tree handle_designated_init_attribute (tree *, tree, tree, int, bool *);
 
 static void check_function_nonnull (tree, int, tree *);
 static void check_nonnull_arg (void *, tree, unsigned HOST_WIDE_INT);
@@ -766,6 +767,8 @@  const struct attribute_spec c_common_attribute_table[] =
 			      handle_omp_declare_simd_attribute, false },
   { "omp declare target",     0, 0, true, false, false,
 			      handle_omp_declare_target_attribute, false },
+  { "designated_init",        0, 0, false, true, false,
+			      handle_designated_init_attribute, false },
   { NULL,                     0, 0, false, false, false, NULL, false }
 };
 
@@ -9133,6 +9136,21 @@  handle_returns_nonnull_attribute (tree *node, tree, tree, int,
   return NULL_TREE;
 }
 
+/* Handle a "designated_init" attribute; arguments as in
+   struct attribute_spec.handler.  */
+
+static tree
+handle_designated_init_attribute (tree *node, tree name, tree, int,
+				  bool *no_add_attrs)
+{
+  if (TREE_CODE (*node) != RECORD_TYPE)
+    {
+      error ("%qE attribute is only valid on struct type", name);
+      *no_add_attrs = true;
+    }
+  return NULL_TREE;
+}
+
 
 /* Check for valid arguments being passed to a function with FNTYPE.
    There are NARGS arguments in the array ARGARRAY.  */
diff --git a/gcc/c-family/c.opt b/gcc/c-family/c.opt
index 38ae58e..29ac4d0 100644
--- a/gcc/c-family/c.opt
+++ b/gcc/c-family/c.opt
@@ -355,6 +355,10 @@  Wdeprecated
 C C++ ObjC ObjC++ Var(warn_deprecated) Init(1) Warning
 Warn if a deprecated compiler feature, class, method, or field is used
 
+Wdesignated-init
+C ObjC Var(warn_designated_init) Init(0) Warning LangEnabledBy(C ObjC,Wall)
+Warn about positional initialization of structs requiring designated initializers
+
 Wdiv-by-zero
 C ObjC C++ ObjC++ Var(warn_div_by_zero) Init(1) Warning
 Warn about compile-time integer division by zero
diff --git a/gcc/c/c-typeck.c b/gcc/c/c-typeck.c
index 92304b0..84f917f 100644
--- a/gcc/c/c-typeck.c
+++ b/gcc/c/c-typeck.c
@@ -6887,6 +6887,7 @@  struct constructor_stack
   char outer;
   char incremental;
   char designated;
+  int designator_depth;
 };
 
 static struct constructor_stack *constructor_stack;
@@ -7058,6 +7059,7 @@  really_start_incremental_init (tree type)
   p->outer = 0;
   p->incremental = constructor_incremental;
   p->designated = constructor_designated;
+  p->designator_depth = designator_depth;
   p->next = 0;
   constructor_stack = p;
 
@@ -7203,6 +7205,7 @@  push_init_level (int implicit, struct obstack * braced_init_obstack)
   p->outer = 0;
   p->incremental = constructor_incremental;
   p->designated = constructor_designated;
+  p->designator_depth = designator_depth;
   p->next = constructor_stack;
   p->range_stack = 0;
   constructor_stack = p;
@@ -7503,6 +7506,7 @@  pop_init_level (int implicit, struct obstack * braced_init_obstack)
   constructor_erroneous = p->erroneous;
   constructor_incremental = p->incremental;
   constructor_designated = p->designated;
+  designator_depth = p->designator_depth;
   constructor_pending_elts = p->pending_elts;
   constructor_depth = p->depth;
   if (!p->implicit)
@@ -8560,6 +8564,14 @@  process_init_element (struct c_expr value, bool implicit,
   if (constructor_type == 0)
     return;
 
+  if (!implicit && warn_designated_init && !was_designated
+      && TREE_CODE (constructor_type) == RECORD_TYPE
+      && lookup_attribute ("designated_init",
+			   TYPE_ATTRIBUTES (constructor_type)))
+    warning_init (OPT_Wdesignated_init,
+		  "positional initialization of field "
+		  "in struct declared with designated_init attribute");
+
   /* If we've exhausted any levels that didn't have braces,
      pop them now.  */
   while (constructor_stack->implicit)
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 2f4f91d..7cefeb1 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -5742,6 +5742,17 @@  and caught in another, the class must have default visibility.
 Otherwise the two shared objects are unable to use the same
 typeinfo node and exception handling will break.
 
+@item designated_init
+This attribute may only be applied to struct types.  It indicates that
+any initialization of an object of this type must use designated
+initializers rather than positional initializers.  The intent of this
+attribute is to allow the programmer to indicate that a structure's
+layout may change, and that therefore relying on positional
+initialization will result in future breakage.
+
+GCC only emits a warning for this attribute when
+@option{-Wdesignated-init} is given.
+
 @end table
 
 To specify multiple attributes, separate them by commas within the
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 1a3a268..a0e90f3 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -241,7 +241,8 @@  Objective-C and Objective-C++ Dialects}.
 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
--Wno-deprecated -Wno-deprecated-declarations -Wdisabled-optimization  @gol
+-Wno-deprecated -Wno-deprecated-declarations @gol
+-Wdesignated-init -Wdisabled-optimization  @gol
 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
 -Wno-endif-labels -Werror  -Werror=* @gol
 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
@@ -3340,6 +3341,7 @@  Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
 -Wc++11-compat  @gol
 -Wchar-subscripts  @gol
+-Wdesignated-init @gol
 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
 -Wimplicit-int @r{(C and Objective-C only)} @gol
 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
@@ -5094,6 +5096,12 @@  a suffix.  When used together with @option{-Wsystem-headers} it
 warns about such constants in system header files.  This can be useful
 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
 from the decimal floating-point extension to C99.
+
+@item -Wdesignated-init @r{(C and Objective-C only)}
+Issue a warning when a positional initializer is used to initialize a
+structure that has been marked with the @code{designated_init}
+attribute.
+
 @end table
 
 @node Debugging Options
diff --git a/gcc/testsuite/gcc.dg/Wdesignated-init.c b/gcc/testsuite/gcc.dg/Wdesignated-init.c
new file mode 100644
index 0000000..1e236f1
--- /dev/null
+++ b/gcc/testsuite/gcc.dg/Wdesignated-init.c
@@ -0,0 +1,107 @@ 
+/* PR c/59855 */
+/* { dg-do compile } */
+/* { dg-options "-Wdesignated-init" } */
+
+typedef int vvv  __attribute__((designated_init)); /* { dg-error "only valid" } */
+
+union U {
+  int a;
+  double b;
+} __attribute__((designated_init)); /* { dg-error "only valid" } */
+
+enum E { ONE, TWO }  __attribute__((designated_init)); /* { dg-error "only valid" } */
+
+struct Pok {
+  int x;
+  int y;
+};
+
+struct Des {
+  int x;
+  int y;
+} __attribute__ ((designated_init));
+
+struct Des d1 = { 5, 5 }; /* { dg-warning "(positional|near initialization)" } */
+struct Des d2 = { .x = 5, .y = 5 };
+struct Des d3 = { .x = 5, 5 }; /* { dg-warning "(positional|near initialization)" } */
+
+struct Des fd1 (void)
+{
+  return (struct Des) { 5, 5 }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Des fd2 (void)
+{
+  return (struct Des) { .x = 5, .y = 5 };
+}
+
+struct Des fd3 (void)
+{
+  return (struct Des) { .x = 5, 5 }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap {
+  struct Pok p;
+  struct Des d;
+} __attribute__ ((designated_init));
+
+struct Wrap w1 = { { 0, 1 }, { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w2 = { .p = { 0, 1 }, { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w3 = { .p = { 0, 1 }, .d = { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w4 = { { 0, 1 }, .d = { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w5 = { .p = { 0, 1 }, .d = { .x = 2, .y = 3} };
+
+struct Wrap w6 = { { 0, 1 }, .d.x = 2, .d.y = 3 }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w7 = { .p = { 0, 1 }, .d.x = 2, .d.y = 3 };
+struct Wrap w8 = { .p = { 0, 1 }, .d = { 2, 0 }, .d.y = 3 }; /* { dg-warning "(positional|near initialization)" } */
+struct Wrap w9 = { .p = { 0, 1 }, .d = { .x = 2 }, .d.y = 3 };
+
+struct Wrap fw1 (void)
+{
+  return (struct Wrap) { { 0, 1 }, { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+};
+
+struct Wrap fw2 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap fw3 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, .d = { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap fw4 (void)
+{
+  return (struct Wrap) { { 0, 1 }, .d = { 2, 3} }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap fw5 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, .d = { .x = 2, .y = 3} };
+}
+
+struct Wrap fw6 (void)
+{
+  return (struct Wrap) { { 0, 1 }, .d.x = 2, .d.y = 3 }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap fw7 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, .d.x = 2, .d.y = 3 };
+}
+
+struct Wrap fw8 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, .d = { 2, 0 }, .d.y = 3 }; /* { dg-warning "(positional|near initialization)" } */
+}
+
+struct Wrap fw9 (void)
+{
+  return (struct Wrap) { .p = { 0, 1 }, .d = { .x = 2 }, .d.y = 3 };
+}
+
+struct Des da[] = {
+  { .x = 1, .y = 2 },
+  { 5, 5 } /* { dg-warning "(positional|near initialization)" } */
+};