Skip to content

Commit dd4bc44

Browse files
cppforlifemaximilien
cppforlife
authored and
maximilien
committed
made ui classes public
Signed-off-by: Michael Maximilien <[email protected]>
1 parent c96fa48 commit dd4bc44

File tree

5 files changed

+68
-68
lines changed

5 files changed

+68
-68
lines changed

‎ui/color_ui.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ type ColorUI struct {
1313
boldFunc func(string, ...interface{}) string
1414
}
1515

16-
func NewColorUI(parent UI) UI {
16+
func NewColorUI(parent UI) *ColorUI {
1717
return &ColorUI{
1818
parent: parent,
1919
okFunc: color.New(color.FgGreen).SprintfFunc(),

‎ui/indenting_ui.go‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,62 +6,62 @@ import (
66
. "github.com/cppforlife/go-cli-ui/ui/table"
77
)
88

9-
type indentingUI struct {
9+
type IndentingUI struct {
1010
parent UI
1111
}
1212

13-
func NewIndentingUI(parent UI) UI {
14-
return &indentingUI{parent: parent}
13+
func NewIndentingUI(parent UI) *IndentingUI {
14+
return &IndentingUI{parent: parent}
1515
}
1616

17-
func (ui *indentingUI) ErrorLinef(pattern string, args ...interface{}) {
17+
func (ui *IndentingUI) ErrorLinef(pattern string, args ...interface{}) {
1818
ui.parent.ErrorLinef(" %s", fmt.Sprintf(pattern, args...))
1919
}
2020

21-
func (ui *indentingUI) PrintLinef(pattern string, args ...interface{}) {
21+
func (ui *IndentingUI) PrintLinef(pattern string, args ...interface{}) {
2222
ui.parent.PrintLinef(" %s", fmt.Sprintf(pattern, args...))
2323
}
2424

25-
func (ui *indentingUI) BeginLinef(pattern string, args ...interface{}) {
25+
func (ui *IndentingUI) BeginLinef(pattern string, args ...interface{}) {
2626
ui.parent.BeginLinef(" %s", fmt.Sprintf(pattern, args...))
2727
}
2828

29-
func (ui *indentingUI) EndLinef(pattern string, args ...interface{}) {
29+
func (ui *IndentingUI) EndLinef(pattern string, args ...interface{}) {
3030
ui.parent.EndLinef(pattern, args...)
3131
}
3232

33-
func (ui *indentingUI) PrintBlock(block []byte) {
33+
func (ui *IndentingUI) PrintBlock(block []byte) {
3434
ui.parent.PrintBlock(block)
3535
}
3636

37-
func (ui *indentingUI) PrintErrorBlock(block string) {
37+
func (ui *IndentingUI) PrintErrorBlock(block string) {
3838
ui.parent.PrintErrorBlock(block)
3939
}
4040

41-
func (ui *indentingUI) PrintTable(table Table) {
41+
func (ui *IndentingUI) PrintTable(table Table) {
4242
ui.parent.PrintTable(table)
4343
}
4444

45-
func (ui *indentingUI) AskForText(label string) (string, error) {
45+
func (ui *IndentingUI) AskForText(label string) (string, error) {
4646
return ui.parent.AskForText(label)
4747
}
4848

49-
func (ui *indentingUI) AskForChoice(label string, options []string) (int, error) {
49+
func (ui *IndentingUI) AskForChoice(label string, options []string) (int, error) {
5050
return ui.parent.AskForChoice(label, options)
5151
}
5252

53-
func (ui *indentingUI) AskForPassword(label string) (string, error) {
53+
func (ui *IndentingUI) AskForPassword(label string) (string, error) {
5454
return ui.parent.AskForPassword(label)
5555
}
5656

57-
func (ui *indentingUI) AskForConfirmation() error {
57+
func (ui *IndentingUI) AskForConfirmation() error {
5858
return ui.parent.AskForConfirmation()
5959
}
6060

61-
func (ui *indentingUI) IsInteractive() bool {
61+
func (ui *IndentingUI) IsInteractive() bool {
6262
return ui.parent.IsInteractive()
6363
}
6464

65-
func (ui *indentingUI) Flush() {
65+
func (ui *IndentingUI) Flush() {
6666
ui.parent.Flush()
6767
}

‎ui/json_ui.go‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
. "github.com/cppforlife/go-cli-ui/ui/table"
1010
)
1111

12-
type jsonUI struct {
12+
type JSONUI struct {
1313
parent UI
1414
uiResp uiResp
1515

@@ -30,35 +30,35 @@ type tableResp struct {
3030
Notes []string
3131
}
3232

33-
func NewJSONUI(parent UI, logger ExternalLogger) UI {
34-
return &jsonUI{parent: parent, logTag: "JSONUI", logger: logger}
33+
func NewJSONUI(parent UI, logger ExternalLogger) *JSONUI {
34+
return &JSONUI{parent: parent, logTag: "JSONUI", logger: logger}
3535
}
3636

37-
func (ui *jsonUI) ErrorLinef(pattern string, args ...interface{}) {
37+
func (ui *JSONUI) ErrorLinef(pattern string, args ...interface{}) {
3838
ui.addLine(pattern, args)
3939
}
4040

41-
func (ui *jsonUI) PrintLinef(pattern string, args ...interface{}) {
41+
func (ui *JSONUI) PrintLinef(pattern string, args ...interface{}) {
4242
ui.addLine(pattern, args)
4343
}
4444

45-
func (ui *jsonUI) BeginLinef(pattern string, args ...interface{}) {
45+
func (ui *JSONUI) BeginLinef(pattern string, args ...interface{}) {
4646
ui.addLine(pattern, args)
4747
}
4848

49-
func (ui *jsonUI) EndLinef(pattern string, args ...interface{}) {
49+
func (ui *JSONUI) EndLinef(pattern string, args ...interface{}) {
5050
ui.addLine(pattern, args)
5151
}
5252

53-
func (ui *jsonUI) PrintBlock(block []byte) {
53+
func (ui *JSONUI) PrintBlock(block []byte) {
5454
ui.uiResp.Blocks = append(ui.uiResp.Blocks, string(block))
5555
}
5656

57-
func (ui *jsonUI) PrintErrorBlock(block string) {
57+
func (ui *JSONUI) PrintErrorBlock(block string) {
5858
ui.uiResp.Blocks = append(ui.uiResp.Blocks, block)
5959
}
6060

61-
func (ui *jsonUI) PrintTable(table Table) {
61+
func (ui *JSONUI) PrintTable(table Table) {
6262
table.FillFirstColumn = true
6363

6464
header := map[string]string{}
@@ -98,27 +98,27 @@ func (ui *jsonUI) PrintTable(table Table) {
9898
ui.uiResp.Tables = append(ui.uiResp.Tables, resp)
9999
}
100100

101-
func (ui *jsonUI) AskForText(_ string) (string, error) {
101+
func (ui *JSONUI) AskForText(_ string) (string, error) {
102102
panic("Cannot ask for input in JSON UI")
103103
}
104104

105-
func (ui *jsonUI) AskForChoice(_ string, _ []string) (int, error) {
105+
func (ui *JSONUI) AskForChoice(_ string, _ []string) (int, error) {
106106
panic("Cannot ask for a choice in JSON UI")
107107
}
108108

109-
func (ui *jsonUI) AskForPassword(_ string) (string, error) {
109+
func (ui *JSONUI) AskForPassword(_ string) (string, error) {
110110
panic("Cannot ask for password in JSON UI")
111111
}
112112

113-
func (ui *jsonUI) AskForConfirmation() error {
113+
func (ui *JSONUI) AskForConfirmation() error {
114114
panic("Cannot ask for confirmation in JSON UI")
115115
}
116116

117-
func (ui *jsonUI) IsInteractive() bool {
117+
func (ui *JSONUI) IsInteractive() bool {
118118
return ui.parent.IsInteractive()
119119
}
120120

121-
func (ui *jsonUI) Flush() {
121+
func (ui *JSONUI) Flush() {
122122
defer ui.parent.Flush()
123123

124124
if !reflect.DeepEqual(ui.uiResp, uiResp{}) {
@@ -132,7 +132,7 @@ func (ui *jsonUI) Flush() {
132132
}
133133
}
134134

135-
func (ui *jsonUI) stringRows(header []Header, rows [][]Value) []map[string]string {
135+
func (ui *JSONUI) stringRows(header []Header, rows [][]Value) []map[string]string {
136136
result := []map[string]string{}
137137

138138
for _, row := range rows {
@@ -152,7 +152,7 @@ func (ui *jsonUI) stringRows(header []Header, rows [][]Value) []map[string]strin
152152
return result
153153
}
154154

155-
func (ui *jsonUI) addLine(pattern string, args []interface{}) {
155+
func (ui *JSONUI) addLine(pattern string, args []interface{}) {
156156
msg := fmt.Sprintf(pattern, args...)
157157
ui.uiResp.Lines = append(ui.uiResp.Lines, msg)
158158
ui.logger.Debug(ui.logTag, msg)

‎ui/non_interactive.go‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,63 +4,63 @@ import (
44
. "github.com/cppforlife/go-cli-ui/ui/table"
55
)
66

7-
type nonInteractiveUI struct {
7+
type NonInteractiveUI struct {
88
parent UI
99
}
1010

11-
func NewNonInteractiveUI(parent UI) UI {
12-
return &nonInteractiveUI{parent: parent}
11+
func NewNonInteractiveUI(parent UI) *NonInteractiveUI {
12+
return &NonInteractiveUI{parent: parent}
1313
}
1414

15-
func (ui *nonInteractiveUI) ErrorLinef(pattern string, args ...interface{}) {
15+
func (ui *NonInteractiveUI) ErrorLinef(pattern string, args ...interface{}) {
1616
ui.parent.ErrorLinef(pattern, args...)
1717
}
1818

19-
func (ui *nonInteractiveUI) PrintLinef(pattern string, args ...interface{}) {
19+
func (ui *NonInteractiveUI) PrintLinef(pattern string, args ...interface{}) {
2020
ui.parent.PrintLinef(pattern, args...)
2121
}
2222

23-
func (ui *nonInteractiveUI) BeginLinef(pattern string, args ...interface{}) {
23+
func (ui *NonInteractiveUI) BeginLinef(pattern string, args ...interface{}) {
2424
ui.parent.BeginLinef(pattern, args...)
2525
}
2626

27-
func (ui *nonInteractiveUI) EndLinef(pattern string, args ...interface{}) {
27+
func (ui *NonInteractiveUI) EndLinef(pattern string, args ...interface{}) {
2828
ui.parent.EndLinef(pattern, args...)
2929
}
3030

31-
func (ui *nonInteractiveUI) PrintBlock(block []byte) {
31+
func (ui *NonInteractiveUI) PrintBlock(block []byte) {
3232
ui.parent.PrintBlock(block)
3333
}
3434

35-
func (ui *nonInteractiveUI) PrintErrorBlock(block string) {
35+
func (ui *NonInteractiveUI) PrintErrorBlock(block string) {
3636
ui.parent.PrintErrorBlock(block)
3737
}
3838

39-
func (ui *nonInteractiveUI) PrintTable(table Table) {
39+
func (ui *NonInteractiveUI) PrintTable(table Table) {
4040
ui.parent.PrintTable(table)
4141
}
4242

43-
func (ui *nonInteractiveUI) AskForText(label string) (string, error) {
43+
func (ui *NonInteractiveUI) AskForText(label string) (string, error) {
4444
panic("Cannot ask for input in non-interactive UI")
4545
}
4646

47-
func (ui *nonInteractiveUI) AskForChoice(label string, options []string) (int, error) {
47+
func (ui *NonInteractiveUI) AskForChoice(label string, options []string) (int, error) {
4848
panic("Cannot ask for a choice in non-interactive UI")
4949
}
5050

51-
func (ui *nonInteractiveUI) AskForPassword(label string) (string, error) {
51+
func (ui *NonInteractiveUI) AskForPassword(label string) (string, error) {
5252
panic("Cannot ask for password in non-interactive UI")
5353
}
5454

55-
func (ui *nonInteractiveUI) AskForConfirmation() error {
55+
func (ui *NonInteractiveUI) AskForConfirmation() error {
5656
// Always respond successfully
5757
return nil
5858
}
5959

60-
func (ui *nonInteractiveUI) IsInteractive() bool {
60+
func (ui *NonInteractiveUI) IsInteractive() bool {
6161
return false
6262
}
6363

64-
func (ui *nonInteractiveUI) Flush() {
64+
func (ui *NonInteractiveUI) Flush() {
6565
ui.parent.Flush()
6666
}

‎ui/padding_ui.go‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,79 +13,79 @@ const (
1313
paddingUIModeAskText
1414
)
1515

16-
type paddingUI struct {
16+
type PaddingUI struct {
1717
parent UI
1818
prevMode paddingUIMode
1919
}
2020

21-
func NewPaddingUI(parent UI) UI {
22-
return &paddingUI{parent: parent}
21+
func NewPaddingUI(parent UI) *PaddingUI {
22+
return &PaddingUI{parent: parent}
2323
}
2424

25-
func (ui *paddingUI) ErrorLinef(pattern string, args ...interface{}) {
25+
func (ui *PaddingUI) ErrorLinef(pattern string, args ...interface{}) {
2626
ui.padBefore(paddingUIModeAuto)
2727
ui.parent.ErrorLinef(pattern, args...)
2828
}
2929

30-
func (ui *paddingUI) PrintLinef(pattern string, args ...interface{}) {
30+
func (ui *PaddingUI) PrintLinef(pattern string, args ...interface{}) {
3131
ui.padBefore(paddingUIModeAuto)
3232
ui.parent.PrintLinef(pattern, args...)
3333
}
3434

35-
func (ui *paddingUI) BeginLinef(pattern string, args ...interface{}) {
35+
func (ui *PaddingUI) BeginLinef(pattern string, args ...interface{}) {
3636
ui.padBefore(paddingUIModeRaw)
3737
ui.parent.BeginLinef(pattern, args...)
3838
}
3939

40-
func (ui *paddingUI) EndLinef(pattern string, args ...interface{}) {
40+
func (ui *PaddingUI) EndLinef(pattern string, args ...interface{}) {
4141
ui.padBefore(paddingUIModeRaw)
4242
ui.parent.EndLinef(pattern, args...)
4343
}
4444

45-
func (ui *paddingUI) PrintBlock(block []byte) {
45+
func (ui *PaddingUI) PrintBlock(block []byte) {
4646
ui.padBefore(paddingUIModeRaw)
4747
ui.parent.PrintBlock(block)
4848
}
4949

50-
func (ui *paddingUI) PrintErrorBlock(block string) {
50+
func (ui *PaddingUI) PrintErrorBlock(block string) {
5151
ui.padBefore(paddingUIModeRaw)
5252
ui.parent.PrintErrorBlock(block)
5353
}
5454

55-
func (ui *paddingUI) PrintTable(table Table) {
55+
func (ui *PaddingUI) PrintTable(table Table) {
5656
ui.padBefore(paddingUIModeAuto)
5757
ui.parent.PrintTable(table)
5858
}
5959

60-
func (ui *paddingUI) AskForText(label string) (string, error) {
60+
func (ui *PaddingUI) AskForText(label string) (string, error) {
6161
ui.padBefore(paddingUIModeAskText)
6262
return ui.parent.AskForText(label)
6363
}
6464

65-
func (ui *paddingUI) AskForChoice(label string, options []string) (int, error) {
65+
func (ui *PaddingUI) AskForChoice(label string, options []string) (int, error) {
6666
ui.padBefore(paddingUIModeAuto)
6767
return ui.parent.AskForChoice(label, options)
6868
}
6969

70-
func (ui *paddingUI) AskForPassword(label string) (string, error) {
70+
func (ui *PaddingUI) AskForPassword(label string) (string, error) {
7171
ui.padBefore(paddingUIModeAskText)
7272
return ui.parent.AskForPassword(label)
7373
}
7474

75-
func (ui *paddingUI) AskForConfirmation() error {
75+
func (ui *PaddingUI) AskForConfirmation() error {
7676
ui.padBefore(paddingUIModeAuto)
7777
return ui.parent.AskForConfirmation()
7878
}
7979

80-
func (ui *paddingUI) IsInteractive() bool {
80+
func (ui *PaddingUI) IsInteractive() bool {
8181
return ui.parent.IsInteractive()
8282
}
8383

84-
func (ui *paddingUI) Flush() {
84+
func (ui *PaddingUI) Flush() {
8585
ui.parent.Flush()
8686
}
8787

88-
func (ui *paddingUI) padBefore(currMode paddingUIMode) {
88+
func (ui *PaddingUI) padBefore(currMode paddingUIMode) {
8989
switch {
9090
case ui.prevMode == paddingUIModeNone:
9191
// do nothing on the first time UI is called

0 commit comments

Comments
 (0)