canis 0.0.4

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

@@ -0,0 +1,173 @@
+require 'canis/core/util/promptmenu'
+module Canis
+  # this module makes it possible for a textview to maintain multiple buffers
+  # The first buffer has been placed using set_content(lines, config). 
+  # After this, additional buffers mst be supplied with add_content text, config.
+  # Also, please note that after you call set_content the first time, you must call 
+  # add_content so the buffer can be accessed while cycling. will try to fix this.
+  # (I don't want to touch textview, would prefer not to write a decorator).
+
+  # TODO ?? allow setting of a limit, so in some cases where we keep adding
+  # programatically, the 
+  # TODO: maintain cursor and line number so user can revert to same point. this will have to be
+  #   updated by buffer_next and others.
+  # Done: need to be able to set multiple file names. which are read in only when
+  #  buffer is accessed. filename to be maintained and used as title.
+  #  == CHANGE: 
+  #  allow filename to be sent, rather than array. Array was very limiting since it 
+  #   did not have a name to list or goto a buffer with. Also, now we can add file names that
+  #   are read only if the buffer is selected.
+  module MultiBuffers
+    extend self
+
+    # add content to buffers of a textview
+    # @param [Array] text, or String (filename)
+    # @param [Hash] options, typically :content_type => :ansi or :tmux, and :title
+    def add_content text, config={}
+      unless @_buffers
+        bind_key(?\M-n, :buffer_next)
+        bind_key(?\M-p, :buffer_prev)
+        bind_key(KEY_BACKSPACE, :buffer_prev) # backspace, already hardcoded in textview !
+        bind_key(?:, :buffer_menu)
+      end
+      @_buffers ||= []
+      @_buffers_conf ||= []
+      @_buffers << text
+      if text.is_a? String
+        config[:filename] = text
+        config[:title] ||= text
+      end
+      @_buffers_conf << config
+      @_buffer_ctr ||= 0
+      $log.debug "XXX:  HELP adding text #{@_buffers.size} "
+    end
+
+    # supply an array of files to the multibuffer. These will be read
+    #  as the user presses next or last etc.
+    def add_files filearray, config={}
+      filearray.each do |e| add_content(e, config.dup); end
+    end
+
+    # display next buffer
+    def buffer_next
+      buffer_update_info
+      @_buffer_ctr += 1
+      x = @_buffer_ctr
+      l = @_buffers[x]
+      if l
+        populate_buffer_from_filename x
+      else
+        @_buffer_ctr = 0 
+      end
+      set_content @_buffers[@_buffer_ctr], @_buffers_conf[@_buffer_ctr]
+      buffer_update_position
+    end
+    def populate_buffer_from_filename x
+      l = @_buffers[x]
+      if l
+        if l.is_a? String
+          if File.directory? l
+            Dir.chdir(l)
+            arr = Dir.entries(".")
+            @_buffers[x] = arr
+          else
+            arr = File.open(l,"r").read.split("\n")
+            @_buffers[x] = arr
+          end
+        end
+      end
+    end
+    #
+    # display previous buffer if any
+    def buffer_prev
+      buffer_update_info
+      if @_buffer_ctr < 1
+        buffer_last
+        return
+      end
+      @_buffer_ctr -= 1 if @_buffer_ctr > 0
+      x = @_buffer_ctr
+      l = @_buffers[x]
+      if l
+        populate_buffer_from_filename x
+        l = @_buffers[x]
+        $log.debug "bp calling set_content with #{l.class} "
+        set_content l, @_buffers_conf[x]
+        buffer_update_position
+      end
+    end
+    def buffer_last
+      buffer_update_info
+      @_buffer_ctr = @_buffers.count - 1
+      x = @_buffer_ctr
+      l = @_buffers.last
+      if l
+        populate_buffer_from_filename x
+        l = @_buffers[x]
+        $log.debug "  calling set_content with #{l.class} "
+        set_content l, @_buffers_conf.last
+        buffer_update_position
+      end
+    end
+    def buffer_at index
+      buffer_update_info
+      @_buffer_ctr = index
+      l = @_buffers[index]
+      if l
+        populate_buffer_from_filename index
+        l = @_buffers[index]
+        set_content l, @_buffers_conf[index]
+        buffer_update_position
+
+
+      end
+    end
+    # close window, a bit clever, we really don't know what the CLOSE_KEY is
+    def close
+      @graphic.ungetch(?q.ord)
+    end
+    # display a menu so user can do buffer management
+    # However, how can application add to these. Or disable, such as when we 
+    # add buffer delete or buffer insert or edit
+    def buffer_menu
+      menu = PromptMenu.new self do
+        item :n, :buffer_next
+        item :p, :buffer_prev
+        item :b, :scroll_backward
+        item :f, :scroll_forward
+        item :l, :list_buffers
+        item :q, :close
+        submenu :m, "submenu..." do
+          item :p, :goto_last_position
+          item :r, :scroll_right
+          item :l, :scroll_left
+        end
+      end
+      menu.display_new :title => "Buffer Menu"
+    end
+    # pops up a list of buffers using titles allowing the user to select
+    # Based on selection, that buffer is displayed.
+    def list_buffers
+      arr = []
+      @_buffers_conf.each_with_index do |e, i|
+        t = e[:title] || "no title for #{i}"
+        #$log.debug "  TITLE is #{e.title} , t is #{t} "
+        arr << t
+      end
+      ix = popuplist arr
+      buffer_at ix
+    end
+    def buffer_update_info
+      x = @_buffer_ctr || 0
+      @_buffers_conf[x][:current_index] = @current_index || 0
+      @_buffers_conf[x][:curpos] = @curpos || 0
+    end
+    def buffer_update_position
+      x = @_buffer_ctr || 0
+      ci = (@_buffers_conf[x][:current_index] || 0)
+      goto_line ci
+      @curpos = (@_buffers_conf[x][:curpos] || 0)
+    end
+
+  end
+end

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

@@ -0,0 +1,73 @@
+=begin
+  * Name: ActionEvent
+  * Description: Event used to notify interested parties that an action has happened on component
+                 Usually a button press. Nothing more.
+  * Author: jkepler (ABCD)
+  
+  --------
+  * Date: 2010-09-12 18:53 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+
+# Event created when state changed (as in ViewPort)
+module Canis
+  # source - as always is the object whose event has been fired
+  # id     - event identifier (seems redundant since we bind events often separately.
+  # event  - is :PRESS
+  # action_command - command string associated with event (such as title of button that changed
+  ActionEvent = Struct.new(:source, :event, :action_command) do
+    # This should always return the most relevant text associated with this object
+    # so the user does not have to go through the source object's documentation.
+    # It should be a user-friendly string 
+    # @return text associated with source (label of button)
+    def text
+      source.text
+    end
+
+    # This is similar to text and can often be just an alias.
+    # However, i am putting this for backward compatibility with programs
+    # that received the object and called it's getvalue. It is better to use text.
+    # @return text associated with source (label of button)
+    def getvalue
+      source.getvalue
+    end
+  end
+  # a derivative of Action Event for textviews
+  # We allow a user to press ENTER on a row and use that for processing.
+  # We are basically using TextView as a list in which user can scroll around
+  # and move cursor at will.
+  class TextActionEvent < ActionEvent
+    # current_index or line number starting 0
+    attr_accessor :current_index
+    # cursor position on the line
+    attr_accessor :curpos
+    def initialize source, event, action_command, current_index, curpos
+      super source, event, action_command
+      @current_index = current_index
+      @curpos = curpos
+    end
+    # the text of the line on which the user is
+    def text
+      source.current_value.to_s
+    end
+    # the word under the cursor TODO
+    # if its a text with pipe delim, then ??
+    def word_under_cursor line=text(), pos=@curpos, delim=" "
+      line ||= text()
+      pos ||= @curpos
+      # if pressed on a space, try to go to next word to make easier 2013-03-24
+      if line[pos,1] == delim
+        while line[pos,1] == delim
+          pos += 1
+        end
+      end
+      finish = line.index(delim, pos)
+      start = line.rindex(delim,pos)
+      finish = -1 if finish.nil?
+      start = 0 if start.nil?
+      return line[start..finish]
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+=begin
+  * Name: ChangeEvent
+  * Description: Event used to notify interested parties that state of component has changed
+  * Author: jkepler (ABCD)
+  
+  --------
+  * Date: 2010-02-26 11:32 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+
+# Event created when state changed (as in ViewPort)
+module Canis
+  class ChangeEvent
+    attr_accessor :source
+    def initialize source
+      @source = source
+    end
+    def to_s
+      inspect
+    end
+    def inspect
+      "ChangeEvent #{@source}"
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# ----------------------------------------------------------------------------- #
+#         File: rhistory.rb
+#  Description: a module that pops up history, and then updates selected value
+#               This goes with Field.
+#               e.g.,
+#               field.extend(FieldHistory)
+#
+#               The module name History was throwing up errors
+#       Author: jkepler http://github.com/mare-imbrium/canis/
+#         Date: 2011-11-27 - 18:10
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2011-11-27 - 20:11
+# ----------------------------------------------------------------------------- #
+#
+# supply history for this object, at least give an empty array
+# widget would typically be Field,
+#  otherwise it should implement *text()* for getting and setting value
+#  and a *CHANGED* event for when user has modified a value and moved out
+# You can externally set $history_key to any unused key, otherwise it is M-h
+module Canis
+  extend self
+  module FieldHistory
+    def self.extended(obj)
+
+      obj.instance_exec {
+        @history ||= []
+        $history_key ||= ?\M-h
+        # ensure that the field is not overriding this in handle_key
+        bind_key($history_key) { _show_history }
+        # widget should have CHANGED event, or this will either give error, or just not work
+        # else please update history whenever you want a value to be retrieved
+        bind(:CHANGED) { @history << @text if @text && (!@history.include? @text) }
+      }
+    end
+
+    # pass the array of history values
+    # Trying out a change where an item can also be sent in.
+    # I am lost, i want the initialization to happen once.
+    def history arr
+      return @history unless arr
+      if arr.is_a? Array
+        @history = arr 
+      else
+        @history << arr unless @history.include? arr
+      end
+    end
+    def history=(x); history(x); end
+    
+    # pass in some configuration for histroy such as row and column to show popup on
+    def history_config config={}
+      @_history_config = config
+    end
+
+    # popup the hist 
+    # 
+    private
+    def _show_history
+      return unless @history
+      return  if @history.empty?
+      list = @history
+      @_history_config ||= {}
+      #list = ["No history"]  if @history.empty?
+      raise ArgumentError, "show_history got nil list" unless list
+      # calculate r and c
+      # col if fine, except for when there's a label.
+      wcol = 0 # taking care of when dialog uses history 2012-01-4 
+      wcol = self.form.window.left if self.form
+      c = wcol + ( @field_col || @col) # this is also dependent on window coords, as in a status_window or messagebox
+      sz = @history.size
+      wrow = 0
+      wrow = self.form.window.top if self.form
+      crow = wrow + @row
+      # if list can be displayed above, then fit it just above
+      if crow > sz + 2
+        r = crow - sz - 2
+      else
+        # else fit it in next row
+        r = crow + 1
+      end
+      #r = @row - 10
+      #if @row < 10
+        #r = @row + 1
+      #end
+      r = @_history_config[:row] || r
+      c = @_history_config[:col] || c
+      ret = popuplist(list, :row => r, :col => c, :title  => " History ")
+      if ret
+        self.text = list[ret] 
+        self.set_form_col 
+      end
+      @form.repaint if @form
+      @window.wrefresh if @window
+    end
+  end # mod History
+end # mod RubyC

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

@@ -0,0 +1,47 @@
+=begin
+  * Name: InputDataEvent
+  * Description: Event created when data modified in Field or TextEdit
+  * Author: jkepler (ABCD)
+  
+  --------
+  * Date:  2008-12-24 17:27 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+NOTE: this is how we used to write code in the Java days. Anyone reading this source,
+this is NOT how to code in rubyland. Please see this link, for how to code such as class:
+http://blog.grayproductions.net/articles/all_about_struct
+
+=end
+
+# Event created when data modified in Field or TextEdit
+#  2008-12-24 17:54 
+module Canis
+  class InputDataEvent
+    attr_accessor :index0, :index1, :source, :type, :row, :text
+    def initialize index0, index1, source, type, row, text
+      @index0 = index0
+      @index1 = index1
+      @source = source
+      @type = type
+      @row = row
+      @text = text
+    end
+    # until now to_s was returning inspect, but to make it easy for users let us return the value
+    # they most expect which is the text that was changed
+    def to_s
+      inspect
+    end
+    def inspect
+      ## now that textarea.to_s prints content we shouldn pass it here.
+      #"#{@type.to_s}, #{@source}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+      "#{@type.to_s}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+    end
+    # this is so that earlier applications were getting source in the block, not an event. they 
+    # were doing a fld.getvalue, so we must keep those apps running
+    # @since 1.2.0  added 2010-09-11 12:25 
+    def getvalue
+      @source.getvalue
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# ----------------------------------------------------------------------------- #
+#         File: textdocument.rb
+#  Description: Abstracts complex text preprocessing and rendering from TextPad
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-06-25 - 12:52
+#      License: MIT
+#  Last update: 2014-07-08 13:11
+# ----------------------------------------------------------------------------- #
+#  textdocument.rb  Copyright (C) 2012-2014 j kepler
+
+module Canis
+  # In an attempt to keep TextPad simple, and move complexity of complex content out of it,
+  #  I am trying to move specialized processing and rendering to a Document class which manages the same.
+  #  I would also like to keep content, and content_type etc together. This should percolate to multibuffers
+  #  to.
+  #  An application may create a TextDocument object and pass it to TextPad using the +text+ method.
+  #  Or an app may send in a hash, which +text+ uses to create this object.
+  class TextDocument
+    attr_accessor :content_type
+    attr_accessor :stylesheet
+    # +hash+ of options passed in constructor including content_type and stylesheet
+    attr_accessor :options
+    # +text+ is the original Array<String> which contains markup of some sort
+    #  which source will retrieve. Changes happen to this (row added, deleted, changed)
+    attr_accessor :text
+
+    # returns the native or transformed format of original content. +text+ gets transformed into
+    #  native text. The renderer knows how to display native_text.
+    #attr_reader :native_text
+    def native_text
+      unless @native_text
+        preprocess_text @text
+      end
+      return @native_text
+    end
+    # specify a renderer if you do not want the DefaultRenderer to be installed.
+    attr_accessor :renderer
+    attr_reader :source
+
+    def initialize hash
+      @parse_required = true
+      @options = hash
+      @content_type = hash[:content_type]
+      @stylesheet = hash[:stylesheet]
+      @text = hash[:text]
+      $log.debug "  TEXTDOCUMENT created with #{@content_type} , #{@stylesheet} "
+      raise "textdoc recieves nil content_type in constructor" unless @content_type
+    end
+    # declare that transformation of entire content is required. Currently called by fire_dimension_changed event
+    #  of textpad.
+    def parse_required
+      @parse_required = true
+    end
+    # set the object that is using this textdocument (typically TextPad).
+    # This allows us to bind to events such as adding or deleting a row, or modification of data.
+    def source=(sou)
+      @source = sou
+      if @renderer
+        @source.renderer = @renderer
+      end
+      @source.bind :ROW_CHANGED  do | o, ix|  parse_line ix ; end
+      @source.bind :DIMENSION_CHANGED do | o, _meth|  parse_required() ; end
+      @source.title = self.title() if self.title()
+    end
+    # if there is a content_type specfied but nothing to handle the content
+    #  then we create a default handler.
+    def create_default_content_type_handler
+      raise "source is nil in textdocument" unless @source
+      require 'canis/core/include/colorparser'
+      # cp will take the content+type from self and select actual parser
+      cp = Chunks::ColorParser.new @source
+      @content_type_handler = cp
+    end
+    # called by textpad to do any parsing or conversion on data since a textdocument by default
+    # does some transformation on the content
+    def preprocess_text data
+      parse_formatted_text data
+    end
+    # transform a given line number from original content to internal format.
+    # Called by textpad when a line changes (update)
+    def parse_line(lineno)
+      @native_text[lineno] = @content_type_handler.parse_line( @list[lineno]) 
+    end
+    # This is now to be called at start when text is set,
+    # and whenever there is a data modification.
+    # This updates @native_text
+    # @param [Array<String>] original content sent in by user
+    #     which may contain markup
+    # @param [Hash] config containing
+    #    content_type
+    #    stylesheet
+    # @return [Chunklines] content in array of chunks.
+    def parse_formatted_text(formatted_text, config=nil)
+      return unless @parse_required
+
+      unless @content_type_handler
+        create_default_content_type_handler
+      end
+      @parse_required = false
+      @native_text = @content_type_handler.parse_text formatted_text
+    end
+    # returns title of document
+    def title
+      return @options[:title]
+    end
+    # set title of document (to be displayed by textpad)
+    def title=(t)
+      @options[:title] = t
+    end
+  end
+end # mod