# ----------------------------------------------------------------------------- #
#         File: rcombo.rb
#  Description: Non-editable combo box.
#               Make it dead-simple to use.
#               This is a simpler version of the original ComboBox which allowed
#               editing and used rlistbox. This simpler class is meant for the rbhex
#               core package and will only depend on a core class if at all.
#       Author: rkumar http://github.com/rkumar/rbcurse/
#         Date: 2011-11-11 - 21:42
#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
#  Last update: 2014-03-24 16:42
# ----------------------------------------------------------------------------- #
#
require 'rbhex/core'

include Rbhex
module Rbhex
  extend self

  # the quick approach would be to use field, and just add a popup.
  # Or since we are not editing, we could use a Label and a popup
  # Or just display a label and a popup without using anything else.
  # Thre is an undocumented variable +display_length+ which is the size of the label
  #  This is used to position the combo symbol and the popup. This can be calculated
  #  based on the label. 2014-03-24 - 16:42

  class ComboBox < Field
    include Rbhex::EventHandler
    dsl_accessor :list_config

    attr_accessor :current_index
    # the symbol you want to use for combos
    attr_accessor :COMBO_SYMBOL
    attr_accessor :show_symbol # show that funny symbol after a combo to signify its a combo
    dsl_accessor :arrow_key_policy   # :IGNORE :NEXT_ROW :POPUP

    def initialize form, config={}, &block
      @arrow_key_policy = :ignore
      @editable         = false
      #@COMBO_SYMBOL = "v".ord  # trying this out
      # thanks hramrach for fix
      if RUBY_VERSION < "1.9" then
        @COMBO_SYMBOL = "v"[0]  # trying this out
      else
        @COMBO_SYMBOL = "v".ord  # trying this out
      end
      @current_index    = 0
      super
      ## this was getting overridden this making the combo editable 2014-03-24 - 16:24
      @editable         = false
      # added if  check since it was overriding set_buffer in creation. 2009-01-18 00:03
      set_buffer @list[@current_index].dup if @buffer.nil? or @buffer.empty?
      init_vars
      @_events.push(*[:CHANGE, :ENTER_ROW, :LEAVE_ROW])
    end
    def init_vars
      super
      @show_symbol = true if @show_symbol.nil? # if set to false don't touch
      #@show_symbol = false if @label # 2011-11-13
      @COMBO_SYMBOL ||= FFI::NCurses::ACS_DARROW #GEQUAL

      # next 2 lines giving an error in newtabbedwindow.rb example since the methods
      # have been deprecated.
      #bind_key(KEY_UP) { previous_row }
      #bind_key(KEY_DOWN) { next_row }
    end
    def selected_item
      @list[@current_index]
    end
    def selected_index
      @current_index
    end

    ##
    # convert given list to datamodel
    def list alist=nil
      return @list if alist.nil?
      #@list = Rbhex::ListDataModel.new(alist)
      @list = alist
    end
    ##
    # combo edit box key handling
    # removed UP and DOWN and bound it, so it can be unbound
    def handle_key(ch)
      @current_index ||= 0
      # added 2009-01-18 22:44 no point moving horiz or passing up to Field if not edit
      if !@editable
        if ch == KEY_LEFT or ch == KEY_RIGHT
          return :UNHANDLED
        end
      end
      case @arrow_key_policy
      when :ignore
        if ch == KEY_DOWN or ch == KEY_UP
          return :UNHANDLED
        end
      when :popup
        if ch == KEY_DOWN or ch == KEY_UP
          popup
        end
      end
      case ch
      #when KEY_UP  # show previous value
      #  previous_row
      #when KEY_DOWN  # show previous value
      #  next_row
        # adding spacebar to popup combo, as in microemacs 2010-10-01 13:21
      when 32, KEY_DOWN+ META_KEY # alt down
        popup  # pop up the popup
      else
        super
      end
    end
    def DEPprevious_row
      @current_index -= 1 if @current_index > 0
      set_buffer @list[@current_index].dup
      set_modified(true)  ## ??? not required
      fire_handler :ENTER_ROW, self
      @list.on_enter_row self
    end
    def DEPnext_row
      @current_index += 1 if @current_index < @list.length()-1
      set_buffer @list[@current_index].dup
      set_modified(true)  ## ??? not required
      fire_handler :ENTER_ROW, self
      @list.on_enter_row self
    end
    ##
    # calls a popup list
    # TODO: should not be positioned so that it goes off edge
    # user's customizations of list should be passed in
    # The dup of listconfig is due to a tricky feature/bug.
    # I try to keep the config hash and instance variables in synch. So
    # this config hash is sent to popuplist which updates its row col and
    # next time we pop up the popup row and col are zero.
    #
    #
    # added dup in PRESS since editing edit field mods this
    # on pressing ENTER, value set back and current_index updated
    def popup
      @list_config ||= {}
      @list_config[:row] ||= @row
      #@list_config[:col] ||= @col
      @list_config[:col] ||= @col + @display_length
      @list_config[:relative_to] ||= self
      # this does not allow us to bind to events in the list
      index = popuplist @list, @list_config
      if index
        set_buffer @list[index].dup
        set_modified(true) if @current_index != index
        @current_index = index
      end
    end
    def OLDpopup
      listconfig = (@list_config && @list_config.dup) || {}
      dm = @list
      # current item in edit box will be focussed when list pops up
      #$log.debug "XXX POPUP: #{dm.selected_index} = #{@current_index}, value #{@buffer}"
      # we are having some problms when using this in a list. it retains earlier value
      _index = dm.index @buffer
      dm.selected_index = _index #  @current_index
      poprow = @row+0 # one row below the edit box
      popcol = @col
      dlength = @display_length
      f = self
      @popup = Rbhex::PopupList.new do
        row  poprow
        col  popcol
        width dlength
        list_data_model dm
        list_selection_mode 'single'
        relative_to f
        list_config listconfig
        bind(:PRESS) do |index|
          f.set_buffer dm[index].dup
          f.set_modified(true) if f.current_index != index
          f.current_index = index
        end
      end
    end

    # Field putc advances cursor when it gives a char so we override this
    def putc c
      if c >= 0 and c <= 127
        ret = putch c.chr
        if ret == 0
          addcol 1 if @editable
          set_modified
        end
      end
      return -1 # always ??? XXX
    end
    ##
    # field does not give char to non-editable fields so we override
    def putch char
      @current_index ||= 0
      if @editable
        raise "how is it editable here in combo"
        super
        return 0
      else
        match = next_match(char)
        set_buffer match unless match.nil?
        fire_handler :ENTER_ROW, self
      end
      @modified = true
      fire_handler :CHANGE, self    # 2008-12-09 14:51  ???
      0
    end
    ##
    # the sets the next match in the edit field
    def next_match char
      start = @current_index
      start.upto(@list.length-1) do |ix|
        if @list[ix][0,1].casecmp(char) == 0
          return @list[ix] unless @list[ix] == @buffer
        end
        @current_index += 1
      end
      ## could not find, start from zero
      @current_index = 0
      start = [@list.length()-1, start].min
      0.upto(start) do |ix|
        if @list[ix][0,1].casecmp(char) == 0
          return @list[ix] unless @list[ix] == @buffer
        end
        @current_index += 1
      end
      @current_index = [@list.length()-1, @current_index].min
      return nil
    end
    ##
    # on leaving the listbox, update the combo/datamodel.
    # we are using methods of the datamodel. Updating our list will have
    # no effect on the list, and wont trigger events.
    # Do not override.
    def on_leave
      fire_handler :LEAVE, self
    end

    def repaint
      super
      c = @col + @display_length
      if @show_symbol # 2009-01-11 18:47
        # i have changed c +1 to c, since we have no right to print beyond display_length
        @form.window.mvwaddch @row, c, @COMBO_SYMBOL # Ncurses::ACS_GEQUAL
        @form.window.mvchgat(y=@row, x=c, max=1, Ncurses::A_REVERSE|Ncurses::A_UNDERLINE, $datacolor, nil)
      end
    end

  end # class ComboBox

end # module