diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile
index d2e725c4..d3bc3aec 100644
--- a/doxygen/Doxyfile
+++ b/doxygen/Doxyfile
@@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "QP/C++"
-PROJECT_NUMBER = "6.0.0"
+PROJECT_NUMBER = "6.0.1"
PROJECT_BRIEF =
PROJECT_LOGO = images/header_logo_ql.png
OUTPUT_DIRECTORY =
diff --git a/doxygen/Doxyfile-CHM b/doxygen/Doxyfile-CHM
index 112d873b..c8ad9955 100644
--- a/doxygen/Doxyfile-CHM
+++ b/doxygen/Doxyfile-CHM
@@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "QP/C++"
-PROJECT_NUMBER = "6.0.0"
+PROJECT_NUMBER = "6.0.1"
PROJECT_BRIEF =
PROJECT_LOGO = images/header_logo_ql.png
OUTPUT_DIRECTORY =
diff --git a/doxygen/history.dox b/doxygen/history.dox
index 08c6c782..1f710322 100644
--- a/doxygen/history.dox
+++ b/doxygen/history.dox
@@ -2,6 +2,27 @@ namespace QP {
/** @page history Revision History
+@section qpcpp_6_0_1 Version 6.0.1, 2017-11-10
+The main focus of this release is to fix the remaining problems with transitions out of eXit-Points in sub-machines. Specifically, this release modifies the QMsm-based state machine implementation strategy (file src/qf/qep_msm.cpp to properly handle transitions from eXit-Points to Entry-Points and to History connectors in sub-machines. These changes are part of fixing the following bugs reported for QM:
+
+- [bug#190 "Exit-Point segment targeting History doesn't work](https://sourceforge.net/p/qpc/bugs/190/)
+
+- [bug#189 "Exit-Point segment targeting an Entry-Point to sub-machine state doesn't work"](https://sourceforge.net/p/qpc/bugs/189/)
+
+Additionally, this release fixes the following bug in transitions to "shallow history":
+- [bug#191 "Transition to shallow history in QMsm causes assertion qep_msm#810"](https://sourceforge.net/p/qpc/bugs/191/)
+
+The bug#191 is fixed by modifying the function QMsm::childStateObj() in qep_msm.cpp to return the parent state in the corner case when the current state is the parent state.
+
+
+@note
+This QP/C++ 6.0.1 release is the minium version required in the upcoming QM 4.1.0. This is because QM 4.1.0 assumes the modified QMsm-state machine implementation strategy in order to properly handle the various transitions out of eXit-Points in sub-machine states.
+
+
+Additionally, this release changes the QXK implementation still related to the [bug#186 "QXK: Extended thread context switch causes assertion in PendSV_Handler"](https://sourceforge.net/p/qpc/bugs/186/). Specifically, the case of context switching away and back to the same thread (which can arise under specific interrupt preemption scenarios) is now handled as a simple return from PendSV. The QXK scheduler has been modified to set the "next" thread pointer to NULL when it detects switching back to the "current" thread.
+
+
+------------------------------------------------------------------------------
@section qpcpp_6_0_0 Version 6.0.0, 2017-10-13
This release fixes two bugs found in the QXK kernel:
- [bug#185](https://sourceforge.net/p/qpc/bugs/185/) "QXK: PendSV_Handler uses inconsistent stack frames for saving and restoring AO for Cortex-M0(+)"
diff --git a/doxygen/make.bat b/doxygen/make.bat
index 401c65f3..6862092a 100644
--- a/doxygen/make.bat
+++ b/doxygen/make.bat
@@ -1,8 +1,8 @@
@echo off
:: ==========================================================================
:: Product: QP/C++ script for generating Doxygen documentation
-:: Last Updated for Version: 6.0.0
-:: Date of the Last Update: 2017-10-13
+:: Last Updated for Version: 6.0.1
+:: Date of the Last Update: 2017-11-12
::
:: Q u a n t u m L e a P s
:: ---------------------------
@@ -38,7 +38,7 @@ echo usage:
echo make
echo make -CHM
-set VERSION=6.0.0
+set VERSION=6.0.1
:: Generate Resource Standard Metrics for QP/C++ .............................
set DOXHOME="C:\tools\doxygen\bin"
diff --git a/doxygen/metrics.dox b/doxygen/metrics.dox
index cd6743a2..573cc116 100644
--- a/doxygen/metrics.dox
+++ b/doxygen/metrics.dox
@@ -1,7 +1,7 @@
/** @page metrics Code Metrics
@code
- Standard Code Metrics for QP/C++ 6.0.0
+ Standard Code Metrics for QP/C++ 6.0.1
Resource Standard Metrics (TM) for C, C++, C# and Java
Version 7.75 - mSquaredTechnologies.com
@@ -9,7 +9,7 @@
License Type: Windows Single User License
Licensed To : Quantum Leaps, LLC
License No. : WS2975 License Date: Dec 15, 2013
- Build Date : Sep 2 2009 Run Date: Oct 18, 2017
+ Build Date : Sep 2 2009 Run Date: Nov 12, 2017
(C)1996-2009 M Squared Technologies LLC
________________________________________________________________________
@@ -827,12 +827,12 @@
Conditional if / else if: 1
Logical and ( && ) : 1
Complexity Param 1 Return 1 Cyclo Vg 6 Total 8
- LOC 49 eLOC 46 lLOC 30 Comment 30 Lines 67
+ LOC 49 eLOC 46 lLOC 30 Comment 31 Lines 67
Function: QP::QHsm::top
Parameters: (void * const, QEvt const * const)
Complexity Param 2 Return 1 Cyclo Vg 1 Total 4
- LOC 3 eLOC 2 lLOC 1 Comment 15 Lines 3
+ LOC 3 eLOC 2 lLOC 1 Comment 16 Lines 3
Function: QP::QHsm::dispatch
Parameters: (QEvt const * const e)
@@ -852,7 +852,7 @@
Loops while / do : 4
Conditional if / else if: 10
Complexity Param 1 Return 1 Cyclo Vg 15 Total 17
- LOC 99 eLOC 79 lLOC 48 Comment 61 Lines 140
+ LOC 99 eLOC 79 lLOC 48 Comment 62 Lines 140
Function: QP::QHsm::isIn
Parameters: (QStateHandler const s)
@@ -861,7 +861,7 @@
Loops while / do : 1
Conditional if / else if: 1
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 16 eLOC 13 lLOC 9 Comment 21 Lines 23
+ LOC 16 eLOC 13 lLOC 9 Comment 22 Lines 23
Function: QP::QHsm::childState
Parameters: (QStateHandler const parent)
@@ -870,13 +870,13 @@
Loops while / do : 1
Conditional if / else if: 1
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 19 eLOC 16 lLOC 12 Comment 27 Lines 25
+ LOC 19 eLOC 16 lLOC 12 Comment 29 Lines 25
------------------------------------------------------------------------
~~ Total File Summary ~~
- LOC 348 eLOC 302 lLOC 169 Comment 289 Lines 611
+ LOC 348 eLOC 302 lLOC 169 Comment 295 Lines 617
------------------------------------------------------------------------
~~ File Functional Summary ~~
@@ -907,7 +907,7 @@
Function: QP::QMsm::QMsm
Parameters: (QStateHandler const initial)
Complexity Param 1 Return 1 Cyclo Vg 1 Total 3
- LOC 4 eLOC 2 lLOC 2 Comment 13 Lines 4
+ LOC 4 eLOC 2 lLOC 2 Comment 15 Lines 4
Function: QP::QMsm::init
Parameters: (QEvt const * const e)
@@ -923,18 +923,19 @@
Cyclomatic Complexity Vg Detail
Function Base : 1
Loops while / do : 2
- Conditional if / else if: 13
- Complexity Param 1 Return 1 Cyclo Vg 16 Total 18
- LOC 117 eLOC 100 lLOC 61 Comment 73 Lines 159
+ Conditional if / else if: 12
+ Complexity Param 1 Return 1 Cyclo Vg 15 Total 17
+ LOC 112 eLOC 95 lLOC 61 Comment 72 Lines 153
Function: QP::QMsm::execTatbl_
Parameters: (QMTranActTable const * const tatbl)
Cyclomatic Complexity Vg Detail
Function Base : 1
Loops for / foreach : 1
- Conditional if / else if: 6
+ Conditional if / else if: 5
+ Inlined if-else ( ? : ) : 1
Complexity Param 1 Return 1 Cyclo Vg 8 Total 10
- LOC 56 eLOC 46 lLOC 21 Comment 31 Lines 67
+ LOC 53 eLOC 45 lLOC 20 Comment 30 Lines 63
Function: QP::QMsm::exitToTranSource_
Parameters: (QMState const *s, QMState const * const ts)
@@ -952,7 +953,7 @@
Loops while / do : 2
Conditional if / else if: 3
Complexity Param 1 Return 1 Cyclo Vg 6 Total 8
- LOC 40 eLOC 33 lLOC 21 Comment 22 Lines 48
+ LOC 40 eLOC 33 lLOC 21 Comment 23 Lines 48
Function: QP::QMsm::isInState
Parameters: (QMState const * const st)
@@ -970,33 +971,33 @@
Loops for / foreach : 1
Conditional if / else if: 1
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 19 eLOC 14 lLOC 9 Comment 17 Lines 23
+ LOC 19 eLOC 14 lLOC 9 Comment 19 Lines 23
------------------------------------------------------------------------
~~ Total File Summary ~~
- LOC 312 eLOC 259 lLOC 139 Comment 262 Lines 544
+ LOC 304 eLOC 253 lLOC 138 Comment 265 Lines 541
------------------------------------------------------------------------
~~ File Functional Summary ~~
File Function Count....: 8
- Total Function LOC.....: 288 Total Function Pts LOC : 5.9
- Total Function eLOC....: 237 Total Function Pts eLOC: 4.9
- Total Function lLOC....: 137 Total Function Pts lLOC: 2.6
+ Total Function LOC.....: 280 Total Function Pts LOC : 5.7
+ Total Function eLOC....: 231 Total Function Pts eLOC: 4.8
+ Total Function lLOC....: 136 Total Function Pts lLOC: 2.6
Total Function Params .: 9 Total Function Return .: 8
- Total Cyclo Complexity : 44 Total Function Complex.: 61
+ Total Cyclo Complexity : 43 Total Function Complex.: 60
------ ----- ----- ------ ------ -----
- Max Function LOC ......: 117 Average Function LOC ..: 36.00
- Max Function eLOC .....: 100 Average Function eLOC .: 29.63
- Max Function lLOC .....: 61 Average Function lLOC .: 17.13
+ Max Function LOC ......: 112 Average Function LOC ..: 35.00
+ Max Function eLOC .....: 95 Average Function eLOC .: 28.88
+ Max Function lLOC .....: 61 Average Function lLOC .: 17.00
------ ----- ----- ------ ------ -----
Max Function Parameters: 2 Avg Function Parameters: 1.13
Max Function Returns ..: 1 Avg Function Returns ..: 1.00
Max Interface Complex. : 3 Avg Interface Complex. : 2.13
- Max Cyclomatic Complex.: 16 Avg Cyclomatic Complex.: 5.50
- Max Total Complexity ..: 18 Avg Total Complexity ..: 7.63
+ Max Cyclomatic Complex.: 15 Avg Cyclomatic Complex.: 5.38
+ Max Total Complexity ..: 17 Avg Total Complexity ..: 7.50
________________________________________________________________________
End of File: ..\src\qf\qep_msm.cpp
@@ -1893,7 +1894,7 @@
Function Base : 1
Conditional if / else if: 1
Complexity Param 0 Return 1 Cyclo Vg 2 Total 3
- LOC 11 eLOC 9 lLOC 6 Comment 13 Lines 14
+ LOC 11 eLOC 9 lLOC 6 Comment 13 Lines 15
Function: QP::QXK::schedLock
Parameters: (uint_fast8_t const ceiling)
@@ -1928,7 +1929,7 @@
Loops while / do : 1
Conditional if / else if: 6
Complexity Param 0 Return 1 Cyclo Vg 8 Total 9
- LOC 79 eLOC 69 lLOC 35 Comment 53 Lines 108
+ LOC 78 eLOC 68 lLOC 35 Comment 53 Lines 107
Function: QXK_current
Parameters: (void)
@@ -1942,20 +1943,20 @@
~~ Total File Summary ~~
- LOC 292 eLOC 249 lLOC 128 Comment 291 Lines 570
+ LOC 290 eLOC 247 lLOC 127 Comment 292 Lines 568
------------------------------------------------------------------------
~~ File Functional Summary ~~
File Function Count....: 12
- Total Function LOC.....: 235 Total Function Pts LOC : 5.5
- Total Function eLOC....: 201 Total Function Pts eLOC: 4.7
+ Total Function LOC.....: 234 Total Function Pts LOC : 5.5
+ Total Function eLOC....: 200 Total Function Pts eLOC: 4.7
Total Function lLOC....: 112 Total Function Pts lLOC: 2.4
Total Function Params .: 9 Total Function Return .: 12
Total Cyclo Complexity : 35 Total Function Complex.: 56
------ ----- ----- ------ ------ -----
- Max Function LOC ......: 79 Average Function LOC ..: 19.58
- Max Function eLOC .....: 69 Average Function eLOC .: 16.75
+ Max Function LOC ......: 78 Average Function LOC ..: 19.50
+ Max Function eLOC .....: 68 Average Function eLOC .: 16.67
Max Function lLOC .....: 35 Average Function lLOC .: 9.33
------ ----- ----- ------ ------ -----
Max Function Parameters: 6 Avg Function Parameters: 0.75
@@ -1971,7 +1972,7 @@
________________________________________________________________________
Function: QP::QXMutex::init
- Parameters: (uint_fast8_t ceiling)
+ Parameters: (uint_fast8_t const ceiling)
Cyclomatic Complexity Vg Detail
Function Base : 1
Conditional if / else if: 1
@@ -2054,7 +2055,7 @@
Conditional if / else if: 1
Logical and ( && ) : 3
Complexity Param 1 Return 1 Cyclo Vg 5 Total 7
- LOC 28 eLOC 25 lLOC 17 Comment 36 Lines 41
+ LOC 28 eLOC 25 lLOC 17 Comment 37 Lines 42
Function: QP::QXSemaphore::tryWait
Parameters: (void)
@@ -2069,35 +2070,35 @@
Cyclomatic Complexity Vg Detail
Function Base : 1
Conditional if / else if: 3
- Logical and ( && ) : 2
- Complexity Param 0 Return 1 Cyclo Vg 6 Total 7
- LOC 29 eLOC 23 lLOC 14 Comment 26 Lines 39
+ Logical and ( && ) : 3
+ Complexity Param 0 Return 1 Cyclo Vg 7 Total 8
+ LOC 30 eLOC 24 lLOC 14 Comment 28 Lines 41
------------------------------------------------------------------------
~~ Total File Summary ~~
- LOC 95 eLOC 80 lLOC 43 Comment 144 Lines 240
+ LOC 96 eLOC 81 lLOC 43 Comment 147 Lines 244
------------------------------------------------------------------------
~~ File Functional Summary ~~
File Function Count....: 4
- Total Function LOC.....: 78 Total Function Pts LOC : 1.8
- Total Function eLOC....: 64 Total Function Pts eLOC: 1.5
+ Total Function LOC.....: 79 Total Function Pts LOC : 1.8
+ Total Function eLOC....: 65 Total Function Pts eLOC: 1.5
Total Function lLOC....: 43 Total Function Pts lLOC: 0.8
Total Function Params .: 3 Total Function Return .: 4
- Total Cyclo Complexity : 14 Total Function Complex.: 21
+ Total Cyclo Complexity : 15 Total Function Complex.: 22
------ ----- ----- ------ ------ -----
- Max Function LOC ......: 29 Average Function LOC ..: 19.50
- Max Function eLOC .....: 25 Average Function eLOC .: 16.00
+ Max Function LOC ......: 30 Average Function LOC ..: 19.75
+ Max Function eLOC .....: 25 Average Function eLOC .: 16.25
Max Function lLOC .....: 17 Average Function lLOC .: 10.75
------ ----- ----- ------ ------ -----
Max Function Parameters: 2 Avg Function Parameters: 0.75
Max Function Returns ..: 1 Avg Function Returns ..: 1.00
Max Interface Complex. : 3 Avg Interface Complex. : 1.75
- Max Cyclomatic Complex.: 6 Avg Cyclomatic Complex.: 3.50
- Max Total Complexity ..: 7 Avg Total Complexity ..: 5.25
+ Max Cyclomatic Complex.: 7 Avg Cyclomatic Complex.: 3.75
+ Max Total Complexity ..: 8 Avg Total Complexity ..: 5.50
________________________________________________________________________
End of File: ..\src\qxk\qxk_sema.cpp
@@ -2108,7 +2109,7 @@
Function: QP::QXThread::QXThread
Parameters: (QXThreadHandler const handler, uint_fast8_t const tickRate)
Complexity Param 2 Return 1 Cyclo Vg 1 Total 4
- LOC 3 eLOC 1 lLOC 1 Comment 18 Lines 3
+ LOC 3 eLOC 1 lLOC 1 Comment 19 Lines 3
Function: QP::QXThread::init
Parameters: (QEvt const * const)
@@ -2205,7 +2206,7 @@
~~ Total File Summary ~~
- LOC 292 eLOC 243 lLOC 138 Comment 319 Lines 611
+ LOC 292 eLOC 243 lLOC 138 Comment 320 Lines 612
------------------------------------------------------------------------
~~ File Functional Summary ~~
@@ -2238,7 +2239,7 @@
~~ Total Project Summary ~~
- LOC 4915 eLOC 4348 lLOC 1895 Comment 6484 Lines 11684
+ LOC 4906 eLOC 4341 lLOC 1893 Comment 6498 Lines 11690
Average per File, metric/37 files
LOC 132 eLOC 117 lLOC 51 Comment 175 Lines 315
@@ -2596,12 +2597,12 @@
Function: QP::QHsm::init
Parameters: (QEvt const * const e)
Complexity Param 1 Return 1 Cyclo Vg 6 Total 8
- LOC 49 eLOC 46 lLOC 30 Comment 30 Lines 67
+ LOC 49 eLOC 46 lLOC 30 Comment 31 Lines 67
Function: QP::QHsm::top
Parameters: (void * const, QEvt const * const)
Complexity Param 2 Return 1 Cyclo Vg 1 Total 4
- LOC 3 eLOC 2 lLOC 1 Comment 15 Lines 3
+ LOC 3 eLOC 2 lLOC 1 Comment 16 Lines 3
Function: QP::QHsm::dispatch
Parameters: (QEvt const * const e)
@@ -2611,22 +2612,22 @@
Function: QP::QHsm::hsm_tran
Parameters: (QStateHandler (&path)[MAX_NEST_DEPTH_])
Complexity Param 1 Return 1 Cyclo Vg 15 Total 17
- LOC 99 eLOC 79 lLOC 48 Comment 61 Lines 140
+ LOC 99 eLOC 79 lLOC 48 Comment 62 Lines 140
Function: QP::QHsm::isIn
Parameters: (QStateHandler const s)
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 16 eLOC 13 lLOC 9 Comment 21 Lines 23
+ LOC 16 eLOC 13 lLOC 9 Comment 22 Lines 23
Function: QP::QHsm::childState
Parameters: (QStateHandler const parent)
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 19 eLOC 16 lLOC 12 Comment 27 Lines 25
+ LOC 19 eLOC 16 lLOC 12 Comment 29 Lines 25
Function: QP::QMsm::QMsm
Parameters: (QStateHandler const initial)
Complexity Param 1 Return 1 Cyclo Vg 1 Total 3
- LOC 4 eLOC 2 lLOC 2 Comment 13 Lines 4
+ LOC 4 eLOC 2 lLOC 2 Comment 15 Lines 4
Function: QP::QMsm::init
Parameters: (QEvt const * const e)
@@ -2635,13 +2636,13 @@
Function: QP::QMsm::dispatch
Parameters: (QEvt const * const e)
- Complexity Param 1 Return 1 Cyclo Vg 16 Total 18
- LOC 117 eLOC 100 lLOC 61 Comment 73 Lines 159
+ Complexity Param 1 Return 1 Cyclo Vg 15 Total 17
+ LOC 112 eLOC 95 lLOC 61 Comment 72 Lines 153
Function: QP::QMsm::execTatbl_
Parameters: (QMTranActTable const * const tatbl)
Complexity Param 1 Return 1 Cyclo Vg 8 Total 10
- LOC 56 eLOC 46 lLOC 21 Comment 31 Lines 67
+ LOC 53 eLOC 45 lLOC 20 Comment 30 Lines 63
Function: QP::QMsm::exitToTranSource_
Parameters: (QMState const *s, QMState const * const ts)
@@ -2651,7 +2652,7 @@
Function: QP::QMsm::enterHistory_
Parameters: (QMState const * const hist)
Complexity Param 1 Return 1 Cyclo Vg 6 Total 8
- LOC 40 eLOC 33 lLOC 21 Comment 22 Lines 48
+ LOC 40 eLOC 33 lLOC 21 Comment 23 Lines 48
Function: QP::QMsm::isInState
Parameters: (QMState const * const st)
@@ -2661,7 +2662,7 @@
Function: QP::QMsm::childStateObj
Parameters: (QMState const * const parent)
Complexity Param 1 Return 1 Cyclo Vg 3 Total 5
- LOC 19 eLOC 14 lLOC 9 Comment 17 Lines 23
+ LOC 19 eLOC 14 lLOC 9 Comment 19 Lines 23
Function: QP::QF::add_
Parameters: (QActive * const a)
@@ -3006,7 +3007,7 @@
Function: QP::QActive::stop
Parameters: (void)
Complexity Param 0 Return 1 Cyclo Vg 2 Total 3
- LOC 11 eLOC 9 lLOC 6 Comment 13 Lines 14
+ LOC 11 eLOC 9 lLOC 6 Comment 13 Lines 15
Function: QP::QXK::schedLock
Parameters: (uint_fast8_t const ceiling)
@@ -3026,7 +3027,7 @@
Function: QXK_activate_
Parameters: (void)
Complexity Param 0 Return 1 Cyclo Vg 8 Total 9
- LOC 79 eLOC 69 lLOC 35 Comment 53 Lines 108
+ LOC 78 eLOC 68 lLOC 35 Comment 53 Lines 107
Function: QXK_current
Parameters: (void)
@@ -3034,7 +3035,7 @@
LOC 14 eLOC 12 lLOC 8 Comment 4 Lines 21
Function: QP::QXMutex::init
- Parameters: (uint_fast8_t ceiling)
+ Parameters: (uint_fast8_t const ceiling)
Complexity Param 1 Return 1 Cyclo Vg 4 Total 6
LOC 16 eLOC 14 lLOC 8 Comment 30 Lines 24
@@ -3061,7 +3062,7 @@
Function: QP::QXSemaphore::wait
Parameters: (uint_fast16_t const nTicks)
Complexity Param 1 Return 1 Cyclo Vg 5 Total 7
- LOC 28 eLOC 25 lLOC 17 Comment 36 Lines 41
+ LOC 28 eLOC 25 lLOC 17 Comment 37 Lines 42
Function: QP::QXSemaphore::tryWait
Parameters: (void)
@@ -3070,13 +3071,13 @@
Function: QP::QXSemaphore::signal
Parameters: (void)
- Complexity Param 0 Return 1 Cyclo Vg 6 Total 7
- LOC 29 eLOC 23 lLOC 14 Comment 26 Lines 39
+ Complexity Param 0 Return 1 Cyclo Vg 7 Total 8
+ LOC 30 eLOC 24 lLOC 14 Comment 28 Lines 41
Function: QP::QXThread::QXThread
Parameters: (QXThreadHandler const handler, uint_fast8_t const tickRate)
Complexity Param 2 Return 1 Cyclo Vg 1 Total 4
- LOC 3 eLOC 1 lLOC 1 Comment 18 Lines 3
+ LOC 3 eLOC 1 lLOC 1 Comment 19 Lines 3
Function: QP::QXThread::init
Parameters: (QEvt const * const)
@@ -3141,29 +3142,29 @@
LOC 14 eLOC 11 lLOC 7 Comment 2 Lines 16
Total: Functions
- LOC 2785 eLOC 2317 lLOC 1373 InCmp 340 CycloCmp 480
- Function Points FP(LOC) 47.5 FP(eLOC) 40.1 FP(lLOC) 24.0
+ LOC 2777 eLOC 2311 lLOC 1372 InCmp 340 CycloCmp 480
+ Function Points FP(LOC) 47.4 FP(eLOC) 40.0 FP(lLOC) 24.0
------------------------------------------------------------------------
~~ Project Functional Analysis ~~
- Total Functions .......: 175 Total Physical Lines ..: 3850
- Total LOC .............: 2785 Total Function Pts LOC : 47.5
- Total eLOC ............: 2317 Total Function Pts eLOC: 40.1
- Total lLOC.............: 1373 Total Function Pts lLOC: 24.0
+ Total Functions .......: 175 Total Physical Lines ..: 3843
+ Total LOC .............: 2777 Total Function Pts LOC : 47.4
+ Total eLOC ............: 2311 Total Function Pts eLOC: 40.0
+ Total lLOC.............: 1372 Total Function Pts lLOC: 24.0
Total Cyclomatic Comp. : 480 Total Interface Comp. .: 340
Total Parameters ......: 165 Total Return Points ...: 175
- Total Comment Lines ...: 2715 Total Blank Lines .....: 520
+ Total Comment Lines ...: 2728 Total Blank Lines .....: 520
------ ----- ----- ------ ------ -----
- Avg Physical Lines ....: 22.00
- Avg LOC ...............: 15.91 Avg eLOC ..............: 13.24
- Avg lLOC ..............: 7.85 Avg Cyclomatic Comp. ..: 2.74
+ Avg Physical Lines ....: 21.96
+ Avg LOC ...............: 15.87 Avg eLOC ..............: 13.21
+ Avg lLOC ..............: 7.84 Avg Cyclomatic Comp. ..: 2.74
Avg Interface Comp. ...: 1.94 Avg Parameters ........: 0.94
- Avg Return Points .....: 1.00 Avg Comment Lines .....: 15.51
+ Avg Return Points .....: 1.00 Avg Comment Lines .....: 15.59
------ ----- ----- ------ ------ -----
- Max LOC ...............: 117
- Max eLOC ..............: 100 Max lLOC ..............: 61
+ Max LOC ...............: 112
+ Max eLOC ..............: 96 Max lLOC ..............: 61
Max Cyclomatic Comp. ..: 18 Max Interface Comp. ...: 7
Max Parameters ........: 6 Max Return Points .....: 1
Max Comment Lines .....: 111 Max Total Lines .......: 191
diff --git a/doxygen/ports_os.dox b/doxygen/ports_os.dox
index fb3a1ab5..a76f3675 100644
--- a/doxygen/ports_os.dox
+++ b/doxygen/ports_os.dox
@@ -28,21 +28,55 @@ The standard QP/C++ distribution contains the POSIX port and @ref exa_posix "Exa
/*##########################################################################*/
/*! @page qt Qt GUI Framework
-@image html logo_qt.jpg
+The QP/C++ ports and examples for [Qt](https://www.qt.io/) are described in the Quantum Leaps Application Note QP and the Qt GUI Framework.
+
-@image html under_construction.jpg
+@htmlonly
+
+
+
+Application Note: QP and the Qt GUI Framework
+
+
The QP/C/C++ ports and examples for Windows (e.g., Windows Embedded, WindowsCE etc.) are described in the Quantum Leaps Application Note QP and Win32 (Windows).
+
+
+@htmlonly
+
+
+
+Application Note: QP and Win32 (Windows)
+
+
The QP/C/C++ ports and examples for Windows with single-thread (like the @ref qv "QV cooperative kernel") are described in the Quantum Leaps Application Note QP and Win32 (Windows).
+
+
+@htmlonly
+
+
+
+Application Note: QP and Win32 (Windows)
+
+
: QHsm(Q_STATE_CAST(&Philo::initial)),
+ m_timeEvt(AO_Table, this, TIMEOUT_SIG, 0U)
+
+
+
+ static bool registered = false; // starts off with 0, per C-standard
+(void)e; // suppress the compiler warning about unused parameter
+if (!registered) {
+ registered = true;
+ QS_FUN_DICTIONARY(&Philo::initial);
+ QS_FUN_DICTIONARY(&Philo::thinking);
+ QS_FUN_DICTIONARY(&Philo::hungry);
+ QS_FUN_DICTIONARY(&Philo::eating);
+}
+QS_SIG_DICTIONARY(HUNGRY_SIG, me); // signal for each Philos
+
+
+
+
+
+ me->m_timeEvt.armX(think_time(), 0U);
+ (void)me->m_timeEvt.disarm();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TableEvt *pe = Q_NEW(TableEvt, HUNGRY_SIG);
+pe->philo = me;
+AO_Table->postLIFO(pe);
+
+
+
+
+
+
+
+
+
+
+ me->m_timeEvt.armX(eat_time(), 0U);
+ (void)me->m_timeEvt.disarm();
+
+// asynchronously post event to the Container
+TableEvt *pe = Q_NEW(TableEvt, DONE_SIG);
+pe->philo = me;
+AO_Table->postLIFO(pe);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #include "qpcpp.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+namespace DPP {
+
+// helper function to provide a randomized think time for Philos
+inline QP::QTimeEvtCtr think_time() {
+ return static_cast<QP::QTimeEvtCtr>((BSP::random() % BSP::TICKS_PER_SEC)
+ + (BSP::TICKS_PER_SEC/2U));
+}
+
+// helper function to provide a randomized eat time for Philos
+inline QP::QTimeEvtCtr eat_time() {
+ return static_cast<QP::QTimeEvtCtr>((BSP::random() % BSP::TICKS_PER_SEC)
+ + BSP::TICKS_PER_SEC);
+}
+
+} // namespace DPP
+
+// Philo definition ----------------------------------------------------------
+$define(Comp::Philo)
+
+
+
diff --git a/examples/win32/dpp-comp/comp/philo.cpp b/examples/win32/dpp-comp/comp/philo.cpp
new file mode 100644
index 00000000..915efabd
--- /dev/null
+++ b/examples/win32/dpp-comp/comp/philo.cpp
@@ -0,0 +1,162 @@
+//$file${Comp::.::philo.cpp} #################################################
+//
+// Model: dpp.qm
+// File: C:/qp_lab/qpcpp/examples/win32/dpp-comp/comp/philo.cpp
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
+// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
+//
+// This program is open source software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published
+// by the Free Software Foundation.
+//
+// This program is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+// for more details.
+//
+//$endhead${Comp::.::philo.cpp} ##############################################
+#include "qpcpp.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+namespace DPP {
+
+// helper function to provide a randomized think time for Philos
+inline QP::QTimeEvtCtr think_time() {
+ return static_cast((BSP::random() % BSP::TICKS_PER_SEC)
+ + (BSP::TICKS_PER_SEC/2U));
+}
+
+// helper function to provide a randomized eat time for Philos
+inline QP::QTimeEvtCtr eat_time() {
+ return static_cast((BSP::random() % BSP::TICKS_PER_SEC)
+ + BSP::TICKS_PER_SEC);
+}
+
+} // namespace DPP
+
+// Philo definition ----------------------------------------------------------
+//$define${Comp::Philo} ######################################################
+// Check for the minimum required QP version
+#if ((QP_VERSION < 601) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
+#error qpcpp version 6.0.1 or higher required
+#endif
+namespace DPP {
+
+//${Comp::Philo} .............................................................
+//${Comp::Philo::Philo} ......................................................
+Philo::Philo()
+ : QHsm(Q_STATE_CAST(&Philo::initial)),
+ m_timeEvt(AO_Table, this, TIMEOUT_SIG, 0U)
+{}
+
+//${Comp::Philo::SM} .........................................................
+QP::QState Philo::initial(Philo * const me, QP::QEvt const * const e) {
+ //${Comp::Philo::SM::initial}
+ static bool registered = false; // starts off with 0, per C-standard
+ (void)e; // suppress the compiler warning about unused parameter
+ if (!registered) {
+ registered = true;
+ QS_FUN_DICTIONARY(&Philo::initial);
+ QS_FUN_DICTIONARY(&Philo::thinking);
+ QS_FUN_DICTIONARY(&Philo::hungry);
+ QS_FUN_DICTIONARY(&Philo::eating);
+ }
+ QS_SIG_DICTIONARY(HUNGRY_SIG, me); // signal for each Philos
+ return Q_TRAN(&thinking);
+}
+//${Comp::Philo::SM::thinking} ...............................................
+QP::QState Philo::thinking(Philo * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Comp::Philo::SM::thinking}
+ case Q_ENTRY_SIG: {
+ me->m_timeEvt.armX(think_time(), 0U);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Comp::Philo::SM::thinking}
+ case Q_EXIT_SIG: {
+ (void)me->m_timeEvt.disarm();
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Comp::Philo::SM::thinking::TIMEOUT}
+ case TIMEOUT_SIG: {
+ status_ = Q_TRAN(&hungry);
+ break;
+ }
+ //${Comp::Philo::SM::thinking::TEST}
+ case TEST_SIG: {
+ status_ = Q_HANDLED();
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&top);
+ break;
+ }
+ }
+ return status_;
+}
+//${Comp::Philo::SM::hungry} .................................................
+QP::QState Philo::hungry(Philo * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Comp::Philo::SM::hungry}
+ case Q_ENTRY_SIG: {
+ TableEvt *pe = Q_NEW(TableEvt, HUNGRY_SIG);
+ pe->philo = me;
+ AO_Table->postLIFO(pe);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Comp::Philo::SM::hungry::EAT}
+ case EAT_SIG: {
+ status_ = Q_TRAN(&eating);
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&top);
+ break;
+ }
+ }
+ return status_;
+}
+//${Comp::Philo::SM::eating} .................................................
+QP::QState Philo::eating(Philo * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Comp::Philo::SM::eating}
+ case Q_ENTRY_SIG: {
+ me->m_timeEvt.armX(eat_time(), 0U);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Comp::Philo::SM::eating}
+ case Q_EXIT_SIG: {
+ (void)me->m_timeEvt.disarm();
+
+ // asynchronously post event to the Container
+ TableEvt *pe = Q_NEW(TableEvt, DONE_SIG);
+ pe->philo = me;
+ AO_Table->postLIFO(pe);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Comp::Philo::SM::eating::TIMEOUT}
+ case TIMEOUT_SIG: {
+ status_ = Q_TRAN(&thinking);
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&top);
+ break;
+ }
+ }
+ return status_;
+}
+
+} // namespace DPP//$enddef${Comp::Philo} ######################################################
diff --git a/examples/win32/dpp-comp/cont/cont.qmp b/examples/win32/dpp-comp/cont/cont.qmp
new file mode 100644
index 00000000..d4d0f0c5
--- /dev/null
+++ b/examples/win32/dpp-comp/cont/cont.qmp
@@ -0,0 +1,337 @@
+
+
+
+
+
+
+ Specialized time event for components. The time evnet can be owned by a component and can dispatch itself to the component.
+
+
+ The constructor to initialize a Component Time Event.
+
+When creating a time event, you must commit it to a specific active object 'act', event signal 'sig', and tick rate 'tickRate'. You cannot change these attributes later.
+
+
+
+
+ : QTimeEvt(act, sig, tickRate)
+
+m_comp = comp;
+
+
+ m_comp->dispatch(this);
+
+
+
+
+ Embedded component state machine objects
+
+
+
+
+ : QActive(Q_STATE_CAST(&Table::initial))
+
+for (uint8_t n = 0U; n < N_PHILO; ++n) {
+ m_fork[n] = FREE;
+ m_isHungry[n] = false;
+}
+
+
+
+ (void)e; // suppress the compiler warning about unused parameter
+
+QS_OBJ_DICTIONARY(&l_table);
+QS_FUN_DICTIONARY(&Table::initial);
+QS_FUN_DICTIONARY(&Table::active);
+QS_FUN_DICTIONARY(&Table::serving);
+QS_FUN_DICTIONARY(&Table::paused);
+
+QS_SIG_DICTIONARY(DONE_SIG, (void *)0); // global signals
+QS_SIG_DICTIONARY(EAT_SIG, (void *)0);
+QS_SIG_DICTIONARY(PAUSE_SIG, (void *)0);
+QS_SIG_DICTIONARY(SERVE_SIG, (void *)0);
+QS_SIG_DICTIONARY(TEST_SIG, (void *)0);
+
+QS_SIG_DICTIONARY(TIMEOUT_SIG, me); // signal just for Table
+QS_SIG_DICTIONARY(HUNGRY_SIG, me); // signal just for Table
+
+me->subscribe(PAUSE_SIG);
+me->subscribe(SERVE_SIG);
+me->subscribe(TEST_SIG);
+
+for (uint8_t n = 0U; n < N_PHILO; ++n) {
+ me->m_philo[n].init(); // top-most initial tran.
+ me->m_fork[n] = FREE;
+ me->m_isHungry[n] = false;
+ BSP::displayPhilStat(n, THINKING);
+}
+
+
+
+
+
+
+ Q_EVT_CAST(CompTimeEvt)->dispatchToComp();
+
+
+
+
+
+ Q_ERROR();
+
+
+
+
+
+
+
+
+
+
+ for (uint8_t n = 0U; n < N_PHILO; ++n) { // give permissions to eat...
+ if (me->m_isHungry[n]
+ && (me->m_fork[LEFT(n)] == FREE)
+ && (me->m_fork[n] == FREE))
+ {
+ me->m_fork[LEFT(n)] = USED;
+ me->m_fork[n] = USED;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[n];
+ me->m_philo[n].dispatch(&evt);
+
+ me->m_isHungry[n] = false;
+ BSP::displayPhilStat(n, EATING);
+ }
+}
+
+ // find the index of the Philo from the event
+uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+// philo ID must be in range and he must be not hungry
+Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+BSP::displayPhilStat(n, HUNGRY);
+uint8_t m = LEFT(n);
+
+ (me->m_fork[m] == FREE) && (me->m_fork[n] == FREE)
+ me->m_fork[m] = USED;
+me->m_fork[n] = USED;
+
+// synchronoulsy dispatch EAT event to the Philo component
+TableEvt evt;
+evt.sig = EAT_SIG;
+evt.philo = &me->m_philo[n];
+me->m_philo[n].dispatch(&evt);
+
+BSP::displayPhilStat(n, EATING);
+
+
+
+
+
+ else
+ me->m_isHungry[n] = true;
+
+
+
+
+
+
+
+
+
+ // find the index of the Philo from the event
+uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+// philo ID must be in range and he must be not hungry
+Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+BSP::displayPhilStat(n, THINKING);
+uint8_t m = LEFT(n);
+// both forks of Phil[n] must be used
+Q_ASSERT((me->m_fork[n] == USED) && (me->m_fork[m] == USED));
+
+me->m_fork[m] = FREE;
+me->m_fork[n] = FREE;
+m = RIGHT(n); // check the right neighbor
+
+if (me->m_isHungry[m] && (me->m_fork[m] == FREE)) {
+ me->m_fork[n] = USED;
+ me->m_fork[m] = USED;
+ me->m_isHungry[m] = false;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[m];
+ me->m_philo[m].dispatch(&evt);
+
+ BSP::displayPhilStat(m, EATING);
+}
+m = LEFT(n); // check the left neighbor
+n = LEFT(m); // left fork of the left neighbor
+if (me->m_isHungry[m] && (me->m_fork[n] == FREE)) {
+ me->m_fork[m] = USED;
+ me->m_fork[n] = USED;
+ me->m_isHungry[m] = false;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[m];
+ me->m_philo[m].dispatch(&evt);
+
+ BSP::displayPhilStat(m, EATING);
+}
+
+
+
+
+
+ Q_ERROR();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BSP::displayPaused(1U);
+ BSP::displayPaused(0U);
+
+
+
+
+
+
+ // find the index of the Philo from the event
+uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+// philo ID must be in range and he must be not hungry
+Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+me->m_isHungry[n] = true;
+BSP::displayPhilStat(n, HUNGRY);
+
+
+
+
+
+ // find the index of the Philo from the event
+uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+// philo ID must be in range and he must be not hungry
+Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+BSP::displayPhilStat(n, THINKING);
+
+uint8_t m = LEFT(n);
+// both forks of Phil[n] must be used
+Q_ASSERT((me->m_fork[n] == USED) && (me->m_fork[m] == USED));
+
+me->m_fork[m] = FREE;
+me->m_fork[n] = FREE;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #ifndef dpp_h
+#define dpp_h
+
+namespace DPP {
+
+enum DPPSignals {
+ EAT_SIG = QP::Q_USER_SIG, // published by Table to let a philosopher eat
+ DONE_SIG, // published by Philosopher when done eating
+ PAUSE_SIG, // published by BSP to pause the application
+ SERVE_SIG, // published by BSP to serve re-start serving forks
+ TEST_SIG, // published by BSP to test the application
+ MAX_PUB_SIG, // the last published signal
+
+ HUNGRY_SIG, // posted direclty to Table from hungry Philo
+ TIMEOUT_SIG, // used by the component time events
+ MAX_SIG // the last signal
+};
+
+class Philo; // forward declaration
+
+} // namespace DPP
+
+enum {
+ N_PHILO = 5 // number of Philos
+};
+
+$declare(Cont::CompTimeEvt)
+
+$declare(Cont::AO_Table)
+
+$declare(Comp::Philo)
+
+$declare(Cont::TableEvt)
+
+#endif // dpp_h
+
+
+ #include "qpcpp.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+// Active object class -------------------------------------------------------
+$declare(Cont::Table)
+
+namespace DPP {
+
+// helper function to provide the RIGHT neighbour of a Philo[n]
+inline uint8_t RIGHT(uint8_t const n) {
+ return static_cast<uint8_t>((n + (N_PHILO - 1U)) % N_PHILO);
+}
+
+// helper function to provide the LEFT neighbour of a Philo[n]
+inline uint8_t LEFT(uint8_t const n) {
+ return static_cast<uint8_t>((n + 1U) % N_PHILO);
+}
+
+static uint8_t const FREE = static_cast<uint8_t>(0);
+static uint8_t const USED = static_cast<uint8_t>(1);
+
+static char_t const * const THINKING = &"thinking"[0];
+static char_t const * const HUNGRY = &"hungry "[0];
+static char_t const * const EATING = &"eating "[0];
+
+// Local objects -------------------------------------------------------------
+static Table l_table; // the single instance of the Table active object
+
+// Global-scope objects ------------------------------------------------------
+QP::QActive * const AO_Table = &l_table; // "opaque" AO pointer
+
+} // namespace DPP
+
+
+//............................................................................
+$define(Cont::CompTimeEvt)
+
+$define(Cont::Table)
+
+
+
diff --git a/examples/win32/dpp-comp/cont/dpp.h b/examples/win32/dpp-comp/cont/dpp.h
new file mode 100644
index 00000000..2a45229e
--- /dev/null
+++ b/examples/win32/dpp-comp/cont/dpp.h
@@ -0,0 +1,104 @@
+//$file${Cont::.::dpp.h} #####################################################
+//
+// Model: dpp.qm
+// File: C:/qp_lab/qpcpp/examples/win32/dpp-comp/cont/dpp.h
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
+// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
+//
+// This program is open source software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published
+// by the Free Software Foundation.
+//
+// This program is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+// for more details.
+//
+//$endhead${Cont::.::dpp.h} ##################################################
+#ifndef dpp_h
+#define dpp_h
+
+namespace DPP {
+
+enum DPPSignals {
+ EAT_SIG = QP::Q_USER_SIG, // published by Table to let a philosopher eat
+ DONE_SIG, // published by Philosopher when done eating
+ PAUSE_SIG, // published by BSP to pause the application
+ SERVE_SIG, // published by BSP to serve re-start serving forks
+ TEST_SIG, // published by BSP to test the application
+ MAX_PUB_SIG, // the last published signal
+
+ HUNGRY_SIG, // posted direclty to Table from hungry Philo
+ TIMEOUT_SIG, // used by the component time events
+ MAX_SIG // the last signal
+};
+
+class Philo; // forward declaration
+
+} // namespace DPP
+
+enum {
+ N_PHILO = 5 // number of Philos
+};
+
+//$declare${Cont::CompTimeEvt} ###############################################
+namespace DPP {
+
+//${Cont::CompTimeEvt} .......................................................
+class CompTimeEvt : public QP::QTimeEvt {
+public:
+ QP::QHsm * m_comp;
+
+public:
+ CompTimeEvt(
+ QP::QActive * act,
+ QP::QHsm * comp,
+ enum_t const sig,
+ uint_fast8_t const tickRate);
+ void dispatchToComp() const {
+ m_comp->dispatch(this);
+ }
+};
+
+} // namespace DPP//$enddecl${Cont::CompTimeEvt} ###############################################
+
+//$declare${Cont::AO_Table} ##################################################
+namespace DPP {
+
+extern QP::QActive * const AO_Table;
+
+} // namespace DPP//$enddecl${Cont::AO_Table} ##################################################
+
+//$declare${Comp::Philo} #####################################################
+namespace DPP {
+
+//${Comp::Philo} .............................................................
+class Philo : public QP::QHsm {
+private:
+ CompTimeEvt m_timeEvt;
+
+public:
+ Philo();
+
+protected:
+ static QP::QState initial(Philo * const me, QP::QEvt const * const e);
+ static QP::QState thinking(Philo * const me, QP::QEvt const * const e);
+ static QP::QState hungry(Philo * const me, QP::QEvt const * const e);
+ static QP::QState eating(Philo * const me, QP::QEvt const * const e);
+};
+
+} // namespace DPP//$enddecl${Comp::Philo} #####################################################
+
+//$declare${Cont::TableEvt} ##################################################
+namespace DPP {
+
+//${Cont::TableEvt} ..........................................................
+class TableEvt : public QP::QEvt {
+public:
+ DPP::Philo * philo;
+};
+
+} // namespace DPP//$enddecl${Cont::TableEvt} ##################################################
+
+#endif // dpp_h
\ No newline at end of file
diff --git a/examples/win32/dpp-comp/cont/table.cpp b/examples/win32/dpp-comp/cont/table.cpp
new file mode 100644
index 00000000..fdc55a15
--- /dev/null
+++ b/examples/win32/dpp-comp/cont/table.cpp
@@ -0,0 +1,354 @@
+//$file${Cont::.::table.cpp} #################################################
+//
+// Model: dpp.qm
+// File: C:/qp_lab/qpcpp/examples/win32/dpp-comp/cont/table.cpp
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
+// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
+//
+// This program is open source software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published
+// by the Free Software Foundation.
+//
+// This program is distributed in the hope that it will be useful, but
+// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+// for more details.
+//
+//$endhead${Cont::.::table.cpp} ##############################################
+#include "qpcpp.h"
+#include "dpp.h"
+#include "bsp.h"
+
+Q_DEFINE_THIS_FILE
+
+// Active object class -------------------------------------------------------
+//$declare${Cont::Table} #####################################################
+namespace DPP {
+
+//${Cont::Table} .............................................................
+class Table : public QP::QActive {
+private:
+ Philo m_philo[N_PHILO];
+ uint8_t m_fork[N_PHILO];
+ bool m_isHungry[N_PHILO];
+
+public:
+ Table();
+
+protected:
+ static QP::QState initial(Table * const me, QP::QEvt const * const e);
+ static QP::QState active(Table * const me, QP::QEvt const * const e);
+ static QP::QState serving(Table * const me, QP::QEvt const * const e);
+ static QP::QState paused(Table * const me, QP::QEvt const * const e);
+};
+
+} // namespace DPP//$enddecl${Cont::Table} #####################################################
+
+namespace DPP {
+
+// helper function to provide the RIGHT neighbour of a Philo[n]
+inline uint8_t RIGHT(uint8_t const n) {
+ return static_cast((n + (N_PHILO - 1U)) % N_PHILO);
+}
+
+// helper function to provide the LEFT neighbour of a Philo[n]
+inline uint8_t LEFT(uint8_t const n) {
+ return static_cast((n + 1U) % N_PHILO);
+}
+
+static uint8_t const FREE = static_cast(0);
+static uint8_t const USED = static_cast(1);
+
+static char_t const * const THINKING = &"thinking"[0];
+static char_t const * const HUNGRY = &"hungry "[0];
+static char_t const * const EATING = &"eating "[0];
+
+// Local objects -------------------------------------------------------------
+static Table l_table; // the single instance of the Table active object
+
+// Global-scope objects ------------------------------------------------------
+QP::QActive * const AO_Table = &l_table; // "opaque" AO pointer
+
+} // namespace DPP
+
+
+//............................................................................
+//$define${Cont::CompTimeEvt} ################################################
+// Check for the minimum required QP version
+#if ((QP_VERSION < 601) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
+#error qpcpp version 6.0.1 or higher required
+#endif
+namespace DPP {
+
+//${Cont::CompTimeEvt} .......................................................
+//${Cont::CompTimeEvt::CompTimeEvt} ..........................................
+CompTimeEvt::CompTimeEvt(
+ QP::QActive * act,
+ QP::QHsm * comp,
+ enum_t const sig,
+ uint_fast8_t const tickRate)
+ : QTimeEvt(act, sig, tickRate)
+{
+ m_comp = comp;
+}
+
+
+} // namespace DPP//$enddef${Cont::CompTimeEvt} ################################################
+
+//$define${Cont::Table} ######################################################
+namespace DPP {
+
+//${Cont::Table} .............................................................
+//${Cont::Table::Table} ......................................................
+Table::Table()
+ : QActive(Q_STATE_CAST(&Table::initial))
+{
+ for (uint8_t n = 0U; n < N_PHILO; ++n) {
+ m_fork[n] = FREE;
+ m_isHungry[n] = false;
+ }
+}
+
+//${Cont::Table::SM} .........................................................
+QP::QState Table::initial(Table * const me, QP::QEvt const * const e) {
+ //${Cont::Table::SM::initial}
+ (void)e; // suppress the compiler warning about unused parameter
+
+ QS_OBJ_DICTIONARY(&l_table);
+ QS_FUN_DICTIONARY(&Table::initial);
+ QS_FUN_DICTIONARY(&Table::active);
+ QS_FUN_DICTIONARY(&Table::serving);
+ QS_FUN_DICTIONARY(&Table::paused);
+
+ QS_SIG_DICTIONARY(DONE_SIG, (void *)0); // global signals
+ QS_SIG_DICTIONARY(EAT_SIG, (void *)0);
+ QS_SIG_DICTIONARY(PAUSE_SIG, (void *)0);
+ QS_SIG_DICTIONARY(SERVE_SIG, (void *)0);
+ QS_SIG_DICTIONARY(TEST_SIG, (void *)0);
+
+ QS_SIG_DICTIONARY(TIMEOUT_SIG, me); // signal just for Table
+ QS_SIG_DICTIONARY(HUNGRY_SIG, me); // signal just for Table
+
+ me->subscribe(PAUSE_SIG);
+ me->subscribe(SERVE_SIG);
+ me->subscribe(TEST_SIG);
+
+ for (uint8_t n = 0U; n < N_PHILO; ++n) {
+ me->m_philo[n].init(); // top-most initial tran.
+ me->m_fork[n] = FREE;
+ me->m_isHungry[n] = false;
+ BSP::displayPhilStat(n, THINKING);
+ }
+ return Q_TRAN(&serving);
+}
+//${Cont::Table::SM::active} .................................................
+QP::QState Table::active(Table * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Cont::Table::SM::active::TIMEOUT}
+ case TIMEOUT_SIG: {
+ Q_EVT_CAST(CompTimeEvt)->dispatchToComp();
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::EAT}
+ case EAT_SIG: {
+ Q_ERROR();
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::TEST}
+ case TEST_SIG: {
+ status_ = Q_HANDLED();
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&top);
+ break;
+ }
+ }
+ return status_;
+}
+//${Cont::Table::SM::active::serving} ........................................
+QP::QState Table::serving(Table * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Cont::Table::SM::active::serving}
+ case Q_ENTRY_SIG: {
+ for (uint8_t n = 0U; n < N_PHILO; ++n) { // give permissions to eat...
+ if (me->m_isHungry[n]
+ && (me->m_fork[LEFT(n)] == FREE)
+ && (me->m_fork[n] == FREE))
+ {
+ me->m_fork[LEFT(n)] = USED;
+ me->m_fork[n] = USED;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[n];
+ me->m_philo[n].dispatch(&evt);
+
+ me->m_isHungry[n] = false;
+ BSP::displayPhilStat(n, EATING);
+ }
+ }
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::serving::HUNGRY}
+ case HUNGRY_SIG: {
+ // find the index of the Philo from the event
+ uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+ // philo ID must be in range and he must be not hungry
+ Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+ BSP::displayPhilStat(n, HUNGRY);
+ uint8_t m = LEFT(n);
+ //${Cont::Table::SM::active::serving::HUNGRY::[bothfree]}
+ if ((me->m_fork[m] == FREE) && (me->m_fork[n] == FREE)) {
+ me->m_fork[m] = USED;
+ me->m_fork[n] = USED;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[n];
+ me->m_philo[n].dispatch(&evt);
+
+ BSP::displayPhilStat(n, EATING);
+ status_ = Q_HANDLED();
+ }
+ //${Cont::Table::SM::active::serving::HUNGRY::[else]}
+ else {
+ me->m_isHungry[n] = true;
+ status_ = Q_HANDLED();
+ }
+ break;
+ }
+ //${Cont::Table::SM::active::serving::DONE}
+ case DONE_SIG: {
+ // find the index of the Philo from the event
+ uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+ // philo ID must be in range and he must be not hungry
+ Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+ BSP::displayPhilStat(n, THINKING);
+ uint8_t m = LEFT(n);
+ // both forks of Phil[n] must be used
+ Q_ASSERT((me->m_fork[n] == USED) && (me->m_fork[m] == USED));
+
+ me->m_fork[m] = FREE;
+ me->m_fork[n] = FREE;
+ m = RIGHT(n); // check the right neighbor
+
+ if (me->m_isHungry[m] && (me->m_fork[m] == FREE)) {
+ me->m_fork[n] = USED;
+ me->m_fork[m] = USED;
+ me->m_isHungry[m] = false;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[m];
+ me->m_philo[m].dispatch(&evt);
+
+ BSP::displayPhilStat(m, EATING);
+ }
+ m = LEFT(n); // check the left neighbor
+ n = LEFT(m); // left fork of the left neighbor
+ if (me->m_isHungry[m] && (me->m_fork[n] == FREE)) {
+ me->m_fork[m] = USED;
+ me->m_fork[n] = USED;
+ me->m_isHungry[m] = false;
+
+ // synchronoulsy dispatch EAT event to the Philo component
+ TableEvt evt;
+ evt.sig = EAT_SIG;
+ evt.philo = &me->m_philo[m];
+ me->m_philo[m].dispatch(&evt);
+
+ BSP::displayPhilStat(m, EATING);
+ }
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::serving::EAT}
+ case EAT_SIG: {
+ Q_ERROR();
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::serving::PAUSE}
+ case PAUSE_SIG: {
+ status_ = Q_TRAN(&paused);
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&active);
+ break;
+ }
+ }
+ return status_;
+}
+//${Cont::Table::SM::active::paused} .........................................
+QP::QState Table::paused(Table * const me, QP::QEvt const * const e) {
+ QP::QState status_;
+ switch (e->sig) {
+ //${Cont::Table::SM::active::paused}
+ case Q_ENTRY_SIG: {
+ BSP::displayPaused(1U);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::paused}
+ case Q_EXIT_SIG: {
+ BSP::displayPaused(0U);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::paused::SERVE}
+ case SERVE_SIG: {
+ status_ = Q_TRAN(&serving);
+ break;
+ }
+ //${Cont::Table::SM::active::paused::HUNGRY}
+ case HUNGRY_SIG: {
+ // find the index of the Philo from the event
+ uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+ // philo ID must be in range and he must be not hungry
+ Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+ me->m_isHungry[n] = true;
+ BSP::displayPhilStat(n, HUNGRY);
+ status_ = Q_HANDLED();
+ break;
+ }
+ //${Cont::Table::SM::active::paused::DONE}
+ case DONE_SIG: {
+ // find the index of the Philo from the event
+ uint8_t n = (Q_EVT_CAST(TableEvt)->philo - &me->m_philo[0]);
+ // philo ID must be in range and he must be not hungry
+ Q_ASSERT((n < N_PHILO) && (!me->m_isHungry[n]));
+
+ BSP::displayPhilStat(n, THINKING);
+
+ uint8_t m = LEFT(n);
+ // both forks of Phil[n] must be used
+ Q_ASSERT((me->m_fork[n] == USED) && (me->m_fork[m] == USED));
+
+ me->m_fork[m] = FREE;
+ me->m_fork[n] = FREE;
+ status_ = Q_HANDLED();
+ break;
+ }
+ default: {
+ status_ = Q_SUPER(&active);
+ break;
+ }
+ }
+ return status_;
+}
+
+} // namespace DPP//$enddef${Cont::Table} ######################################################
diff --git a/examples/win32/dpp-comp/dpp.qm b/examples/win32/dpp-comp/dpp.qm
new file mode 100644
index 00000000..8a62d039
--- /dev/null
+++ b/examples/win32/dpp-comp/dpp.qm
@@ -0,0 +1,16 @@
+
+
+ Dining Philosopher Problem example with the "Orthogonal Component" state pattern (see https://www.state-machine.com/doc/Pattern_Orthogonal.pdf)
+
+The model demonstrates the following features:
+
+1. Partitioning the application into Container and Components
+2. Packages for Container (cont) and Components (comp)
+3. External packages with speparate QM-package model files
+4. CompTimeEvt class for private time evnents of Components
+5. Container to Component communication via synchronous event dispatching
+6. Component to Container communication via asynchronous event posting using the LIFO policy.
+
+
+
+
diff --git a/examples/win32/dpp-comp/main.cpp b/examples/win32/dpp-comp/main.cpp
new file mode 100644
index 00000000..26f4a2f3
--- /dev/null
+++ b/examples/win32/dpp-comp/main.cpp
@@ -0,0 +1,91 @@
+//****************************************************************************
+// DPP example for Windows
+// Last updated for version 6.0.0
+// Last updated on 2017-10-28
+//
+// Q u a n t u m L e a P s
+// ---------------------------
+// innovating embedded systems
+//
+// Copyright (C) Quantum Leaps, LLC. All rights reserved.
+//
+// This program is open source software: you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Alternatively, this program may be distributed and modified under the
+// terms of Quantum Leaps commercial licenses, which expressly supersede
+// the GNU General Public License and are specifically designed for
+// licensees interested in retaining the proprietary status of their code.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see .
+//
+// Contact information:
+// https://state-machine.com
+// mailto:info@state-machine.com
+//****************************************************************************
+#include "qpcpp.h"
+#include "dpp.h"
+#include "bsp.h"
+
+// "fudge factor" for Windows, see NOTE1
+enum { WIN_FUDGE_FACTOR = 10 };
+
+//............................................................................
+int main() {
+ static QP::QEvt const *tableQueueSto[N_PHILO*WIN_FUDGE_FACTOR];
+ static QF_MPOOL_EL(DPP::TableEvt) smlPoolSto[2*N_PHILO*WIN_FUDGE_FACTOR];
+
+ static QP::QSubscrList subscrSto[DPP::MAX_PUB_SIG];
+
+
+ QP::QF::init(); // initialize the framework and the underlying RT kernel
+
+ DPP::BSP::init(); // initialize the BSP
+
+ // object dictionaries...
+ QS_OBJ_DICTIONARY(smlPoolSto);
+ QS_OBJ_DICTIONARY(tableQueueSto);
+
+ QP::QF::psInit(subscrSto, Q_DIM(subscrSto)); // init publish-subscribe
+
+ // initialize event pools...
+ QP::QF::poolInit(smlPoolSto,
+ sizeof(smlPoolSto), sizeof(smlPoolSto[0]));
+
+ // start the active objects...
+ DPP::AO_Table->start(
+ 1U,
+ tableQueueSto, Q_DIM(tableQueueSto),
+ (void *)0, 0U);
+
+ return QP::QF::run(); // run the QF application
+}
+
+//****************************************************************************
+// NOTE1:
+// Windows is not a deterministic real-time system, which means that the
+// system can occasionally and unexpectedly "choke and freeze" for a number
+// of seconds. The designers of Windows have dealt with these sort of issues
+// by massively oversizing the resources available to the applications. For
+// example, the default Windows GUI message queues size is 10,000 entries,
+// which can dynamically grow to an even larger number. Also the stacks of
+// Win32 threads can dynamically grow to several megabytes.
+//
+// In contrast, the event queues, event pools, and stack size inside the
+// real-time embedded (RTE) systems can be (and must be) much smaller,
+// because you typically can put an upper bound on the real-time behavior
+// and the resulting delays.
+//
+// To be able to run the unmodified applications designed originally for
+// RTE systems on Windows, and to reduce the odds of resource shortages in
+// this case, the generous WIN_FUDGE_FACTOR is used to oversize the
+// event queues and event pools.
+//
diff --git a/examples/win32/history_qmsm/history.cpp b/examples/win32/history_qmsm/history.cpp
index af552d31..3ffab6ab 100644
--- a/examples/win32/history_qmsm/history.cpp
+++ b/examples/win32/history_qmsm/history.cpp
@@ -1,8 +1,9 @@
-//****************************************************************************
-// Model: history.qm
-// File: ./history.cpp
+//$file${.::history.cpp} #####################################################
//
-// This code has been generated by QM tool (see state-machine.com/qm).
+// Model: history.qm
+// File: C:/qp_lab/qpcpp/examples/win32/history_qmsm/history.cpp
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
//
// This code is covered by the following QP license:
@@ -15,8 +16,8 @@
// the generated code is still licensed under the terms of GPL.
// Please submit request for extension of the evaluaion period at:
// https://state-machine.com/licensing/#RequestForm
-//****************************************************************************
-//${.::history.cpp} ..........................................................
+//
+//$endhead${.::history.cpp} ##################################################
#include "qep_port.h"
#include "qassert.h"
#include "history.h"
@@ -27,11 +28,7 @@
Q_DEFINE_THIS_FILE
-
-#if ((QP_VERSION < 591) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
-#error qpcpp version 5.9.1 or higher required
-#endif
-
+//$declare${SMs::ToastOven} ##################################################
//${SMs::ToastOven} ..........................................................
class ToastOven : public QP::QMsm {
public:
@@ -69,13 +66,18 @@ protected:
protected:
QP::QMState const *his_doorClosed;
};
-
+//$enddecl${SMs::ToastOven} ##################################################
static ToastOven l_oven; // the only instance of the ToastOven class
// global-scope definitions ------------------------------------
QP::QMsm * const the_oven = &l_oven; // the opaque pointer
+//$define${SMs::ToastOven} ###################################################
+// Check for the minimum required QP version
+#if ((QP_VERSION < 601) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
+#error qpcpp version 6.0.1 or higher required
+#endif
//${SMs::ToastOven} ..........................................................
//${SMs::ToastOven::ToastOven} ...............................................
ToastOven::ToastOven()
@@ -95,7 +97,7 @@ QP::QState ToastOven::initial(ToastOven * const me, QP::QEvt const * const e) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::ToastOven::SM::initial}
+ //${SMs::ToastOven::SM::initial}
(void)e; /* avoid compiler warning */
// state history attributes
me->his_doorClosed = &off_s;
@@ -109,19 +111,19 @@ QP::QMState const ToastOven::doorClosed_s = {
Q_ACTION_CAST(&ToastOven::doorClosed_x),
Q_ACTION_CAST(&ToastOven::doorClosed_i)
};
-// ${SMs::ToastOven::SM::doorClosed}
+//${SMs::ToastOven::SM::doorClosed}
QP::QState ToastOven::doorClosed_e(ToastOven * const me) {
printf("door-Closed;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&doorClosed_s);
}
-// ${SMs::ToastOven::SM::doorClosed}
+//${SMs::ToastOven::SM::doorClosed}
QP::QState ToastOven::doorClosed_x(ToastOven * const me) {
// save deep history
me->his_doorClosed = me->stateObj();
return QM_EXIT(&doorClosed_s);
}
-// ${SMs::ToastOven::SM::doorClosed::initial}
+//${SMs::ToastOven::SM::doorClosed::initial}
QP::QState ToastOven::doorClosed_i(ToastOven * const me) {
static struct {
QP::QMState const *target;
@@ -133,14 +135,14 @@ QP::QState ToastOven::doorClosed_i(ToastOven * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::ToastOven::SM::doorClosed::initial}
+ //${SMs::ToastOven::SM::doorClosed::initial}
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::ToastOven::SM::doorClosed}
+//${SMs::ToastOven::SM::doorClosed}
QP::QState ToastOven::doorClosed(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::ToastOven::SM::doorClosed::TERMINATE}
+ //${SMs::ToastOven::SM::doorClosed::TERMINATE}
case TERMINATE_SIG: {
static struct {
QP::QMState const *target;
@@ -156,7 +158,7 @@ QP::QState ToastOven::doorClosed(ToastOven * const me, QP::QEvt const * const e)
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::ToastOven::SM::doorClosed::OPEN}
+ //${SMs::ToastOven::SM::doorClosed::OPEN}
case OPEN_SIG: {
static struct {
QP::QMState const *target;
@@ -172,7 +174,7 @@ QP::QState ToastOven::doorClosed(ToastOven * const me, QP::QEvt const * const e)
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::ToastOven::SM::doorClosed::TOAST}
+ //${SMs::ToastOven::SM::doorClosed::TOAST}
case TOAST_SIG: {
static struct {
QP::QMState const *target;
@@ -188,7 +190,7 @@ QP::QState ToastOven::doorClosed(ToastOven * const me, QP::QEvt const * const e)
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::ToastOven::SM::doorClosed::BAKE}
+ //${SMs::ToastOven::SM::doorClosed::BAKE}
case BAKE_SIG: {
static struct {
QP::QMState const *target;
@@ -204,7 +206,7 @@ QP::QState ToastOven::doorClosed(ToastOven * const me, QP::QEvt const * const e)
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::ToastOven::SM::doorClosed::OFF}
+ //${SMs::ToastOven::SM::doorClosed::OFF}
case OFF_SIG: {
static struct {
QP::QMState const *target;
@@ -234,19 +236,19 @@ QP::QMState const ToastOven::heating_s = {
Q_ACTION_CAST(&ToastOven::heating_x),
Q_ACTION_CAST(&ToastOven::heating_i)
};
-// ${SMs::ToastOven::SM::doorClosed::heating}
+//${SMs::ToastOven::SM::doorClosed::heating}
QP::QState ToastOven::heating_e(ToastOven * const me) {
printf("heater-On;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&heating_s);
}
-// ${SMs::ToastOven::SM::doorClosed::heating}
+//${SMs::ToastOven::SM::doorClosed::heating}
QP::QState ToastOven::heating_x(ToastOven * const me) {
printf("heater-Off;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&heating_s);
}
-// ${SMs::ToastOven::SM::doorClosed::heating::initial}
+//${SMs::ToastOven::SM::doorClosed::heating::initial}
QP::QState ToastOven::heating_i(ToastOven * const me) {
static struct {
QP::QMState const *target;
@@ -258,10 +260,10 @@ QP::QState ToastOven::heating_i(ToastOven * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::ToastOven::SM::doorClosed::heating::initial}
+ //${SMs::ToastOven::SM::doorClosed::heating::initial}
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::ToastOven::SM::doorClosed::heating}
+//${SMs::ToastOven::SM::doorClosed::heating}
QP::QState ToastOven::heating(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
@@ -281,13 +283,13 @@ QP::QMState const ToastOven::toasting_s = {
Q_ACTION_CAST(0), // no exit action
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::ToastOven::SM::doorClosed::heating::toasting}
+//${SMs::ToastOven::SM::doorClosed::heating::toasting}
QP::QState ToastOven::toasting_e(ToastOven * const me) {
printf("toasting;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&toasting_s);
}
-// ${SMs::ToastOven::SM::doorClosed::heating::toasting}
+//${SMs::ToastOven::SM::doorClosed::heating::toasting}
QP::QState ToastOven::toasting(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
@@ -307,13 +309,13 @@ QP::QMState const ToastOven::baking_s = {
Q_ACTION_CAST(0), // no exit action
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::ToastOven::SM::doorClosed::heating::baking}
+//${SMs::ToastOven::SM::doorClosed::heating::baking}
QP::QState ToastOven::baking_e(ToastOven * const me) {
printf("baking;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&baking_s);
}
-// ${SMs::ToastOven::SM::doorClosed::heating::baking}
+//${SMs::ToastOven::SM::doorClosed::heating::baking}
QP::QState ToastOven::baking(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
@@ -333,13 +335,13 @@ QP::QMState const ToastOven::off_s = {
Q_ACTION_CAST(0), // no exit action
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::ToastOven::SM::doorClosed::off}
+//${SMs::ToastOven::SM::doorClosed::off}
QP::QState ToastOven::off_e(ToastOven * const me) {
printf("toaster-Off;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&off_s);
}
-// ${SMs::ToastOven::SM::doorClosed::off}
+//${SMs::ToastOven::SM::doorClosed::off}
QP::QState ToastOven::off(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
@@ -359,23 +361,23 @@ QP::QMState const ToastOven::doorOpen_s = {
Q_ACTION_CAST(&ToastOven::doorOpen_x),
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::ToastOven::SM::doorOpen}
+//${SMs::ToastOven::SM::doorOpen}
QP::QState ToastOven::doorOpen_e(ToastOven * const me) {
printf("door-Open,lamp-On;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&doorOpen_s);
}
-// ${SMs::ToastOven::SM::doorOpen}
+//${SMs::ToastOven::SM::doorOpen}
QP::QState ToastOven::doorOpen_x(ToastOven * const me) {
printf("lamp-Off;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&doorOpen_s);
}
-// ${SMs::ToastOven::SM::doorOpen}
+//${SMs::ToastOven::SM::doorOpen}
QP::QState ToastOven::doorOpen(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::ToastOven::SM::doorOpen::CLOSE}
+ //${SMs::ToastOven::SM::doorOpen::CLOSE}
case CLOSE_SIG: {
static struct {
QP::QMState const *target;
@@ -391,7 +393,7 @@ QP::QState ToastOven::doorOpen(ToastOven * const me, QP::QEvt const * const e) {
status_ = QM_TRAN_HIST(me->his_doorClosed, &tatbl_);
break;
}
- // ${SMs::ToastOven::SM::doorOpen::TERMINATE}
+ //${SMs::ToastOven::SM::doorOpen::TERMINATE}
case TERMINATE_SIG: {
static struct {
QP::QMState const *target;
@@ -422,14 +424,14 @@ QP::QMState const ToastOven::final_s = {
Q_ACTION_CAST(0), // no exit action
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::ToastOven::SM::final}
+//${SMs::ToastOven::SM::final}
QP::QState ToastOven::final_e(ToastOven * const me) {
printf("-> final\nBye!Bye!\n");
_exit(0);
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&final_s);
}
-// ${SMs::ToastOven::SM::final}
+//${SMs::ToastOven::SM::final}
QP::QState ToastOven::final(ToastOven * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
@@ -441,4 +443,4 @@ QP::QState ToastOven::final(ToastOven * const me, QP::QEvt const * const e) {
(void)me; // avoid compiler warning in case 'me' is not used
return status_;
}
-
+//$enddef${SMs::ToastOven} ###################################################
diff --git a/examples/win32/history_qmsm/history.h b/examples/win32/history_qmsm/history.h
index e8450a62..5013fafb 100644
--- a/examples/win32/history_qmsm/history.h
+++ b/examples/win32/history_qmsm/history.h
@@ -1,8 +1,9 @@
-//****************************************************************************
-// Model: history.qm
-// File: ./history.h
+//$file${.::history.h} #######################################################
//
-// This code has been generated by QM tool (see state-machine.com/qm).
+// Model: history.qm
+// File: C:/qp_lab/qpcpp/examples/win32/history_qmsm/history.h
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
//
// This code is covered by the following QP license:
@@ -15,8 +16,8 @@
// the generated code is still licensed under the terms of GPL.
// Please submit request for extension of the evaluaion period at:
// https://state-machine.com/licensing/#RequestForm
-//****************************************************************************
-//${.::history.h} ............................................................
+//
+//$endhead${.::history.h} ####################################################
#ifndef history_h
#define history_h
@@ -31,4 +32,4 @@ enum ToastOvenSignals {
extern QP::QMsm * const the_oven; // opaque pointer to the oven MSM
-#endif // history_h
+#endif // history_h
\ No newline at end of file
diff --git a/examples/win32/history_qmsm/history.qm b/examples/win32/history_qmsm/history.qm
index 438588d5..7ae5b362 100644
--- a/examples/win32/history_qmsm/history.qm
+++ b/examples/win32/history_qmsm/history.qm
@@ -1,5 +1,5 @@
-
+
QMsmTst is a contrived state machine from Chapter 2 of the PSiCC2 book for testing the QMsm class implementation.
diff --git a/examples/win32/qmsmtst/qmsmtst.cpp b/examples/win32/qmsmtst/qmsmtst.cpp
index 5d4ff39c..13b851aa 100644
--- a/examples/win32/qmsmtst/qmsmtst.cpp
+++ b/examples/win32/qmsmtst/qmsmtst.cpp
@@ -1,8 +1,9 @@
-//****************************************************************************
-// Model: qmsmtst.qm
-// File: ./qmsmtst.cpp
+//$file${.::qmsmtst.cpp} #####################################################
//
-// This code has been generated by QM tool (see state-machine.com/qm).
+// Model: qmsmtst.qm
+// File: C:/qp_lab/qpcpp/examples/win32/qmsmtst/qmsmtst.cpp
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
//
// This code is covered by the following QP license:
@@ -15,18 +16,14 @@
// the generated code is still licensed under the terms of GPL.
// Please submit request for extension of the evaluaion period at:
// https://state-machine.com/licensing/#RequestForm
-//****************************************************************************
-//${.::qmsmtst.cpp} ..........................................................
+//
+//$endhead${.::qmsmtst.cpp} ##################################################
#include "qpcpp.h"
#include "qmsmtst.h"
namespace QMSMTST {
-
-#if ((QP_VERSION < 591) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
-#error qpcpp version 5.9.1 or higher required
-#endif
-
+//$declare${SMs::QMsmTst} ####################################################
//${SMs::QMsmTst} ............................................................
class QMsmTst : public QP::QMsm {
private:
@@ -68,13 +65,18 @@ protected:
static QP::QState s211_x(QMsmTst * const me);
static QP::QMState const s211_s;
};
-
+//$enddecl${SMs::QMsmTst} ####################################################
static QMsmTst l_msmtst; // the only instance of the QMsmTst class
// global-scope definitions -----------------------------------------
QP::QMsm * const the_msm = &l_msmtst; // the opaque pointer
+//$define${SMs::QMsmTst} #####################################################
+// Check for the minimum required QP version
+#if ((QP_VERSION < 601) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8)))
+#error qpcpp version 6.0.1 or higher required
+#endif
//${SMs::QMsmTst} ............................................................
//${SMs::QMsmTst::SM} ........................................................
@@ -91,7 +93,7 @@ QP::QState QMsmTst::initial(QMsmTst * const me, QP::QEvt const * const e) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::QMsmTst::SM::initial}
+ //${SMs::QMsmTst::SM::initial}
(void)e; // avoid compiler warning
me->m_foo = 0U;
BSP_display("top-INIT;");
@@ -105,19 +107,19 @@ QP::QMState const QMsmTst::s_s = {
Q_ACTION_CAST(&QMsmTst::s_x),
Q_ACTION_CAST(&QMsmTst::s_i)
};
-// ${SMs::QMsmTst::SM::s}
+//${SMs::QMsmTst::SM::s}
QP::QState QMsmTst::s_e(QMsmTst * const me) {
BSP_display("s-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s_s);
}
-// ${SMs::QMsmTst::SM::s}
+//${SMs::QMsmTst::SM::s}
QP::QState QMsmTst::s_x(QMsmTst * const me) {
BSP_display("s-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s_s);
}
-// ${SMs::QMsmTst::SM::s::initial}
+//${SMs::QMsmTst::SM::s::initial}
QP::QState QMsmTst::s_i(QMsmTst * const me) {
static struct {
QP::QMState const *target;
@@ -130,17 +132,17 @@ QP::QState QMsmTst::s_i(QMsmTst * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::QMsmTst::SM::s::initial}
+ //${SMs::QMsmTst::SM::s::initial}
BSP_display("s-INIT;");
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::QMsmTst::SM::s}
+//${SMs::QMsmTst::SM::s}
QP::QState QMsmTst::s(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::I}
+ //${SMs::QMsmTst::SM::s::I}
case I_SIG: {
- // ${SMs::QMsmTst::SM::s::I::[me->m_foo]}
+ //${SMs::QMsmTst::SM::s::I::[me->m_foo]}
if (me->m_foo) {
me->m_foo = 0U;
BSP_display("s-I;");
@@ -151,7 +153,7 @@ QP::QState QMsmTst::s(QMsmTst * const me, QP::QEvt const * const e) {
}
break;
}
- // ${SMs::QMsmTst::SM::s::E}
+ //${SMs::QMsmTst::SM::s::E}
case E_SIG: {
static struct {
QP::QMState const *target;
@@ -168,7 +170,7 @@ QP::QState QMsmTst::s(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::TERMINATE}
+ //${SMs::QMsmTst::SM::s::TERMINATE}
case TERMINATE_SIG: {
BSP_terminate(0);
status_ = QM_HANDLED();
@@ -190,19 +192,19 @@ QP::QMState const QMsmTst::s1_s = {
Q_ACTION_CAST(&QMsmTst::s1_x),
Q_ACTION_CAST(&QMsmTst::s1_i)
};
-// ${SMs::QMsmTst::SM::s::s1}
+//${SMs::QMsmTst::SM::s::s1}
QP::QState QMsmTst::s1_e(QMsmTst * const me) {
BSP_display("s1-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s1_s);
}
-// ${SMs::QMsmTst::SM::s::s1}
+//${SMs::QMsmTst::SM::s::s1}
QP::QState QMsmTst::s1_x(QMsmTst * const me) {
BSP_display("s1-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s1_s);
}
-// ${SMs::QMsmTst::SM::s::s1::initial}
+//${SMs::QMsmTst::SM::s::s1::initial}
QP::QState QMsmTst::s1_i(QMsmTst * const me) {
static struct {
QP::QMState const *target;
@@ -214,23 +216,23 @@ QP::QState QMsmTst::s1_i(QMsmTst * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::QMsmTst::SM::s::s1::initial}
+ //${SMs::QMsmTst::SM::s::s1::initial}
BSP_display("s1-INIT;");
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::QMsmTst::SM::s::s1}
+//${SMs::QMsmTst::SM::s::s1}
QP::QState QMsmTst::s1(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::s1::I}
+ //${SMs::QMsmTst::SM::s::s1::I}
case I_SIG: {
BSP_display("s1-I;");
status_ = QM_HANDLED();
break;
}
- // ${SMs::QMsmTst::SM::s::s1::D}
+ //${SMs::QMsmTst::SM::s::s1::D}
case D_SIG: {
- // ${SMs::QMsmTst::SM::s::s1::D::[!me->m_foo]}
+ //${SMs::QMsmTst::SM::s::s1::D::[!me->m_foo]}
if (!me->m_foo) {
static struct {
QP::QMState const *target;
@@ -252,7 +254,7 @@ QP::QState QMsmTst::s1(QMsmTst * const me, QP::QEvt const * const e) {
}
break;
}
- // ${SMs::QMsmTst::SM::s::s1::A}
+ //${SMs::QMsmTst::SM::s::s1::A}
case A_SIG: {
static struct {
QP::QMState const *target;
@@ -270,7 +272,7 @@ QP::QState QMsmTst::s1(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s1::B}
+ //${SMs::QMsmTst::SM::s::s1::B}
case B_SIG: {
static struct {
QP::QMState const *target;
@@ -286,7 +288,7 @@ QP::QState QMsmTst::s1(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s1::F}
+ //${SMs::QMsmTst::SM::s::s1::F}
case F_SIG: {
static struct {
QP::QMState const *target;
@@ -305,7 +307,7 @@ QP::QState QMsmTst::s1(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s1::C}
+ //${SMs::QMsmTst::SM::s::s1::C}
case C_SIG: {
static struct {
QP::QMState const *target;
@@ -338,23 +340,23 @@ QP::QMState const QMsmTst::s11_s = {
Q_ACTION_CAST(&QMsmTst::s11_x),
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::QMsmTst::SM::s::s1::s11}
+//${SMs::QMsmTst::SM::s::s1::s11}
QP::QState QMsmTst::s11_e(QMsmTst * const me) {
BSP_display("s11-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s11_s);
}
-// ${SMs::QMsmTst::SM::s::s1::s11}
+//${SMs::QMsmTst::SM::s::s1::s11}
QP::QState QMsmTst::s11_x(QMsmTst * const me) {
BSP_display("s11-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s11_s);
}
-// ${SMs::QMsmTst::SM::s::s1::s11}
+//${SMs::QMsmTst::SM::s::s1::s11}
QP::QState QMsmTst::s11(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::s1::s11::H}
+ //${SMs::QMsmTst::SM::s::s1::s11::H}
case H_SIG: {
static struct {
QP::QMState const *target;
@@ -372,9 +374,9 @@ QP::QState QMsmTst::s11(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s1::s11::D}
+ //${SMs::QMsmTst::SM::s::s1::s11::D}
case D_SIG: {
- // ${SMs::QMsmTst::SM::s::s1::s11::D::[me->m_foo]}
+ //${SMs::QMsmTst::SM::s::s1::s11::D::[me->m_foo]}
if (me->m_foo) {
static struct {
QP::QMState const *target;
@@ -396,7 +398,7 @@ QP::QState QMsmTst::s11(QMsmTst * const me, QP::QEvt const * const e) {
}
break;
}
- // ${SMs::QMsmTst::SM::s::s1::s11::G}
+ //${SMs::QMsmTst::SM::s::s1::s11::G}
case G_SIG: {
static struct {
QP::QMState const *target;
@@ -431,19 +433,19 @@ QP::QMState const QMsmTst::s2_s = {
Q_ACTION_CAST(&QMsmTst::s2_x),
Q_ACTION_CAST(&QMsmTst::s2_i)
};
-// ${SMs::QMsmTst::SM::s::s2}
+//${SMs::QMsmTst::SM::s::s2}
QP::QState QMsmTst::s2_e(QMsmTst * const me) {
BSP_display("s2-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s2_s);
}
-// ${SMs::QMsmTst::SM::s::s2}
+//${SMs::QMsmTst::SM::s::s2}
QP::QState QMsmTst::s2_x(QMsmTst * const me) {
BSP_display("s2-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s2_s);
}
-// ${SMs::QMsmTst::SM::s::s2::initial}
+//${SMs::QMsmTst::SM::s::s2::initial}
QP::QState QMsmTst::s2_i(QMsmTst * const me) {
static struct {
QP::QMState const *target;
@@ -456,17 +458,17 @@ QP::QState QMsmTst::s2_i(QMsmTst * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::QMsmTst::SM::s::s2::initial}
+ //${SMs::QMsmTst::SM::s::s2::initial}
BSP_display("s2-INIT;");
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::QMsmTst::SM::s::s2}
+//${SMs::QMsmTst::SM::s::s2}
QP::QState QMsmTst::s2(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::s2::I}
+ //${SMs::QMsmTst::SM::s::s2::I}
case I_SIG: {
- // ${SMs::QMsmTst::SM::s::s2::I::[!me->m_foo]}
+ //${SMs::QMsmTst::SM::s::s2::I::[!me->m_foo]}
if (!me->m_foo) {
me->m_foo = true;
BSP_display("s2-I;");
@@ -477,7 +479,7 @@ QP::QState QMsmTst::s2(QMsmTst * const me, QP::QEvt const * const e) {
}
break;
}
- // ${SMs::QMsmTst::SM::s::s2::F}
+ //${SMs::QMsmTst::SM::s::s2::F}
case F_SIG: {
static struct {
QP::QMState const *target;
@@ -495,7 +497,7 @@ QP::QState QMsmTst::s2(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s2::C}
+ //${SMs::QMsmTst::SM::s::s2::C}
case C_SIG: {
static struct {
QP::QMState const *target;
@@ -528,19 +530,19 @@ QP::QMState const QMsmTst::s21_s = {
Q_ACTION_CAST(&QMsmTst::s21_x),
Q_ACTION_CAST(&QMsmTst::s21_i)
};
-// ${SMs::QMsmTst::SM::s::s2::s21}
+//${SMs::QMsmTst::SM::s::s2::s21}
QP::QState QMsmTst::s21_e(QMsmTst * const me) {
BSP_display("s21-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s21_s);
}
-// ${SMs::QMsmTst::SM::s::s2::s21}
+//${SMs::QMsmTst::SM::s::s2::s21}
QP::QState QMsmTst::s21_x(QMsmTst * const me) {
BSP_display("s21-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s21_s);
}
-// ${SMs::QMsmTst::SM::s::s2::s21::initial}
+//${SMs::QMsmTst::SM::s::s2::s21::initial}
QP::QState QMsmTst::s21_i(QMsmTst * const me) {
static struct {
QP::QMState const *target;
@@ -552,15 +554,15 @@ QP::QState QMsmTst::s21_i(QMsmTst * const me) {
Q_ACTION_CAST(0) // zero terminator
}
};
- // ${SMs::QMsmTst::SM::s::s2::s21::initial}
+ //${SMs::QMsmTst::SM::s::s2::s21::initial}
BSP_display("s21-INIT;");
return QM_TRAN_INIT(&tatbl_);
}
-// ${SMs::QMsmTst::SM::s::s2::s21}
+//${SMs::QMsmTst::SM::s::s2::s21}
QP::QState QMsmTst::s21(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::s2::s21::G}
+ //${SMs::QMsmTst::SM::s::s2::s21::G}
case G_SIG: {
static struct {
QP::QMState const *target;
@@ -579,7 +581,7 @@ QP::QState QMsmTst::s21(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s2::s21::A}
+ //${SMs::QMsmTst::SM::s::s2::s21::A}
case A_SIG: {
static struct {
QP::QMState const *target;
@@ -597,7 +599,7 @@ QP::QState QMsmTst::s21(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s2::s21::B}
+ //${SMs::QMsmTst::SM::s::s2::s21::B}
case B_SIG: {
static struct {
QP::QMState const *target;
@@ -628,23 +630,23 @@ QP::QMState const QMsmTst::s211_s = {
Q_ACTION_CAST(&QMsmTst::s211_x),
Q_ACTION_CAST(0) // no intitial tran.
};
-// ${SMs::QMsmTst::SM::s::s2::s21::s211}
+//${SMs::QMsmTst::SM::s::s2::s21::s211}
QP::QState QMsmTst::s211_e(QMsmTst * const me) {
BSP_display("s211-ENTRY;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_ENTRY(&s211_s);
}
-// ${SMs::QMsmTst::SM::s::s2::s21::s211}
+//${SMs::QMsmTst::SM::s::s2::s21::s211}
QP::QState QMsmTst::s211_x(QMsmTst * const me) {
BSP_display("s211-EXIT;");
(void)me; // avoid compiler warning in case 'me' is not used
return QM_EXIT(&s211_s);
}
-// ${SMs::QMsmTst::SM::s::s2::s21::s211}
+//${SMs::QMsmTst::SM::s::s2::s21::s211}
QP::QState QMsmTst::s211(QMsmTst * const me, QP::QEvt const * const e) {
QP::QState status_;
switch (e->sig) {
- // ${SMs::QMsmTst::SM::s::s2::s21::s211::H}
+ //${SMs::QMsmTst::SM::s::s2::s21::s211::H}
case H_SIG: {
static struct {
QP::QMState const *target;
@@ -663,7 +665,7 @@ QP::QState QMsmTst::s211(QMsmTst * const me, QP::QEvt const * const e) {
status_ = QM_TRAN(&tatbl_);
break;
}
- // ${SMs::QMsmTst::SM::s::s2::s21::s211::D}
+ //${SMs::QMsmTst::SM::s::s2::s21::s211::D}
case D_SIG: {
static struct {
QP::QMState const *target;
@@ -687,6 +689,6 @@ QP::QState QMsmTst::s211(QMsmTst * const me, QP::QEvt const * const e) {
}
return status_;
}
+//$enddef${SMs::QMsmTst} #####################################################
-
-} // namespace QMSMTST
+} // namespace QMSMTST
\ No newline at end of file
diff --git a/examples/win32/qmsmtst/qmsmtst.h b/examples/win32/qmsmtst/qmsmtst.h
index 89f8705b..0403f101 100644
--- a/examples/win32/qmsmtst/qmsmtst.h
+++ b/examples/win32/qmsmtst/qmsmtst.h
@@ -1,8 +1,9 @@
-//****************************************************************************
-// Model: qmsmtst.qm
-// File: ./qmsmtst.h
+//$file${.::qmsmtst.h} #######################################################
//
-// This code has been generated by QM tool (see state-machine.com/qm).
+// Model: qmsmtst.qm
+// File: C:/qp_lab/qpcpp/examples/win32/qmsmtst/qmsmtst.h
+//
+// This code has been generated by QM tool (https://state-machine.com/qm).
// DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
//
// This code is covered by the following QP license:
@@ -15,8 +16,8 @@
// the generated code is still licensed under the terms of GPL.
// Please submit request for extension of the evaluaion period at:
// https://state-machine.com/licensing/#RequestForm
-//****************************************************************************
-//${.::qmsmtst.h} ............................................................
+//
+//$endhead${.::qmsmtst.h} ####################################################
#ifndef qmsmtst_h
#define qmsmtst_h
@@ -45,4 +46,4 @@ void BSP_terminate(int16_t const result);
} // namespace QMSMTST
-#endif // qmsmtst_h
+#endif // qmsmtst_h
\ No newline at end of file
diff --git a/examples/win32/qmsmtst/qmsmtst.qm b/examples/win32/qmsmtst/qmsmtst.qm
index 060a991d..58268adf 100644
--- a/examples/win32/qmsmtst/qmsmtst.qm
+++ b/examples/win32/qmsmtst/qmsmtst.qm
@@ -1,5 +1,5 @@
-
+
QMsmTst is a test for the QMsm state machine based on Chapter 2 of the PSiCC2 book.
diff --git a/include/qep.h b/include/qep.h
index bcf386ca..196a8028 100644
--- a/include/qep.h
+++ b/include/qep.h
@@ -50,8 +50,8 @@
// and Z is a 1-digit release number.
#define QP_VERSION_STR "6.0.1"
-//! Tamperproof current QP release (6.0.1) and date (2017-10-20)
-#define QP_RELEASE 0x9A1068E6U
+//! Tamperproof current QP release (6.0.1) and date (2017-11-10)
+#define QP_RELEASE 0x9A02AD46U
//****************************************************************************
@@ -275,11 +275,11 @@ QState const Q_RET_TRAN = static_cast(8);
//! initial transition taken
QState const Q_RET_TRAN_INIT = static_cast(9);
-//! event handled (transition to history)
-QState const Q_RET_TRAN_HIST = static_cast(10);
-
//! entry-point transition into a submachine
-QState const Q_RET_TRAN_EP = static_cast(11);
+QState const Q_RET_TRAN_EP = static_cast(10);
+
+//! transition to history of a given state
+QState const Q_RET_TRAN_HIST = static_cast(11);
//! exit-point transition out of a submachine
QState const Q_RET_TRAN_XP = static_cast(12);
diff --git a/include/qxthread.h b/include/qxthread.h
index 84a629a8..56f56345 100644
--- a/include/qxthread.h
+++ b/include/qxthread.h
@@ -3,8 +3,8 @@
/// @ingroup qxk
/// @cond
///***************************************************************************
-/// Last updated for version 5.9.9
-/// Last updated on 2017-09-29
+/// Last updated for version 6.0.1
+/// Last updated on 2017-11-03
///
/// Q u a n t u m L e a P s
/// ---------------------------
@@ -211,7 +211,7 @@ private:
class QXMutex {
public:
//! initialize the QXK priority-ceiling mutex QP::QXMutex
- void init(uint_fast8_t ceiling);
+ void init(uint_fast8_t const ceiling);
//! lock the QXK priority-ceiling mutex QP::QXMutex
bool lock(uint_fast16_t const nTicks = QXTHREAD_NO_TIMEOUT);
diff --git a/src/qf/qep_hsm.cpp b/src/qf/qep_hsm.cpp
index e2329786..bc8a2794 100644
--- a/src/qf/qep_hsm.cpp
+++ b/src/qf/qep_hsm.cpp
@@ -3,8 +3,8 @@
/// @ingroup qep
/// @cond
///***************************************************************************
-/// Last updated for version 5.9.0
-/// Last updated on 2017-05-08
+/// Last updated for version 6.0.1
+/// Last updated on 2017-11-03
///
/// Q u a n t u m L e a P s
/// ---------------------------
@@ -131,7 +131,8 @@ QHsm::~QHsm() {
///
/// @param[in] e pointer to the initialization event (might be NULL)
///
-/// @note Must be called exactly __once__ before the QP::QHsm::dispatch().
+/// @note
+/// Must be called exactly __once__ before the QP::QHsm::dispatch().
///
void QHsm::init(QEvt const * const e) {
QStateHandler t = m_state.fun;
@@ -208,8 +209,9 @@ void QHsm::init(QEvt const * const e) {
///
/// @param[in] e pointer to the event to be dispatched to the HSM
///
-/// @returns Always returns #Q_RET_IGNORED, which means that the top state
-/// ignores all events.
+/// @returns
+/// Always returns #Q_RET_IGNORED, which means that the top state ignores
+/// all events.
///
/// @note
/// The arguments to this state handler are not used. They are provided for
@@ -386,7 +388,8 @@ void QHsm::dispatch(QEvt const * const e) {
/// @param[in,out] path array of pointers to state-handler functions
/// to execute the entry actions
///
-/// @returns the depth of the entry path stored in the @p path parameter.
+/// @returns
+/// the depth of the entry path stored in the @p path parameter.
////
int_fast8_t QHsm::hsm_tran(QStateHandler (&path)[MAX_NEST_DEPTH_]) {
// transition entry path index
@@ -539,7 +542,8 @@ int_fast8_t QHsm::hsm_tran(QStateHandler (&path)[MAX_NEST_DEPTH_]) {
///
/// @param[in] state pointer to the state-handler function to be tested
///
-/// @returns 'true' if the HSM is in the @p state and 'false' otherwise
+/// @returns
+/// 'true' if the HSM is in the @p state and 'false' otherwise
///
bool QHsm::isIn(QStateHandler const s) {
@@ -575,16 +579,18 @@ bool QHsm::isIn(QStateHandler const s) {
///
/// @param[in] parent pointer to the state-handler function
///
-/// @returns the child of a given @c parent state, which is an ancestor of
-/// the currently active state
+/// @returns
+/// the child of a given @c parent state, which is an ancestor of the
+/// currently active state
///
-/// @note this function is designed to be called during state transitions,
-/// so it does not necessarily start in a stable state configuration.
+/// @note
+/// this function is designed to be called during state transitions, so it
+/// does not necessarily start in a stable state configuration.
/// However, the function establishes stable state configuration upon exit.
///
QStateHandler QHsm::childState(QStateHandler const parent) {
QStateHandler child = m_state.fun; // start with the current state
- bool isConfirmed = false; // start with the child not confirmed
+ bool isFound = false; // start with the child not found
QState r;
// establish stable state configuration
@@ -592,7 +598,7 @@ QStateHandler QHsm::childState(QStateHandler const parent) {
do {
// is this the parent of the current child?
if (m_temp.fun == parent) {
- isConfirmed = true; // child is confirmed
+ isFound = true; // child is found
r = Q_RET_IGNORED; // cause breaking out of the loop
}
else {
@@ -603,7 +609,7 @@ QStateHandler QHsm::childState(QStateHandler const parent) {
m_temp.fun = m_state.fun; // establish stable state configuration
/// @post the child must be confirmed
- Q_ENSURE_ID(710, isConfirmed);
+ Q_ENSURE_ID(810, isFound);
return child; // return the child
}
diff --git a/src/qf/qep_msm.cpp b/src/qf/qep_msm.cpp
index 7467f2c2..ccc33f3c 100644
--- a/src/qf/qep_msm.cpp
+++ b/src/qf/qep_msm.cpp
@@ -3,8 +3,8 @@
/// @ingroup qep
/// @cond
///***************************************************************************
-/// Last updated for version 5.9.1
-/// Last updated on 2017-05-24
+/// Last updated for version 6.0.1
+/// Last updated on 2017-11-03
///
/// Q u a n t u m L e a P s
/// ---------------------------
@@ -75,10 +75,12 @@ QMState const QMsm::msm_top_s = {
///
/// @param[in] initial the top-most initial transition for the MSM.
///
-/// @note The constructor is protected to prevent direct instantiating
-/// of the QP::QMsm objects. This class is intended for subclassing only.
+/// @note
+/// The constructor is protected to prevent direct instantiating of the
+/// QP::QMsm objects. This class is intended for subclassing only.
///
-/// @sa The QP::QMsm example illustrates how to use the QMsm constructor
+/// @sa
+/// The QP::QMsm example illustrates how to use the QMsm constructor
/// in the constructor initializer list of the derived state machines.
///
QMsm::QMsm(QStateHandler const initial)
@@ -139,22 +141,23 @@ void QMsm::init(QEvt const * const e) {
///
/// @param[in] e pointer to the event to be dispatched to the MSM
///
-/// @note Must be called after QP::QMsm::init().
+/// @note
+/// Must be called after QP::QMsm::init().
///
void QMsm::dispatch(QEvt const * const e) {
QMState const *s = m_state.obj; // store the current state
QMState const *t = s;
- QState r = Q_RET_SUPER;
+ QState r;
QS_CRIT_STAT_
/// @pre current state must be initialized
Q_REQUIRE_ID(300, s != static_cast(0));
QS_BEGIN_(QS_QEP_DISPATCH, QS::priv_.locFilter[QS::SM_OBJ], this)
- QS_TIME_(); // time stamp
- QS_SIG_(e->sig); // the signal of the event
- QS_OBJ_(this); // this state machine object
- QS_FUN_(s->stateHandler); // the current state handler
+ QS_TIME_(); // time stamp
+ QS_SIG_(e->sig); // the signal of the event
+ QS_OBJ_(this); // this state machine object
+ QS_FUN_(s->stateHandler); // the current state handler
QS_END_()
// scan the state hierarchy up to the top state...
@@ -204,14 +207,11 @@ void QMsm::dispatch(QEvt const * const e) {
QMTranActTable const *tatbl = m_temp.tatbl;
QHsmAttr tmp; // temporary to save intermediate values
- // was a regular state transition segment taken?
- if (r == Q_RET_TRAN) {
+ // was TRAN, TRAN_INIT, or TRAN_EP taken?
+ if (r < Q_RET_TRAN_HIST) {
exitToTranSource_(s, t);
r = execTatbl_(tatbl);
- }
- // was an initial transition segment taken?
- else if (r == Q_RET_TRAN_INIT) {
- r = execTatbl_(tatbl);
+ s = m_state.obj;
}
// was a transition segment to history taken?
else if (r == Q_RET_TRAN_HIST) {
@@ -220,10 +220,7 @@ void QMsm::dispatch(QEvt const * const e) {
exitToTranSource_(s, t);
(void)execTatbl_(tatbl);
r = enterHistory_(tmp.obj);
- }
- // was a transition segment to an entry point taken?
- else if (r == Q_RET_TRAN_EP) {
- r = execTatbl_(tatbl);
+ s = m_state.obj;
}
// was a transition segment to an exit point taken?
else if (r == Q_RET_TRAN_XP) {
@@ -231,32 +228,32 @@ void QMsm::dispatch(QEvt const * const e) {
m_state.obj = s; // restore the original state
r = (*act)(this); // execute the XP action
- if (r == Q_RET_TRAN) {
+ if (r == Q_RET_TRAN) { // XP -> TRAN ?
exitToTranSource_(s, t);
- tmp.tatbl = m_temp.tatbl; // save XP-Segment
// take the tran-to-XP segment inside submachine
(void)execTatbl_(tatbl);
- m_state.obj = s; // restore original state
-#ifdef Q_SPY
- t = m_temp.tatbl->target; // store for tracing
-#endif /* Q_SPY */
- // take the XP-Segment from submachine-state
- r = execTatbl_(tmp.tatbl);
-
- QS_BEGIN_(QS_QEP_TRAN_XP,
- QS::priv_.locFilter[QS::SM_OBJ], this)
- QS_OBJ_(this); // this state machine object
- QS_FUN_(s); // source handler
- QS_FUN_(t); // target handler
- QS_END_()
+ s = m_state.obj;
+ }
+ else if (r == Q_RET_TRAN_HIST) { // XP -> HIST ?
+ tmp.obj = m_state.obj; // save the history
+ m_state.obj = s; // restore the original state
+ exitToTranSource_(s, t);
+ // take the tran-to-XP segment inside submachine
+ (void)execTatbl_(tatbl);
+ s = m_state.obj;
+ m_state.obj = tmp.obj; // restore the history
+ }
+ else {
+ // TRAN_XP must NOT be followed by any other tran type
+ Q_ASSERT_ID(330, r < Q_RET_TRAN);
}
}
else {
// no other return value should be produced
- Q_ERROR_ID(330);
+ Q_ERROR_ID(340);
}
- s = m_state.obj;
- t = s;
+
+ t = s; // set target to the current state
} while (r >= Q_RET_TRAN);
@@ -307,7 +304,8 @@ void QMsm::dispatch(QEvt const * const e) {
///
/// @param[in] tatbl pointer to the transition-action table
///
-/// @returns status of the last action from the transition-action table.
+/// @returns
+/// the status of the last action from the transition-action table.
///
/// @note
/// This function is for internal use inside the QEP event processor and
@@ -371,13 +369,9 @@ QState QMsm::execTatbl_(QMTranActTable const * const tatbl) {
#endif // Q_SPY
}
- if (r >= Q_RET_TRAN_INIT) {
- m_state.obj = m_temp.tatbl->target; // the tran. target
- }
- else {
- m_state.obj = tatbl->target; // the tran. target
- }
-
+ m_state.obj = (r >= Q_RET_TRAN)
+ ? m_temp.tatbl->target
+ : tatbl->target;
return r;
}
@@ -424,8 +418,9 @@ void QMsm::exitToTranSource_(QMState const *s,
///
/// @param[in] hist pointer to the history substate
///
-/// @returns QP::Q_RET_INIT, if an initial transition has been executed in
-/// the last entered state or QP::Q_RET_NULL if no such transition was taken.
+/// @returns
+/// QP::Q_RET_INIT, if an initial transition has been executed in the last
+/// entered state or QP::Q_RET_NULL if no such transition was taken.
///
QState QMsm::enterHistory_(QMState const * const hist) {
QMState const *s = hist;
@@ -477,17 +472,17 @@ QState QMsm::enterHistory_(QMState const * const hist) {
}
//****************************************************************************
-/// \description
+/// @description
/// Tests if a state machine derived from QMsm is-in a given state.
///
-/// \note For a MSM, to "be-in" a state means also to "be-in" a superstate of
+/// @note
+/// For a MSM, to "be-in" a state means also to "be-in" a superstate of
/// of the state.
///
-/// \arguments
-/// \arg[in] \c st pointer to the QMState object that corresponds to the
+/// @param[in] st pointer to the QMState object that corresponds to the
/// tested state.
-///
-/// \returns 'true' if the MSM is in the \c st and 'false' otherwise
+/// @returns
+/// 'true' if the MSM is in the \c st and 'false' otherwise
///
bool QMsm::isInState(QMState const * const st) const {
bool inState = false; // assume that this MSM is not in 'state'
@@ -514,20 +509,22 @@ bool QMsm::isInState(QMState const * const st) const {
///
/// @param[in] parent pointer to the state-handler object
///
-/// @returns the child of a given @c parent state, which is an ancestor of
-/// the currently active state
+/// @returns
+/// the child of a given @c parent state, which is an ancestor of the
+/// currently active state. For the corner case when the currently active
+/// state is the given @c parent state, function returns the @c parent state.
///
QMState const *QMsm::childStateObj(QMState const * const parent) const {
QMState const *child = m_state.obj;
- bool isConfirmed = false; // start with the child not confirmed
+ bool isFound = false; // start with the child not found
QMState const *s;
- for (s = m_state.obj->superstate;
+ for (s = m_state.obj;
s != static_cast(0);
s = s->superstate)
{
if (s == parent) {
- isConfirmed = true; // child is confirmed
+ isFound = true; // child is found
break;
}
else {
@@ -535,8 +532,8 @@ QMState const *QMsm::childStateObj(QMState const * const parent) const {
}
}
- /// @post the child must be confirmed
- Q_ENSURE_ID(810, isConfirmed != false);
+ /// @post the child must be found
+ Q_ENSURE_ID(810, isFound);
return child; // return the child
}
diff --git a/src/qxk/qxk.cpp b/src/qxk/qxk.cpp
index 18af06d5..b5ace169 100644
--- a/src/qxk/qxk.cpp
+++ b/src/qxk/qxk.cpp
@@ -389,8 +389,8 @@ uint_fast8_t QXK_sched_(void) {
QP::QS::priv_.locFilter[QP::QS::AO_OBJ],
QXK_attr_.next)
QS_TIME_(); // timestamp
- QS_2U8_(static_cast(p), // prio of the next thread
- static_cast( // prio of the curent thread
+ QS_2U8_(static_cast(p), /* prio of the next AO */
+ static_cast( /* prio of the curent AO */
QXK_attr_.actPrio));
QS_END_NOCRIT_()
@@ -416,7 +416,7 @@ uint_fast8_t QXK_sched_(void) {
p = static_cast(0); // no activation needed
QXK_CONTEXT_SWITCH_();
}
- else { // next is the same as the current
+ else { // next is the same as the current
// no need to context-switch
QXK_attr_.next = static_cast(0);
p = static_cast(0); // no activation needed
diff --git a/src/qxk/qxk_mutex.cpp b/src/qxk/qxk_mutex.cpp
index 6da420eb..49576a5f 100644
--- a/src/qxk/qxk_mutex.cpp
+++ b/src/qxk/qxk_mutex.cpp
@@ -4,8 +4,8 @@
/// @cond
///***************************************************************************
/// Product: QK/C++
-/// Last updated for version 5.9.9
-/// Last updated on 2017-09-29
+/// Last updated for version 6.0.1
+/// Last updated on 2017-11-03
///
/// Q u a n t u m L e a P s
/// ---------------------------
@@ -81,7 +81,7 @@ Q_DEFINE_THIS_MODULE("qxk_mutex")
/// @usage
/// @include qxk_mux.cpp
///
-void QXMutex::init(uint_fast8_t ceiling) {
+void QXMutex::init(uint_fast8_t const ceiling) {
QF_CRIT_STAT_
QF_CRIT_ENTRY_();
diff --git a/src/qxk/qxk_xthr.cpp b/src/qxk/qxk_xthr.cpp
index 1fd00352..b295c4dc 100644
--- a/src/qxk/qxk_xthr.cpp
+++ b/src/qxk/qxk_xthr.cpp
@@ -95,7 +95,7 @@ void QXThread::dispatch(QEvt const * const /*e*/) {
//****************************************************************************
///
/// @description
-/// Starts an extended thread and registers it with the framework.
+/// Starts execution of an extended thread and registers it with the framework.
/// The extended thread becomes ready-to-run immediately and is scheduled
/// if the QXK is already running.
///
@@ -287,15 +287,15 @@ bool QXThread::post_(QEvt const * const e, uint_fast16_t const margin,
QS_TIME_(); // timestamp
QS_OBJ_(sender); // the sender object
QS_SIG_(e->sig); // the signal of the event
- QS_OBJ_(this); // this active object
- QS_2U8_(e->poolId_, e->refCtr_); // poolID & refCtr of the evt
+ QS_OBJ_(this); // this active object (recipient)
+ QS_2U8_(e->poolId_, e->refCtr_); // poolID & ref Count
QS_EQC_(nFree); // number of free entries
QS_EQC_(static_cast(margin)); // margin requested
QS_END_NOCRIT_()
QF_CRIT_EXIT_();
- QF::gc(e); // recycle the evnet to avoid a leak
+ QF::gc(e); // recycle the event to avoid a leak
status = false; // event not posted
}
}
diff --git a/version-6.0.1 b/version-6.0.1
index 6ae663fe..83ea7e28 100644
--- a/version-6.0.1
+++ b/version-6.0.1
@@ -1,2 +1,2 @@
QP/C++ 6.0.1
-2017-10-20
+2017-11-10