coco-tools 0.8__tar.gz → 0.17__tar.gz

{coco-tools-0.8/coco_tools.egg-info → coco-tools-0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: coco-tools
-Version: 0.8
+Version: 0.17
 Summary: TRS-80 Color Computer Tools
 Home-page: https://github.com/jamieleecho/coco-tools
 Author: Jamie Cho
@@ -12,7 +12,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
+Requires-Python: >=3.9.19
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -35,14 +35,14 @@ python3 setup.py
 
 ## Tools
 
-### [decb-to-b09](README.decb-to-b09.md)
+### [decb-to-b09](./README.decb-to-b09.md)
 
 ```
-usage: decb-to-b09 [-h] [--version] [-l] [-z] program.bas program.b09
+usage: decb-to-b09 [-h] [--version] [-l] [-z] [-D] [-w] program.bas program.b09
 
 Convert a Color BASIC program to a BASIC09 program
 Copyright (c) 2023 by Jamie Cho
-Version: 0.7
+Version: 0.8
 
 positional arguments:
   program.bas           input DECB text program file
@@ -55,6 +55,10 @@ options:
                         Filter out line numbers not referenced by the program
   -z, --dont-initialize-vars
                         Don't pre-initialize all variables
+  -D, --dont-output-dependencies
+                        Don't output required dependencies
+  -w, --dont-run-width-32
+                        if set don't run the default width 32
 ```
 
 ### cm3toppm
@@ -246,4 +250,20 @@ docker-compose run test
 
 # Run tests using the source on the host computer
 docker-compose run testv
+
+# To make changes and develop locally
+pip install -r requirements.txt
+pre-commit install
 ```
+
+## Credits
+The programs in the examples/decb and examples/other-decb-examples-to-try directories are from the following sources:
+* alien4k0.bas -- https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4
+* bach.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10
+* banner.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10
+* cadnza.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10
+* cflip.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10
+* loops.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
+* f15eagle.bas -- https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip
+* mars.bas -- https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars
+* saints.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf

{coco-tools-0.8 → coco-tools-0.17}/README.md

@@ -17,14 +17,14 @@ python3 setup.py
 
 ## Tools
 
-### [decb-to-b09](README.decb-to-b09.md)
+### [decb-to-b09](./README.decb-to-b09.md)
 
 ```
-usage: decb-to-b09 [-h] [--version] [-l] [-z] program.bas program.b09
+usage: decb-to-b09 [-h] [--version] [-l] [-z] [-D] [-w] program.bas program.b09
 
 Convert a Color BASIC program to a BASIC09 program
 Copyright (c) 2023 by Jamie Cho
-Version: 0.7
+Version: 0.8
 
 positional arguments:
   program.bas           input DECB text program file
@@ -37,6 +37,10 @@ options:
                         Filter out line numbers not referenced by the program
   -z, --dont-initialize-vars
                         Don't pre-initialize all variables
+  -D, --dont-output-dependencies
+                        Don't output required dependencies
+  -w, --dont-run-width-32
+                        if set don't run the default width 32
 ```
 
 ### cm3toppm
@@ -228,4 +232,20 @@ docker-compose run test
 
 # Run tests using the source on the host computer
 docker-compose run testv
-```
+
+# To make changes and develop locally
+pip install -r requirements.txt
+pre-commit install
+```
+
+## Credits
+The programs in the examples/decb and examples/other-decb-examples-to-try directories are from the following sources:
+* alien4k0.bas -- https://github.com/jggames/trs80mc10/blob/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Arcade/4K/Alien4K/ALIEN4K0.TXT#L4
+* bach.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/bach.c10
+* banner.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/banner.c10
+* cadnza.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cadnza.c10
+* cflip.bas -- https://colorcomputerarchive.com/repo/MC-10/Software/Books/TRS-80%20Color%20Computer%20%26%20MC-10%20Programs/cflip.c10
+* loops.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf
+* f15eagle.bas -- https://colorcomputerarchive.com/repo/Disks/Magazines/Rainbow%20On%20Disk.zip
+* mars.bas -- https://github.com/jggames/trs80mc10/tree/9df4c9578250009d68a03101d626faa3c22e7445/quicktype/Text%20Adventures/WorkInProgress/Mars
+* saints.bas -- https://colorcomputerarchive.com/repo/Documents/Manuals/Hardware/Color%20Computer%203%20Extended%20Basic%20(Tandy).pdf

{coco-tools-0.8 → coco-tools-0.17}/coco/__init__.py

@@ -1,2 +1,2 @@
 # __version__ MUST be defined on line 2
-__version__ = "0.8"
+__version__ = "0.17"

coco-tools-0.17/coco/b09/__init__.py

@@ -0,0 +1 @@
+DEFAULT_STR_STORAGE: int = 32

coco-tools-0.17/coco/b09/compiler.py

@@ -0,0 +1,260 @@
+from typing import List
+
+from coco import b09
+from coco.b09 import error_handler
+from coco.b09.elements import (
+    Basic09CodeStatement,
+    BasicExpressionList,
+    BasicLine,
+    BasicLiteral,
+    BasicOnBrkGoStatement,
+    BasicOnErrGoStatement,
+    BasicRunCall,
+    BasicVar,
+)
+from coco.b09.grammar import grammar, PROCNAME_REGEX
+from coco.b09.parser import BasicVisitor
+from coco.b09.procbank import ProcedureBank
+from coco.b09.prog import BasicProg
+from coco.b09.visitors import (
+    BasicEmptyDataElementVisitor,
+    BasicFunctionalExpressionPatcherVisitor,
+    BasicHbuffPresenceVisitor,
+    BasicInputStatementPatcherVisitor,
+    BasicNextPatcherVisitor,
+    BasicPrintStatementPatcherVisitor,
+    BasicReadStatementPatcherVisitor,
+    DeclareImplicitArraysVisitor,
+    GetDimmedArraysVisitor,
+    JoystickVisitor,
+    LineNumberFilterVisitor,
+    LineNumberCheckerVisitor,
+    LineReferenceVisitor,
+    LineZeroFilterVisitor,
+    SetDimStringStorageVisitor,
+    StatementCollectorVisitor,
+    StrVarAllocatorVisitor,
+    VarInitializerVisitor,
+)
+
+
+class ParseError(Exception):
+    pass
+
+
+def convert(
+    progin: str,
+    *,
+    add_standard_prefix: bool = True,
+    add_suffix: bool = True,
+    default_str_storage: int = b09.DEFAULT_STR_STORAGE,
+    default_width32: bool = True,
+    filter_unused_linenum: bool = False,
+    initialize_vars: bool = False,
+    output_dependencies: bool = False,
+    procname: str = "",
+    skip_procedure_headers: bool = False,
+) -> str:
+    tree = grammar.parse(progin)
+    bv = BasicVisitor()
+    basic_prog: BasicProg = bv.visit(tree)
+
+    if add_standard_prefix:
+        prefix_lines = [
+            BasicLine(None, Basic09CodeStatement("base 0")),
+            BasicLine(
+                None,
+                Basic09CodeStatement(
+                    "type display_t = tpth, vpth, wpth, hpth, pal(16), blnk, "
+                    "undrln, bck, fore, brdr, hbck, hfore, hscl, hpy, hagl, hdsc: byte; hpx: integer"
+                ),
+            ),
+            BasicLine(None, Basic09CodeStatement("dim display: display_t")),
+            BasicLine(None, Basic09CodeStatement("dim erno: real")),
+            BasicLine(None, Basic09CodeStatement("erno := -1")),
+            BasicLine(
+                None,
+                BasicRunCall(
+                    "RUN _ecb_start",
+                    BasicExpressionList(
+                        [
+                            BasicVar("display"),
+                            BasicLiteral(1 if default_width32 else 0),
+                        ]
+                    ),
+                ),
+            ),
+            BasicLine(
+                None, Basic09CodeStatement("TYPE play_t=oct,octo,lnt,tne,vol,dot:BYTE")
+            ),
+            BasicLine(None, Basic09CodeStatement("DIM play: play_t")),
+            BasicLine(None, Basic09CodeStatement("play.oct := 3")),
+            BasicLine(None, Basic09CodeStatement("play.octo := 0")),
+            BasicLine(None, Basic09CodeStatement("play.lnt := 4")),
+            BasicLine(None, Basic09CodeStatement("play.tne := 2")),
+            BasicLine(None, Basic09CodeStatement("play.vol := 15")),
+            BasicLine(None, Basic09CodeStatement("play.dot := 0")),
+        ]
+        basic_prog.insert_lines_at_beginning(prefix_lines)
+
+    if skip_procedure_headers := skip_procedure_headers or not output_dependencies:
+        procname = ""
+    else:
+        procname = procname if PROCNAME_REGEX.match(procname) else "program"
+    basic_prog.set_procname(procname)
+
+    # Patch INPUT statements
+    basic_prog.visit(BasicInputStatementPatcherVisitor())
+
+    # Patch up READ statements to handle empty DATA elements
+    empty_data_elements_visitor = BasicEmptyDataElementVisitor()
+    basic_prog.visit(empty_data_elements_visitor)
+    if empty_data_elements_visitor.has_empty_data_elements:
+        basic_prog.visit(BasicReadStatementPatcherVisitor())
+
+    # Update joystk stuff
+    joystk_initializer = JoystickVisitor()
+    basic_prog.visit(joystk_initializer)
+    basic_prog.extend_prefix_lines(joystk_initializer.joystk_var_statements)
+
+    # Patch PRINT statements
+    basic_prog.visit(BasicPrintStatementPatcherVisitor())
+
+    # transform functions to proc calls
+    basic_prog.visit(BasicFunctionalExpressionPatcherVisitor())
+
+    set_string_storage_vistor: SetDimStringStorageVisitor = SetDimStringStorageVisitor(
+        default_str_storage=default_str_storage
+    )
+    basic_prog.visit(set_string_storage_vistor)
+
+    # Declare implicitly declared arrays
+    dimmed_array_visitor = GetDimmedArraysVisitor()
+    basic_prog.visit(dimmed_array_visitor)
+    declare_array_visitor = DeclareImplicitArraysVisitor(
+        dimmed_var_names=dimmed_array_visitor.dimmed_var_names,
+    )
+    basic_prog.visit(declare_array_visitor)
+    basic_prog.extend_prefix_lines(declare_array_visitor.dim_statements)
+
+    # allocate sufficient string storage
+    str_var_allocator: StrVarAllocatorVisitor = StrVarAllocatorVisitor(
+        default_str_storage=default_str_storage,
+        dimmed_var_names=set_string_storage_vistor.dimmed_var_names,
+    )
+    basic_prog.visit(str_var_allocator)
+    basic_prog.extend_prefix_lines(str_var_allocator.allocation_lines)
+
+    # initialize variables
+    if initialize_vars:
+        var_initializer = VarInitializerVisitor()
+        basic_prog.visit(var_initializer)
+        basic_prog.extend_prefix_lines(var_initializer.assignment_lines)
+
+    # remove unused line numbers
+    line_ref_visitor = LineReferenceVisitor()
+    basic_prog.visit(line_ref_visitor)
+    line_num_filter = (
+        LineNumberFilterVisitor(line_ref_visitor.references)
+        if filter_unused_linenum
+        else LineZeroFilterVisitor(line_ref_visitor.references)
+    )
+    basic_prog.visit(line_num_filter)
+
+    # make sure line numbers exist and are not too big
+    line_checker: LineNumberCheckerVisitor = LineNumberCheckerVisitor(
+        line_ref_visitor.references
+    )
+    basic_prog.visit(line_checker)
+    if len(line_checker.undefined_lines) > 0:
+        raise ParseError(
+            f"The following lines are undefined: {', '.join(str(linenum) for linenum in line_checker.undefined_lines)}"
+        )
+
+    # make sure there are no more than 1 ON ERR statement
+    on_err_collector: StatementCollectorVisitor = StatementCollectorVisitor(
+        BasicOnErrGoStatement
+    )
+    basic_prog.visit(on_err_collector)
+    if len(on_err_collector.statements) > 1:
+        raise ParseError("At most 1 ON ERR GOTO statement is allowed.")
+    err_line: BasicOnErrGoStatement = (
+        on_err_collector.statements[0].linenum if on_err_collector.statements else None
+    )
+
+    # make sure there are no more than 1 ON BRK statement
+    on_brk_collector: StatementCollectorVisitor = StatementCollectorVisitor(
+        BasicOnBrkGoStatement
+    )
+    basic_prog.visit(on_brk_collector)
+    if len(on_brk_collector.statements) > 1:
+        raise ParseError("At most 1 ON BRK GOTO statement is allowed.")
+    brk_line: BasicOnBrkGoStatement = (
+        on_brk_collector.statements[0].linenum if on_brk_collector.statements else None
+    )
+
+    # try to patch up empty next statements
+    basic_prog.visit(BasicNextPatcherVisitor())
+    suffix_lines: List[BasicLine] = error_handler.generate(
+        brk_line=brk_line,
+        err_line=err_line,
+    )
+    if add_suffix:
+        basic_prog.append_lines(suffix_lines)
+
+    # detect hbuff
+    if add_standard_prefix:
+        hbuff_visitor = BasicHbuffPresenceVisitor()
+        basic_prog.visit(hbuff_visitor)
+        if hbuff_visitor.has_hbuff:
+            basic_prog.insert_lines_at_beginning(
+                [
+                    BasicLine(None, Basic09CodeStatement("dim pid: integer")),
+                    BasicLine(
+                        None,
+                        BasicRunCall(
+                            "RUN _ecb_init_hbuff",
+                            BasicExpressionList([BasicVar("pid")]),
+                        ),
+                    ),
+                ]
+            )
+
+    # output the program
+    program = basic_prog.basic09_text(0)
+    if output_dependencies and procname:
+        procedure_bank = ProcedureBank(
+            default_str_storage=default_str_storage,
+        )
+        procedure_bank.add_from_resource("ecb.b09")
+        procedure_bank.add_from_str(program)
+        program = procedure_bank.get_procedure_and_dependencies(procname)
+
+    return program + "\n"
+
+
+def convert_file(
+    input_program_file: str,
+    output_program_file: str,
+    *,
+    add_standard_prefix: bool = True,
+    default_width32: bool = True,
+    default_str_storage: int = b09.DEFAULT_STR_STORAGE,
+    filter_unused_linenum: bool = False,
+    initialize_vars: bool = False,
+    output_dependencies: bool = False,
+    procname: str = "",
+) -> None:
+    progin = input_program_file.read()
+    progout = convert(
+        progin,
+        add_standard_prefix=add_standard_prefix,
+        default_str_storage=default_str_storage,
+        default_width32=default_width32,
+        filter_unused_linenum=filter_unused_linenum,
+        initialize_vars=initialize_vars,
+        output_dependencies=output_dependencies,
+        procname=procname,
+    )
+    progout = progout.replace("\n", "\r")
+    output_program_file.write(progout)