Merge lp:~googol-deactivatedaccount/openlp/editor into lp:~m2j/openlp/editor

[Andreas Preikschat]

- Removed code (we require Qt 4.6)
- implemented undo stack

Current problems:
- The {br} tag is saved as ↵ in the stack when we are outside the line it appears (same applies for {p})

Thoughts:
- reimplement self.highlighter.rehighlight() and disable the undo_list from there.
- use blockSignals instead of the skip_undo attribute

[Andreas Preikschat (googol-deactivatedaccount)]

To see the stack is working (and we are not using the build in one) see this code: http://pastebin.com/YVHqCszt

Just type in something like "test test {r}asdf" and then press ctrl+z. You will see that the {r} is removed at once.

[lp:~googol-deactivatedaccount/openlp/editor]

20. By Andreas Preikschat on 2013-02-26

started to implement a method to get the clean text from

21. By Andreas Preikschat on 2013-02-27

removed prints and commented code

Unmerged revisions

21. By Andreas Preikschat on 2013-02-27

removed prints and commented code

20. By Andreas Preikschat on 2013-02-26

started to implement a method to get the clean text from

19. By Andreas Preikschat on 2013-02-25

added example song without tags

18. By Andreas Preikschat on 2013-02-25

attempt to fix br/p tag insertion

17. By Andreas Preikschat on 2013-02-25

removed methods, removed parameter, fixed highlighting when editing a line

16. By Andreas Preikschat on 2013-02-25

more comments

15. By Andreas Preikschat on 2013-02-25

fixed cursor position

14. By Andreas Preikschat on 2013-02-25

fixed highlighting

13. By Andreas Preikschat on 2013-02-25

fixed highlighting

12. By Andreas Preikschat on 2013-02-25

reverted change

=== modified file 'core/formattededit.py'
--- core/formattededit.py	2012-12-12 23:18:59 +0000
+++ core/formattededit.py	2013-02-27 16:24:22 +0000
@@ -24,7 +24,6 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
-
 import re
 
 from PyQt4 import QtGui, QtCore, Qt
@@ -38,26 +37,90 @@
 from core.formattingtags import getAllTags, TAGREGEX, SPANTAGREGEX, TAGPAIRREGEX
 
 
+class UndoCommand(QtGui.QUndoCommand):
+    def __init__(self, parent):
+        """
+        Constructor
+        """
+        QtGui.QUndoCommand.__init__(self)
+        self.plain_text_edit = parent
+        old_command = self.plain_text_edit.undo_stack.command(self.plain_text_edit.undo_stack.count() - 1)
+        self.new_string = self.plain_text_edit.toPlainTextClean()
+        self.new_position = self.plain_text_edit.textCursor().position()
+        # Get the old string from the previous command.
+        self.old_string = old_command.new_string if old_command else u''
+        self.old_positon =  old_command.new_position if old_command else 0
+
+    def undo(self):
+        """
+        Action performed when this particular "undo command" is undon.
+        """
+        # Prevent onTextChanged signal being emitted.
+        self.plain_text_edit.blockSignals(True)
+        # Undo
+        self.plain_text_edit.setPlainText(self.old_string)
+        # Restore the cursor.
+        cursor = self.plain_text_edit.textCursor()
+        cursor.setPosition(self.old_positon)
+        self.plain_text_edit.setTextCursor(cursor)
+        # Allow signal again.
+        self.plain_text_edit.blockSignals(False)
+
+    def redo(self):
+        """
+        Action performed when this particular "undo command" is done.
+        """
+        # Prevent onTextChanged signal being emitted.
+        self.plain_text_edit.blockSignals(True)
+        # Redo
+        self.plain_text_edit.setPlainText(self.new_string)
+        # Restore the cursor.
+        cursor = self.plain_text_edit.textCursor()
+        cursor.setPosition(self.new_position)
+        self.plain_text_edit.setTextCursor(cursor)
+        # Allow signal again.
+        self.plain_text_edit.blockSignals(False)
+
+
 class FormattedEdit(QtGui.QPlainTextEdit):
     """
     This is a text editor widget which works together with TagHighlighter.
     """
-   
+
     def __init__(self, parent):
         QtGui.QPlainTextEdit.__init__(self, parent)
-
+        self.undo_stack = QtGui.QUndoStack()
+        self.skip_undo = False
         self.hasMouseCursor = False
         self.spellChecker = None
         self.spellCheckEnabled = False
         self.tagEditToolsEnabled = False
         self.tagHighlightingEnabled = False
-
         self.setupHighlighter()
         self.setupToolDock()
 
         self.previousBlock = self.document().begin().previous()
         self.onCursorPositionChanged()
         QtCore.QObject.connect(self, QtCore.SIGNAL(u'cursorPositionChanged()'), self.onCursorPositionChanged)
+        QtCore.QObject.connect(self, QtCore.SIGNAL(u'textChanged()'), self.onTextChanged)
+
+    def keyPressEvent(self, event):
+        """
+        Reimplement the ``keyPressEvent`` to act on undo/redo events.
+
+        ``event``
+            The event
+        """
+        if event.key() == QtCore.Qt.Key_Z:
+            # User wants to undo.
+            if event.modifiers() == QtCore.Qt.ControlModifier:
+                self.undo_stack.undo()
+                return
+            # User want to redo.
+            if event.modifiers() == (QtCore.Qt.ControlModifier | QtCore.Qt.ShiftModifier):
+                self.undo_stack.redo()
+                return
+        QtGui.QPlainTextEdit.keyPressEvent(self, event)
 
     def setupHighlighter(self, highlighter=None):
         """
@@ -79,7 +142,7 @@
         self.toolDock.setOrientation(QtCore.Qt.Vertical)
         self.toolDock.setFloating(True)
         self.toolDock.adjustSize()
-        self.toolDock.hide()
+        #self.toolDock.hide()
         # TODO: basis for the tool dock
         self.toolDockBackground = QtGui.QWidget(self)
         self.toolDockBackground.hide()
@@ -255,7 +318,9 @@
         if enabled and not hasattr(self, u'replaceForthDict'):
             self.setupReplacements({u'{br}': u'\u21B5\u2028', u'{p}': u'\u2028{p}\u204B', u'{/p}': u'\u00B6{/p}\u2028'})
         self.highlighter.enableTagHighlighting(enabled)
+        self.skip_undo = True
         self.highlighter.rehighlight()
+        self.skip_undo = False
 
     def enableTagEditTools(self, enabled=True):
         """
@@ -457,10 +522,9 @@
                 offset -= len(match.group())
                 match = TAGPAIRREGEX.search(text, match.end())
         cursor.endEditBlock()
-        if Qt.qVersion() < u'4.6':
-            self.highlighter.rehighlight()
-        else:
-            self.highlighter.rehighlightBlock(self.document().findBlock(start_pos))
+        self.skip_undo = True
+        self.highlighter.rehighlightBlock(self.document().findBlock(start_pos))
+        self.skip_undo = False
 
     def removeTag(self, tag=None):
         """
@@ -502,7 +566,7 @@
                     cursor.insertText(u'{/%s}' % s_tag)
             for s_tag in reversed(start_tags[start_level:]):
                 if tag and s_tag != tag:
-                    if unicode(self.toPlainText())[cursor.position(): \
+                    if unicode(self.toPlainText())[cursor.position():
                         cursor.position() + len(s_tag) + 3] == u'{/%s}' % s_tag:
                         cursor.movePosition(QtGui.QTextCursor.NextCharacter, QtGui.QTextCursor.KeepAnchor,
                             len(s_tag) + 3)
@@ -526,34 +590,43 @@
             end_level = end_tags.index(tag) if tag else 0
             for e_tag in reversed(end_tags[end_level:]):
                 if tag and e_tag != tag:
-                    if unicode(self.toPlainText())[cursor.position() - len(e_tag) - 2:cursor.position()]
-                        == u'{%s}' % e_tag:
+                    if unicode(self.toPlainText())[cursor.position() - len(e_tag) - 2:cursor.position()] == u'{%s}' % e_tag:
                         cursor.movePosition(QtGui.QTextCursor.PreviousCharacter, QtGui.QTextCursor.KeepAnchor,
                             len(e_tag) + 2)
                         cursor.removeSelectedText()
                     else:
                         cursor.insertText(u'{/%s}' % e_tag)
             for end_tag in end_tags[end_level:]:
-                if unicode(self.toPlainText())[cursor.position(): cursor.position() + len(end_tag) + 3]
-                    == u'{/%s}' % end_tag:
+                if unicode(self.toPlainText())[cursor.position(): cursor.position() + len(end_tag) + 3] == u'{/%s}' % end_tag:
                     cursor.movePosition(QtGui.QTextCursor.NextCharacter, QtGui.QTextCursor.KeepAnchor, len(end_tag) + 3)
                     cursor.removeSelectedText()
                 else:
                     cursor.insertText(u'{%s}' % end_tag)
-        if Qt.qVersion() < u'4.6':
-            self.highlighter.rehighlight()
-        else:
-            self.highlighter.rehighlightBlock(
-                self.document().findBlock(start_pos))
+        self.skip_undo = True
+        self.highlighter.rehighlightBlock(self.document().findBlock(start_pos))
+        self.skip_undo = False
+
+    def toPlainTextClean(self):
+        """
+        Returns the text with all tags. This is the inverse function to ``replaceTags()``.
+        """
+        # TODO: Not working! We need to use the regex to get the text with all tags.
+        text = self.toPlainText()
+        match = self.replaceBackRegExp.search(unicode(text))
+        while match:
+            offset = len(self.replaceBackDict[match.group()])
+            match = self.replaceBackRegExp.search(unicode(block.text()), match.start() + offset)
+        return self.toPlainText()
 
     def replaceTags(self, block):
         """
-        This function is replacing tags which can't be visualized with just syntax highlighting. For example {br} is
-        replaced by a down-left arrow and a newline character.
+        This function is replacing tags whsetupReplacementsich can't be visualized with just syntax highlighting. For
+        example {br} is replaced by a down-left arrow and a newline character.
         """
-        # TODO: is there a way to skip the undo-list?
         if not self.tagHighlightingEnabled:
             return
+        self.skip_undo = True
+        self.blockSignals(True)
         if block.userData() and block.userData().focus:
             match = self.replaceBackRegExp.search(unicode(block.text()))
             if match:
@@ -576,6 +649,8 @@
                 cursor.insertText(self.replaceForthDict[match.group()])
                 offset = len(self.replaceForthDict[match.group()])
                 match = self.replaceForthRegExp.search(unicode(block.text()), match.start() + offset)
+        self.skip_undo = False
+        self.blockSignals(False)
 
     def getSurroundingTags(self):
         """
@@ -603,6 +678,20 @@
                 end_tags[-1:] = []
         return start_tags, end_tags
 
+    def onTextChanged(self):
+        """
+        The text has changed. Save changes to the undo stack.
+        """
+        if self.skip_undo:
+            return
+        self.onCursorPositionChanged()
+        position = self.textCursor().position()
+        self.undo_stack.push(UndoCommand(self))
+        cursor = self.textCursor()
+        cursor.setPosition(position)
+        self.setTextCursor(cursor)
+        self.onCursorPositionChanged()
+
     def onCursorPositionChanged(self):
         """
         This function follows the cursor position and triggers adjustment of the highlighting.
@@ -619,13 +708,12 @@
                 self.replaceTags(previous)
             current.userData().focus = True
             self.replaceTags(current)
-            if Qt.qVersion() < u'4.6':
-                self.highlighter.rehighlight()
-            else:
-                self.highlighter.rehighlightBlock(previous)
-                self.highlighter.rehighlightBlock(current)
+            self.skip_undo = True
+            self.highlighter.rehighlightBlock(previous)
+            self.highlighter.rehighlightBlock(current)
+            self.skip_undo = False
             self.emit(QtCore.SIGNAL(u'cursorBlockChanged()'))
-    
+
     def getSpellCheckContextMenu(self, context_menu, event, language=None):
         """
         Prepend spell check items on the context menu.
@@ -634,7 +722,8 @@
         context_menu.insertMenu(context_menu.actions()[0], self.defaultDictMenu)
         cursor = self.cursorForPosition(event.pos())
         cursor.select(QtGui.QTextCursor.WordUnderCursor)
-        if cursor.hasSelection() and language is not False:
+        if cursor.hasSelection() and language is not None:
+            # FIXME: language is "de" but dict is calle "de_DE" or "de_AT" etc.
             dictionary = self.spellChecker.get_dictionary(language)
             text = unicode(cursor.selectedText())
             if not dictionary.check(text):
@@ -651,7 +740,7 @@
     def updateToolDockVisibility(self):
         # TODO: We have to delay this with a timer. Furthermore we should keep it visible if the pointer is above the
         #   tool dock or a menu.
-        self.toolDock.setVisible(self.hasFocus() or self.hasMouseCursor)
+        self.toolDock.setVisible(self.hasFocus() or self.hasMouseCursor or True)
 
     def contextMenuEvent(self, event):
         """
@@ -746,6 +835,7 @@
                 QtCore.QVariant()).toBool():
                 self.cleanUpFormattingTags(data[QtCore.QString(u'close')].toBool())
 
+
 class TextSignalAction(QtGui.QAction):
     """
     A special QAction that returns its text in a signal.

=== modified file 'core/highlighter.py'
--- core/highlighter.py	2012-12-12 23:18:59 +0000
+++ core/highlighter.py	2013-02-27 16:24:22 +0000
@@ -41,7 +41,7 @@
     def __init__(self):
         """
         This class contains user data for text blocks
-        
+
         ``focus``
             Holds whether cursor is on the block
 
@@ -64,7 +64,7 @@
     """
     This is a syntax highlighter for OpenLPs formatting tags.
     """
-   
+
     def __init__(self, document, edit):
         QtGui.QSyntaxHighlighter.__init__(self, document)
 
@@ -114,7 +114,7 @@
         This function allows enabling and disabling of the formatting tag highlighting.
         """
         self.tagHighlightingEnabled = enabled
-        
+
 
     def highlightBlock(self, text):
         """

=== modified file 'core/spellchecker.py'
--- core/spellchecker.py	2012-12-12 23:18:59 +0000
+++ core/spellchecker.py	2013-02-27 16:24:22 +0000
@@ -57,7 +57,7 @@
 
         ``language``
             A string for the dictionary key. If ``None`` the default dictionary will be returned.
-            
+
         Valid strings in can be found in self.available_languages. If the chosen dictionary is not available ``None``
         will be returned.
         """

=== modified file 'run_songedit.py'
--- run_songedit.py	2012-12-12 23:18:59 +0000
+++ run_songedit.py	2013-02-27 16:24:22 +0000
@@ -77,7 +77,7 @@
         self.lyricsLabel.setText(translate('SongsPlugin.EditSongForm', '&Lyrics:'))
         self.verseOrderLabel.setText(translate('SongsPlugin.EditSongForm', '&Verse order:'))
 
-        infile = open('sample_song.txt', 'r')
+        infile = open('sample_song2.txt', 'r')
         self.lyricsEdit.setPlainText(unicode(infile.read(), u'utf8'))
         self.lyricsEdit.enableSpellCheck()
         self.lyricsEdit.enableTagHighlighting()

=== added file 'sample_song2.txt'
--- sample_song2.txt	1970-01-01 00:00:00 +0000
+++ sample_song2.txt	2013-02-27 16:24:22 +0000
@@ -0,0 +1,2 @@
+a b c d
+asdfds

=== modified file 'songs/lyricsedit.py'
--- songs/lyricsedit.py	2012-12-12 23:18:59 +0000
+++ songs/lyricsedit.py	2013-02-27 16:24:22 +0000
@@ -188,7 +188,7 @@
     def updateSideBarGeometry(self):
         """
         This method updates the visibility of the side bar and adjusts the editor viewport accordingly.
-    	"""
+        """
         top = self.verseSideBar.geometry().top()
         right = self.verseSideBar.geometry().right()
         if self.translationSideBar.headers():