limelight 0.3.1-java → 0.4.0-java

data/lib/limelight/file_filter.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight

data/lib/limelight/file_loader.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight

data/lib/limelight/gems.rb

@@ -1,3 +1,6 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
 module Limelight
   module Gems
 
@@ -17,6 +20,7 @@ module Limelight
         end
       end
 
+      #TODO - MDM - This doesn't work when loading gems like: gem 'gem_name'.  Need make use of Gem::SourceIndex. See SourceIndex.load_gems_in
       def install_gems_in_production(production)
         self.current_production = production
 

data/lib/limelight/java_couplings.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
     
 module Limelight #:nodoc:
@@ -20,6 +20,7 @@ module Limelight #:nodoc:
 
   module Util #:nodoc:
     Colors = Java::limelight.util.Colors
+    Version = Java::limelight.util.Version
   end
 
   module UI #:nodoc:
@@ -27,7 +28,7 @@ module Limelight #:nodoc:
     ButtonGroupCache = Java::limelight.ui.ButtonGroupCache
 
     module Model #:nodoc:
-      Frame = Java::limelight.ui.model.Frame
+      Frame = Java::limelight.ui.model.StageFrame
       Panel = Java::limelight.ui.model.PropPanel
       ImagePanel = Java::limelight.ui.model.ImagePanel
 

data/lib/limelight/java_util.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/string'

data/lib/limelight/limelight_exception.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight

data/lib/limelight/main.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/commands/command'

data/lib/limelight/paint_action.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/pen'

data/lib/limelight/pen.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight

data/lib/limelight/producer.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/file_loader'
@@ -13,6 +13,7 @@ require 'limelight/theater'
 require 'limelight/production'
 require 'limelight/gems'
 require 'limelight/util/downloader'
+require 'limelight/version'
 
 module Limelight
 
@@ -25,12 +26,17 @@ module Limelight
 
     # Creates a new Producer and has it open a Production by specified name.
     #
-    def self.open(production_name)
+    def self.open(production_name, options={})
       producer = new(production_name)
-      producer.open
+      begin
+        producer.open(options)
+      rescue Exception => e
+        puts e
+        puts e.backtrace
+      end
     end
 
-    attr_reader :loader, :theater, :production
+    attr_reader :theater, :production
     attr_writer :builtin_styles
 
     # A Production name, or root directory, must be provided. If not Theater is provided, one will be created.
@@ -45,49 +51,60 @@ module Limelight
         root_path = unpack_production(root_path)
       end
       @production = production || Production.new(root_path)
-      @loader = @production.root
       @theater = theater.nil? ? Theater.new : theater
+      establish_production
+    end
+
+    # Returns true if the production's minimum_limelight_version is compatible with the current version.
+    #
+    def version_compatible?
+      current_version = Limelight::Util::Version.new(Limelight::VERSION::STRING)
+      required_version = Limelight::Util::Version.new(@production.minimum_limelight_version)
+      return required_version.is_less_than_or_equal(current_version)
     end
 
     # Returns the CastingDirector for this Production.
     #
     def casting_director
-      @casting_director = CastingDirector.new(loader) if not @casting_director
+      @casting_director = CastingDirector.new(@production.root) if not @casting_director
       return @casting_director
     end
 
     # Loads the Production without opening it.  The Production will be created into memory with all it's stages
     #
     def load(options = {})
-      establish_production
-      Gems.install_gems_in_production(@production)  
+      Gems.install_gems_in_production(@production)
       Kernel.load(@production.init_file) if ( !options[:ignore_init] &&  File.exists?(@production.init_file) )
       load_stages if File.exists?(@production.stages_file)
     end
 
     # Opens the Production.
     #
-    def open()
+    def open(options = {})
+      return unless version_compatible? || Studio.utilities_production.proceed_with_incompatible_version?(@production.name, @production.minimum_limelight_version)
+      @production.production_opening
       load
+      @production.production_loaded
       if @theater.has_stages?
-        @theater.stages.each { |stage| open_scene(stage.default_scene, stage) if stage.default_scene }
-      else
-        open_scene(:root, @theater.default_stage)
+        @theater.stages.each do |stage|          
+          open_scene(stage.default_scene.to_s, stage) if stage.default_scene
+        end
+      elsif @production.default_scene
+        open_scene(@production.default_scene, @theater.default_stage)
       end
       @casting_director = nil
+      @production.production_opened
     end
 
     # Opens the specified Scene onto the Spcified Stage.
     #
-    def open_scene(name, stage)
+    def open_scene(name, stage, options={})
       path = @production.scene_directory(name)
       scene_name = File.basename(path)
-      scene = load_props(:production => @production, :casting_director => casting_director, :path => path, :name => scene_name)
-
+      scene = load_props(options.merge(:production => @production, :casting_director => casting_director, :path => path, :name => scene_name))
       styles = load_styles(scene)
       merge_with_root_styles(styles)
       scene.styles = styles
-
       stage.open(scene)
       return scene
     end
@@ -114,7 +131,7 @@ module Limelight
       if File.exists?(scene.props_file)
         content = IO.read(scene.props_file)
         options[:build_loader] = @production.root
-        return Limelight.build_scene(scene, options) do
+        return Limelight.build_props(scene, options) do
           begin
             eval content
           rescue Exception => e
@@ -141,25 +158,6 @@ module Limelight
       end
     end
 
-    # Loads the 'production.rb' file if it exists and configures the Production.
-    #
-    def establish_production
-      @production.producer = self
-      @production.theater = @theater
-
-      if @production.root.exists?("production.rb")
-        content = @production.root.load("production.rb")
-        @production = Limelight.build_production(@production) do
-          begin
-            eval content
-          rescue Exception => e
-            raise DSL::BuildException.new("production.rb", content, e)
-          end
-        end
-      end
-
-    end
-
     # A production with multiple Scenes may have a 'styles.rb' file in the root directory.  This is called the
     # root_style.  This method loads the root_styles, if they haven't already been loaded, and returns them.
     #
@@ -189,6 +187,21 @@ module Limelight
       return @builtin_styles.dup
     end
 
+    def establish_production #:nodoc:
+      @production.producer = self
+      @production.theater = @theater
+
+      production_file = @production.production_file
+      if File.exists?(production_file)
+        tmp_module = Module.new
+        content = IO.read(production_file)
+        tmp_module.module_eval(content, production_file)
+        production_module = tmp_module.const_get("Production")
+        raise "production.rb should define a module named 'Production'" if production_module.nil?
+        @production.extend(production_module)
+      end
+    end
+
     private ###############################################
 
     def merge_with_root_styles(styles)
@@ -199,7 +212,9 @@ module Limelight
 
     def unpack_production(production_name)
       packer = Limelight::Util::Packer.new()
-      return packer.unpack(production_name)
+      dest_dir = File.join(Data.productions_dir, rand.to_s.sub("0.", ""))
+      Dir.mkdir(dest_dir)
+      return packer.unpack(production_name, dest_dir)
     end
 
   end

data/lib/limelight/production.rb

@@ -1,8 +1,10 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/limelight_exception'
 require 'limelight/file_loader'
+require 'limelight/studio'
+require 'drb'
 
 module Limelight
 
@@ -12,60 +14,29 @@ module Limelight
   # Productions are configured, and attributes are added, by the ProductionBuilder.
   #
   class Production
-    
+
     class << self
-      
-      def index(production) #:nodoc:
-        @index = [] if @index.nil?
-        if production.name.nil?
-          assign_name_to(production) 
-        else
-          error_if_duplicate_name(production.name)
-        end
-        @index << production
-      end
-      
+
       def [](name) #:nodoc:
-        return nil if @index.nil?
-        return @index.find { |production| production.name == name }
-      end
-      
-      def assign_name_to(production) #:nodoc:
-        count = @index.length + 1
-        while name_taken?(count.to_s)
-          count += 1
-        end
-        production.name = count.to_s
-      end
-      
-      def name_taken?(name) #:nodoc:
-        return self[name] != nil
+        return Studio[name]
       end
 
-      def clear_index #:nodoc:
-        @index = []
-      end
-      
-      def error_if_duplicate_name(name) #:nodoc:
-        raise Limelight::LimelightException.new("Production name '#{name}' is already taken") if name_taken?(name)
-      end
-      
     end
-    
-    attr_reader :name, :root 
+
+    attr_reader :name, :root
     attr_accessor :producer, :theater
 
     # Users typically need not create Production objects.
     #
-    def initialize(path)    
+    def initialize(path)
       @root = FileLoader.for_root(path)
-      self.class.index(self)
+      @name = File.basename(path)
     end
 
     # Sets the name of the Production.  The name must be unique amongst all Productions in memory.
     #
     def name=(value)
-      self.class.error_if_duplicate_name(value)
+      Studio.error_if_duplicate_name(value)
       @name = value
     end
 
@@ -81,6 +52,12 @@ module Limelight
       return @root.path_to("init.rb")
     end
 
+    # Returns the path to the production's production.rb file
+    #
+    def production_file
+      return @root.path_to("production.rb")
+    end
+
     # Returns the path to the production's stages file
     #
     def stages_file
@@ -103,9 +80,70 @@ module Limelight
     #
     def scene_directory(name)
       return @root.root if name == :root
-      return @root.path_to(name)
+        return @root.path_to(name)
+    end
+
+    # Returns the minimum version of limelight required to run this production.  Default: "0.0.0"
+    # If the version of limelight used to open this production is less than the minimum,
+    # an error will be displayed (starting with version 0.4.0).
+    #
+    def minimum_limelight_version
+      return "0.0.0"
+    end
+
+    # Returns true if the production allows itself to be closed.  The system will call this methods when
+    # it wishes to close the production, perhaps when the user quits the application.  By default the production
+    # will always return true.
+    #
+    def allow_close?
+      return true
+    end
+
+    # Called when the production is about to be opened.  The default implementation does nothing but you may re-implement
+    # it in the production.rb file.
+    #
+    def production_opening
     end
-    
+
+    # Called when the production has been loaded.  That is, when all the gems have been loaded stages have been
+    # instantiated.
+    #
+    def production_loaded
+    end
+
+    # Called when the production is fully opened.  The default implementation does nothing but you may re-implement
+    # it in the production.rb file.
+    #
+    def production_opened
+    end
+
+    # Called when the production is about to be closed.  The default implementation does nothing but you may re-implement
+    # it in the production.rb file.
+    #
+    def production_closing
+    end
+
+    # Called when the production is fully closed.  The default implementation does nothing but you may re-implement
+    # it in the production.rb file.
+    #
+    def production_closed
+    end
+
+    # Closes the production. If there are no more productions open, the Limelight runtime will shutdown.
+    #
+    def close
+      self.production_closing
+      Studio.production_closed(self)
+      self.production_closed
+    end
+
+    # Returned the name of the default scene.  This is only used when there are not stages defined in the production.
+    # Defaults to :root, the production's root directory is the default scene.  Return nil if there are not defaults.
+    #
+    def default_scene
+      return :root
+    end
+
   end
-  
+
 end

data/lib/limelight/prop.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/java_util'
@@ -30,6 +30,8 @@ module Limelight
       end
 
       def event2(event_symbol)
+        @events ||= []
+        @events << event_symbol unless @events.include?(event_symbol)
         define_method("accepts_#{event_symbol}".to_sym) { return self.respond_to?(event_symbol) }
       end
 
@@ -37,8 +39,9 @@ module Limelight
 
     include UI::Api::Prop
 
+    attr_accessor :style, :hover_style
     attr_reader :panel #:nodoc:
-    attr_reader :style, :hover_style, :children, :parent, :name, :id, :players
+    attr_reader :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.
@@ -108,7 +111,10 @@ module Limelight
     # Injects the behavior of the specified Player into the Prop.  The Player must be a Module.
     #
     def include_player(player_module)
-      extend player_module unless self.is_a?(player_module)
+      unless self.is_a?(player_module)
+        extend player_module
+        self.casted if player_module.instance_methods.include?("casted")
+      end 
     end
 
     def update #:nodoc:
@@ -145,7 +151,7 @@ module Limelight
     # Sets the text of this Prop.  If a prop is given text, it will become sterilized (it may not have any more children).
     # Some Players such as text_box, will cause the text to appear in the text_box.
     #
-    def text=(value)
+    def text=(value)    
       @panel.text = value.to_s
     end
 
@@ -219,13 +225,6 @@ module Limelight
       return Pen.new(panel.getGraphics)
     end
 
-    # Plays a sound on the computers audio output.  The parameter is the filename of a .au sound file.
-    # 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))
-    end
-
     # Initiate an animation loop.  Options may include :name (string), :updates_per_second (int: defaults to 60)
     # An Animation object is returned.
     # The provided block will be invoked :updates_per_second times per second until the Animation is stopped.
@@ -243,8 +242,28 @@ module Limelight
       return animation
     end
 
+    # Plays a sound on the computers audio output.  The parameter is the filename of a .au sound file.
+    # 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))
+    end
+
+    # Luanches the spcified URL using the OS's default handlers. For example, opening a URL in a browser:
+    #
+    #   launch('http://www.google.com')
+    #
+    # To create a link prop add an accessor on the player (say url) and use that in the prop definition
+    # Ex:
+    #
+    #   link :text => "I am a link", :url => "http://www.8thlight.com"
+    def launch(url)
+      Context.instance.os.launch(url)
+    end
+
     # GUI Events ##########################################
 
+    # TODO MDM - This may be very inefficient.  If seems like these methods are generated for each instance of prop.
     event2 :mouse_clicked
     event :mouse_entered
     event :mouse_exited
@@ -285,7 +304,7 @@ module Limelight
 
     def illuminated? #:nodoc:
       return @illuminated
-    end
+    end  
 
     private ###############################################
 
@@ -310,7 +329,7 @@ module Limelight
 
     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)
+      return string_value[0..2] == "on_" && self.class.events.include?(string_value[3..-1].to_sym)
     end
 
     def define_event(symbol, value)

data/lib/limelight/scene.rb

@@ -1,4 +1,4 @@
-#- Copyright 2008 8th Light, Inc. All Rights Reserved.
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 require 'limelight/java_util'
@@ -7,13 +7,13 @@ require 'limelight/button_group_cache'
 require 'limelight/limelight_exception'
 require 'limelight/file_loader'
 
+
 module Limelight
 
   # A Scene is a root Prop.  Scenes may be loaded onto a Stage.  In addition to being a Prop object, Scenes have a
   # few extra attributes and behaviors.
   #
-  class Scene < Prop
-
+  class Scene < Prop    
     include UI::Api::Scene
 
     attr_reader :button_groups, :casting_director, :cast
@@ -22,6 +22,8 @@ module Limelight
     setters :stage
     event :scene_opened
 
+    alias :visible? :visible
+
     def initialize(options={})
       path = options.delete(:path) || ""
       @root = FileLoader.for_root(path)
@@ -86,8 +88,7 @@ module Limelight
     # Creates a new Producer to open the specified Production.
     #
     def open_production(production_path)
-      producer = Producer.new(production_path, @production.theater)
-      producer.open
+      Thread.new { Studio.open(production_path) }
     end
 
     # Opens the specified Scene on the Stage currently occupied by this Scene.
@@ -112,13 +113,7 @@ module Limelight
     # Removed the Prop from the index.
     #
     def unindex_prop(prop)      
-      prop.children.each do |child|
-        if child.children.empty? 
-          @prop_index.delete(child.id)
-        else
-          unindex_prop(child)
-        end
-      end
+      unindex_child_props(prop)
       @prop_index.delete(prop.id) if prop.id
     end
 
@@ -127,7 +122,7 @@ module Limelight
     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)
@@ -136,7 +131,17 @@ module Limelight
     end
 
     private ###############################################
-
+    
+    def unindex_child_props(prop)
+      prop.children.each do |child|
+        if child.children.empty? 
+          @prop_index.delete(child.id)
+        else
+          unindex_prop(child)
+        end
+      end
+    end
+    
     def reload
       load(File.basename(path))
     end