tickly 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Julik Tarkhanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= tickly
+
+A highly simplistic TCL parser and evaluator (primarily designed for parsing Nuke scripts)
+
+== Contributing to tickly
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require File.dirname(__FILE__) + "/lib/tickly"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.version = Tickly::VERSION
+  gem.name = "tickly"
+  gem.homepage = "http://github.com/julik/tickly"
+  gem.license = "MIT"
+  gem.summary = %Q{Assists in parsing Nuke scripts in TCL}
+  gem.description = %Q{Parses the subset of the TCL grammar needed for Nuke scripts}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tickly #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/tickly.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + "/tickly/parser"
+require File.dirname(__FILE__) + "/tickly/evaluator"
+require 'forwardable'
+
+module Tickly
+  VERSION = '0.0.1'
+  
+  # Represents a TCL expression with it's arguments (in curly or square braces)
+  class Expr
+    extend Forwardable
+    
+    def_delegators :@e, :push, :<<, :any?, :reject!, :map!, :[], :delete_at, :include?, :each, :empty?, :join, :length
+    
+    def initialize(elements = [])
+      @e = elements
+    end
+    
+    def map(&blk)
+      self.class.new(@e.map(&blk))
+    end
+    
+    def to_a
+      @e
+    end
+    
+    def ==(another)
+      another.to_a == to_a
+    end
+    
+    def inspect
+      @e.map{|e| e.inspect }.join(', ')
+    end
+    
+  end
+  
+  # Represents an expression between curly braces (within which no text substitution will be done)
+  # like  { 1 2 3 }
+  class LiteralExpr < Expr
+    def inspect
+      "le(%s)" % super
+    end
+  end
+
+  # Represents an expression between square brackets (where text substitution will be done)
+  # like  [1 2 3]
+  class StringExpr < Expr
+    def inspect
+      "se(%s)" % super
+    end
+  end
+  
+  # Provides the methods for quickly emitting the LiteralExpr and StringExpr objects
+  module Emitter
+    def le(*elems)
+      LiteralExpr.new(elems)
+    end
+    
+    def se(*elems)
+      LiteralExpr.new(elems)
+    end
+  end
+  
+  
+  def self.to_tcl(e)
+    if e.is_a?(Tickly::LiteralExpr)
+      '{%s}' % e.map{|e| to_tcl(e)}.join(' ')
+    elsif e.is_a?(Tickly::StringExpr)
+      '[%s]' % e.map{|e| to_tcl(e)}.join(' ')
+    elsif e.is_a?(String) && (e.include?('"') || e.include?("'"))
+      e.inspect
+    else
+      e.to_s
+    end
+  end
+  
+  def self.split_array(arr, separator = nil)
+    return arr unless arr.include?(separator)
+    
+    subarrays = arr.class.new
+    subarrays.push(arr.class.new)
+    
+    arr.each do | element |
+      if element == separator
+        subarrays.push(arr.class.new)
+      else
+        subarrays[-1].push(element)
+      end
+    end
+    return subarrays
+  end
+end

data/lib/tickly/evaluator.rb

@@ -0,0 +1,47 @@
+module Tickly
+  # Evaluates a passed TCL expression without expanding it's inner arguments.
+  # The TCL should look like Nuke's node commands (i.e. NodeClass { foo bar; baz bad; } and so on)
+  # You have to add the Classes that you want to instantiate for nodes using add_node_handler_class
+  # and the evaluator will instantiate the classes it finds in the passed expression and pass the
+  # node options (actually TCL commands) to the constructor, as a Ruby Hash with string keys.
+  class Evaluator
+    def initialize
+      @node_handlers = []
+    end
+    
+    def add_node_handler_class(handler_class)
+      @node_handlers << handler_class
+    end
+    
+    def evaluate(expr)
+      if multiple_atoms?(expr) && has_subcommand?(expr) && has_handler?(expr) 
+        handler_class = @node_handlers.find{|e| unconst_name(e) == expr[0]}
+        handler_arguments = expr[1]
+        hash_of_args = {}
+        expr[1].map do | e |
+          # The name of the command is the first element, always
+          hash_of_args[e[0]] = e[1]
+        end
+        
+        # Instantiate the handler with the options
+        handler_class.new(hash_of_args)
+      end
+    end
+    
+    def multiple_atoms?(expr)
+      expr.length > 1
+    end
+    
+    def has_handler?(expr)
+      @node_handlers.map{|handler_class| unconst_name(handler_class) }.include?(expr[0])
+    end
+    
+    def unconst_name(some_module)
+      some_module.to_s.split('::').pop
+    end
+    
+    def has_subcommand?(expr)
+      expr[1].is_a?(LiteralExpr)
+    end
+  end
+end

data/lib/tickly/parser.rb

@@ -0,0 +1,123 @@
+require 'stringio'
+
+module Tickly
+  
+  class Parser
+
+    # Parses a piece of TCL and returns it converted into internal expression
+    # structures (nested StringExpr or LiteralExp objects).
+    def parse(io_or_str)
+      io = io_or_str.respond_to?(:readchar) ? io_or_str : StringIO.new(io_or_str)
+      sub_parse(io)
+    end
+    
+    private
+    
+    # Parse from a passed IO object either until an unescaped stop_char is reached
+    # or until the IO is exhausted. The last argument is the class used to
+    # compose the subexpression being parsed. The subparser is reentrant and not
+    # destructive for the object containing it.
+    def sub_parse(io, stop_char = nil, expr_class = LiteralExpr)
+      # A standard stack is an expression that does not evaluate to a string
+      stack = expr_class.new
+      buf = ''
+      until io.eof?
+        char = io.readchar
+        
+        if buf[-1] != ESC
+          if char == stop_char # Bail out of a subexpr
+            stack << buf if (buf.length > 0)
+            return cleanup(stack)
+          elsif char == " " || char == "\n" # Space
+            if buf.length > 0
+              stack << buf
+              buf = ''
+            end
+            if char == "\n" # Introduce a stack separator! This is a new line
+              stack << nil
+            end
+          elsif char == '[' # Opens a new string expression
+            stack << buf if (buf.length > 0)
+            stack << sub_parse(io, ']', StringExpr)
+          elsif char == '{' # Opens a new literal expression  
+            stack << buf if (buf.length > 0)
+            stack << sub_parse(io, '}', LiteralExpr)
+          elsif char == '"'
+            stack << buf if (buf.length > 0)
+            stack << parse_str(io, '"')
+          elsif char == "'"
+            stack << buf if (buf.length > 0)
+            stack << parse_str(io, "'")
+          else
+            buf << char
+          end
+        else
+          buf << char
+        end
+      end
+    
+      # Ramass any remaining buffer contents
+      stack << buf if (buf.length > 0)
+    
+      cleanup(stack)
+    end
+    
+    private
+    
+    ESC = 92.chr # Backslash (\)
+    
+    def parse_str(io, stop_char)
+      buf = ''
+      until io.eof?
+        c = io.readchar
+        if c == stop_char && buf[-1] != ESC
+          return buf
+        elsif buf[-1] == ESC # Eat out the escape char
+          buf = buf[0..-2] # Trim the escape character at the end of the buffer
+          buf << c
+        else
+          buf << c
+        end
+      end
+      
+      return buf
+    end
+    
+    def expand_one_elements!(expr)
+      expr.map! do | element |
+        if expr?(element) && element.length == 1 && element[0].class == element.class
+          element[0]
+        else
+          element
+        end
+      end
+    end
+    
+    def remove_empty_elements!(expr)
+      expr.reject! {|e|  expr?(e) && e.empty? }
+    end
+    
+    # Tells whether a passed object is a StringExpr or LiteralExpr
+    def expr?(something)
+      [StringExpr, LiteralExpr].include?(something.class)
+    end
+    
+    # Cleans up a subexpression stack. Currently it only removes nil objects
+    # in-between items (which act as line separators)
+    def cleanup(expr)
+      # Expand one-element expressions of the same class
+      #expand_one_elements!(expr)
+      
+      # Remove empty subexprs
+      #remove_empty_elements!(expr)
+      
+      # Squeeze out the leading and trailing nils
+      expr.delete_at(0) while (expr.any? && expr[0].nil?)
+      expr.delete_at(-1) while (expr.any? && expr[-1].nil?)
+      
+      # Convert line breaks into subexpressions
+      Tickly.split_array(expr)
+    end
+  
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tickly'
+
+class Test::Unit::TestCase
+end

data/test/nuke7_tracker_2tracks.nk

@@ -0,0 +1,116 @@
+version 7.0 v2
+define_window_layout_xml {<?xml version="1.0" encoding="UTF-8"?>
+<layout version="1.0">
+    <window x="0" y="25" w="1920" h="1150" screen="0">
+        <splitter orientation="1">
+            <split size="1348"/>
+            <splitter orientation="2">
+                <split size="1099"/>
+                <dock id="" activePageId="Viewer.1">
+                    <page id="Viewer.1"/>
+                    <page id="Curve Editor.1"/>
+                </dock>
+            </splitter>
+            <split size="560"/>
+            <splitter orientation="2">
+                <split size="112"/>
+                <dock id="" activePageId="Progress.1">
+                    <page id="Progress.1"/>
+                </dock>
+                <split size="983"/>
+                <dock id="" activePageId="Properties.1">
+                    <page id="Properties.1"/>
+                </dock>
+            </splitter>
+        </splitter>
+    </window>
+    <window x="2034" y="25" w="1294" h="1084" screen="1">
+        <splitter orientation="1">
+            <split size="40"/>
+            <dock id="" hideTitles="1" activePageId="Toolbar.1">
+                <page id="Toolbar.1"/>
+            </dock>
+            <split size="1242"/>
+            <dock id="" activePageId="DAG.1">
+                <page id="DAG.1"/>
+            </dock>
+        </splitter>
+    </window>
+</layout>
+}
+Root {
+inputs 0
+name /mnt/flame-io/Julik/nuke7_tracker_2tracks.nk
+frame 14
+last_frame 56
+lock_range true
+format "2048 1556 0 0 2048 1556 1 2K_Super_35(full-ap)"
+proxy_type scale
+proxy_format "1024 778 0 0 1024 778 1 1K_Super_35(full-ap)"
+}
+Read {
+inputs 0
+file /mnt/flame-io/Julik/BUIENRADAR/e010.##.jpg
+format "1280 720 0 0 1280 720 1 "
+last 56
+origlast 56
+origset true
+name Read1
+xpos -184
+ypos -218
+}
+Tracker4 {
+tracks { { 1 31 2 } 
+{ { 5 1 20 enable e } 
+{ 3 1 75 name name } 
+{ 2 1 58 track_x track_x } 
+{ 2 1 58 track_y track_y } 
+{ 2 1 63 offset_x offset_x } 
+{ 2 1 63 offset_y offset_y } 
+{ 4 1 27 T T } 
+{ 4 1 27 R R } 
+{ 4 1 27 S S } 
+{ 2 0 45 error error } 
+{ 1 1 0 error_min error_min } 
+{ 1 1 0 error_max error_max } 
+{ 1 1 0 pattern_x pattern_x } 
+{ 1 1 0 pattern_y pattern_y } 
+{ 1 1 0 pattern_r pattern_r } 
+{ 1 1 0 pattern_t pattern_t } 
+{ 1 1 0 search_x search_x } 
+{ 1 1 0 search_y search_y } 
+{ 1 1 0 search_r search_r } 
+{ 1 1 0 search_t search_t } 
+{ 2 1 0 key_track key_track } 
+{ 2 1 0 key_search_x key_search_x } 
+{ 2 1 0 key_search_y key_search_y } 
+{ 2 1 0 key_search_r key_search_r } 
+{ 2 1 0 key_search_t key_search_t } 
+{ 2 1 0 key_track_x key_track_x } 
+{ 2 1 0 key_track_y key_track_y } 
+{ 2 1 0 key_track_r key_track_r } 
+{ 2 1 0 key_track_t key_track_t } 
+{ 2 1 0 key_centre_offset_x key_centre_offset_x } 
+{ 2 1 0 key_centre_offset_y key_centre_offset_y } 
+} 
+{ 
+ { {curve K x1 1} "track 1" {curve x1 322 328.270813 328.0776978 326.0780029 326.5220032 324.8073425 358.2276306 392.5158691 392.4506226 401.6607666 401.6607666 x18 249 x19 242.1311951 235.2490845 229.473938 224.0309448 221.7980194 220.8138733 220.3097687 215.9066162 216.5221558 218.1231995 214.0824127 207.1420898 204.0522003 210.0070496 217.8195801 214.3830719 207.4842224 204.8947906 198.1132812 193.6152954 184.8657379 171.0793915 162.1078033 155.2776642 148.0143738 141.5550842 135.0557556 127.2473297 117.5063477 111.3422699 110.9694901 113.7087555 118.9628067 127.8691406 135.8892517 139.4182281 144.1413269 155.4910736} {curve x1 448 445.8141174 446.9832458 448.1704102 441.0701904 437.9360657 556.8189697 678.854187 681.770813 717.4888306 717.4888306 x18 409 x19 390.3128357 370.7902832 351.7124939 328.2048035 297.6690063 268.4028015 247.1441345 233.0551147 218.6214294 202.251358 188.6234741 183.5131378 179.0403137 173.3173218 168.2889252 165.387619 161.8663025 159.7026215 159.069519 159.5846252 160.325119 159.0343628 157.5151825 152.0431976 145.3804932 139.6097717 135.7308655 134.8005676 135.1534119 133.8771973 136.3284607 142.3200989 146.5865173 147.2932434 142.7356567 139.2093506 138.0481262 136.0488892} {curve K x1 0} {curve K x1 0} 1 0 0 {curve x1 0 9.74636543e-06 1.760418285e-05 2.161071201e-05 2.798796773e-05 3.497911246e-05 0.0003542814737 0.0007139164942 0.0005931421783 0.0005755083276 1 x18 0 x19 1.87521598e-05 0 8.180780791e-06 4.05472592e-05 6.728636954e-05 4.514258642e-05 3.507300538e-05 5.679712691e-05 8.744039287e-05 8.901520371e-05 0.00014483844 0.0001974749447 0.0002397972595 0.0002381663772 0.0002376472995 0.000209526033 0.0002295304103 0.0002616869801 0.0002456147812 0.0002774110437 0.0002656264675 0.0003155143973 0.0003469124189 0.0003644985254 0.0003972521665 0.000450609575 0.0004647645682 0.0005169142432 0.0005581540428 0.0006074070912 0.0006259974691 0.0005996763002 0.0005906001679 0.0005627727423 0.0005342494754 0.0005779165788 0.0005351592621 0.000515979146} 0 0.000713916 -17 -21 17 21 -32.7509 -32.7903 32.7509 32.7903 {} {curve x1 88 x18 29 x20 185} {curve x1 264 x18 236 x20 317} {curve x1 555 x18 468 x20 284} {curve x1 631 x18 581 x20 424} {curve x1 291 x18 232 x20 218} {curve x1 416 x18 388 x20 350} {curve x1 352 x18 265 x20 251} {curve x1 479 x18 429 x20 391} {curve x1 30.5 x18 16.5 x20 16.74908447} {curve x1 31.5 x18 20.5 x20 20.2902832}  } 
+ { {curve K x5 1} "track 2" {curve x5 118 112.3128128 105.5753326 105.4177399 110.1507874 106.7580414 95.44088745 84.42394257 78.0067749 70.42266846 62.3243866 55.09116364 45.5963974 33.77041626 28} {curve x5 64 64.09799194 70.61010742 74.58335876 75.47390747 77.01951599 77.52868652 71.32130432 59.49882126 53.70751572 50.4881134 41.80975723 29.1135006 13.10626316 0} {curve K x5 0} {curve K x5 0} 0 0 0 {curve x5 0 0.0001074973855 0.0002505811277 0.0003459765825 0.0001592934367 7.501828633e-05 0.0001198931179 0.0001049462949 8.04409813e-05 7.558142753e-05 8.95837562e-05 0.0001356712125 0.000246491915 0.0003578705189 0} 0 0.000357871 -11 -13 11 13 -46 -41 46 41 {} {curve x5 61 x19 -29} {curve x5 10 x19 -54} {curve x5 174 x19 84} {curve x5 117 x19 53} {curve x5 107 x19 17} {curve x5 51 x19 -13} {curve x5 128 x19 38} {curve x5 76 x19 12} {curve x5 10.5 x19 10.5} {curve x5 12.5 x19 12.5}  } 
+} 
+}
+
+translate {{curve x1 0 6.270812988 6.077697754 4.07800293 4.522003174 2.807342529 36.22763062 70.51586914 70.45062256 79.6607666 79.6607666 x18 -73 x19 -79.86880493 -86.75091553 -92.52606201 -97.96905518 -100.2019806 -101.1861267 -101.6902313 -106.0933838 -105.4778442 -103.8768005 -107.9175873 -114.8579102 -117.9477997 -111.9929504 -104.1804199 -107.6169281 -114.5157776 -117.1052094 -123.8867188 -128.3847046 -137.1342621 -150.9206085 -159.8921967 -166.7223358 -173.9856262 -180.4449158 -186.9442444 -194.7526703 -204.4936523 -210.6577301 -211.0305176 -208.2912445 -203.0372009 -194.1308594 -186.1107483 -182.5817719 -177.8586731 -166.5089264} {curve x1 0 -2.185882568 -1.01675415 0.1704101562 -6.92980957 -10.06393433 108.8189697 230.854187 233.770813 269.4888306 269.4888306 x18 -39 x19 -57.68716431 -77.2097168 -96.2875061 -119.7951965 -150.3309937 -179.5971985 -200.8558655 -214.9448853 -229.3785706 -245.748642 -259.3765259 -264.4868774 -268.9596863 -274.6826782 -279.7110596 -282.6123657 -286.1336975 -288.2973633 -288.930481 -288.4153748 -287.6748657 -288.9656372 -290.4848022 -295.9567871 -302.6195068 -308.3902283 -312.2691345 -313.1994324 -312.8465881 -314.1228027 -311.6715393 -305.6799011 -301.4134827 -300.7067566 -305.2643433 -308.7906494 -309.9518738 -311.9511108}}
+center {{curve x1 322 322 322 322 322 322 322 322 322 322 322 x18 322 x19 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322 322} {curve x1 448 448 448 448 448 448 448 448 448 448 448 x18 448 x19 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448 448}}
+selected_tracks 0
+name Tracker1
+selected true
+xpos -237
+ypos -62
+}
+Viewer {
+frame 14
+input_process false
+name Viewer1
+xpos -40
+ypos -10
+}