SearchEngine.py

'''Define SearchEngine for search dialogs.'''
import re
from Tkinter import StringVar, BooleanVar, TclError
import tkMessageBox

def get(root):
    '''Return the singleton SearchEngine instance for the process.

The single SearchEngine saves settings between dialog instances.
    If there is not a SearchEngine already, make one.
    '''
    if not hasattr(root, "_searchengine"):
        root._searchengine = SearchEngine(root)
        # This creates a cycle that persists until root is deleted.
    return root._searchengine

class SearchEngine:
    """Handles searching a text widget for Find, Replace, and Grep."""

def __init__(self, root):
        '''Initialize Variables that save search state.

The dialogs bind these to the UI elements present in the dialogs.
        '''
        self.root = root  # need for report_error()
        self.patvar = StringVar(root, '')   # search pattern
        self.revar = BooleanVar(root, False)   # regular expression?
        self.casevar = BooleanVar(root, False)   # match case?
        self.wordvar = BooleanVar(root, False)   # match whole word?
        self.wrapvar = BooleanVar(root, True)   # wrap around buffer?
        self.backvar = BooleanVar(root, False)   # search backwards?

# Access methods

def getpat(self):
        return self.patvar.get()

def setpat(self, pat):
        self.patvar.set(pat)

def isre(self):
        return self.revar.get()

def iscase(self):
        return self.casevar.get()

def isword(self):
        return self.wordvar.get()

def iswrap(self):
        return self.wrapvar.get()

def isback(self):
        return self.backvar.get()

# Higher level access methods

def setcookedpat(self, pat):
        "Set pattern after escaping if re."
        # called only in SearchDialog.py: 66
        if self.isre():
            pat = re.escape(pat)
        self.setpat(pat)

def getcookedpat(self):
        pat = self.getpat()
        if not self.isre():  # if True, see setcookedpat
            pat = re.escape(pat)
        if self.isword():
            pat = r"\b%s\b" % pat
        return pat

def getprog(self):
        "Return compiled cooked search pattern."
        pat = self.getpat()
        if not pat:
            self.report_error(pat, "Empty regular expression")
            return None
        pat = self.getcookedpat()
        flags = 0
        if not self.iscase():
            flags = flags | re.IGNORECASE
        try:
            prog = re.compile(pat, flags)
        except re.error as what:
            args = what.args
            msg = args[0]
            col = args[1] if len(args) >= 2 else -1
            self.report_error(pat, msg, col)
            return None
        return prog

def report_error(self, pat, msg, col=-1):
        # Derived class could override this with something fancier
        msg = "Error: " + str(msg)
        if pat:
            msg = msg + "\nPattern: " + str(pat)
        if col >= 0:
            msg = msg + "\nOffset: " + str(col)
        tkMessageBox.showerror("Regular expression error",
                               msg, master=self.root)

def search_text(self, text, prog=None, ok=0):
        '''Return (lineno, matchobj) or None for forward/backward search.

This function calls the right function with the right arguments.
        It directly return the result of that call.

Text is a text widget. Prog is a precompiled pattern.
        The ok parameter is a bit complicated as it has two effects.

If there is a selection, the search begin at either end,
        depending on the direction setting and ok, with ok meaning that
        the search starts with the selection. Otherwise, search begins
        at the insert mark.

To aid progress, the search functions do not return an empty
        match at the starting position unless ok is True.
        '''

if not prog:
            prog = self.getprog()
            if not prog:
                return None # Compilation failed -- stop
        wrap = self.wrapvar.get()
        first, last = get_selection(text)
        if self.isback():
            if ok:
                start = last
            else:
                start = first
            line, col = get_line_col(start)
            res = self.search_backward(text, prog, line, col, wrap, ok)
        else:
            if ok:
                start = first
            else:
                start = last
            line, col = get_line_col(start)
            res = self.search_forward(text, prog, line, col, wrap, ok)
        return res

def search_forward(self, text, prog, line, col, wrap, ok=0):
        wrapped = 0
        startline = line
        chars = text.get("%d.0" % line, "%d.0" % (line+1))
        while chars:
            m = prog.search(chars[:-1], col)
            if m:
                if ok or m.end() > col:
                    return line, m
            line = line + 1
            if wrapped and line > startline:
                break
            col = 0
            ok = 1
            chars = text.get("%d.0" % line, "%d.0" % (line+1))
            if not chars and wrap:
                wrapped = 1
                wrap = 0
                line = 1
                chars = text.get("1.0", "2.0")
        return None

def search_backward(self, text, prog, line, col, wrap, ok=0):
        wrapped = 0
        startline = line
        chars = text.get("%d.0" % line, "%d.0" % (line+1))
        while 1:
            m = search_reverse(prog, chars[:-1], col)
            if m:
                if ok or m.start() < col:
                    return line, m
            line = line - 1
            if wrapped and line < startline:
                break
            ok = 1
            if line <= 0:
                if not wrap:
                    break
                wrapped = 1
                wrap = 0
                pos = text.index("end-1c")
                line, col = map(int, pos.split("."))
            chars = text.get("%d.0" % line, "%d.0" % (line+1))
            col = len(chars) - 1
        return None

def search_reverse(prog, chars, col):
    '''Search backwards and return an re match object or None.

This is done by searching forwards until there is no match.
    Prog: compiled re object with a search method returning a match.
    Chars: line of text, without \\n.
    Col: stop index for the search; the limit for match.end().
    '''
    m = prog.search(chars)
    if not m:
        return None
    found = None
    i, j = m.span()  # m.start(), m.end() == match slice indexes
    while i < col and j <= col:
        found = m
        if i == j:
            j = j+1
        m = prog.search(chars, j)
        if not m:
            break
        i, j = m.span()
    return found

def get_selection(text):
    '''Return tuple of 'line.col' indexes from selection or insert mark.
    '''
    try:
        first = text.index("sel.first")
        last = text.index("sel.last")
    except TclError:
        first = last = None
    if not first:
        first = text.index("insert")
    if not last:
        last = first
    return first, last

def get_line_col(index):
    '''Return (line, col) tuple of ints from 'line.col' string.'''
    line, col = map(int, index.split(".")) # Fails on invalid index
    return line, col

if __name__ == "__main__":
    import unittest
    unittest.main('idlelib.idle_test.test_searchengine', verbosity=2, exit=False)

docroot: /home/induvedam/public_html

curdir: /opt/alt/python27/lib64/python2.7/idlelib

	.	8192
	..	24576
X	AutoComplete.py	8964
X	AutoComplete.pyc	8181
X	AutoComplete.pyo	8181
X	AutoCompleteWindow.py	17318
X	AutoCompleteWindow.pyc	12714
X	AutoCompleteWindow.pyo	12655
X	AutoExpand.py	3395
X	AutoExpand.pyc	3580
X	AutoExpand.pyo	3580
X	Bindings.py	2976
X	Bindings.pyc	4708
X	Bindings.pyo	4708
X	CREDITS.txt	1866
X	CallTipWindow.py	6065
X	CallTipWindow.pyc	6292
X	CallTipWindow.pyo	6292
X	CallTips.py	7740
X	CallTips.pyc	8354
X	CallTips.pyo	8354
X	ChangeLog	56393
X	ClassBrowser.py	6999
X	ClassBrowser.pyc	9890
X	ClassBrowser.pyo	9890
X	CodeContext.py	8342
X	CodeContext.pyc	6788
X	CodeContext.pyo	6744
X	ColorDelegator.py	9762
X	ColorDelegator.pyc	9119
X	ColorDelegator.pyo	9119
X	Debugger.py	18236
X	Debugger.pyc	18144
X	Debugger.pyo	18144
X	Delegator.py	665
X	Delegator.pyc	1346
X	Delegator.pyo	1346
X	EditorWindow.py	65498
X	EditorWindow.pyc	58522
X	EditorWindow.pyo	58420
X	FileList.py	3718
X	FileList.pyc	4168
X	FileList.pyo	4135
X	FormatParagraph.py	7287
X	FormatParagraph.pyc	7311
X	FormatParagraph.pyo	7311
X	GrepDialog.py	5145
X	GrepDialog.pyc	6607
X	GrepDialog.pyo	6607
X	HISTORY.txt	10317
X	HyperParser.py	10497
X	HyperParser.pyc	6803
X	HyperParser.pyo	6803
X	IOBinding.py	21911
X	IOBinding.pyc	19068
X	IOBinding.pyo	19068
	Icons	4096
X	IdleHistory.py	4052
X	IdleHistory.pyc	4151
X	IdleHistory.pyo	4151
X	MultiCall.py	17701
X	MultiCall.pyc	16793
X	MultiCall.pyo	16719
X	MultiStatusBar.py	1348
X	MultiStatusBar.pyc	2357
X	MultiStatusBar.pyo	2357
X	NEWS.txt	47247
X	ObjectBrowser.py	4376
X	ObjectBrowser.pyc	7431
X	ObjectBrowser.pyo	7431
X	OutputWindow.py	4576
X	OutputWindow.pyc	5427
X	OutputWindow.pyo	5427
X	ParenMatch.py	6714
X	ParenMatch.pyc	7350
X	ParenMatch.pyo	7350
X	PathBrowser.py	3009
X	PathBrowser.pyc	4681
X	PathBrowser.pyo	4681
X	Percolator.py	3222
X	Percolator.pyc	4803
X	Percolator.pyo	4619
X	PyParse.py	19510
X	PyParse.pyc	10226
X	PyParse.pyo	9788
X	PyShell.py	58872
X	PyShell.pyc	54269
X	PyShell.pyo	54167
X	README.txt	7890
X	RemoteDebugger.py	11632
X	RemoteDebugger.pyc	17131
X	RemoteDebugger.pyo	16977
X	RemoteObjectBrowser.py	942
X	RemoteObjectBrowser.pyc	2280
X	RemoteObjectBrowser.pyo	2280
X	ReplaceDialog.py	6639
X	ReplaceDialog.pyc	8016
X	ReplaceDialog.pyo	8016
X	RstripExtension.py	1050
X	RstripExtension.pyc	1665
X	RstripExtension.pyo	1665
X	ScriptBinding.py	8459
X	ScriptBinding.pyc	8370
X	ScriptBinding.pyo	8370
X	ScrolledList.py	4373
X	ScrolledList.pyc	6768
X	ScrolledList.pyo	6768
X	SearchDialog.py	2630
X	SearchDialog.pyc	4139
X	SearchDialog.pyo	4139
X	SearchDialogBase.py	7094
X	SearchDialogBase.pyc	8631
X	SearchDialogBase.pyo	8631
X	SearchEngine.py	7463
X	SearchEngine.pyc	8575
X	SearchEngine.pyo	8575
X	StackViewer.py	4431
X	StackViewer.pyc	6677
X	StackViewer.pyo	6677
X	TODO.txt	8478
X	ToolTip.py	3173
X	ToolTip.pyc	4890
X	ToolTip.pyo	4890
X	TreeWidget.py	15037
X	TreeWidget.pyc	18383
X	TreeWidget.pyo	18383
X	UndoDelegator.py	10787
X	UndoDelegator.pyc	14218
X	UndoDelegator.pyo	14218
X	WidgetRedirector.py	6906
X	WidgetRedirector.pyc	7951
X	WidgetRedirector.pyo	7951
X	WindowList.py	2473
X	WindowList.pyc	3831
X	WindowList.pyo	3831
X	ZoomHeight.py	1300
X	ZoomHeight.pyc	1711
X	ZoomHeight.pyo	1711
X	__init__.py	288
X	__init__.pyc	444
X	__init__.pyo	444
X	aboutDialog.py	7014
X	aboutDialog.pyc	7017
X	aboutDialog.pyo	7017
X	config-extensions.def	2965
X	config-highlight.def	2515
X	config-keys.def	7777
X	config-main.def	2561
X	configDialog.py	65958
X	configDialog.pyc	54435
X	configDialog.pyo	54435
X	configHandler.py	32485
X	configHandler.pyc	29985
X	configHandler.pyo	29985
X	configHelpSourceEdit.py	6686
X	configHelpSourceEdit.pyc	6712
X	configHelpSourceEdit.pyo	6712
X	configSectionNameDialog.py	4040
X	configSectionNameDialog.pyc	4510
X	configSectionNameDialog.pyo	4510
X	dynOptionMenuWidget.py	1984
X	dynOptionMenuWidget.pyc	2868
X	dynOptionMenuWidget.pyo	2868
X	extend.txt	3642
X	help.html	42414
X	help.py	11035
X	help.pyc	12543
X	help.pyo	12543
X	help.txt	12144
X	idle.py	453
X	idle.pyc	423
X	idle.pyo	423
X	idle.pyw	563
	idle_test	4096
X	idlever.py	415
X	idlever.pyc	591
X	idlever.pyo	591
X	keybindingDialog.py	12468
X	keybindingDialog.pyc	12368
X	keybindingDialog.pyo	12368
X	macosxSupport.py	8435
X	macosxSupport.pyc	8585
X	macosxSupport.pyo	8447
X	rpc.py	20150
X	rpc.pyc	22495
X	rpc.pyo	22389
X	run.py	12917
X	run.pyc	13770
X	run.pyo	13712
X	tabbedpages.py	18439
X	tabbedpages.pyc	19081
X	tabbedpages.pyo	19081
X	textView.py	3520
X	textView.pyc	4116
X	textView.pyo	4116