FilesExpand file tree

master

/

completion.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

309 lines (252 loc) · 6.81 KB

master

/

completion.go

Copy path

Top

File metadata and controls

• Code
• Blame

309 lines (252 loc) · 6.81 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

package flags

import (

"fmt"

"path/filepath"

"reflect"

"sort"

"strings"

"unicode/utf8"

)

// Completion is a type containing information of a completion.

type Completion struct {

// The completed item

Item string

// A description of the completed item (optional)

Description string

}

type completions []Completion

func (c completions) Len() int {

return len(c)

}

func (c completions) Less(i, j int) bool {

return c[i].Item < c[j].Item

}

func (c completions) Swap(i, j int) {

c[i], c[j] = c[j], c[i]

}

// Completer is an interface which can be implemented by types

// to provide custom command line argument completion.

type Completer interface {

// Complete receives a prefix representing a (partial) value

// for its type and should provide a list of possible valid

// completions.

Complete(match string) []Completion

}

type completion struct {

parser *Parser

}

// Filename is a string alias which provides filename completion.

type Filename string

func completionsWithoutDescriptions(items []string) []Completion {

ret := make([]Completion, len(items))

for i, v := range items {

ret[i].Item = v

}

return ret

}

// Complete returns a list of existing files with the given

// prefix.

func (f *Filename) Complete(match string) []Completion {

ret, _ := filepath.Glob(match + "*")

return completionsWithoutDescriptions(ret)

}

func (c *completion) skipPositional(s *parseState, n int) {

if n >= len(s.positional) {

s.positional = nil

} else {

s.positional = s.positional[n:]

}

}

func (c *completion) completeOptionNames(s *parseState, prefix string, match string, short bool) []Completion {

if short && len(match) != 0 {

return []Completion{

Completion{

Item: prefix + match,

},

}

}

var results []Completion

repeats := map[string]bool{}

for name, opt := range s.lookup.longNames {

if strings.HasPrefix(name, match) && !opt.Hidden {

results = append(results, Completion{

Item: defaultLongOptDelimiter + name,

Description: opt.Description,

})

if short {

repeats[string(opt.ShortName)] = true

}

}

}

if short {

for name, opt := range s.lookup.shortNames {

if _, exist := repeats[name]; !exist && strings.HasPrefix(name, match) && !opt.Hidden {

results = append(results, Completion{

Item: string(defaultShortOptDelimiter) + name,

Description: opt.Description,

})

}

}

}

return results

}

func (c *completion) completeNamesForLongPrefix(s *parseState, prefix string, match string) []Completion {

return c.completeOptionNames(s, prefix, match, false)

}

func (c *completion) completeNamesForShortPrefix(s *parseState, prefix string, match string) []Completion {

return c.completeOptionNames(s, prefix, match, true)

}

func (c *completion) completeCommands(s *parseState, match string) []Completion {

n := make([]Completion, 0, len(s.command.commands))

for _, cmd := range s.command.commands {

if cmd.data != c && strings.HasPrefix(cmd.Name, match) {

n = append(n, Completion{

Item: cmd.Name,

Description: cmd.ShortDescription,

})

}

}

return n

}

func (c *completion) completeValue(value reflect.Value, prefix string, match string) []Completion {

if value.Kind() == reflect.Slice {

value = reflect.New(value.Type().Elem())

}

i := value.Interface()

var ret []Completion

if cmp, ok := i.(Completer); ok {

ret = cmp.Complete(match)

} else if value.CanAddr() {

if cmp, ok = value.Addr().Interface().(Completer); ok {

ret = cmp.Complete(match)

}

}

for i, v := range ret {

ret[i].Item = prefix + v.Item

}

return ret

}

func (c *completion) complete(args []string) []Completion {

if len(args) == 0 {

args = []string{""}

}

s := &parseState{

args: args,

}

c.parser.fillParseState(s)

var opt *Option

for len(s.args) > 1 {

arg := s.pop()

if (c.parser.Options&PassDoubleDash) != None && arg == "--" {

opt = nil

c.skipPositional(s, len(s.args)-1)

break

}

if argumentIsOption(arg) {

prefix, optname, islong := stripOptionPrefix(arg)

optname, _, argument := splitOption(prefix, optname, islong)

if argument == nil {

var o *Option

canarg := true

if islong {

o = s.lookup.longNames[optname]

} else {

for i, r := range optname {

sname := string(r)

o = s.lookup.shortNames[sname]

if o == nil {

break

}

if i == 0 && o.canArgument() && len(optname) != len(sname) {

canarg = false

break

}

}

}

if o == nil && (c.parser.Options&PassAfterNonOption) != None {

opt = nil

c.skipPositional(s, len(s.args)-1)

break

} else if o != nil && o.canArgument() && !o.OptionalArgument && canarg {

if len(s.args) > 1 {

s.pop()

} else {

opt = o

}

}

}

} else {

if len(s.positional) > 0 {

if !s.positional[0].isRemaining() {

// Don't advance beyond a remaining positional arg (because

// it consumes all subsequent args).

s.positional = s.positional[1:]

}

} else if cmd, ok := s.lookup.commands[arg]; ok {

cmd.fillParseState(s)

}

opt = nil

}

}

lastarg := s.args[len(s.args)-1]

var ret []Completion

if opt != nil {

// Completion for the argument of 'opt'

ret = c.completeValue(opt.value, "", lastarg)

} else if argumentStartsOption(lastarg) {

// Complete the option

prefix, optname, islong := stripOptionPrefix(lastarg)

optname, split, argument := splitOption(prefix, optname, islong)

if argument == nil && !islong {

rname, n := utf8.DecodeRuneInString(optname)

sname := string(rname)

if opt := s.lookup.shortNames[sname]; opt != nil && opt.canArgument() {

ret = c.completeValue(opt.value, prefix+sname, optname[n:])

} else {

ret = c.completeNamesForShortPrefix(s, prefix, optname)

}

} else if argument != nil {

if islong {

opt = s.lookup.longNames[optname]

} else {

opt = s.lookup.shortNames[optname]

}

if opt != nil {

ret = c.completeValue(opt.value, prefix+optname+split, *argument)

}

} else if islong {

ret = c.completeNamesForLongPrefix(s, prefix, optname)

} else {

ret = c.completeNamesForShortPrefix(s, prefix, optname)

}

} else if len(s.positional) > 0 {

// Complete for positional argument

ret = c.completeValue(s.positional[0].value, "", lastarg)

} else if len(s.command.commands) > 0 {

// Complete for command

ret = c.completeCommands(s, lastarg)

}

sort.Sort(completions(ret))

return ret

}

func (c *completion) print(items []Completion, showDescriptions bool) {

if showDescriptions && len(items) > 1 {

maxl := 0

for _, v := range items {

if len(v.Item) > maxl {

maxl = len(v.Item)

}

}

for _, v := range items {

fmt.Printf("%s", v.Item)

if len(v.Description) > 0 {

fmt.Printf("%s # %s", strings.Repeat(" ", maxl-len(v.Item)), v.Description)

}

fmt.Printf("\n")

}

} else {

for _, v := range items {

fmt.Println(v.Item)

}

}

}