VTTest.h

//------------------------------------------------------------------------------
// Module:        VTTest
// Description:   Simple VT100 test runner for renderer validation.
// Author:        R. Zuehlsdorff
// Created:       2026-02-09
// License:       MIT License (https://opensource.org/license/mit/)
//------------------------------------------------------------------------------
 
#pragma once
 
#include <circle/types.h>
 
#include "TConfig.h"
 
class CTRenderer;
 
class CVTTest
{
public:
    struct TVTTestStep
    {
        const char *name;
        const char *sequence;
        const char *hint;
        int expectedRow;
        int expectedCol;
    };
 
    CVTTest(void);
 
    void Initialize(CTRenderer *pRenderer);
 
    void Tick(void);
 
    bool OnKeyPress(const char *pString);
 
    bool IsActive() const;
 
    static constexpr unsigned kMaxSteps = 64;
 
private:
    void Start(void);
    void StartSuite(unsigned index);
    void Stop(void);
    void RunStep(const TVTTestStep &step);
    void ShowHint(const TVTTestStep &step, bool pass);
    void ShowPrompt(void);
    void ShowIntro(void);
    void ShowSummary(void);
    void LogSummary(void);
    void DrawTestFrame(const TVTTestStep &step);
    void StartBoundaryAnimation(bool wrapAroundEnabled, bool marginBellMode);
    void ServiceBoundaryAnimation(unsigned nowTicks);
 
    enum TTestResult
    {
        ResultPending = 0,
        ResultPass,
        ResultFail
    };
 
    enum TBoundaryTestMode
    {
        BoundaryTestNone = 0,
        BoundaryTestWrapOn,
        BoundaryTestWrapOff,
        BoundaryTestMarginBell
    };
 
    CTRenderer *m_pRenderer;
    bool m_bActive;
    bool m_bCompleted;
    bool m_bLastEnabled;
    bool m_bStopRequested = false;
    unsigned m_nStep;
    unsigned m_nNextTick;
    bool m_bWaitForKey;
    bool m_bKeyPressed = false;
    bool m_bHoldClearScreen = false;
    bool m_bSummaryActive = false;
    bool m_bIntroActive = false;
    const TVTTestStep *m_pHoldStep = nullptr;
    bool m_bHoldCursorToggle = false;
 
    unsigned m_suiteIndex = 0;
    const char *m_suiteName = nullptr;
    const TVTTestStep *m_steps = nullptr;
    unsigned m_stepCount = 0;
    bool m_bAwaitNextSuite = false;
    bool m_bShowRulers = true;
    bool m_bTabLayout = false;
 
    static constexpr unsigned kMaxAllResults = 128;
    const char *m_allNames[kMaxAllResults];
    TTestResult m_allResults[kMaxAllResults];
    unsigned m_allCount = 0;
 
    bool m_bScrollTestActive = false;
    unsigned m_scrollLineIndex = 0;
    unsigned m_scrollNextTick = 0;
 
    TBoundaryTestMode m_BoundaryTestMode = BoundaryTestNone;
    unsigned m_BoundaryRow = 0;
    unsigned m_BoundaryStartCol = 0;
    unsigned m_BoundaryCharIndex = 0;
    unsigned m_BoundaryNextTick = 0;
    unsigned m_BoundaryBellCol = 0;
    bool m_BoundaryBellTriggered = false;
    char m_BoundaryChars[24]{};
 
    bool m_bSequencePartsActive = false;
    const char **m_sequenceParts = nullptr;
    unsigned m_sequencePartCount = 0;
    unsigned m_sequencePartIndex = 0;
    unsigned m_sequenceNextTick = 0;
    bool m_bShowPromptAfterSequence = false;
 
    bool m_bPendingResult = false;
    TTestResult m_pendingResult = ResultPending;
 
    bool m_hasSavedTabStops = false;
    bool m_savedTabStops[CTConfig::TabStopsMax]{};
    bool m_hasSavedSmoothScroll = false;
    boolean m_savedSmoothScroll = TRUE;
    bool m_hasSavedWrapAround = false;
    boolean m_savedWrapAround = TRUE;
 
    TTestResult m_TestResults[kMaxSteps];
};