RUIC 0.5.0 → 0.6.0

data/lib/ruic/renderplugin.rb

@@ -0,0 +1,18 @@
+class UIC::RenderPlugin
+	include UIC::FileBacked
+	def initialize( file )
+		self.file = file
+	end
+end
+
+class UIC::Application::RenderPlugin < UIC::RenderPlugin
+	include UIC::ElementBacked
+	# @!parse extend UIC::ElementBacked::ClassMethods
+	xmlattribute :id
+	xmlattribute :src
+	def initialize(application,el)
+		self.owner = application
+		self.el    = el
+		super( application.absolute_path(src) )
+	end
+end

data/lib/ruic/ripl.rb

@@ -0,0 +1,45 @@
+module Ripl; end
+
+# Allows [Ripl](https://github.com/cldwalker/ripl) to execute code or print a message after every result.
+#
+# @example 1) Printing a blank line after each result
+#  require_relative 'ripl-after-result'
+#  Ripl::Shell.include Ripl::AfterResult
+#  Ripl.config.merge! after_result:"\n"
+#
+# @example 2) Executing arbitrary code with the result
+#  results = []
+#  require_relative 'ripl-after-result'
+#  Ripl::Shell.include Ripl::AfterResult
+#  Ripl.config.merge! after_result:proc{ |result| results << result }
+module Ripl::AfterResult
+	# @private no need to document the method
+	def print_result(result)
+		super unless result.nil? && config[:skip_nil_results]
+		if after=config[:after_result]
+			if after.respond_to?(:call)
+				after.call(result)
+			else
+				puts after
+			end
+		end
+	end
+end
+
+# Allows [Ripl](https://github.com/cldwalker/ripl) to wrap lines of output
+# and/or prefix each line of the result with the `result_prompt`.
+module Ripl::FormatResult
+	# @private no need to document the method
+	def format_result(result,conf={})
+		conf=config if respond_to? :config
+		result = conf[:to_s] ? result.to_s : result.inspect
+		result = result.dup if result.frozen?
+		if limit=conf[:result_line_limit]
+			match = /^.{#{limit}}.+/o
+			:go while result.sub!(match){ |line| line.sub /^(?:(.{,#{limit}})[ \t]+|(.{#{limit}}))/o, "\\1\\2\n" }
+		end
+
+		result.gsub( conf[:prefix_result_lines] ? /^/ : /\A/, conf[:result_prompt] )
+	end
+	module_function :format_result
+end

data/lib/ruic/statemachine.rb

@@ -1,15 +1,10 @@
 class UIC::StateMachine
-	include UIC::FileBacked
-	def initialize( xml )
-		@doc = Nokogiri.XML( xml )
+	include UIC::XMLFileBacked
+	def initialize( scxml )
+		self.file = scxml
 	end
-
-	def errors?
-		!errors.empty?
-	end
-
-	def errors
-		file_found? ? [] : ["File not found: '#{file}'"]
+	def inspect
+		"<#{self.class} #{file}>"
 	end
 end
 
@@ -29,12 +24,13 @@ class UIC::Application::StateMachine < UIC::StateMachine
 	def initialize(application,el)
 		self.owner = application
 		self.el    = el
-		self.file  = application.resolve_file_path(src)
-		super( File.read( file, encoding:'utf-8' ) )
-		@visuals = @doc.at( "/application/statemachine[@ref='##{id}']/visual-states" )
-		@visuals ||= @doc.root.add_child("<statemachine ref='##{id}'><visual-states/></statemachine>")
+
+		@visuals = app.doc.at( "/xmlns:application/xmlns:statemachine[@ref='##{id}']/xmlns:visual-states" )
+		@visuals ||= app.doc.root.add_child("<statemachine ref='##{id}'><visual-states/></statemachine>")
 		@visual_states      = VisualStates.new( self, @visuals )
 		@visual_transitions = VisualTransitions.new( self, @visuals )
+
+		self.file  = application.absolute_path(src)
 	end
 	alias_method :app, :owner
 
@@ -48,12 +44,32 @@ class UIC::Application::StateMachine < UIC::StateMachine
 			visual_action.value[/\A(['"])[^'"]+\1\Z/] && # ensure that it's a simple string value
 			visual_action.element.properties[ visual_action.attribute ].is_a?( UIC::Property::Image )
 		end.group_by do |visual_action,owner|
-			visual_action.value[/\A(['"])([^'"]+)\1\Z/,2]
+			app.absolute_path( visual_action.value[/\A(['"])([^'"]+)\1\Z/,2] )
 		end.each do |image_path,array|
 			array.map!(&:last)
 		end
 	end
 
+	# @return [Array<VisualAction>] all visual actions in the `.uia` for this state machine.
+	def visual_actions
+		visual_states.flat_map(&:enter_actions) +
+		visual_states.flat_map(&:exit_actions) +
+		visual_transitions.flat_map(&:actions)
+	end
+
+	def referenced_files
+		visual_actions.map do |action|
+			if action.is_a?(VisualAction::SetAttribute) && (el=action.element) && (path=action.value[ /\A(['"])([^'"]+)\1\Z/, 2 ])
+				type=el.properties[ action.attribute ].type
+				if action.attribute=='sourcepath' || action.attribute=='importfile' || type=='Texture'
+					app.absolute_path( path.sub(/#.+$/,'') )
+				elsif type=='Font'
+					app.absolute_path( File.join( 'fonts', path.sub(/$/,'.ttf') ) )
+				end
+			end
+		end.compact.uniq
+	end
+
 	class UIC::Application::StateMachine::VisualStates
 		include Enumerable
 		def initialize(app_machine,visuals_el)
@@ -62,15 +78,15 @@ class UIC::Application::StateMachine < UIC::StateMachine
 			@by_el   = {}
 		end
 		def each
-			@wrap.xpath('state').each{ |el| yield @by_el[el] ||= VisualState.new(el) }
+			@wrap.xpath('xmlns:state').each{ |el| yield @by_el[el] ||= VisualState.new(el,@machine) }
 		end
 		def [](id)
-			if el=@wrap.at("state[@ref='#{id}']")
-				@by_el[el] ||= VisualState.new(el)
+			if el=@wrap.at("xmlns:state[@ref='#{id}']")
+				@by_el[el] ||= VisualState.new(el,@machine)
 			end
 		end
 		def length
-			@wrap.xpath('count(state)').to_i
+			@wrap.xpath('count(xmlns:state)').to_i
 		end
 		alias_method :count, :length
 	end
@@ -83,30 +99,131 @@ class UIC::Application::StateMachine < UIC::StateMachine
 			@by_el   = {}
 		end
 		def each
-			@wrap.xpath('transition').each{ |el| yield @by_el[el] ||= VisualState.new(el) }
+			@wrap.xpath('xmlns:transition').each{ |el| yield @by_el[el] ||= VisualTransition.new(el,@machine) }
 		end
 		def [](id)
-			if el=@wrap.at("transition[@ref='#{id}']")
-				@by_el[el] ||= VisualTransition.new(el)
+			if el=@wrap.at("xmlns:transition[@ref='#{id}']")
+				@by_el[el] ||= VisualTransition.new(el,@machine)
 			end
 		end
 		def length
-			@wrap.xpath('count(transition)').to_i
+			@wrap.xpath('count(xmlns:transition)').to_i
 		end
 		alias_method :count, :length
 	end
 
 	class UIC::Application::StateMachine::VisualState
-		def initialize(el)
+		include UIC::ElementBacked
+
+		# @!attribute ref
+		#   @return [String] the `id` of the state in the state machine whose enter/exit will trigger the attached visual actions.
+		xmlattribute :ref
+
+		# @return [Nokogiri::XML::Element] the Nokogiri element in the `.uia` representing this visual state.
+		attr_reader :el
+
+		# @return [Application::StateMachine] the state machine containing the referenced state.
+		attr_reader :machine
+
+		def initialize(el,machine)
 			@el = el
+			@machine = machine
+		end
+
+		def enter_actions
+			@el.xpath('xmlns:enter/*').to_a.map{ |el| VisualAction.create(el,self) }
+		end
+
+		def exit_actions
+			@el.xpath('xmlns:exit/*').to_a.map{ |el| VisualAction.create(el,self) }
 		end
 	end
 
 	class UIC::Application::StateMachine::VisualTransition
-		def initialize(el)
+		include UIC::ElementBacked
+
+		# @!attribute ref
+		#   @return [String] the `uic:id` of the transition that will trigger the attached visual actions.
+		xmlattribute :ref
+
+		def initialize(el,machine)
 			@el = el
+			@machine = machine
+		end
+		def actions
+			@el.xpath('./*').to_a.map{ |el| VisualAction.create(el,self) }
 		end
 	end
 
+	class UIC::Application::StateMachine::VisualAction
+		include UIC::ElementBacked
+
+		# @!attribute element
+		#   @return [UIC::MetaData::AssetBase] the element in a UIC presentation affected by this action.
+		xmlattribute(:element, lambda{ |path,action| (action.machine.app / path) }){ |element| element.path }
+
+		# @return [Nokogiri::XML::Element] the Nokogiri element representing this action in the `.uia`.
+		attr_reader :el
 
+		# @return [VisualState,VisualTransition] the visual state or transition wrapping this action.
+		attr_reader :owner
+
+		# @return [Application::StateMachine] the state machine triggering this action.
+		attr_reader :machine
+
+		def self.create(el,owner)
+			klass = case el.name
+				when 'goto-slide'    then GotoSlide
+				when 'call'          then Call
+				when 'set-attribute' then SetAttribute
+				when 'fire-event'    then FireEvent
+				else                      Generic
+			end
+			klass.new(el,owner)
+		end
+
+		def initialize(el,owner)
+			@el = el
+			@owner = owner
+			@machine = owner.machine
+		end
+
+		class UIC::Application::StateMachine::VisualAction::GotoSlide < self
+			# TODO: xmlattributes
+		end
+
+		class UIC::Application::StateMachine::VisualAction::Call < self
+			# TODO: xmlattributes
+		end
+
+		class UIC::Application::StateMachine::VisualAction::SetAttribute < self
+			# @!attribute attribute
+			#   @return [String] the name of the attribute to set.
+			xmlattribute :attribute
+
+			# @!attribute value
+			#   @return [String] the Lua expression to evaluate as the new value.
+			xmlattribute :value
+		end
+
+		class UIC::Application::StateMachine::VisualAction::FireEvent < self
+			# TODO: xmlattributes
+		end
+
+		class UIC::Application::StateMachine::VisualAction::Generic
+			# @return [Nokogiri::XML::Element] the Nokogiri element representing this action in the `.uia`.
+			attr_reader :el
+
+			# @return [VisualState,VisualTransition] the visual state or transition wrapping this action.
+			attr_reader :owner
+
+			# TODO: xmlattributes
+
+			def initialize(el,owner)
+				@el = el
+				@owner = owner
+				@machine = owner.machine
+			end
+		end
+	end
 end

data/lib/ruic/version.rb

@@ -1,3 +1,3 @@
 class RUIC
-	VERSION = '0.5.0'
+	VERSION = '0.6.0'
 end

data/test/customclasses.ruic

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruic
 metadata 'MetaData.xml'                         # optional; also may be set via -m flag
 uia 'projects/CustomClasses/CustomClasses.uia'  # required before other commands
-show app.errors if app.errors?
 
 main = app.main_presentation
 

data/test/filtering.ruic

@@ -1,7 +1,6 @@
 metadata 'MetaData.xml'
 
 uia 'projects/SimpleScene/SimpleScene.uia'
-show app.errors if app.errors?
 
 main = app.main_presentation
 

data/test/futureassets.ruic

@@ -1,6 +1,5 @@
 metadata 'MetaData-simple.xml'
 uia 'projects/CustomClasses/CustomClasses.uia'  # required before other commands
-show app.errors if app.errors?
 
 future = app["#future"]
 

data/test/nonmaster.ruic

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruic
 metadata 'MetaData.xml'                         # optional; also may be set via -m flag
 uia 'projects/CustomClasses/CustomClasses.uia'  # required before other commands
-show app.errors if app.errors?
 
 main = app.main_presentation
 

data/test/paths.ruic

@@ -2,8 +2,6 @@
 metadata 'MetaData.xml'         # optional; also may be set via -m flag
 uia 'projects/Paths/Paths.uia'  # required before other commands
 
-show "Uh oh!", app.errors if app.errors?
-
 main = app.main
 paths = main.find _type:'Path'
 assert paths.length == 5

data/test/projects/MissingAssets/Existing.uip

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<UIP version="3" >
+	<Project >
+		<ProjectSettings author="" company="" presentationWidth="800" presentationHeight="480" maintainAspect="False" />
+		<Classes >
+			<Effect id="existing_001" name="existing" sourcepath=".\effects\existing.effect" />
+			<Effect id="missing_001" name="missing" sourcepath=".\effects\missing.effect" />
+			<CustomMaterial id="concrete" name="concrete" sourcepath=".\materials\concrete.material" />
+			<CustomMaterial id="missingcustom" name="missingcustom" sourcepath=".\materials\missing.material" />
+			<Behavior id="existing1" name="existing1" sourcepath=".\scripts\existing1.lua" />
+			<Behavior id="missing1" name="missing1" sourcepath=".\scripts\missing1.lua" />
+		</Classes>
+		<Graph >
+			<Scene id="Scene" >
+				<Behavior id="existing1_001" class="#existing1" />
+				<Behavior id="missing1_001" class="#missing1" />
+				<Layer id="Layer" >
+					<Camera id="Camera" />
+					<Light id="Light" />
+					<Text id="Text" />
+					<Text id="Text2" />
+					<Model id="existing" >
+						<Material id="Material" >
+							<Image id="Material_diffusemap" />
+						</Material>
+					</Model>
+					<Model id="missing" >
+						<Material id="Material_001" >
+							<Image id="Material_001_diffusemap" />
+						</Material>
+					</Model>
+					<Effect id="existing2" class="#existing_001" />
+					<Effect id="existing3" class="#existing_001" />
+					<Effect id="missing2" class="#missing_001" />
+					<Model id="Cube" >
+						<CustomMaterial id="Material_002" class="#concrete" />
+					</Model>
+					<Model id="Rectangle" >
+						<CustomMaterial id="concrete_001" class="#missingcustom" />
+					</Model>
+					<Group id="RoundedPlane-1" importid="__import__root__" >
+						<Model id="RoundedPlane" name="RoundedPlane" importid="RoundedPlane" orientation="Right Handed" position="0 0 -0" rotation="0 -0 0" rotationorder="XYZr" scale="1 1 1" sourcepath=".\RoundedPlane-1\meshes\RoundedPlane.mesh#1" >
+							<Material id="lambert2" name="lambert2" blendmode="Normal" diffuse="1 1 1" emissivepower="0" importid="lambert2" opacity="100" specularamount="0" />
+						</Model>
+					</Group>
+					<Group id="MissingImport" importid="__import__root__" >
+						<Model id="MissingMesh" name="RoundedPlane" importid="RoundedPlane" orientation="Right Handed" position="0 0 -0" rotation="0 -0 0" rotationorder="XYZr" scale="1 1 1" sourcepath=".\models\meshes\missing.mesh#1" >
+							<Material id="lambert2_001" name="lambert2" blendmode="Normal" diffuse="1 1 1" emissivepower="0" importid="lambert2" opacity="100" specularamount="0" />
+						</Model>
+					</Group>
+				</Layer>
+			</Scene>
+		</Graph>
+		<Logic >
+			<State name="Master Slide" component="#Scene" >
+				<Add ref="#Layer" />
+				<Add ref="#Camera" />
+				<Add ref="#Light" />
+				<State id="Scene-Intro" name="Intro" >
+					<Add ref="#existing1_001" name="existing1" />
+					<Add ref="#missing1_001" name="missing1" />
+					<Add ref="#Text" name="WelcomeMessage" font="Arimo-Regular" position="0 90 0" size="36" textstring="Hello World!&#10;This is the Intro Slide." />
+					<Add ref="#Text2" name="MissingText" font="Missing" />
+					<Add ref="#existing" name="existing" position="-353.627 -164.545 0" scale="2.7328 2.7328 0.53375" sourcepath="#Rectangle" />
+					<Add ref="#Material" diffusemap="#Material_diffusemap" />
+					<Add ref="#Material_diffusemap" sourcepath=".\maps\existing.png" />
+					<Add ref="#missing" name="missing" position="291.562 -170.318 0" scale="2.432 2.432 0.475" sourcepath="#Rectangle" />
+					<Add ref="#Material_001" diffusemap="#Material_001_diffusemap" />
+					<Add ref="#Material_001_diffusemap" sourcepath=".\maps\missing.png" />
+					<Add ref="#existing2" name="existing2" />
+					<Add ref="#existing3" name="existing3" NoiseSamp=".\maps\missing2.png" />
+					<Add ref="#missing2" name="missing2" />
+					<Add ref="#Cube" name="Cube" position="373.834 191.969 0" rotation="-41.4279 82.585 -28.6931" sourcepath="#Cube" />
+					<Add ref="#Material_002" name="Material" bump_texture=".\maps\missing.png" diffuse_texture=".\maps\existing.png" />
+					<Add ref="#Rectangle" name="Rectangle" position="-375.278 223.723 0" sourcepath="#Rectangle" />
+					<Add ref="#concrete_001" name="MissingCustom" />
+					<Add ref="#RoundedPlane-1" name="RoundedPlane-1" importfile=".\RoundedPlane-1\RoundedPlane-1.import" sourcepath=".\RoundedPlane-1\RoundedPlane-1.import" />
+					<Add ref="#RoundedPlane" importfile=".\RoundedPlane-1\RoundedPlane-1.import" />
+					<Add ref="#lambert2" importfile=".\RoundedPlane-1\RoundedPlane-1.import" />
+					<Add ref="#MissingImport" name="MissingImport" importfile=".\RoundedPlane-1\RoundedPlane-1.import" position="20 0 0" sourcepath=".\RoundedPlane-1\RoundedPlane-1.import" />
+					<Add ref="#MissingMesh" name="MissingMesh" importfile=".\RoundedPlane-1\RoundedPlane-1.import" />
+					<Add ref="#lambert2_001" importfile=".\RoundedPlane-1\RoundedPlane-1.import" />
+				</State>
+			</State>
+		</Logic>
+	</Project>
+</UIP>

data/test/projects/MissingAssets/MissingAssets.uia

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<application scalemode="center" watermark-location="1.0 1.0" xmlns="http://nvidia.com/uicomposer">
+	<assets initial="main">
+		<behavior               src="scripts/existing1.lua" />
+		<behavior               src="scripts/missing1.lua"  />
+		<statemachine id="s1"   src="states/existing.scxml" />
+		<statemachine id="s2"   src="states/missing.scxml" />
+		<presentation id="main" src="Existing.uip" />
+		<presentation id="sub"  src="Missing.uip"  />
+		<renderplugin id="rp"   src="scripts/missing.so"  />
+	</assets>
+	<statemachine ref="#s1">
+		<visual-states>
+			<state ref="Initial"><enter>
+				<set-attribute element="main:Scene.Layer.existing.Material.Image" attribute="sourcepath" value="'./maps/existing2.png'" />
+			</enter><exit>
+				<set-attribute element="main:Scene.Layer.existing.Material.Image" attribute="sourcepath" value="'.\\maps\\missing3.png'" />
+			</exit></state>
+		</visual-states>
+	</statemachine>
+</application>