-
Notifications
You must be signed in to change notification settings - Fork 20
/
terminal.go
122 lines (101 loc) · 4.11 KB
/
terminal.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// This file is part of Gopher2600.
//
// Gopher2600 is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Gopher2600 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Gopher2600. If not, see <https://www.gnu.org/licenses/>.
package terminal
import (
"os"
"github.com/jetsetilly/gopher2600/userinput"
)
// Input defines the operations required by an interface that allows input.
type Input interface {
// TermRead will return the number of characters inserted into the buffer,
// or an error, when completed.
//
// If possible the TermRead() implementation should regularly check the
// ReadEvents channels for activity. Not all implementations will be able
// to do so because of the context in which they operate.
//
// Implementations that can't check ReadEvents will surely limit the
// functionality of the debugger.
TermRead(buffer []byte, prompt Prompt, events *ReadEvents) (int, error)
// TermReadCheck() returns true if there is input to be read. Not all
// implementations will be able return anything meaningful in which case a
// return value of false is fine.
//
// Note that TermReadCheck() does not check for events like TermRead().
TermReadCheck() bool
// IsInteractive() should return true for implementations that require user
// interaction. Instances that don't expect user intervention should return
// false.
IsInteractive() bool
// IsRealTerminal returns true if the terminal implementation is using a
// real terminal for Input.
IsRealTerminal() bool
}
// Sentinal errors controlling program exit
const (
UserInterrupt = "user interrupt"
UserAbort = "user abort"
// UserQuit indicates an intentional quit and should probably be caught and silenced
UserQuit = "user quit"
)
// ReadEvents *must* be monitored during a TermRead().
type ReadEvents struct {
// user input events. these are the inputs into the emulation (ie.
// joystick, paddle, etc.)
UserInput chan userinput.Event
UserInputHandler func(userinput.Event) error
// interrupt signals from the operating system
IntEvents chan os.Signal
// RawEvents allows functions to be pushed into the debugger goroutine
//
// errors are not returned by RawEvents so errors should be logged
RawEvents chan func()
// RawEventsReturn is the same as RawEvnts but handlers must return control
// to the debugger inputloop after the function has run
RawEventsReturn chan func()
}
// Output defines the operations required by an interface that allows output.
type Output interface {
TermPrintLine(Style, string)
}
// Terminal defines the operations required by the debugger's command line interface.
type Terminal interface {
// Terminal implementation also implement the Input and Output interfaces.
Input
Output
// Initialise the terminal. not all terminal implementations will need to
// do anything.
Initialise() error
// Restore the terminal to it's original state, if possible. for example,
// we could use this to make sure the terminal is returned to canonical
// mode. not all terminal implementations will need to do anything.
CleanUp()
// Register a tab completion implementation to use with the terminal. Not
// all implementations need to respond meaningfully to this.
RegisterTabCompletion(TabCompletion)
// Silence all input and output except error messages. In other words,
// TermPrintLine() should display error messages even if silenced is true.
Silence(silenced bool)
}
// TabCompletion defines the operations required for tab completion. A good
// implementation can be found in the commandline sub-package.
type TabCompletion interface {
Complete(input string) string
Reset()
}
// Broker implementations can identify a terminal.
type Broker interface {
GetTerminal() Terminal
}