summaryrefslogtreecommitdiffstats
path: root/completions/bfs.bash
blob: 0896bef5935ef9174e2394d110dede40cb9a30c7 (plain)
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#!/bin/bash

############################################################################
# bfs                                                                      #
# Copyright (C) 2020 Benjamin Mundt <benMundt@ibm.com>                     #
# Copyright (C) 2020 Tavian Barnes <tavianator@tavianator.com>             #
#                                                                          #
# Permission to use, copy, modify, and/or distribute this software for any #
# purpose with or without fee is hereby granted.                           #
#                                                                          #
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES #
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF         #
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  #
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   #
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN    #
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  #
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.           #
############################################################################

# bash completion script for bfs

_bfs() {
    local cword="$COMP_CWORD"
    local cur="${COMP_WORDS[cword]}"
    local prev prev2
    if ((cword > 0)); then
        prev="${COMP_WORDS[cword-1]}"
    fi
    if ((cword > 1)); then
        prev2="${COMP_WORDS[cword-2]}"
    fi

    # Options with a special completion procedure
    local special=(
        -D
        -S
        -exec
        -execdir
        -fprintf
        -fstype
        -gid
        -group
        -ok
        -okdir
        -perm
        -regextype
        -type
        -uid
        -user
        -xtype
    )

    # Options whose values should not be completed
    # (e.g. because they are numeric, glob, regexp, time, etc.)
    local nocomp=(
        -{a,B,c,m}{min,since,time}
        -ilname
        -iname
        -inum
        -ipath
        -iregex
        -iwholename
        -links
        -lname
        -maxdepth
        -mindepth
        -name
        -newer{a,B,c,m}t
        -path
        -printf
        -regex
        -since
        -size
        -used
        -wholename
        -xattrname
    )

    # Options whose value is a filename
    local filecomp=(
        -{a,B,c,m}newer
        -f
        -fls
        -fprint
        -fprint0
        -newer
        -newer{a,B,c,m}{a,B,c,m}
        -samefile
    )

    local operators=(
        -a
        -and
        -exclude
        -not
        -o
        -or
    )

    # Flags that take no arguments
    local nullary_flags=(
        -E
        -H
        -L
        -O{0,1,2,3,4,fast}
        -P
        -X
        -d
        -x
    )

    # Options that take no arguments
    local nullary_options=(
        -color
        -daystart
        -depth
        -follow
        -ignore_readdir_race
        -maxdepth
        -mindepth
        -mount
        -nocolor
        -noignore_readdir_race
        -noleaf
        -nowarn
        -status
        -unique
        -warn
        -xdev
    )

    # Tests that take no arguments
    local nullary_tests=(
        -capable
        -empty
        -executable
        -false
        -hidden
        -nogroup
        -nohidden
        -nouser
        -readable
        -sparse
        -true
        -writable
        -xattr
        -xattrname
    )

    # Actions that take no arguments
    local nullary_actions=(
        --help
        --version
        -delete
        -exit
        -help
        -ls
        -print
        -print0
        -printx
        -prune
        -quit
        -rm
        -version
    )

    local everything=(
        "${special[@]}"
        "${nocomp[@]}"
        "${filecomp[@]}"
        "${operators[@]}"
        "${nullary_flags[@]}"
        "${nullary_options[@]}"
        "${nullary_tests[@]}"
        "${nullary_actions[@]}"
    )

    # Completing -exec requires matching the whole command line
    local iscmd isarg word
    for word in "${COMP_WORDS[@]::cword}"; do
        case "$word" in
            -exec|-execdir|-ok|-okdir)
                iscmd=y
                ;;
            \\\;|+)
                if [[ -n "$iscmd" ]] || [[ -n "$isarg" ]]; then
                    iscmd=
                    isarg=
                fi
                ;;
            *)
                if [[ -n "$iscmd" ]]; then
                    iscmd=
                    isarg=y
                fi
                ;;
        esac
    done

    if [[ -n "$iscmd" ]]; then
        COMPREPLY=($(compgen -c -- "$cur"))
        return
    elif [[ -n "$isarg" ]]; then
        COMPREPLY=($(compgen -o default -o bashdefault -W "{} + \\\\;" -- "$cur"))
        return
    fi

    # Completions with 2-word lookbehind
    case "$prev2" in
        -fprintf)
            # -fprintf FORMAT FILE
            #     Like -ls/-print/-print0/-printf, but write to FILE instead of standard
            #     output
            # when -fprintf is prev2, current word is FILE; perform file completion
            COMPREPLY=($(compgen -f -- "$cur"))
            return
            ;;
    esac

    # No completion for numbers, globs, regexes, times, etc.
    if [[ " ${nocomp[@]} " =~ " $prev " ]]; then
        COMPREPLY=()
        return
    fi

    # Complete filenames
    if [[ " ${filecomp[@]} " =~ " $prev " ]]; then
        COMPREPLY=($(compgen -o filenames -f -- "$cur"))
        return
    fi

    # Other completions with 1-word lookbehind
    case "$prev" in
        -type|-xtype)
            # -type [bcdlpfswD]
            #     Find files of the given type
            # -xtype [bcdlpfswD]
            #     Find files of the given type, following links when -type would not, and
            #     vice versa
            COMPREPLY=()
            if [[ -n $cur ]] && ! [[ $cur =~ ,$ ]]; then
                COMPREPLY+=("$cur")
                cur+=,
            fi
            COMPREPLY+=("$cur"{b,c,d,l,p,f,s,w,D})
            return
            ;;
        -gid|-uid)
            # -gid [-+]N
            # -uid [-+]N
            #     Find files owned by group/user ID N
            # TODO: list numeric uids/gids
            COMPREPLY=()
            return
            ;;
        -group)
            # -group NAME
            #     Find files owned by the group NAME
            COMPREPLY=($(compgen -g -- "$cur"))
            return
            ;;
        -user)
            # -user  NAME
            #     Find files owned by the user NAME
            COMPREPLY=($(compgen -u -- "$cur"))
            return
            ;;
        -S)
            # -S bfs|dfs|ids|eds
            #     Use breadth-first/depth-first/iterative/exponential deepening search
            #     (default: -S bfs)
            COMPREPLY=($(compgen -W 'bfs dfs ids eds' -- "$cur"))
            return
            ;;
        -D)
            # -D FLAG
            #     Turn on a debugging flag (see -D help)
            COMPREPLY=($(compgen -W 'help cost exec opt rates search stat tree all' -- "$cur"))
            return
            ;;
        -regextype)
            # -regextype TYPE
            #     Use TYPE-flavored regexes (default: posix-basic; see -regextype help)
            COMPREPLY=($(compgen -W 'help posix-basic posix-extended' -- "$cur"))
            return
            ;;
        -fstype)
            # -fstype TYPE
            #     Find files on file systems with the given TYPE
            #TODO: parse the mount table for a list of mounted filesystem types
            COMPREPLY=()
            return
            ;;
        (-perm)
            # -perm [-]MODE
            #     Find files with a matching mode
            # sample syntax:
            #   -perm 777
            #   -perm 507
            #   -perm u+rw
            #   -perm og-rx
            if [[ -z "$cur" ]]; then
                # initial completion
                COMPREPLY=(0 1 2 3 4 5 6 7 u g o)
                return
            elif [[ "$cur" =~ [rwx][rwx][rwx]$ ]] || [[ "$cur" =~ [0-7][0-7][0-7]$ ]]; then
                # final completion (filled in all possible mode bits)
                COMPREPLY=("$cur")
                return
            elif [[ "$cur" =~ [0-7]$ ]]; then
                # intermediate completion, octal mode specifier
                COMPREPLY=("$cur"{0,1,2,3,4,5,6,7})
                return
            elif [[ "$cur" =~ ^[ugo]*[+-][rwx]*$ ]]; then
                # intermediate completion, symbolic mode specifier
                COMPREPLY=()
                [[ "$cur" =~ [rwx]$ ]] && COMPREPLY+=("${cur}")
                [[ "$cur" =~ [+-][wx]*r ]] || COMPREPLY+=("${cur}r")
                [[ "$cur" =~ [+-][rx]*w ]] || COMPREPLY+=("${cur}w")
                [[ "$cur" =~ [+-][rw]*x ]] || COMPREPLY+=("${cur}x")
                return 0
            elif [[ "$cur" =~ ^[ugo] ]]; then
                # intermediate completion, symbolic group specifier
                COMPREPLY=(+ -)
                [[ "$cur" =~ ^[go]*u ]] || COMPREPLY+=("${cur}u")
                [[ "$cur" =~ ^[uo]*g ]] || COMPREPLY+=("${cur}g")
                [[ "$cur" =~ ^[ug]*o ]] || COMPREPLY+=("${cur}o")
                return 0
            fi
            COMPREPLY=()
            return
            ;;
    esac

    # Completions with no lookbehind
    if [[ "$cur" == -* ]]; then
        # complete all options
        COMPREPLY=($(compgen -o default -o bashdefault -W "${everything[*]}" -- "$cur"))
        return
    fi

    # default completion
    COMPREPLY=($(compgen -o default -o bashdefault -f -W "${everything[*]} ! ," -- "$cur"))
    return
} && complete -F _bfs bfs