Add clang-tidy (#26)

Author: marcoroth

.clang-tidy

@@ -0,0 +1,146 @@
+---
+Checks: '-*,
+bugprone-argument-comment,
+bugprone-assert-side-effect,
+bugprone-bad-signal-to-kill-thread,
+bugprone-branch-clone,
+bugprone-copy-constructor-init,
+bugprone-dangling-handle,
+bugprone-dynamic-static-initializers,
+bugprone-fold-init-type,
+bugprone-forward-declaration-namespace,
+bugprone-forwarding-reference-overload,
+bugprone-inaccurate-erase,
+bugprone-incorrect-roundings,
+bugprone-integer-division,
+bugprone-lambda-function-name,
+bugprone-macro-parentheses,
+bugprone-macro-repeated-side-effects,
+bugprone-misplaced-operator-in-strlen-in-alloc,
+bugprone-misplaced-pointer-arithmetic-in-alloc,
+bugprone-misplaced-widening-cast,
+bugprone-move-forwarding-reference,
+bugprone-multiple-statement-macro,
+bugprone-no-escape,
+bugprone-parent-virtual-call,
+bugprone-posix-return,
+bugprone-reserved-identifier,
+bugprone-sizeof-container,
+bugprone-sizeof-expression,
+bugprone-spuriously-wake-up-functions,
+bugprone-string-constructor,
+bugprone-string-integer-assignment,
+bugprone-string-literal-with-embedded-nul,
+bugprone-suspicious-enum-usage,
+bugprone-suspicious-include,
+bugprone-suspicious-memset-usage,
+bugprone-suspicious-missing-comma,
+bugprone-suspicious-semicolon,
+bugprone-suspicious-string-compare,
+bugprone-suspicious-memory-comparison,
+//bugprone-suspicious-realloc-usage,
+bugprone-swapped-arguments,
+bugprone-terminating-continue,
+bugprone-throw-keyword-missing,
+bugprone-too-small-loop-variable,
+bugprone-undefined-memory-manipulation,
+bugprone-undelegated-constructor,
+bugprone-unhandled-self-assignment,
+bugprone-unused-raii,
+bugprone-unused-return-value,
+bugprone-use-after-move,
+bugprone-virtual-near-miss,
+cert-dcl21-cpp,
+cert-dcl58-cpp,
+cert-err34-c,
+cert-err52-cpp,
+cert-err60-cpp,
+cert-flp30-c,
+cert-msc50-cpp,
+cert-msc51-cpp,
+cert-str34-c,
+cppcoreguidelines-interfaces-global-init,
+cppcoreguidelines-narrowing-conversions,
+cppcoreguidelines-pro-type-member-init,
+cppcoreguidelines-pro-type-static-cast-downcast,
+cppcoreguidelines-slicing,
+google-default-arguments,
+google-explicit-constructor,
+google-runtime-operator,
+hicpp-exception-baseclass,
+hicpp-multiway-paths-covered,
+misc-misplaced-const,
+misc-new-delete-overloads,
+misc-no-recursion,
+misc-non-copyable-objects,
+misc-throw-by-value-catch-by-reference,
+misc-unconventional-assign-operator,
+misc-uniqueptr-reset-release,
+modernize-avoid-bind,
+modernize-concat-nested-namespaces,
+modernize-deprecated-headers,
+modernize-deprecated-ios-base-aliases,
+modernize-loop-convert,
+modernize-make-shared,
+modernize-make-unique,
+modernize-pass-by-value,
+modernize-raw-string-literal,
+modernize-redundant-void-arg,
+modernize-replace-auto-ptr,
+modernize-replace-disallow-copy-and-assign-macro,
+modernize-replace-random-shuffle,
+modernize-return-braced-init-list,
+modernize-shrink-to-fit,
+modernize-unary-static-assert,
+modernize-use-auto,
+modernize-use-bool-literals,
+modernize-use-emplace,
+modernize-use-equals-default,
+modernize-use-equals-delete,
+modernize-use-nodiscard,
+modernize-use-noexcept,
+modernize-use-nullptr,
+modernize-use-override,
+modernize-use-transparent-functors,
+modernize-use-uncaught-exceptions,
+mpi-buffer-deref,
+mpi-type-mismatch,
+openmp-use-default-none,
+performance-faster-string-find,
+performance-for-range-copy,
+performance-implicit-conversion-in-loop,
+performance-inefficient-algorithm,
+performance-inefficient-string-concatenation,
+performance-inefficient-vector-operation,
+performance-move-const-arg,
+performance-move-constructor-init,
+performance-no-automatic-move,
+performance-noexcept-move-constructor,
+performance-trivially-destructible,
+performance-type-promotion-in-math-fn,
+performance-unnecessary-copy-initialization,
+performance-unnecessary-value-param,
+portability-simd-intrinsics,
+readability-avoid-const-params-in-decls,
+readability-const-return-type,
+readability-container-size-empty,
+readability-convert-member-functions-to-static,
+readability-delete-null-pointer,
+readability-deleted-default,
+readability-inconsistent-declaration-parameter-name,
+readability-make-member-function-const,
+readability-misleading-indentation,
+readability-misplaced-array-index,
+readability-non-const-parameter,
+readability-redundant-control-flow,
+readability-redundant-declaration,
+readability-redundant-function-ptr-dereference,
+readability-redundant-smartptr-get,
+readability-redundant-string-cstr,
+readability-redundant-string-init,
+readability-simplify-subscript-expr,
+readability-static-accessed-through-instance,
+readability-static-definition-in-anonymous-namespace,
+readability-string-compare,
+readability-uniqueptr-delete-release,
+readability-use-anyofallof'

.github/workflows/test.yml

@@ -4,6 +4,7 @@ on: [push]
 
 jobs:
   build:
+    name: Build
     runs-on: ubuntu-latest
 
     steps:
@@ -35,3 +36,18 @@ jobs:
 
       - name: Lint
         run: bin/lint
+
+  tidy:
+    name: Tidy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install clang-tidy
+        run: sudo apt-get install -y clang-tidy
+
+      - name: clang-tidy version
+        run: clang-tidy --version
+
+      - name: Tidy
+        run: bin/tidy

Brewfile

@@ -1,2 +1,3 @@
 brew "check"
 brew "clang-format"
+brew "llvm" # for clang and clang-tidy

Makefile

@@ -1,9 +1,17 @@
 exec = erbx
 test_exec = run_erbx_tests
 
-sources = $(wildcard src/*.c)
+sources = $(wildcard src/*.c) $(wildcard src/**/*.c)
+headers = $(wildcard src/*.h) $(wildcard src/**/*.h)
 objects = $(sources:.c=.o)
 
+extension_sources = $(wildcard ext/**/*.c)
+extension_headers = $(wildcard ext/**/*.h)
+
+project_files = $(sources) $(headers)
+extension_files = $(extension_sources) $(extension_headers)
+project_and_extension_files = $(project_files) $(extension_files)
+
 test_sources = $(wildcard test/*.c)
 test_objects = $(test_sources:.c=.o)
 non_main_objects = $(filter-out src/main.o, $(objects))
@@ -19,14 +27,20 @@ flags = -g -Wall -fPIC
 ifeq ($(os),Linux)
   test_cflags = $(flags) -I/usr/include/check
   test_ldflags = -L/usr/lib/x86_64-linux-gnu -lcheck -lm -lsubunit
+  llvm_path = TODO
+  cc = clang
   clang_format = clang-format-19
+  clang_tidy = clang-tidy
 endif
 
 ifeq ($(os),Darwin)
   brew_prefix := $(shell brew --prefix check)
   test_cflags = $(flags) -I$(brew_prefix)/include
   test_ldflags = -L$(brew_prefix)/lib -lcheck -lm
+  llvm_path = /opt/homebrew/opt/llvm
+  cc = $(llvm_path)/bin/clang
   clang_format = clang-format
+  clang_tidy = $(llvm_path)/bin/clang-tidy
 endif
 
 all: $(exec) $(lib_name) test
@@ -52,7 +66,10 @@ clean:
 	rm -rf src/*.o test/*.o lib/erbx/*.bundle tmp
 
 format:
-	$(clang_format) -i $(wildcard src/*.c) $(wildcard src/**/*.c) $(wildcard src/*.h) $(wildcard src/**/*.h) $(wildcard ext/**/*.c) $(wildcard ext/**/*.h)
+	$(clang_format) -i $(project_and_extension_files)
 
 lint:
-	$(clang_format) --dry-run --Werror $(wildcard src/*.c) $(wildcard src/**/*.c) $(wildcard src/*.h) $(wildcard src/**/*.h) $(wildcard ext/**/*.c) $(wildcard ext/**/*.h)
+	$(clang_format) --dry-run --Werror $(project_and_extension_files)
+
+tidy:
+	$(clang_tidy) $(project_files) -- $(flags)

README.md

@@ -11,15 +11,16 @@ This project builds the ERBX program and its associated unit tests using a Makef
 - **GCC**
 - **Check**: The project uses the [Check](https://libcheck.github.io/check/) library for unit testing.
 - **Clang Format**: The project uses [Clang Format](https://clang.llvm.org/docs/ClangFormat.html) for formatting.
+- **Clang Tidy**: The project uses [Clang Format](https://clang.llvm.org/docs/ClangFormat.html) for formatting.
 
 For Linux:
 ```bash
-sudo apt-get install check clang-format-19
+sudo apt-get install check clang-format-19 clang-tidy
 ```
 
 For macOS (using Homebrew):
 ```bash
-brew install check clang-format
+brew install check clang-format llvm
 # or
 brew bundle
 ```

bin/tidy

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e  # Exit on error
+
+make tidy
+
+echo "Tidy complete!"

ext/erbx/extension.c

@@ -1,6 +1,5 @@
 #include "extension.h"
-#include "extconf.h"
-#include "ruby.h"
+#include <ruby.h>
 
 #include "../../src/include/erbx.h"
 

src/array.c

@@ -4,7 +4,7 @@ size_t array_sizeof(void) {
   return sizeof(array_T);
 }
 
-array_T* array_init(int capacity) {
+array_T* array_init(size_t capacity) {
   array_T* array = (array_T*) malloc(sizeof(array_T));
 
   array->size = 0;
@@ -24,28 +24,28 @@ void array_append(array_T* array, void* item) {
   array->size++;
 }
 
-void* array_get(array_T* array, int index) {
+void* array_get(array_T* array, size_t index) {
   if (index >= array->size || index < 0) {
     return NULL;
   }
 
   return array->items[index];
 }
 
-void array_set(array_T* array, int index, void* item) {
-  if (index >= array->size || index < 0) {
+void array_set(array_T* array, size_t index, void* item) {
+  if (index >= array->size) {
     return;
   }
 
   array->items[index] = item;
 }
 
-void array_remove(array_T* array, int index) {
-  if (index >= array->size || index < 0) {
+void array_remove(array_T* array, size_t index) {
+  if (index >= array->size) {
     return;
   }
 
-  for (int i = index; i < array->size - 1; i++) {
+  for (size_t i = index; i < array->size - 1; i++) {
     array->items[i] = array->items[i + 1];
   }
 

src/include/array.h

@@ -9,14 +9,14 @@ typedef struct ARRAY_STRUCT {
   size_t capacity;
 } array_T;
 
-array_T* array_init(int capacity);
+array_T* array_init(size_t capacity);
 
-void* array_get(array_T* array, int index);
+void* array_get(array_T* array, size_t index);
 
 void array_append(array_T* array, void* item);
-void array_set(array_T* array, int index, void* item);
+void array_set(array_T* array, size_t index, void* item);
 void array_free(array_T* array);
-void array_remove(array_T* array, int index);
+void array_remove(array_T* array, size_t index);
 
 size_t array_capacity(array_T* array);
 size_t array_size(array_T* array);

src/include/lexer_struct.h

@@ -20,10 +20,10 @@ typedef enum {
 typedef struct LEXER_STRUCT {
   char* source;
   size_t source_length;
+  size_t current_position;
+  size_t current_line;
+  size_t current_column;
   char current_character;
-  unsigned int current_position;
-  unsigned int current_line;
-  unsigned int current_column;
   lexer_state_T state;
 } lexer_T;