From 46a380b89ae7ec50d728b65df37c37479f127b4f Mon Sep 17 00:00:00 2001 From: DarwinNE Date: Sat, 18 Jan 2020 00:33:55 +0100 Subject: [PATCH] Implement suggestions from the code review of the pull request #103. --- Console/ConsoleTest.cc | 2 +- Console/readme.txt | 15 ++-- Console/retro/Console.cc | 142 +++++++++++++-------------------- Console/retro/Console.h | 23 +++--- Console/retro/ConsoleWindow.cc | 5 +- 5 files changed, 78 insertions(+), 109 deletions(-) diff --git a/Console/ConsoleTest.cc b/Console/ConsoleTest.cc index 7d02558f4b..ce8fa7e896 100644 --- a/Console/ConsoleTest.cc +++ b/Console/ConsoleTest.cc @@ -10,7 +10,7 @@ int main() { retro::InitConsole(); std::string out = "\033]0;Hello world win\007Hello, \033[1mexternal world of \033[0m\033[3mtrue beauty and \033[4mgreatness\033[0m.\nEnter \"exit\" to quit.\n"; - //std::string out = "Hello, \033[1mexternal world of \033[0m\033[3mtrue beauty and \033[4mgreatness\033[0m.\nEnter \"exit\" to quit.\n"; + retro::Console::currentInstance->write(out.data(), out.size()); std::string in; diff --git a/Console/readme.txt b/Console/readme.txt index 6abd8b4d30..b3ddcdcb95 100644 --- a/Console/readme.txt +++ b/Console/readme.txt @@ -1,17 +1,18 @@ - IConsole + Console -This is a slightly improved version of Retro68's Console library, offering a -support for a subset of ANSI control sequences. +This library provides a simple console library, offering a limited support for ANSI control sequences. Here is a list of the supported sequences and their meaning: -ESC[0m Reset all text style -ESC[1m Bold font (*) -ESC[3m Italic font -ESC[4m Underline font +ESC[0m Reset all text style +ESC[1m Bold font (*) +ESC[3m Italic font +ESC[4m Underline font +ESC]0;NewnameBEL Set the window title to "Newname" (**) NOTES: (*) Obtained with bold + condense style together, so that the character grid remains regular (this way, the width of bold characters remains the same as regular ones). +(**) BEL is ASCII character 7. diff --git a/Console/retro/Console.cc b/Console/retro/Console.cc index 9fea2fb5f2..cb11ced0a8 100644 --- a/Console/retro/Console.cc +++ b/Console/retro/Console.cc @@ -30,6 +30,9 @@ using namespace retro; +const char BEL = 7; +const char MAX_LEN = 250; + Console *Console::currentInstance = NULL; Attributes::Attributes(void) @@ -162,7 +165,7 @@ void Console::Init(GrafPtr port, Rect r) onscreen = chars; cursorX = cursorY = 0; - isProcessingEscSequence=false; + sequenceState=State::noSequence; } void Console::SetAttributes(Attributes aa) @@ -265,82 +268,22 @@ void Console::ScrollUp(short n) dirtyRect.bottom = dirtyRect.bottom > 0 ? dirtyRect.bottom - 1 : 0; } -void Console::ProcessOSCseq(char c) +bool Console::ProcessEscSequence(char c) { - switch(sequenceStep) + switch(sequenceState) { - case 1: - if(c!='0') // The only recognized sequence is OSC 0; - { - OSCseq=false; - sequenceStep=0; - return; - } - ++sequenceStep; - break; - case 2: - if(c!=';') // The only recognized sequence is OSC 0; - { - OSCseq=false; - sequenceStep=0; - return; - } - ++sequenceStep; - windowName=""; - break; - default: - if(c==BEL) // The BEL character ends the sequence. - { - setWindowName(windowName); - OSCseq=false; - isProcessingEscSequence=false; - sequenceStep=0; - } + case State::noSequence: + return false; // Break is not needed there. + case State::waitingForSequenceStart: + if(c=='[') + sequenceState=State::waitingForControlSequence; + else if(c==']') + sequenceState=State::waitingForOSCStart; else - { - windowName+=c; - ++sequenceStep; - } - } -} - -void Console::ProcessEscSequence(char c) -{ - if(sequenceStep>0 && OSCseq) - { - ProcessOSCseq(c); - //sequenceStep=0; - //isProcessingEscSequence=false; - return; - } - if(sequenceStep>MAX_LEN) - { - // Sequence is too long! - sequenceStep=0; - isProcessingEscSequence=false; - return; - } - - switch(sequenceStep) - { - case 0: - if(c=='[') // Control Sequence Introducer - { - OSCseq=false; - ++sequenceStep; - } - else if(c==']') // Operating System Command - { - OSCseq=true; - ++sequenceStep; - } - else - { - isProcessingEscSequence=false; - } + sequenceState=State::noSequence; // Unrecognized sequence break; - case 1: - ++sequenceStep; + case State::waitingForControlSequence: + sequenceState=State::waitingForM; switch(c) { case '0': // Normal character @@ -356,36 +299,61 @@ void Console::ProcessEscSequence(char c) currentAttr.setUnderline(true); break; default: - isProcessingEscSequence=false; + sequenceState=State::noSequence; // Unrecognized sequence } break; - case 2: + case State::waitingForM: if(c=='m') - isProcessingEscSequence=false; - else if(c==';') - sequenceStep=1; + sequenceState=State::noSequence; // Normal end of sequence else - isProcessingEscSequence=false; + sequenceState=State::noSequence; // Unrecognized sequence (but we end it anyway!) + break; + case State::waitingForOSCStart: + if(c=='0') + sequenceState=State::waitingForSemicolon; + else + sequenceState=State::noSequence; // Normal end of sequence + break; + case State::waitingForSemicolon: + if(c==';') + { + sequenceState=State::inWindowName; + windowName=""; + } + else + sequenceState=State::noSequence; // Normal end of sequence + break; + case State::inWindowName: + if(c==BEL) + { + setWindowName(std::move(windowName)); + sequenceState=State::noSequence; // Normal end of sequence + } + else + { + if(windowName.size() < MAX_LEN) + windowName+=c; + } break; default: - sequenceStep=0; - isProcessingEscSequence=false; + sequenceState=State::noSequence; + break; } + return true; } void Console::PutCharNoUpdate(char c) { - if(isProcessingEscSequence) - { - ProcessEscSequence(c); + if(ProcessEscSequence(c)) return; - } + InvalidateCursor(); switch(c) { case '\033': // Begin of an ANSI escape sequence - isProcessingEscSequence=true; - sequenceStep=0; + //isProcessingEscSequence=true; + //sequenceStep=0; + sequenceState=State::waitingForSequenceStart; break; case '\r': cursorX = 0; diff --git a/Console/retro/Console.h b/Console/retro/Console.h index c30e7cb7b3..7ace8b3500 100644 --- a/Console/retro/Console.h +++ b/Console/retro/Console.h @@ -27,9 +27,6 @@ #include #include -#define BEL 7 -#define MAX_LEN 250 - namespace retro { class Attributes @@ -62,8 +59,16 @@ namespace retro AttributedChar(char cc, Attributes aa) {c=cc; attrs=aa;} }; -// inline bool operator==(const Attributes& lhs, const Attributes& rhs); -// inline bool operator!=(const Attributes& lhs, const Attributes& rhs); + enum class State + { + noSequence, + waitingForSequenceStart, + waitingForControlSequence, + waitingForM, + waitingForOSCStart, + waitingForSemicolon, + inWindowName + }; class Console { @@ -94,15 +99,14 @@ namespace retro bool IsEOF() const { return eof; } private: + + State sequenceState; std::string windowName; GrafPtr consolePort = nullptr; Rect bounds; Attributes currentAttr; std::vector chars, onscreen; - bool isProcessingEscSequence; - int sequenceStep; - bool OSCseq; short cellSizeX; short cellSizeY; @@ -126,8 +130,7 @@ namespace retro void DrawCell(short x, short y, bool erase = true); void DrawCells(short x1, short x2, short y, bool erase = true); void ScrollUp(short n = 1); - void ProcessEscSequence(char c); - void ProcessOSCseq(char c); + bool ProcessEscSequence(char c); void SetAttributes(Attributes aa); void InvalidateCursor(); diff --git a/Console/retro/ConsoleWindow.cc b/Console/retro/ConsoleWindow.cc index 367d00c45f..cc29e6f262 100644 --- a/Console/retro/ConsoleWindow.cc +++ b/Console/retro/ConsoleWindow.cc @@ -36,10 +36,7 @@ namespace ConsoleWindow::ConsoleWindow(Rect r, ConstStr255Param title) { GrafPtr port; - //Retro68 Improved Console - win = NewWindow(NULL, &r, "\p", true, 0, (WindowPtr)-1, true, 0); - setWindowName("Retro68 Console"); - + win = NewWindow(NULL, &r, "\pRetro68 Console", true, 0, (WindowPtr)-1, true, 0); #if !TARGET_API_MAC_CARBON port = win;