Update docs

.github/workflows/python-app.yml

@@ -8,8 +8,6 @@ on:
     branches:
       - main
   pull_request:
-    branches:
-      - main
     branches-ignore:
       - docs
 

docs/architectures/uzebox.md

@@ -6,9 +6,9 @@
 * RAM Memory: 4kb
 * Colours: 256 (same palette as from msx2-screen8, or zxspectrum-ulaplus)
 * Video "Memory": 1 byte (!) - The video display is just a 8bit port, used defaultly from the interrupt video-mode kernels.
-* Tile Display Memory Area: is (defaultly) inside the 4kb RAM memory, size depending on how is it used from the video-mode kernel choosed. Most of the ready video modes can have 256 different tiles available.
-* Pattern Display Memory Area (tiles and sprites): is (defaultly) inside the 64kb Flash memory, size depending on how is it used from the video-mode kernel choosed
-* Sprite Attribute Memory Area: is (defaultly) inside the 4kb RAM memory, size depending on how is it used from the video-mode kernel choosed
+* Tile Display Memory Area: is (defaultly) inside the 4kb RAM memory, size depending on how is it used from the video-mode kernel chosen. Most of the ready video modes can have 256 different tiles available.
+* Pattern Display Memory Area (tiles and sprites): is (defaultly) inside the 64kb Flash memory, size depending on how is it used from the video-mode kernel chosen
+* Sprite Attribute Memory Area: is (defaultly) inside the 4kb RAM memory, size depending on how is it used from the video-mode kernel chosen
 * Video Modes: 9 (up to now) - Since display modes are from interrupt, anyone is welcome on creating new video-modes when needed (and skilled for helping). Theoretically, from 1 cycle from ATmega644 processor, a display resolution like 1440x240 could be obtained. But since at least 4 cycles are needed to display a pixel, the width resolutions available from video modes are 360 (4 cycles), 288 (5), 240 (6), 180 (8), 144 (10) and 120 (12).
 
 ## more information

docs/code.md

@@ -19,7 +19,7 @@ Returned value type is [UByte](types.md#UByte).
 REM ASCII CODE of "A"
 PRINT "ASCII CODE of A is "; CODE("A")
 LET a$ = ""
-PRINT "ASCII CODE of emtpy string is "; CODE(a$)
+PRINT "ASCII CODE of empty string is "; CODE(a$)
 ```
 
 ## Remarks

docs/if.md

@@ -37,7 +37,7 @@ End If
 ```
 
 
-Since **IF** is a _sentence_, it can be nested; however, remember that _every_ **IF** _must be closed with_ **END IF** when the line is splitted after **THEN** (mutiline **IF**):
+Since **IF** is a _sentence_, it can be nested; however, remember that _every_ **IF** _must be closed with_ **END IF** when the line is split after **THEN** (mutiline **IF**):
 ```
 If a < 5 Then
     Print "A is less than five"

docs/library/keys/getkey.md

@@ -22,12 +22,12 @@ x = GetKey
 PRINT "You pressed the "; CHR x; " key"
 ```
 Will print the key pressed. Unlike [INKEY$](../../inkey.md) it returns an Ubyte (ASCII code)
-which is more efficent that working with strings.
+which is more efficient that working with strings.
 
 ### See also
 
 * [GetKeyScanCode](getkeyscancode.md)
 * [MultiKeys](multikeys.md)
 
 
-Back to parent page: [Keys ibrary](../keys.bas.md)
+Back to parent page: [Keys library](../keys.bas.md)

docs/library/print64.bas.md

@@ -211,7 +211,7 @@ BLp64_END_LOOP:
         sra a                    ;
         sra a                    ;
         sra a                    ; Multiply by 8 60155 203 47
-        add a, 88                ; Add to attrbute base address
+        add a, 88                ; Add to attribute base address
         ld h, a                  ; Put high byte value for attribute into H.
         ld a, d                  ; get y value again
         and 7                    ; set within third

docs/library/putchars.bas.md

@@ -95,7 +95,7 @@ Asm
     INC DE
     INC H
     ld a,(DE)
-    LD (HL),a ; Eigth Row
+    LD (HL),a ; Eighth Row
 
     INC DE ; Move to next data item.
 

docs/library/puttile.md

@@ -20,7 +20,7 @@ It uses 36 bytes of data, starting at the address given.
 
 
 ```
-' Routine to place a 16 pixel by 16 pixel "Tile" onto the screen at character position x,y from adddress given.
+' Routine to place a 16 pixel by 16 pixel "Tile" onto the screen at character position x,y from address given.
 ' Data must be in the format of 16 bit rows, followed by attribute data.
 ' (c) 2010 Britlion, donated to the ZX BASIC project.
 ' Thanks to Boriel, LCD and Na_than for inspiration behind this.

docs/pause.md

@@ -7,7 +7,7 @@ PAUSE <value>
 
 Just as in Sinclair basic, this command pauses the execution for the given number of frames
 (1 frame equals to 1/50th of second in Europe, 1/60th of second in the US: this is usually in
-sync with the electricity AC frecuency) or until a key is pressed.
+sync with the electricity AC frequency) or until a key is pressed.
 
 Bear in mind the number 0 is actually taken as 65536.
 Currently this sentence uses the Sinclair BASIC ROM, so **it needs interruptions enabled**.

docs/zxb.md

@@ -76,7 +76,7 @@ ZXB provides several (and useful) command line options. To see them, just type *
   -T, --tzx             Sets output format to tzx (default is .bin)
   -t, --tap             Sets output format to tap (default is .bin)
   -B, --BASIC           Creates a BASIC loader which loads the rest of the
-                        CODE. Requires -T ot -t
+                        CODE. Requires -T or -t
   -a, --autorun         Sets the program to be run once loaded
   -A, --asm             Sets output format to asm
   -S ORG, --org ORG     Start of machine code. By default 32768
@@ -184,7 +184,7 @@ and it size is fixed (won't change during program execution).
 * **--debug-memory**
 <br /> During your program execution, using strings might fail due to lack of memory, but your program won't report it
 and will continue executing (except the strings not fitting into the heap will be converted to `NULL` string or `""`).
-The same aplies to other dynamic objects. So enabling this flag, will make your program to stop reporting a
+The same applies to other dynamic objects. So enabling this flag, will make your program to stop reporting a
 ROM _Out of memory_ error. This will add a little overhead to your program execution, but it's useful to detect
 _Out of Memory_ errors.
 

pyproject.toml

@@ -107,6 +107,7 @@ target-version = "py310"
 select = [
     "C4",
     "E",
+    "EXE",
     "F",
     "I",
     "PLR",
@@ -120,6 +121,7 @@ ignore = [
     "E722",
     "E731",
     "E741",
+    "EXE002",
     "PLR0124",
     "PLR0911",
     "PLR0912",
@@ -135,7 +137,6 @@ ignore = [
     "RET501",
     "RET503",
     "RET504",
-    "RET506",
     "RET507",
     "RUF005",
     "RUF012",

src/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 import sys
 
 PYTHON_VERSION = 3, 10  # Minimum python version required

src/api/check.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # vim:ts=4:sw=4:et:
 
 # ----------------------------------------------------------------------
@@ -407,7 +406,7 @@ def is_temporary_value(node) -> bool:
     return node.token not in ("STRING", "VAR") and node.t[0] not in ("_", "#")
 
 
-def common_type(a, b):
+def common_type(a: symbols.TYPE | Type | None, b: symbols.TYPE | Type | None) -> symbols.TYPE | Type | None:
     """Returns a type which is common for both a and b types.
     Returns None if no common types allowed.
     """
@@ -436,7 +435,7 @@ def common_type(a, b):
     assert a.is_basic
     assert b.is_basic
 
-    types = (a, b)
+    types = a, b
 
     if Type.float_ in types:
         return Type.float_

src/api/config.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # vim:ts=4:et:sw=4:
 
 # ----------------------------------------------------------------------
@@ -13,7 +12,7 @@
 import os
 import sys
 from collections.abc import Callable
-from enum import Enum
+from enum import StrEnum
 
 from src.api import errmsg, global_, options, python_version_check
 from src.api.options import ANYTYPE, Action
@@ -25,14 +24,21 @@
 # Common setup and configuration for all tools
 # ------------------------------------------------------
 @enum.unique
-class ConfigSections(str, Enum):
+class ConfigSections(StrEnum):
     ZXBC = "zxbc"
     ZXBASM = "zxbasm"
     ZXBPP = "zxbpp"
 
 
 @enum.unique
-class OPTION(str, Enum):
+class OptimizationStrategy(StrEnum):
+    Size = "size"
+    Speed = "speed"
+    Auto = "auto"
+
+
+@enum.unique
+class OPTION(StrEnum):
     OUTPUT_FILENAME = "output_filename"
     INPUT_FILENAME = "input_filename"
     STDERR_FILENAME = "stderr_filename"
@@ -77,6 +83,9 @@ class OPTION(str, Enum):
     ASM_ZXNEXT = "zxnext"
     FORCE_ASM_BRACKET = "force_asm_brackets"
 
+    # Optimization Preferences
+    OPT_STRATEGY = "opt_strategy"
+
 
 OPTIONS = options.Options()
 OPTIONS_NOT_SAVED = {
@@ -227,6 +236,15 @@ def init() -> None:
     # Whether to show WXXX warning codes or not
     OPTIONS(Action.ADD, name=OPTION.HIDE_WARNING_CODES, type=bool, default=False, ignore_none=True)
 
+    # Optimization preferences
+    OPTIONS(
+        Action.ADD,
+        name=OPTION.OPT_STRATEGY,
+        type=OptimizationStrategy,
+        default=OptimizationStrategy.Auto,
+        ignore_none=True,
+    )
+
     OPTIONS(
         Action.ADD,
         name=OPTION.PROJECT_FILENAME,