Dev

.clang-format

@@ -43,4 +43,5 @@ BinPackArguments: false
 BinPackParameters: false
 AllowAllArgumentsOnNextLine: false
 IndentPPDirectives: BeforeHash
-IndentExternBlock: Indent
+IndentExternBlock: Indent
+AlignEscapedNewlines: Left

CMakeLists.txt

@@ -1,12 +1,13 @@
+include_guard()
 cmake_minimum_required(VERSION 3.21)
 
 # General info about the project
-project(
-    ZeroMate
+project(ZeroMate
     VERSION 1.4.2
     DESCRIPTION "Raspberry Pi Zero emulator"
     HOMEPAGE_URL "https://github.com/silhavyj/ZeroMate"
-    LANGUAGES C CXX)
+    LANGUAGES C CXX
+)
 
 # Enable parallel build
 set(CMAKE_BUILD_PARALLEL_LEVEL 4)
@@ -18,23 +19,29 @@ set(CMAKE_CXX_STANDARD 20)
 include(cmake/standard_project_settings.cmake)
 
 add_library(project_warnings INTERFACE)
+
 add_library(project_options INTERFACE)
 
-target_compile_features(project_options INTERFACE cxx_std_${CMAKE_CXX_STANDARD})
+target_compile_features(project_options
+    INTERFACE
+        cxx_std_${CMAKE_CXX_STANDARD}
+)
 
 # Standard compiler warnings
 include(cmake/compiler_warnings.cmake)
+
 set_project_warnings(project_warnings)
 
 # Add sanitizer options if supported by the compiler
 include(cmake/sanitizers.cmake)
+
 enable_sanitizers(project_options)
 
 # Turn on compiler optimizations for the Release build
-if(CMAKE_BUILD_TYPE STREQUAL "Release")
+if (CMAKE_BUILD_TYPE STREQUAL "Release")
     include(cmake/compiler_optimizations.cmake)
     set_project_optimizations(project_warnings)
-endif()
+endif ()
 
 # Allow for static analysis option
 include(cmake/static_analyzers.cmake)
@@ -61,14 +68,16 @@ add_subdirectory(src)
 
 # Add tests
 option(ENABLE_TESTING "Enable Test Builds" ON)
-if(ENABLE_TESTING)
+
+if (ENABLE_TESTING)
     add_subdirectory(external/googletest)
     enable_testing()
     add_subdirectory(test)
-endif()
+endif ()
 
 # Generate docs
 option(BUILD_DOC "Build Documentation" ON)
+
 if (BUILD_DOC)
     include(cmake/doxygen.cmake)
-endif()
+endif ()

docs/diagrams/branching_strategy.drawio

@@ -0,0 +1,169 @@
+<mxfile host="Electron" modified="2024-01-12T14:05:56.060Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/22.1.16 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="tMlkng_TqpMCt0v8ZFgR" version="22.1.16" type="device">
+  <diagram name="Page-1" id="r9S0kEUFvn608547pgD2">
+    <mxGraphModel dx="505" dy="300" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-2" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-28" target="Qs0CVcsadeXlFzhfiOa3-26" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="150" y="190" as="sourcePoint" />
+            <mxPoint x="200" y="190" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-4" value="v0.1.0" style="shape=step;perimeter=stepPerimeter;whiteSpace=wrap;html=1;fixedSize=1;size=10;shadow=1;fontFamily=Computer Modern;" parent="1" vertex="1">
+          <mxGeometry x="460" y="160" width="70" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-5" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="360" y="240" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-6" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="270" y="280" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-8" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.943;exitY=0.693;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-28" target="Qs0CVcsadeXlFzhfiOa3-9" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="150" y="190" as="sourcePoint" />
+            <mxPoint x="200" y="200" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-9" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="210" y="240" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-11" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=1;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-28" target="Qs0CVcsadeXlFzhfiOa3-12" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="150" y="190" as="sourcePoint" />
+            <mxPoint x="200" y="240" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-12" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="210" y="280" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-13" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="330" y="280" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-15" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-12" target="Qs0CVcsadeXlFzhfiOa3-6" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="160" y="200" as="sourcePoint" />
+            <mxPoint x="210" y="300" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-16" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-6" target="Qs0CVcsadeXlFzhfiOa3-13" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="230" y="300" as="sourcePoint" />
+            <mxPoint x="260" y="300" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-17" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-9" target="Qs0CVcsadeXlFzhfiOa3-5" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="160" y="200" as="sourcePoint" />
+            <mxPoint x="212" y="244" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-18" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-13" target="Qs0CVcsadeXlFzhfiOa3-5" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="290" y="300" as="sourcePoint" />
+            <mxPoint x="330" y="300" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-19" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="460" y="280" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-20" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="400" y="280" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-21" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-20" target="Qs0CVcsadeXlFzhfiOa3-19" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="350" y="200" as="sourcePoint" />
+            <mxPoint x="400" y="300" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-22" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-5" target="Qs0CVcsadeXlFzhfiOa3-20" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="360" y="300" as="sourcePoint" />
+            <mxPoint x="380" y="260" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-23" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="500" y="240" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-24" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-19" target="Qs0CVcsadeXlFzhfiOa3-23" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="430" y="300" as="sourcePoint" />
+            <mxPoint x="470" y="300" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-25" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-5" target="Qs0CVcsadeXlFzhfiOa3-23" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="230" y="250" as="sourcePoint" />
+            <mxPoint x="370" y="250" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-26" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="540" y="200" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-27" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;entryX=0;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-23" target="Qs0CVcsadeXlFzhfiOa3-26" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="490" y="300" as="sourcePoint" />
+            <mxPoint x="520" y="260" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-28" value="" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="140" y="200" width="20" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-30" value="" style="endArrow=none;dashed=1;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="Qs0CVcsadeXlFzhfiOa3-4" target="Qs0CVcsadeXlFzhfiOa3-26" edge="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="310" y="150" as="sourcePoint" />
+            <mxPoint x="360" y="100" as="targetPoint" />
+            <Array as="points">
+              <mxPoint x="550" y="170" />
+            </Array>
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-31" value="Release" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Computer Modern;" parent="1" vertex="1">
+          <mxGeometry x="521" y="145" width="60" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-32" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="140" y="312" as="sourcePoint" />
+            <mxPoint x="580" y="315" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-33" value="Time" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Computer Modern;" parent="1" vertex="1">
+          <mxGeometry x="516" y="294" width="60" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-34" value="main branch" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Computer Modern;fontStyle=2" parent="1" vertex="1">
+          <mxGeometry x="65" y="200" width="70" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-35" value="development&lt;br&gt;branch" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Computer Modern;fontStyle=2" parent="1" vertex="1">
+          <mxGeometry x="60" y="240" width="80" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-36" value="feature branch/&lt;br&gt;bug-fix branch" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Computer Modern;fontStyle=2" parent="1" vertex="1">
+          <mxGeometry x="42.5" y="280" width="115" height="20" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-42" value="&amp;nbsp; All pipelines&lt;br&gt;&amp;nbsp; are run (CI)" style="shape=note;size=20;whiteSpace=wrap;html=1;align=left;fontFamily=Computer Modern;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="310" y="150" width="100" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-43" value="" style="endArrow=none;dashed=1;html=1;rounded=0;entryX=0;entryY=0;entryDx=100;entryDy=30;entryPerimeter=0;" parent="1" edge="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="525" y="234" as="sourcePoint" />
+            <mxPoint x="415" y="174" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-44" value="&amp;nbsp; e.g. implementation&lt;br&gt;&amp;nbsp; of the ARM timer" style="shape=note;size=20;whiteSpace=wrap;html=1;align=left;fontFamily=Computer Modern;shadow=1;" parent="1" vertex="1">
+          <mxGeometry x="160" y="150" width="130" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-46" value="" style="endArrow=none;dashed=1;html=1;rounded=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" target="Qs0CVcsadeXlFzhfiOa3-44" edge="1">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="310" y="290" as="sourcePoint" />
+            <mxPoint x="350" y="400" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="Qs0CVcsadeXlFzhfiOa3-47" value="" style="endArrow=open;endFill=1;endSize=12;html=1;rounded=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" edge="1">
+          <mxGeometry width="160" relative="1" as="geometry">
+            <mxPoint x="560" y="209.66" as="sourcePoint" />
+            <mxPoint x="600" y="210" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>