limelight 0.5.1-java → 0.5.2-java

data/lib/limelight/builtin/utilities_production/alert/players/alert.rb

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

data/lib/limelight/builtin/utilities_production/production.rb

@@ -3,7 +3,7 @@
 
 require 'monitor'
 
-module Production
+module Production #:nodoc:
 
   def production_opening
     @monitor = Monitor.new
@@ -44,7 +44,7 @@ module Production
 
   def alert(message)
     @alert_monitor = @monitor.new_cond
-    load_alert_scene(message)
+    load_alert_scene(message.to_s)
     @monitor.synchronize{ @alert_monitor.wait }
     @alert_stage.close
     return @alert_response

data/lib/limelight/dsl/styles_builder.rb

@@ -143,6 +143,11 @@ module Limelight
         raise StyleBuilderException.new("'#{sym}' is not a valid style") if !@__style.respond_to?(setter_sym)
         @__style.send(setter_sym, value.to_s)
       end
+
+      # Kernel.y was added by the yaml library in JRuby 1.4.  Not sure what to do about this type of problem.
+      def y(*args) #:nodoc:
+        method_missing(:y, *args)
+      end
     end
 
     # Exception thrown by StyleBuilder when an error is encountered.

data/lib/limelight/java_couplings.rb

@@ -1,12 +1,12 @@
 #- 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:
+module Limelight
 
   Main = Java::limelight.Main
   ResourceLoader = Java::limelight.ResourceLoader
   Context = Java::limelight.Context
-  Studio = Java::limelight.ui.api.Studio
+  Studio = Java::limelight.Studio
 
   module Background
     Animation = Java::limelight.background.Animation

data/lib/limelight/main.rb

@@ -5,31 +5,59 @@ require 'limelight/commands/command'
 
 module Limelight
 
-  # Used to open and manage Limelight Productions.
+  # Limelight::Main is used, when installed as a gem, to work with Limelight production.  It provides
+  # a handful of utilities to create, bundle, and develop with Limelight.
   #
-  # Productions may have a single scene or multiple scenes.
+  # For example, running the following command will generate a new Limelight production for you.
   #
-  # Single-Scene Production Directory Structure:
+  #   jruby -S limelight create production <production name>
   #
-  #   - calculator
-  #   | - props.rb
-  #   | - styles.rb
-  #   | - players
-  #     | - <player_name>.rb
-  #     | - *
+  # Assuming you used "sandbox" as the name or your production, you'd end up with the following directory structure
+  # generated for you.
+  #
+  #   - sandbox
   #   | - stages.rb
+  #   | - styles.rb
   #   | - production.rb
+  #   | - default_scene
+  #     | - props.rb
+  #     | - styles.rb
+  #     | - players
+  #       | - <player_name>.rb
+  #   | - spec
+  #     | - spec_helper.rb
+  #     | - default_scene
+  #       | - default_scene_spec.rb
   #
-  # In a Single-Scene production, the scene name and production name are the same.  As seen above, both names are 'calculator'.
-  # Inside the scene there are three files and one directory, all of which are options.
+  # In this case, you've just created a production called "Sandbox".  By convention, the name of the production matches the name of the root directory.
+  # Notice that there are 3 files and 2 directories.  Let's start by talking about the files.
+  #
+  # == stages.rb
+  # This file uses a DSL to configure the stages that will be used in the production.
+  # See Limelight::StagesBuilder
+  #
+  # == styles.rb
+  # This file defines production level styles. Each scene may have their own styles but styles defined here will be avaiable to all scenes.
+  # See Limelight::StylesBuilder
+  #
+  # == production.rb
+  # This file defines a module names Production where you can defined hooks and behavior for your production.
+  # See Limelight::Production
+  #
+  # For the most part, each directory inside the root directory is a scene.  This production has one scene named "default_scene" (this is the default name).
+  # Each scene starts out containing 2 file and a directory.  Let's look at those..
   #
   # == props.rb
-  # This file defines the props contained in the scene
+  # This file defines the structure of your scene.  Scenes are composed of Props.  In this file you use the Prop DSL to
+  # specify all the components of your scene.
   # See Limelight::PropBuilder
+  # See Limelight::Prop
   #
   # == styles.rb
-  # This file defines the styles used in the scene
+  # Similar to the styles.rb file located in the root directory, this file contains definitions of styles.  However,
+  # all styles defined here are only available to the containgin scene.  Styles define the look and feel of your scenes.
   # See Limelight::StylesBuilder
+  # See Limelight::Style
   #
   # == players
   # A directory containing all the players used in the scene.  Players are modules that are included by Prop objects.
@@ -37,40 +65,9 @@ module Limelight
   # Inside 'wall.rb' you would define a module named 'Wall'.  All behavior defined in the Wall modules will automatically be included
   # in every prop named 'wall'.
   #
-  # == stages.rb
-  # This file uses a DSL to configure the stages that will be used in the production.
-  # See Limelight::StagesBuilder
-  #
-  # == production.rb
-  # This file uses a DSL to configure the current Production.
-  # See Limelight::ProductionBuilder
-  #
-  # Multiple-Scene Production Directory Structure:
-  #
-  #   - sandbox
-  #   | - stages.rb
-  #   | - production.rb
-  #   | - styles.rb
-  #   | - players
-  #     | - <player_name>.rb
-  #   | - fader
-  #     | - props.rb
-  #     | - styles.rb
-  #     | - players
-  #       | - <player_name>.rb
-  #   | - floater
-  #     | - props.rb
-  #     | - styles.rb
-  #     | - players
-  #       | - <player_name>.rb
-  #
-  # In a Multiple-Scene production, the production acquires that name of the root directory.  In this case the production is named 'sandbox'.
-  # Each directory inside the root directory is a scene.  This production has two scenes named 'fader' and 'floater'.  Each scene is structured
-  # the same as in a Single-Scene production with the exception of the 'stages.rb' file.  This file is specific to the production.  The production
-  # may contain a 'styles.rb' which contains styles used by multiple scenes.  If some players are used in multiple Scenes, then it is useful to
-  # to create a players directory in the Production root to hold the common players. Other files may exist in the directory structure and they will not
-  # conflict with Limelight.
+  # So there's a brief overview for you.  Besure to check out the Limelight Docs production.  You can find it by installing Limelight and starting it up.
   #
+  # For more info on available commands: 
   # See Limelight::Commands
   #
   class Main

data/lib/limelight/producer.rb

@@ -170,6 +170,27 @@ module Limelight
       return extendable_styles.merge(new_styles)
     end
 
+    # Closes the specified production.  The producer will trigger the hook, production_closing and production_closed,
+    # to keep the production aware of it's status.  The Studio will also be informed of the closure.  If no
+    # production remain opened, then the Limelight runtine will exit.
+    #
+    def close(production)
+      return if production.closed?
+      production.closed = true
+      return Thread.new do
+        begin
+          Thread.pass
+          production.production_closing
+          production.theater.close
+          production.production_closed
+          Context.instance.studio.production_closed(production)
+        rescue StandardError => e
+          puts e
+          puts e.backtrace
+        end
+      end
+    end
+
     def establish_production #:nodoc:
       @production.producer = self
       @production.theater = @theater

data/lib/limelight/production.rb

@@ -3,8 +3,10 @@
 
 require 'limelight/limelight_exception'
 require 'limelight/file_loader'
+require 'limelight/dsl/styles_builder'
 require 'drb'
 
+
 module Limelight
 
   # The root object of Limelight Production.  Every Prop in a production has access to its Production object.
@@ -26,6 +28,7 @@ module Limelight
 
     attr_reader :name, :root
     attr_accessor :producer, :theater
+    attr_accessor :closed #:nodoc:
 
 
     # Users typically need not create Production objects.
@@ -77,7 +80,7 @@ module Limelight
     def gems_directory
       return @root.path_to("__resources/gems/gems")
     end
-    
+
     # Returns the path to the productions gems root
     #
     def gems_root
@@ -88,7 +91,7 @@ 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"
@@ -137,22 +140,24 @@ module Limelight
     def production_closed
     end
 
+    # returns true if the production has been closed.
+    #
+    def closed?
+      return @closed
+    end
+
     # Closes the production. If there are no more productions open, the Limelight runtime will shutdown.
+    # The production will actually delegate to it's producer and the producer will close the production down.
     #
     def close
-      return if @closed
-      self.production_closing
-      @theater.close
-      @closed = true
-      self.production_closed
-      Context.instance.studio.production_closed(self)
+      @producer.close(self)
     end
 
     # Called when the last stage in this production's theater is closed.  If the allow_close? returns true
     # this production will be closed.
     #
-    def theater_empty!    
-      close if allow_close?
+    def theater_empty!
+      close if allow_close? && !closed?
     end
 
     # Returned the name of the default scene.  This is only used when there are not stages defined in the production.
@@ -180,7 +185,9 @@ module Limelight
     alias :setName :name= #:nodoc:
     alias :allowClose :allow_close? #:nodoc: 
 
-    def callMethod(name, args) #:nodoc:   
+    def callMethod(name, java_obj_array) #:nodoc:
+      args = []
+      java_obj_array.length.times { |i| args << java_obj_array[i] }
       send(name.to_sym, *args)
     end
 

data/lib/limelight/specs/test_scene_opener.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 Specs
     module SpecHelper

data/lib/limelight/stage.rb

@@ -199,15 +199,6 @@ module Limelight
     #
     def close
       @frame.close
-      closed
-    end
-
-    # Invoked when the stage has been closed.  Users need not call it. 
-    #
-    def closed
-      @current_scene.visible = false if @current_scene
-      @current_scene = nil
-      @theater.stage_closed(self)
     end
 
     # Loads a scene on the Stage.  If the Stage is currently hosting a Scene, the original Scene will be removed and
@@ -261,6 +252,68 @@ module Limelight
       @current_scene = scene
     end
 
+    # returns true if the stage has been closed.  Closed stages may not be reopened.
+    #
+    def closed?
+      return @frame.closed?
+    end
+
+    # Invoked when the stage is being closed.
+    # System hook that should NOT be called by you.
+    #
+    def closing(e)
+    end
+
+    # Invoked when the stage has been closed.
+    # System hook that should NOT be called by you.
+    #
+    def closed(e)
+      @current_scene.visible = false if @current_scene
+      @current_scene = nil
+      @theater.stage_closed(self)
+    end
+
+    # Invoked when the stage has gained focus on the desktop.  Only 1 stage my have focus at a time.
+    # System hook that should NOT be called by you.
+    #
+    def focus_gained(e)
+      @theater.stage_activated(self)
+    end
+
+    # Invoked when the stage has lost focus on the desktop.  Only 1 stage my have focus at a time.
+    # System hook that should NOT be called by you.
+    #
+    def focus_lost(e)
+    end
+
+    # Invoked when the stage has been iconified.  This occurs when the stage is no longer visible on the desktop
+    # and an icon for the stage has been added to the OS's taskbar or dock.
+    # System hook that should NOT be called by you.
+    #
+    def iconified(e)
+    end
+
+    # Invoked when the stage has been deiconified.  This occurs when the icon for the stage has been removed from the
+    # taskbar or dock, and the stage is again visible on the desktop.  
+    # System hook that should NOT be called by you.
+    #
+    def deiconified(e)
+    end
+
+    # Invoked when the stage has become the active stage on the desktop.  Only 1 stage my be active at a time.
+    # System hook that should NOT be called by you.
+    #
+    def activated(e)
+      @theater.stage_activated(self)
+    end
+
+    # Invoked when the stage has lost status as the active stage.  Only 1 stage my have focus at a time.
+    # System hook that should NOT be called by you.
+    #
+    def deactivated(e)
+      @theater.stage_deactivated(self)  
+    end
+
     protected #############################################
 
     def new_frame

data/lib/limelight/studio.rb

@@ -1,185 +1,54 @@
 #- 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/producer'
+raise "studio.rb is present for solely to document it's Java counterpart limelight.Studio.  This file should NOT be loaded in the Ruby runtime."
 
 module Limelight
 
   # A Studio creates Productions.  There is only one instance of Studio per Limelight runtime.  All open productions
-  # are opened by the studio.
+  # are opened and tracked by the studio.
   #
   class Studio
 
-    class << self
-
-      def install #:nodoc:
-        Context.instance.studio = instance
-        return instance
-      end
-
-      def instance #:nodoc:
-        @studio = self.new if @studio.nil?
-        return @studio
-      end
-
-      def reset #:nodoc:
-        @studio = nil
-      end
-
-    end
-
-    def index(production) #:nodoc:
-      @index = [] if @index.nil?
-      if name_taken?(production.name)
-        assign_unique_name(production)
-      elsif production.name.nil?
-        assign_name_to(production)
-      else
-        error_if_duplicate_name(production.name)
-      end
-      @index << production
-    end
-
-    # Returns the production with the specified name that was previously opened but the Studio.
-    #
-    def [](name)
-      return nil if @index.nil?
-      return @index.find { |production| production.name == name }
-    end
-
-    def name_taken?(name) #:nodoc:
-      return self[name] != nil
-    end
-
-    def error_if_duplicate_name(name) #:nodoc:
-      raise Limelight::LimelightException.new("Production name '#{name}' is already taken") if name_taken?(name)
-    end
-
     # Opens the production at the specified path.
     #
     def open(production_path)
-      begin
-        src = <<END
-#begin
-  puts "$:: \#{$:.join(", ")}"
-  puts "__FILE__: \#{__FILE__}"
-  require 'limelight/limelight_init'
-  require 'limelight/producer'
-  producer = Limelight::Producer.new("#{production_path}")
-  production = producer.production
-  Java::java.lang.Thread.currentThread.handle = production
-  producer.open
-#rescue Exception => e
-#  raise e
-#end
-END
-        production = Context.instance().runtimeFactory.spawn(src)
-        index(production)
-        return production
-      rescue StandardError => e
-        alert_and_shutdown(e)
-      end
     end
 
-#      def open(production_path)
-#        begin
-#          producer = Producer.new(production_path)
-#          production = producer.production
-#          index(production)
-#          producer.open
-#          return production
-#        rescue StandardError => e
-#          alert_and_shutdown(e)
-#        end
-#      end
+    # Returns the production with the specified name. If the studio never opened a production by that name, nil
+    # will be returned.
+    #
+    def get(name)
+    end
 
     # Returns true if all of the open productions allow closing.
     #
     def should_allow_shutdown
-      return true if @index.nil?
-      return @index.all? { |production| production.allow_close? }
     end
 
     # If allowed (should_allow_shutdown), this will close all open productions and shutdown the limelight runtime.
     #
     def shutdown
-      return if @is_shutdown || @is_shutting_down
-      return unless should_allow_shutdown
-      @is_shutting_down = true
-      @index.each { |production| production.close } if @index
-      @utilities_production.close if @utilities_production
-      @is_shutdown = true
-      Thread.new { Context.instance().shutdown }
     end
 
-    # Called when a production is closed to notify the studio of the event.
+    # Called when a production is closed to notify the studio of the event. Developers should not need to call this method.
     #
     def production_closed(production)
-      puts "Studio.production_closed @index: #{@index}"
-      if @index
-        @index.delete(production)
-        puts "closing production: #{production}"
-production.audit        
-        Context.instance().runtimeFactory.terminate(production)
-puts "index.inspect: #{@index.inspect}"        
-      end
-      shutdown if @index && @index.empty?
     end
 
-    # Returns an array of all the productions
+    # Returns a list of all the productions
     #
     def productions
-      return @index.nil? ? [] : @index.dup
-    end
-
-    # Publish the Studio, using DRb, on the specified port.
-    #
-    def publish_on_drb(port)
-      @drb_server = DRb.start_service("druby://0.0.0.0:#{port}", self)
     end
 
     # Returns the utilities production; a production used by limelight.
     #
     def utilities_production
-      if @utilities_production == nil
-        producer = Producer.new(File.join($LIMELIGHT_LIB, "limelight", "builtin", "utilities_production"))
-        @utilities_production = producer.production
-        producer.open
-      end
-      return @utilities_production
     end
 
-    private #############################################
-
-    def assign_unique_name(production) #:nodoc:
-      count = 2
-      name = production.name
-      while name_taken?(name)
-        name = "#{production.name}_#{count}"
-        count += 1
-      end
-      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 alert_and_shutdown(e)
-      begin
-        message = "#{e}\n#{e.backtrace.join("\n")}"
-        utilities_production.alert(message)
-        shutdown if @index.nil? || @index.empty?
-      rescue Exception => e
-        puts e
-        puts e.backtrace
-      end
+    # Returns true if the Studio has been shutdown.  ie. The procees is exiting.
+    #
+    def shutdown?
     end
-
   end
 
 end