tyrano_dsl 0.1.0

data/lib/tyrano_dsl/parsing_words/conditional_jump.rb

@@ -0,0 +1,42 @@
+require_relative '../elements/jump_target'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::ConditionalJump
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  VALID_OPERATORS = [
+      '<',
+      '>',
+      '==',
+      '!=',
+  ]
+
+  # @param [String] variable
+  # @param [String] operator
+  # @param [String, Symbol, Float] value
+  # @param [String] scene_name
+  # @param [String, nil] label_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def conditional_jump(variable, operator, value, scene_name, label_name = nil)
+    check_variable_exist(variable)
+    if value.is_a?(String) || value.is_a?(Symbol)
+      check_variable_exist(value)
+    end
+    unless VALID_OPERATORS.include? operator
+      raise TyranoDsl::TyranoException, "Unknown operator [#{operator}]"
+    end
+    add_parsed_word(
+        TyranoDsl::Vocabulary::CONDITIONAL_JUMP,
+        variable: variable,
+        operator: operator,
+        value: value,
+        scene_name: scene_name,
+        label_name: label_name
+    )
+    label = label_name ? context.world.label_value(label_name) : nil
+    context.world.jump_targets << TyranoDsl::Elements::JumpTarget.new(scene_name, label)
+  end
+end

data/lib/tyrano_dsl/parsing_words/declare_background.rb

@@ -0,0 +1,32 @@
+require_relative '../elements/background'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+
+module TyranoDsl::ParsingWords::DeclareBackground
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] background_name
+  # @param [String] image_path
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def declare_background(background_name, image_path)
+    image_full_path = file_full_path(image_path)
+    if context.world.backgrounds.key? background_name
+      raise TyranoDsl::TyranoException, "Duplicated background [#{background_name}]"
+    end
+    context.world.backgrounds[background_name] =
+        TyranoDsl::Elements::Background.new(
+            background_name,
+            image_full_path,
+            context.world.backgrounds.length + 1
+        )
+    add_parsed_word(
+        TyranoDsl::Vocabulary::DECLARE_BACKGROUND,
+        name: background_name, image_path: image_full_path
+    )
+  end
+
+end
+

data/lib/tyrano_dsl/parsing_words/declare_character.rb

@@ -0,0 +1,38 @@
+require_relative '../elements/character'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::DeclareCharacter
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] character_name
+  # @param [Hash{String => String}] stances
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def declare_character(character_name, stances)
+    symbolized_stances = symbolize_keys(stances)
+    symbolized_stances.each_pair do |name, path|
+      symbolized_stances[name] = file_full_path(path)
+    end
+
+    default_stance = symbolized_stances[:default]
+    unless default_stance
+      raise TyranoDsl::TyranoException, 'A default stance is required'
+    end
+    if context.world.characters.key? character_name
+      raise TyranoDsl::TyranoException, "Duplicated character [#{character_name}]"
+    end
+    context.world.characters[character_name] = TyranoDsl::Elements::Character.new(
+        character_name,
+        symbolized_stances,
+        context.world.characters.length + 1
+    )
+
+    add_parsed_word(
+        TyranoDsl::Vocabulary::DECLARE_CHARACTER,
+        name: character_name, stances: symbolized_stances, default_stance: default_stance
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/declare_label.rb

@@ -0,0 +1,20 @@
+require_relative '../elements/background'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::DeclareLabel
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] label_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def declare_label(label_name)
+    add_parsed_word(
+        TyranoDsl::Vocabulary::DECLARE_LABEL,
+        label_name: label_name
+    )
+    context.world.label_value(label_name)
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/declare_variable.rb

@@ -0,0 +1,30 @@
+require_relative '../elements/variable'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::DeclareVariable
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String\Symbol] variable_name
+  # @param [Float] initial_value
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def declare_variable(variable_name, initial_value)
+    if context.world.variables.key? variable_name
+      raise TyranoDsl::TyranoException, "Duplicated variable [#{variable_name}]"
+    else
+      context.world.variables[variable_name] = TyranoDsl::Elements::Variable.new(
+          variable_name,
+          "variable_#{context.world.variables.length + 1}",
+          initial_value
+      )
+    end
+    add_parsed_word(
+        TyranoDsl::Vocabulary::DECLARE_VARIABLE,
+        variable_name: variable_name,
+        initial_value: initial_value,
+        )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/display_text.rb

@@ -0,0 +1,22 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::DisplayText
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String, nil] character_name
+  # @param [String] text
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def display_text(character_name, text)
+    if character_name
+      check_character_exist(character_name)
+    end
+    add_parsed_word(
+        TyranoDsl::Vocabulary::DISPLAY_TEXT,
+        character_name: character_name, text: text
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/hide_character.rb

@@ -0,0 +1,20 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+
+module TyranoDsl::ParsingWords::HideCharacter
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] character_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def hide_character(character_name)
+    check_character_exist(character_name)
+    add_parsed_word(
+        TyranoDsl::Vocabulary::HIDE_CHARACTER,
+        name: character_name
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/hide_message_window.rb

@@ -0,0 +1,16 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::HideMessageWindow
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def hide_message_window
+    add_parsed_word(
+        TyranoDsl::Vocabulary::HIDE_MESSAGE_WINDOW,
+        )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/include_file.rb

@@ -0,0 +1,26 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+
+module TyranoDsl::ParsingWords::IncludeFile
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] file_path
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def include_file(file_path)
+    log {"Reading content file at [#{file_path}]"}
+    complete_file_path = File.absolute_path(file_path, File.dirname(included_files_hierarchy.last))
+    unless File.exist? complete_file_path
+      raise TyranoDsl::TyranoException, "File not found [#{complete_file_path}]"
+    end
+    included_files_hierarchy << complete_file_path
+    log {"Start parsing [#{complete_file_path}]"}
+    file_content = IO.read(complete_file_path)
+    instance_eval(file_content, complete_file_path, 1)
+    log {"End parsing [#{complete_file_path}]"}
+    included_files_hierarchy.pop
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/jump.rb

@@ -0,0 +1,22 @@
+require_relative '../elements/jump_target'
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::Jump
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] scene_name
+  # @param [String, nil] label_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def jump(scene_name, label_name = nil)
+    add_parsed_word(
+        TyranoDsl::Vocabulary::JUMP,
+        scene_name: scene_name,
+        label_name: label_name
+    )
+    label = label_name ? context.world.label_value(label_name) : nil
+    context.world.jump_targets << TyranoDsl::Elements::JumpTarget.new(scene_name, label)
+  end
+end

data/lib/tyrano_dsl/parsing_words/parsing_words_module.rb

@@ -0,0 +1,72 @@
+require_relative '../tyrano_exception'
+require_relative '../vocabulary'
+
+module TyranoDsl
+  module ParsingWords
+
+    module ParsingWordsModule
+
+      protected
+
+      # @param [String] file_path
+      # @return [String]
+      # @raise [TyranoDsl::TyranoException]
+      def file_full_path(file_path)
+        absolute_path = File.absolute_path(file_path, File.dirname(included_files_hierarchy.last))
+        unless File.exist?(absolute_path)
+          raise TyranoDsl::TyranoException, "Missing file [#{absolute_path}]"
+        end
+        absolute_path
+      end
+
+      # @param [String] variable_name
+      # @return [void]
+      # @raise [TyranoDsl::TyranoException]
+      def check_variable_exist(variable_name)
+        unless context.world.variables.key?(variable_name)
+          raise_unknown('variable', variable_name, context.world.variables.keys)
+        end
+      end
+
+      # @param [String] character_name
+      # @param [String, nil] character_stance
+      # @return [void]
+      # @raise [TyranoDsl::TyranoException]
+      def check_character_exist(character_name, character_stance = nil)
+        character = context.world.characters[character_name]
+        unless character
+          raise_unknown('character', character_name, context.world.characters.keys)
+        end
+        if character_stance && !character.stances.key?(character_stance)
+          raise_unknown('stance', character_stance, character.stances.keys)
+        end
+      end
+
+      # @param [Hash] hash
+      # @return [Hash{Symbol=>Object}]
+      def symbolize_keys(hash)
+        result = {}
+        hash.keys.each do |key|
+          result[symbolize(key)] = hash[key]
+        end
+        result
+      end
+
+      # @param [String] string
+      # @return [Symbol]
+      def symbolize(string)
+        string.to_sym rescue string
+      end
+
+      # @param [String] type
+      # @param [String] unknown_name
+      # @param [Array<String>] current_elements
+      # @return [void]
+      # @raise [TyranoDsl::TyranoException]
+      def raise_unknown(type, unknown_name, current_elements)
+        raise TyranoDsl::TyranoException, "Unknown #{type} [#{unknown_name}], currently #{current_elements.length} defined: #{current_elements.sort.collect {|e| "[#{e}]"}.join(', ')}"
+      end
+
+    end
+  end
+end

data/lib/tyrano_dsl/parsing_words/set_background.rb

@@ -0,0 +1,21 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::SetBackground
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] background_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def set_background(background_name)
+    unless context.world.backgrounds.key? background_name
+      raise_unknown('background', background_name, context.world.backgrounds.keys)
+    end
+    add_parsed_word(
+        TyranoDsl::Vocabulary::SET_BACKGROUND,
+        name: background_name
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/set_character_stance.rb

@@ -0,0 +1,23 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::SetCharacterStance
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] character_name
+  # @param [String] character_stance
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def set_character_stance(character_name, character_stance)
+    symbolized_stance = symbolize(character_stance)
+    check_character_exist(character_name, symbolized_stance)
+
+    add_parsed_word(
+        TyranoDsl::Vocabulary::SET_CHARACTER_STANCE,
+        name: character_name,
+        stance: symbolized_stance
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/set_title_screen_background.rb

@@ -0,0 +1,25 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::SetTitleScreenBackground
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] background_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def set_title_screen_background(background_name)
+    unless context.world.backgrounds.key? background_name
+      raise_unknown('background', background_name, context.world.backgrounds.keys)
+    end
+    if context.world.title_screen.background
+      raise TyranoDsl::TyranoException, 'Title screen background already defined'
+    end
+    context.world.title_screen.background = background_name
+    add_parsed_word(
+        TyranoDsl::Vocabulary::SET_TITLE_SCREEN_BACKGROUND,
+        name: background_name
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/show_character.rb

@@ -0,0 +1,26 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::ShowCharacter
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] character_name
+  # @param [String] character_stance
+  # @param [Integer] left
+  # @param [Integer] top
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def show_character(character_name, character_stance, left, top)
+    symbolized_stance = symbolize(character_stance)
+    check_character_exist(character_name, symbolized_stance)
+    add_parsed_word(
+        TyranoDsl::Vocabulary::SHOW_CHARACTER,
+        name: character_name,
+        stance: symbolized_stance,
+        left: left,
+        top: top
+    )
+  end
+
+end