Teek API Documentation

Teek::Debugger Class

Live inspector for Teek applications. Opens a Toplevel window with three tabs: Widgets (tree ` config), Variables (searchable list), and Watches (tracked variable history).

Can also be enabled via the `TEEK_DEBUG+ environment variable.

Inherits: Object

Instance Methods ↑

add_watch(name)

Add a variable watch by name. Registers a Tcl trace so changes are recorded.

View source ▼ 
def add_watch(name)
  return if @watches.key?(name)

  cb_id = @app.register_callback(proc { |var_name, index, *|
    record_watch(var_name, index)
  })

  @app.tcl_eval("trace add variable #{Teek.make_list(name)} write {ruby_callback #{cb_id}}")

  @watches[name] = { cb_id: cb_id, values: [] }
  record_watch(name, nil)
  update_watches_ui
end
GitHub

hide

View source ▼ 
def hide
  @app.hide(TOP)
end
GitHub

initialize(app)

Returns Debugger — a new instance of Debugger

View source ▼ 
def initialize(app)
  @app = app
  @interp = app.interp
  @watches = {}

  app.command(:toplevel, TOP)
  app.command(:wm, 'title', TOP, 'Teek Debugger')
  app.command(:wm, 'geometry', TOP, '400x500')

  # Don't let closing the debugger kill the app
  close_proc = proc { |*| app.command(:wm, 'withdraw', TOP) }
  app.command(:wm, 'protocol', TOP, 'WM_DELETE_WINDOW', close_proc)

  setup_ui
  sync_widget_tree
  start_auto_refresh

  # Start behind the main app window
  app.command(:lower, TOP, '.')
end
GitHub

on_widget_created(path, cls)

Called by App when a widget is created

View source ▼ 
def on_widget_created(path, cls)
  tree = "#{NB}.widgets.tree"
  return unless @app.command(:winfo, 'exists', tree) == "1"
  return if @app.command(tree, 'exists', path) == "1"

  ensure_parent_exists(path)
  parent_id = parent_tree_id(path)
  name = tk_basename(path)

  @app.command(tree, 'insert', parent_id, 'end',
    id: path, text: name, values: Teek.make_list(path, cls))
  @app.command(tree, 'item', parent_id, open: 1)
rescue Teek::TclError => e
  $stderr.puts "teek debugger: on_widget_created(#{path}): #{e.message}"
end
GitHub

on_widget_destroyed(path)

Called by App when a widget is destroyed

View source ▼ 
def on_widget_destroyed(path)
  tree = "#{NB}.widgets.tree"
  return unless @app.command(:winfo, 'exists', tree) == "1"
  return unless @app.command(tree, 'exists', path) == "1"

  @app.command(tree, 'delete', path)
rescue Teek::TclError => e
  $stderr.puts "teek debugger: on_widget_destroyed(#{path}): #{e.message}"
end
GitHub

remove_watch(name)

Remove a variable watch by name.

View source ▼ 
def remove_watch(name)
  info = @watches.delete(name)
  return unless info

  @app.tcl_eval(
    "trace remove variable #{Teek.make_list(name)} write {ruby_callback #{info[:cb_id]}}"
  )
  @app.unregister_callback(info[:cb_id])

  # Remove the tree item
  watch_tree = "#{NB}.watches.tree"
  item_id = "watch_#{name}"
  if @app.command(watch_tree, 'exists', item_id) == "1"
    @app.command(watch_tree, 'delete', item_id)
  end

  update_watches_ui
rescue Teek::TclError => e
  $stderr.puts "teek debugger: remove_watch(#{name}): #{e.message}"
end
GitHub

show

View source ▼ 
def show
  @app.show(TOP)
  @app.command(:raise, TOP)
end
GitHub
Attributes ↑

interp [R]

Returns the value of attribute interp.