ruby-miyako-mswin32 2.1.6 → 2.1.7

data/README

@@ -1,8 +1,8 @@
 *******************************************************************************
 【   作者名   】　サイロス誠
 【  ソフト名  】　Interactive Media Authoring System "Miyako"
-【 バージョン 】　2.1.6
-【   作成日   】　2010/01/01
+【 バージョン 】　2.1.7
+【   作成日   】　2010/01/03
 【    種別    】　フリーウェア
 【  開発言語  】　Ruby 1.9.1
 【 ランタイム 】　Ruby 1.9.1～,Ruby/SDL 2.1～,SDL
@@ -15,7 +15,7 @@
 
 【 注意事項  】
 
-本バージョンは、2.1.5公式リリース版です。
+本バージョンは、2.1.7公式リリース版です。
 本バージョンでは、ドキュメント・リファレンスは不十分ですが、「サイログ。」内や、サンプルプログラムの紹介等で随時ドキュメントを公開して行きます。
 （RDOC化を進めていますので、我こそはと思う方は是非・・・）
 
@@ -1546,5 +1546,47 @@ v2.1.6(2010.01.01)
 ・InitiativeScenarioEngine#update_animation_all
 <インスタンスメソッド廃止>
 
+v2.1.7(2010.01.03)
+<バグ修正>
+・InitiativeScenarioEngine#Command構造体の順番がScenarioEngine#Commandと同期されていなかった問題を修正
+・InitiativeScenarioEngine#CommandEx構造体の順番がScenarioEngine#CommandExと同期されていなかった問題を修正
+・InitiativeScenarioEngine#render_allでエラーを出すバグを修正
+・InitiativeScenarioEngine#render_to_allでエラーを出すバグを修正
+・InitiativeScenarioEngine#pauseで解除待ちカーソルが消えないバグを修正
+<機能改善>
+<仕様変更>
+・(Initiative)ScenarioEngine#commandで、第2引数にnilを渡すことで、キャンセル操作無効にするようにした(明示的な引数渡しが必要)
+・over_execで使用するシナリオエンジンの事前登録が可能
+・ScenarioEngine#over_execメソッドの仕様を変更(engine,plotが省略可能に)
+・InitiativeScenarioEngine#over_execメソッドの仕様を変更(base,engine,plotが省略可能に)
+<ファイル追加>
+・API/simple_story.rb
+<ファイル削除>
+<グローバル変数追加>
+<定数追加>
+<定数削除>
+<構造体追加>
+<クラス追加>
+・SimpleStory
+<モジュール追加>
+・SimpleStory::Scene
+<mixin>
+<クラス・モジュールメソッド追加>
+<クラス・モジュールメソッド廃止>
+<モジュール関数追加>
+<モジュール関数廃止>
+<インスタンスメソッド追加>
+・ScenarioEngine#over_engine=
+・ScenarioEngine#under_engine
+・ScenarioEngine#under_engine=
+・ScenarioEngine#render_all
+・ScenarioEngine#render_to_all
+・InitiativeScenarioEngine#over_engine=
+・InitiativeScenarioEngine#under_engine
+・InitiativeScenarioEngine#under_engine=
+・InitiativeScenarioEngine#engine_stack
+・InitiativeScenarioEngine#create_engine_stack
+<インスタンスメソッド廃止>
+
 *******************************************************************************
 このReadMeファイルは「れ～どめ～えじた～」によって作成されました。

data/lib/Miyako/API/i_yuki.rb

@@ -82,7 +82,7 @@ module Miyako
     #_result_:: 選択結果（移動先シーンクラス名、シナリオ（メソッド）名他のオブジェクト）
     #_body_disable_:: 選択不可時コマンドの名称（移動する、調べるなど、アイコンなどの画像も可）(省略時は、bodyと同一)
     #_enabe_:: コマンド選択の時はtrue、選択不可の時はfalseを設定
-    Command = Struct.new(:body, :body_selected, :condition, :result, :body_disable, :enable)
+    Command = Struct.new(:body, :body_selected, :body_disable, :enable, :condition, :result)
 
     #==コマンド構造体
     #_body_:: コマンドの名称（移動する、調べるなど、アイコンなどの画像も可）
@@ -93,7 +93,7 @@ module Miyako
     #_body_disable_:: 選択不可時コマンドの名称（移動する、調べるなど、アイコンなどの画像も可）(省略時は、bodyと同一)
     #ブロックは1つの引数を取る(コマンド選択テキストボックス))。デフォルトはnil
     #_enabe_:: コマンド選択の時はtrue、選択不可の時はfalseを設定
-    CommandEX = Struct.new(:body, :body_selected, :condition, :result, :end_select_proc, :body_disable, :enable)
+    CommandEX = Struct.new(:body, :body_selected, :condition, :body_disable, :enable, :result, :end_select_proc)
 
     attr_reader :visibles, :pre_visibles, :bgs, :base
     attr_reader :valign
@@ -114,6 +114,11 @@ module Miyako
     #callメソッドを持つブロックが使用可能。
     attr_reader :selecting_procs
 
+    #over_execを使用したシナリオエンジンのコールスタック
+    #over_execするエンジンを基準に、一番大本のエンジンから順に積み込まれる
+    #自分自身(self)は含まない
+    attr_reader :engine_stack
+
     #===Yukiにメソッドを追加する(すべてのYukiインスタンスに適応)
     #ブロックを渡すことで、Yukiに新しいメソッドを追加できる。
     #追加したメソッドは、すべてのYukiインスタンスで利用可能となる。
@@ -152,6 +157,7 @@ module Miyako
     def initialize(*params, &proc)
       @base = nil
       @over_yuki = nil
+      @under_yuki = nil
       @yuki = { }
       @text_box = nil
       @command_box = nil
@@ -168,6 +174,7 @@ module Miyako
       @select_ok = false
       @select_cancel = false
       @select_amount = [0, 0]
+      @cencel = nil
       @mouse_amount = nil
 
       @mouse_enable = true
@@ -215,6 +222,8 @@ module Miyako
       @now_page = nil
       @first_page = nil
 
+      @engine_stack = []
+
       raise MiyakoProcError, "Aagument count is not same block parameter count!" if proc && proc.arity.abs != params.length
       instance_exec(*params, &proc) if block_given?
     end
@@ -223,6 +232,13 @@ module Miyako
       raise MiyakoCopyError.not_copy("Yuki")
     end
 
+    #===エンジンスタックを生成する
+    #base:: over_exec呼び出し元のエンジン
+    def create_engine_stack(base)
+      return unless @engine_stack.empty?
+      @engine_stack.push(*base.engine_stack, base)
+    end
+
     #===マウスでの制御を可能にする
     #ゲームパッド・キーボードでのコマンド・ポーズ制御を行えるが、
     #それに加えて、マウスでもゲームパッド・キーボードでの制御が行える
@@ -254,7 +270,7 @@ module Miyako
       self.bgs.render
       self.visibles.render
       self.textbox_all.render
-      self.commandbox_all.render unless yuki.box_shared?
+      self.commandbox_all.render unless self.box_shared?
       self.pre_visibles.render
     end
 
@@ -271,7 +287,7 @@ module Miyako
       self.bgs.render_to(dst)
       self.visibles.render_to(dst)
       self.textbox_all.render_to(dst)
-      self.commandbox_all.render_to(dst) unless yuki.box_shared?
+      self.commandbox_all.render_to(dst) unless self.box_shared?
       self.pre_visibles.render_to(dst)
     end
 
@@ -825,6 +841,21 @@ module Miyako
       @over_yuki
     end
 
+    def over_engine=(engine)
+      @over_yuki = engine
+      engine.under_engine = self
+      engine.engine_stack.clear
+      engine.create_engine_stack(self)
+    end
+
+    def under_engine
+      @under_yuki
+    end
+
+    def under_engine=(engine)
+      @under_yuki = engine
+    end
+
     #===別のYukiエンジンを実行する
     #[[Yukiスクリプトとして利用可能]]
     #もう一つのYukiエンジンを実行させ、並行実行させることができる
@@ -835,10 +866,11 @@ module Miyako
     #_plot_:: プロットインスタンス。すでにsetupなどで登録しているときはnilを渡す
     #_params_:: プロット実行開始時に、プロットに渡す引数
     #返却値:: 自分自身を返す
-    def over_exec(yuki, base, plot, *params)
+    def over_exec(yuki = nil, base = nil, plot = nil, *params)
       raise MiyakoValueError, "This Yuki engine is same as self!" if yuki.eql?(self)
-      @over_yuki = yuki
-      @over_yuki.start_plot(base, plot, *params)
+      self.over_engine = yuki if yuki
+      @over_yuki.start_plot(base ? base : @over_yuki, plot, *params)
+      yuki.engine_stack.clear if yuki
       return self
     end
 
@@ -1260,6 +1292,7 @@ module Miyako
         pause_release = @release_checks.inject(false){|r, c| r |= c.call }
         post_process
       end
+      @text_box.release
       @post_pause.each{|proc| proc.call}
       return self
     end
@@ -1312,7 +1345,7 @@ module Miyako
         pre_process
         @base.selecting_inner(self) if @base
         @select_ok = true if @ok_checks.inject(false){|r, c| r |= c.call }
-        @select_cancel = true if @cancel_checks.inject(false){|r, c| r |= c.call }
+        @select_cancel = true if @cancel && @cancel_checks.inject(false){|r, c| r |= c.call }
         @select_amount = @key_amount_proc.call
         @mouse_amount = @mouse_amount_proc.call
         @selecting_procs.each{|sp|

data/lib/Miyako/API/simple_story.rb

@@ -0,0 +1,240 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+--
+Miyako v2.1
+Copyright (C) 2007-2009  Cyross Makoto
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+++
+=end
+
+module Miyako
+  #==シーン実行クラス
+  #用意したシーンインスタンスを実行
+  class SimpleStory
+
+    @@sub_scenes = [:sub_scene, :sub_routine]
+
+    def prev_label #:nodoc:
+      return @prev_label
+    end
+
+    def next_label #:nodoc:
+      return @next_label
+    end
+
+    def upper_label #:nodoc:
+      return @stack.empty? ? nil : @stack.last[0]
+    end
+
+    #===インスタンスの作成
+    #ストーリー情報の初期か
+    #返却値:: 生成したインスタンス
+    def initialize
+      @prev_label = nil
+      @next_label = nil
+
+      @stack = []
+    end
+
+    def initialize_copy(obj) #:nodoc:
+      @stack = @stack.dup
+    end
+
+    #===Storyの実行を始める
+    #"obj.run(MainScene)"と記述すると、SceneモジュールをmixinしたMainSceneクラスのインスタンスを作成し、評価を始める
+    #_n_:: 最初に実行するシーン名(クラス名を定数で)
+    def run(n)
+      return nil if n == nil
+      u = nil
+      on = nil
+      @stack = Array.new # reset
+      while n != nil
+        @prev_label = on
+        on = n
+
+        raise MiyakoValueError, "Illegal Script-label name! : #{n}" unless Scene.has_scene?(n.to_s)
+        raise MiyakoValueError, "This scene cannot use for Standard Scene! : #{n}" if n.scene_type != :scene
+        u = n.new(self) if u == nil
+        u.init_inner(@prev_label, self.upper_label)
+
+        n = u.execute
+        u.next = n
+        @next_label = n
+        if n.nil?
+          if @@sub_scenes.include?(u.class.scene_type) && @stack.empty? == false
+            n, u = @stack.pop
+            next
+          end
+          u.dispose
+          break
+        elsif @@sub_scenes.include?(n.scene_type)
+          @stack.push([on, u])
+          u = nil
+        else
+          u.dispose
+          u = nil
+        end
+      end
+    end
+
+    #===内部の情報を解放する
+    def dispose
+      @stack.each{|scene| scene.dispose }
+    end
+
+    #==シーンモジュール
+    #本モジュールをmixinすることにより、シーンを示すインスタンスを作成することができる
+    #mixinするときに気をつけなければいけないのは、本モジュールでは以下の
+    #モジュール変数を
+    #予約しているため、これらの変数の値を勝手に変えてはいけない
+    #・@@scenesモジュール変数(シーンクラス一覧が入っているハッシュ)
+    #・@@poolモジュール変数(シーン情報が入っているハッシュ)
+    #(互換性のために@nowを残しているが、now_sceneのみを使うときは値を上書きしてもかまわない))
+    #また、シーンには「シーン形式」がある。
+    #種類は、シーケンスな移動が出来る「通常シーン」、終了したときに移動元に戻る「サブシーン」、
+    #現在実行中のシーン上で並行に実行する「オーバーシーン」の3種類。
+    #デフォルトは「通常シーン」となっている。
+    #判別は、scene_typeクラスメソッドを呼び出すことで可能。デフォルトは、
+    #通常シーンを示すシンボル":scene"が返る。
+    #形式を変えるには、scene_typeクラスメソッドをオーバーライドし、返却値を変える。
+    #サブシーンの時はシンボル":sub_scene"を返すように実装する
+    #(注1)同じクラス名のシーンを繰り返し実行したいときは、いったん別のダミーシーンを
+    #介してから元のシーンへ移動する必要がある
+    #(注2)オーバーシーン内では、シーンの移動が出来ないが、入れ子形式で
+    #別のオーバーシーンを積み上げる形なら移動可能。
+    module Scene
+      @@scenes = {}
+      @@pool = {}
+
+      def self.included(c) #:nodoc:
+        unless c.singleton_methods.include?(:scene_type)
+          def c.scene_type
+            return :scene
+          end
+        end
+        @@scenes[c.to_s] = c
+      end
+
+      def self.scenes #:nodoc:
+        return @@scenes
+      end
+
+      def self.has_scene?(s) #:nodoc:
+        return @@scenes.has_key?(s)
+      end
+
+      def initialize(story, check_only=false) #:nodoc:
+        return if check_only
+        @@pool[self.object_id] = Miyako::Story::ScenePool.new(story, nil, nil, nil)
+        @now = self.now_scene
+        self.init
+      end
+
+      def init_inner(p, u) #:nodoc:
+        @@pool[self.object_id].prev = p
+        @@pool[self.object_id].upper = u
+      end
+
+      #===前回実行したシーンを返す
+      #前回実行しているシーンをクラス名で返す
+      #但し、最初のシーンの場合はnilを返す
+      #返却値:: 前回実行したシーン名(Classクラスインスタンス)
+      def story
+        return @@pool[self.object_id].story
+      end
+
+      #===サブルーチンの呼び元シーンを返す
+      #サブルーチンを呼び出したシーンをクラス名で返す
+      #サブルーチンではないときはnilを返す
+      #返却値:: 前回実行したシーン名(Classクラスインスタンス)
+      def upper_scene
+        return @@pool[self.object_id].upper
+      end
+
+      def next_scene #:nodoc:
+        return @@pool[self.object_id].next
+      end
+
+      #===前回実行したシーンを返す
+      #前回実行しているシーンをクラス名で返す
+      #但し、最初のシーンの場合はnilを返す
+      #返却値:: 前回実行したシーン名(Classクラスインスタンス)
+      def prev_scene
+        return @@pool[self.object_id].prev
+      end
+
+      #===現在実行中のシーンを返す
+      #現在実行しているシーンをクラス名で返す
+      #返却値:: 前回実行したシーン名(Classクラスインスタンス)
+      def now_scene
+        return self.class
+      end
+
+      #===シーン内で使用するオブジェクトの初期化テンプレートメソッド
+      #シーン内で使用するインスタンスを生成するときなどにこのメソッドを実装する
+      def init
+      end
+
+      #===シーンの情報を更新するテンプレートメソッド
+      #
+      #現在実行しているシーンを繰り返し実行する場合はインスタンス変数@nowを返すように実装する
+      #nilを返すとシーンの処理を終了する(元のStory#runメソッド呼び出しの次に処理が移る)
+      #但し、scene_typeメソッドの結果が:sub_routneのとき、移動元シーンに戻る
+      #返却値:: 移動先シーンクラス
+      def execute
+        return now_scene
+      end
+
+      #===シーンに使用したデータの解放を記述するテンプレートメソッド
+      #initメソッドと対になっているというイメージ
+      def dispose
+      end
+
+      def next=(label) #:nodoc:
+        @@pool[self.object_id].next = label
+      end
+
+      #===シーンの解説を返す(テンプレートメソッド)
+      #Sceneモジュールをmixinしたとき、解説文を返す実装をしておくと、
+      #Scene.#lisutupメソッドを呼び出したときに、noticeメソッドの結果を取得できる
+      #返却値:: シーンの解説(文字列)
+      def notice
+        return ""
+      end
+
+      #===登録しているシーン一覧をリストアップする
+      #リストの内容は、"シーンクラス名(文字列),シーンクラス(ポインタ),
+      #解説(noticeメソッドの内容)"という書式で取得できる
+      #返却値:: リストアップしたシーンの配列
+      def self.listup
+        list = Array.new
+        sns = @@scenes
+        sns.keys.sort.each{|k| list.push("#{k}, #{sns[k]}, \"#{sns[k].notice}\"\n") }
+        return list
+      end
+
+      #===Scene.#listupメソッドの内容をCSVファイルに保存する
+      #_csvname_:: 保存するCSVファイルパス
+      def self.listup2csv(csvfname)
+        csvfname += ".csv" if csvfname !~ /\.csv$/
+        list = self.listup
+        File.open(csvfname, "w"){|f| list.each{|l| f.print l } }
+      end
+
+    end
+  end
+end

data/lib/Miyako/API/story.rb

@@ -151,7 +151,7 @@ module Miyako
       @@scenes = {}
       @@pool = {}
 
-      def Scene.included(c) #:nodoc:
+      def self.included(c) #:nodoc:
         unless c.singleton_methods.include?(:scene_type)
           def c.scene_type
             return :scene
@@ -160,11 +160,11 @@ module Miyako
         @@scenes[c.to_s] = c
       end
 
-      def Scene.scenes #:nodoc:
+      def self.scenes #:nodoc:
         return @@scenes
       end
 
-      def Scene.has_scene?(s) #:nodoc:
+      def self.has_scene?(s) #:nodoc:
         return @@scenes.has_key?(s)
       end
 
@@ -267,7 +267,7 @@ module Miyako
       #リストの内容は、"シーンクラス名(文字列),シーンクラス(ポインタ),
       #解説(noticeメソッドの内容)"という書式で取得できる
       #返却値:: リストアップしたシーンの配列
-      def Scene.listup
+      def self.listup
         list = Array.new
         sns = @@scenes
         sns.keys.sort.each{|k| list.push("#{k}, #{sns[k]}, \"#{sns[k].notice}\"\n") }
@@ -276,7 +276,7 @@ module Miyako
 
       #===Scene.#listupメソッドの内容をCSVファイルに保存する
       #_csvname_:: 保存するCSVファイルパス
-      def Scene.listup2csv(csvfname)
+      def self.listup2csv(csvfname)
         csvfname += ".csv" if csvfname !~ /\.csv$/
         list = self.listup
         File.open(csvfname, "w"){|f| list.each{|l| f.print l } }

data/lib/Miyako/API/yuki.rb

@@ -146,6 +146,7 @@ module Miyako
     def initialize(*params, &proc)
       @yuki = { }
       @over_yuki = nil
+      @under_yuki = nil
       @over_exec = false
       @text_box = nil
       @command_box = nil
@@ -164,6 +165,7 @@ module Miyako
       @select_ok = false
       @select_cancel = false
       @select_amount = [0, 0]
+      @cencel = nil
       @mouse_amount = nil
 
       @mouse_enable = true
@@ -238,6 +240,19 @@ module Miyako
       @over_yuki
     end
 
+    def over_engine=(engine)
+      @over_yuki = engine
+      engine.under_engine = self
+    end
+
+    def under_engine
+      @under_yuki
+    end
+
+    def under_engine=(engine)
+      @under_yuki = engine
+    end
+
     #===マウスでの制御を可能にする
     #ゲームパッド・キーボードでのコマンド・ポーズ制御を行えるが、
     #それに加えて、マウスでもゲームパッド・キーボードでの制御が行える
@@ -283,6 +298,22 @@ module Miyako
       return self
     end
 
+    def render_all
+      self.bgs.render
+      self.visibles.render
+      self.textbox_all.render
+      self.commandbox_all.render unless self.box_shared?
+      self.pre_visibles.render
+    end
+
+    def render_to_all(dst)
+      self.bgs.render_to(dst)
+      self.visibles.render_to(dst)
+      self.textbox_all.render_to(dst)
+      self.commandbox_all.render_to(dst) unless self.box_shared?
+      self.pre_visibles.render_to(dst)
+    end
+
     #===Yuki#showで表示指定した画像のアニメーションを更新する
     #showメソッドで指定した画像のupdate_animationメソッドを呼び出す
     #返却値:: 描く画像のupdate_spriteメソッドを呼び出した結果を配列で返す
@@ -724,9 +755,9 @@ module Miyako
     #_plot_:: プロットインスタンス。すでにsetupなどで登録しているときはnilを渡す
     #_params_:: プロット実行開始時に、プロットに渡す引数
     #返却値:: 自分自身を返す
-    def over_exec(yuki, plot, *params)
+    def over_exec(yuki = nil, plot = nil, *params)
       raise MiyakoValueError, "This Yuki engine is same as self!" if yuki.eql?(self)
-      @over_yuki = yuki
+      self.over_engine = yuki if yuki
       @over_yuki.start_plot(plot, *params)
       return self
     end
@@ -848,7 +879,7 @@ module Miyako
         @pause_release = true
       elsif @selecting
         @select_ok = true if @ok_checks.inject(false){|r, c| r |= c.call }
-        @select_cancel = true if @cancel_checks.inject(false){|r, c| r |= c.call }
+        @select_cancel = true if @cancel && @cancel_checks.inject(false){|r, c| r |= c.call }
         @select_amount = @key_amount_proc.call
         @mouse_amount = @mouse_amount_proc.call
       end

data/lib/Miyako/miyako.rb

@@ -63,7 +63,7 @@ Thread.abort_on_exception = true
 
 #==Miyako基幹モジュール
 module Miyako
-  VERSION = "2.1.4"
+  VERSION = "2.1.7"
 
   #===アプリケーション実行中に演奏する音楽のサンプリングレートを指定する
   #単位はHz(周波数)
@@ -155,6 +155,7 @@ require 'Miyako/API/map'
 require 'Miyako/API/fixedmap'
 require 'Miyako/API/map_event'
 require 'Miyako/API/story'
+require 'Miyako/API/simple_story'
 require 'Miyako/API/diagram'
 
 module Miyako

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-miyako-mswin32
 version: !ruby/object:Gem::Version 
-  version: 2.1.6
+  version: 2.1.7
 platform: ruby
 authors: 
 - Cyross Makoto
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-01 00:00:00 +09:00
+date: 2010-01-03 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -57,6 +57,7 @@ files:
 - ./lib/Miyako/API/sprite_animation.rb
 - ./lib/Miyako/API/sprite_list.rb
 - ./lib/Miyako/API/story.rb
+- ./lib/Miyako/API/simple_story.rb
 - ./lib/Miyako/API/struct_point.rb
 - ./lib/Miyako/API/struct_size.rb
 - ./lib/Miyako/API/struct_rect.rb