ffi-tk 2010.01.02 → 2010.02

data/lib/ffi-tk/command/selection.rb

@@ -35,9 +35,9 @@ module Tk
     end
 
     # Retrieves the value of selection from window's display and returns it as a
-    # result. Selection defaults to PRIMARY and window defaults to “.”.
+    # result. Selection defaults to PRIMARY and window defaults to ".".
     # Type specifies the form in which the selection is to be returned (the
-    # desired “target” for conversion, in ICCCM terminology), and should be
+    # desired "target" for conversion, in ICCCM terminology), and should be
     # an atom name such as STRING or FILE_NAME; see the Inter-Client
     # Communication Conventions Manual for complete details.
     # Type defaults to STRING.
@@ -129,4 +129,4 @@ module Tk
       end
     end
   end
-end
+end

data/lib/ffi-tk/command/tk_cmd.rb

@@ -51,8 +51,9 @@ module Tk
     # application (the name that may be used in send commands to communicate
     # with the application).
     # If newName is specified, then the name of the application is changed to
-    # newName. If the given name is already in use, then a suffix of the form “
-    # #2” or “ #3” is appended in order to make the name unique.
+    # newName.
+    # If the given name is already in use, then a suffix of the form "#2" or
+    # "#3" is appended in order to make the name unique.
     # The command's result is the name actually chosen.
     # newName should not start with a capital letter.
     # This will interfere with option processing, since names starting with
@@ -90,7 +91,7 @@ module Tk
     # If the window argument is omitted, it defaults to the main window.
     # If the number argument is omitted, the current value of the scaling
     # factor is returned.
-    # A “point” is a unit of measurement equal to 1/72 inch.
+    # A "point" is a unit of measurement equal to 1/72 inch.
     # A scaling factor of 1.0 corresponds to 1 pixel per point, which is
     # equivalent to a standard 72 dpi monitor.
     # A scaling factor of 1.25 would mean 1.25 pixels per point, which is the

data/lib/ffi-tk/command/winfo.rb

@@ -434,7 +434,7 @@ module Tk
     # Returns the number of pixels in window corresponding to the distance
     # given by number.
     # Number may be specified in any of the forms acceptable to Tk_GetPixels,
-    # such as “2.0c” or “1i”.
+    # such as "2.0c" or "1i".
     # The result is rounded to the nearest integer value; for a fractional
     # result, use winfo fpixels.
     def pixels(window, number)
@@ -665,4 +665,4 @@ module Tk
       Tk.execute(:winfo, :y, window)
     end
   end
-end
+end

data/lib/ffi-tk/core_extensions.rb

@@ -14,6 +14,8 @@ module Tk
         TclString.new('{' << map(&:to_tcl).compact.join(' ') << '}')
       end
 
+      # try to convert to a Hash.
+      # it may return an Array if this contains none.
       def tcl_options_to_hash(hints = {})
         if first.respond_to?(:to_ary)
           hash = {}
@@ -36,9 +38,8 @@ module Tk
           end
 
           hash
-        else
+        elsif first =~ /^-/
           ::Hash[each_slice(2).map{|key, value|
-
             key = key.sub(/^-/, '').to_sym
 
             case hint = hints[key]
@@ -52,6 +53,8 @@ module Tk
               [key, value]
             end
           }]
+        else
+          self
         end
       end
     end
@@ -95,7 +98,7 @@ module Tk
 
     module String
       def to_tcl
-        TclString.new('"' << gsub(/[\[\]$"\\]/, '\\\\\&') << '"')
+        TclString.new('"' << gsub(/[\[\]{}$"\\]/, '\\\\\&') << '"')
       end
 
       def to_tcl_option

data/lib/ffi-tk/event/data.rb

@@ -33,8 +33,8 @@ module Tk
         ['%K', :String,  :keysym            ],
         ['%N', :Integer, :keysym_number     ],
         ['%P', :String,  :property          ],
-        ['%R', :Integer, :root              ],
-        ['%S', :Integer, :subwindow         ],
+        ['%R', :String,  :root              ],
+        ['%S', :String,  :subwindow         ],
         ['%T', :Integer, :type              ],
         ['%W', :String,  :window_path       ],
         ['%X', :Integer, :x_root            ],
@@ -45,7 +45,8 @@ module Tk
         super id, sequence
 
         PROPERTIES.each do |code, conv, name|
-          converted = __send__(conv, properties.shift)
+          value = properties.shift
+          converted = __send__(conv, value)
           next if converted == '??'
           self[name] = converted
         end
@@ -54,6 +55,36 @@ module Tk
       def call
         Handler.invoke(id, self) if id
       end
+
+      # Try to resend the event with as much information preserved as possible.
+      # Unfortunately that doesn't seem to be easy.
+      def resend(widget, virtual, changes = {})
+        original = {}
+        members.each do |name|
+          value = self[name]
+
+          case name
+          when :id, :sequence, :border_width, :button, :count, :focus, :height,
+            :keycode, :keysym, :keysym_number, :mode, :mousewheel_delta,
+            :override_redirect, :place, :property, :root, :send_event,
+            :subwindow, :type, :unicode, :width, :window, :window_path
+          when :x_root
+            original[:rootx] = value
+          when :y_root
+            original[:rooty] = value
+          when :detail
+            original[name] = value if value
+          else
+            original[name] = value
+          end
+        end
+
+        Event.generate(widget, virtual, original.merge(changes))
+      end
+
+      def widget
+        Tk.widgets[window_path]
+      end
     end
   end
 end

data/lib/ffi-tk/event/handler.rb

@@ -4,6 +4,7 @@ module Tk
       data = Data::PROPERTIES.transpose[0].join(' ').gsub(/%/, '%%')
       @callback = %(bind %s %s { ::RubyFFI::event %d %s #{data} })
       @store = []
+      @bound = {}
       @mutex = Mutex.new
 
       module_function
@@ -27,6 +28,7 @@ module Tk
       def register(tag, sequence, &block)
         id = register_block(block)
         Tk.interp.eval(@callback % [tag, sequence, id, sequence])
+        @bound[[tag, sequence]] = block
         id
       end
 
@@ -36,8 +38,15 @@ module Tk
         id
       end
 
-      def unregister(id)
-        @store[id] = nil
+      def unregister(tag, sequence)
+        key = [tag, sequence]
+
+        if block = @bound[key]
+          Tk.execute(:bind, tag, sequence, nil)
+          id = @store.index(block)
+          @store[id] = nil
+          @bound.delete(key)
+        end
       end
     end
   end

data/lib/ffi-tk/ffi/tcl/interp.rb

@@ -30,6 +30,9 @@ module FFI
             Tcl.new_string_obj(ruby_obj, ruby_obj.bytesize)
           when Fixnum
             Tcl.new_int_obj(ruby_obj)
+          when Exception
+            string = [ruby_obj.message, *ruby_obj.backtrace].join("\n")
+            Tcl.new_string_obj(string, string.bytesize)
           else
             if ruby_obj.respond_to?(:to_tcl)
               ruby_obj.to_tcl

data/lib/ffi-tk/ffi/tk.rb

@@ -3,11 +3,50 @@ module FFI
     extend FFI::Library
     ffi_lib 'libtk8.5.so', 'libtk.so', *::Tk::LIBPATH[:tk]
 
+    class XColor < FFI::Struct
+      layout(
+        :pixel, :ulong,
+        :red,   :ushort,
+        :green, :ushort,
+        :blue,  :ushort,
+        :flags, :char,
+        :pad,   :char
+      )
+
+      def red
+        self[:red]
+      end
+
+      def green
+        self[:green]
+      end
+
+      def blue
+        self[:blue]
+      end
+    end
+
+    # This is opaque
+    class Window < FFI::Struct
+    end
+
     attach_function :Tk_Init, [:pointer], :int
+    attach_function :Tk_MainWindow, [Tcl::Interp], Window
+    attach_function :Tk_GetColor, [Tcl::Interp, Window, name = :string], XColor
     attach_function :Tk_MainLoop, [], :void
 
     module_function
 
+    def get_color(interp, string)
+      if ::Tk::RUN_EVENTLOOP_ON_MAIN_THREAD
+        XColor.new(Tk_GetColor(interp, Tk_MainWindow(interp), string))
+      else
+        Tcl.thread_sender.thread_send{
+          XColor.new(Tk_GetColor(interp, Tk_MainWindow(interp), string))
+        }
+      end
+    end
+
     def mainloop
       if ::Tk::RUN_EVENTLOOP_ON_MAIN_THREAD
         Tk_MainLoop()

data/lib/ffi-tk/tk.rb

@@ -124,7 +124,7 @@ module Tk
 
     return BREAK
   rescue => ex
-    FFI::Tcl::Interp.new(interp).obj_result = ex.message
+    FFI::Tcl::Interp.new(interp).obj_result = ex
     return ERROR
   end
   TCL_CALLBACK = method(:tcl_callback)
@@ -145,7 +145,7 @@ module Tk
 
     return BREAK
   rescue => ex
-    FFI::Tcl::Interp.new(interp).obj_result = ex.message
+    FFI::Tcl::Interp.new(interp).obj_result = ex
     return ERROR
   end
   TCL_EVENT = method(:tcl_event)

data/lib/ffi-tk/version.rb

@@ -1,3 +1,3 @@
 module FFI::Tk
-  VERSION = "2010.01.02"
+  VERSION = "2010.02"
 end

data/lib/ffi-tk/widget/canvas.rb

@@ -174,7 +174,7 @@ module Tk
       # unregister_event(name)
 
       Event::Handler.register_custom(script) do |id|
-        code = "%s bind %s %s { puts hi\n::RubyFFI::event %d %s %s }"
+        code = "%s bind %s %s { ::RubyFFI::event %d %s %s }"
         props = Event::Data::PROPERTIES.transpose[0].join(' ')
         tcl = code % [tk_pathname, tag_or_id, sequence, id, sequence, props]
         Tk.interp.eval(tcl)

data/lib/ffi-tk/widget/checkbutton.rb

@@ -15,7 +15,7 @@ module Tk
       end
     end
 
-    # Deselects the checkbutton and sets the associated variable to its “off”
+    # Deselects the checkbutton and sets the associated variable to its "off"
     # value.
     def deselect
       execute_only(:deselect)
@@ -36,12 +36,12 @@ module Tk
     # Tcl command associated with the checkbutton, if there is one.
     # The return value is the return value from the Tcl command, or an empty
     # string if there is no command associated with the checkbutton.
-    # This command is ignored if the checkbut‐ ton's state is disabled.
+    # This command is ignored if the checkbutton's state is disabled.
     def invoke
       execute_only(:invoke)
     end
 
-    # Selects the checkbutton and sets the associated variable to its “on”
+    # Selects the checkbutton and sets the associated variable to its "on"
     # value.
     def select
       execute_only(:select)

data/lib/ffi-tk/widget/listbox.rb

@@ -20,7 +20,7 @@ module Tk
     # Sets the active element to the one indicated by index.
     # If index is outside the range of elements in the listbox then the closest
     # element is activated.
-    # The active element is drawn as speci‐ fied by -activestyle when the
+    # The active element is drawn as specified by -activestyle when the
     # widget has the input focus, and its index may be retrieved with the index
     # active.
     def activate(index)
@@ -100,7 +100,7 @@ module Tk
     # of this list).
     # If option is specified with no value, then the command returns a list
     # describing the one named option (this list will be identical to the
-    # correspond‐ ing sublist of the value returned if no option is specified).
+    # corresponding sublist of the value returned if no option is specified).
     # If one or more option-value pairs are specified, then the command
     # modifies the given widget option(s) to have the given value(s); in this
     # case the command returns an empty string.
@@ -136,7 +136,7 @@ module Tk
 
     # This command computes the difference between its x and y arguments and
     # the x and y arguments to the last scan mark command for the widget.
-    # It then adjusts the view by 10 times the dif‐ ference in coordinates.
+    # It then adjusts the view by 10 times the difference in coordinates.
     # This command is typically associated with mouse motion events in the
     # widget, to produce the effect of dragging the list at high speed through
     # the window.

data/lib/ffi-tk/widget/menu.rb

@@ -44,7 +44,7 @@ module Tk
     # This option is not available for separator or tear-off entries.
     # -bitmap value Specifies a bitmap to display in the menu instead of a
     # textual label, in any of the forms accepted by Tk_GetBitmap.
-    # This option overrides the -label option (as controlled by the -com‐ pound
+    # This option overrides the -label option (as controlled by the -compound
     # option) but may be reset to an empty string to enable a textual label to
     # be displayed.
     # If a -image option has been specified, it overrides -bitmap.
@@ -58,7 +58,7 @@ module Tk
     # -compound value Specifies whether the menu entry should display both an
     # image and text, and if so, where the image should be placed relative to
     # the text.
-    # Valid values for this option are bottom, cen‐ ter, left, none, right and
+    # Valid values for this option are bottom, center, left, none, right and
     # top. The default value is none, meaning that the button will display
     # either an image or text, depending on the values of the -image and
     # -bitmap options.
@@ -122,7 +122,7 @@ module Tk
     # bindings will refuse to activate or invoke the entry.
     # In this state the entry is displayed according to the disabledForeground
     # option for the menu and the background option from the entry.
-    # This option is not available for separa‐ tor entries.
+    # This option is not available for separator entries.
     # -underline value Specifies the integer index of a character to underline
     # in the entry.
     # This option is also queried by the default bindings and used to implement
@@ -255,7 +255,7 @@ module Tk
     # Unmap the window so that it is no longer displayed.
     # If a lower-level cascaded menu is posted, unpost that menu.
     # Returns an empty string.
-    # This subcommand does not work on Windows and the Mac‐ intosh, as those
+    # This subcommand does not work on Windows and the Macintosh, as those
     # platforms have their own way of unposting menus.
     def unpost
       execute(:unpost)
@@ -263,7 +263,6 @@ module Tk
 
     # Returns a decimal string giving the x-coordinate within the menu window
     # of the leftmost pixel in the entry specified by index.
-    # │
     def xposition(index)
       execute(:xposition, index)
     end
@@ -299,7 +298,7 @@ module Tk
     # menus. You create a torn-off menu by invoking the tear-off entry at the
     # top of an existing menu.
     # The default bindings will create a new menu that is a copy of the
-    # original menu and leave it perma‐ nently posted as a top-level window.
+    # original menu and leave it permanently posted as a top-level window.
     # The torn-off menu behaves just the same as the original menu.
     # and unposts the menu.
     # If the current menu is a top-level menu posted from a menubutton, then

data/lib/ffi-tk/widget/panedwindow.rb

@@ -62,7 +62,7 @@ module Tk
 
     # This command computes the difference between the given coordinates and
     # the coordinates given to the last sash mark command for the given sash.
-    # It then moves that sash the computed dif‐ ference.
+    # It then moves that sash the computed difference.
     def sash_dragto(index, x, y)
       execute_only(:sash, :dragto, index, x, y)
     end
@@ -84,81 +84,107 @@ module Tk
       execute(:panecget, window, option.to_tcl_option)
     end
 
-    # Query or modify the management options for window.
-    # If no option is specified, returns a list describing all of the available
-    # options for pathName (see Tk_ConfigureInfo for information on the format
+    # Query or modify the management options for +window+.
+    #
+    # If no +options+ is specified, returns a list describing all of the available
+    # options for +window+ (see Tk_ConfigureInfo for information on the format
     # of this list).
-    # If option is specified with no value, then the command returns a list
+    #
+    # If +options+ is specified with no value, then the command returns a list
     # describing the one named option (this list will be identical to the
     # corresponding sublist of the value returned if no option is specified).
-    # If one or more option-value pairs are specified, then the command
-    # modifies the given widget option(s) to have the given value(s); in this
-    # case the command returns an empty string.
-    # The following options are supported: -after window Insert the window
-    # after the window specified.
-    # window should be the name of a window already managed by pathName.
-    # -before window Insert the window before the window specified.
-    # window should be the name of a window already managed by pathName.
-    # -height size Specify a height for the window.
-    # The height will be the outer dimension of the window including its
-    # border, if any.
-    # If size is an empty string, or if -height is not specified, then the
-    # height requested internally by the window will be used initially; the
-    # height may later be adjusted by the movement of sashes in the
-    # panedwindow. Size may be any value accepted by Tk_GetPixels.
-    # -hide boolean Controls the visibility of a pane.
-    # When the boolean is true (according to Tcl_GetBoolean) the pane will not
-    # be visible, but it will still be maintained in the list of panes.
-    # │ -minsize n Specifies that the size of the window cannot be made less
-    # than n.
-    # This constraint only affects the size of the widget in the paned
-    # dimension — the x dimension for horizontal panedwin‐ dows, the y
-    # dimension for vertical panedwindows.
-    # May be any value accepted by Tk_GetPixels.
-    # -padx n Specifies a non-negative value indicating how much extra space to
-    # leave on each side of the window in the X-direction.
-    # The value may have any of the forms accepted by Tk_GetPixels.
-    # -pady n Specifies a non-negative value indicating how much extra space to
-    # leave on each side of the window in the Y-direction.
-    # The value may have any of the forms accepted by Tk_GetPixels.
-    # -sticky style If a window's pane is larger than the requested dimensions
-    # of the window, this option may be used to position (or stretch) the
-    # window within its pane.
-    # Style is a string that contains zero or more of the characters n, s, e or
-    # w. The string can optionally contains spaces or commas, but they are
-    # ignored. Each letter refers to a side (north, south, east, or west) that
-    # the window will “stick” to.
-    # If both n and s (or e and w) are specified, the window will be stretched
-    # to fill the entire height (or width) of its cavity.
-    # -stretch when Controls how extra space is allocated to each of the panes.
-    # When is one of always, first, last, middle, and never.
-    # The panedwindow will calculate the required size of all its panes.
-    # │ Any remaining (or deficit) space will be distributed to those panes
-    # marked for stretching.
-    # The space will be distributed based on each panes current ratio of the
-    # whole. The when values │ have the following definition: │ always │ This
-    # pane will always stretch.
-    # │ first │ Only if this pane is the first pane (left-most or top-most)
-    # will it stretch.
-    # │ last │ Only if this pane is the last pane (right-most or bottom-most)
-    # will it stretch.
-    # This is the default value.
-    # │ middle │ Only if this pane is not the first or last pane will it
-    # stretch. │ never │ This pane will never stretch.
-    # │ -width size Specify a width for the window.
-    # The width will be the outer dimension of the window including its border,
-    # if any.
-    # If size is an empty string, or if -width is not specified, then the width
-    # requested internally by the window will be used initially; the width may
-    # later be adjusted by the movement of sashes in the panedwindow.
-    # Size may be any value accepted by Tk_Get‐ Pixels.
+    #
+    # If one or more option-value pairs are specified, then the command modifies
+    # the given widget option(s) to have the given value(s); in this case the
+    # command returns an empty string.
+    #
+    # The following options are supported:
+    #   :after window
+    #     Insert the window after the window specified.
+    #     window should be the name of a window already managed by +window+.
+    #
+    #   :before window
+    #     Insert the window before the window specified.
+    #     window should be the name of a window already managed by +window+.
+    #
+    #   :height size
+    #     Specify a height for the window.
+    #     The height will be the outer dimension of the window including its
+    #     border, if any.
+    #     If size is an empty string, or if -height is not specified, then the
+    #     height requested internally by the window will be used initially; the
+    #     height may later be adjusted by the movement of sashes in the
+    #     panedwindow. Size may be any value accepted by Tk_GetPixels.
+    #
+    #   :hide boolean
+    #     Controls the visibility of a pane.
+    #     When the boolean is true (according to Tcl_GetBoolean) the pane will
+    #     not be visible, but it will still be maintained in the list of panes.
+    #
+    #   :minsize n
+    #     Specifies that the size of the window cannot be made less than n.
+    #     This constraint only affects the size of the widget in the paned
+    #     dimension -- the x dimension for horizontal panedwindows, the y
+    #     dimension for vertical panedwindows.
+    #     May be any value accepted by Tk_GetPixels.
+    #
+    #   :padx n
+    #     Specifies a non-negative value indicating how much extra space to
+    #     leave on each side of the window in the X-direction.
+    #     The value may have any of the forms accepted by Tk_GetPixels.
+    #
+    #   :pady n
+    #     Specifies a non-negative value indicating how much extra space to
+    #     leave on each side of the window in the Y-direction.
+    #     The value may have any of the forms accepted by Tk_GetPixels.
+    #   :sticky style
+    #     If a window's pane is larger than the requested dimensions of the
+    #     window, this option may be used to position (or stretch) the window
+    #     within its pane.
+    #     Style is a string that contains zero or more of the characters n, s, e
+    #     or w.
+    #     The string can optionally contains spaces or commas, but they are
+    #     ignored. Each letter refers to a side (north, south, east, or west)
+    #     that the window will "stick" to.
+    #     If both n and s (or e and w) are specified, the window will be
+    #     stretched to fill the entire height (or width) of its cavity.
+    #   :stretch when
+    #     Controls how extra space is allocated to each of the panes.
+    #     When is one of always, first, last, middle, and never.
+    #     The panedwindow will calculate the required size of all its panes.
+    #     Any remaining (or deficit) space will be distributed to those panes
+    #     marked for stretching.
+    #     The space will be distributed based on each panes current ratio of the
+    #     whole.
+    #     The when values have the following definition:
+    #       :always
+    #         This pane will always stretch.
+    #       :first
+    #         Only if this pane is the first pane (left-most or top-most) will
+    #         it stretch.
+    #       :last
+    #         Only if this pane is the last pane (right-most or bottom-most)
+    #         will it stretch. This is the default value.
+    #       :middle
+    #         Only if this pane is not the first or last pane will it stretch.
+    #       :never
+    #         This pane will never stretch.
+    #
+    #   :width size
+    #     Specify a width for the window.
+    #     The width will be the outer dimension of the window including its
+    #     border, if any.
+    #     If size is an empty string, or if -width is not specified, then the
+    #     width requested internally by the window will be used initially; the
+    #     width may later be adjusted by the movement of sashes in the
+    #     panedwindow. Size may be any value accepted by Tk_GetPixels.
     def paneconfigure(window, options = None)
       common_configure([:paneconfigure, window], options)
     end
 
-    # Returns an ordered list of the widgets managed by pathName.
-    def panes
-      execute(:panes).to_a
+    # Returns an ordered list of the widgets managed by +window+.
+    def panes(window = None)
+      execute(:panes, window).to_a
     end
   end
 end