rebase main to Dev (#10)

* doc update. increased rev to 1.0.5

* doc fixes

* Create static-analisys.yml

* SA fixes

* small SA fixes

* cppcheck inline supression for some false-positives

* doc update for config macros

* doc typo fixes

* more typo fixes to doc

* doc update

- added sm::SIGNAL_USER
- fixed doc typos
- increased rev to 1.0.6

* fixes and improvements

- fixed idle task wihout callback
- allow user-defined tasks : inherited from task
- fixed task naming
- increased rev to 1.0.7

* allow FSM states definition as objects

increased rev to 1.0.8

* inline check typo fixes

* Update doxygen_gen.yml

* Update doxygen_gen.yml

* Delete header.html

* Update doxygen_gen.yml

* decoupled signalPublisher

- time_t replaced by duration_t to prevent std name clashing

* increased rev to 1.0.9

* added perform-until to coroutines

* bump to 1.1.0

- small fix to co::yield and co::restart calls
- doc update

* Buid action (#4)

* Create build

* Rename build to build.yml

* Update build.yml

* Update build.yml

* Update README.md

* refactor trace -> logger

- renamed "trace" to "logger"
- simplified api : logger::out( <severity>)
- updated documentation
- increased rev to 1.2.1

* Update logger.hpp

* fix example

* updated rev

* logger fixes

logger fixes
increased rev to 1.2.3

* minor fixes to logger

* logger refactor

* doc update. Rev increased

* define SIZE_MAX  for some compilers that do not have it defined

* Adding missing constructor to command (#5)

* portability and compliance fixes

* updated doc stylesheet

* fixed doc figure

* added getter for cli command param

* added command getter to cli handler. doc update

* small improvements. increased rev to 1.2.9

* fix doc typo

* sa fixes for compliance

* fix literals

* fix redundant boolean literal on boolean operator

* deepsource inline ommit flags

* small sa fixes

* added self state subscription validation

* removed redundant timeoutSet/Stop on stateHandler

* fix typo

* alias for signalID type

* removed member initializers on transition_t to allow aggregate initialization

* incresed rev to 1.3.1

* doc fixes: example on fsm

* added arduino example for blink fsm

* added overloaded constructors to sm::transition to simplify transition tables creation for user

* sa rev

* increased rev to 1.3.3

* eventdata and sm::handler class access simplified

* doc update

* simplify usage of setTimeouts() and setTransitions()

* fix doc ver

* increased rev to 1.3.6.

* bump to 1.3.7

* typo: not use N as identifier for msp430x compatibility

* bump to 1.3.8

* sa rev

* doc update

* doc update

* fixed examples. bump to 1.3.9

* added api to set name on idle task

* fix type on sm::state::setTimeouts(). Fixed fsm example. bump to 1.4.1

* bump to 1.4.2

* small fixes. logger with disabled coloring by default. bump to 1.4.3

* fix name clash  with list/coroutine. Simplified edgecheck. bump to 1.4.4

* some addons to edgecheck. bump to 1.4.5

* fix nullptr deref on edgecheck

* renamed edgecheck to input. Bump to 1.4.7

* some renaming to enums in input

* fix enums

* minor fix

* added doc. naming fixes

* refactor input. bump to 1.4.9

* fix to input

* bump to 1.5.1

* added posibility to let kernel handle the input-watchers. bump to 1.5.2

* fix lib category

* some refactor to input

* update fsm example

* doc update

* sa fixes

* some small fixes

* small fix to input

* fix to input clear steady on/off on edge

* fix input::event output on logger.cpp

* fixed input for analog channels. bump to 1.5.5

* small fixes

* fix proto

* analog input with same id shares value. bump to 1.5.6

* added input multipress. Added OS prod constants. bump to 1.5.7

* minor fixes. bump to 1.5.8

* small fix on logger

* fix cast on logger. Other minor fixes. bump to 1.5.9

* improved input. Bump to 1.6.0

* sa check

* refactores methods on input. bump to 1.6.1

* sa fixes

* comment out protected on input

* bump to 1.6.2

* doc update and other fixes

* more doc fixes

* small typo fix on Doxygen

* more doc fixes

* fix doc grouping issue

* fix typo

* bump to 1.6.4

* fix doc on input

* fixes to input. renamed core::addxxxx() methods to core::add(). same for sm::###::install##(). Fixed volatile deprecation

* minor dox fix on fsm

* updated keywords

* minor doc fixes

* added STEP and DELTA events to input

* doc fixes

* doc fixes

* fix step/diff events on input. bump to 1.7.2

* fix step/diff events. bump to 1.7.3

* fix step event on input to prevent missing events. bump to 1.7.4

* Update stylesheet

* Bump to 1.7.5. Detect fir on input step event. Other minor SA fixes

* sa rev

* update actions

---------

Co-authored-by: camilo <juancamilo.gomezcadavid@sensiaglobal.com>
Co-authored-by: J. Camilo G.C <kmilo17pet@gmail.com>
Co-authored-by: Fernando Mumbach <fermuch@cryptolab.net>

.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Build
+
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+      - 'doc/**'
+      - 'examples/**'
+      - '.vscode/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: cmake preparation
+      run: mkdir build && cd build && cmake ..
+
+    - name: build
+      working-directory: ./build
+      run: make VERBOSE=1

.github/workflows/doxygen_gen.yml

@@ -8,24 +8,32 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
     - name: Checkout repository and submodules
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         submodules: recursive
     - name: create dirs
       run: mkdir docout
-    - name: set repo url on corner
-      run: sed -i 's,https://github.com/jothepro/doxygen-awesome-css,https://github.com/kmilo17pet/QuarkTScpp,g' doc/stylesheet/doxygen-custom/header.html
+    - name: set repo url and metadata
+      run: |
+        sed -i 's,https://github.com/jothepro/doxygen-awesome-css,https://github.com/kmilo17pet/QuarkTS-cpp,g' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="og:title" content="\)[^"]*\(" \/>$\)#\1QuarkTS++ OS\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="og:image" content="\)[^"]*\(" \/>$\)#\1https://user-images.githubusercontent.com/11412210/235049017-242f1c64-52ef-46db-8008-2c3d8a578320.png\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="og:description" content="\)[^"]*\(" \/>$\)#\1An open-source OS for small embedded applications\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="og:url" content="\)[^"]*\(" \/>$\)#\1https://github.com/kmilo17pet/QuarkTS-cpp\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="twitter:image:src" content="\)[^"]*\(" \/>$\)#\1https://user-images.githubusercontent.com/11412210/235049017-242f1c64-52ef-46db-8008-2c3d8a578320.png\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="twitter:title" content="\)[^"]*\(" \/>$\)#\1QuarkTS++ OS\2#' doc/stylesheet/doxygen-custom/header.html
+        sed -i 's#\(<meta property="twitter:description" content="\)[^"]*\(" \/>$\)#\1An open-source OS for small embedded applications\2#' doc/stylesheet/doxygen-custom/header.html
     - name: Doxygen Action
-      uses: mattnotmitt/doxygen-action@v1.9.2
+      uses: mattnotmitt/doxygen-action@edge
       with:
         doxyfile-path: './doc/Doxygen'
     - name: rm gitignore
-      run: rm .gitignore  
+      run: rm .gitignore
     - name: Deploy doc
-      uses: peaceiris/actions-gh-pages@v3
+      uses: peaceiris/actions-gh-pages@v4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./doxyout/html

.github/workflows/static-analisys.yml

@@ -0,0 +1,31 @@
+name: Static-Analysis
+
+on:
+  workflow_dispatch:
+  push:
+    paths-ignore:
+      - 'check/**'
+      - 'doc/**'
+      - 'examples/**'
+      - 'tools/**'
+
+jobs:
+  analize:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Update OS packages list
+      run: |
+        sudo apt-get update -yq
+    - name: Install analyzer
+      run: |
+        sudo apt-get install -y cppcheck python3
+        mkdir sa_results
+    - name: General checks
+      run: cppcheck --enable=all --inline-suppr  --inconclusive --std=c++11 ./src -I ./src/config -I ./src/include --output-file=./sa_results/general.txt --suppress=missingIncludeSystem --suppress=unmatchedSuppression:{} --suppress=unusedFunction:{}
+    - uses: actions/upload-artifact@v4
+      with:
+        name: Static_Analisys_Results
+        path: sa_results

.vscode/settings.json

@@ -52,13 +52,21 @@
         "util": "cpp",
         "ctime": "cpp",
         "ratio": "cpp",
-        "climits": "cpp"
+        "climits": "cpp",
+        "bit": "cpp",
+        "cstdarg": "cpp",
+        "algorithm": "cpp",
+        "memory": "cpp",
+        "numeric": "cpp",
+        "random": "cpp",
+        "tuple": "cpp"
     },
     "cSpell.words": [
         "endcond",
         "endverbatim",
         "QUARKTS",
         "skipcq",
-        "stackless"
+        "stackless",
+        "tparam"
     ]
 }

README.md

@@ -6,6 +6,7 @@
 [![MISRAC++2008](https://img.shields.io/badge/MISRAC++2008-Compliant-blue.svg?logo=verizon)](https://www.misra.org.uk/)
 [![CERT](https://img.shields.io/badge/CERT-Compliant-blue.svg?logo=cplusplus)](https://wiki.sei.cmu.edu/confluence/display/seccode/SEI+CERT+Coding+Standards)
 [![C++ Standard](https://img.shields.io/badge/STD-C++11-green.svg?logo=cplusplus)](https://en.cppreference.com/w/cpp/11)
+[![Build](https://github.com/kmilo17pet/QuarkTS-cpp/actions/workflows/build.yml/badge.svg)](https://github.com/kmilo17pet/QuarkTS-cpp/actions/workflows/build.yml)
 [![Documentation](https://github.com/kmilo17pet/QuarkTS-cpp/actions/workflows/doxygen_gen.yml/badge.svg)](https://github.com/kmilo17pet/QuarkTS-cpp/actions/workflows/doxygen_gen.yml)
 [![arduino-library-badge](https://www.ardu-badge.com/badge/QuarkTS.svg?)](https://www.ardu-badge.com/QuarkTS)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?logo=textpattern)](https://github.com/kmilo17pet/QuarkTS-cpp/graphs/commit-activity)

check/main.cpp

@@ -11,7 +11,7 @@ void idleTask_Callback( event_t e ) {
 
   co::reenter() {
     co::delay( 500 );
-    co::restart;
+    co::restart();
   }
 }