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.
    #_x_ :: The left edge position in the parent view.
    #_y_ :: The top edge position in the parent view.
    #_col_ :: The max column size allocated for this window.
    #_row_ :: The max line size allocated for this window including
    #ModeLine's line size (usually 1).
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Return
    #An initialized instance of Window.
    def initialize(view, x, y, col, row)
      @view = view
      @cursor = Cursor.new(0, 0)

      init_ui(x, y, col, row - 1)

      #Creating modeline bar.
      @modeline = Edmaru::modeline_class.new(self, x, y + row - 1, col)
      element = ModeLineElement.new("buffer-name", -1, 1, 1,"*scratch#{$count}*")
      @modeline.add_element(element)
      @modeline.show_element("buffer-name")
    end

    #The system specific initialization for this window.
    #
    #=== Arguments
    #_x_ :: The left edge position in the parent view.
    #_y_ :: The top edge position in the parent view.
    #_col_ :: The max column size allocated for this window.
    #_row_ :: The max line size allocated for this window excluding
    #ModeLine's line size (usually 1).
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    #And it *MUST* *NOT* deal with anything about modeline bar.
    def init_ui(x, y, col, row)
    end

    #Discard the current buffer and set the specified new buffer.
    #
    #=== 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

    #Redraw this window.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived clases.
    def refresh
      if @buffer == nil
        return
      end
    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