hdf5/.clang-format

---
Language:        Cpp
BasedOnStyle:  LLVM
AlignConsecutiveAssignments: true
#llvm11: AlignConsecutiveBitFields: false
AlignConsecutiveDeclarations: true
AlignConsecutiveMacros: true
#llvm10-11: AlignOperands:   true - Align
#llvm11: AllowShortEnumsOnASingleLine: 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
  #llvm10-11: AfterControlStatement: false - Never
  BeforeCatch:     true
  BeforeElse:      true
  #llvm11:   BeforeLambdaBody: false
  #llvm11:   BeforeWhile:     false
BreakBeforeBraces: Stroustrup
BreakAfterJavaFieldAnnotations: true
BreakStringLiterals: true
ColumnLimit:     110    # Update $max_trace_macro_line_len in bin/trace also
IncludeCategories:
  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
    Priority:        3
    SortPriority:    0
  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
    Priority:        4
    SortPriority:    0
  - Regex:           '.*'
    Priority:        0
    SortPriority:    0
  - Regex:           '^H5*.*'
    Priority:        1
    SortPriority:    0
  - Regex:           'private.*'
    Priority:        2
    SortPriority:    0
IncludeIsMainRegex: '(public)?$'
IndentCaseLabels: true
#llvm11: IndentCaseBlocks: false
IndentGotoLabels: false
#llvm11: IndentExternBlock: AfterExternBlock
IndentWidth:     4
#llvm11: InsertTrailingCommas: None
MacroBlockBegin: "^BEGIN_FUNC"
MacroBlockEnd: "^END_FUNC"
ObjCBlockIndentWidth: 4
#llvm11: ObjCBreakBeforeNestedBlockParam: true
ReflowComments:  true
SortIncludes:    false
StatementMacros:
  - FUNC_ENTER_API
  - FUNC_LEAVE_API
  - FUNC_ENTER_NOAPI_NOINIT_NOERR
  - FUNC_LEAVE_NOAPI
  - H5_BEGIN_TAG
  - HGOTO_DONE_TAG
  - H5_END_TAG
  - HSYS_DONE_ERROR
  - HSYS_GOTO_ERROR
  - HDONE_ERROR
  - HERROR
  - H5_LEAVE
  - H5E_PRINTF
  - H5E_THROW
  - HGOTO_DONE
  - HGOTO_ERROR
  - HMPI_ERROR
  - HMPI_DONE_ERROR
  - HMPI_GOTO_ERROR
  - H5_GCC_DIAG_OFF
  - H5_GCC_DIAG_ON
  - CATCH
#llvm10: TypenameMacros:
#llvm10:   - STACK_OF
#llvm10:   - LIST
#llvm11: WhitespaceSensitiveMacros:
#llvm11:   - STRINGIZE
#llvm11:   - PP_STRINGIZE
...
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`---`
			`Language: Cpp`
Change to based on LLVM format 2020-09-25 01:35:54 +08:00			`BasedOnStyle: LLVM`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`AlignConsecutiveAssignments: true`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: AlignConsecutiveBitFields: false`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`AlignConsecutiveDeclarations: true`
Primary change is HDFFV-11212 - new refs and JNI (#372) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes * Update format plugin * Undo clang-format version 11 changes * One more correction * Update supported platforms * Revert whitespace changes * Correct whitespace * Changes from PR#3 * HDFFV-11213 added option to control gcc10 warnings diagnostics * HDFFV-11212 Use the new references correctly in JNI utility and tests * format source * Fix typo * Add new test file * HDFFV-11212 - update test and remove unused arg * Minor non-space formatting changes * Use H5I_INVALID_ID instead of "-1" * source formatting * add missing testfile, update jni function * Undo commit of debug code * remove mislocated file * Fix h5repack test for handling of fapls and id close * Update h5diff test files usage text * HDFFV-11212 add new ref tests for JNI export dataset * src format update * Remove blank line typo * src format typo * long double requires %Lg * Another long double foramt specifer S.B. %Lg * issue with t128bit test * Windows issue with h5dump and type. * Fix review issues * refactor function nesting and fix error checks * format fixes * Remove untested functions and javadoc quiet comments * Restore TRY block. * Change string append errors to memory exception * revert to H5_JNI_FATAL_ERROR - support functions need work * Add assertion error for h5util functions * remove duplicate function * format fix * Revert HD function error handling * Update copyright comments 2021-02-26 05:12:57 +08:00			`AlignConsecutiveMacros: true`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm10-11: AlignOperands: true - Align`
			`#llvm11: AllowShortEnumsOnASingleLine: true`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`AlwaysBreakAfterReturnType: AllDefinitions`
Update reformatting settings, trace wrapping, and printf-format strings (#22) * Add BEGIN_FUNC / CATCH / END_FUNC to macros * Remove incorrect trailing '{' * Update trace script to wrap H5TRACE macros at 110 characters and improve comments for code that performs this operation. * Clean up printf-formatting in H5public.h and correct some oversights in the code. * Reformat with BEGIN_FUNC / END_FUNC handled correctly by clang-format * Run clang-format on changes. * Correct H5_SIZEOF_HSIZE_T/H5_SIZEOF_HSSIZE_T macros to match typedef. * And make the undef value match also. * Update comment * Update clang-format actions to exclude generated files. * Post-process generated H5LTparse.h file as well as H5LTparse.c file. * Fix formatting * Update version of github clang-format action 2020-10-07 06:37:42 +08:00			`# 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`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`BraceWrapping:`
			`AfterFunction: true`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm10-11: AfterControlStatement: false - Never`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`BeforeCatch: true`
			`BeforeElse: true`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: BeforeLambdaBody: false`
			`#llvm11: BeforeWhile: false`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`BreakBeforeBraces: Stroustrup`
			`BreakAfterJavaFieldAnnotations: true`
			`BreakStringLiterals: true`
Update reformatting settings, trace wrapping, and printf-format strings (#22) * Add BEGIN_FUNC / CATCH / END_FUNC to macros * Remove incorrect trailing '{' * Update trace script to wrap H5TRACE macros at 110 characters and improve comments for code that performs this operation. * Clean up printf-formatting in H5public.h and correct some oversights in the code. * Reformat with BEGIN_FUNC / END_FUNC handled correctly by clang-format * Run clang-format on changes. * Correct H5_SIZEOF_HSIZE_T/H5_SIZEOF_HSSIZE_T macros to match typedef. * And make the undef value match also. * Update comment * Update clang-format actions to exclude generated files. * Post-process generated H5LTparse.h file as well as H5LTparse.c file. * Fix formatting * Update version of github clang-format action 2020-10-07 06:37:42 +08:00			`ColumnLimit: 110 # Update $max_trace_macro_line_len in bin/trace also`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`IncludeCategories:`
			`- Regex: '^"(llvm\|llvm-c\|clang\|clang-c)/'`
			`Priority: 3`
			`SortPriority: 0`
			`- Regex: '^(<\|"(gtest\|gmock\|isl\|json)/)'`
			`Priority: 4`
			`SortPriority: 0`
			`- Regex: '.*'`
			`Priority: 0`
			`SortPriority: 0`
			`- Regex: '^H5.'`
			`Priority: 1`
			`SortPriority: 0`
			`- Regex: 'private.*'`
			`Priority: 2`
			`SortPriority: 0`
			`IncludeIsMainRegex: '(public)?$'`
			`IndentCaseLabels: true`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: IndentCaseBlocks: false`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`IndentGotoLabels: false`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: IndentExternBlock: AfterExternBlock`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`IndentWidth: 4`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: InsertTrailingCommas: None`
Update reformatting settings, trace wrapping, and printf-format strings (#22) * Add BEGIN_FUNC / CATCH / END_FUNC to macros * Remove incorrect trailing '{' * Update trace script to wrap H5TRACE macros at 110 characters and improve comments for code that performs this operation. * Clean up printf-formatting in H5public.h and correct some oversights in the code. * Reformat with BEGIN_FUNC / END_FUNC handled correctly by clang-format * Run clang-format on changes. * Correct H5_SIZEOF_HSIZE_T/H5_SIZEOF_HSSIZE_T macros to match typedef. * And make the undef value match also. * Update comment * Update clang-format actions to exclude generated files. * Post-process generated H5LTparse.h file as well as H5LTparse.c file. * Fix formatting * Update version of github clang-format action 2020-10-07 06:37:42 +08:00			`MacroBlockBegin: "^BEGIN_FUNC"`
			`MacroBlockEnd: "^END_FUNC"`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`ObjCBlockIndentWidth: 4`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm11: ObjCBreakBeforeNestedBlockParam: true`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`ReflowComments: true`
			`SortIncludes: false`
			`StatementMacros:`
			`- FUNC_ENTER_API`
			`- FUNC_LEAVE_API`
			`- FUNC_ENTER_NOAPI_NOINIT_NOERR`
			`- FUNC_LEAVE_NOAPI`
			`- H5_BEGIN_TAG`
			`- HGOTO_DONE_TAG`
			`- H5_END_TAG`
			`- HSYS_DONE_ERROR`
			`- HSYS_GOTO_ERROR`
			`- HDONE_ERROR`
			`- HERROR`
			`- H5_LEAVE`
			`- H5E_PRINTF`
			`- H5E_THROW`
			`- HGOTO_DONE`
			`- HGOTO_ERROR`
			`- HMPI_ERROR`
			`- HMPI_DONE_ERROR`
			`- HMPI_GOTO_ERROR`
			`- H5_GCC_DIAG_OFF`
			`- H5_GCC_DIAG_ON`
Update reformatting settings, trace wrapping, and printf-format strings (#22) * Add BEGIN_FUNC / CATCH / END_FUNC to macros * Remove incorrect trailing '{' * Update trace script to wrap H5TRACE macros at 110 characters and improve comments for code that performs this operation. * Clean up printf-formatting in H5public.h and correct some oversights in the code. * Reformat with BEGIN_FUNC / END_FUNC handled correctly by clang-format * Run clang-format on changes. * Correct H5_SIZEOF_HSIZE_T/H5_SIZEOF_HSSIZE_T macros to match typedef. * And make the undef value match also. * Update comment * Update clang-format actions to exclude generated files. * Post-process generated H5LTparse.h file as well as H5LTparse.c file. * Fix formatting * Update version of github clang-format action 2020-10-07 06:37:42 +08:00			`- CATCH`
develop clang-format comments (#286) * OESS-98 convert plugin option to FetchContent, add tests * Fixes for pkcfg files because of plugin option * OESS-98 fix tools test for plugins * Keep doxygen comments under 100 chars long - format hint * Whitespace * HDFFV-11144 - Reclassify CMake messages * HDFFV-11099/11100 added help text * Reworked switch statement to compare string instead * Fix typo * Update CDash mode * Correct name of threadsafe * Correct option name * Undo accidental commit * Note LLVM 10 to 11 format default changes 2021-01-28 07:51:59 +08:00			`#llvm10: TypenameMacros:`
			`#llvm10: - STACK_OF`
			`#llvm10: - LIST`
			`#llvm11: WhitespaceSensitiveMacros:`
			`#llvm11: - STRINGIZE`
			`#llvm11: - PP_STRINGIZE`
CMake and script changes for clang-format 2020-09-05 05:36:52 +08:00			`...`