Merge remote-tracking branch 'origin/topic/timw/spicy-reformat'

* origin/topic/timw/spicy-reformat: Update .git-blame-ignore-revs Reformat Bifcl in Spicy style
zeek · Nov 6, 2023 · cfbd7e9 · cfbd7e9
2 parents c7bf54c + db8de10
commit cfbd7e9
Show file tree

Hide file tree

Showing 9 changed files with 301 additions and 254 deletions.
diff --git a/.clang-format b/.clang-format
@@ -1,74 +1,66 @@
-# Clang-format configuration for Zeek. This configuration requires
-# at least clang-format 12.0.1 to format correctly.
-
-Language: Cpp
-Standard: c++17
-
-BreakBeforeBraces: Whitesmiths
-
-# BraceWrapping:
-#   AfterCaseLabel: true
-#   AfterClass: false
-#   AfterControlStatement: Always
-#   AfterEnum: false
-#   AfterFunction: true
-#   AfterNamespace: false
-#   AfterStruct: false
-#   AfterUnion: false
-#   AfterExternBlock: false
-#   BeforeCatch: true
-#   BeforeElse: true
-#   BeforeWhile: false
-#   IndentBraces: true
-#   SplitEmptyFunction: false
-#   SplitEmptyRecord: false
-#   SplitEmptyNamespace: false
+# Copyright (c) 2020-2023 by the Zeek Project. See LICENSE for details.
 
+---
+Language:        Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: Align
-AlignTrailingComments: false
-AllowShortBlocksOnASingleLine: Empty
-AllowShortEnumsOnASingleLine: true
-AllowShortFunctionsOnASingleLine: Inline
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: true
 AllowShortIfStatementsOnASingleLine: false
-AllowShortLambdasOnASingleLine: Empty
 AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
 BinPackArguments: true
 BinPackParameters: true
-BreakConstructorInitializers: BeforeColon
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      true
+  IndentBraces:    false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
 BreakInheritanceList: BeforeColon
-ColumnLimit: 100
-ConstructorInitializerAllOnOneLineOrOnePerLine: false
-FixNamespaceComments: false
-IndentCaseLabels: true
-IndentCaseBlocks: false
-IndentExternBlock: NoIndent
-IndentPPDirectives: None
-IndentWidth: 4
-NamespaceIndentation: None
-PointerAlignment: Left
-SpaceAfterCStyleCast: false
-SpaceAfterLogicalNot: true
-SpaceBeforeAssignmentOperators: true
-SpaceBeforeCpp11BracedList: false
-SpaceBeforeCtorInitializerColon: true
-SpaceBeforeInheritanceColon: true
-SpaceBeforeParens: ControlStatements
-SpaceBeforeRangeBasedForLoopColon: true
-SpaceInEmptyBlock: true
-SpaceInEmptyParentheses: false
-SpacesInAngles: false
-SpacesInConditionalStatement: true
-SpacesInContainerLiterals: false
-SpacesInParentheses: false
-TabWidth: 4
-UseTab: AlignWithSpaces
-
-# Setting this to a high number causes clang-format to prefer breaking somewhere else
-# over breaking after the assignment operator in a line that's over the column limit
-PenaltyBreakAssignment: 100
-
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  'NOLINT'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
 IncludeBlocks: Regroup
 
 # Include categories go like this:
@@ -98,3 +90,57 @@ IncludeCategories:
     Priority: 4
   - Regex: '.*'
     Priority: 5
+
+IncludeIsMainRegex: '$'
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: '^BEGIN_'
+MacroBlockEnd:   '^END_'
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 500
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 1000
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: false
+SpaceAfterLogicalNot: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpacesInConditionalStatement: true
+Standard:        Cpp11
+StatementMacros:
+  - STANDARD_OPERATOR_1
+TabWidth:        4
+UseTab:          Never
+---
+Language: Json
+...
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# clang-format: Reformat Bifcl in Spicy style
+1c92e23be51ffb2d66e3a1a37d2930c3fb17844f
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,17 +3,33 @@
 #
 repos:
 - repo: https://github.com/pre-commit/mirrors-clang-format
-  rev: 'v13.0.0'
+  rev: 'v17.0.3'
   hooks:
   - id: clang-format
+    types_or:
+      - "c"
+      - "c++"
+      - "json"
 
 - repo: https://github.com/maxwinterstein/shfmt-py
-  rev: 3.3.1.8
+  rev: v3.7.0.1
   hooks:
     - id: shfmt
       args: ["-w", "-i", "4", "-ci"]
 
-- repo: https://github.com/pre-commit/mirrors-yapf
-  rev: v0.31.0
+- repo: https://github.com/google/yapf
+  rev: v0.40.2
   hooks:
   - id: yapf
+
+- repo: https://github.com/cheshirekow/cmake-format-precommit
+  rev: v0.6.13
+  hooks:
+  - id: cmake-format
+    exclude: '^auxil/.*$'
+
+- repo: https://github.com/crate-ci/typos
+  rev: v1.16.21
+  hooks:
+    - id: typos
+      exclude: '^(.typos.toml|src/SmithWaterman.cc|testing/.*|auxil/.*|scripts/base/frameworks/files/magic/.*|CHANGES)$'
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,9 @@
+1.8.0-14 | 2023-11-06 13:32:55 -0700
+
+  * Update .git-blame-ignore-revs (Tim Wojtulewicz, Corelight)
+
+  * Reformat Bifcl in Spicy style (Tim Wojtulewicz, Corelight)
+
 1.8.0-11 | 2023-08-03 09:36:59 -0700
 
   * Remove usage of FindRequiredPackage (Tim Wojtulewicz, Corelight)

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,73 +6,74 @@ include(cmake/CommonCMakeConfig.cmake)
 find_package(BISON REQUIRED)
 find_package(FLEX REQUIRED)
 
-if (MSVC)
+if(MSVC)
   add_compile_options(/J) # Similar to -funsigned-char on other platforms
-  set_property(SOURCE bif_lex.cc APPEND_STRING PROPERTY COMPILE_FLAGS "/wd4018")
+  set_property(
+    SOURCE bif_lex.cc
+    APPEND_STRING
+    PROPERTY COMPILE_FLAGS "/wd4018")
 else()
-  set_property(SOURCE bif_lex.cc APPEND_STRING PROPERTY COMPILE_FLAGS "-Wno-sign-compare")
+  set_property(
+    SOURCE bif_lex.cc
+    APPEND_STRING
+    PROPERTY COMPILE_FLAGS "-Wno-sign-compare")
 endif()
 
-include_directories(BEFORE
-                    ${BifCl_SOURCE_DIR}/include
-                    ${BifCl_BINARY_DIR}
-)
+include_directories(BEFORE ${BifCl_SOURCE_DIR}/include ${BifCl_BINARY_DIR})
 
 set(BISON_FLAGS "--debug")
 
 # BIF parser/scanner
-bison_target(BIFParser builtin-func.y
-             ${BifCl_BINARY_DIR}/bif_parse.cc
-             DEFINES_FILE ${BifCl_BINARY_DIR}/bif_parse.h
-             COMPILE_FLAGS "${BISON_FLAGS}")
+bison_target(
+  BIFParser builtin-func.y ${BifCl_BINARY_DIR}/bif_parse.cc
+  DEFINES_FILE ${BifCl_BINARY_DIR}/bif_parse.h
+  COMPILE_FLAGS "${BISON_FLAGS}")
 flex_target(BIFScanner builtin-func.l ${BifCl_BINARY_DIR}/bif_lex.cc)
 add_flex_bison_dependency(BIFScanner BIFParser)
 
 set(bifcl_SRCS
-   ${BISON_BIFParser_INPUT}
-   ${FLEX_BIFScanner_INPUT}
-   ${BISON_BIFParser_OUTPUTS}
-   ${FLEX_BIFScanner_OUTPUTS}
-   bif_arg.cc
-   include/bif_arg.h
-   module_util.cc
-   include/module_util.h
-)
+    ${BISON_BIFParser_INPUT}
+    ${FLEX_BIFScanner_INPUT}
+    ${BISON_BIFParser_OUTPUTS}
+    ${FLEX_BIFScanner_OUTPUTS}
+    bif_arg.cc
+    include/bif_arg.h
+    module_util.cc
+    include/module_util.h)
 
 add_executable(bifcl ${bifcl_SRCS})
 target_compile_features(bifcl PRIVATE cxx_std_17)
 set_target_properties(bifcl PROPERTIES CXX_EXTENSIONS OFF)
 
-if (MSVC)
-    # If building separately from zeek, we need to add the libunistd subdirectory so
-    # that linking doesn't fail.
-    if ("${CMAKE_PROJECT_NAME}" STREQUAL "BifCl")
-        add_subdirectory(auxil/libunistd EXCLUDE_FROM_ALL)
-    endif()
-    target_link_libraries(bifcl PRIVATE libunistd)
+if(MSVC)
+  # If building separately from zeek, we need to add the libunistd subdirectory
+  # so that linking doesn't fail.
+  if("${CMAKE_PROJECT_NAME}" STREQUAL "BifCl")
+    add_subdirectory(auxil/libunistd EXCLUDE_FROM_ALL)
+  endif()
+  target_link_libraries(bifcl PRIVATE libunistd)
 endif()
 
 install(TARGETS bifcl DESTINATION bin)
 
-if (CMAKE_BUILD_TYPE)
-    string(TOUPPER ${CMAKE_BUILD_TYPE} BuildType)
-endif ()
+if(CMAKE_BUILD_TYPE)
+  string(TOUPPER ${CMAKE_BUILD_TYPE} BuildType)
+endif()
 
 message(
-    "\n====================|  Bifcl Build Summary  |====================="
-    "\n"
-    "\nBuild type:        ${CMAKE_BUILD_TYPE}"
-    "\nBuild dir:         ${PROJECT_BINARY_DIR}"
-    "\nInstall prefix:    ${CMAKE_INSTALL_PREFIX}"
-    "\nDebug mode:        ${ENABLE_DEBUG}"
-    "\n"
-    "\nCC:                ${CMAKE_C_COMPILER}"
-    "\nCFLAGS:            ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${BuildType}}"
-    "\nCXX:               ${CMAKE_CXX_COMPILER}"
-    "\nCXXFLAGS:          ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${BuildType}}"
-    "\nCPP:               ${CMAKE_CXX_COMPILER}"
-    "\n"
-    "\n================================================================\n"
-)
+  "\n====================|  Bifcl Build Summary  |====================="
+  "\n"
+  "\nBuild type:        ${CMAKE_BUILD_TYPE}"
+  "\nBuild dir:         ${PROJECT_BINARY_DIR}"
+  "\nInstall prefix:    ${CMAKE_INSTALL_PREFIX}"
+  "\nDebug mode:        ${ENABLE_DEBUG}"
+  "\n"
+  "\nCC:                ${CMAKE_C_COMPILER}"
+  "\nCFLAGS:            ${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_${BuildType}}"
+  "\nCXX:               ${CMAKE_CXX_COMPILER}"
+  "\nCXXFLAGS:          ${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_${BuildType}}"
+  "\nCPP:               ${CMAKE_CXX_COMPILER}"
+  "\n"
+  "\n================================================================\n")
 
 include(UserChangedWarning)
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.8.0-11
+1.8.0-14
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# clang-format: Reformat Bifcl in Spicy style
		1c92e23be51ffb2d66e3a1a37d2930c3fb17844f