Chris@13
|
1 <?php
|
Chris@13
|
2
|
Chris@13
|
3 /*
|
Chris@13
|
4 * This file is part of Psy Shell.
|
Chris@13
|
5 *
|
Chris@13
|
6 * (c) 2012-2018 Justin Hileman
|
Chris@13
|
7 *
|
Chris@13
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@13
|
9 * file that was distributed with this source code.
|
Chris@13
|
10 */
|
Chris@13
|
11
|
Chris@13
|
12 namespace Psy\Readline;
|
Chris@13
|
13
|
Chris@13
|
14 use Psy\Exception\BreakException;
|
Chris@13
|
15
|
Chris@13
|
16 /**
|
Chris@13
|
17 * An array-based Readline emulation implementation.
|
Chris@13
|
18 */
|
Chris@13
|
19 class Transient implements Readline
|
Chris@13
|
20 {
|
Chris@13
|
21 private $history;
|
Chris@13
|
22 private $historySize;
|
Chris@13
|
23 private $eraseDups;
|
Chris@13
|
24 private $stdin;
|
Chris@13
|
25
|
Chris@13
|
26 /**
|
Chris@13
|
27 * Transient Readline is always supported.
|
Chris@13
|
28 *
|
Chris@13
|
29 * {@inheritdoc}
|
Chris@13
|
30 */
|
Chris@13
|
31 public static function isSupported()
|
Chris@13
|
32 {
|
Chris@13
|
33 return true;
|
Chris@13
|
34 }
|
Chris@13
|
35
|
Chris@13
|
36 /**
|
Chris@13
|
37 * Transient Readline constructor.
|
Chris@13
|
38 */
|
Chris@13
|
39 public function __construct($historyFile = null, $historySize = 0, $eraseDups = false)
|
Chris@13
|
40 {
|
Chris@13
|
41 // don't do anything with the history file...
|
Chris@13
|
42 $this->history = [];
|
Chris@13
|
43 $this->historySize = $historySize;
|
Chris@13
|
44 $this->eraseDups = $eraseDups;
|
Chris@13
|
45 }
|
Chris@13
|
46
|
Chris@13
|
47 /**
|
Chris@13
|
48 * {@inheritdoc}
|
Chris@13
|
49 */
|
Chris@13
|
50 public function addHistory($line)
|
Chris@13
|
51 {
|
Chris@13
|
52 if ($this->eraseDups) {
|
Chris@17
|
53 if (($key = \array_search($line, $this->history)) !== false) {
|
Chris@13
|
54 unset($this->history[$key]);
|
Chris@13
|
55 }
|
Chris@13
|
56 }
|
Chris@13
|
57
|
Chris@13
|
58 $this->history[] = $line;
|
Chris@13
|
59
|
Chris@13
|
60 if ($this->historySize > 0) {
|
Chris@17
|
61 $histsize = \count($this->history);
|
Chris@13
|
62 if ($histsize > $this->historySize) {
|
Chris@17
|
63 $this->history = \array_slice($this->history, $histsize - $this->historySize);
|
Chris@13
|
64 }
|
Chris@13
|
65 }
|
Chris@13
|
66
|
Chris@17
|
67 $this->history = \array_values($this->history);
|
Chris@13
|
68
|
Chris@13
|
69 return true;
|
Chris@13
|
70 }
|
Chris@13
|
71
|
Chris@13
|
72 /**
|
Chris@13
|
73 * {@inheritdoc}
|
Chris@13
|
74 */
|
Chris@13
|
75 public function clearHistory()
|
Chris@13
|
76 {
|
Chris@13
|
77 $this->history = [];
|
Chris@13
|
78
|
Chris@13
|
79 return true;
|
Chris@13
|
80 }
|
Chris@13
|
81
|
Chris@13
|
82 /**
|
Chris@13
|
83 * {@inheritdoc}
|
Chris@13
|
84 */
|
Chris@13
|
85 public function listHistory()
|
Chris@13
|
86 {
|
Chris@13
|
87 return $this->history;
|
Chris@13
|
88 }
|
Chris@13
|
89
|
Chris@13
|
90 /**
|
Chris@13
|
91 * {@inheritdoc}
|
Chris@13
|
92 */
|
Chris@13
|
93 public function readHistory()
|
Chris@13
|
94 {
|
Chris@13
|
95 return true;
|
Chris@13
|
96 }
|
Chris@13
|
97
|
Chris@13
|
98 /**
|
Chris@13
|
99 * {@inheritdoc}
|
Chris@13
|
100 *
|
Chris@13
|
101 * @throws BreakException if user hits Ctrl+D
|
Chris@13
|
102 *
|
Chris@13
|
103 * @return string
|
Chris@13
|
104 */
|
Chris@13
|
105 public function readline($prompt = null)
|
Chris@13
|
106 {
|
Chris@13
|
107 echo $prompt;
|
Chris@13
|
108
|
Chris@17
|
109 return \rtrim(\fgets($this->getStdin()), "\n\r");
|
Chris@13
|
110 }
|
Chris@13
|
111
|
Chris@13
|
112 /**
|
Chris@13
|
113 * {@inheritdoc}
|
Chris@13
|
114 */
|
Chris@13
|
115 public function redisplay()
|
Chris@13
|
116 {
|
Chris@13
|
117 // noop
|
Chris@13
|
118 }
|
Chris@13
|
119
|
Chris@13
|
120 /**
|
Chris@13
|
121 * {@inheritdoc}
|
Chris@13
|
122 */
|
Chris@13
|
123 public function writeHistory()
|
Chris@13
|
124 {
|
Chris@13
|
125 return true;
|
Chris@13
|
126 }
|
Chris@13
|
127
|
Chris@13
|
128 /**
|
Chris@13
|
129 * Get a STDIN file handle.
|
Chris@13
|
130 *
|
Chris@13
|
131 * @throws BreakException if user hits Ctrl+D
|
Chris@13
|
132 *
|
Chris@13
|
133 * @return resource
|
Chris@13
|
134 */
|
Chris@13
|
135 private function getStdin()
|
Chris@13
|
136 {
|
Chris@13
|
137 if (!isset($this->stdin)) {
|
Chris@17
|
138 $this->stdin = \fopen('php://stdin', 'r');
|
Chris@13
|
139 }
|
Chris@13
|
140
|
Chris@17
|
141 if (\feof($this->stdin)) {
|
Chris@13
|
142 throw new BreakException('Ctrl+D');
|
Chris@13
|
143 }
|
Chris@13
|
144
|
Chris@13
|
145 return $this->stdin;
|
Chris@13
|
146 }
|
Chris@13
|
147 }
|