Update reformatting settings, trace wrapping, and printf-format strings

.clang-format

@@ -5,14 +5,27 @@ AlignConsecutiveMacros: true
 AlignConsecutiveAssignments: true
 AlignConsecutiveDeclarations: true
 AlwaysBreakAfterReturnType: AllDefinitions
+# Can enable the following section when llvm 12.x is out
+#AttributeMacros:
+#  - H5_ATTR_FORMAT
+#  - H5_ATTR_UNUSED
+#  - H5_ATTR_DEPRECATED_USED
+#  - H5_ATTR_NDEBUG_UNUSED
+#  - H5_ATTR_DEBUG_API_USED
+#  - H5_ATTR_PARALLEL_UNUSED
+#  - H5_ATTR_PARALLEL_USED
+#  - H5_ATTR_NORETURN
+#  - H5_ATTR_CONST
+#  - H5_ATTR_PURE
+#  - H5_ATTR_FALLTHROUGH
 BraceWrapping:
   AfterFunction:   true
   BeforeCatch:     true
   BeforeElse:      true
 BreakBeforeBraces: Stroustrup
 BreakAfterJavaFieldAnnotations: true
 BreakStringLiterals: true
-ColumnLimit:     110
+ColumnLimit:     110    # Update $max_trace_macro_line_len in bin/trace also
 IncludeCategories:
   - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
     Priority:        3
@@ -33,6 +46,8 @@ IncludeIsMainRegex: '(public)?$'
 IndentCaseLabels: true
 IndentGotoLabels: false
 IndentWidth:     4
+MacroBlockBegin: "^BEGIN_FUNC"
+MacroBlockEnd: "^END_FUNC"
 ObjCBlockIndentWidth: 4
 ReflowComments:  true
 SortIncludes:    false
@@ -58,5 +73,6 @@ StatementMacros:
   - HMPI_GOTO_ERROR
   - H5_GCC_DIAG_OFF
   - H5_GCC_DIAG_ON
+  - CATCH
 ...
 

bin/trace

@@ -210,6 +210,14 @@ $Source = "";
                "ssize_t"                    => "Zs",
               );
 
+
+##############################################################################
+# Maximum length of H5TRACE macro line
+# If the ColumnLimit in .clang-format is changed, this value will need to be updated
+#
+my $max_trace_macro_line_len = 110;
+
+
 ##############################################################################
 # Print an error message.
 #
@@ -287,7 +295,7 @@ sub rewrite_func ($$$$$) {
 
   # Parse arguments
   if ($args eq "void") {
-    $trace = "H5TRACE0(\"$rettype\",\"\");\n";
+    $trace = "H5TRACE0(\"$rettype\", \"\");\n";
   } else {
     # Split arguments.  First convert `/*in,out*/' to get rid of the
     # comma, then split the arguments on commas.
@@ -331,18 +339,34 @@ sub rewrite_func ($$$$$) {
         }
       }
     }
+
+    # Compose the trace macro
     $trace = "H5TRACE" . scalar(@arg_str) . "(\"$rettype\", \"";
     $trace .= join("", @arg_str) . "\"";
-    my $len = 4 + length $trace;
+    my $len = 4 + length $trace;        # Add 4, for indenting the line
     for (@arg_name) {
-      if ($len + length >= 77) {
-        $trace .= ",\n             $_";
-        $len = 13 + length;
+      # Wrap lines that will be longer than the limit, after ');' is added
+      if ($len + length >= ($max_trace_macro_line_len - 2)) {
+        # Wrap line, with indention
+        $trace .= ",\n             ";
+        $len = 13;              # Set to 13, for indention
+
+        # Indent an extra space to account for extra digit in 'H5TRACE' macro
+        if (scalar(@arg_str) >= 10) {
+          $trace .= " ";
+          $len++;
+        }
       } else {
-        $trace .= ", $_";
-        $len += 1 + length;
+        $trace .= ", ";
+        $len += 2;     # Add 2, for ', '
       }
+
+      # Append argument
+      $trace .= "$_";
+      $len += length;     # Add 2, for ', '
     }
+
+    # Append final ');' for macro
     $trace .= ");\n";
   }
   goto error if grep {/!/} @arg_str;

hl/src/H5LTanalyze.c

@@ -2413,11 +2413,7 @@ yy_scan_buffer(char *base, yy_size_t size)
  *       yy_scan_bytes() instead.
  */
 YY_BUFFER_STATE
-yy_scan_string(const char *yystr)
-{
-
-    return yy_scan_bytes(yystr, (int)strlen(yystr));
-}
+yy_scan_string(const char *yystr) { return yy_scan_bytes(yystr, (int)strlen(yystr)); }
 
 /** Setup the input buffer state to scan the given bytes. The next call to yylex() will
  * scan from a @e copy of @a bytes.