Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 1 | "Implement Idle Shell history mechanism with History class" |
| 2 | |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 3 | from idlelib.config import idleConf |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 4 | |
Terry Jan Reedy | bfbaa6b | 2016-08-31 00:50:55 -0400 | [diff] [blame^] | 5 | |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 6 | class History: |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 7 | ''' Implement Idle Shell history mechanism. |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 8 | |
Terry Jan Reedy | 6fa5bdc | 2016-05-28 13:22:31 -0400 | [diff] [blame] | 9 | store - Store source statement (called from pyshell.resetoutput). |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 10 | fetch - Fetch stored statement matching prefix already entered. |
| 11 | history_next - Bound to <<history-next>> event (default Alt-N). |
| 12 | history_prev - Bound to <<history-prev>> event (default Alt-P). |
| 13 | ''' |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 14 | def __init__(self, text): |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 15 | '''Initialize data attributes and bind event methods. |
| 16 | |
| 17 | .text - Idle wrapper of tk Text widget, with .bell(). |
| 18 | .history - source statements, possibly with multiple lines. |
| 19 | .prefix - source already entered at prompt; filters history list. |
| 20 | .pointer - index into history. |
| 21 | .cyclic - wrap around history list (or not). |
| 22 | ''' |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 23 | self.text = text |
| 24 | self.history = [] |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 25 | self.prefix = None |
| 26 | self.pointer = None |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 27 | self.cyclic = idleConf.GetOption("main", "History", "cyclic", 1, "bool") |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 28 | text.bind("<<history-previous>>", self.history_prev) |
| 29 | text.bind("<<history-next>>", self.history_next) |
| 30 | |
| 31 | def history_next(self, event): |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 32 | "Fetch later statement; start with ealiest if cyclic." |
| 33 | self.fetch(reverse=False) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 34 | return "break" |
| 35 | |
| 36 | def history_prev(self, event): |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 37 | "Fetch earlier statement; start with most recent." |
| 38 | self.fetch(reverse=True) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 39 | return "break" |
| 40 | |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 41 | def fetch(self, reverse): |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 42 | '''Fetch statememt and replace current line in text widget. |
| 43 | |
| 44 | Set prefix and pointer as needed for successive fetches. |
| 45 | Reset them to None, None when returning to the start line. |
| 46 | Sound bell when return to start line or cannot leave a line |
| 47 | because cyclic is False. |
| 48 | ''' |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 49 | nhist = len(self.history) |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 50 | pointer = self.pointer |
| 51 | prefix = self.prefix |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 52 | if pointer is not None and prefix is not None: |
| 53 | if self.text.compare("insert", "!=", "end-1c") or \ |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 54 | self.text.get("iomark", "end-1c") != self.history[pointer]: |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 55 | pointer = prefix = None |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 56 | self.text.mark_set("insert", "end-1c") # != after cursor move |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 57 | if pointer is None or prefix is None: |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 58 | prefix = self.text.get("iomark", "end-1c") |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 59 | if reverse: |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 60 | pointer = nhist # will be decremented |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 61 | else: |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 62 | if self.cyclic: |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 63 | pointer = -1 # will be incremented |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 64 | else: # abort history_next |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 65 | self.text.bell() |
| 66 | return |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 67 | nprefix = len(prefix) |
| 68 | while 1: |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 69 | pointer += -1 if reverse else 1 |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 70 | if pointer < 0 or pointer >= nhist: |
| 71 | self.text.bell() |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 72 | if not self.cyclic and pointer < 0: # abort history_prev |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 73 | return |
| 74 | else: |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 75 | if self.text.get("iomark", "end-1c") != prefix: |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 76 | self.text.delete("iomark", "end-1c") |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 77 | self.text.insert("iomark", prefix) |
Kurt B. Kaiser | 0676dfd | 2005-02-03 01:37:14 +0000 | [diff] [blame] | 78 | pointer = prefix = None |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 79 | break |
| 80 | item = self.history[pointer] |
| 81 | if item[:nprefix] == prefix and len(item) > nprefix: |
| 82 | self.text.delete("iomark", "end-1c") |
Terry Jan Reedy | 29c3fc5 | 2013-08-15 16:19:13 -0400 | [diff] [blame] | 83 | self.text.insert("iomark", item) |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 84 | break |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 85 | self.text.see("insert") |
| 86 | self.text.tag_remove("sel", "1.0", "end") |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 87 | self.pointer = pointer |
| 88 | self.prefix = prefix |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 89 | |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 90 | def store(self, source): |
| 91 | "Store Shell input statement into history list." |
Kurt B. Kaiser | 6b06f29 | 2002-09-16 22:09:19 +0000 | [diff] [blame] | 92 | source = source.strip() |
David Scherer | 7aced17 | 2000-08-15 01:13:23 +0000 | [diff] [blame] | 93 | if len(source) > 2: |
| 94 | # avoid duplicates |
| 95 | try: |
| 96 | self.history.remove(source) |
| 97 | except ValueError: |
| 98 | pass |
| 99 | self.history.append(source) |
Terry Jan Reedy | 0a01ac4 | 2013-08-13 19:51:04 -0400 | [diff] [blame] | 100 | self.pointer = None |
| 101 | self.prefix = None |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 102 | |
Terry Jan Reedy | bfbaa6b | 2016-08-31 00:50:55 -0400 | [diff] [blame^] | 103 | |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 104 | if __name__ == "__main__": |
Terry Jan Reedy | c2564f9 | 2013-08-15 14:32:04 -0400 | [diff] [blame] | 105 | from unittest import main |
Terry Jan Reedy | bfbaa6b | 2016-08-31 00:50:55 -0400 | [diff] [blame^] | 106 | main('idlelib.idle_test.test_history', verbosity=2, exit=False) |