Tidier

Author: whoami730

.clang-format

@@ -0,0 +1,35 @@
+BasedOnStyle: LLVM
+
+IndentWidth: 4
+
+BreakAfterReturnType: ExceptShortType
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: true
+  AfterFunction: true
+  AfterClass: false
+  AfterControlStatement: false
+  AfterEnum: false
+  AfterNamespace: false
+  BeforeElse: true
+  IndentBraces: false
+
+# Don’t reflow or wrap lines
+ColumnLimit: 0
+
+# Leave initializer lists alone
+Cpp11BracedListStyle: False
+
+AllowShortCaseExpressionOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: WithoutElse
+
+# Switch/case
+IndentCaseLabels: true
+IndentCaseBlocks: true
+
+IndentPPDirectives: BeforeHash
+
+PointerAlignment: Left
+
+SortIncludes: false
+SpaceInEmptyBlock: true

.clang-tidy

@@ -0,0 +1,12 @@
+Checks: >
+  -*,
+  bugprone-*,
+  modernize-use-override,
+  clang-analyzer-*,
+  -bugprone-easily-swappable-parameters,
+  -clang-diagnostic-error,
+  -clang-analyzer-cplusplus.NewDelete,
+
+WarningsAsErrors: ''     # keep warnings first, promote to errors later
+HeaderFilterRegex: 'src/.*'
+FormatStyle: none

ASTNode.h

@@ -1,5 +1,5 @@
-#ifndef _PYC_ASTNODE_H
-#define _PYC_ASTNODE_H
+#ifndef PYC_ASTNODE_H
+#define PYC_ASTNODE_H
 
 #include "pyc_module.h"
 #include <list>

ASTree.cpp

@@ -130,8 +130,6 @@ PycRef<ASTNode> BuildFromCode(PycRef<PycCode> code, PycModule* mod)
                 && opcode != Pyc::POP_JUMP_IF_TRUE_A
                 && opcode != Pyc::POP_JUMP_FORWARD_IF_TRUE_A
                 && opcode != Pyc::POP_BLOCK) {
-            else_pop = false;
-
             PycRef<ASTBlock> prev = curblock;
             while (prev->end() < pos
                     && prev->blktype() != ASTBlock::BLK_MAIN) {
@@ -2480,7 +2478,6 @@ PycRef<ASTNode> BuildFromCode(PycRef<PycCode> code, PycModule* mod)
         case Pyc::RESUME_A:
         case Pyc::INSTRUMENTED_RESUME_A:
             /* We just entirely ignore this / no-op */
-            break;
         case Pyc::CACHE:
             /* These "fake" opcodes are used as placeholders for optimizing
                certain opcodes in Python 3.11+.  Since we have no need for
@@ -2645,11 +2642,10 @@ static int cmp_prec(PycRef<ASTNode> parent, PycRef<ASTNode> child)
         if (parent.type() == ASTNode::NODE_BINARY) {
             PycRef<ASTBinary> binParent = parent.cast<ASTBinary>();
             if (binParent->right() == child) {
-                if (binParent->op() == ASTBinary::BIN_SUBTRACT &&
-                    binChild->op() == ASTBinary::BIN_ADD)
-                    return 1;
-                else if (binParent->op() == ASTBinary::BIN_DIVIDE &&
-                         binChild->op() == ASTBinary::BIN_MULTIPLY)
+                if ((binParent->op() == ASTBinary::BIN_SUBTRACT &&
+                     binChild->op() == ASTBinary::BIN_ADD) ||
+                    (binParent->op() == ASTBinary::BIN_DIVIDE &&
+                     binChild->op() == ASTBinary::BIN_MULTIPLY))
                     return 1;
             }
             return binChild->op() - binParent->op();
@@ -2663,6 +2659,9 @@ static int cmp_prec(PycRef<ASTNode> parent, PycRef<ASTNode> child)
         PycRef<ASTUnary> unChild = child.cast<ASTUnary>();
         if (parent.type() == ASTNode::NODE_BINARY) {
             PycRef<ASTBinary> binParent = parent.cast<ASTBinary>();
+
+            // NOLINTBEGIN(bugprone-branch-clone)f
+            // Not sure if reordering the branches could lead to some bugs
             if (binParent->op() == ASTBinary::BIN_LOG_AND ||
                 binParent->op() == ASTBinary::BIN_LOG_OR)
                 return -1;
@@ -2672,6 +2671,7 @@ static int cmp_prec(PycRef<ASTNode> parent, PycRef<ASTNode> child)
                 return 1;
             else
                 return -1;
+            // NOLINTEND(bugprone-branch-clone)
         } else if (parent.type() == ASTNode::NODE_COMPARE) {
             return (unChild->op() == ASTUnary::UN_NOT) ? 1 : -1;
         } else if (parent.type() == ASTNode::NODE_UNARY) {
@@ -2696,23 +2696,18 @@ static void print_ordered(PycRef<ASTNode> parent, PycRef<ASTNode> child,
                           PycModule* mod, std::ostream& pyc_output)
 {
     if (child.type() == ASTNode::NODE_BINARY ||
-        child.type() == ASTNode::NODE_COMPARE) {
+        child.type() == ASTNode::NODE_COMPARE ||
+        child.type() == ASTNode::NODE_UNARY) {
         if (cmp_prec(parent, child) > 0) {
             pyc_output << "(";
             print_src(child, mod, pyc_output);
             pyc_output << ")";
-        } else {
-            print_src(child, mod, pyc_output);
         }
-    } else if (child.type() == ASTNode::NODE_UNARY) {
-        if (cmp_prec(parent, child) > 0) {
-            pyc_output << "(";
-            print_src(child, mod, pyc_output);
-            pyc_output << ")";
-        } else {
+        else {
             print_src(child, mod, pyc_output);
         }
-    } else {
+    }
+    else {
         print_src(child, mod, pyc_output);
     }
 }
@@ -2773,6 +2768,9 @@ void print_formatted_value(PycRef<ASTFormattedValue> formatted_value, PycModule*
     case ASTFormattedValue::ASCII:
         pyc_output << "!a";
         break;
+    default:
+        // error case
+        break;
     }
     if (formatted_value->conversion() & ASTFormattedValue::HAVE_FMT_SPEC) {
         pyc_output << ":" << formatted_value->format_spec().cast<ASTObject>()->object().cast<PycString>()->value();
@@ -2849,7 +2847,6 @@ void print_src(PycRef<ASTNode> node, PycModule* mod, std::ostream& pyc_output)
                     pyc_output << ", ";
                 pyc_output << "**";
                 print_src(call->kw(), mod, pyc_output);
-                first = false;
             }
             pyc_output << ")";
         }

ASTree.h

@@ -1,5 +1,5 @@
-#ifndef _PYC_ASTREE_H
-#define _PYC_ASTREE_H
+#ifndef PYC_ASTREE_H
+#define PYC_ASTREE_H
 
 #include "ASTNode.h"
 

CMakeLists.txt

@@ -4,7 +4,7 @@ project(pycdc)
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-# Debug options.
+# Debug options
 option(ENABLE_BLOCK_DEBUG "Enable block debugging" OFF)
 option(ENABLE_STACK_DEBUG "Enable stack debugging" OFF)
 
@@ -16,16 +16,15 @@ if (ENABLE_STACK_DEBUG)
     add_definitions(-DSTACK_DEBUG)
 endif()
 
-if(CMAKE_COMPILER_IS_GNUCXX OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
-    set(CMAKE_CXX_FLAGS "-Wall -Wextra -Wno-error=shadow -Werror ${CMAKE_CXX_FLAGS}")
+# Compiler warnings
+if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    add_compile_options(-Wall -Wextra -Werror -Wno-error=shadow)
 elseif(MSVC)
-    set(CMAKE_CXX_FLAGS "/WX ${CMAKE_CXX_FLAGS}")
+    add_compile_options(/WX)
     add_definitions(-D_CRT_SECURE_NO_WARNINGS)
 endif()
 
-include_directories(${CMAKE_CURRENT_SOURCE_DIR})
-
-add_library(pycxx STATIC
+file(GLOB SRC_LIB_CPP CONFIGURE_DEPENDS
     bytecode.cpp
     data.cpp
     pyc_code.cpp
@@ -34,47 +33,91 @@ add_library(pycxx STATIC
     pyc_object.cpp
     pyc_sequence.cpp
     pyc_string.cpp
-    bytes/python_1_0.cpp
-    bytes/python_1_1.cpp
-    bytes/python_1_3.cpp
-    bytes/python_1_4.cpp
-    bytes/python_1_5.cpp
-    bytes/python_1_6.cpp
-    bytes/python_2_0.cpp
-    bytes/python_2_1.cpp
-    bytes/python_2_2.cpp
-    bytes/python_2_3.cpp
-    bytes/python_2_4.cpp
-    bytes/python_2_5.cpp
-    bytes/python_2_6.cpp
-    bytes/python_2_7.cpp
-    bytes/python_3_0.cpp
-    bytes/python_3_1.cpp
-    bytes/python_3_2.cpp
-    bytes/python_3_3.cpp
-    bytes/python_3_4.cpp
-    bytes/python_3_5.cpp
-    bytes/python_3_6.cpp
-    bytes/python_3_7.cpp
-    bytes/python_3_8.cpp
-    bytes/python_3_9.cpp
-    bytes/python_3_10.cpp
-    bytes/python_3_11.cpp
-    bytes/python_3_12.cpp
-    bytes/python_3_13.cpp
+    bytes/*.cpp
+)
+
+file(GLOB SRC_MAIN CONFIGURE_DEPENDS
+    *.h
+    bytes/*.h
+    pycdas.cpp
+    pycdc.cpp
+    ASTree.cpp
+    ASTNode.cpp
+    ${SRC_LIB_CPP})
+
+file(GLOB SRC_ALL CONFIGURE_DEPENDS
+    bytecode_ops.inl # This file does not contain compilable code
+    ${SRC_MAIN}
+)
+
+# Enable/disable targets/tools
+option(ENABLE_CLANG_FORMAT "Provide `format` and `format-check` targets using clang-format" ON)
+option(ENABLE_CLANG_TIDY  "Provide `tidy-all` target using clang-tidy" ON)
+
+# Export compile commands for clang-tidy / language servers
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+if(ENABLE_CLANG_FORMAT)
+    find_program(CLANG_FORMAT_EXECUTABLE
+        NAMES clang-format
+    )
+    if(CLANG_FORMAT_EXECUTABLE)
+        add_custom_target(format
+            COMMAND ${CLANG_FORMAT_EXECUTABLE} -style=file -i ${SRC_ALL}
+            COMMENT "Running clang-format on project sources"
+            VERBATIM
+        )
+
+        add_custom_target(format-check
+            COMMAND ${CLANG_FORMAT_EXECUTABLE} -style=file --dry-run -Werror ${SRC_ALL}
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+            COMMENT "Checking clang-format (non-zero exit if formatting required)"
+            VERBATIM
+            USES_TERMINAL # Enables propagating error code
+        )
+    endif()
+endif()
+
+if(ENABLE_CLANG_TIDY)
+    find_program(CLANG_TIDY_EXECUTABLE
+        NAMES clang-tidy
+    )
+    if(CLANG_TIDY_EXECUTABLE)
+        # Minimal clang-tidy wrapper. Adjust checks in your .clang-tidy file.
+        # Semicolon-separated list is required by CMake for the wrapper.
+        set(CMAKE_CXX_CLANG_TIDY
+            "${CLANG_TIDY_EXECUTABLE};-p=${CMAKE_BINARY_DIR}"
+        )
+        # If you prefer to apply clang-tidy to specific targets only, remove the
+        # global set above and use set_target_properties(... CXX_CLANG_TIDY ...)
+        # Create a custom target to run clang-tidy over main sources
+        add_custom_target(tidy-all
+            COMMAND ${CLANG_TIDY_EXECUTABLE} -p ${CMAKE_BINARY_DIR} ${SRC_MAIN}
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+            COMMENT "Running clang-tidy on project sources"
+            VERBATIM
+        )
+    endif()
+endif()
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+
+# Library
+add_library(pycxx STATIC
+    ${SRC_LIB_CPP}
 )
 
+# Executable: pycdas
 add_executable(pycdas pycdas.cpp)
-target_link_libraries(pycdas pycxx)
+target_link_libraries(pycdas PRIVATE pycxx)
 
-install(TARGETS pycdas
-    RUNTIME DESTINATION bin)
+install(TARGETS pycdas RUNTIME DESTINATION bin)
 
+# Executable: pycdc
 add_executable(pycdc pycdc.cpp ASTree.cpp ASTNode.cpp)
-target_link_libraries(pycdc pycxx)
+target_link_libraries(pycdc PRIVATE pycxx)
 
-install(TARGETS pycdc
-    RUNTIME DESTINATION bin)
+install(TARGETS pycdc RUNTIME DESTINATION bin)
 
 find_package(Python3 3.6 COMPONENTS Interpreter)
 if(Python3_FOUND)

FastStack.h

@@ -1,5 +1,5 @@
-#ifndef _PYC_FASTSTACK_H
-#define _PYC_FASTSTACK_H
+#ifndef PYC_FASTSTACK_H
+#define PYC_FASTSTACK_H
 
 #include "ASTNode.h"
 #include <stack>