Runtime blocks INIT/TERM

Author: nzeemin

README.md

@@ -67,9 +67,10 @@ Current state of the project: **prototype**
 Результат компиляции (только основной код, без рантайма):
 ```assembler
 START:
-	MTPS	#340		; disable interrupts
+; Инициализация программы
+	MTPS	#340			; disable interrupts
 	CLR	@#177560
-	MTPS	#0		; enable interrupts
+	MTPS	#0			; enable interrupts
 	MOV	SP, SAVESP
 ; 10 A%=23.42
 N10:
@@ -80,6 +81,7 @@ N20:
 	CALL	WRINT		; PRINT Integer
 	CALL	WREOL
 LEND:
+; Завершение программы
 SAVESP = . + 2
 	MOV	#776, SP	; restore SP
 	EMT	350		; .EXIT

generator.cpp

@@ -195,12 +195,15 @@ static string GET_CONSTEXPR_INT_VALUE_AS_CLRMOV(ExpressionModel expr)
 //////////////////////////////////////////////////////////////////////
 
 
-Generator::Generator(SourceModel* source, FinalModel* final)
-    : m_source(source), m_final(final), m_lineindex(-1), m_line(nullptr),
-    m_runtimeneeds(), m_notimplemented()
+Generator::Generator(SourceModel* source, FinalModel* final,
+        const std::vector<string>* initlines, const std::vector<string>* termlines)
+    : m_source(source), m_final(final), m_initlines(initlines), m_termlines(termlines),
+    m_lineindex(-1), m_line(nullptr), m_local(0), m_runtimeneeds(), m_notimplemented()
 {
     assert(source != nullptr);
     assert(final != nullptr);
+    assert(initlines != nullptr);
+    assert(termlines != nullptr);
 }
 
 void Generator::AddRuntimeCall(RuntimeSymbol rtsymbol, string comment)
@@ -226,25 +229,14 @@ void Generator::AddRuntimeCall(RuntimeSymbol rtsymbol, string comment)
 void Generator::ProcessBegin()
 {
     AddLine("START:");
-    if (g_platform == PlatformUKNC)
-    {
-        AddLine("\tMTPS\t#340\t; disable interrupts");
-        AddLine("\tCLR\t@#177560");
-        AddLine("\tMTPS\t#0\t; enable interrupts");
-    }
-    AddLine("\tMOV\tSP, SAVESP");
+
+    // Copy initialization code from the runtime template
+    for (const string& line : *m_initlines)
+        m_final->AddLine(line);
 }
 
 void Generator::ProcessEnd()
 {
-    AddLine("LEND:");
-    AddLine("SAVESP = . + 2");
-    AddLine("\tMOV\t#776, SP\t; restore SP");
-    if (g_platform == PlatformBK0010)
-        AddLine("\tRETURN\t; return to Monitor/OS/etc.");
-    else if (g_platform == PlatformUKNC)
-        AddLine("\tEMT\t350\t; .EXIT");
-
     // Enumerate all the prepared lines to format them properly
     for (string& line : m_final->lines)
     {
@@ -270,6 +262,12 @@ void Generator::ProcessEnd()
         }
     }
 
+    AddLine("LEND:");
+
+    // Copy termination code from the runtime template
+    for (const string& line : *m_termlines)
+        m_final->AddLine(line);
+
     GenerateStrings();
 
     GenerateVariables();

main.cpp

@@ -1,4 +1,5 @@
 
+#include <cassert>
 #include <cstdio>
 #include <iostream>
 #include <fstream>
@@ -50,7 +51,6 @@ TargetPlatform FindPlatformByName(const string& name)
     return PlatformNone;
 }
 
-
 void RegisterError()
 {
     g_errorcount++;
@@ -274,15 +274,6 @@ void ProcessFiles()
         exit(EXIT_FAILURE);
     }
 
-    // Generation
-    Generator generator(&g_source, &g_final);
-    g_errorcount = 0;
-    while (generator.ProcessLine())
-        ;
-
-    const std::set<RuntimeSymbol> runtimeneeds = generator.GetRuntimeNeeds();
-    RuntimeGenerator runtimegen(runtimeneeds, &g_final);
-
     // Read and parse the runtime template
     std::ifstream rttplstream;
     rttplstream.open(g_rttplfilepath);
@@ -291,11 +282,32 @@ void ProcessFiles()
         std::cerr << "Failed to open runtime template file " + g_rttplfilepath << std::endl;
         exit(EXIT_FAILURE);
     }
+    RuntimeGenerator runtimegen(&g_final);
     runtimegen.ParseRuntimeTemplate(&rttplstream);
     rttplstream.close();
 
+    // Generation
+    std::vector<string> initlines;
+    runtimegen.GetRuntimeBlock(RuntimeINIT, initlines);
+    std::vector<string> termlines;
+    runtimegen.GetRuntimeBlock(RuntimeTERM, termlines);
+
+    if (g_errorcount > 0)
+    {
+        std::cerr << "Generation ERRORS: " << g_errorcount << std::endl;
+        exit(EXIT_FAILURE);
+    }
+    assert(!initlines.empty());
+    assert(!termlines.empty());
+
+    Generator generator(&g_source, &g_final, &initlines, &termlines);
+    g_errorcount = 0;
+    while (generator.ProcessLine())
+        ;
+
     // Generate runtime
-    runtimegen.GenerateRuntime();
+    const std::set<RuntimeSymbol> runtimeneeds = generator.GetRuntimeNeeds();
+    runtimegen.GenerateRuntime(runtimeneeds);
 
     if (g_errorcount > 0)
     {

main.h

@@ -107,30 +107,31 @@ enum TargetPlatform
     PlatformUKNC        = 2,
 };
 
+//NOTE: This enum should be in the same order as RuntimeSymbolNames array in model.cpp
 enum RuntimeSymbol
 {
     RuntimeNone         = 0,
-    RuntimeWRCH         = 1,
-    RuntimeWREOL        = 2,
-    RuntimeWRAT         = 3,
-    RuntimeWRSPC        = 4,
-    RuntimeWRTAB        = 5,
-    RuntimeWRCOM        = 6,
-    RuntimeWRINT        = 7,
-    RuntimeWRSNG        = 8,
-    RuntimeWRST         = 9,   // Write String
-    RuntimeSTOP         = 10,  // Show stop message and stop
-    RuntimeERRR         = 11,  // Show error message and stop
-    RuntimeReserved1    = 12,
-    RuntimeGETCR        = 13,
-    RuntimeCURSR        = 14,
-    RuntimeINPU         = 15,  // INPUT read to buffer
-    RuntimeINPI         = 16,  // INPUT Integer
-    RuntimeIMUL         = 17,
-    RuntimeIDIV         = 18,
-    RuntimeITOF         = 19,  // Integer to Single conversion
-    RuntimeFTOI         = 20,  // Single to Integer conversion
-    RuntimeReserved2    = 21,
+    RuntimeINIT         = 1,   // Initialization code to copy into the assembly code
+    RuntimeTERM         = 2,   // Termination code to copy into the assembly code
+    RuntimeWRCH         = 3,
+    RuntimeWREOL        = 4,
+    RuntimeWRAT         = 5,
+    RuntimeWRSPC        = 6,
+    RuntimeWRTAB        = 7,
+    RuntimeWRCOM        = 8,
+    RuntimeWRINT        = 9,
+    RuntimeWRSNG        = 10,
+    RuntimeWRST         = 11,  // Write String
+    RuntimeSTOP         = 12,  // Show stop message and stop
+    RuntimeERRR         = 13,  // Show error message and stop
+    RuntimeGETCR        = 14,
+    RuntimeCURSR        = 15,
+    RuntimeINPU         = 16,  // INPUT read to buffer
+    RuntimeINPI         = 17,  // INPUT Integer
+    RuntimeIMUL         = 18,
+    RuntimeIDIV         = 19,
+    RuntimeITOF         = 20,  // Integer to Single conversion
+    RuntimeFTOI         = 21,  // Single to Integer conversion
     RuntimeFUNPK        = 22,  // Print Single to buffer
     RuntimeFFIX         = 23,
     RuntimeFINT         = 24,
@@ -158,6 +159,7 @@ enum RuntimeSymbol
     RuntimeINKEY        = 46,
     RuntimeSTCP         = 47,  // String copy
     RuntimeCOLR         = 48,  // COLOR
+    __RuntimeSymbol_SIZE__
 };
 
 
@@ -639,13 +641,16 @@ class Generator
 {
     SourceModel*    m_source;
     FinalModel*     m_final;
+    const std::vector<string>* m_initlines;
+    const std::vector<string>* m_termlines;
     int             m_lineindex;
     SourceLineModel* m_line;    // Curent line being generated
     int             m_local;    // Counter for local labels within the current line
     std::set<RuntimeSymbol> m_runtimeneeds;
     std::set<KeywordIndex> m_notimplemented;  // Statements/functions used but not implemented
 public:
-    Generator(SourceModel* source, FinalModel* intermed);
+    Generator(SourceModel* source, FinalModel* intermed,
+        const std::vector<string>* initlines, const std::vector<string>* termlines);
 public:
     void ProcessBegin();
     bool ProcessLine();
@@ -763,10 +768,11 @@ class RuntimeGenerator
     FinalModel* m_final;
     std::vector<RuntimeBlock> m_rtblocks;
 public:
-    RuntimeGenerator(const std::set<RuntimeSymbol>& needs, FinalModel* intermed);
+    RuntimeGenerator(FinalModel* intermed);
 public:
     void ParseRuntimeTemplate(std::istream* pInput);
-    void GenerateRuntime();
+    void GenerateRuntime(const std::set<RuntimeSymbol>& needs);
+    void GetRuntimeBlock(RuntimeSymbol rtsymbol, std::vector<string>& copyto);
 private:
     RuntimeBlock FindRuntimeBlock(RuntimeSymbol rtsymbol);
     void AddLine(const string& str) { m_final->AddRuntimeLine(str); }

model.cpp

@@ -566,17 +566,16 @@ void FinalModel::AddRuntimeLine(const string& str)
 // The table has the same procedures in the same order as RuntimeSymbol enum
 const char* RuntimeSymbolNames[] = {
     "", // None
+    "INIT", "TERM",
     "WRCH", "WREOL", "WRAT", "WRSPC", "WRTAB", "WRCOM",
     "WRINT", "WRSNG", "WRST",
     "STOP",
     "ERRR",
-    "",  // Reserved
     "GETCR", "CURSR",
     "INPU",
     "INPI",
     "IMUL", "IDIV",
     "ITOF", "FTOI",
-    "",  // Reserved
     "FUNPK", "FFIX", "FINT",
     "FCMP", "FSGN",
     "",  // Reserved
@@ -594,6 +593,9 @@ const char* RuntimeSymbolNames[] = {
 
 string GetRuntimeSymbolName(RuntimeSymbol rtsymbol)
 {
+    // Make sure RuntimeSymbolNames array has the same size as RuntimeSymbol enum
+    assert(__RuntimeSymbol_SIZE__ == sizeof(RuntimeSymbolNames) / sizeof(const char*));
+
     if (rtsymbol < sizeof(RuntimeSymbolNames) / sizeof(const char*))
         return RuntimeSymbolNames[rtsymbol];
 

runtime-BK0010.tmac

@@ -1,5 +1,19 @@
-; Шаблон рантайм процедур для БК-0010
+; Шаблон рантайма для БК-0010
 ;
+
+;#####################################################################
+;## INIT
+; Инициализация программы
+	MOV	SP, SAVESP
+
+;#####################################################################
+;## TERM
+; Завершение программы
+SAVESP = . + 2
+	MOV	#776, SP	; restore SP
+	RETURN			; return to Monitor/OS/etc.
+
+
 ;#####################################################################
 ;## WRCH
 ; Печать одного символа; R0 = символ

runtime-UKNC.tmac

@@ -1,5 +1,22 @@
 ; Шаблон рантайм процедур для УКНЦ
 ;
+
+;#####################################################################
+;## INIT
+; Инициализация программы
+	MTPS	#340		; disable interrupts
+	CLR	@#177560
+	MTPS	#0		; enable interrupts
+	MOV	SP, SAVESP
+
+;#####################################################################
+;## TERM
+; Завершение программы
+SAVESP = . + 2
+	MOV	#776, SP	; restore SP
+	EMT	350		; .EXIT
+
+
 ;#####################################################################
 ;## WRCH
 ; Печать одного символа; R0 = символ

runtime.cpp

@@ -8,8 +8,8 @@
 //////////////////////////////////////////////////////////////////////
 
 
-RuntimeGenerator::RuntimeGenerator(const std::set<RuntimeSymbol>& needs, FinalModel* intermed)
-    : m_needs(needs), m_final(intermed)
+RuntimeGenerator::RuntimeGenerator(FinalModel* intermed)
+    : m_final(intermed)
 {
     assert(intermed != nullptr);
 }
@@ -97,8 +97,25 @@ RuntimeBlock RuntimeGenerator::FindRuntimeBlock(RuntimeSymbol rtsymbol)
     return RuntimeBlock();  // empty block
 }
 
-void RuntimeGenerator::GenerateRuntime()
+void RuntimeGenerator::GetRuntimeBlock(RuntimeSymbol rtsymbol, std::vector<string>& copyto)
 {
+    RuntimeBlock rtblock = FindRuntimeBlock(rtsymbol);
+    if (rtblock.rtsymbol == RuntimeNone)
+    {
+        string rtsymbolname = GetRuntimeSymbolName(rtsymbol);
+        std::cerr << "Runtime block \'" << rtsymbolname << "\' not found." << std::endl;
+        RegisterError();
+        return;
+    }
+
+    std::copy(rtblock.lines.begin(), rtblock.lines.end(), std::back_inserter(copyto));
+}
+
+void RuntimeGenerator::GenerateRuntime(const std::set<RuntimeSymbol>& needs)
+{
+    for (RuntimeSymbol rtsymbol : needs)
+        m_needs.insert(rtsymbol);
+
     std::vector<RuntimeSymbol> listnewneeds;
     std::copy(m_needs.begin(), m_needs.end(), std::back_inserter(listnewneeds));
     while (true)