svn/view/window.rb

# window.rb: the module definition of Edmaru::Window.
#
# Copyright (C) 2007 Takashi Nakamoto
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA.
#

require "cursor.rb"
require "modeline.rb"

module Edmaru

  #Abstract class to implement system specific window.
  module Window

    #Construct a window instance.
    #
    #=== Arguments
    #_view_ :: The parent view.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Return
    #An initialized instance of Window.
    def initialize(view)
      @view = view
      @cursor = Cursor.new(0, 0)
      @modeline = Edmaru::SYSTEM_MODELINE.new(self)

      init_ui
    end

    #The system specific initialization for this window.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def init_ui
    end

    #Discard the current buffer and set the specified new buffer.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_new_buffer_ :: The buffer to be shown in this window.
    def buffer=(new_buffer)
      if @buffer != nil
        @buffer.unlink(self)
      end

      #Linked buffer to this window.
      @buffer = new_buffer
      @buffer.link(self)
      refresh
    end

    def buffer
      @buffer
    end

    def modeline
      @modeline
    end

    #Insert the specified string to the buffer shown in this window.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_str_ :: String to be inserted.
    #_move_cursor_ :: _true_ to cause the cursor move to the end of the
    #inserted string.
    def insert_at_cursor(str, move_cursor = true)
      #Insert to the buffer.
      @buffer.insert(@cursor.row, @cursor.column, str)

      #Move the cursor to the end of inserted string.
      if move_cursor
        str.size.times{ |n|
          cursor_forward
        }
      end

      refresh
    end

    #Move the cursor forward.
    #
    #=== Argument
    #_n_ :: the number of times to forward the cursor.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def cursor_forward(n = 1)
      n.times{
        if @cursor.column >= @buffer.lines[@cursor.row].size &&
            @cursor.row == (@buffer.lines.size - 1)
          #ToDo: Alert that the cursor is at the end of this buffer.
          @view.beep
        elsif @cursor.column >= @buffer.lines[@cursor.row].size
          #Go to the begin of the next line
          @cursor.row += 1
          @cursor.column = 0
        else
          @cursor.column += 1
        end
      }

      refresh_cursor
    end

    #Move the cursor backward.
    #
    #=== Argument
    #_n_ :: the number of times to backward the cursor.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def cursor_backward(n = 1)
      n.times{
        if @cursor.column == 0 && @cursor.row == 0
          #ToDo: Alert that the cursor is at the begin of this buffer.
          @view.beep
        elsif @cursor.column == 0
          @cursor.row -= 1
          @cursor.column = @buffer.lines[@cursor.row].size
        else
          @cursor.column -= 1
        end
      }

      refresh_cursor
    end

    #Move the cursor to the begin of the current line.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def cursor_goto_line_head
      @cursor.column = 0
      refresh_cursor
    end

    #Move the cursor to the end of the current line.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def cursor_goto_line_tail
      @cursor.column = buffer.lines[@cursor.row].size
      refresh_cursor
    end

    #Redraw the cursor.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived clases.
    def refresh_cursor
    end

    #Redraw this window.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived clases.
    def refresh
    end

    #Terminate this view instance.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def terminate
      @modeline.terminate

      terminate_ui
    end

    #Free system specific resources.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def terminate_ui
    end
  end
end