[Python-checkins] python/dist/src/Lib/idlelib CodeContext.py, 1.4.6.1, 1.4.6.2

jhylton@users.sourceforge.net jhylton at users.sourceforge.net
Sun Oct 16 07:24:33 CEST 2005


Update of /cvsroot/python/python/dist/src/Lib/idlelib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27718/Lib/idlelib

Modified Files:
      Tag: ast-branch
	CodeContext.py 
Log Message:
Merge head to branch (for the last time)


Index: CodeContext.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/idlelib/CodeContext.py,v
retrieving revision 1.4.6.1
retrieving revision 1.4.6.2
diff -u -d -r1.4.6.1 -r1.4.6.2
--- CodeContext.py	7 Jan 2005 06:58:37 -0000	1.4.6.1
+++ CodeContext.py	16 Oct 2005 05:24:00 -0000	1.4.6.2
@@ -1,33 +1,33 @@
-"""CodeContext - Display the block context of code at top of edit window
+"""CodeContext - Extension to display the block context above the edit window
 
-Once code has scrolled off the top of the screen, it can be difficult
-to determine which block you are in.  This extension implements a pane
-at the top of each IDLE edit window which provides block structure
-hints.  These hints are the lines which contain the block opening
-keywords, e.g. 'if', for the enclosing block.  The number of hint lines
-is determined by the numlines variable in the CodeContext section of
-config-extensions.def. Lines which do not open blocks are not shown in
-the context hints pane.
+Once code has scrolled off the top of a window, it can be difficult to
+determine which block you are in.  This extension implements a pane at the top
+of each IDLE edit window which provides block structure hints.  These hints are
+the lines which contain the block opening keywords, e.g. 'if', for the
+enclosing block.  The number of hint lines is determined by the numlines
+variable in the CodeContext section of config-extensions.def. Lines which do
+not open blocks are not shown in the context hints pane.
 
 """
 import Tkinter
 from configHandler import idleConf
 from sets import Set
 import re
+from sys import maxint as INFINITY
 
 BLOCKOPENERS = Set(["class", "def", "elif", "else", "except", "finally", "for",
                     "if", "try", "while"])
-INFINITY = 1 << 30
 UPDATEINTERVAL = 100 # millisec
 FONTUPDATEINTERVAL = 1000 # millisec
 
-getspacesfirstword = lambda s, c=re.compile(r"^(\s*)(\w*)"): c.match(s).groups()
+getspacesfirstword =\
+                   lambda s, c=re.compile(r"^(\s*)(\w*)"): c.match(s).groups()
 
 class CodeContext:
     menudefs = [('options', [('!Code Conte_xt', '<<toggle-code-context>>')])]
 
-    numlines = idleConf.GetOption("extensions", "CodeContext",
-                                  "numlines", type="int", default=3)
+    context_depth = idleConf.GetOption("extensions", "CodeContext",
+                                       "numlines", type="int", default=3)
     bgcolor = idleConf.GetOption("extensions", "CodeContext",
                                  "bgcolor", type="str", default="LightGray")
     fgcolor = idleConf.GetOption("extensions", "CodeContext",
@@ -37,9 +37,13 @@
         self.text = editwin.text
         self.textfont = self.text["font"]
         self.label = None
-        # Dummy line, which starts the "block" of the whole document:
-        self.info = list(self.interesting_lines(1))
-        self.lastfirstline = 1
+        # self.info is a list of (line number, indent level, line text, block
+        # keyword) tuples providing the block structure associated with
+        # self.topvisible (the linenumber of the line displayed at the top of
+        # the edit window). self.info[0] is initialized as a 'dummy' line which
+        # starts the toplevel 'block' of the module.
+        self.info = [(0, -1, "", False)]
+        self.topvisible = 1
         visible = idleConf.GetOption("extensions", "CodeContext",
                                      "visible", type="bool", default=False)
         if visible:
@@ -51,18 +55,25 @@
 
     def toggle_code_context_event(self, event=None):
         if not self.label:
-            self.label = Tkinter.Label(self.editwin.top,
-                                      text="\n" * (self.numlines - 1),
+            self.pad_frame = Tkinter.Frame(self.editwin.top,
+                                           bg=self.bgcolor, border=2,
+                                           relief="sunken")
+            self.label = Tkinter.Label(self.pad_frame,
+                                      text="\n" * (self.context_depth - 1),
                                       anchor="w", justify="left",
                                       font=self.textfont,
                                       bg=self.bgcolor, fg=self.fgcolor,
-                                      relief="sunken",
+                                      border=0,
                                       width=1, # Don't request more than we get
                                       )
-            self.label.pack(side="top", fill="x", expand=0,
-                            after=self.editwin.status_bar)
+            self.label.pack(side="top", fill="x", expand=True,
+                            padx=4, pady=0)
+            self.pad_frame.pack(side="top", fill="x", expand=False,
+                                padx=0, pady=0,
+                                after=self.editwin.status_bar)
         else:
             self.label.destroy()
+            self.pad_frame.destroy()
             self.label = None
         idleConf.SetOption("extensions", "CodeContext", "visible",
                            str(self.label is not None))
@@ -73,14 +84,8 @@
 
         If the line does not start a block, the keyword value is False.
         The indentation of empty lines (or comment lines) is INFINITY.
-        There is a dummy block start, with indentation -1 and text "".
-
-        Return the indent level, text (including leading whitespace),
-        and the block opening keyword.
 
         """
-        if linenum == 0:
-            return -1, "", True
         text = self.text.get("%d.0" % linenum, "%d.end" % linenum)
         spaces, firstword = getspacesfirstword(text)
         opener = firstword in BLOCKOPENERS and firstword
@@ -90,45 +95,69 @@
             indent = len(spaces)
         return indent, text, opener
 
-    def interesting_lines(self, firstline):
-        """Generator which yields context lines, starting at firstline."""
+    def get_context(self, new_topvisible, stopline=1, stopindent=0):
+        """Get context lines, starting at new_topvisible and working backwards.
+
+        Stop when stopline or stopindent is reached. Return a tuple of context
+        data and the indent level at the top of the region inspected.
+
+        """
+        assert stopline > 0
+        lines = []
         # The indentation level we are currently in:
         lastindent = INFINITY
         # For a line to be interesting, it must begin with a block opening
         # keyword, and have less indentation than lastindent.
-        for line_index in xrange(firstline, -1, -1):
-            indent, text, opener = self.get_line_info(line_index)
+        for linenum in xrange(new_topvisible, stopline-1, -1):
+            indent, text, opener = self.get_line_info(linenum)
             if indent < lastindent:
                 lastindent = indent
                 if opener in ("else", "elif"):
                     # We also show the if statement
                     lastindent += 1
-                if opener and line_index < firstline:
-                    yield line_index, text
+                if opener and linenum < new_topvisible and indent >= stopindent:
+                    lines.append((linenum, indent, text, opener))
+                if lastindent <= stopindent:
+                    break
+        lines.reverse()
+        return lines, lastindent
 
-    def update_label(self):
-        firstline = int(self.text.index("@0,0").split('.')[0])
-        if self.lastfirstline == firstline:
+    def update_code_context(self):
+        """Update context information and lines visible in the context pane.
+
+        """
+        new_topvisible = int(self.text.index("@0,0").split('.')[0])
+        if self.topvisible == new_topvisible:      # haven't scrolled
             return
-        self.lastfirstline = firstline
-        tmpstack = []
-        for line_index, text in self.interesting_lines(firstline):
-            # Remove irrelevant self.info items, and when we reach a relevant
-            # item (which must happen because of the dummy element), break.
-            while self.info[-1][0] > line_index:
+        if self.topvisible < new_topvisible:       # scroll down
+            lines, lastindent = self.get_context(new_topvisible,
+                                                 self.topvisible)
+            # retain only context info applicable to the region
+            # between topvisible and new_topvisible:
+            while self.info[-1][1] >= lastindent:
                 del self.info[-1]
-            if self.info[-1][0] == line_index:
-                break
-            tmpstack.append((line_index, text))
-        while tmpstack:
-            self.info.append(tmpstack.pop())
-        lines = [""] * max(0, self.numlines - len(self.info)) + \
-                [x[1] for x in self.info[-self.numlines:]]
-        self.label["text"] = '\n'.join(lines)
+        elif self.topvisible > new_topvisible:     # scroll up
+            stopindent = self.info[-1][1] + 1
+            # retain only context info associated
+            # with lines above new_topvisible:
+            while self.info[-1][0] >= new_topvisible:
+                stopindent = self.info[-1][1]
+                del self.info[-1]
+            lines, lastindent = self.get_context(new_topvisible,
+                                                 self.info[-1][0]+1,
+                                                 stopindent)
+        self.info.extend(lines)
+        self.topvisible = new_topvisible
+
+        # empty lines in context pane:
+        context_strings = [""] * max(0, self.context_depth - len(self.info))
+        # followed by the context hint lines:
+        context_strings += [x[2] for x in self.info[-self.context_depth:]]
+        self.label["text"] = '\n'.join(context_strings)
 
     def timer_event(self):
         if self.label:
-            self.update_label()
+            self.update_code_context()
         self.text.after(UPDATEINTERVAL, self.timer_event)
 
     def font_timer_event(self):



More information about the Python-checkins mailing list