TConfig.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Module:        CTConfig
// Description:   Loads VT100 configuration from storage and exposes runtime settings.
// Author:        R. Zuehlsdorff, ralf.zuehlsdorff@t-online.de
// Created:       2026-01-18
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
// Change Log:
// 2026-01-18     R. Zuehlsdorff        Initial creation
//------------------------------------------------------------------------------
 
#pragma once
 
// Include Circle core components
#include <circle/sched/task.h>
#include <circle/string.h>
#include <fatfs/ff.h>
 
#include "TColorPalette.h"
#include "TFontConverter.h"
 
// Forward declarations and includes for classes used in this module
class CKernel;
 
// Simple config parameter structure
struct TConfigParam
{
    const char *keyword;
    unsigned int *variable;    // Pointer to integer variable
    unsigned int defaultValue; // Default value
    const char *description;   // Description with value meanings
};
 
class CTConfig : public CTask
{
public:
    static constexpr unsigned int TabStopsMax = 160U;
    static CTConfig *Get(void);
 
    CTConfig(void);
    ~CTConfig(void);
 
    boolean Initialize(void);
 
    void Run() override;
 
    boolean LoadFromFile(void);
    boolean SaveToFile(void);
 
    // --- Configuration Parameters: Getters and Setters ---
 
    unsigned int GetLineEndingMode(void) const { return m_LineEnding; }
    void SetLineEndingMode(unsigned int mode);
 
    unsigned int GetBaudRate(void) const { return m_BaudRate; }
    void SetBaudRate(unsigned int baudRate);
 
    boolean GetCursorBlock(void) const { return m_CursorType != 0; }
    void SetCursorBlock(boolean block);
 
    boolean GetCursorBlinking(void) const { return m_CursorBlinking != 0; }
    void SetCursorBlinking(boolean blinking);
 
    boolean GetVTTestEnabled(void) const { return m_VTTestEnabled != 0; }
    void SetVTTestEnabled(boolean enabled);
 
    boolean GetVT52ModeEnabled(void) const { return m_VT52Mode != 0; }
    void SetVT52ModeEnabled(boolean enabled);
 
    unsigned int GetLogOutput(void) const { return m_LogOutput; }
    void SetLogOutput(unsigned int logOutput);
 
    const char *GetLogFileName(void) const { return m_LogFileName; }
    void SetLogFileName(const char *pFileName);
 
    EColorSelection GetTextColor(void) const { return m_TextColorIndex; }
    void SetTextColor(EColorSelection color);
 
    EColorSelection GetBackgroundColor(void) const { return m_BackgroundColorIndex; }
    void SetBackgroundColor(EColorSelection color);
 
    EFontSelection GetFontSelection(void) const { return static_cast<EFontSelection>(m_FontSelection); }
    void SetFontSelection(EFontSelection selection);
 
    unsigned int GetBuzzerVolume(void) const { return m_BuzzerVolume; }
    void SetBuzzerVolume(unsigned int volume);
 
    unsigned int GetKeyClick(void) const { return m_KeyClick; }
    void SetKeyClick(boolean enabled);
 
    unsigned int GetSwitchTxRx(void) const { return m_SwitchTxRx; }
    void SetSwitchTxRx(boolean enabled);
 
    unsigned int GetWlanHostAutoStart(void) const { return m_WlanHostAutoStart; }
    void SetWlanHostAutoStart(boolean enabled);
 
    unsigned int GetKeyRepeatDelayMs(void) const { return m_KeyRepeatDelayMs; }
    boolean GetKeyAutoRepeatEnabled(void) const { return m_KeyAutoRepeat != 0; }
    void SetKeyAutoRepeatEnabled(boolean enabled);
    void SetKeyRepeatDelayMs(unsigned int delayMs);
 
    unsigned int GetKeyRepeatRateCps(void) const { return m_KeyRepeatRateCps; }
    void SetKeyRepeatRateCps(unsigned int rateCps);
 
    boolean GetScreenInverted(void) const { return m_ScreenInverted != 0; }
    void SetScreenInverted(boolean inverted);
 
    boolean GetSmoothScrollEnabled(void) const { return m_SmoothScrollEnabled != 0; }
    void SetSmoothScrollEnabled(boolean enabled);
 
    boolean GetWrapAroundEnabled(void) const { return m_WrapAroundEnabled != 0; }
    void SetWrapAroundEnabled(boolean enabled);
 
    unsigned int GetSerialDataBits(void) const { return m_SerialDataBits; }
    void SetSerialDataBits(unsigned int dataBits);
 
    unsigned int GetSerialParityMode(void) const { return m_SerialParityMode; }
    void SetSerialParityMode(unsigned int parityMode);
 
    boolean GetSoftwareFlowControl(void) const { return m_SoftwareFlowControl != 0; }
    void SetSoftwareFlowControl(boolean enabled);
 
    boolean GetMarginBellEnabled(void) const { return m_MarginBellEnabled != 0; }
    void SetMarginBellEnabled(boolean enabled);
 
    // --- End Configuration Parameters ---
 
    void ResolveLogOutputs(bool &screen, bool &file, bool &wlan) const;
    const char *GetLineEndingModeString(void) const;
    void logConfig(void) const;
 
    bool IsTabStop(unsigned int column) const;
    void SetTabStop(unsigned int column, bool enabled);
    void InitDefaultTabStops(unsigned int columns = TabStopsMax);
 
private:
    boolean LoadConfigFromFile(void);
    void LoadDefaults(void);
    boolean ParseConfigLine(const char *pLine);
    void TrimWhitespace(char *pString);
 
    // Configuration variables (all integers for simplicity)
    unsigned int m_LineEnding;              // 0=LF, 1=CRLF
    unsigned int m_BaudRate;                // Baud rate
    unsigned int m_CursorType;              // 0=underline, 1=block
    unsigned int m_CursorBlinking;          // 0=steady, 1=blinking
    unsigned int m_VTTestEnabled;           // 0=off, 1=on
    unsigned int m_VT52Mode;                // 0=ANSI, 1=VT52
    unsigned int m_LogOutput;               // bitmask: 1=screen, 2=file, 4=wlan
    EColorSelection m_TextColorIndex;       // Color index for text (EColorSelection)
    EColorSelection m_BackgroundColorIndex; // Color index for background (EColorSelection)
    unsigned int m_FontSelection;           // Encoded font selection identifier
    unsigned int m_BuzzerVolume;            // 0-100% duty cycle for buzzer
    unsigned int m_KeyClick;                // 0=disabled, 1=enabled key click feedback
    unsigned int m_SwitchTxRx;              // 0=normal wiring, 1=swap TX/RX via GPIO16
    unsigned int m_WlanHostAutoStart;       // 0=command/log mode on connect, 1=host mode auto-start
    unsigned int m_KeyAutoRepeat;           // 0=disabled, 1=enabled keyboard auto-repeat
    unsigned int m_KeyRepeatDelayMs;        // Key repeat delay in milliseconds
    unsigned int m_KeyRepeatRateCps;        // Repeat frequency in characters per second
    unsigned int m_ScreenInverted;          // 0=normal, 1=swap fg/bg screen colors
    unsigned int m_SmoothScrollEnabled;     // 0=off, 1=on smooth scrolling animation
    unsigned int m_WrapAroundEnabled;       // 0=off hold at right margin, 1=on wrap to next line
    unsigned int m_SerialDataBits;          // UART data bits (7 or 8)
    unsigned int m_SerialParityMode;        // UART parity (0=none, 1=even, 2=odd)
    unsigned int m_SoftwareFlowControl;     // 0=off, 1=on software flow control (XON/XOFF)
    unsigned int m_MarginBellEnabled;       // 0=off, 1=on margin bell (8 columns before right margin)
    char m_LogFileName[64];                 // Log filename (string, special handling)
    bool m_TabStops[TabStopsMax];           // Tab stop positions (0-based columns)
 
    static const char ConfigFileName[];
    TConfigParam s_ConfigParams[24]; // Instance array for config params
};