tyrano_dsl 0.1.0

data/lib/tyrano_dsl/parsing_words/show_message_window.rb

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

data/lib/tyrano_dsl/parsing_words/start_scene.rb

@@ -0,0 +1,30 @@
+require_relative 'parsing_words_module'
+require_relative '../vocabulary'
+require_relative '../elements/scene'
+
+module TyranoDsl::ParsingWords::StartScene
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  # @param [String] scene_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def start_scene(scene_name)
+    if context.world.scenes.key? scene_name
+      raise TyranoDsl::TyranoException, "Duplicated scene [#{scene_name}]"
+    end
+    unless context.world.title_screen.first_scene_name
+      context.world.title_screen.first_scene_name = scene_name
+    end
+    context.world.scenes[scene_name] =
+        TyranoDsl::Elements::Scene.new(
+            scene_name,
+            context.world.scenes.length + 1
+        )
+    add_parsed_word(
+        TyranoDsl::Vocabulary::START_SCENE,
+        name: scene_name
+    )
+  end
+
+end

data/lib/tyrano_dsl/parsing_words/update_variable.rb

@@ -0,0 +1,37 @@
+require_relative '../vocabulary'
+require_relative 'parsing_words_module'
+
+module TyranoDsl::ParsingWords::UpdateVariable
+
+  include TyranoDsl::ParsingWords::ParsingWordsModule
+
+  VALID_OPERATORS = [
+      '=',
+      '+=',
+      '-=',
+      '*=',
+      '/=',
+      '%=',
+  ]
+
+  # @param [String] variable
+  # @param [String] operator
+  # @param [String|Symbol|Float] value
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def update_variable(variable, operator, value)
+    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::UPDATE_VARIABLE,
+        variable: variable,
+        operator: operator,
+        value: value
+    )
+  end
+end

data/lib/tyrano_dsl/tyrano_dsl.rb

@@ -0,0 +1,3 @@
+module TyranoDsl
+  VERSION = '0.1.0'
+end

data/lib/tyrano_dsl/tyrano_exception.rb

@@ -0,0 +1,6 @@
+require_relative 'tyrano_dsl'
+
+# When something goes wrong.
+class TyranoDsl::TyranoException < RuntimeError
+
+end

data/lib/tyrano_dsl/vocabulary.rb

@@ -0,0 +1,84 @@
+require_relative 'tyrano_dsl'
+
+# All the available words of the DSL
+module TyranoDsl::Vocabulary
+
+  # Declare a background
+  ASK_QUESTION = :ask_question
+  # Conditional jump
+  CONDITIONAL_JUMP = :conditional_jump
+  # Declare a background
+  DECLARE_BACKGROUND = :declare_background
+  # Declare a character
+  DECLARE_CHARACTER = :declare_character
+  # Declare a label
+  DECLARE_LABEL = :declare_label
+  # Declare a variable
+  DECLARE_VARIABLE = :declare_variable
+  # Display some text
+  DISPLAY_TEXT = :display_text
+  # Hide a character
+  HIDE_CHARACTER = :hide_character
+  # Hide the message window
+  HIDE_MESSAGE_WINDOW = :hide_message_window
+  # Include another file
+  INCLUDE_FILE = :include_file
+  # Jump to a scene
+  JUMP = :jump
+  # Set the current background
+  SET_BACKGROUND = :set_background
+  #  Set the background of the title screen
+  SET_TITLE_SCREEN_BACKGROUND = :set_title_screen_background
+  #  Set the stance of a character
+  SET_CHARACTER_STANCE = :set_character_stance
+  # Show a character
+  SHOW_CHARACTER = :show_character
+  # Show the message window
+  SHOW_MESSAGE_WINDOW = :show_message_window
+  # Start a scene
+  START_SCENE = :start_scene
+  # Update a variable
+  UPDATE_VARIABLE = :update_variable
+
+  # All the available words
+  ALL_WORDS = [
+      ASK_QUESTION,
+      CONDITIONAL_JUMP,
+      DECLARE_BACKGROUND,
+      DECLARE_CHARACTER,
+      DECLARE_LABEL,
+      DECLARE_VARIABLE,
+      DISPLAY_TEXT,
+      HIDE_CHARACTER,
+      HIDE_MESSAGE_WINDOW,
+      INCLUDE_FILE,
+      JUMP,
+      SET_BACKGROUND,
+      SET_TITLE_SCREEN_BACKGROUND,
+      SET_CHARACTER_STANCE,
+      SHOW_CHARACTER,
+      SHOW_MESSAGE_WINDOW,
+      START_SCENE,
+      UPDATE_VARIABLE,
+  ].sort.freeze
+
+  # Get the word class corresponding to the words
+  # @param [String] class_file_path name of the class
+  def self.get_words_class(class_file_path)
+    TyranoDsl::Vocabulary::ALL_WORDS.each do |word|
+      full_path = "#{class_file_path}/#{word}"
+      require_relative full_path
+      full_class_name = "TyranoDsl::" + full_path.
+          split('_').
+          collect(&:capitalize).
+          join.
+          split('/').
+          collect do |c|
+        c[0] = c[0].upcase
+        c
+      end.join('::')
+      word_class = Kernel.const_get(full_class_name)
+      yield(word, word_class)
+    end
+  end
+end

data/lib/tyrano_dsl/writer.rb

@@ -0,0 +1,114 @@
+require 'logger'
+
+require_relative 'elements_writers/background_writer'
+require_relative 'elements_writers/character_writer'
+require_relative 'elements_writers/characters_writer'
+require_relative 'elements_writers/title_screen_writer'
+require_relative 'elements_writers/variables_writer'
+require_relative 'tyrano_dsl'
+require_relative 'vocabulary'
+require_relative 'writing_context'
+
+# Write the content that have been parsed
+class TyranoDsl::Writer
+
+  def initialize
+    @logger = Logger.new(STDOUT)
+    @words = {}
+    TyranoDsl::Vocabulary.get_words_class('writing_words') do |word, word_class|
+      @words[word] = word_class.new
+    end
+  end
+
+  # @param [TyranoDsl::Elements::World] world
+  # @param [Array<TyranoDsl::ParsedWord>] parsed_words
+  # @return [TyranoDsl::WritingContext]
+  # @raise [TyranoDsl::TyranoException]
+  def write(world, parsed_words)
+    log {'Writing content'}
+    writing_context = TyranoDsl::WritingContext.new(world)
+    write_title_screen(writing_context, world)
+    write_backgrounds(writing_context, world)
+    write_characters(writing_context, world)
+    write_scenes(writing_context, world, parsed_words)
+    write_variables(writing_context, world)
+    writing_context.end_writing
+    log {'Content written'}
+    writing_context
+  end
+
+  private
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::Elements::World] world
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def write_title_screen(writing_context, world)
+    title_screen_writer = TyranoDsl::ElementsWriters::TitleScreenWriter.new
+    concat_file_actions(writing_context, title_screen_writer.write(world))
+  end
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::Elements::World] world
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def write_characters(writing_context, world)
+    character_writer = TyranoDsl::ElementsWriters::CharacterWriter.new
+    concat_file_actions(writing_context, character_writer.init_actions)
+    world.characters.each_value do |character|
+      concat_file_actions(writing_context, character_writer.write(character))
+    end
+    characters_writer = TyranoDsl::ElementsWriters::CharactersWriter.new
+    concat_file_actions(writing_context, characters_writer.write(world))
+  end
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::Elements::World] world
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def write_backgrounds(writing_context, world)
+    background_writer = TyranoDsl::ElementsWriters::BackgroundWriter.new
+    concat_file_actions(writing_context, background_writer.init_actions)
+    world.backgrounds.each_value do |background|
+      concat_file_actions(writing_context, background_writer.write(background))
+    end
+  end
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [TyranoDsl::Elements::World] world
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def write_variables(writing_context, world)
+    variables_writer = TyranoDsl::ElementsWriters::VariablesWriter.new
+    concat_file_actions(writing_context, variables_writer.write(world))
+  end
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [Array] file_actions
+  # @return [void]
+  def concat_file_actions(writing_context, file_actions)
+    writing_context.file_actions.concat(file_actions)
+  end
+
+  # @param [TyranoDsl::WritingContext] writing_context
+  # @param [Array<TyranoDsl::ParsedWord>] parsed_words
+  # @param [TyranoDsl::Elements::World] world
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def write_scenes(writing_context, world, parsed_words)
+    parsed_words.each do |parsed_word|
+      action_word = @words[parsed_word.word]
+      action_word.run(
+          writing_context,
+          world,
+          parsed_word.word_location,
+          parsed_word.parameters
+      )
+    end
+  end
+
+  def log
+    @logger.info(self.class) {yield}
+  end
+
+end

data/lib/tyrano_dsl/writing_context.rb

@@ -0,0 +1,123 @@
+require 'logger'
+require 'set'
+
+require_relative 'elements_writers/scene_writer'
+require_relative 'tyrano_exception'
+require_relative 'tyrano_dsl'
+
+# Context for writing
+class TyranoDsl::WritingContext
+
+  # @return [Array<String>]
+  attr_reader :current_scene_assets
+  # @return [Array<String>]
+  attr_reader :current_scene_content
+  # @return [Hash{String => Object}]
+  attr_reader :file_actions
+  # @return [TyranoDsl::Elements::World]
+  attr_reader :world
+
+  # @param [TyranoDsl::Elements::World] world
+  def initialize(world)
+    @logger = Logger.new(STDOUT)
+    @world = world
+    @file_actions = []
+    @current_scene_content = nil
+    @current_scene_name = nil
+    @current_scene_assets = nil
+    @current_scene_labels = nil
+    @scene_writer = TyranoDsl::ElementsWriters::SceneWriter.new
+  end
+
+  # Append some content to the current scene
+  #
+  # @param [Array<String>] word_location
+  # @param [Array<String>] content
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def append_content(word_location, content)
+    check_in_scene(word_location)
+    @current_scene_content << content
+  end
+
+  # Add an asset to be loaded in the current scene
+  #
+  # @param [Array<String>] word_location
+  # @param [String] asset_content
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def add_asset_loading(word_location, asset_content)
+    check_in_scene(word_location)
+    @current_scene_assets << asset_content
+  end
+
+  # Add an label in the current scene
+  #
+  # @param [Array<String>] word_location
+  # @param [String] label_name
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def add_label(word_location, label_name)
+    check_in_scene(word_location)
+    if @current_scene_labels.include? label_name
+      raise TyranoDsl::TyranoException, "Duplicated label [#{label_name}]"
+    end
+    @current_scene_labels << label_name
+  end
+
+  # Initialize a new scene
+  # @param [String] scene_name the scene name
+  # @return [void]
+  def init_new_scene(scene_name)
+    write_current_scene
+    @current_scene_content = []
+    @current_scene_name = scene_name
+    @current_scene_assets = Set.new
+    @current_scene_labels = []
+  end
+
+  # Bookkeeping stuff to end the writing
+  # @raise [TyranoDsl::TyranoException]
+  # @return [void]
+  def end_writing
+    write_current_scene
+    @current_scene_content = nil
+    @current_scene_name = nil
+    @current_scene_assets = nil
+    @current_scene_labels = nil
+    @world.validate
+    log {"Writing is over, #{@file_actions.length} actions created"}
+  end
+
+  private
+
+  def write_current_scene
+    if @current_scene_name
+      current_scene = @world.scenes[@current_scene_name]
+      @file_actions.concat @scene_writer.write(
+          current_scene,
+          @current_scene_content,
+          @current_scene_assets
+      )
+      @current_scene_labels.each do |label|
+        current_scene.labels << label
+      end
+    end
+  end
+
+  def log
+    @logger.info(self.class) {yield}
+  end
+
+  # @param [Array<String>] word_location
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def check_in_scene(word_location)
+    unless @current_scene_content
+      exception = TyranoDsl::TyranoException.new('This action should take place in a scene')
+      exception.set_backtrace word_location
+      raise exception
+    end
+  end
+
+end

data/lib/tyrano_dsl/writing_words/ask_question.rb

@@ -0,0 +1,28 @@
+require_relative 'writing_words_module'
+
+class TyranoDsl::WritingWords::AskQuestion
+
+  include TyranoDsl::WritingWords::WritingWordsModule
+
+  def run(writing_context, world, word_location, parameters)
+    content = []
+    parameters[:possible_answers].each do |possible_answer|
+      text = possible_answer[:text]
+      scene_name = possible_answer[:scene]
+      label_name = possible_answer[:label]
+      top = possible_answer[:top]
+      left = possible_answer[:left]
+      target_scene = fetch_scene(world, word_location, scene_name)
+
+      label = label_name ? world.labels[label_name].target_name : ''
+
+      content << "[glink color=\"black\" storage=\"#{target_scene.target_name}\" target=\"#{label}\" size=\"20\" x=\"#{left}\" y=\"#{top}\" text=\"#{h(text)}\"]\n"
+    end
+    content << "[s]\n"
+    writing_context.append_content(
+        word_location,
+        content.join
+    )
+  end
+
+end