Bug#26036912 COMPONENT MACRO DO CONFUSE CODE FORMATTERS

Before this fix, all code involving macros used
to define or implement components and services
is extremely poorly formatted by clang-format.

The root cause is that the macro themselves are
very opaque, and obfuscate completely the code structure,
so that clang-format can not even find basic expressions
or statements while just reading the calling code.

The fix is as follows.

When a macro generates a list item, ending by a column:
- remove the column from the macro
- require the calling code to explicitly add the column

When a macro generates a statement, ending by a semicolumn:
- remove the semicolumn from the macro
- require the calling code to explicitly add the semicolumn

With this change, code formatted by clang-format,
while not beeing perfect, is at least workable.

Details of the change:
- END_DECLARE_COMPONENT() is now followed by ';'
- PROVIDES_SERVICE() is now followed by ','
- END_COMPONENT_PROVIDES() is now followed by ';'
- REQUIRES_SERVICE() is now followed by ','
- END_COMPONENT_REQUIRES() is now followed by ';'
- METADATA() is now followed by ','
- END_COMPONENT_METADATA() is now followed by ';'
- END_SERVICE_IMPLEMENTATION() is now followed by ';'

Author: marcalff

components/example/example_component1.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
@@ -50,38 +50,34 @@ mysql_service_status_t example_deinit() { return 0; }
 
 /* This component provides an implementation for all example Services. */
 BEGIN_SERVICE_IMPLEMENTATION(example_component1, greetings)
-english_greeting_service_imp::say_hello,
-    END_SERVICE_IMPLEMENTATION()
-
-        BEGIN_SERVICE_IMPLEMENTATION(example_component1, greetings_localization)
-            english_greeting_service_imp::get_language,
-    END_SERVICE_IMPLEMENTATION()
-
-        BEGIN_SERVICE_IMPLEMENTATION(example_component1, example_math)
-            simple_example_math_imp::calculate_gcd,
-    END_SERVICE_IMPLEMENTATION()
-
-        BEGIN_COMPONENT_PROVIDES(example_component1)
-            PROVIDES_SERVICE(example_component1, greetings)
-                PROVIDES_SERVICE(example_component1, greetings_localization)
-                    PROVIDES_SERVICE(example_component1, example_math)
-                        END_COMPONENT_PROVIDES()
-
-    /* An empty list of dependencies. */
-    BEGIN_COMPONENT_REQUIRES(example_component1) END_COMPONENT_REQUIRES()
-
-    /* A list of metadata to describe the Component. */
-    BEGIN_COMPONENT_METADATA(example_component1)
-        METADATA("mysql.author", "Oracle Corporation")
-            METADATA("mysql.license", "GPL") METADATA("test_property", "1")
-                END_COMPONENT_METADATA()
-
-    /* Declaration of the Component. */
-    DECLARE_COMPONENT(example_component1,
-                      "mysql:example_component1") example_init,
-    example_deinit END_DECLARE_COMPONENT()
-
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component1)
-        END_DECLARE_LIBRARY_COMPONENTS
+english_greeting_service_imp::say_hello, END_SERVICE_IMPLEMENTATION();
+
+BEGIN_SERVICE_IMPLEMENTATION(example_component1, greetings_localization)
+english_greeting_service_imp::get_language, END_SERVICE_IMPLEMENTATION();
+
+BEGIN_SERVICE_IMPLEMENTATION(example_component1, example_math)
+simple_example_math_imp::calculate_gcd, END_SERVICE_IMPLEMENTATION();
+
+BEGIN_COMPONENT_PROVIDES(example_component1)
+PROVIDES_SERVICE(example_component1, greetings),
+    PROVIDES_SERVICE(example_component1, greetings_localization),
+    PROVIDES_SERVICE(example_component1, example_math),
+    END_COMPONENT_PROVIDES();
+
+/* An empty list of dependencies. */
+BEGIN_COMPONENT_REQUIRES(example_component1) END_COMPONENT_REQUIRES();
+
+/* A list of metadata to describe the Component. */
+BEGIN_COMPONENT_METADATA(example_component1)
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"), METADATA("test_property", "1"),
+    END_COMPONENT_METADATA();
+
+/* Declaration of the Component. */
+DECLARE_COMPONENT(example_component1, "mysql:example_component1")
+example_init, example_deinit END_DECLARE_COMPONENT();
+
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component1)
+    END_DECLARE_LIBRARY_COMPONENTS

components/example/example_component2.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
@@ -32,34 +32,32 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
   Services. */
 
 BEGIN_SERVICE_IMPLEMENTATION(example_component2, greetings)
-polish_greeting_service_imp::say_hello,
-    END_SERVICE_IMPLEMENTATION()
-
-        BEGIN_SERVICE_IMPLEMENTATION(example_component2, greetings_localization)
-            polish_greeting_service_imp::get_language,
-    END_SERVICE_IMPLEMENTATION()
-
-        BEGIN_COMPONENT_PROVIDES(example_component2)
-            PROVIDES_SERVICE(example_component2, greetings)
-                PROVIDES_SERVICE(example_component2, greetings_localization)
-                    END_COMPONENT_PROVIDES()
-
-    /* An empty list of dependencies. */
-    BEGIN_COMPONENT_REQUIRES(example_component2) END_COMPONENT_REQUIRES()
-
-    /* A list of metadata to describe the Component. */
-    BEGIN_COMPONENT_METADATA(example_component2)
-        METADATA("mysql.author", "Oracle Corporation")
-            METADATA("mysql.license", "GPL") METADATA("test_property", "2")
-                END_COMPONENT_METADATA()
-
-    /* Declaration of the Component, this is the case when we don't need
-      initialization/de-initialization methods, so we are fine to just use NULL
-      values here. */
-    DECLARE_COMPONENT(example_component2, "mysql:example_component2") NULL,
-    NULL END_DECLARE_COMPONENT()
-
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component2)
-        END_DECLARE_LIBRARY_COMPONENTS
+polish_greeting_service_imp::say_hello, END_SERVICE_IMPLEMENTATION();
+
+BEGIN_SERVICE_IMPLEMENTATION(example_component2, greetings_localization)
+polish_greeting_service_imp::get_language, END_SERVICE_IMPLEMENTATION();
+
+BEGIN_COMPONENT_PROVIDES(example_component2)
+PROVIDES_SERVICE(example_component2, greetings),
+    PROVIDES_SERVICE(example_component2, greetings_localization),
+    END_COMPONENT_PROVIDES();
+
+/* An empty list of dependencies. */
+BEGIN_COMPONENT_REQUIRES(example_component2) END_COMPONENT_REQUIRES();
+
+/* A list of metadata to describe the Component. */
+BEGIN_COMPONENT_METADATA(example_component2)
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"), METADATA("test_property", "2"),
+    END_COMPONENT_METADATA();
+
+/* Declaration of the Component, this is the case when we don't need
+  initialization/de-initialization methods, so we are fine to just use NULL
+  values here. */
+DECLARE_COMPONENT(example_component2, "mysql:example_component2")
+NULL, NULL END_DECLARE_COMPONENT();
+
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component2)
+    END_DECLARE_LIBRARY_COMPONENTS

components/example/example_component3.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
@@ -32,39 +32,35 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
 /* This component provides an implementation for 'example_math' Service only. */
 BEGIN_SERVICE_IMPLEMENTATION(example_component3, example_math)
-example_math_wrapping_imp::calculate_gcd,
-    END_SERVICE_IMPLEMENTATION()
+example_math_wrapping_imp::calculate_gcd, END_SERVICE_IMPLEMENTATION();
 
-        BEGIN_COMPONENT_PROVIDES(example_component3)
-            PROVIDES_SERVICE(example_component3, example_math)
-                END_COMPONENT_PROVIDES()
+BEGIN_COMPONENT_PROVIDES(example_component3)
+PROVIDES_SERVICE(example_component3, example_math), END_COMPONENT_PROVIDES();
 
-    /* A block for specifying dependencies of this Component. Note that for each
-      dependency we need to have a placeholder, a extern to placeholder in
-      header file of the Component, and an entry on requires list below. */
-    REQUIRES_SERVICE_PLACEHOLDER(greetings);
+/* A block for specifying dependencies of this Component. Note that for each
+  dependency we need to have a placeholder, a extern to placeholder in
+  header file of the Component, and an entry on requires list below. */
+REQUIRES_SERVICE_PLACEHOLDER(greetings);
 REQUIRES_SERVICE_PLACEHOLDER(greetings_localization);
 
 /* A list of dependencies. */
 BEGIN_COMPONENT_REQUIRES(example_component3)
-REQUIRES_SERVICE(greetings)
-REQUIRES_SERVICE(greetings_localization)
-END_COMPONENT_REQUIRES()
+REQUIRES_SERVICE(greetings), REQUIRES_SERVICE(greetings_localization),
+    END_COMPONENT_REQUIRES();
 
 /* A list of metadata to describe the Component. */
 BEGIN_COMPONENT_METADATA(example_component3)
-METADATA("mysql.author", "Oracle Corporation")
-METADATA("mysql.license", "GPL")
-METADATA("test_property", "3")
-END_COMPONENT_METADATA()
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"), METADATA("test_property", "3"),
+    END_COMPONENT_METADATA();
 
 /* Declaration of the Component, this is the case when we don't need
   initialization/de-initialization methods, so we are fine to just use NULL
   values here. */
 DECLARE_COMPONENT(example_component3, "mysql:example_component3")
-NULL, NULL END_DECLARE_COMPONENT()
+NULL, NULL END_DECLARE_COMPONENT();
 
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component3)
-        END_DECLARE_LIBRARY_COMPONENTS
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(example_component3)
+    END_DECLARE_LIBRARY_COMPONENTS

components/example/test_backup_lock_service.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License, version 2.0,
@@ -56,28 +56,26 @@ mysql_service_status_t test_backup_lock_service_deinit() {
 
 /* An empty list as no service is provided. */
 BEGIN_COMPONENT_PROVIDES(test_backup_lock_service)
-END_COMPONENT_PROVIDES()
+END_COMPONENT_PROVIDES();
 
 REQUIRES_SERVICE_PLACEHOLDER(mysql_backup_lock);
 
 /* A list of required services. */
 BEGIN_COMPONENT_REQUIRES(test_backup_lock_service)
-REQUIRES_SERVICE(mysql_backup_lock)
-END_COMPONENT_REQUIRES()
+REQUIRES_SERVICE(mysql_backup_lock), END_COMPONENT_REQUIRES();
 
 /* A list of metadata to describe the Component. */
 BEGIN_COMPONENT_METADATA(test_backup_lock_service)
-METADATA("mysql.author", "Oracle Corporation")
-METADATA("mysql.license", "GPL")
-METADATA("test_backup_lock_service", "1")
-END_COMPONENT_METADATA()
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"), METADATA("test_backup_lock_service", "1"),
+    END_COMPONENT_METADATA();
 
 /* Declaration of the Component. */
 DECLARE_COMPONENT(test_backup_lock_service, "mysql:test_backup_lock_service")
 test_backup_lock_service_init,
-    test_backup_lock_service_deinit END_DECLARE_COMPONENT()
+    test_backup_lock_service_deinit END_DECLARE_COMPONENT();
 
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_backup_lock_service)
-        END_DECLARE_LIBRARY_COMPONENTS
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_backup_lock_service)
+    END_DECLARE_LIBRARY_COMPONENTS

components/example/test_string_service.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
@@ -313,7 +313,7 @@ mysql_service_status_t test_string_service_deinit() { return false; }
 
 /* An empty list as no service is provided. */
 BEGIN_COMPONENT_PROVIDES(test_string_service)
-END_COMPONENT_PROVIDES()
+END_COMPONENT_PROVIDES();
 
 REQUIRES_SERVICE_PLACEHOLDER(mysql_string_factory);
 REQUIRES_SERVICE_PLACEHOLDER(mysql_string_converter);
@@ -325,27 +325,25 @@ REQUIRES_SERVICE_PLACEHOLDER(mysql_string_ctype);
 
 /* A list of required services. */
 BEGIN_COMPONENT_REQUIRES(test_string_service)
-REQUIRES_SERVICE(mysql_string_factory)
-REQUIRES_SERVICE(mysql_string_converter)
-REQUIRES_SERVICE(mysql_string_character_access)
-REQUIRES_SERVICE(mysql_string_byte_access)
-REQUIRES_SERVICE(mysql_string_case)
-REQUIRES_SERVICE(mysql_string_iterator)
-REQUIRES_SERVICE(mysql_string_ctype)
-END_COMPONENT_REQUIRES()
+REQUIRES_SERVICE(mysql_string_factory),
+    REQUIRES_SERVICE(mysql_string_converter),
+    REQUIRES_SERVICE(mysql_string_character_access),
+    REQUIRES_SERVICE(mysql_string_byte_access),
+    REQUIRES_SERVICE(mysql_string_case),
+    REQUIRES_SERVICE(mysql_string_iterator),
+    REQUIRES_SERVICE(mysql_string_ctype), END_COMPONENT_REQUIRES();
 
 /* A list of metadata to describe the Component. */
 BEGIN_COMPONENT_METADATA(test_string_service)
-METADATA("mysql.author", "Oracle Corporation")
-METADATA("mysql.license", "GPL")
-METADATA("test_string_service", "1")
-END_COMPONENT_METADATA()
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"), METADATA("test_string_service", "1"),
+    END_COMPONENT_METADATA();
 
 /* Declaration of the Component. */
 DECLARE_COMPONENT(test_string_service, "mysql:test_string_service")
-test_string_service_init, test_string_service_deinit END_DECLARE_COMPONENT()
+test_string_service_init, test_string_service_deinit END_DECLARE_COMPONENT();
 
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_string_service)
-        END_DECLARE_LIBRARY_COMPONENTS
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_string_service)
+    END_DECLARE_LIBRARY_COMPONENTS

components/example/test_string_service_charset.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License, version 2.0,
@@ -196,7 +196,7 @@ mysql_service_status_t test_string_service_deinit() { return false; }
 
 /* An empty list as no service is provided. */
 BEGIN_COMPONENT_PROVIDES(test_string_service_charset)
-END_COMPONENT_PROVIDES()
+END_COMPONENT_PROVIDES();
 
 REQUIRES_SERVICE_PLACEHOLDER(mysql_string_factory);
 REQUIRES_SERVICE_PLACEHOLDER(mysql_string_converter);
@@ -208,28 +208,26 @@ REQUIRES_SERVICE_PLACEHOLDER(mysql_string_ctype);
 
 /* A list of required services. */
 BEGIN_COMPONENT_REQUIRES(test_string_service_charset)
-REQUIRES_SERVICE(mysql_string_factory)
-REQUIRES_SERVICE(mysql_string_converter)
-REQUIRES_SERVICE(mysql_string_character_access)
-REQUIRES_SERVICE(mysql_string_byte_access)
-REQUIRES_SERVICE(mysql_string_case)
-REQUIRES_SERVICE(mysql_string_iterator)
-REQUIRES_SERVICE(mysql_string_ctype)
-END_COMPONENT_REQUIRES()
+REQUIRES_SERVICE(mysql_string_factory),
+    REQUIRES_SERVICE(mysql_string_converter),
+    REQUIRES_SERVICE(mysql_string_character_access),
+    REQUIRES_SERVICE(mysql_string_byte_access),
+    REQUIRES_SERVICE(mysql_string_case),
+    REQUIRES_SERVICE(mysql_string_iterator),
+    REQUIRES_SERVICE(mysql_string_ctype), END_COMPONENT_REQUIRES();
 
 /* A list of metadata to describe the Component. */
 BEGIN_COMPONENT_METADATA(test_string_service_charset)
-METADATA("mysql.author", "Oracle Corporation")
-METADATA("mysql.license", "GPL")
-METADATA("test_string_charset_service", "1")
-END_COMPONENT_METADATA()
+METADATA("mysql.author", "Oracle Corporation"),
+    METADATA("mysql.license", "GPL"),
+    METADATA("test_string_charset_service", "1"), END_COMPONENT_METADATA();
 
 /* Declaration of the Component. */
 DECLARE_COMPONENT(test_string_service_charset,
                   "mysql:test_string_service_charset")
-test_string_service_init, test_string_service_deinit END_DECLARE_COMPONENT()
+test_string_service_init, test_string_service_deinit END_DECLARE_COMPONENT();
 
-    /* Defines list of Components contained in this library. Note that for now
-      we assume that library will have exactly one Component. */
-    DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_string_service_charset)
-        END_DECLARE_LIBRARY_COMPONENTS
+/* Defines list of Components contained in this library. Note that for now
+  we assume that library will have exactly one Component. */
+DECLARE_LIBRARY_COMPONENTS &COMPONENT_REF(test_string_service_charset)
+    END_DECLARE_LIBRARY_COMPONENTS