tkar 0.63

data/lib/tkar/help-window.rb

@@ -0,0 +1,168 @@
+module Tkar
+  class HelpWindow < TkToplevel
+    def self.show
+      if @help_window
+        @help_window.destroy
+      end
+      @help_window = new
+    end
+    
+    def initialize(*)
+      super
+      
+      title("Tkar Help")
+      iconname("tkar help")
+
+      frame = TkFrame.new(self){|frame|
+        pack('side'=>'top', 'expand'=>'yes', 'fill'=>'both')
+      }
+      
+      text = TkText.new(frame){|t|
+        setgrid 'true'
+        width  72
+        height 32
+        wrap 'word'
+        
+        TkScrollbar.new(frame) {|s|
+          pack('side'=>'right', 'fill'=>'y')
+          command proc{|*args| t.yview(*args)}
+          t.yscrollcommand proc{|first,last| s.set first,last}
+        }
+        pack('expand'=>'yes', 'fill'=>'both')
+
+        st_fixed = TkTextTag.new(t,
+          'font'=>'-*-Courier--R-Normal--*-120-*-*-*-*-*-*')
+        st_bold = TkTextTag.new(t,
+          'font'=>'-*-Courier-Bold-O-Normal--*-120-*-*-*-*-*-*')
+        st_big = TkTextTag.new(t,
+          'font'=>'-*-Courier-Bold-R-Normal--*-140-*-*-*-*-*-*')
+        st_h1 = st_verybig = TkTextTag.new(t,
+          'font'=>'-*-Helvetica-Bold-R-Normal--*-240-*-*-*-*-*-*')
+        st_h2 = TkTextTag.new(t,
+          'font'=>'-*-Helvetica-Bold-R-Normal--*-160-*-*-*-*-*-*')
+        st_small = TkTextTag.new(t,
+          'font'=>'-Adobe-Helvetica-Bold-R-Normal-*-100-*')
+        
+        st_color1 = TkTextTag.new(t, 'background'=>'#a0b7ce')
+        st_color2 = TkTextTag.new(t, 'foreground'=>'red')
+        st_raised = TkTextTag.new(t, 'relief'=>'raised', 'borderwidth'=>1)
+        st_sunken = TkTextTag.new(t, 'relief'=>'sunken', 'borderwidth'=>1)
+
+        st_bgstipple = TkTextTag.new(t, 'background'=>'black', 
+                                            'borderwidth'=>0, 
+                                            'bgstipple'=>'gray12')
+
+        st_fgstipple = TkTextTag.new(t, 'fgstipple'=>'gray50')
+        st_underline = TkTextTag.new(t, 'underline'=>'on')
+        st_overstrike = TkTextTag.new(t, 'overstrike'=>'on')
+        st_right  = TkTextTag.new(t, 'justify'=>'right')
+        st_center = TkTextTag.new(t, 'justify'=>'center')
+        st_super = TkTextTag.new(t, 'offset'=>'4p', 'font'=>'-Adobe-Courier-Medium-R-Normal--*-100-*-*-*-*-*-*')
+        st_sub = TkTextTag.new(t, 'offset'=>'-2p', 'font'=>'-Adobe-Courier-Medium-R-Normal--*-100-*-*-*-*-*-*')
+        st_margins = TkTextTag.new(t, 'lmargin1'=>'12m', 'lmargin2'=>'6m',
+                                          'rmargin'=>'10m')
+        st_spacing = TkTextTag.new(t, 'spacing1'=>'10p', 'spacing2'=>'2p',
+                                          'lmargin1'=>'12m', 'lmargin2'=>'6m',
+                                          'rmargin'=>'10m')
+
+        
+        insert('end', "\nTkar Quick Reference", [st_center, st_h1])
+        
+        insert('end', "\n\nKey commands", [st_h2])
+
+        insert('end', "\n
+    command                  effect
+    ----------------------------------------------------
+    <right-arrow>            scroll right
+    <left-arrow>             scroll left
+    <up-arrow>               scroll up
+    <down-arrow>             scroll down
+    
+    <ALT-right-arrow>        scroll right one pixel
+    <ALT-left-arrow>         scroll left one pixel
+    <ALT-up-arrow>           scroll up one pixel
+    <ALT-down-arrow>         scroll down one pixel
+    
+    <CTRL-up-arrow>          zoom out
+    <CTRL-down-arrow>        zoom in
+    
+    h                        show help window(*)
+    CTRL-q                   quit Tkar
+        ", st_fixed)
+
+        insert('end', "\n\n(*) The '?' button in the lower right corner also bings up the help window.")
+        
+        insert('end', "\n\nMouse commands", [st_h2])
+
+        insert('end', "\n
+    command                  effect
+    ----------------------------------------------------
+    <button-1-drag>          drag an object(*)
+    <CTRL-btn-1>             select object to follow(**)
+    <button-2-drag>          zoom in or out
+    <button-3-drag>          scroll
+    <CTRL-btn-3-drag>        scroll faster
+    <mouse-wheel>            zoom
+    <CTRL-mouse-wheel>       zoom faster
+    <hover>                  highlight all parts of object
+        ", st_fixed)
+        
+        insert('end', "\n\n(*) If no object is under the mouse, this can be used to scroll the view by moving the mouse outside the visible area.")
+        
+        insert('end', "\n\n(**) If no object is under the mouse, this clears the previously selected object to follow (if any) and centers the display at the selected point. If the object selected to be followed is selected a second time, the object is no longer followed.")
+        
+        insert('end', "\n\n In addition, some mouse commands cause output to be sent back to the controlling process that can be used to manipulate its own representation of the objects:")
+
+        insert('end', "\n
+    command                  text sent to master process
+    ----------------------------------------------------
+    <click>                  click <ID>
+    <doubleclick>            doubleclick <ID>
+    <button-1-drag>          drag <ID> <x> <y>
+    <button-1-drop>          drop <ID> <target-ID>
+        ", st_fixed)
+        
+        insert('end', "\n\nCommand-line usage", [st_h2])
+        insert('end', "\
+\n\n
+  tkar [-b] [addr] [port]
+
+    Start a tkar animation process. Its inputs and outputs are one of:
+
+      stdin/stdout: this is the default
+
+      TCP socket:   if port is given (addr default is 127.0.0.1)
+
+      UNIX socket:  if addr only is given
+
+    The -b switch turns on binary protocol mode, otherwise uses ascii.
+    See docs for details.
+
+    Additional switches:
+
+      -h            this help
+
+      -c            act as client instead of server [socket cases only]
+
+      --local-lib   tells bin/tkar to use the lib dir at ./lib
+", st_fixed)
+
+        insert('end', "\n\nRun tkar with the -h option to get the most up-to-date list of command line options.")
+
+        insert('end', "\n\nAuthor", [st_center, st_h1])
+        insert('end', "\n\nJoel VanderWerf, vjoel@users.sourceforge.net")
+        
+        insert('end', "\n\nLicense", [st_center, st_h1])
+        insert('end', "\
+\n\n
+Use of Tkar is subject to the Ruby license:
+http://www.ruby-lang.org/en/LICENSE.txt
+
+Copyright (c) 2006-2009, Joel VanderWerf
+")
+        
+        state 'disabled'
+      }
+    end
+  end
+end

data/lib/tkar/primitives.rb

@@ -0,0 +1,376 @@
+module Tkar
+  module Primitives
+    module_function
+    
+    SHORTCUTS = {
+     "fc"  => "fill",
+     "oc"  => "outline",
+     "wi"  => "width",
+     "da"  => "dash",
+     "st"  => "stipple",
+    }
+    
+    def handle_shortcuts key
+      SHORTCUTS[key] || key
+    end
+    
+    @color_str = {}
+
+    def color_str col
+      @color_str[col] ||=
+        begin
+          s = col.to_s(16).rjust(6, "0")
+          "##{s}"
+        rescue
+          col # assume col is a color name
+        end
+    end
+    
+    @dash_val = {}
+
+    def dash_val val
+      @dash_val[val] ||= val.is_a?(Integer) ? val.to_s.split("") : val
+    end
+
+    # handles the following options:
+    #
+    #  fill    
+    #  outline 
+    #  width   
+    #  dash    
+    #  stipple 
+    def handle_generic_config(config, params, key_args)
+      fc, oc, wi, da, st =
+        key_args.values_at(*%w{fill outline width dash stipple})
+      if fc
+        ## skip if we saw this one before?
+        val = fc[params] rescue fc
+        config[:fill] = color_str(val)
+      end
+      if oc
+        val = oc[params] rescue oc
+        config[:outline] = color_str(val)
+      end
+      if wi
+        config[:width] = wi[params] rescue wi
+      end
+      if da
+        val = da[params] rescue da
+        config[:dash] = dash_val val
+      end
+      if st
+        config[:stipple] = st[params] rescue st
+        ## how to use "@filename" to load file once and then use bitmap name?
+      end
+    end
+    
+    # arcX,Y,W,H,key:val...
+    #
+    # (X,Y) is center, W is width, H is height.
+    # This differs from Tk because it's better!
+    # Rotation may look strange if width != height
+    #
+    #  extent angle
+    #  start angle
+    #  style sty  (pieslice, chord, or arc)
+    def arc args, key_args
+      extent, start, style = key_args.values_at(*%w{extent start style})
+      
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        cx, cy, width, height = args.map {|arg| arg[params] rescue arg}
+
+        rcx = x + cx * cos_r - cy * sin_r
+        rcy = y + cx * sin_r + cy * cos_r
+        
+        coords = [
+          rcx - width,  rcy - height,
+          rcx + width,  rcy + height ]
+        
+        ## possible to skip below if no changes?
+        config = {}
+        handle_generic_config(config, params, key_args)
+        
+        if extent
+          config[:extent] = extent[params] rescue extent
+        end
+        if start
+          config[:start] = start[params] rescue start
+          config[:start] -= tkaroid.r * RADIANS_TO_DEGREES
+        end
+        if style
+          config[:style] = style[params] rescue style
+        end
+
+        [TkcArc, coords, config]
+      end
+    end
+    
+    # lineX1,Y1,X2,Y2...,key:val...
+    #
+    #  arrow where (none, first, last, both)
+    #  arrowshape shape
+    #  capstyle style (butt, projecting, round)
+    #  joinstyle style (miter, bevel, round)
+    #  smooth smoothMethod (true or false)
+    #  splinesteps number
+    def line args, key_args
+      arrow, arrowshape, capstyle, joinstyle, smooth, splinesteps =
+      key_args.values_at(
+        *%w{arrow arrowshape capstyle joinstyle smooth splinesteps})
+
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        coords = []
+        points = args.map {|arg| arg[params] rescue arg}
+        points.each_slice(2) do |xv, yv|
+          coords << x + xv * cos_r - yv * sin_r
+          coords << y + xv * sin_r + yv * cos_r
+        end
+        
+        config = {}
+        handle_generic_config(config, params, key_args)
+        
+        if arrow
+          config[:arrow] = arrow[params] rescue arrow
+        end
+        if arrowshape
+          val = arrowshape[params] rescue arrowshape
+          val = val.split("+").map{|s| Integer(s)}
+          config[:arrowshape] = val
+        end
+        if capstyle
+          config[:capstyle] = capstyle[params] rescue capstyle
+        end
+        if joinstyle
+          config[:joinstyle] = joinstyle[params] rescue joinstyle
+        end
+        if smooth
+          config[:smooth] = smooth[params] rescue smooth
+        end
+        if splinesteps
+          config[:splinesteps] = splinesteps[params] rescue splinesteps
+        end
+
+        [TkcLine, coords, config]
+      end
+    end
+    
+    # ovalX1,Y1,X2,Y2,key:val...
+    # standard keys
+    def oval args, key_args
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        coords = []
+        points = args.map {|arg| arg[params] rescue arg}
+        points.each_slice(2) do |xv, yv|
+           coords << x + xv * cos_r - yv * sin_r
+           coords << y + xv * sin_r + yv * cos_r
+        end
+        
+        config = {}
+        handle_generic_config(config, params, key_args)
+
+        [TkcOval, coords, config]
+      end
+    end
+    
+    # rectX1,Y1,X2,Y2,key:val...
+    # standard keys
+    def rect args, key_args
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        coords = []
+        points = args.map {|arg| arg[params] rescue arg}
+        points.each_slice(2) do |xv, yv|
+           coords << x + xv * cos_r - yv * sin_r
+           coords << y + xv * sin_r + yv * cos_r
+        end
+        
+        config = {}
+        handle_generic_config(config, params, key_args)
+
+        [TkcRectangle, coords, config]
+      end
+    end
+    
+    # polyX1,Y1,X2,Y2,...key:val...
+    #
+    #  joinstyle style (miter, bevel, round)
+    #  smooth smoothMethod (true or false)
+    #  splinesteps number
+    def poly args, key_args
+      joinstyle, smooth, splinesteps =
+      key_args.values_at(*%w{joinstyle smooth splinesteps})
+
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        coords = []
+        points = args.map {|arg| arg[params] rescue arg}
+        points.each_slice(2) do |xv, yv|
+           coords << x + xv * cos_r - yv * sin_r
+           coords << y + xv * sin_r + yv * cos_r
+        end
+        
+        config = {}
+        handle_generic_config(config, params, key_args)
+
+        if joinstyle
+          config[:joinstyle] = joinstyle[params] rescue joinstyle
+        end
+        if smooth
+          config[:smooth] = smooth[params] rescue smooth
+        end
+        if splinesteps
+          config[:splinesteps] = splinesteps[params] rescue splinesteps
+        end
+
+        [TkcPolygon, coords, config]
+      end
+    end
+    
+    # textX,Y,key:val...
+    #
+    #  anchor anchorPos (center, n, nw, ...)
+    #  font fontName
+    #  justify how (left, right, or center)
+    #  text string (**)
+    #  width lineLength
+    #
+    # (**) text with embedded spaces can be specified only via a param command 
+    def text args, key_args
+      anchor, font, justify, text =
+      key_args.values_at(*%w{anchor font justify text})
+       # width handled by handle_generic_config
+      
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        xv, yv = args.map {|arg| arg[params] rescue arg}
+        coords = [
+          x + xv * cos_r - yv * sin_r,
+          y + xv * sin_r + yv * cos_r
+        ]
+        
+        config = {}
+        handle_generic_config(config, params, key_args)
+
+        if anchor
+          config[:anchor] = anchor[params] rescue anchor
+        end
+        if font
+          config[:font] = font[params] rescue font
+        end
+        if justify
+          config[:justify] = justify[params] rescue justify
+        end
+        if text
+          config[:text] = text[params] rescue text
+        end
+
+        [TkcText, coords, config]
+      end
+    end
+    
+    # imageX,Y,key:val...
+    #
+    #  anchor anchorPos (center, n, nw, ...)
+    #  image imageFileName
+    #
+    def image args, key_args
+      anchor, image = key_args.values_at(*%w{anchor image})
+      
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        xv, yv = args.map {|arg| arg[params] rescue arg}
+        coords = [
+          x + xv * cos_r - yv * sin_r,
+          y + xv * sin_r + yv * cos_r
+        ]
+        
+        config = {}
+        if anchor
+          config[:anchor] = anchor[params] rescue anchor
+        end
+        if image
+          config[:image] = get_image(image[params]) rescue get_image(image)
+        end
+
+        [TkcImage, coords, config]
+      end
+    end
+    
+    def get_image file_name
+      @@images ||= {}
+      @@images[file_name] ||= TkPhotoImage.new(:file => file_name)
+    end
+    
+    ## bitmap
+    
+    # anchor anchorPos
+    # height pixels
+    # width pixels
+    # window pathName
+##    def window args, key_args
+##      x, y = args
+##      
+##    end
+
+    # An embedded window that shows a list of key-value pairs.
+##    def proplist args, key_args
+##    end
+    
+    # just a very simple example!
+    def polybox args, key_args
+      dx, dy = args
+      
+      # return a proc to make the info needed to instantiate/update
+      proc do |tkaroid, cos_r, sin_r|
+        x = tkaroid.x
+        y = tkaroid.y
+        params = tkaroid.params
+
+        ex = dx[params] rescue dx
+        ey = dy[params] rescue dy
+
+        points =
+        [ [ ex,  ey],
+          [ ex, -ey],
+          [-ex, -ey],
+          [-ex,  ey] ]
+
+        coords = []
+        points.each do |xv, yv|
+          coords << x + xv * cos_r - yv * sin_r
+          coords << y + xv * sin_r + yv * cos_r
+        end
+
+        ## possible to skip below if no changes?
+        config = {}
+        handle_generic_config(config, params, key_args)
+
+        [TkcPolygon, coords, config]
+      end
+    end
+  end
+end