tickly 2.0.0 → 2.1.0

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "bychar", "~> 1.2"
+gem 'bychar', '~> 2'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/README.rdoc

@@ -3,14 +3,14 @@
 A highly simplistic TCL parser and evaluator (primarily designed for parsing Nuke scripts). It structures
 the passed Nuke scripts into a TCL AST and return it. You can use some cheap tricks to discard the nodes you are not interested in.
 
-== Parsing
+== Plain parsing
 
 Create a Parser object and pass TCL expressions/scripts to it. You can pass IO obejcts or strings. Note that parse()
 will always return an Array of expressions, even if you only fed it one expression line. For example:
     
     p = Tickly::Parser.new
     
-    # One expression, even if it's invalid (2 is not a valid TCL bareword)- doesn't matter
+    # One expression, even if it's invalid (2 is not a valid TCL bareword - doesn't matter)
     p.parse '2' #=> [["2"]]
     
     # TCL command
@@ -35,40 +35,61 @@ Multiple expressions separated by ; or a newline will be accumulated as multiple
 Lots and lots of TCL features are not supported - remember that most Nuke scripts are machine-generated and they do not
 use most of the esoteric language features.
 
-== Evaulating
+== Evaulating nodes in Nuke scripts
 
-Nuke uses the following syntax for it's nodes:
+What you are likely to use Tickly for is parsing Nuke scripts. They got multiple node definitions, which
+are actially arguments for a node constructor written out in TCL. Consider this ubiquitous fragment for a
+hypothetic SomeNode in your script:
 
     SomeNode {
       someknob 15
       anotherknob 3
-      andanother {curve x1 12 45 67}
+      animation {curve x1 12 45 67}
+      x_pos 123
+      y_pos -10
     }
 
-and so on. You can use a simple Evaluator object to run through the nodes returned by the parser. To set up
-the evaulation you need to create classes matching the node classes by name. For example, a Blur class:
+and so on. You can use a NodeProcessor to capture these node constructors right as they are being parsed.
 
-    class Blur
+All the nodes you are not interested in will be discarded, which matters in terms of memory use.
+
+To do it you need to create Ruby classes matching the node classes by name. For example, for that SomeNode
+of ours:
+
+    class SomeNode
+      attr_reader :knobs
       def initialize(string_keyed_knobs_hash)
+        @knobs = string_keyed_knobs_hash
       end
     end
     
-    e = Tickly::Evaluator.new
+    # Instantiate a new processor
+    e = Tickly::NodeProcessor.new
+    
+    # Add the class
     e.add_node_handler_class Blur
     
-    some_script_expressions = Tickly::Parser.new.parse(File.open("/mnt/raid/nuke/scripts/HugeShot_123.nk"))
+    file = File.open("/mnt/raid/nuke/scripts/HugeShot_123.nk")
     
-    some_script_expressions.each do | expression_in_ast |
-      # Everytime a Blur node is found in the script it will be instantiated,
+    e.parse(file) do | every_some_node |
+      # Everytime a SomeNode is found in the script it will be instantiated,
       # and the knobs of the node will be passed to the constructor that you define
-      e.evaluate(expression_in_ast) do | blur_node |
-        # Now a Blur node instance is all yours
-      end
+      x_position = every_some_node.knobs["x_pos"]
+      ...
     end
 
+If you are curious, this is how Tracksperanto parses various nodes containing tracking data:
+    
+    parser = Tickly::NodeProcessor.new
+    parser.add_node_handler_class(Tracker3)
+    parser.add_node_handler_class(Reconcile3D)
+    parser.add_node_handler_class(PlanarTracker1_0)
+    parser.add_node_handler_class(Tracker4)
+
 == Animation curves
 
 You can parse Nuke's animation curves using Tickly::Curve. This will give you a way to iterate over every defined keyframe.
+This currently does not happen automatically for things passing through the parser.
 
 == Contributing to tickly
  

data/lib/tickly.rb

@@ -4,7 +4,7 @@ require File.dirname(__FILE__) + "/tickly/curve"
 require File.dirname(__FILE__) + "/tickly/node_processor"
 
 module Tickly
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
   
   # Provides the methods for quickly emitting the expression arrays,
   # is used in tests

data/lib/tickly/parser.rb

@@ -19,7 +19,7 @@ module Tickly
     def parse(io_or_str)
       bare_io = io_or_str.respond_to?(:read) ? io_or_str : StringIO.new(io_or_str)
       # Wrap the IO in a Bychar buffer to read faster
-      reader = Bychar::Reader.new(bare_io)
+      reader = Bychar.wrap(bare_io)
       # Use multiple_expressions = true so that the top-level parsed script is always an array
       # of expressions
       sub_parse(reader, stop_char = nil, stack_depth = 0, multiple_expressions = true)
@@ -27,7 +27,10 @@ module Tickly
     
     # Override this to remove any unneeded subexpressions.
     # Return the modified expression. If you return nil, the result
-    # will not be added to the expression list
+    # will not be added to the expression list. You can also use this
+    # method for bottom-up expression evaluation, returning the result
+    # of the expression being evaluated. This method will be first called
+    # for the innermost expressions and then proceed up the call stack.
     def compact_subexpr(expr, at_depth)
       expr
     end
@@ -62,7 +65,7 @@ module Tickly
       last_char_was_linebreak = false
       
       no_eof do
-        char = io.read_one_byte!
+        char = io.read_one_char!
         
         if char == stop_char # Bail out of a subexpr
           # Handle any remaining subexpressions
@@ -114,14 +117,14 @@ module Tickly
     def no_eof(&blk)
       begin
         loop(&blk)
-      rescue Bychar::EOFError
+      rescue Bychar::EOF
       end
     end
     
     def parse_str(io, stop_char)
       buf = ''
       no_eof do
-        c = io.read_one_byte!
+        c = io.read_one_char!
         if c == stop_char && buf[LAST_CHAR] != ESC
           return buf
         elsif buf[LAST_CHAR] == ESC # Eat out the escape char

data/tickly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "tickly"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2013-03-21"
+  s.date = "2013-03-23"
   s.description = "Parses the subset of the TCL grammar needed for Nuke scripts"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -55,14 +55,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<bychar>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<bychar>, ["~> 2"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<ruby-prof>, [">= 0"])
     else
-      s.add_dependency(%q<bychar>, ["~> 1.2"])
+      s.add_dependency(%q<bychar>, ["~> 2"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -70,7 +70,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<ruby-prof>, [">= 0"])
     end
   else
-    s.add_dependency(%q<bychar>, ["~> 1.2"])
+    s.add_dependency(%q<bychar>, ["~> 2"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tickly
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bychar
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4279008670880210764
+      hash: -720429447261605785
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: