rbcurse 1.4.1 → 1.5.0.pre1

data/lib/rbcurse/keylabelprinter.rb

@@ -1,178 +0,0 @@
-require 'rbcurse/rwidget'
-#include Ncurses # FFI 2011-09-8 
-include RubyCurses
-module RubyCurses
-  #
-  # This paints labels for various keys at the bottom of the screen, in 2 rows. 
-  # This is based on alpines last 2 rows. Modes are supported so that the 
-  # labels change as you enter a widget.
-  # For an example, see dbdemo.rb or rfe.rb
-  # NOTE: applications using 'App' use a shortcut "dock" to create this.
-  #
-  # The most minimal keylabel to print one label in first row, and none in second is:
-  #     [["F1", "Help"], nil]
-  # To print 2 labels, one over the other:
-  #     [["F1", "Help"], ["F10", "Quit"]]
-  #
-  class KeyLabelPrinter < Widget
-    attr_reader :key_labels
-    # the current mode (labels are based on mode, changing the mode, changes the labels
-    #  displayed)
-    dsl_property :mode
-    # set the color of the labels, overriding the defaults
-    dsl_accessor :footer_color_pair
-    # set the color of the mnemonic, overriding the defaults
-    dsl_accessor :footer_mnemonic_color_pair
-
-    def initialize form, key_labels, config={}, &block
-
-      case key_labels
-      when Hash
-        raise "KeyLabelPrinter: KeyLabels cannot be a hash, Array of key labels required. Perhaps you did not pass labels"
-      when Array
-      else
-        raise "KeyLabelPrinter: Array of key labels required. Perhaps you did not pass labels"
-      end
-      super form, config, &block
-      @mode ||= :normal
-      #@key_labels = key_labels
-      @key_hash = {}
-      @key_hash[@mode] = key_labels
-      @editable = false
-      @focusable = false
-      @cols ||= Ncurses.COLS-1
-      @row ||= Ncurses.LINES-2
-      @col ||= 0
-      @repaint_required = true
-      @footer_color_pair ||= $bottomcolor
-      @footer_mnemonic_color_pair ||= $reversecolor #2
-    end
-    def key_labels mode=@mode
-      @key_hash[mode] 
-    end
-    # returns the keys as printed. these may or may not help
-    # in validation depedign on what you passed as zeroth index
-    def get_current_keys
-      a = []
-      @key_hash[@mode].each do |arr|
-        a << arr[0] unless arr.nil?
-      end
-      return a
-    end
-    def getvalue
-      @key_hash
-    end
-    def set_key_labels _key_labels, mode=:normal
-      @key_hash[mode] = _key_labels
-    end
-
-    ##
-    # XXX need to move wrapping etc up and done once. 
-    def repaint
-      return unless @repaint_required
-      r,c = rowcol
-      arr = key_labels()
-      print_key_labels(arr, mode=@mode)
-      @repaint_required = false
-    end
-    # ?? does not use mode, i think key_labels is unused. a hash is now used 2011-10-11 XXX FIXME
-    # WARNING, i have not tested this after changing it. 
-    def append_key_label key, label, mode=@mode
-      #@key_labels << [key, label] if !@key_labels.include? [key, label]
-      @key_hash[mode] << [key, label] if !@key_hash[mode].include? [key, label]
-      @repaint_required = true
-    end
-    def print_key_labels(arr = key_labels(), mode=@mode)
-      #return if !@show_key_labels # XXX
-      @win ||= @form.window
-      $log.debug "XXX: PKL #{arr.length}, #{arr}"
-      @padding = @cols / (arr.length/2)
-      posx = 0
-      even = []
-      odd = []
-      arr.each_index { |i|
-        if i % 2 == 0
-          #arr[i+1] = ['',''] if arr[i+1].nil?
-          nextarr = arr[i+1] || ['', '']
-          keyw = [arr[i][0].length, nextarr[0].length].max
-          labelw = [arr[i][1].length, nextarr[1].length].max
-
-          even << [ sprintf("%*s", keyw,  arr[i][0]), sprintf("%-*s", labelw,  arr[i][1]) ]
-          odd << [ sprintf("%*s", keyw,  nextarr[0]), sprintf("%-*s", labelw,  nextarr[1]) ]
-          #$log.debug("loop even: #{even.inspect}")
-        else
-        end
-      }
-      #$log.debug("even: #{even.inspect}")
-      #$log.debug("odd : #{odd.inspect}")
-      #posy = @barrow-1
-      posy = @row
-      print_key_labels_row(posy, posx, even)
-      posy = @row+1
-      print_key_labels_row(posy, posx, odd)
-      # uncommented next line after ffi-ncurses else not showing till key press FFI 2011-09-17 
-      @win.wrefresh   # needed else secod row not shown after askchoice XXX 
-    end
-    def print_key_labels_row(posy, posx, arr)
-      # FIXME: this logic of padding needs to take into account
-      # width of window
-      padding = 8
-      padding = 4 if arr.length > 5
-      padding = 2 if arr.length > 7
-      padding = 0 if arr.length > 9
-      #padding = @padding # XXX 2008-11-13 23:01 
-      my_form_win = @win
-      @win.printstring(posy,0, "%-*s" % [@cols," "], @footer_color_pair, @attr)
-      arr.each do |kl|
-        key = kl[0]
-        lab = kl[1]
-        if key !="" # don't print that white blank space for fillers
-          color_pair= @footer_mnemonic_color_pair # $reversecolor #2
-          x = posx +  (key.length - key.strip.length)
-          my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
-          my_form_win.mvprintw(posy, x, "%s" % kl[0].strip );
-          my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
-        end
-        color_pair=@footer_color_pair
-        posx = posx + kl[0].length 
-        my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
-
-        #lab = sprintf(" %s %*s" , kl[1], padding, " ");
-        lab = sprintf(" %s %s" , kl[1], " "*padding);
-        my_form_win.mvprintw(posy, posx, lab)
-        my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
-        posx = posx +  lab.length
-      end
-    end
-    ##
-    # updates existing label with a new one.
-    # @return true if updated, else false
-    # @example update "C-x", "C-x", "Disable"
-    def update_application_key_label(display_code, new_display_code, text)
-      @repaint_required = true
-      labels = key_labels()
-      raise "labels are nil !!!" unless labels
-      labels.each_index do |ix|
-        lab = labels[ix]
-        next if lab.nil?
-        if lab[0] == display_code
-          labels[ix] = [new_display_code , text]
-          $log.debug("updated #{labels[ix]}")
-          return true
-        end
-      end
-      return false
-    end
-    alias :update :update_application_key_label
-    ##
-    # inserts an application label at given index
-    # to add the key, use create_datakeys to add bindings
-    # remember to call restore_application_key_labels after updating/inserting
-    def insert_application_key_label(index, display_code, text)
-      @repaint_required = true
-      labels = key_labels()
-      labels.insert(index, [display_code , text] )
-    end
-    # ADD HERE KEYLABEL
-  end
-end

data/lib/rbcurse/listcellrenderer.rb

@@ -1,140 +0,0 @@
-require 'rbcurse/rwidget'
-module RubyCurses
-
-  ## 
-  #  2010-09-27 11:06 : i have modified this quite a bit, to calculate some stuff
-  #  once in the init, to reduce work in repaint
-  # This is a basic list cell renderer that will render the to_s value of anything.
-  # Using alignment one can use for numbers too.
-  # However, for booleans it will print true and false. If editing, you may want checkboxes
-  # NOTE: this class is being extended by many other classes. Careful while making
-  # sweeping changes.
-  class ListCellRenderer
-    include RubyCurses::ConfigSetup
-    include RubyCurses::Utils
-    dsl_accessor :justify     # :right, :left, :center  # added 2008-12-22 19:02 
-    dsl_accessor :display_length     #  please give this to ensure the we only print this much
-    dsl_accessor :height    # if you want a multiline label.
-    dsl_accessor :text    # text of label
-    dsl_accessor :color, :bgcolor
-    dsl_accessor :row, :col
-    dsl_accessor :parent    #usuall the table to get colors and other default info
-
-    def initialize text="", config={}, &block
-      @text = text
-      @editable = false
-      @focusable = false
-      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
-      instance_eval &block if block_given?
-      init_vars
-    end
-    # NOTE: please call super() if you override this
-    def init_vars  #:nodoc:
-      # omg, some classes won't have justify !!
-      #@justify ||= (@parent.justify || :left)
-      unless @justify
-        if @parent.respond_to? :justify
-          @justify ||= (@parent.justify || :left)
-        else
-          @justify ||= :left
-        end
-      end
-      @format = @justify.to_sym == :right ? "%*s" : "%-*s"  
-      @display_length ||= 10
-      # create color pairs once for this 2010-09-26 20:53 
-    end
-    # creates pairs of colors at start
-    # since often classes are overriding init_vars, so not gettin created
-    def create_color_pairs
-      @color_pair = get_color $datacolor
-      @pairs = Hash.new(@color_pair)
-      @attrs = Hash.new(Ncurses::A_NORMAL)
-      color_pair = get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor
-      @pairs[:normal] = @color_pair
-      @pairs[:selected] = color_pair
-      @pairs[:focussed] = @pairs[:normal]
-      @attrs[:selected] = $row_selected_attr
-      @attrs[:focussed] = $row_focussed_attr
-
-    end
-    def getvalue
-      @text
-    end
-    ##
-    # sets @color_pair and @attr
-    def select_colors focussed, selected
-      create_color_pairs unless @pairs
-      raise ArgumentError, "pairs hash is null. Changes have happened in listcellrenderer" unless @pairs
-      @color_pair = @pairs[:normal]
-      #@attr = $row_attr
-      @attr = @row_attr || $row_attr # changed 2011-10-15 since we seem to be ignoring row_attr changes
-      # give precedence to a selected row
-      if selected
-        @color_pair = @pairs[:selected]
-        @attr       = @attrs[:selected]
-      elsif focussed
-        @color_pair = @pairs[:focussed]
-        @attr       = @attrs[:focussed]
-      end
-    end
-
-    ##
-    #  paint a list box cell
-    #
-    #  @param [Buffer] window or buffer object used for printing
-    #  @param [Fixnum] row
-    #  @param [Fixnum] column
-    #  @param [Fixnum] actual index into data, some lists may have actual data elsewhere and
-    #                  display data separate. e.g. rfe_renderer (directory listing)
-    #  @param [String] text to print in cell
-    #  @param [Boolean, cell focussed, not focussed
-    #  @param [Boolean] cell selected or not
-    def repaint graphic, r=@row,c=@col, row_index=-1,value=@text, focussed=false, selected=false
-
-      select_colors focussed, selected 
-      # if listboxes width is reduced, display_len remains the same
-      # XXX FIXME parent may not be the list but a container like rfe !!
-      # maybe caller should update at start of repain loop.
-      #@display_length = @parent.width - 2 - @parent.left_margin
-
-      value=value.to_s
-      if !@display_length.nil?
-        if value.length > @display_length
-          value = value[0..@display_length-1]
-        end
-        # added 2010-09-27 11:05 TO UNCOMMENT AND TEST IT OUT
-        if @justify == :center
-          value = value.center(@display_length)
-        end
-      end
-      len = @display_length || value.length
-      #$log.debug " XXX @display_length: #{@display_length}, #{value.length}, L:#{len}, pw:#{@parent.width} ::attr:: #{@attr} "
-      graphic.printstring r, c, @format % [len, value], @color_pair, @attr
-    end # repaint
-
-    # @deprecated
-    # only for older code that may have extended this.
-    def prepare_default_colors focussed, selected
-        @color_pair = get_color $datacolor
-        @attr = @row_attr || Ncurses::A_NORMAL
-
-
-        ## determine bg and fg and attr
-        if selected
-          @attr = Ncurses::A_BOLD if selected
-          @color_pair =get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor unless @parent.nil?
-        end
-        case focussed
-        when :SOFT_FOCUS
-          @attr |= Ncurses::A_BOLD
-        when true
-          @attr |= Ncurses::A_REVERSE
-        when false
-        end
-        #if focussed 
-          #@attr |= Ncurses::A_REVERSE
-        #end
-    end
-  end # class
-
-end # module

data/lib/rbcurse/listeditable.rb

@@ -1,310 +0,0 @@
-# Some methods for manipulating lists
-# Different components may bind different keys to these
-# Currently will be called by TextArea and the editable version
-# of TextView (vieditable).
-#
-require 'rbcurse/rinputdataevent'
-module ListEditable
-
-    def remove_all
-      @list = []
-      set_modified  # added 2009-02-13 22:28 so repaints
-    end
-    # current behav is a mix of vim's D and C-k from alpine, i don;t know how i screwed it up like this
-    # Should be:
-    # 1. do not take cursor back by 1 (this is vims D behavior)
-    # 2. retain EOL, we need to evaluate at undo
-    # 3. if nothing coming in delete buffer then join next line here
-    # 4. if line is blank, it will go to delete line (i think).
-    # Earlier, a C-k at pos 0 would blank the line and not delete it (copied from alpine).
-    # The next C-k would delete. emacs deletes if C-k at pos 0.
-    def delete_eol
-      return -1 unless @editable
-      pos = @curpos -1 # retain from 0 till prev char
-      @delete_buffer = @buffer[@curpos..-1]
-      # currently eol is there in delete_buff often. Should i maintain it ? 2010-03-08 18:29 UNDO
-      #@delete_buffer.chomp! # new 2010-03-08 18:29 UNDO - this worked but hope does not have othe impact
-
-      # if pos is 0, pos-1 becomes -1, end of line!
-      @list[@current_index] = pos == -1 ? "" : @buffer[0..pos]
-      $log.debug "delete EOL :pos=#{pos}, #{@delete_buffer}: row: #{@list[@current_index]}:"
-      @buffer = @list[@current_index]
-      if @delete_buffer == ""
-        $log.debug " TA: DELETE going to join next "
-        join_next_line # pull next line in
-      end
-      oldcur = @curpos
-      #x cursor_backward if @curpos > 0 #  this was vims behavior -- knoecked off
-      #fire_handler :CHANGE, self  # 2008-12-09 14:56 
-      fire_handler :CHANGE, InputDataEvent.new(oldcur,oldcur+@delete_buffer.length, self, :DELETE, @current_index, @delete_buffer)     #  2008-12-24 18:34 
-      set_modified 
-      return @delete_buffer
-    end
-    def join_next_line
-      # return if last line  TODO
-      buff = @list.delete_at(@current_index + 1)
-      if buff
-        $log.debug " TA: DELETE inside to join next #{buff}  "
-        fire_handler :CHANGE, InputDataEvent.new(0,0+buff.length, self, :DELETE_LINE, @current_index+1, buff)  
-        @buffer << buff
-      end
-    end
-  # deletes given line or current
-  # now fires DELETE_LINE so no guessing by undo manager
-  def delete_line line=@current_index
-    return -1 unless @editable
-    if !$multiplier or $multiplier == 0 
-      @delete_buffer = @list.delete_at line
-    else
-      @delete_buffer = @list.slice!(line, $multiplier)
-    end
-    $multiplier = 0
-    add_to_kill_ring @delete_buffer
-    @buffer = @list[@current_index]
-    if @buffer.nil?
-      up
-      setrowcol @row + 1, nil # @form.col
-    end
-    # warning: delete buffer can now be an array
-    fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE_LINE, line, @delete_buffer)     #  2008-12-24 18:34 
-    set_modified 
-  end
-    def delete_curr_char num=($multiplier == 0 ? 1 : $multiplier)
-      return -1 unless @editable
-      delete_at @curpos, num # changed so only one event, and one undo
-      set_modified 
-      $multiplier = 0
-    end
-    # 
-    # 2010-03-08 23:30 does not seem to be working well when backspacing at first char of line
-    # FIXME should work as a unit, so one undo and one fire_handler, at least if on one line.
-    def delete_prev_char num=($multiplier == 0 ? 1 : $multiplier)
-      return -1 if !@editable 
-      num.times do
-        if @curpos <= 0
-          join_to_prev_line
-          return
-        end
-        @curpos -= 1 if @curpos > 0
-        delete_at
-        set_modified 
-        addcol -1
-      end
-      $multiplier = 0
-    end
-    # open a new line and add chars to it.
-    # FIXME does not fire handler, thus won't undo
-    def append_row lineno=@current_index, chars=""
-        $log.debug "append row sapce:#{chars}."
-      @list.insert lineno+1, chars
-    end
-    ##
-    # delete character/s on current line
-    def delete_at index=@curpos, howmany=1
-      return -1 if !@editable 
-      $log.debug "delete_at (characters) : #{@current_index} #{@buffer} #{index}"
-      char = @buffer.slice!(@curpos,howmany)  # changed added ,1 and take char for event
-      # if no newline at end of this then bring up prev character/s till maxlen
-      # NO WE DON'T DO THIS ANYLONGER 2008-12-26 21:09 lets see
-=begin
-      if @buffer[-1,1]!="\r"
-        @buffer[-1]=" " if @buffer[-1,1]=="\n"
-        if !next_line.nil? and next_line.length > 0
-          move_chars_up
-        end
-      end
-=end
-      set_modified true
-      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+howmany, self, :DELETE, @current_index, char)     #  2008-12-24 18:34 
-    end
-    def undo_handler(uh)
-      @undo_handler = uh
-    end
-    ## THIS ONE SHOULD BE IN TEXTVIEW ALSO
-    # saves current or n lines into kill ring, appending to earlier contents
-    # Use yank (paste) or yank-pop to retrieve
-    def kill_ring_save
-      pointer = @current_index
-      list = []
-      repeatm {
-        line =  @list[pointer] 
-        list << line unless line.nil?
-        pointer += 1
-      }
-      add_to_kill_ring list
-    end
-    ## THIS ONE SHOULD BE IN TEXTVIEW ALSO
-    # add given line or lines to kill_ring
-    def add_to_kill_ring list
-      # directly referenceing kill_ring.  We need to OO it a bit, so we can change internals w'o breaking all.
-      # FIXME
-      if $append_next_kill
-        # user requested this kill to be appened to last kill, so it can be yanked as one
-        #$kill_ring.last << list
-        last = $kill_ring.pop 
-        $log.debug "YANK: addto : last= #{last} , list= #{list} "
-        case list
-        when Array
-          #list.insert 0, last
-          list.insert 0, *last # 2011-10-10 changed as it was wrong in textarea
-          $kill_ring << list
-        when String
-          $kill_ring << [last, list]
-        end
-      else
-        $kill_ring << list
-      end
-      $kill_ring_pointer = $kill_ring.size
-      $append_next_kill = false
-      $log.debug "YANK: kill_ring: #{$kill_ring} "
-    end
-
-    # pastes recent (last) entry of kill_ring.
-    # This can be one or more lines. Please note that for us vimmer's yank means copy
-    # but for emacsers it seems to mean paste. Aargh!!
-    def yank where=@current_index
-      return -1 if !@editable 
-      return if $kill_ring.empty?
-      row = $kill_ring.last
-      $log.debug "YANK: row #{row} "
-      index = where
-      case row
-      when Array
-        #index = @current_index
-        row.each{ |r|
-          @list.insert index, r.dup
-          index += 1
-        }
-        $kill_last_pop_size = row.size
-      when String
-        #@list[@current_index].insert row.dup
-        #@list.insert @current_index, row.dup
-        @list.insert index, row.dup
-        $kill_last_pop_size = 1
-      else
-        raise "textarea yank got uncertain datatype from kill_ring  #{row.class} "
-      end
-      $kill_ring_pointer = $kill_ring.size - 1
-      $kill_ring_index = @current_index # pops will replace data in this row, never an insert
-      @repaint_required = true
-      # XXX not firing anything here, so i can't undo. yet, i don't know whether a yank will
-      # be followed by a yank-pop, in which case it will not be undone.
-      # object row can be string or array - time to use INSERT_LINE so we are clear
-      # row.length can be array's size or string length - beware
-      fire_handler :CHANGE, InputDataEvent.new(0,row.length, self, :INSERT_LINE, @current_index, row)
-    end
-
-    # paste previous entries from kill ring
-    # I am not totally clear on this, not being an emacs user. but seems you have to do C-y
-    # once (yank) before you can do a yank pop. 
-    def yank_pop
-      return -1 if !@editable 
-      return if $kill_ring.empty?
-      mapped_key = @current_key # we are mapped to this
-      # checking that user has done a yank on this row. We only replace on the given row, never
-      # insert. But what if user edited after yank, Sheesh ! XXX
-      if $kill_ring_index != @current_index
-        Ncurses.beep
-        return # error message required that user must yank first
-      end
-      # the real reason i put this into a loop is so that i can properly undo the
-      # action later if required. I only need to store the final selection.
-      # This also ensures the user doesn't wander off in between and come back.
-      row = nil
-      while true
-        # remove lines from last replace, then insert
-        index = @current_index
-        $kill_last_pop_size.times {
-          del = @list.delete_at index
-        }
-        row = $kill_ring[$kill_ring_pointer-$multiplier]
-        $multiplier = 0
-        index = @current_index
-        case row
-        when Array
-          row.each{ |r|
-            @list.insert index, r.dup
-            index += 1
-          }
-          $kill_last_pop_size = row.size
-        when String
-          @list.insert index, row.dup
-          $kill_last_pop_size = 1
-        else
-          raise "textarea yank_pop got uncertain datatype from kill_ring  #{row.class} "
-        end
-
-        $kill_ring_pointer -= 1
-        if $kill_ring_pointer < 0
-          # should be size, but that'll give an error. need to find a way!
-          $kill_ring_pointer = $kill_ring.size - 1
-        end
-        @repaint_required = true
-        my_win = @form || @parent_component.form # 2010-02-12 12:51 
-        my_win.repaint
-        ch = @graphic.getchar
-        if ch != mapped_key
-          @graphic.ungetch ch # seems to work fine
-          return ch # XXX to be picked up by handle_key loop and processed
-        end
-      end
-      # object row can be string or array - time to use INSERT_LINE so we are clear
-      # row.length can be array's size or string length - beware
-      fire_handler :CHANGE, InputDataEvent.new(0,row.length, self, :INSERT_LINE, @current_index, row)
-      return 0
-    end
-    def append_next_kill
-      $append_next_kill = true
-    end
-    # deletes count words on current line
-    # Does not at this point go beyond the line
-    def delete_word
-      return -1 unless @editable
-      $multiplier = 1 if !$multiplier or $multiplier == 0 
-      line = @current_index
-      pos = @curpos
-      @delete_buffer = ""
-      # currently only look in current line
-      $multiplier.times {
-        found = @buffer.index(/[[:punct:][:space:]]/, pos)
-        break if !found
-        $log.debug " delete_word: pos #{pos} found #{found} buff: #{@buffer} "
-        @delete_buffer << @buffer.slice!(pos..found)
-      }
-      return if @delete_buffer == ""
-      $log.debug " delete_word: delbuff #{@delete_buffer} "
-      add_to_kill_ring @delete_buffer
-      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE, line, @delete_buffer)     #  2008-12-24 18:34 
-      set_modified 
-    end
-    ##
-    # deletes forward till the occurence of a character
-    # it gets the char from the user
-    # Should we pass in the character (and accept it as a separate func) ???
-    def delete_forward
-      return -1 unless @editable
-      ch = @graphic.getchar
-      return if ch < 0 || ch > 255
-      char = ch.chr
-      $multiplier = 1 if !$multiplier or $multiplier == 0 
-      line = @current_index
-      pos = @curpos
-      tmpbuf = ""
-      # currently only look in current line
-      $multiplier.times {
-        found = @buffer.index(char, pos)
-        break if !found
-        #$log.debug " delete_forward: pos #{pos} found #{found} buff: #{@buffer} "
-        # ideally do this in one shot outside loop, but its okay here for now
-        tmpbuf << @buffer.slice!(pos..found)
-      }
-      return if tmpbuf == ""
-      @delete_buffer = tmpbuf
-      $log.debug " delete_forward: delbuff #{@delete_buffer} "
-      add_to_kill_ring @delete_buffer
-      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE, line, @delete_buffer)     #  2008-12-24 18:34 
-      set_modified 
-      $multiplier = 0
-    end
-
-end # end module