| 1 | n/a | "Implement Idle Shell history mechanism with History class" |
|---|
| 2 | n/a | |
|---|
| 3 | n/a | from idlelib.configHandler import idleConf |
|---|
| 4 | n/a | |
|---|
| 5 | n/a | class History: |
|---|
| 6 | n/a | ''' Implement Idle Shell history mechanism. |
|---|
| 7 | n/a | |
|---|
| 8 | n/a | store - Store source statement (called from PyShell.resetoutput). |
|---|
| 9 | n/a | fetch - Fetch stored statement matching prefix already entered. |
|---|
| 10 | n/a | history_next - Bound to <<history-next>> event (default Alt-N). |
|---|
| 11 | n/a | history_prev - Bound to <<history-prev>> event (default Alt-P). |
|---|
| 12 | n/a | ''' |
|---|
| 13 | n/a | def __init__(self, text, output_sep = "\n"): |
|---|
| 14 | n/a | '''Initialize data attributes and bind event methods. |
|---|
| 15 | n/a | |
|---|
| 16 | n/a | .text - Idle wrapper of tk Text widget, with .bell(). |
|---|
| 17 | n/a | .history - source statements, possibly with multiple lines. |
|---|
| 18 | n/a | .prefix - source already entered at prompt; filters history list. |
|---|
| 19 | n/a | .pointer - index into history. |
|---|
| 20 | n/a | .cyclic - wrap around history list (or not). |
|---|
| 21 | n/a | ''' |
|---|
| 22 | n/a | self.text = text |
|---|
| 23 | n/a | self.history = [] |
|---|
| 24 | n/a | self.prefix = None |
|---|
| 25 | n/a | self.pointer = None |
|---|
| 26 | n/a | self.output_sep = output_sep |
|---|
| 27 | n/a | self.cyclic = idleConf.GetOption("main", "History", "cyclic", 1, "bool") |
|---|
| 28 | n/a | text.bind("<<history-previous>>", self.history_prev) |
|---|
| 29 | n/a | text.bind("<<history-next>>", self.history_next) |
|---|
| 30 | n/a | |
|---|
| 31 | n/a | def history_next(self, event): |
|---|
| 32 | n/a | "Fetch later statement; start with ealiest if cyclic." |
|---|
| 33 | n/a | self.fetch(reverse=False) |
|---|
| 34 | n/a | return "break" |
|---|
| 35 | n/a | |
|---|
| 36 | n/a | def history_prev(self, event): |
|---|
| 37 | n/a | "Fetch earlier statement; start with most recent." |
|---|
| 38 | n/a | self.fetch(reverse=True) |
|---|
| 39 | n/a | return "break" |
|---|
| 40 | n/a | |
|---|
| 41 | n/a | def _get_source(self, start, end): |
|---|
| 42 | n/a | # Get source code from start index to end index. Lines in the |
|---|
| 43 | n/a | # text control may be separated by sys.ps2 . |
|---|
| 44 | n/a | lines = self.text.get(start, end).split(self.output_sep) |
|---|
| 45 | n/a | return "\n".join(lines) |
|---|
| 46 | n/a | |
|---|
| 47 | n/a | def _put_source(self, where, source): |
|---|
| 48 | n/a | output = self.output_sep.join(source.split("\n")) |
|---|
| 49 | n/a | self.text.insert(where, output) |
|---|
| 50 | n/a | |
|---|
| 51 | n/a | def fetch(self, reverse): |
|---|
| 52 | n/a | "Fetch statememt and enter into text at cursor." |
|---|
| 53 | n/a | nhist = len(self.history) |
|---|
| 54 | n/a | pointer = self.pointer |
|---|
| 55 | n/a | prefix = self.prefix |
|---|
| 56 | n/a | if pointer is not None and prefix is not None: |
|---|
| 57 | n/a | if self.text.compare("insert", "!=", "end-1c") or \ |
|---|
| 58 | n/a | self._get_source("iomark", "end-1c") != self.history[pointer]: |
|---|
| 59 | n/a | pointer = prefix = None |
|---|
| 60 | n/a | if pointer is None or prefix is None: |
|---|
| 61 | n/a | prefix = self._get_source("iomark", "end-1c") |
|---|
| 62 | n/a | if reverse: |
|---|
| 63 | n/a | pointer = nhist # will be decremented |
|---|
| 64 | n/a | else: |
|---|
| 65 | n/a | if self.cyclic: |
|---|
| 66 | n/a | pointer = -1 # will be incremented |
|---|
| 67 | n/a | else: |
|---|
| 68 | n/a | self.text.bell() |
|---|
| 69 | n/a | return |
|---|
| 70 | n/a | nprefix = len(prefix) |
|---|
| 71 | n/a | while 1: |
|---|
| 72 | n/a | if reverse: |
|---|
| 73 | n/a | pointer = pointer - 1 |
|---|
| 74 | n/a | else: |
|---|
| 75 | n/a | pointer = pointer + 1 |
|---|
| 76 | n/a | if pointer < 0 or pointer >= nhist: |
|---|
| 77 | n/a | self.text.bell() |
|---|
| 78 | n/a | if not self.cyclic and pointer < 0: |
|---|
| 79 | n/a | return |
|---|
| 80 | n/a | else: |
|---|
| 81 | n/a | if self._get_source("iomark", "end-1c") != prefix: |
|---|
| 82 | n/a | self.text.delete("iomark", "end-1c") |
|---|
| 83 | n/a | self._put_source("iomark", prefix) |
|---|
| 84 | n/a | pointer = prefix = None |
|---|
| 85 | n/a | break |
|---|
| 86 | n/a | item = self.history[pointer] |
|---|
| 87 | n/a | if item[:nprefix] == prefix and len(item) > nprefix: |
|---|
| 88 | n/a | self.text.delete("iomark", "end-1c") |
|---|
| 89 | n/a | self._put_source("iomark", item) |
|---|
| 90 | n/a | break |
|---|
| 91 | n/a | self.text.mark_set("insert", "end-1c") |
|---|
| 92 | n/a | self.text.see("insert") |
|---|
| 93 | n/a | self.text.tag_remove("sel", "1.0", "end") |
|---|
| 94 | n/a | self.pointer = pointer |
|---|
| 95 | n/a | self.prefix = prefix |
|---|
| 96 | n/a | |
|---|
| 97 | n/a | def store(self, source): |
|---|
| 98 | n/a | "Store Shell input statement into history list." |
|---|
| 99 | n/a | source = source.strip() |
|---|
| 100 | n/a | if len(source) > 2: |
|---|
| 101 | n/a | # avoid duplicates |
|---|
| 102 | n/a | try: |
|---|
| 103 | n/a | self.history.remove(source) |
|---|
| 104 | n/a | except ValueError: |
|---|
| 105 | n/a | pass |
|---|
| 106 | n/a | self.history.append(source) |
|---|
| 107 | n/a | self.pointer = None |
|---|
| 108 | n/a | self.prefix = None |
|---|