canis 0.0.4

data/lib/canis/core/docs/textpad.txt

@@ -0,0 +1,48 @@
+# Help for Textpads 
+
+(These were earlier called _TextViews_ )
+
+Textpads allow display of multiline textual information and provide for 
+basic search, and vim-like navigation keys.
+
+Some textpads are extended to display multiple buffers such as the help
+screens. Textpads may display text that has ANSI escape codes such as 
+unix `man` pages, or the output of commands such as `ri` or `dooby` or 
+any other unix command that outputs colored output.
+
+There is a second format that provides a lot more control than ANSI,
+which is a `tmux` like format. This is used in the `status_line`.
+
+Finally, there is a (new) help format, much like markdown (very
+restricted, though). This page is formatted using the help format.
+
+Following are some styles it provides:
+
+- strong using __ as in __strong__. end
+- strong using double asterisks that is ** : **strong text with spaces**. end
+- emphasis using single asterisk * as in *emphasis*. end.
+  Emphasis *taking spaces in* between with single asterisk.
+- emphasis using single _ as in _thisisemphsized_, will not take _
+inside.
+- code using tilde as in `do_process_now` or `@bgcolor` and `$fgcolor`.
+- underline using bar as in |underlined|, this depends on TERM setting.
+  xterm shows underlines, most others do not.
+- Link as in [[list]] (double brackets in source, but single in display).
+- key using angular brackets as in <KEY_BACKSPACE>.
+
+A block follows in white and bold (start with a single > on previous
+line, and end with a single < char after block:
+>
+ I think most of these need to be fixed so they don't start capturing
+ if surrounded by spaces. A lookahead and lookbehind is required other
+ wise they can wreak havoc.
+<
+
+
+Textpads do not provide row selection, but do allow mapping of the <ENTER>
+key and provide the `word_under_cursor` to the calling block as part of
+the action event. For instance, on this (or other) help pages, pressing 
+the <TAB> key will take the cursor to the next link (if there is one).
+Pressing <ENTER> on the link will open the linked help file. This is the
+link to the [[index]] or main help page.
+

data/lib/canis/core/docs/tree.txt

@@ -0,0 +1,23 @@
+# Help for Trees
+
+Trees are multirow components that support tree-like information, with
+leafs and branches (nodes) that contain more leafs or branches.
+
+These are often used for directory-like structures.
+
+Trees support all or most motion commands of [[Textpad]] in addition to
+defining some additional ones such as:
+>
+  - O   Expand all children
+  - X   Collapse all children
+  - o   toggle expanded state
+  - p   go to parent
+  - x   collapse parent
+<
+
+Pressing <ENTER> expands or collapses a node (branch).
+The `$row_selector` key by default is "v" which is used to trigger a
+method, such as displaying details on some other list or view.
+
+(This page needs to be completed)
+

data/lib/canis/core/include/action.rb

@@ -0,0 +1,83 @@
+# ----------------------------------------------------------------------------- #
+#         File: action.rb
+#  Description: A common action class which can be used with buttons, popupmenu
+#               and anythign else that takes an action or command
+#       Author: jkepler http://github.com/mare-imbrium/canis/
+#         Date: been around since the beginning
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2014-04-28 14:53
+#  NOTE: I don't like the dependence on rwidget and EventHandler. Seems it needs
+#   that only for fire_handler and not sure if that's used. I've not bound :FIRE
+#   ever.
+#
+#   Darn, do i really need to have dsl_accessors and property This is not a 
+#   widget and there's no repaint. Do button's and popups really repaint
+#   themselves when a dsl_property is modified ?
+# ----------------------------------------------------------------------------- #
+#
+#require 'canis/core/widgets/rwidget'
+include Canis
+module Canis
+  ## encapsulates behaviour allowing centralization
+  # == Example
+  #    a = Action.new("&New Row") { commands }
+  #    a.accelerator "Alt N"
+  #    menu.add(a)
+  #    b = Button.new form do
+  #      action a
+  #      ...
+  #    end
+  class Action < Proc
+    # once again commented on 2014-04-28 - 14:37 to keep simple
+    #include EventHandler # removed 2012-01-3 maybe you can bind FIRE
+    #include ConfigSetup # removed 2012-01-3 
+    # name used on button or menu
+    attr_accessor :name
+    attr_accessor :enabled
+    attr_accessor :tooltip_text
+    attr_accessor :help_text
+    attr_accessor :mnemonic
+    attr_accessor :accelerator
+
+    def initialize name, config={}, &block
+      super &block
+      @name = name
+      @name.freeze
+      @enabled = true
+      # removing dependency from config
+      #config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      @config = config
+      keys = @config.keys
+      keys.each do |e| 
+        variable_set(e, @config[e])
+      end
+      #@_events = [:FIRE]
+    end
+    def call *args
+      return unless @enabled
+      # seems to be here, if you've bound :FIRE no this, not on any widget
+      #fire_handler :FIRE, self  
+      super
+    end
+
+
+    # the next 3 are to adapt this to CMenuitems
+    def hotkey
+      return @mnemonic if @mnemonic
+      ix = @name.index('&')
+      if ix
+        return @name[ix+1, 1].downcase
+      end
+    end
+    # to adapt this to CMenuitems
+    def label
+      @name.sub('&','')
+    end
+    # to adapt this to CMenuitems
+    def action
+      self
+    end
+
+  end # class
+end # module
+

data/lib/canis/core/include/actionmanager.rb

@@ -0,0 +1,49 @@
+# ----------------------------------------------------------------------------- #
+#         File: actionmanager.rb
+#  Description: a class that manages actions for a widget
+#
+#       Author: jkepler http://github.com/mare-imbrium/canis/
+#         Date: 2012-01-4 
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: ,,L
+# ----------------------------------------------------------------------------- #
+#
+# Maintains actions for a widget
+module Canis
+  class ActionManager
+    include Io
+    attr_reader :actions
+
+    def initialize #form, config={}, &block
+      @actions = []
+       #instance_eval &block if block_given?
+    end
+    def add_action act
+      @actions << act
+    end
+    def remove_action act
+      @actions.remove act
+    end
+    #
+    # insert an item at given position (index)
+    def insert_action pos, *val
+      @actions[pos] = val
+    end
+    #def create_menuitem *args
+      #PromptMenu.create_menuitem *args
+    #end
+
+    # popup the hist 
+    # 
+    def show_actions
+      return if @actions.empty?
+      list = @actions
+      menu = PromptMenu.new self do |m|
+      list.each { |e| 
+        m.add *e
+      }
+      end
+      menu.display_new :title => 'Widget Menu (Press letter)'
+    end
+  end # class
+end # mod RubyC

data/lib/canis/core/include/appmethods.rb

@@ -0,0 +1,179 @@
+module Canis
+  module Utils
+    private
+    def _suspend clear=true
+      return unless block_given?
+      Ncurses.def_prog_mode
+      if clear
+        Ncurses.endwin 
+        # NOTE: avoid false since screen remains half off
+        # too many issues
+      else
+        system "/bin/stty sane"
+      end
+      yield if block_given?
+      Ncurses.reset_prog_mode
+      if !clear
+        # Hope we don't screw your terminal up with this constantly.
+        Canis::stop_ncurses
+        Canis::start_ncurses  
+        #@form.reset_all # not required
+      end
+      @form.repaint if @form
+      @window.wrefresh if @window
+      Ncurses::Panel.update_panels
+    end
+    #
+    # Suspends to shell so user can execute commands.
+    # Maybe not be able to get your prompt correctly.
+    # 
+    public
+    def suspend
+      _suspend(false) do
+        system("tput cup 26 0")
+        system("tput ed")
+        system("echo Enter C-d to return to application")
+        system (ENV['PS1']='\s-\v\$ ') if ENV['SHELL']== '/bin/bash'
+        system(ENV['SHELL']);
+      end
+    end
+
+    #
+    # prompts user for unix command and displays output in viewer
+    # 
+    def shell_output
+      $shell_history ||= []
+      cmd = get_string("Enter shell command:", :maxlen => 50) do |f|
+        require 'canis/core/include/rhistory'
+        f.extend(FieldHistory)
+        f.history($shell_history)
+      end
+      if cmd && !cmd.empty?
+        run_command cmd
+        $shell_history.push(cmd) unless $shell_history.include? cmd
+      end
+    end
+
+    #
+    # executes given command and displays in viewer
+    # @param [String] unix command, e.g., git -st
+    def run_command cmd
+      # http://whynotwiki.com/Ruby_/_Process_management#What_happens_to_standard_error_.28stderr.29.3F
+      require 'canis/core/util/viewer'
+      begin
+        res = `#{cmd} 2>&1`
+      rescue => ex
+        res = ex.to_s
+        res << ex.backtrace.join("\n") 
+      end
+      res.gsub!("\t","   ")
+      # Earlier close key was ENTER but we need that to execute or fire
+      Canis::Viewer.view(res.split("\n"), :close_key => 'q', :title => "<q> to close, M-l M-h to scroll")
+    end
+    def shell_out command
+      w = @window || @form.window
+      w.hide
+      Ncurses.endwin
+      ret = system command
+      Ncurses.refresh
+      #Ncurses.curs_set 0  # why ?
+      w.show
+      return ret
+    end
+  end # utils
+  class PrefixCommand
+    attr_accessor :object
+    def initialize _symbol, calling, config={}, &block
+      @object = calling
+      @symbol = _symbol
+      @descriptions = {}
+      define_prefix_command _symbol
+      yield self if block_given?
+    end
+    def define_prefix_command _name, config={}
+      $rb_prefix_map ||= {}
+      #h = {}
+      #@map = h
+      _name = _name.to_sym unless _name.is_a? Symbol
+      # TODO it may already exist, so retrieve it
+      $rb_prefix_map[_name] ||= {}
+      @map = $rb_prefix_map[_name]
+      # create a variable by name _name
+      # create a method by same name to use
+      @object.instance_eval %{
+        def #{_name.to_s} *args
+           h = $rb_prefix_map["#{_name}".to_sym]
+           raise "No prefix_map named #{_name}, #{$rb_prefix_map.keys} " unless h
+           ch = @window.getchar
+           if ch
+              res =  h[ch]
+              if res.is_a? Proc
+                res.call
+              else
+                 send(res) if res
+              end
+           else
+              0
+           end
+        end
+      }
+      return _name
+    end
+    def call
+      h = @map
+      ch = @object.window.getch # dicey.
+        $log.debug "XXX:  CALLED #{ch} "
+      if ch
+        if ch == KEY_F1
+          text =  ["Options are: "]
+          h.keys.each { |e| c = keycode_tos(e); text << " #{c} #{@descriptions[e]} " }
+          textdialog text, :title => " #{@symbol} key bindings "
+          return
+        end
+        res =  h[ch]
+        if res.is_a? Proc
+          res.call
+        elsif res.is_a? Symbol
+          @object.send(res) if res
+        else
+          Ncurses.beep
+          @object.window.ungetch(ch)
+
+          :UNHANDLED
+        end
+      else
+        raise "got nothing"
+      end
+    end
+
+    # define a key within a prefix key map such as C-x
+    # Now that i am moving this from global, how will describe bindings get hold of the bindings
+    # and descriptions
+    def define_key _keycode, *args, &blk
+      _symbol = @symbol
+      h = $rb_prefix_map[_symbol]
+      raise ArgumentError, "No such keymap #{_symbol} defined. Use define_prefix_command." unless h
+      _keycode = _keycode[0].getbyte(0) if _keycode[0].class == String
+      arg = args.shift
+      if arg.is_a? String
+        desc = arg
+        arg = args.shift
+      elsif arg.is_a? Symbol
+        # its a symbol
+        desc = arg.to_s
+      elsif arg.nil?
+        desc = "unknown"
+      else
+        raise ArgumentError, "Don't know how to handle #{arg.class} in PrefixManager"
+      end
+      @descriptions[_keycode] = desc
+
+      if !block_given?
+        blk = arg
+      end
+      h[_keycode] = blk
+    end
+    alias :key :define_key
+  end
+end # module RubyC
+include Canis::Utils

data/lib/canis/core/include/bordertitle.rb

@@ -0,0 +1,49 @@
+# I am moving the common title and border printing stuff into 
+# a separate module.
+module Canis
+  module BorderTitle
+    dsl_accessor :suppress_borders            #to_print_borders
+    dsl_accessor :border_attrib, :border_color
+    dsl_accessor :title                       #set this on top
+    dsl_accessor :title_attrib                #bold, reverse, normal
+
+    def bordertitle_init
+      @_bordertitle_init_called = true
+      @row_offset = @col_offset = 0 if @suppress_borders 
+      @internal_width = 1 if @suppress_borders # the other programs have zero not 1 NOTE
+    end
+    # why the dash does it reduce height by one.
+    def print_borders
+      bordertitle_init unless @_bordertitle_init_called
+      raise ArgumentError, "Graphic not set" unless @graphic
+      raise "#{self} needs width" unless @width
+      raise "#{self} needs height" unless @height
+      width = @width
+      height = @height-1
+      window = @graphic
+      startcol = @col 
+      startrow = @row 
+      @color_pair = get_color($datacolor)
+      bordercolor = @border_color || @color_pair
+      borderatt = @border_attrib || Ncurses::A_NORMAL
+      window.print_border startrow, startcol, height, width, bordercolor, borderatt
+      print_title
+    end
+    def print_title
+      bordertitle_init unless @_bordertitle_init_called
+      return unless @title
+      raise "#{self} needs width" unless @width
+      # removed || since this can change after first invocation and should be recalculated.
+      @color_pair = get_color($datacolor) 
+      #$log.debug " print_title #{@row}, #{@col}, #{@width}  "
+      # check title.length and truncate if exceeds width
+      _title = @title
+      if @title.length > @width - 2
+        _title = @title[0..@width-2]
+      end
+      @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, @color_pair, @title_attrib) unless @title.nil?
+    end
+
+  end
+end
+include BorderTitle

data/lib/canis/core/include/canisparser.rb

@@ -0,0 +1,100 @@
+# ----------------------------------------------------------------------------- #
+#         File: canisparser.rb
+#  Description: creates an returns instances of parser objects
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-06-11 - 12:23
+#      License: MIT
+#  Last update: 2014-06-16 16:56
+# ----------------------------------------------------------------------------- #
+#  canisparser.rb  Copyright (C) 2012-2014 j kepler
+module Canis
+
+  # Uses multiton pattern from http://blog.rubybestpractices.com/posts/gregory/059-issue-25-creational-design-patterns.html
+  # to create and returns cached instances of a text parser.
+  # Users will call the +[]+ method rather than the +new+ method.
+  # If users wish to declare their own custom parser, then the +map+ method is to be used.
+  #
+  # @example
+  #
+  #     CanisParser[:tmux]
+  #
+  # To define your own parser:
+  #
+  #     CanisParser.map( :custom => [ 'canis/core/include/customparser', 'Canis::CustomParser' ]
+  #
+  # and later at some point,
+  #
+  #     CanisParser[:custom]
+  #
+  class CanisParser
+    class << self
+      # hash storing a filename and classname per content_type
+      def content_types 
+        #@content_types ||= {}
+        unless @content_types
+          @content_types = {}
+          #map(:tmux => [ 'canis/core/util/defaultcolorparser', 'DefaultColorParser'])
+          #map(:ansi => [ 'canis/core/util/ansiparser', 'AnsiParser'] )
+          @content_types[:tmux] = [ 'canis/core/util/defaultcolorparser', 'DefaultColorParser']
+          @content_types[:ansi] = [ 'canis/core/util/ansiparser', 'AnsiParser']
+        end
+        return @content_types
+      end
+      # hash storing a parser instance per content_type
+      def instances 
+        @instances ||= {}
+      end
+      # Used by user to define a new parser
+      # map( :tmux => ['filename', 'klassname'] )
+      def map(params)
+        content_types.update params
+      end
+
+      # Used by user to retrieve a parser instance, creating one if not present
+      # CanisParser[:tmux]
+      def [](name)
+        $log.debug "  [] got #{name} "
+        raise "nil received by [] " unless name
+        instances[name] ||= new(content_types[name])
+        #instances[name] ||= create(content_types[name])
+      end
+      def create args
+        filename = args.first
+        klassname = args[1]
+        $log.debug "  canisparser create got #{args} "
+        require filename
+        clazz = Object.const_get(klassname).new
+        $log.debug "  created #{clazz.class} "
+        #  clazz = 'Foo::Bar'.split('::').inject(Object) {|o,c| o.const_get c}
+        return clazz
+      end
+    end
+    ## WARNING - this creates a CanisParser class which we really can't use.
+    # So we need to delegate to the color parse we created.
+    # create and return a parser instance
+    # Canisparser.new filename, klassname
+    # Usually, *not* called by user, since this instance is not cached. Use +map+
+    #  and then +[]+ instead for creating and cacheing.
+    def initialize *args
+      args = args.flatten
+      filename = args.first
+      klassname = args[1]
+      $log.debug "  canisparser init got #{args} "
+      raise "Canisparser init got nil" unless filename
+      require filename
+      clazz = Object.const_get(klassname).new
+      #  clazz = 'Foo::Bar'.split('::').inject(Object) {|o,c| o.const_get c}
+      #return clazz
+      @clazz = clazz
+    end
+    # delegate call to color parser
+    def parse_format s, *args, &block
+      @clazz.parse_format(s, *args, &block)
+    end
+    # delegate all call to color parser
+    def method_missing meth, *args, &block
+      #$log.debug "  canisparser got method_missing for #{meth}, sending to #{@clazz.class} "
+      @clazz.send( meth, *args, &block)
+    end
+  end
+end