Logger improvements

Author: camilo

check/Release/BrowseInfo/sa_check.pbd

@@ -0,0 +1,40 @@
+@REM This batch file has been generated by the IAR Embedded Workbench
+@REM C-SPY Debugger, as an aid to preparing a command line for running
+@REM the cspybat command line utility using the appropriate settings.
+@REM
+@REM Note that this file is generated every time a new debug session
+@REM is initialized, so you may want to move or rename the file before
+@REM making changes.
+@REM
+@REM You can launch cspybat by typing the name of this batch file followed
+@REM by the name of the debug file (usually an ELF/DWARF or UBROF file).
+@REM
+@REM Read about available command line parameters in the C-SPY Debugging
+@REM Guide. Hints about additional command line parameters that may be
+@REM useful in specific cases:
+@REM   --download_only   Downloads a code image without starting a debug
+@REM                     session afterwards.
+@REM   --silent          Omits the sign-on message.
+@REM   --timeout         Limits the maximum allowed execution time.
+@REM 
+
+
+@echo off 
+
+if not "%~1" == "" goto debugFile 
+
+@echo on 
+
+"C:\iar\ewarm-9.60.2\common\bin\cspybat" -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.general.xcl" --backend -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.driver.xcl" 
+
+@echo off 
+goto end 
+
+:debugFile 
+
+@echo on 
+
+"C:\iar\ewarm-9.60.2\common\bin\cspybat" -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.general.xcl" "--debug_file=%~1" --backend -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.driver.xcl" 
+
+@echo off 
+:end

check/Release/BrowseInfo/sa_check.pbd.browse

@@ -0,0 +1,31 @@
+param([String]$debugfile = "");
+
+# This powershell file has been generated by the IAR Embedded Workbench
+# C - SPY Debugger, as an aid to preparing a command line for running
+# the cspybat command line utility using the appropriate settings.
+#
+# Note that this file is generated every time a new debug session
+# is initialized, so you may want to move or rename the file before
+# making changes.
+#
+# You can launch cspybat by typing Powershell.exe -File followed by the name of this batch file, followed
+# by the name of the debug file (usually an ELF / DWARF or UBROF file).
+#
+# Read about available command line parameters in the C - SPY Debugging
+# Guide. Hints about additional command line parameters that may be
+# useful in specific cases :
+#   --download_only   Downloads a code image without starting a debug
+#                     session afterwards.
+#   --silent          Omits the sign - on message.
+#   --timeout         Limits the maximum allowed execution time.
+#
+
+
+if ($debugfile -eq "")
+{
+& "C:\iar\ewarm-9.60.2\common\bin\cspybat" -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.general.xcl" --backend -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.driver.xcl" 
+}
+else
+{
+& "C:\iar\ewarm-9.60.2\common\bin\cspybat" -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.general.xcl" --debug_file=$debugfile --backend -f "D:\Camilo\Documents\GitHub\QuarkTS-cpp\check\settings\sa_check.Release.driver.xcl" 
+}

check/Release/BrowseInfo/sa_check.pbw

@@ -418,35 +418,98 @@
 * @c DISABLED states.
 *
 * @section q_critical Critical sections
-* Since the kernel is non-preemptive, the only critical section that must be
-* handled are the shared resources accessed from the ISR context. Perhaps, the
-* most obvious way of achieving mutual exclusion is to allow the kernel to
-* disable interrupts before it enters their critical section and then, enable
-* interrupts after it leaves its critical section.
-*
-* By disabling interrupts, the CPU will be unable to change the current context.
-* This guarantees that the currently running job can use a shared resource
-* without another context accessing it. But, disabling interrupts, is a major
-* undertaking. At best, the system will not be able to service interrupts for
-* the time the current job is doing in its critical section, however, in QuarkTS++,
-* these critical sections are handled as quickly as possible.
-*
-* Considering that the kernel is hardware-independent, the application writer
-* should provide the necessary piece of code to enable and disable interrupts.
-*
-* For this, the qOS::critical::setInterruptsED() method should be used. In this way,
-* communication between ISR and tasks using queued notifications or data queues
-* is performed safely.
-*
-* In some systems, disabling the global IRQ flags is not enough, as they don't
-* save/restore state of interrupt, so here, the @c uint32_t argument and
-* return value in both functions (@c Disabler and @c Restorer) becomes relevant,
-* because they can be used by the application writer to save and restore the
-* current interrupt configuration. So, when a critical section is performed,
-* the @c Disabler, in addition to disabling the interrupts, returns the current
-* configuration to be retained by the kernel, later when the critical section
-* finish, this retained value is passed to @c Restorer to bring back the saved
-* configuration.
+*
+* Since the kernel is non-preemptive, the only critical sections that must be
+* handled are those involving shared resources accessed from ISR context.
+* The most straightforward way to achieve mutual exclusion is to temporarily
+* disable interrupts before entering a critical section and re-enable them
+* afterward.
+*
+* By disabling interrupts, the CPU cannot switch context, ensuring that the
+* currently running job accesses shared resources safely. However, this must
+* be done carefully and only for short periods. In QuarkTS++, critical
+* sections are minimized to keep interrupt latency as small as possible.
+*
+* Because the kernel is hardware-independent, the application developer must
+* provide the specific code for enabling and disabling interrupts.
+*
+* For this purpose, the qOS::critical::setInterruptsED() method should be
+* used. It allows the kernel to safely coordinate communication between ISRs
+* and tasks using queued notifications or data queues.
+*
+* Some MCUs require not only disabling global interrupt flags but also
+* saving and restoring the interrupt configuration. The @c uint32_t argument
+* and return values in the provided @c Disabler and @c Restorer functions are used
+* for this purpose.
+*
+* When a critical section is performed:
+* - The @c Disabler function disables interrupts and returns the previous
+*   interrupt configuration.
+* - The kernel stores this configuration internally.
+* - After the critical section ends, the @c Restorer function restores
+*   the saved configuration.
+*
+*
+* @subsection q_critical_examples Examples
+*
+* @subsubsection regintfcns Registering the interrupt control functions
+*
+* Before using any critical section, the application must register the
+* hardware-specific enable/disable routines:
+*
+* @code{.cpp}
+* using namespace qOS;
+*
+* static uint32_t disableInterrupts() {
+*     uint32_t primask = __get_PRIMASK();  // Read current interrupt state
+*     __disable_irq();                      // Disable all interrupts
+*     return primask;                       // Return the saved state
+* }
+*
+* static void restoreInterrupts(uint32_t primask) {
+*     if (!primask) {
+*         __enable_irq();                   // Restore interrupt state
+*     }
+* }
+*
+* void main( void ) {
+*     critical::setInterruptsED(restoreInterrupts, disableInterrupts);
+*     /* TODO : Setup OS and add tasks*/
+* }
+* @endcode
+*
+*
+* @subsubsection usecritscope Using critical::scope for quick inline protection
+*
+* This construct provides minimal syntax overhead for protecting short
+* critical sections. The section is automatically exited when the scope ends.
+*
+* @code{.cpp}
+* void example() {
+*     // Normal code (non-critical)
+*     critical::scope {
+*         // This block runs with interrupts disabled
+*         sharedCounter++;
+*     }
+*     // Back to normal code (interrupts enabled)
+* }
+* @endcode
+*
+*
+* @subsubsection usecritlock Using critical::lock (RAII-style)
+*
+* The qOS::critical::lock class automatically manages entry and exit of a
+* critical section using RAII semantics. When the object is created, interrupts
+* are disabled; when it goes out of scope, interrupts are restored.
+*
+* @code{.cpp}
+* void example() {
+*     critical::lock lockGuard;   // interrupts disabled here
+*
+*     sharedBuffer.push(value);   // safe shared access
+*
+* } // lockGuard destroyed → interrupts restored
+* @endcode
 *
 * @section q_configmacros Configuration macros
 * Some OS features can be customized using a set of macros located in the header

check/settings/sa_check.Release.cspy.bat

@@ -1,6 +1,6 @@
 cmake_minimum_required( VERSION 3.2 )
 project( quarkts-cpp
-         VERSION 1.7.8
+         VERSION 1.7.9
          DESCRIPTION "An open-source OS for small embedded applications"
          LANGUAGES CXX )
 

check/settings/sa_check.Release.cspy.ps1

@@ -41,8 +41,8 @@ This file is part of the QuarkTS++ OS distribution.
 #ifndef QOS_CPP_H
 #define QOS_CPP_H
 
-#define QUARKTS_CPP_VERSION         "1.7.8"
-#define QUARKTS_CPP_VERNUM          ( 178u )
+#define QUARKTS_CPP_VERSION         "1.7.9"
+#define QUARKTS_CPP_VERNUM          ( 179u )
 #define QUARKTS_CPP_CAPTION         "QuarkTS++ OS " QUARKTS_CPP_VERSION
 
 #include "config/config.h"
@@ -65,8 +65,9 @@ This file is part of the QuarkTS++ OS distribution.
 #include "include/logger.hpp"
 
 namespace qOS {
+    /*cstat -MISRAC++2008-0-1-4_b*/
     namespace build {
-        constexpr const uint32_t number = 4215;
+        constexpr const uint32_t number = 4238;
         constexpr const char* date = __DATE__;
         constexpr const char* time = __TIME__;
         constexpr const char* std = "c++11";
@@ -76,7 +77,7 @@ namespace qOS {
         constexpr const uint8_t number = QUARKTS_CPP_VERNUM;
         constexpr const uint8_t mayor = 1U;
         constexpr const uint8_t minor = 7U;
-        constexpr const uint8_t rev = 8U;
+        constexpr const uint8_t rev = 9U;
     }
     namespace product {
         constexpr const char* author = "J. Camilo Gomez C.";
@@ -90,6 +91,7 @@ namespace qOS {
         constexpr const char* source_model = "Open Source";
         constexpr const char* kernel_type = "Cooperative Real-Time Microkernel";
     }
+    /*cstat +MISRAC++2008-0-1-4_b*/
 }
 
 #endif /*QOS_CPP_H*/

doc/pages/_2_foundations.dox

@@ -65,9 +65,11 @@ namespace qOS {
         *
         * @code{.cpp}
         * void example() {
+        *     // code here : normal section(non-critical)
         *     critical::scope {
         *         // Code here runs in a critical section
         *     }
+        *     // code here, normal section (non-critical)
         * }
         * @endcode
         */

src/CMakeLists.txt

@@ -324,31 +324,25 @@ namespace qOS {
                 void writeNumStr( void ) noexcept;
             public:
                 static _logger& getInstance( void ) noexcept;
+
                 template <typename T>
-                inline _logger& _log_integer( const T& v, bool is_int )
+                auto toLog(const T& v) -> decltype((void)(T(1) % 1), (void)(-T(1)), void()) // only valid for integrals
                 {
-                    /*cstat -MISRAC++2008-5-0-9 -MISRAC++2008-5-0-8*/
-                    if ( is_int ) {
-                        (void)util::integerToString( static_cast<signed_t>( v ), buffer, base ); // skipcq: CXX-C1000
-                    }
-                    else {
-                        (void)util::unsignedToString( static_cast<unsigned_t>( v ), buffer, base ); // skipcq: CXX-C1000
+                    /*cstat -CERT-INT31-C_a -MISRAC++2008-5-0-8 -MISRAC++2008-5-0-9 -MISRAC++2008-0-1-2_b -MISRAC++2008-0-1-2_a*/
+                    if (T(-1) < T(0)) {
+                        (void)util::integerToString(static_cast<signed_t>(v), buffer, base);
+                    } else {
+                        (void)util::unsignedToString(static_cast<unsigned_t>(v), buffer, base);
                     }
-                    /*cstat +MISRAC++2008-5-0-9 +MISRAC++2008-5-0-8*/
+                    /*cstat +CERT-INT31-C_a +MISRAC++2008-5-0-8 +MISRAC++2008-5-0-9 +MISRAC++2008-0-1-2_b +MISRAC++2008-0-1-2_a*/
                     writeNumStr();
-                    return *this;
                 }
 
                 void toLog( const char& v );
                 void toLog( const char * s );
-                void toLog( const short& v );
-                void toLog( const int& v );
-                void toLog( const long int& v );
-                void toLog( const unsigned char& v );
-                void toLog( const unsigned short& v );
-                void toLog( const unsigned int& v );
-                void toLog( const unsigned long& v );
                 void toLog( const void * const p );
+
+                void toLog( const float32_t& v );
                 void toLog( const float64_t& v );
                 void toLog( const lout_base& f );
                 void toLog( const mem& m );
@@ -373,17 +367,17 @@ namespace qOS {
             ChainLoggerProxy( const ChainLoggerProxy& ) = delete;
             ChainLoggerProxy( ChainLoggerProxy&& other ) noexcept : parent( other.parent ) {}
             ~ChainLoggerProxy();
+
+            template<typename T>
+            auto operator<<(const T& v) -> decltype((void)(v + 0), *this)
+            {
+                parent.toLog( v );
+                return *this;
+            }
+
             ChainLoggerProxy& operator<<( const char& v );
             ChainLoggerProxy& operator<<( const char * s );
-            ChainLoggerProxy& operator<<( const short& v );
-            ChainLoggerProxy& operator<<( const int& v );
-            ChainLoggerProxy& operator<<( const long int& v );
-            ChainLoggerProxy& operator<<( const unsigned char& v );
-            ChainLoggerProxy& operator<<( const unsigned short& v );
-            ChainLoggerProxy& operator<<( const unsigned int& v );
-            ChainLoggerProxy& operator<<( const unsigned long& v );
             ChainLoggerProxy& operator<<( const void * const p );
-            ChainLoggerProxy& operator<<( const float64_t& v );
             ChainLoggerProxy& operator<<( const lout_base& f );
             ChainLoggerProxy& operator<<( const mem& m );
             ChainLoggerProxy& operator<<( const pre& m );