add linter (#4)

Author: anonrig

.clang-format

@@ -0,0 +1,2 @@
+BasedOnStyle: Google
+SortIncludes: Never

.github/workflows/linter.yml

@@ -0,0 +1,33 @@
+name: Lint
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+
+      - name: Run clang-format
+        uses: jidicula/clang-format-action@f62da5e3d3a2d88ff364771d9d938773a618ab5e # v4.11.0
+        with:
+          clang-format-version: '17'
+          fallback-style: 'Google'

benchmarks/benchmark.cpp

@@ -1,5 +1,6 @@
 
 #include "performancecounters/benchmarker.h"
+#include "version_weaver.h"
 #include <algorithm>
 #include <charconv>
 #include <filesystem>
@@ -8,13 +9,13 @@
 #include <random>
 #include <stdlib.h>
 #include <vector>
-#include "version_weaver.h"
 
 void pretty_print(size_t volume, size_t bytes, std::string name,
                   event_aggregate agg, bool display = true) {
   printf("%-40s : ", name.c_str());
   printf(" %5.2f Gi/s ", volume / agg.fastest_elapsed_ns());
-  double range = (agg.elapsed_ns() - agg.fastest_elapsed_ns())/agg.elapsed_ns() * 100.0;
+  double range =
+      (agg.elapsed_ns() - agg.fastest_elapsed_ns()) / agg.elapsed_ns() * 100.0;
   printf(" %5.2f GB/s (%2.0f %%) ", bytes / agg.fastest_elapsed_ns(), range);
   if (collector.has_events()) {
     printf(" %5.2f GHz ", agg.fastest_cycles() / agg.fastest_elapsed_ns());
@@ -32,20 +33,22 @@ void bench(const std::vector<std::string> &input) {
     bytes += input[i].size();
   }
   std::cout << "volume      : " << volume << " strings" << std::endl;
-  std::cout << "volume      : " << bytes / 1024 / 1024.
-            << " MB" << std::endl;
+  std::cout << "volume      : " << bytes / 1024 / 1024. << " MB" << std::endl;
   volatile size_t sum = 0;
 
   size_t min_repeat = 10;
   size_t min_time_ns = 10000000000;
   size_t max_repeat = 100000;
   pretty_print(volume, bytes, "validate",
-               bench([&input,&sum]() { for(std::string_view v : input) { sum += version_weaver::validate(v); } },
-                     min_repeat, min_time_ns, max_repeat));
-
+               bench(
+                   [&input, &sum]() {
+                     for (std::string_view v : input) {
+                       sum += version_weaver::validate(v);
+                     }
+                   },
+                   min_repeat, min_time_ns, max_repeat));
 }
 
-
 int main(int argc, char **argv) {
   bench({"1.2.4", "13.4.1"});
   return EXIT_SUCCESS;

benchmarks/performancecounters/linux-perf-events.h

@@ -1,27 +1,28 @@
 #pragma once
 #ifdef __linux__
 
-#include <asm/unistd.h>       // for __NR_perf_event_open
-#include <linux/perf_event.h> // for perf event constants
-#include <sys/ioctl.h>        // for ioctl
-#include <unistd.h>           // for syscall
+#include <asm/unistd.h>        // for __NR_perf_event_open
+#include <linux/perf_event.h>  // for perf event constants
+#include <sys/ioctl.h>         // for ioctl
+#include <unistd.h>            // for syscall
 
-#include <cerrno>  // for errno
-#include <cstring> // for memset
+#include <cerrno>   // for errno
+#include <cstring>  // for memset
 #include <stdexcept>
 
 #include <iostream>
 #include <vector>
 
-template <int TYPE = PERF_TYPE_HARDWARE> class LinuxEvents {
+template <int TYPE = PERF_TYPE_HARDWARE>
+class LinuxEvents {
   int fd;
   bool working;
   perf_event_attr attribs{};
   size_t num_events{};
   std::vector<uint64_t> temp_result_vec{};
   std::vector<uint64_t> ids{};
 
-public:
+ public:
   explicit LinuxEvents(std::vector<int> config_vec) : fd(0), working(true) {
     memset(&attribs, 0, sizeof(attribs));
     attribs.type = TYPE;
@@ -32,11 +33,11 @@ template <int TYPE = PERF_TYPE_HARDWARE> class LinuxEvents {
 
     attribs.sample_period = 0;
     attribs.read_format = PERF_FORMAT_GROUP | PERF_FORMAT_ID;
-    const int pid = 0;  // the current process
-    const int cpu = -1; // all CPUs
+    const int pid = 0;   // the current process
+    const int cpu = -1;  // all CPUs
     const unsigned long flags = 0;
 
-    int group = -1; // no group
+    int group = -1;  // no group
     num_events = config_vec.size();
     ids.resize(config_vec.size());
     uint32_t i = 0;
@@ -98,7 +99,7 @@ template <int TYPE = PERF_TYPE_HARDWARE> class LinuxEvents {
 
   bool is_working() { return working; }
 
-private:
+ private:
   void report_error(const std::string &) { working = false; }
 };
 #endif

clang-format-ignore.txt

@@ -1,60 +1,64 @@
 #ifndef VERSION_WEAVER_H
 #define VERSION_WEAVER_H
 #include <optional>
-#include <string_view>
 #include <string>
+#include <string_view>
 #include <variant>
 
 namespace version_weaver {
 
-  // https://semver.org/#does-semver-have-a-size-limit-on-the-version-string
-  static constexpr size_t MAX_VERSION_LENGTH = 256;
-
-  bool validate(std::string_view version);
-  bool gt(std::string_view version1, std::string_view version2);
-  bool lt(std::string_view version1, std::string_view version2);
-  bool satisfies(std::string_view version, std::string_view range);
-  std::string coerce(std::string_view version);
-  std::string minimum(std::string_view range);
-  std::string clean(std::string_view range);
-
-  // A normal version number MUST take the form X.Y.Z where X, Y, and Z are
-  // non-negative integers, and MUST NOT contain leading zeroes.
-  // X is the major version, Y is the minor version, and Z is the patch version.
-  // Each element MUST increase numerically.
-  // For instance: 1.9.0 -> 1.10.0 -> 1.11.0.
-  struct Version {
-
-    std::string_view major;
-    std::string_view minor;
-    std::string_view patch;
-
-    // A pre-release version MAY be denoted by appending a hyphen and a series
-    // of dot separated identifiers immediately following the patch version.
-    // - Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-].
-    // - Identifiers MUST NOT be empty.
-    // - Numeric identifiers MUST NOT include leading zeroes.
-    //
-    // Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.--.
-    std::optional<std::string_view> pre_release;
-
-    // Build metadata MAY be denoted by appending a plus sign and a series of dot
-    // separated identifiers immediately following the patch or pre-release version.
-    // - Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9A-Za-z-].
-    // - Identifiers MUST NOT be empty.
-    // Build metadata MUST be ignored when determining version precedence.
-    // Thus two versions that differ only in the build metadata, have the same precedence.
-    //
-    // Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, 1.0.0-beta+exp.sha.5114f85, 1.0.0+21AF26D3----117B344092BD.
-    std::optional<std::string_view> build;
-  };
-
-  enum ParseError {
-    VERSION_LARGER_THAN_MAX_LENGTH,
-    INVALID_INPUT,
-  };
-
-  std::variant<Version, ParseError> parse(std::string_view version);
-}
-
-#endif // VERSION_WEAVER_H
+// https://semver.org/#does-semver-have-a-size-limit-on-the-version-string
+static constexpr size_t MAX_VERSION_LENGTH = 256;
+
+bool validate(std::string_view version);
+bool gt(std::string_view version1, std::string_view version2);
+bool lt(std::string_view version1, std::string_view version2);
+bool satisfies(std::string_view version, std::string_view range);
+std::string coerce(std::string_view version);
+std::string minimum(std::string_view range);
+std::string clean(std::string_view range);
+
+// A normal version number MUST take the form X.Y.Z where X, Y, and Z are
+// non-negative integers, and MUST NOT contain leading zeroes.
+// X is the major version, Y is the minor version, and Z is the patch version.
+// Each element MUST increase numerically.
+// For instance: 1.9.0 -> 1.10.0 -> 1.11.0.
+struct Version {
+  std::string_view major;
+  std::string_view minor;
+  std::string_view patch;
+
+  // A pre-release version MAY be denoted by appending a hyphen and a series
+  // of dot separated identifiers immediately following the patch version.
+  // - Identifiers MUST comprise only ASCII alphanumerics and hyphens
+  // [0-9A-Za-z-].
+  // - Identifiers MUST NOT be empty.
+  // - Numeric identifiers MUST NOT include leading zeroes.
+  //
+  // Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.--.
+  std::optional<std::string_view> pre_release;
+
+  // Build metadata MAY be denoted by appending a plus sign and a series of dot
+  // separated identifiers immediately following the patch or pre-release
+  // version.
+  // - Identifiers MUST comprise only ASCII alphanumerics and hyphens
+  // [0-9A-Za-z-].
+  // - Identifiers MUST NOT be empty.
+  // Build metadata MUST be ignored when determining version precedence.
+  // Thus two versions that differ only in the build metadata, have the same
+  // precedence.
+  //
+  // Examples: 1.0.0-alpha+001, 1.0.0+20130313144700, 1.0.0-beta+exp.sha.5114f85,
+  // 1.0.0+21AF26D3----117B344092BD.
+  std::optional<std::string_view> build;
+};
+
+enum ParseError {
+  VERSION_LARGER_THAN_MAX_LENGTH,
+  INVALID_INPUT,
+};
+
+std::variant<Version, ParseError> parse(std::string_view version);
+}  // namespace version_weaver
+
+#endif  // VERSION_WEAVER_H