Changeset 1170

Timestamp:

03/14/08 17:19:59 (6 months ago)

Author:

rob

Message:

Added electricChar to autoindent
* electricChar is used in the OnChar? method of FundamentalMode? to automatically reindent a line if a certain char is pressed
* converted PythonMode?'s ElectricColon? into electricChar method of PythonAutoindent?
* added CStyleAutoindent's electricChar to handle opening and closing braces and semicolon

Location:

trunk/peppy

Files:

• fundamental.py (modified) (1 diff)
• lib/autoindent.py (modified) (5 diffs)
• plugins/python_mode.py (modified) (3 diffs)

trunk/peppy/fundamental.py

@@ -400 +400 @@
         """
         uchar = unichr(evt.GetKeyCode())
+        if self.autoindent.electricChar(self, uchar):
+            # If the autoindenter handles the char, it will insert the char.
+            # So, we don't call Skip in this case and the processing ends
+            # here.
+            return
         if self.classprefs.spell_check and uchar in self.word_end_chars:
             # We are catching the event before the character is added to the

trunk/peppy/lib/autoindent.py

@@ -152 +152 @@
             newline = linesep
         else:
+            # When we insert a new line, the colorization isn't always
+            # immediately updated, so we have to force that here before
+            # calling findIndent
+            stc.ReplaceTarget(linesep)
+            pos += len(linesep)
+            end = min(pos + 1, stc.GetTextLength())
+            # Colorize the entire last line up to one character beyond the
+            # newly inserted linesep character, guaranteeing that the new line
+            # will have the correct fold property set.
+            stc.Colourise(stc.PositionFromLine(linenum), end)
+            stc.SetTargetStart(pos)
+            stc.SetTargetEnd(pos)
             ind = self.findIndent(stc, linenum + 1)
-            newline = linesep + stc.GetIndentString(ind)
+            dprint("pos=%d ind=%d fold=%d" % (pos, ind, (stc.GetFoldLevel(linenum+1)&wx.stc.STC_FOLDLEVELNUMBERMASK) - wx.stc.STC_FOLDLEVELBASE))
+            newline = stc.GetIndentString(ind)
         stc.ReplaceTarget(newline)
         stc.GotoPos(pos + len(newline))
@@ -163 +176 @@
         stc.GotoPos(pos)
         stc.EndUndoAction()
+    
+    def electricChar(self, stc, uchar):
+        """Autoindent in response to a special character
+
+        This is a hook to cause an autoindent on a particular character.
+        Note that the hook can do more than that -- it can insert or delete
+        characters as well.
+        
+        This takes its name from emacs, where "electric" meant that something
+        else happened other than simply inserting the char.
+        
+        @param stc: stc instance
+        
+        @param uchar: unicode character that was just typed by the user (note
+        that it hasn't been inserted into the document yet.)
+        
+        @return: True if this method handled the character and the text
+        was modified; False if the calling event handler should handle the
+        character.
+        """
+        return False
 
 
@@ -211 +245 @@
 
         # folding says this should be the current indention
-        fold = stc.GetFoldLevel(linenum)&wx.stc.STC_FOLDLEVELNUMBERMASK - wx.stc.STC_FOLDLEVELBASE
+        fold = (stc.GetFoldLevel(linenum)&wx.stc.STC_FOLDLEVELNUMBERMASK) - wx.stc.STC_FOLDLEVELBASE
         c = stc.GetCharAt(pos)
         s = stc.GetStyleAt(pos)
@@ -224 +258 @@
 
         return fold * stc.GetIndent()
+    
+    def electricChar(self, stc, uchar):
+        """Reindent the line and insert a newline when special chars are typed.
+        
+        Like emacs, a semicolon or curly brace causes the line to be reindented
+        and the next line to be indented to the correct column.
+        
+        @param stc: stc instance
+        
+        @param uchar: unicode character that was just typed by the user (note
+        that it hasn't been inserted into the document yet.)
+        
+        @return: True if this method handled the character and the text
+        was modified; False if the calling event handler should handle the
+        character.
+        """
+        if uchar == u';' or uchar == '{' or uchar == '}':
+            pos = stc.GetCurrentPos()
+            s = stc.GetStyleAt(pos)
+            if not stc.isStyleComment(s) and not stc.isStyleString(s):
+                stc.BeginUndoAction()
+                stc.AddText(uchar)
+                self.processTab(stc)
+                self.processReturn(stc)
+                stc.EndUndoAction()
+                return True
+        return False
 
 
@@ -504 +565 @@
         """Don't reindent but insert the equivalent of a tab character"""
         stc.AddText(stc.GetIndentString(stc.GetIndent()))
+    
+    def electricChar(self, stc, uchar):
+        """No electric chars in Null autoindenter."""
+        return False

trunk/peppy/plugins/python_mode.py

@@ -51 +51 @@
     def action(self, index=-1, multiplier=1):
         self.frame.open("about:sample.py")
-
-
-class ElectricColon(TextModificationAction):
-    name = "Electric Colon"
-    tooltip = "Indent the current line when a colon is pressed"
-    key_bindings = {'default': 'S-;',} # FIXME: doesn't work to specify ':'
-
-    @classmethod
-    def worksWithMajorMode(cls, mode):
-        return mode.keyword == 'Python'
-
-    def action(self, index=-1, multiplier=1):
-        s = self.mode
-        style = s.GetStyleAt(s.GetSelectionEnd())
-        s.BeginUndoAction()
-        s.ReplaceSelection(":")
-        if s.isStyleComment(style) or s.isStyleString(style):
-            self.dprint("within comment or string: not indenting")
-            pass
-        else:
-            # folding info not automatically updated after a Replace, so
-            # do it manually
-            linestart = s.PositionFromLine(s.GetCurrentLine())
-            s.Colourise(linestart, s.GetSelectionEnd())
-            s.autoindent.reindentLine(s, dedent_only=True)
-        s.EndUndoAction()
 
 
@@ -216 +190 @@
         return indent
 
+    def electricChar(self, stc, uchar):
+        """Reindent the line and insert a newline when special chars are typed.
+        
+        For python mode, a colon should reindent the line (for example, after
+        an else statement, it should dedent it one level)
+        """
+        if uchar == u':':
+            pos = stc.GetCurrentPos()
+            s = stc.GetStyleAt(pos)
+            if not stc.isStyleComment(s) and not stc.isStyleString(s):
+                stc.BeginUndoAction()
+                stc.AddText(uchar)
+                self.reindentLine(stc, dedent_only=True)
+                stc.EndUndoAction()
+                return True
+        return False
+
 
 class PythonMode(JobControlMixin, SimpleFoldFunctionMatchMixin,
@@ -296 +287 @@
 
     def getActions(self):
-        return [SamplePython, ElectricColon]
+        return [SamplePython]