ruber 0.0.1.1

data/lib/ruber/main_window/main_window_internal.rb

@@ -0,0 +1,239 @@
+=begin 
+    Copyright (C) 2010 by Stefano Crocco   
+    stefano.crocco@alice.it   
+  
+    This program is free software; you can redistribute it andor modify  
+    it under the terms of the GNU General Public License as published by  
+    the Free Software Foundation; either version 2 of the License, or     
+    (at your option) any later version.                                   
+  
+    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.,                                       
+    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             
+=end
+
+require 'facets/enumerable/sum'
+
+module Ruber
+  
+  class MainWindow < KParts::MainWindow
+    
+=begin rdoc
+A list of strings to be used to create the filter for open file dialogs
+=end
+    OPEN_DLG_FILTERS = [
+      '*.rb|Ruby source file (*.rb)', 
+      '*.yaml *.yml|YAML files (*.yaml, *.yml)',
+      '*|All files'
+      ]
+    
+    slots 'remove_view(QWidget*)', 'document_modified_changed(bool)',
+        :document_url_changed, :next_document, :previous_document,
+        'store_splitter_sizes(QString)', 'update_document_icon(QObject*)',
+        'remove_plugin_ui_actions(QObject*)', 'close_project_files(QObject*)'
+    
+    private    
+    
+=begin rdoc
+Checks whether an editor view for the given document exists and creates it if it
+doesn't. In both cases, An editor view for the document is returned. _doc_ is the
+Document for which the editor should be created.
+
+<b>Note:</b> this also creates a new tab with the new view, if it needs to create
+one
+=end
+    def create_editor_if_needed doc
+      if doc.view then doc.view
+      else
+        view = doc.create_view
+        @editors_mapper.set_mapping view, view
+        connect view, SIGNAL(:closing), @editors_mapper, SLOT(:map)
+        connect view.document, SIGNAL('modified_changed(bool, QObject*)'), self, SLOT('document_modified_changed(bool)')
+        connect view.document, SIGNAL('modified_on_disk(QObject*, bool, KTextEditor::ModificationInterface::ModifiedOnDiskReason)'), self, SLOT('update_document_icon(QObject*)')
+        connect view.document, SIGNAL('document_url_changed(QObject*)'), self, SLOT(:document_url_changed)
+        @views.add_tab view, doc.icon, doc.document_name
+        view
+      end
+    end
+
+=begin rdoc
+Changes the icon in the tab corresponding to the Document _doc_ so that it reflects
+its current status
+=end
+    def update_document_icon doc
+      ed = editor_for doc
+      return unless ed
+      idx = @views.index_of ed
+      return unless idx
+      @views.set_tab_icon idx, doc.icon
+    end
+    
+=begin rdoc
+Opens a file, creating a document and an editor for it, activates and gives focus
+to the editor and adds the file to the list of recent files. _file_ is the absolute
+path of the file to open
+=end
+    def gui_open_file file
+      editor = editor_for! file
+      return unless editor
+      focus_on_editor editor
+      url = KDE::Url.from_path(file)
+      action_collection.action('file_open_recent').add_url url, url.file_name
+    end
+
+=begin rdoc
+If _ed_ is the active editor, it deactivates it and removes it from the gui. If
+_ed_ is not the active editor (or if it's *nil*), nothing is done.
+    
+<b>Note:</b> this doesn't change the status bar associated with the view.
+=end
+    def deactivate_editor ed
+      return unless ed and ed == @active_editor
+      @active_editor.document.deactivate
+      gui_factory.remove_client ed.send( :internal)
+    end
+    
+=begin rdoc
+Remove the editor _ed_ from the tab widget, deactivating it before (if needed).
+If automatical activation of editors is on, it also activates another editor,
+if any
+=end
+    def remove_view ed
+      status_bar.view = nil if ed == @active_editor
+      deactivate_editor ed
+      idx = @views.index_of ed
+      @views.remove_tab idx
+      #This assumes that only one editor can exist for each document
+      ed.document.disconnect SIGNAL('modified_changed(bool, QObject*)'), self
+      ed.document.disconnect SIGNAL('document_url_changed(QObject*)'), self
+      if @views.current_widget and @auto_activate_editors
+        activate_editor @views.current_widget
+        @views.current_widget.set_focus
+      end
+    end
+    
+    protected
+    
+=begin rdoc
+Override of <tt>KParts::MainWindow#queryClose</tt> which calls the <tt>query_close</tt>
+method of the component manager. This means that the latter method will be called
+everytime the application is closed.
+=end
+    def queryClose
+      Ruber[:components].query_close
+    end
+    
+=begin rdoc
+Override of <tt>KParts::MainWindow#queryExit</tt> which calls the +shutdown+ method
+of the component
+=end
+    def queryExit
+      Ruber[:app].quit_ruber
+      true
+    end
+    
+=begin rdoc
+Saves the properties for session management.
+TODO: currently, session management doesn't work at all. So, either remove the
+method or make it work
+=end
+    def saveProperties conf
+      data = YAML.dump @session_data 
+      conf.write_entry 'Ruber', data
+    end
+
+=begin rdoc
+Reads the properties from the config object for session management
+=end
+    def readProperties conf
+      @last_session_data = YAML.load conf.read_entry('Ruber', '{}')
+    end
+   
+=begin rdoc
+Creates a suitable title for the main window.
+=end
+    def make_title 
+      title = ''
+      prj = Ruber[:projects].current_project
+      if prj
+        title << (prj.project_name ? prj.project_name :
+                  File.basename(prj.project_file, '.ruprj'))
+      end
+      if @active_editor and @active_editor.document.path.empty? 
+        title << ' - ' << @active_editor.document.document_name
+      elsif @active_editor
+        title << ' - ' << @active_editor.document.path
+      end
+      title.sub!(/\A\s+-/, '')
+      mod = current_document.modified? rescue false
+      set_caption title, mod
+    end
+    
+=begin rdoc
+:call-seq: document_modified_changed(mod) [SLOT]
+
+Slot called whenever the modified status of a document changes. It updates the
+icon on the tab of the document's editor and the window title (if the document
+was the active one) accordingly.
+=end
+    def document_modified_changed mod
+      doc = self.sender
+      make_title
+#This assumes that only one editor exists for each document
+      update_document_icon doc
+    end
+    
+=begin rdoc
+Slot called whenever the document url changes (usually because the document has
+been saved). It changes the title and icon of the tab and changes the title of the
+window is the document is active.
+=end
+    def document_url_changed
+      doc = self.sender
+      make_title
+      idx = @views.index_of doc.view
+      @views.set_tab_text idx, doc.document_name
+      update_document_icon doc
+      
+      unless doc.path.empty?
+        action_collection.action('file_open_recent').add_url KDE::Url.new(doc.path) 
+      end
+    end
+    
+=begin rdoc
+Removes the action handlers for all the actions belonging to the plugin _plug_
+from the list of handlers
+=end
+    def remove_plugin_ui_actions plug
+      @actions_state_handlers.delete_if do |state, hs|
+        hs.delete_if{|h| h.plugin == plug}
+        hs.empty?
+      end
+    end
+   
+=begin
+Sets the UI states defined by the main window to their initial values.
+=end
+    def setup_initial_states
+      change_state 'active_project_exists', false
+      change_state 'current_document', false
+    end
+    
+    def close_project_files prj
+      to_close = @views.select do |v|
+        prj.project_files.file_in_project? v.document.path
+      end
+      save_documents to_close.map &:document
+      to_close.each{|v| v.document.close}
+    end
+    
+    
+  end
+  
+end

data/lib/ruber/main_window/open_file_in_project_dlg.rb

@@ -0,0 +1,212 @@
+=begin 
+    Copyright (C) 2010 by Stefano Crocco   
+    stefano.crocco@alice.it   
+  
+    This program is free software; you can redistribute it andor modify  
+    it under the terms of the GNU General Public License as published by  
+    the Free Software Foundation; either version 2 of the License, or     
+    (at your option) any later version.                                   
+  
+    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.,                                       
+    59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             
+=end
+
+require 'facets/boolean'
+
+require 'pathname'
+
+require_relative "ui/open_file_in_project_dlg"
+
+module Ruber
+
+=begin rdoc
+ This class is a dialog where the user can choose a file to open among the
+ files of the project.
+
+ The dialog is made by two widgets: a <tt>KDE::LineEdit</tt>, where the user
+ can enter a file pattern, and a <tt>Qt::ListView</tt>, where all files in
+ the project matching the 
+ given regexp are shown. The user can choose the file either by pressing the
+ Return key or by activating an item in the list.
+ 
+ The pattern is interpreted as a regexp and is checked against the whole path
+ of the file if it contains a pattern separator character (the '/' character
+ on UNIX) and only
+ against the name of the file otherwise. When the user changes the pattern, 
+ the file list is changed accordingly. This is achieved using a
+ filter model derived from <tt>Qt::SortFilterProxyModel</tt>.
+=end
+  class OpenFileInProjectDlg < Qt::Dialog
+
+=begin rdoc
+ Class implementing the filter for the +OpenFileInProjectDlg+ class.
+=end
+    class FilterModel < Qt::SortFilterProxyModel
+
+=begin rdoc
+ Returns a new +FilterModel+.
+ =====Arguments
+ _parent_:: the <tt>Qt::Object</tt> parent of the filter
+=end
+      def initialize parent = nil
+        super
+        @filter = nil
+        @role = Qt::DisplayRole
+      end
+
+=begin rdoc
+ Changes the regexp used to filter the files, then re-applies the filter
+ calling the +invalidate+ method.
+ =====Arguments
+ _value_:: the new regexp. It can be +nil+ or a regexp. In the first case,
+           the filter won't be applied.
+ =====TODO
+ On Windows, allow to also use the '\' character as pattern separator.
+ The problem is that that character is also the escape character in a regexp,
+ so things may become complicated.
+=end
+      def filter= value
+        @filter = value
+        # TODO This doesn't work
+        #on windows, where one can also use \ as separator. The problem is that in regexp
+        #it's the escape character, so one must use something like
+        #value.include?(File::SEPARATOR) || (File::ALT_SEPARATOR and value.match(/\\{2}))
+        @role = if @filter and !value.source.include?(File::SEPARATOR) then Qt::UserRole + 1 
+        else Qt::DisplayRole
+        end
+        invalidate
+      end
+
+      protected
+
+=begin rdoc
+ Reimplementation of Qt::SortFilterProxyModel#filterAcceptsRow which returns
+ +true+ if the file matches the regexp and +false+ otherwise (if the regexp
+ is +nil+, this method always returns +true+).
+ 
+ If the source of the regexp contains the pattern separator, the whole
+ filename is tested, otherwise only the name of the file will be tested.
+=end
+      def filterAcceptsRow r, parent
+        return true unless @filter
+        idx = source_model.index r, 0, parent
+        res = idx.data(@role).to_string.match @filter
+        res.to_bool #It seems that it's required to return true or false - other objects don't work
+      end
+
+    end
+
+    slots 'change_filter(const QString &)', 'item_activated(const QModelIndex &)'
+
+=begin rdoc
+ Returns a new +OpenFileInProjectDlg+.
+ =====Arguments
+ _parent_:: the widget parent of the dialog
+=end
+    def initialize parent = nil
+      super
+      files = Ruber.current_project.project_files.to_a
+      @base_dir = Ruber.current_project.project_directory
+      @ui = Ui::OpenFileInProjectDlg.new
+      @ui.setupUi self
+      @ui.regexp_error.hide
+      filter = FilterModel.new @ui.file_list
+      model = Qt::StandardItemModel.new filter
+      @ui.file_list.model = filter
+      filter.source_model = model
+      files.each do |f|
+        path = f.sub %r{\A#{Regexp.quote(@base_dir)}/}, ''
+        it = Qt::StandardItem.new path
+        it.set_data Qt::Variant.new(File.basename(path))
+        it.editable = false
+        model.append_row it
+      end      
+      @ui.pattern.install_event_filter self
+      connect @ui.pattern, SIGNAL('textChanged(const QString &)'), self, SLOT('change_filter(const QString &)')
+      connect @ui.file_list, SIGNAL('activated(const QModelIndex &)'), self, SLOT('item_activated(const QModelIndex &)')
+      @ui.file_list.selection_model.select @ui.file_list.model.index(0,0), 
+        Qt::ItemSelectionModel::ClearAndSelect|Qt::ItemSelectionModel::Rows
+      @ui.file_list.current_index = @ui.file_list.model.index(0,0)
+#       @ui.file_list.header.resize_sections Qt::HeaderView::ResizeToContents
+    end
+
+=begin rdoc
+ Returns the file chosen by the user or +nil+ if no file has been chosen. The
+ chosen file is the file last selected in the file list.
+=end
+    def chosen_file
+      selection = @ui.file_list.selection_model.selected_indexes
+      return nil if selection.empty?
+      idx = selection.first
+      File.join(@base_dir, idx.data.to_string.gsub(/\A\./,''))
+    end
+
+=begin rdoc
+ Reimplements Qt::Object.eventFilter. It blocks the +KeyPress+ events for the 
+ up and down keys (but only if there's no modifier) and redirects them to the 
+ file list widget. All other events are allowed to pass. This allows to scroll
+ the list without taking the focus from the pattern widget.
+ =====Arguments
+ _obj_:: the object whose events should be filtered
+ _e_:: the event
+=end
+    def eventFilter obj, e
+      if e.type != Qt::Event::KeyPress then return false
+      else
+        if (e.key == Qt::Key_Down || e.key == Qt::Key_Up) and e.modifiers == Qt::NoModifier
+# TODO: reintroduce the last parameter when it stops giving errors
+          new_ev = Qt::KeyEvent.new e.type, e.key, e.modifiers, e.text, 
+e.is_auto_repeat, e.count
+          Ruber[:app].post_event @ui.file_list, new_ev
+          true
+        else false
+        end
+      end
+    end
+
+    private
+    
+=begin rdoc
+ Changes the pattern used by the filter model applied to the view so that it is
+ equal to the text currently in the pattern widget and selects the first item in
+ the view (if any). If the list is empty, it also disables the Ok button.
+ =====Arguments
+ _text_:: the new pattern
+=end
+    def change_filter text
+      begin
+        reg = text.empty? ? nil : Regexp.new( text )
+        @ui.file_list.model.filter= reg
+        @ui.file_list.selection_model.select @ui.file_list.model.index(0,0), 
+          Qt::ItemSelectionModel::ClearAndSelect|Qt::ItemSelectionModel::Rows
+        @ui.file_list.current_index = @ui.file_list.model.index(0,0)
+        @ui.buttons.button(Qt::DialogButtonBox::Ok).enabled = @ui.file_list.model.row_count > 0
+        @ui.regexp_error.hide
+      rescue RegexpError 
+        @ui.regexp_error.show
+      end
+    end
+
+=begin rdoc
+ Closes the dialog with the <tt>Qt::Dialog::Accepted</tt> status and selects the
+ index passed as argument.
+ =====Arguments
+ _idx_:: the index of the activated item.
+=end
+    def item_activated idx
+      @ui.file_list.selection_model.select idx, Qt::ItemSelectionModel::ClearAndSelect|
+          Qt::ItemSelectionModel::Rows
+      @ui.file_list.current_index = idx
+      accept
+    end
+
+  end
+
+end