img_to_script 1.0.0

data/lib/img_to_script/abstract_token/loop_begin.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Begin a loop.
+    #
+    class LoopBegin < AbstractToken
+      attr_reader :var_name, :start_value, :end_value
+
+      def initialize(var_name:, start_value:, end_value:, **)
+        @type = AbsTokenType::LOOP_BEGIN
+        @var_name = var_name
+        @start_value = start_value
+        @end_value = end_value
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/loop_end.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Marks loop end.
+    #
+    class LoopEnd < AbstractToken
+      attr_reader :var_name
+
+      def initialize(var_name:, **)
+        @var_name = var_name
+        @type = AbsTokenType::LOOP_END
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/math_add.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Addition arithmetical operation.
+    #
+    class MathAdd < AbstractToken
+      attr_reader :left, :right
+
+      def initialize(left:, right:, **)
+        @type = AbsTokenType::MATH_ADD
+        @left = left
+        @right = right
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/math_greater_than.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # left > right.
+    #
+    class MathGreaterThan < AbstractToken
+      attr_reader :left, :right
+
+      def initialize(left:, right:, **)
+        @type = AbsTokenType::MATH_GREATER_THAN
+        @left = left
+        @right = right
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/math_mult.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Multiplication arithmetical operation.
+    #
+    class MathMult < AbstractToken
+      attr_reader :left, :right
+
+      def initialize(left:, right:, **)
+        @type = AbsTokenType::MATH_MULT
+        @left = left
+        @right = right
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/math_sub.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Subtraction arithmetical operation.
+    #
+    class MathSub < AbstractToken
+      attr_reader :left, :right
+
+      def initialize(left:, right:, **)
+        @type = AbsTokenType::MATH_SUB
+        @left = left
+        @right = right
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/move_point_to_abs_coords.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Move point to the (x, y) position (in the absolute coordinates).
+    #
+    class MovePointToAbsCoords < AbstractToken
+      attr_reader :x, :y
+
+      def initialize(x:, y:, **)
+        @x = x
+        @y = y
+        @type = AbsTokenType::MOVE_POINT_TO_ABS_COORDS
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/parentheses.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Wrap an expression into parentheses.
+    #
+    class Parentheses < AbstractToken
+      attr_reader :expression
+
+      def initialize(expression:, **)
+        @type = AbsTokenType::PARENTHESES
+        @expression = expression
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/program_begin.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Marks begin of the program.
+    #
+    class ProgramBegin < AbstractToken
+      def initialize(**)
+        @type = AbsTokenType::PROGRAM_BEGIN
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/program_end.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Marks end of the program.
+    #
+    class ProgramEnd < AbstractToken
+      def initialize(**)
+        @type = AbsTokenType::PROGRAM_END_LBL
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/remark.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Remark - a comment.
+    #
+    class Remark < AbstractToken
+      attr_reader :text
+
+      def initialize(text:, **)
+        @type = AbsTokenType::REMARK
+        @text = text
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/sign_func.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Sign function.
+    #
+    class SignFunc < AbstractToken
+      attr_reader :expression
+
+      def initialize(expression:, **)
+        @type = AbsTokenType::SIGN_FUNC
+        @expression = expression
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token/wait.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module AbstractToken
+    #
+    # Pause a program run.
+    #
+    class Wait < AbstractToken
+      attr_reader :time
+
+      def initialize(time:, **)
+        @type = AbsTokenType::WAIT
+        @time = time
+
+        super
+      end
+    end
+  end
+end

data/lib/img_to_script/abstract_token.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # Namespace for abstact tokens.
+  #
+  module AbstractToken; end
+end

data/lib/img_to_script/container.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # See https://dry-rb.org/gems/dry-system/main/container/
+  #
+  class Container < Dry::System::Container
+    configure do |config|
+      use :zeitwerk
+
+      config.root = Pathname(__dir__).join("../../")
+
+      config.component_dirs.add "lib" do |dir|
+        dir.namespaces.add "img_to_script", key: nil
+      end
+
+      config.inflector = Dry::Inflector.new do |inflections|
+        inflections.acronym("MK90")
+      end
+    end
+
+    register("utils.logger", Logger.new($stdout, level: Logger::ERROR))
+
+    add_to_load_path! "lib"
+  end
+end

data/lib/img_to_script/current_line_placeholder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # BASIC known by its widely usage of the GOTO construction.
+  # It is a common practice to use statements like N GOTO N + m
+  # (i.e. jump m lines away from the current line N).
+  #
+  # When a generator generates an abstract token, it doesn't know
+  # anything about the current line or its number yet. It is only
+  # when a formatter starts to format the code, this values can be
+  # calculated.
+  #
+  # Thus, at the generation step a placeholder is being used to mark
+  # the current line number.
+  #
+  # Placeholder's job is to tell a formatter that the argument should
+  # be replaced with the actual line number value.
+  #
+  # The optional attribute 'shift' allows to make a relative jump
+  # from the current line to a line that is above (a negative value)
+  # or to a line that's behind (a positive value) of the current line.
+  #
+  # Shift value is in line steps, i.e. works as a coefficient, so the
+  # full form of the expression is: N GOTO N + m * line_step.
+  #
+  class CurrentLinePlaceholder
+    attr_reader :shift
+
+    #
+    # Initialize a placeholder.
+    #
+    # @param [Integer] shift
+    #   A relative shift of the current line number.
+    #
+    def initialize(shift = 0)
+      @shift = shift
+    end
+  end
+end

data/lib/img_to_script/formatter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # Base class.
+  #
+  # Formatters format array of target language tokens to an
+  # executable script.
+  #
+  # A formatter's responsibility is to label BASIC lines, put
+  # separators between the statements' and their arguments, etc.
+  #
+  class Formatter
+    attr_reader :script
+
+    include Dry::Configurable
+
+    #
+    # Format an array of the language tokens to an executable script.
+    #
+    # @param [Array<Object>] tokens
+    #   Translator's output.
+    #
+    # @param [Hash{ Symbol => Object }] **kwargs
+    #   Options.
+    #
+    # @return [Array<String>]
+    #   Formatted script.
+    #
+    def format(tokens, **kwargs)
+      _format(tokens, **kwargs)
+    end
+  end
+end

data/lib/img_to_script/generators/generator.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Generators
+    #
+    # Base class.
+    #
+    class Generator
+      include Dry::Configurable
+
+      setting :x_offset, default: X_OFFSET
+      setting :y_offset, default: Y_OFFSET
+      setting :clear_screen, default: CLEAR_SCREEN
+      setting :pause_program, default: PAUSE_PROGRAM
+      setting :program_begin_lbl, default: PRORGAM_BEGIN_LBL
+      setting :program_end_lbl, default: PROGRAM_END_LBL
+
+      #
+      # Generate abstract tokens that represent the image.
+      #
+      # @param [Magick::BinMagick::Image] image
+      #   Binary image.
+      #
+      # @param [Integer] scr_width
+      #   Target device horizontal screen resolution.
+      #
+      # @param [Integer] scr_height
+      #   Target device vertical screen resolution.
+      #
+      # @return [Array<AbstractToken>] @tokens
+      #
+      def generate(image:, scr_width:, scr_height:)
+        @image = image
+        @scr_width = scr_width
+        @scr_height = scr_height
+        @x_offset = config.x_offset
+        @y_offset = config.y_offset
+
+        _generate_tokens
+
+        @tokens
+      end
+
+      private
+
+      def _generate_tokens
+        @tokens = [] # append new tokens here
+
+        _program_begin if config.program_begin_lbl
+        _clear_screen if config.clear_screen
+        _generate
+        _program_pause if config.pause_program
+        _program_end if config.program_end_lbl
+      end
+
+      #
+      # Transpose image for vertical scanning.
+      #
+      def _transpose
+        @image.rotate!(90)
+        @image.flop!
+      end
+
+      #
+      # Append a token to clear screen.
+      #
+      def _clear_screen
+        @tokens.append(
+          AbstractToken::ClearScreen.new(
+            require_nl: true
+          )
+        )
+      end
+
+      #
+      # Append a token to mark end of the program.
+      #
+      def _program_end
+        @tokens.append(
+          AbstractToken::ProgramEnd.new(
+            require_nl: true
+          )
+        )
+      end
+
+      #
+      # Append a token to mark begin of the program.
+      #
+      def _program_begin
+        @tokens.append(
+          AbstractToken::ProgramBegin.new(
+            require_nl: true
+          )
+        )
+      end
+
+      #
+      # Append a sub-routine to pause the program.
+      #
+      def _program_pause
+        _loop_begin
+        _wait
+        _loop_end
+      end
+
+      def _loop_begin
+        @tokens.append(
+          AbstractToken::LoopBegin.new(
+            start_value: 1,
+            end_value: WAIT_LOOP_COUNT,
+            var_name: LOOP_VAR,
+            require_nl: true
+          )
+        )
+      end
+
+      def _wait
+        @tokens.append(
+          AbstractToken::Wait.new(
+            time: WAIT_TIME
+          )
+        )
+      end
+
+      def _loop_end
+        @tokens.append(
+          AbstractToken::LoopEnd.new(
+            var_name: LOOP_VAR
+          )
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Generators
+    module HexMask
+      #
+      # Generates image rendering script with the DRAM/M statements only
+      # (without 'enhacements').
+      #
+      class Default < HexMask
+        private
+
+        def _generate
+          @tokens.append(
+            AbstractToken::DrawChunkByHexValue.new(
+              hex_values: _encode_img,
+              require_nl: true
+            )
+          )
+        end
+      end
+    end
+  end
+end