Project structure and c++ trace file reader/writer

.clang-format

@@ -0,0 +1,22 @@
+# Use the Google style in this project.
+Language:        Cpp
+BasedOnStyle: Google
+
+# Google style only requires consistency: "int& a" vs. "int &a" vs. "int & a"
+DerivePointerAlignment: false
+PointerAlignment: Left
+
+# Google style only requires consistency: "const int a" vs. "int const a"
+QualifierAlignment: Left
+
+# empty lines between function definitions
+SeparateDefinitionBlocks: Always
+EmptyLineBeforeAccessModifier: LogicalBlock
+
+# break with the Google style but be consistent with python
+IndentWidth: 4
+UseTab: Never
+
+# allow more characters per line
+ColumnLimit: 180
+

.clang-tidy

@@ -0,0 +1,54 @@
+Checks: >
+  -*,
+  readability-*,
+  -readability-useless-return-value,
+  -readability-const-return-type,
+  -readability-magic-numbers,
+  -readability-math-missing-parentheses,
+  cppcoreguidelines-*,
+  -cppcoreguidelines-non-private-member-variables-in-classes,
+  -cppcoreguidelines-pro-type-vararg,
+  -cppcoreguidelines-macro-usage,
+  -cppcoreguidelines-pro-bounds-pointer-arithmetic,
+  -cppcoreguidelines-pro-type-reinterpret-cast,
+  -cppcoreguidelines-owning-memory,
+  -cppcoreguidelines-pro-type-union-access,
+  -cppcoreguidelines-avoid-do-while,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-avoid-c-arrays,
+  -cppcoreguidelines-pro-bounds-array-to-pointer-decay
+  misc-*,
+  bugprone-*,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-suspicious-enum-usage,
+  modernize-,
+  clang-analyzer-*,
+  performance-*,
+  -performance-avoid-endl,
+
+# as like in clang-format, follow the Google style guide https://google.github.io/styleguide/cppguide.html
+# based on https://github.com/googleapis/google-cloud-cpp/blob/main/.clang-tidy
+CheckOptions:
+  - { key: readability-identifier-naming.NamespaceCase,          value: lower_case }
+  - { key: readability-identifier-naming.ClassCase,              value: CamelCase  }
+  - { key: readability-identifier-naming.StructCase,             value: CamelCase  }
+  - { key: readability-identifier-naming.TemplateParameterCase,  value: CamelCase  }
+  - { key: readability-identifier-naming.FunctionCase,           value: aNy_CasE  }
+  - { key: readability-identifier-naming.VariableCase,           value: lower_case }
+  - { key: readability-identifier-naming.ClassMemberCase,        value: lower_case }
+  - { key: readability-identifier-naming.ClassMemberSuffix,      value: _          }
+  - { key: readability-identifier-naming.PrivateMemberSuffix,    value: _          }
+  - { key: readability-identifier-naming.ProtectedMemberSuffix,  value: _          }
+  - { key: readability-identifier-naming.EnumConstantCase,         value: CamelCase }
+  - { key: readability-identifier-naming.EnumConstantPrefix,       value: k         }
+  - { key: readability-identifier-naming.ConstexprVariableCase,    value: CamelCase }
+  - { key: readability-identifier-naming.ConstexprVariablePrefix,  value: k         }
+  - { key: readability-identifier-naming.GlobalConstantCase,       value: CamelCase }
+  - { key: readability-identifier-naming.GlobalConstantPrefix,     value: k         }
+  - { key: readability-identifier-naming.MemberConstantCase,       value: CamelCase }
+  - { key: readability-identifier-naming.MemberConstantPrefix,     value: k         }
+  - { key: readability-identifier-naming.StaticConstantCase,       value: CamelCase }
+  - { key: readability-identifier-naming.StaticConstantPrefix,     value: k         }
+  - { key: readability-implicit-bool-conversion.AllowIntegerConditions,  value: 1   }
+  - { key: readability-implicit-bool-conversion.AllowPointerConditions,  value: 1   }
+  - { key: readability-function-cognitive-complexity.IgnoreMacros,  value: 1   }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+#### Describe the bug
+A clear and concise description of what the bug is.
+
+#### Describe how to reproduce the bug
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+#### Describe the expected behavior
+A clear and concise description of what you expected to happen.
+
+#### Show some screenshots
+If applicable, add screenshots to help explain your problem.
+
+#### Describe the OS you are using
+- OS: [e.g. iOS, Ubuntu 18.04, Windows 10, ...]
+- Browser: [Chrome, Opera. Firefox, ...]
+- Language: [e.g. C++, Python, ...]
+- Version [e.g. 3.6.8]
+
+#### Additional context
+Add any other context about the bug here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+
+#### Describe the feature
+Is your feature request related to a problem with the documentation?
+A clear and concise description of what the problem is.
+Example: I am always frustrated when [...].
+
+#### Describe the solution you would like
+A clear and concise description of what you want to happen.
+
+#### Describe alternatives you have considered
+A clear and concise description of any alternative solutions or features you have considered.
+
+#### Additional context
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+#### Reference to a related issue in the repository
+<!-- Add the issue number that this PR is addressing -->
+closes #<issue_number>
+
+#### Add a description
+<!-- Add a description of the changes proposed in the pull request -->
+
+#### Self-Checks
+<!-- Take this checklist as orientation for yourself -->
+- [ ] I have added unit tests for changed or added functions.
+- [ ] I have updated function documentation of changed or added functions.
+- [ ] My changes generate no errors when passing CI tests.
+- [ ] I have successfully implemented and tested my fix/feature locally.
+- [ ] Appropriate reviewer(s) are assigned.

.github/workflows/lint.yml

@@ -0,0 +1,34 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake build-essential liblz4-dev libzstd-dev protobuf-compiler doxygen graphviz gcovr
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_EXPORT_COMPILE_COMMANDS=on
+      - name: Build for linting
+        run: cmake --build ${{github.workspace}}/build -j3
+      - name: Lint CPP
+        uses: cpp-linter/cpp-linter-action@v2
+        id: cpplinter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          style: ''  # disable clang-format checks.
+          tidy-checks: '' # Use .clang-tidy config file.
+          thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
+          extra-args: -std=c++17
+          database: 'build'
+          ignore: 'tests'
+      - name: Check Lint Results
+        if: steps.linter.outputs.checks-failed > 0
+        run: echo "Some files failed the linting checks!"

.github/workflows/spdx_check.yml

@@ -0,0 +1,19 @@
+name: SPDX License Check
+
+on: [push, pull_request]
+
+jobs:
+  check-spdx-headers:
+    name: SPDX License Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - uses: enarx/spdx@c3e8116ed31c31b3c2e58a26ba5cac407510ca37
+        with:
+          licenses: |-
+            Apache-2.0
+            BSD-3-Clause
+            BSD-2-Clause
+            MIT
+            MPL-2.0

.github/workflows/ubuntu.yml

@@ -0,0 +1,25 @@
+name: Ubuntu
+
+on: [push, pull_request]
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y cmake build-essential liblz4-dev libzstd-dev protobuf-compiler doxygen graphviz gcovr
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCODE_COVERAGE=ON
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build -j3
+      - name: Run Tests
+        working-directory: ${{github.workspace}}/build
+        run: ctest --output-on-failure
+      - name: Generate Coverage Report
+        run: gcovr -r . ${{github.workspace}}/build
+      # TODO add coverage report upload so contributors are encouraged to add tests during a PR

.gitignore

@@ -0,0 +1,60 @@
+# Subfolders
+build/
+dist/
+doc/html
+doc/latex
+osi/
+osi3/
+
+# Specific extensions
+*.egg-info
+.project
+
+# Building
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+CTestTestfile.cmake
+Makefile
+
+build
+cmake_install.cmake
+install_manifest.txt
+osi_version.proto
+
+compile_commands.json
+
+# Python-generated files
+__pycache__/
+.venv/
+venv/
+*.py[cod]
+proto2cpp.log
+.clang-format
+githooks/pre-commit
+
+# Eclipse-specific files
+*.cproject
+*.project
+.settings/
+
+# PyCharm specific files
+.idea
+.vscode/settings.json
+
+# Clion specific files
+.idea/
+cmake-build-*/
+
+# VS Code specific files
+.vscode/
+.history/
+*.vsix
+
+# Local build tool output
+local_build_tools/*.html
+
+# trace file
+*.osi
+*.txth
+*.mcap

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/mcap"]
+	path = lib/mcap
+	url = https://github.com/foxglove/mcap.git

CMakeLists.txt

@@ -0,0 +1,65 @@
+cmake_minimum_required(VERSION 3.16)
+project(osi-utilities)
+
+# Som features (e.g. mcap) require at least C++17
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# Generate compile_commands.json for clang based tools
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# Add the include folder for public headers
+include_directories(${PROJECT_SOURCE_DIR}/include)
+
+# option for specifying the path to the open_simulation_interface.
+option(USE_EXTERNAL_OSI "Use an external version of open_simulation_interface" OFF)
+option(LINK_WITH_SHARED_OSI "Link utils with shared OSI library instead of statically linking" OFF)
+
+# Locate open_simulation_interface using find_package or custom path.
+if (USE_EXTERNAL_OSI)
+    message(FATAL_ERROR "Not implemented yet")
+else ()
+    # Download and use our own open_simulation_interface package.
+    include(FetchContent)
+    FetchContent_Declare(
+            open_simulation_interface
+            GIT_REPOSITORY https://github.com/OpenSimulationInterface/open-simulation-interface.git
+            GIT_TAG v3.7.0
+    )
+    FetchContent_MakeAvailable(open_simulation_interface)
+    set(OSI_INCLUDE_DIR ${open_simulation_interface_BINARY_DIR})
+endif ()
+
+# option to enable coverage reporting
+option(CODE_COVERAGE "Enable coverage reporting" OFF)
+if (CODE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    add_compile_options(--coverage -O0 -g)
+    add_link_options(--coverage)
+    message(WARNING "Added coverage options")
+endif ()
+
+# build doxygen documentation
+find_package(Doxygen)
+if (DOXYGEN_FOUND AND PROJECT_IS_TOP_LEVEL)
+    message(STATUS "Doxygen found, generating API documentation")
+    # set input and output files
+    set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in)
+    set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile)
+    # request to configure the file
+    configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+    # note the option ALL which allows to build the docs together with the application
+    add_custom_target(
+            library_api_doc
+            ALL
+            COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+            WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+            COMMENT "Generating API documentation with Doxygen"
+            VERBATIM
+    )
+endif (DOXYGEN_FOUND AND PROJECT_IS_TOP_LEVEL)
+
+add_subdirectory(src)
+if (PROJECT_IS_TOP_LEVEL)
+    enable_testing()
+    add_subdirectory(tests)
+endif ()
+add_subdirectory(examples)