svn/view/view.rb

# view.rb: the module definition of Edmaru::View.
#
# 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 "event_manager.rb"
require "window.rb"

module Edmaru

  #Abstract class to implement system specific view.
  module View

    #Construct a view instance.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_config_ :: An instance of Edmaru::ConfigurationManager.
    #_event_manager_ :: An instance of Edmaru::EventManager to handle all events raised from this view.
    #_buffer_manager_ :: An instance of Edmaru::BufferManager.
    #
    #=== Return
    #An initialized instance of View.
    def initialize(config, event_manager, buffer_manager)
      @config = config
      @event_manager = event_manager
      @buffer_manager = buffer_manager

      init_ui

      @windows = Array.new
      @windows.push(Edmaru::SYSTEM_WINDOW.new(self, @config))
      @focused_window = @windows[0]
      @mini_window = Edmaru::SYSTEM_MINI_WINDOW.new(self, @config)

      init_windows

      element = ModeLineElement.new("buffer-name", -1, 1, 1, "*scratch*")
      @windows[0].modeline.add_element(element)
      @windows[0].modeline.show_element("buffer-name")
    end

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

    #The system specific initialization for windows that belongs to this view.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def init_windows
    end

    #The event manager linked to this view.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def event_manager
      @event_manager
    end

    #The mini window displayed in the bottom of the screen.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def mini_window
      @mini_window
    end

    #The focused window.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def focused_window
      @focused_window
    end


    #Cause the specfieid window have focus.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def focused_window=(window)
      @focused_window = window
    end

    #Main loop to catch all events.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def main_loop
    end

    #Exit the running main loop.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    #
    #=== Note
    #Some UI systems (such as Ncurses) don't exit the main loop as
    #soon as this method is called.
    def exit_main_loop
    end

    #Beep once.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def beep
      false
    end

    #Terminate this view instance.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def terminate
      @windows.each{ |window|
        window.terminate
      }
      @mini_window.terminate

      terminate_ui
    end

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