img_to_script 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 868a7487d0f8745e1507f2296e1edde72ea010a8ff7bbd4ceb7db1dfce16342d
-  data.tar.gz: 6a93d15efebbb4d8b2f227cda00c8ccb8a3bd4c71a517ffa694483874de6378c
+  metadata.gz: 711c09a2ddc4d5ac5df11d748d266acab0cc6ea9bf1ea4032e0074920629c373
+  data.tar.gz: be7bdc44d5393fa8ce073b4e18352f27d9182aa21dc2a1cef9d358ca8e7e8e35
 SHA512:
-  metadata.gz: a2c8edf4a89d077932aa567529977720a3b51b514a131ec22bb285e0a61bf1b37a29a5de4573ce8b20d9ddc61e35451690cda615d2dd1baa098ed7d1acbb7dec
-  data.tar.gz: 76a4d6dca726fe777652cfbb426e6860e61a62e7163f9062ecece2714b309d3d2a05b9fc2d01415e7bcfd2265acd4e29c9f9113f00c0842e56ff99256051acbe
+  metadata.gz: 6648a5244cea7d45c22220b6b6e7e329eee5752335340bda94366a418677bd167bd9d14e3ee4b26836e3adf8cb943c101afd6cdcfe1df155e47a98fe80d7ee1d
+  data.tar.gz: a35c8376f8d67812710a890443fd77cec590dfeaaa353e021d41bc179504d8b203fb63d277a50668cbd08ca9d721b88cb06cf146281df75be1071b7cd91d3cf3

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [1.2.0] - 2024-01-27
+
+- New experimental feature: load and run another file at the end of the script.
+
+- Different pause subroutine.
+
+- Bug fix in the MK90 minificator.
+
+## [1.1.0] - 2024-01-26
+
+- New generator: `HexMask::ForcedPointMove`.
+
+  Due to a found bug in the MK90 BASIC v.2.0, hex-mask based generators won't work on this systems. This generator is a workaround that should be used to generate scripts for the v.2.0 systems.
+
+- Improved MK90 BASIC v.2.0 compatibility
+
+  Due to yet another found bug in the MK90 BASIC v.2.0, the DRAW O statement won't work on this systems. The update introduces a workaround for this bug.
+
 ## [1.0.1] - 2023-12-29
 
 - Bug fix.

data/README.md

@@ -170,22 +170,34 @@ script = task.run(
 
       Add a statement that marks the end of the program.
 
+   - run_another_file, default: ""
+
+      Load and run another script file at the end of the script. String argument represents a file ID (e.g., a filename). If the string is empty, no file should be loaded.
+
 - **ImgToScript::Generators::HexMask::Default**
 
-   Specific for the Elektronika MK90 BASIC.
+   Specific for the Elektronika MK90 BASIC v.1.0 **only**.
 
    MK90's BASIC has a balanced build-in method to encode and render images. The Elektronika MK90's manual refers to it as the *hex-mask rendering* method. Each 8x1 px block of a binary image is being represented as a hex value (e.g. '00' for a tile of the 8 white pixels in a row, 'FF' for a tile of the 8 black pixels in a row, etc.). Then these hex values are being passed as arguments to the DRAM/M BASIC statement that renders the image according to the provided data.
 
    Due to the logic of the DRAM/M operator, only vertical scan lines are supported.
 
+   **Note**: due to a bug in the MK90 BASIC v.2.0 software, this generation method works only on the BASIC v.1.0 systems.
+
+- **ImgToScript::Generators::HexMask::ForcedPointMove**
+
+   Same as `HexMask::Default`, but with a workaround for the MK90 BASIC v.2.0.
+
 - **ImgToScript::Generators::HexMask::Enhanced**
 
-   Specific for the Elektronika MK90 BASIC.
+   Specific for the Elektronika MK90 BASIC v.1.0 **only**.
 
    Hex-mask encoding with modifications what make output BASIC code more compact.
 
    Due to the logic of the DRAM/M operator, only vertical scan lines are supported.
 
+   **Note**: due to a bug in the MK90 BASIC v.2.0 software, this generation method works only on the BASIC v.1.0 systems.
+
 - **ImgToScript::Generators::RunLengthEncoding::Horizontal**
 
    RLE, horizontal scan lines.

data/lib/img_to_script/abs_token_type.rb

@@ -15,6 +15,7 @@ module ImgToScript
     DRAW_PIXEL_BY_ABS_COORDS = :draw_pixel_by_abs_coords
     GO_TO = :go_to
     IF_CONDITION = :if_condition
+    LOAD_AND_RUN = :load_and_run
     LOOP_BEGIN = :loop_begin
     LOOP_END = :loop_end
     MATH_ADD = :math_add
@@ -25,6 +26,7 @@ module ImgToScript
     PARENTHESES = :parentheses
     PROGRAM_BEGIN = :program_begin_lbl
     PROGRAM_END_LBL = :program_end_lbl
+    READ_KEY_VALUE = :read_key_value
     REMARK = :remark
     SIGN_FUNC = :sign_func
     SIGN_GREATER_THAN = :sign_greater_than

data/lib/img_to_script/abstract_token/load_and_run.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Load and run another script file.
+    #
+    class LoadAndRun < AbstractToken
+      attr_reader :filename
+
+      def initialize(filename:, **)
+        @type = AbsTokenType::LOAD_AND_RUN
+        @filename = filename
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/read_key_value.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Read a key value from the keyboard.
+    #
+    class ReadKeyValue < AbstractToken
+      def initialize(**)
+        @type = AbsTokenType::READ_KEY_VALUE
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/generators/generator.rb

@@ -14,6 +14,7 @@ module ImgToScript
       setting :pause_program, default: PAUSE_PROGRAM
       setting :program_begin_lbl, default: PRORGAM_BEGIN_LBL
       setting :program_end_lbl, default: PROGRAM_END_LBL
+      setting :run_another_file, default: ""
 
       #
       # Generate abstract tokens that represent the image.
@@ -44,12 +45,13 @@ module ImgToScript
       private
 
       def _generate_tokens
-        @tokens = [] # append new tokens here
+        @tokens = [] # append new tokens to this arr.
 
         _program_begin if config.program_begin_lbl
         _clear_screen if config.clear_screen
         _generate
         _program_pause if config.pause_program
+        _run_another_file unless config.run_another_file.empty?
         _program_end if config.program_end_lbl
       end
 
@@ -98,34 +100,55 @@ module ImgToScript
       # Append a sub-routine to pause the program.
       #
       def _program_pause
-        _loop_begin
-        _wait
-        _loop_end
+        _read_key_value
+        _check_key_value
+        _loop
       end
 
-      def _loop_begin
+      def _read_key_value
         @tokens.append(
-          AbstractToken::LoopBegin.new(
-            start_value: 1,
-            end_value: WAIT_LOOP_COUNT,
-            var_name: LOOP_VAR,
+          AbstractToken::AssignValue.new(
+            left: "K",
+            right: AbstractToken::ReadKeyValue.new,
             require_nl: true
           )
         )
       end
 
-      def _wait
+      def _check_key_value
+        expression = AbstractToken::MathGreaterThan.new(
+          left: "K",
+          right: "0"
+        )
+
+        consequent = AbstractToken::GoTo.new(
+          line: CurrentLinePlaceholder.new(2),
+          require_nl: false
+        )
+
         @tokens.append(
-          AbstractToken::Wait.new(
-            time: WAIT_TIME
+          AbstractToken::IfCondition.new(
+            expression: expression,
+            consequent: consequent,
+            require_nl: false
           )
         )
       end
 
-      def _loop_end
+      def _loop
         @tokens.append(
-          AbstractToken::LoopEnd.new(
-            var_name: LOOP_VAR
+          AbstractToken::GoTo.new(
+            line: CurrentLinePlaceholder.new(-1),
+            require_nl: true
+          )
+        )
+      end
+
+      def _run_another_file
+        @tokens.append(
+          AbstractToken::LoadAndRun.new(
+            filename: config.run_another_file,
+            require_nl: true
           )
         )
       end

data/lib/img_to_script/generators/hex_mask/enhanced.rb

@@ -162,15 +162,6 @@ module ImgToScript
           )
         end
 
-        def _append_move_point(x, y)
-          @tokens.append(
-            AbstractToken::MovePointToAbsCoords.new(
-              x: x,
-              y: y
-            )
-          )
-        end
-
         #
         # Replace long sequences of white chunks (0x00) with a shorter manual shift of the (X, Y) point.
         #

data/lib/img_to_script/generators/hex_mask/forced_point_move.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Generators
+    module HexMask
+      #
+      # Workaround for the MK90 BASIC v.2.0.
+      #
+      class ForcedPointMove < HexMask
+        SEG_CHUNK_LENGTH = 28
+
+        private
+
+        def _generate
+          _process_seg_chunks(
+            _encode_img.each_slice(SEG_CHUNK_LENGTH).to_a
+          )
+        end
+
+        def _process_seg_chunks(seg_chunks)
+          x = 0
+          y = 0
+
+          seg_chunks.each do |chunk|
+            # Append only non-white segments:
+            _append_hex_values(chunk) unless _all_elements_equal?(chunk, "00")
+
+            if y + SEG_CHUNK_LENGTH > @scr_height - 1
+              y = (y + SEG_CHUNK_LENGTH) - @scr_height
+              x += CHUNK_WIDTH
+            else
+              y += SEG_CHUNK_LENGTH
+            end
+
+            _append_move_point(x, y)
+          end
+        end
+
+        def _all_elements_equal?(array, value)
+          array.all? { |element| element == value }
+        end
+
+        def _append_hex_values(hex_values)
+          @tokens.append(
+            AbstractToken::DrawChunkByHexValue.new(
+              hex_values: hex_values,
+              require_nl: true
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/img_to_script/generators/hex_mask/hex_mask.rb

@@ -11,6 +11,15 @@ module ImgToScript
 
         private
 
+        def _append_move_point(x, y)
+          @tokens.append(
+            AbstractToken::MovePointToAbsCoords.new(
+              x: x,
+              y: y
+            )
+          )
+        end
+
         #
         # Encode a binary image to a hex-mask encoded image.
         #

data/lib/img_to_script/languages/mk90_basic/formatters/formatter.rb

@@ -40,7 +40,7 @@ module ImgToScript
           end
 
           def _calc_initial_line_number
-            @n_line = @line_offset - @line_step
+            @i_line = @line_offset - @line_step
           end
         end
       end

data/lib/img_to_script/languages/mk90_basic/formatters/minificator.rb

@@ -174,7 +174,7 @@ module ImgToScript
           end
 
           def _update_line_num
-            @n_line += @line_step
+            @i_line += @line_step
 
             # Since line number has been changed, it is required to
             # re-evaluate placeholders with the updated value.
@@ -210,7 +210,7 @@ module ImgToScript
           # @return [String]
           #
           def _select_line_label
-            @number_lines ? @n_line.to_s : ""
+            @number_lines ? @i_line.to_s : ""
           end
 
           #
@@ -242,7 +242,7 @@ module ImgToScript
           def _evaluate_placeholders
             @placeholders_idx.each do |i|
               e = @token.args[i]
-              @args[i] = @n_line + e.shift * @line_step
+              @args[i] = @i_line + e.shift * @line_step
             end
           end
 
@@ -296,6 +296,8 @@ module ImgToScript
           def _minificator
             Minificator.new.configure do |config|
               config.number_lines = false
+              config.line_offset = @i_line + @line_step
+              config.line_step = @line_step
             end
           end
 

data/lib/img_to_script/languages/mk90_basic/translators/mixin.rb

@@ -22,6 +22,10 @@ module ImgToScript
             _single_keyword(token, "END")
           end
 
+          def _read_key_value(token)
+            _single_keyword(token, "INC")
+          end
+
           def _data_store(token)
             MK90BasicToken.new(
               keyword: "DATA",
@@ -96,19 +100,6 @@ module ImgToScript
             _math_operation(token, "*")
           end
 
-          def _move_point_to_abs_coords(token)
-            MK90BasicToken.new(
-              keyword: "DRAWO",
-              args: _translate_arguments([
-                                           token.x,
-                                           token.y
-                                         ]),
-              separator: ",",
-              require_nl: token.require_nl,
-              sliceable: false
-            )
-          end
-
           def _go_to(token)
             MK90BasicToken.new(
               keyword: "GOTO",

data/lib/img_to_script/languages/mk90_basic/translators/mk90_basic_10.rb

@@ -20,6 +20,31 @@ module ImgToScript
               sliceable: false
             )
           end
+
+          # MK90 BASIC v1.0 - load and run another BASIC file.
+          def _load_and_run(token)
+            MK90BasicToken.new(
+              keyword: "LOAD",
+              args: ["\"", token.filename, "\"", ",", "R"],
+              separator: "",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
+
+          # MK90 BASIC v.1.0 does support the DRAW O statement.
+          def _move_point_to_abs_coords(token)
+            MK90BasicToken.new(
+              keyword: "DRAWO",
+              args: _translate_arguments([
+                                           token.x,
+                                           token.y
+                                         ]),
+              separator: ",",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
         end
       end
     end

data/lib/img_to_script/languages/mk90_basic/translators/mk90_basic_20.rb

@@ -20,6 +20,32 @@ module ImgToScript
               sliceable: false
             )
           end
+
+          # MK90 BASIC v2.0 - load and run another BASIC file.
+          def _load_and_run(token)
+            MK90BasicToken.new(
+              keyword: "LOAD",
+              args: ["\"", token.filename, "\"", ",", "A", ",", "R"],
+              separator: "",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
+
+          # MK90 BASIC v.2.0 does NOT support the DRAW O statement due to a bug,
+          # the LOCATE statement should be used instead.
+          def _move_point_to_abs_coords(token)
+            MK90BasicToken.new(
+              keyword: "LOCATE",
+              args: _translate_arguments([
+                                           token.x,
+                                           token.y
+                                         ]),
+              separator: ",",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
         end
       end
     end

data/lib/img_to_script/languages/mk90_basic/translators/translator.rb

@@ -46,6 +46,8 @@ module ImgToScript
               _draw_chunk_by_hex_value(token)
             when AbsTokenType::MOVE_POINT_TO_ABS_COORDS
               _move_point_to_abs_coords(token)
+            when AbsTokenType::LOAD_AND_RUN
+              _load_and_run(token)
             when AbsTokenType::MATH_ADD
               _math_add(token)
             when AbsTokenType::MATH_SUB
@@ -64,6 +66,8 @@ module ImgToScript
               _loop_begin(token)
             when AbsTokenType::PROGRAM_END_LBL
               _program_end(token)
+            when AbsTokenType::READ_KEY_VALUE
+              _read_key_value(token)
             when AbsTokenType::LOOP_END
               _loop_end(token)
             when AbsTokenType::IF_CONDITION

data/lib/img_to_script/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImgToScript
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: img_to_script
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - 8bit-mate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-system
@@ -118,6 +118,7 @@ files:
 - lib/img_to_script/abstract_token/draw_pixel_by_abs_coords.rb
 - lib/img_to_script/abstract_token/go_to.rb
 - lib/img_to_script/abstract_token/if_condition.rb
+- lib/img_to_script/abstract_token/load_and_run.rb
 - lib/img_to_script/abstract_token/loop_begin.rb
 - lib/img_to_script/abstract_token/loop_end.rb
 - lib/img_to_script/abstract_token/math_add.rb
@@ -128,6 +129,7 @@ files:
 - lib/img_to_script/abstract_token/parentheses.rb
 - lib/img_to_script/abstract_token/program_begin.rb
 - lib/img_to_script/abstract_token/program_end.rb
+- lib/img_to_script/abstract_token/read_key_value.rb
 - lib/img_to_script/abstract_token/remark.rb
 - lib/img_to_script/abstract_token/sign_func.rb
 - lib/img_to_script/abstract_token/wait.rb
@@ -139,6 +141,7 @@ files:
 - lib/img_to_script/generators/hex_mask.rb
 - lib/img_to_script/generators/hex_mask/default.rb
 - lib/img_to_script/generators/hex_mask/enhanced.rb
+- lib/img_to_script/generators/hex_mask/forced_point_move.rb
 - lib/img_to_script/generators/hex_mask/hex_mask.rb
 - lib/img_to_script/generators/run_length_encoding.rb
 - lib/img_to_script/generators/run_length_encoding/horizontal.rb