img_to_script 1.0.0

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

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Languages
+    module MK90Basic
+      module Translators
+        #
+        # Translates abstract tokens to the MK90 BASIC statements.
+        #
+        # Both v.1.0 & v.2.0 share the same syntax, but there are small
+        # differences. This differences are defined in the child classes
+        # MK90Basic10 & MK90Basic20.
+        #
+        class Translator < ImgToScript::Translator
+          include Mixin
+
+          private
+
+          def _translate(abstract_tokens, **)
+            result = []
+
+            abstract_tokens.each do |token|
+              result.push(_translate_token(token))
+            end
+
+            result
+          end
+
+          def _translate_token(token)
+            case token.type
+            when AbsTokenType::ABS_FUNC
+              _abs_func(token)
+            when AbsTokenType::ASSIGN_VALUE
+              _assign_value(token)
+            when AbsTokenType::CLEAR_SCREEN
+              _clear_screen(token)
+            when AbsTokenType::DATA_STORE
+              _data_store(token)
+            when AbsTokenType::DATA_READ
+              _data_read(token)
+            when AbsTokenType::DRAW_LINE_BY_ABS_COORDS
+              _draw_line_by_abs_coords(token)
+            when AbsTokenType::DRAW_PIXEL_BY_ABS_COORDS
+              _draw_pixel_by_abs_coords(token)
+            when AbsTokenType::DRAW_CHUNK_BY_HEX_VALUE
+              _draw_chunk_by_hex_value(token)
+            when AbsTokenType::MOVE_POINT_TO_ABS_COORDS
+              _move_point_to_abs_coords(token)
+            when AbsTokenType::MATH_ADD
+              _math_add(token)
+            when AbsTokenType::MATH_SUB
+              _math_sub(token)
+            when AbsTokenType::MATH_MULT
+              _math_mult(token)
+            when AbsTokenType::GO_TO
+              _go_to(token)
+            when AbsTokenType::MATH_GREATER_THAN
+              _math_greater_than(token)
+            when AbsTokenType::SIGN_FUNC
+              _sign_func(token)
+            when AbsTokenType::PARENTHESES
+              _parentheses(token)
+            when AbsTokenType::LOOP_BEGIN
+              _loop_begin(token)
+            when AbsTokenType::PROGRAM_END_LBL
+              _program_end(token)
+            when AbsTokenType::LOOP_END
+              _loop_end(token)
+            when AbsTokenType::IF_CONDITION
+              _if_condition(token)
+            when AbsTokenType::WAIT
+              _wait(token)
+            else
+              rem_token = AbstractToken::Remark.new(
+                text: "wrong abstract token type!",
+                require_nl: true
+              )
+              _remark(rem_token)
+            end
+          end
+
+          #
+          # Replace placeholders, expand nested tokens in the
+          # arguments, etc.
+          #
+          # @param [Array<Object>] args
+          #   Original arguments.
+          #
+          # @return [Array<Object>]
+          #   Translated arguments.
+          #
+          def _translate_arguments(args)
+            result = []
+
+            args.each do |arg|
+              result.push(_translate_arg(arg))
+            end
+
+            result
+          end
+
+          #
+          # Translate an argument based on its type.
+          #
+          # Some abstract tokens can have nested tokens as their
+          # arguments. Other tokens can have Symbols as placeholders
+          # for the variables names. Other arguments should be passed
+          # as is (e.g. Integers and Strings).
+          #
+          # @param [Object] arg
+          #
+          # @return [Object]
+          #
+          def _translate_arg(arg)
+            case arg
+            when AbstractToken::AbstractToken
+              _translate_token(arg)
+            when Symbol
+              arg.to_s.upcase
+            else
+              arg
+            end
+          end
+
+          #
+          # Return a token of a arithmetic operation.
+          #
+          # Operation should have a left part, a right part, and
+          # the operator between the parts.
+          #
+          # @param [AbstractToken] token
+          #
+          # @param [String] operator
+          #   E.g.: "+", "-", ">", "<", etc.
+          #
+          # @return [MK90BasicToken]
+          #
+          def _math_operation(token, operator)
+            MK90BasicToken.new(
+              keyword: "",
+              args: _translate_arguments([
+                                           token.left,
+                                           operator,
+                                           token.right
+                                         ]),
+              separator: "",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
+
+          #
+          # Return a token of a function with parentheses.
+          #
+          # Function with an expression that's wrapped in parentheses.
+          # E.g.: ABS(ex), SGN(ex). Keyword can be empty, in that case
+          # only parentheses with the expression will be returned: (ex).
+          #
+          # @param [AbstractToken] token
+          #
+          # @param [String] keyword
+          #   E.g.: "ABS", "SGN".
+          #
+          # @return [MK90BasicToken]
+          #
+          def _function(token, keyword)
+            MK90BasicToken.new(
+              keyword: keyword,
+              args: _translate_arguments([
+                                           "(",
+                                           token.expression,
+                                           ")"
+                                         ]),
+              separator: "",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
+
+          #
+          # Return a token of a keyword statements.
+          #
+          # A statement that consists only of a keyword, and doesn't
+          # take arguments, e.g.: CLS, END, STOP.
+          #
+          # @param [AbstractToken] token
+          #
+          # @param [String] keyword
+          #
+          # @return [MK90BasicToken]
+          #
+          def _single_keyword(token, keyword)
+            MK90BasicToken.new(
+              keyword: keyword,
+              args: [""],
+              separator: "",
+              require_nl: token.require_nl,
+              sliceable: false
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Languages
+    module MK90Basic
+      #
+      # Namespace for the MK90 BASIC translators.
+      #
+      module Translators
+      end
+    end
+  end
+end

data/lib/img_to_script/languages/mk90_basic.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  module Languages
+    #
+    # Elektronika MK90 BASIC.
+    #
+    module MK90Basic
+      SCR_WIDTH = 120
+      SCR_HEIGHT = 64
+      MAX_CHARS_PER_LINE = 80
+
+      LINE_OFFSET = 1
+      LINE_STEP = 1
+    end
+  end
+end

data/lib/img_to_script/languages.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # Namespace for target languages.
+  #
+  # A target language module should have a translator and a formatter.
+  #
+  module Languages; end
+end

data/lib/img_to_script/task.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # Handles conversion.
+  #
+  class Task
+    include Import[
+      generator: "generators.hex_mask.enhanced",
+      translator: "languages.mk90_basic.translators.mk90_basic_10",
+      formatter: "languages.mk90_basic.formatters.minificator"
+    ]
+
+    def run(image:, scr_width:, scr_height:, **)
+      @formatter.format(
+        @translator.translate(
+          @generator.generate(
+            image: image,
+            scr_width: scr_width,
+            scr_height: scr_height
+          )
+        )
+      )
+    end
+  end
+end

data/lib/img_to_script/translator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ImgToScript
+  #
+  # Base class.
+  #
+  # Translates abstract tokens to more specific target language
+  # statements.
+  #
+  class Translator
+    #
+    # Translate the abstract tokens to the target language tokens.
+    #
+    # @param [Array<AbstractToken>] abstract_tokens
+    #
+    # @param [Hash{ Symbol => Object }] **kwargs
+    #   Options.
+    #
+    # @return [Array<Object>]
+    #
+    def translate(abstract_tokens, **kwargs)
+      _translate(
+        Array(abstract_tokens, **kwargs)
+      )
+    end
+
+    private
+
+    def _translate(*); end
+  end
+end

data/lib/img_to_script/version.rb

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

data/lib/img_to_script.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "dry/system"
+require "logger"
+require "run_length_encoding_rb"
+require "zeitwerk"
+
+require_relative "img_to_script/container"
+require_relative "img_to_script/version"
+
+#
+# Converts binary images to executable scripts.
+#
+module ImgToScript
+  class Error < StandardError; end
+  # Your code goes here...
+
+  Container.finalize!
+end

data/sig/img_to_script.rbs

@@ -0,0 +1,4 @@
+module ImgToScript
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: img_to_script
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 8bit-mate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-system
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: run_length_encoding_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+- !ruby/object:Gem::Dependency
+  name: rmagick-bin_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- img_to_script.gemspec
+- lib/img_to_script.rb
+- lib/img_to_script/abs_token_type.rb
+- lib/img_to_script/abstract_token.rb
+- lib/img_to_script/abstract_token/abs_func.rb
+- lib/img_to_script/abstract_token/abstract_token.rb
+- lib/img_to_script/abstract_token/assign_value.rb
+- lib/img_to_script/abstract_token/clear_screen.rb
+- lib/img_to_script/abstract_token/data_read.rb
+- lib/img_to_script/abstract_token/data_store.rb
+- lib/img_to_script/abstract_token/draw_chunk_by_hex_value.rb
+- lib/img_to_script/abstract_token/draw_line_by_abs_coords.rb
+- 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/loop_begin.rb
+- lib/img_to_script/abstract_token/loop_end.rb
+- lib/img_to_script/abstract_token/math_add.rb
+- lib/img_to_script/abstract_token/math_greater_than.rb
+- lib/img_to_script/abstract_token/math_mult.rb
+- lib/img_to_script/abstract_token/math_sub.rb
+- lib/img_to_script/abstract_token/move_point_to_abs_coords.rb
+- 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/remark.rb
+- lib/img_to_script/abstract_token/sign_func.rb
+- lib/img_to_script/abstract_token/wait.rb
+- lib/img_to_script/container.rb
+- lib/img_to_script/current_line_placeholder.rb
+- lib/img_to_script/formatter.rb
+- lib/img_to_script/generators.rb
+- lib/img_to_script/generators/generator.rb
+- 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/hex_mask.rb
+- lib/img_to_script/generators/run_length_encoding.rb
+- lib/img_to_script/generators/run_length_encoding/horizontal.rb
+- lib/img_to_script/generators/run_length_encoding/run_length_encoding.rb
+- lib/img_to_script/generators/run_length_encoding/vertical.rb
+- lib/img_to_script/generators/segmental.rb
+- lib/img_to_script/generators/segmental/data_read_draw.rb
+- lib/img_to_script/generators/segmental/data_read_draw/data_read_draw.rb
+- lib/img_to_script/generators/segmental/data_read_draw/horizontal.rb
+- lib/img_to_script/generators/segmental/data_read_draw/vertical.rb
+- lib/img_to_script/generators/segmental/direct_draw.rb
+- lib/img_to_script/generators/segmental/direct_draw/direct_draw.rb
+- lib/img_to_script/generators/segmental/direct_draw/horizontal.rb
+- lib/img_to_script/generators/segmental/direct_draw/vertical.rb
+- lib/img_to_script/generators/segmental/horizontal_mixin.rb
+- lib/img_to_script/generators/segmental/segmental.rb
+- lib/img_to_script/generators/segmental/vertical_mixin.rb
+- lib/img_to_script/import.rb
+- lib/img_to_script/language_token.rb
+- lib/img_to_script/languages.rb
+- lib/img_to_script/languages/mk90_basic.rb
+- lib/img_to_script/languages/mk90_basic/formatters.rb
+- lib/img_to_script/languages/mk90_basic/formatters/formatter.rb
+- lib/img_to_script/languages/mk90_basic/formatters/minificator.rb
+- lib/img_to_script/languages/mk90_basic/formatters/sliceable_tokens_mixin.rb
+- lib/img_to_script/languages/mk90_basic/mk90_basic_token.rb
+- lib/img_to_script/languages/mk90_basic/translators.rb
+- lib/img_to_script/languages/mk90_basic/translators/mixin.rb
+- lib/img_to_script/languages/mk90_basic/translators/mk90_basic_10.rb
+- lib/img_to_script/languages/mk90_basic/translators/mk90_basic_20.rb
+- lib/img_to_script/languages/mk90_basic/translators/translator.rb
+- lib/img_to_script/task.rb
+- lib/img_to_script/translator.rb
+- lib/img_to_script/version.rb
+- sig/img_to_script.rbs
+homepage: https://github.com/8bit-mate/img_to_script.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/8bit-mate/img_to_script.rb
+  source_code_uri: https://github.com/8bit-mate/img_to_script.rb
+  changelog_uri: https://github.com/8bit-mate/img_to_script.rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Converts images to executable scripts.
+test_files: []