limelight 0.2.1-java → 0.3.0-java

data/lib/limelight/production.rb

@@ -2,6 +2,7 @@
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/limelight_exception'
+require 'limelight/file_loader'
 
 module Limelight
 
@@ -51,13 +52,13 @@ module Limelight
       
     end
     
-    attr_reader :producer, :theater, :name
+    attr_reader :name, :root 
+    attr_accessor :producer, :theater
 
     # Users typically need not create Production objects.
     #
-    def initialize(producer, theater)
-      @producer = producer
-      @theater = theater
+    def initialize(path)    
+      @root = FileLoader.for_root(path)
       self.class.index(self)
     end
 
@@ -67,6 +68,43 @@ module Limelight
       self.class.error_if_duplicate_name(value)
       @name = value
     end
+
+    # Return the path to the root directory of the production
+    #
+    def path
+      return @root.root
+    end
+
+    # Returns the path to the production's init file
+    #
+    def init_file
+      return @root.path_to("init.rb")
+    end
+
+    # Returns the path to the production's stages file
+    #
+    def stages_file
+      return @root.path_to("stages.rb")
+    end
+
+    # Returns the path to the production's styles file
+    #
+    def styles_file
+      return @root.path_to("styles.rb")
+    end
+
+    # Returns the path to the production's gems directory
+    #
+    def gems_directory
+      return @root.path_to("__resources/gems")
+    end
+
+    # Returns the path to the named Scene's directory within the Production
+    #
+    def scene_directory(name)
+      return @root.root if name == :root
+      return @root.path_to(name)
+    end
     
   end
   

data/lib/limelight/prop.rb

@@ -16,7 +16,7 @@ module Limelight
   # the root Prop of a tree.
   #
   class Prop
-    
+
     class << self
 
       def event(event_symbol)
@@ -29,14 +29,17 @@ module Limelight
         return @events
       end
 
+      def event2(event_symbol)
+        define_method("accepts_#{event_symbol}".to_sym) { return self.respond_to?(event_symbol) }
+      end
+
     end
-    
+
     include UI::Api::Prop
-  
+
     attr_reader :panel #:nodoc:
-    attr_reader :style, :hover_style, :children, :scene, :parent, :name, :id, :players
-    getters :panel, :style, :hover_style, :scene, :name, :text  #:nodoc:
-    setters :text #:nodoc:
+    attr_reader :style, :hover_style, :children, :parent, :name, :id, :players
+    getters :panel, :style, :hover_style, :name, :scene, :loader #:nodoc:
 
     # When creating a Prop, an optional Hash is accepted. These are called initialization options.
     # The key/value pairs in the initialiaztion options will be used to
@@ -48,6 +51,7 @@ module Limelight
       @children = []
       @style = Styles::ScreenableStyle.new
       @panel = UI::Model::Panel.new(self)
+      @illuminated = false
     end
 
     # Add a Prop as a child of this Prop.
@@ -77,8 +81,9 @@ module Limelight
     #    end
     #
     def build(&block)
-      require 'limelight/prop_builder'
-      builder = Limelight::PropBuilder.new(self)
+      require 'limelight/dsl/prop_builder'
+      builder = Limelight::DSL::PropBuilder.new(self)
+      builder.__loader__ = scene.loader
       builder.instance_eval(&block)
     end
 
@@ -86,6 +91,7 @@ module Limelight
     #
     def remove(child)
       if children.delete(child)
+        scene.unindex_prop(child) if scene
         @panel.remove(child.panel)
       end
     end
@@ -94,6 +100,7 @@ module Limelight
     #
     def remove_all
       @panel.remove_all
+      @children.each { |child| scene.unindex_prop(child) } if scene
       @children = []
     end
 
@@ -102,18 +109,18 @@ module Limelight
     def include_player(player_module)
       extend player_module unless self.is_a?(player_module)
     end
-    
+
     def update #:nodoc:
-      return if(@scene.nil? || !@scene.visible)
+      return if (scene.nil? || !scene.visible)
       @panel.doLayout
       @panel.repaint
     end
-    
+
     def update_now #:nodoc:
-      return if(@scene.nil? || !@scene.visible)
+      return if (scene.nil? || !scene.visible)
       @panel.doLayout()
       @panel.paintImmediately(0, 0, @panel.width, @panel.height)
-    end    
+    end
 
     # A hook to invoke behavior after a Prop is painted.
     #
@@ -125,17 +132,6 @@ module Limelight
       end
     end
 
-    # Searches all children for a Prop with the given id.  Returns the desired Prop if found, nil otherwise.
-    #
-    def find(id)
-      return self if @id == id
-      @children.each do |child|
-        result = child.find(id)
-        return result if result
-      end
-      return nil
-    end   
-
     # Searches all children for Props with the specified name.  Returns an Array of matching Props. Returns an
     # empty Array is none are found.
     #
@@ -157,10 +153,18 @@ module Limelight
     def text
       return panel.text
     end
-    
-    #TODO - MDM - DELETE ME
-    def stage #:nodoc:
-      return scene.stage
+
+    # Returns the scene to which this prop belongs to.
+    #
+    def scene 
+      return nil if @parent.nil?
+      @scene = @parent.scene if @scene.nil?
+      return @scene
+    end
+
+    # TODO get rid of me.... The Java Prop interface declares this method.
+    def loader
+      return scene.production.root;
     end
 
     # Returns the current Production this Prop lives in.
@@ -168,27 +172,19 @@ module Limelight
     def production
       return scene.production
     end
-    
+
     def to_s #:nodoc:
       return "#{self.class.name}[id: #{@id}, name: #{@name}]"
     end
-    
+
     def inspect #:nodoc:
       return self.to_s
     end
-    
+
     # unusual name because it's not part of public api
     def set_parent(parent) #:nodoc:
       @parent = parent
-      set_scene parent.scene
-    end
-    
-    # unusual name because it's not part of public api
-    def set_scene(scene) #:nodoc:
-      return if scene == @scene || scene.nil?
-      @scene = scene
-      illuminate
-      children.each { |child| child.set_scene(scene) }
+      illuminate if @parent.illuminated?
     end
 
     # Allows the addition of extra initialization options.  Will raise an exception if the Prop has already been
@@ -206,7 +202,7 @@ module Limelight
     #   box.width, box.height # represents the Prop's dimensions
     #
     def area
-      return panel.get_box.clone
+      return panel.get_bounding_box.clone
     end
 
     # Returns a Box representing the bounds inside the borders of the prop.  If the Prop's style has no margin or
@@ -226,7 +222,7 @@ module Limelight
     # This filename should relative to the root directory of the current Production, or an absolute path.
     #
     def play_sound(filename)
-      @panel.play_sound(@scene.loader.path_to(filename))
+      @panel.play_sound(scene.loader.path_to(filename))
     end
 
     # Initiate an animation loop.  Options may include :name (string), :updates_per_second (int: defaults to 60)
@@ -245,14 +241,14 @@ module Limelight
       animation.start
       return animation
     end
-    
+
     # GUI Events ##########################################
 
-    event :mouse_clicked
+    event2 :mouse_clicked
     event :mouse_entered
     event :mouse_exited
-    event :mouse_pressed
-    event :mouse_released
+    event2 :mouse_pressed
+    event2 :mouse_released
     event :mouse_dragged
     event :mouse_moved
     event :key_typed
@@ -262,29 +258,47 @@ module Limelight
     event :focus_lost
     event :button_pressed
     event :value_changed
-   
-    private ###############################################
-    
-    def illuminate     
+
+    # TODO Try to get me our of public scope
+    #
+    def illuminate #:nodoc:     
       return if @options.nil?
 
-      @id = @options.delete(:id)
+      set_id(@options.delete(:id))
       @name = @options.delete(:name)
       @players = @options.delete(:players)
       @additional_styles = @options.delete(:styles)
-      
+
       inherit_styles
-      @scene.casting_director.fill_cast(self)
+      scene.casting_director.fill_cast(self)
       apply_options
-      
+
       @options = nil
+
+      @illuminated = true
+
+      children.each do |child|
+        child.illuminate unless child.illuminated?
+      end
+    end
+
+    def illuminated? #:nodoc:
+      return @illuminated
     end
-    
+
+    private ###############################################
+
+    def set_id(id)
+      return if id.nil? || id.to_s.empty?
+      @id = id.to_s
+      scene.index_prop(self)
+    end
+
     def apply_options
       @options.each_pair do |key, value|
-        setter_sym = "#{key.to_s}=".to_sym        
+        setter_sym = "#{key.to_s}=".to_sym
         if self.respond_to?(setter_sym)
-          self.send(setter_sym, value) 
+          self.send(setter_sym, value)
         elsif self.style.respond_to?(setter_sym)
           self.style.send(setter_sym, value.to_s)
         elsif is_event_setter(key)
@@ -292,23 +306,23 @@ module Limelight
         end
       end
     end
-    
+
     def is_event_setter(symbol)
       string_value = symbol.to_s
       return string_value[0..2] == "on_" and self.events.include?(string_value[3..-1].to_sym)
     end
-    
+
     def define_event(symbol, value)
       event_name = symbol.to_s[3..-1]
       self.instance_eval "def #{event_name}(event); #{value}; end"
     end
-    
+
     def inherit_styles
       style_names = []
       style_names << @name unless @name.nil?
       style_names += @additional_styles.gsub(',', ' ').split(' ') unless @additional_styles.nil?
-      style_names.each do |style_name|
-        new_style = @scene.styles[style_name]
+      style_names.each do |style_name|    
+        new_style = scene.styles[style_name]
         @style.add_extension(new_style) if new_style
         new_hover_style = scene.styles["#{style_name}.hover"]
         if new_hover_style
@@ -321,13 +335,13 @@ module Limelight
       end
     end
 
-# Why is this method here?  No one appears to use it.
-#    def disinherit_styles
-#      return if @name.nil?
-#      old_style = @scene.styles[@name]
-#      @style.remove_extension(old_style) if old_style
-#      @hover_style = nil
-#    end
-    
+    # Why is this method here?  No one appears to use it.
+    #    def disinherit_styles
+    #      return if @name.nil?
+    #      old_style = scene.styles[@name]
+    #      @style.remove_extension(old_style) if old_style
+    #      @hover_style = nil
+    #    end
+
   end
 end

data/lib/limelight/scene.rb

@@ -4,6 +4,8 @@
 require 'limelight/java_util'
 require 'limelight/prop'
 require 'limelight/button_group_cache'
+require 'limelight/limelight_exception'
+require 'limelight/file_loader'
 
 module Limelight
 
@@ -11,31 +13,58 @@ module Limelight
   # few extra attributes and behaviors.
   #
   class Scene < Prop
-    
+
     include UI::Api::Scene
-  
-    attr_reader :button_groups, :styles, :casting_director
-    attr_accessor :stage, :loader, :visible, :path, :production
+
+    attr_reader :button_groups, :casting_director, :cast
+    attr_accessor :stage, :visible, :production, :styles
     getters :stage, :loader, :styles
     setters :stage
     event :scene_opened
-    
+
     def initialize(options={})
+      path = options.delete(:path) || ""
+      @root = FileLoader.for_root(path)
       super(options)
-      @scene = self
       @button_groups = ButtonGroupCache.new
-      illuminate
+      @prop_index = {}
+      @cast = Module.new
+#      illuminate
+    end
+
+    # Returns self.  A Scene is it's own scene.
+    #
+    def scene 
+      return self
+    end
+
+    # Returns the path to the root directory of the Scene
+    #
+    def path
+      return @root.root
+    end
+
+    # Returns the path to the Scene's props file
+    #
+    def props_file
+      return @root.path_to("props.rb")
     end
-  
-    def add_options(options) #:nodoc:
-      @options = options
-      illuminate
+
+    # Returns the path to the Scene's props file
+    #
+    def styles_file
+      return @root.path_to("styles.rb")
     end
 
+    #    def add_options(options) #:nodoc:
+    #      @options = options
+    #      illuminate
+    #    end
+
     # Creates the menu bar for the Scene 
     #
     def menu_bar
-      return MenuBar.build(self) do
+      return DSL::MenuBar.build(self) do
         menu("File") do
           item("Open", :open_chosen_production)
           item("Refresh", :reload)
@@ -61,23 +90,49 @@ module Limelight
       producer.open
     end
 
-    # Opens the specified Scene on the Stage currently occupied by this Scene.s
+    # Opens the specified Scene on the Stage currently occupied by this Scene.
+    # TODO It doesn't quite make sense that a scene loads other scene.  It has to replace itself?
     #
     def load(scene_name)
       @production.producer.open_scene(scene_name, @stage)
     end
-    
-    private ###############################################
-    
-    def illuminate
+
+    # Add the Prop to the index.  Provides fast lookup by id.
+    #
+    def index_prop(prop)
+      return if prop.id.nil? || prop.id.empty?
+      indexee = @prop_index[prop.id]
+      if indexee.nil?
+        @prop_index[prop.id] = prop
+      else
+        raise LimelightException.new("Duplicate id: #{prop.id}") if indexee != prop
+      end
+    end
+
+    # Removed the Prop from the index.
+    #
+    def unindex_prop(prop)
+      @prop_index.delete(prop.id) if prop.id
+    end
+
+    # Returns a Prop with the specified id.  Returns nil id the Prop doesn't exist in the Scene. 
+    #
+    def find(id)
+      return @prop_index[id.to_s]
+    end
+
+    def illuminate #:nodoc:
       @styles = @options.has_key?(:styles) ? @options.delete(:styles) : (@styles || {})
       @casting_director = @options.delete(:casting_director) if @options.has_key?(:casting_director)
+      @path = @options.delete(:path) if @options.has_key?(:path)
       super
     end
-    
+
+    private ###############################################
+
     def reload
-      load(@path)
+      load(File.basename(path))
     end
-  
+
   end
 end