aopt 1.4.5

A flexible and typed getopt tools
Documentation
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
use std::borrow::Cow;
use std::ffi::OsString;

use crate::acore::args::Args;
use crate::acore::opt::Opt;
use crate::acore::Error;
use crate::acore::HashMap;
use crate::acore::Uid;
use crate::ashell::shell::complete_eq;
use crate::ashell::shell::complete_opt;
use crate::ashell::shell::complete_val;
use crate::ashell::shell::Complete;
use crate::ashell::shell::Shell;
use crate::ashell::value::Values;
use crate::opt::ConfigBuildInfer;
use crate::opt::ConfigValue;
use crate::opt::Style;
use crate::parser::HCOptSet;
use crate::parser::PolicySettings;
use crate::prelude::AFwdParser;
use crate::set::OptValidator;
use crate::set::Set;
use crate::set::SetCfg;
use crate::set::SetOpt;
use crate::set::SetValueFindExt;
use crate::trace;

pub use crate::ashell::script;
pub use crate::ashell::shell;
pub use crate::ashell::value;
pub use crate::ashell::Context;

#[derive(Debug)]
pub struct CompleteCli {
    pub args: Vec<OsString>,

    pub curr: OsString,

    pub prev: OsString,

    pub cword: usize,

    pub shell: String,

    pub script: bool,
}

impl CompleteCli {
    pub fn parse_env() -> Result<Self, Error> {
        Self::parse(Args::from_env())
    }

    /// Check and return the value of `--_completes` option from `std::env::args()`.
    pub fn parse(args: Args) -> Result<Self, Error> {
        let mut parser = AFwdParser::default();

        parser.policy_mut().set_prepolicy(true);

        parser.add_opt("--_shell!: Set shell type".infer::<String>())?;
        parser.add_opt("--_curr: Set the current word".infer::<OsString>())?;
        parser.add_opt("--_prev: Set the previous word".infer::<OsString>())?;
        parser.add_opt("--_cword: Set the index of current word".infer::<usize>())?;

        let mut ret = parser.parse(args)?;
        let mut args = ret.take_args();

        args.remove(0);
        if let Ok(shell) = parser.take_val("--_shell") {
            let curr = parser.take_val("--_curr");
            let prev = parser.take_val("--_prev");
            let script = curr.is_err() && prev.is_err();
            let curr = curr.unwrap_or_default();
            let prev = prev.unwrap_or_default();
            let cword = parser.take_val("--_cword").unwrap_or(args.len());

            Ok(Self {
                shell,
                args,
                curr,
                cword,
                prev,
                script,
            })
        } else {
            Err(crate::error!("can not get complete arguments"))
        }
    }

    pub fn get_context(&self) -> Result<Context<'_>, Error> {
        Ok(Context::new(&self.args, &self.curr, &self.prev, self.cword))
    }

    pub fn gen_with<F>(&self, mut func: F) -> Result<(), Error>
    where
        F: FnMut(&mut Box<dyn crate::shell::script::Generator<Err = Error>>) -> Result<(), Error>,
    {
        if self.script {
            let mut m = crate::ashell::script::Manager::default();

            func(m.find_mut(&self.shell)?)
        } else {
            Err(crate::error!(
                "can not generate string: script = {}",
                self.script
            ))
        }
    }

    pub fn write_stdout(&self, name: &str, bin: &str) -> Result<(), Error> {
        self.gen_with(|g| {
            print!("{}", g.generate(name, bin)?);
            std::io::Write::flush(&mut std::io::stdout())
                .map_err(|e| crate::error!("can not flush stdout: {e:?}"))?;
            Ok(())
        })
    }

    pub fn complete<'a, O, W, F>(&self, func: F) -> Result<(), Error>
    where
        W: std::io::Write + 'a,
        O: crate::opt::Opt + 'a,
        F: FnOnce(
            &mut Box<dyn crate::shell::shell::Shell<O, W, Err = Error> + 'a>,
        ) -> Result<(), Error>,
    {
        if !self.script {
            let mut m = crate::ashell::shell::Manager::<'a, O, W>::default();

            func(m.find_mut(&self.shell)?)
        } else {
            Err(crate::error!(
                "can not perform completion: script = {}",
                self.script
            ))
        }
    }
}

pub struct CompletionManager<'a, S>
where
    S: Set,
{
    optset: HCOptSet<'a, S>,

    values: HashMap<Uid, Box<dyn Values<SetOpt<S>, Err = Error>>>,

    submanager: HashMap<String, CompletionManager<'a, S>>,
}

impl<'a, S> CompletionManager<'a, S>
where
    S: Set,
    SetOpt<S>: Opt,
{
    pub fn new(optset: HCOptSet<'a, S>) -> Self {
        Self {
            optset,
            values: HashMap::default(),
            submanager: HashMap::default(),
        }
    }

    pub fn with_values<V>(mut self, uid: Uid, v: V) -> Self
    where
        V: Values<SetOpt<S>> + 'static,
    {
        self.set_values(uid, v);
        self
    }

    pub fn with_optset(mut self, optset: HCOptSet<'a, S>) -> Self {
        self.optset = optset;
        self
    }

    pub fn with_manager(mut self, name: &str, optset: HCOptSet<'a, S>) -> Result<Self, Error> {
        self.add_manager(name, optset)?;
        Ok(self)
    }

    pub fn set_optset(&mut self, optset: HCOptSet<'a, S>) -> &mut Self {
        self.optset = optset;
        self
    }

    pub fn set_values<V>(&mut self, uid: Uid, v: V) -> &mut Self
    where
        V: Values<SetOpt<S>> + 'static,
    {
        self.values
            .insert(uid, Box::new(crate::ashell::value::wrap(v)));
        self
    }

    pub fn add_manager(&mut self, name: &str, optset: HCOptSet<'a, S>) -> Result<&mut Self, Error> {
        if self
            .optset
            .iter()
            .filter(|v| v.mat_style(aopt_core::opt::Style::Cmd))
            .any(|v| v.name() == name)
        {
            self.submanager
                .insert(name.to_string(), CompletionManager::new(optset));
            Ok(self)
        } else {
            Err(crate::error!("not a sub command name: {name}"))
        }
    }

    pub fn optset(&self) -> &HCOptSet<'a, S> {
        &self.optset
    }

    pub fn optset_mut(&mut self) -> &mut HCOptSet<'a, S> {
        &mut self.optset
    }

    pub fn values(&self) -> &HashMap<Uid, Box<dyn Values<SetOpt<S>, Err = Error>>> {
        &self.values
    }

    pub fn managers(&self) -> &HashMap<String, CompletionManager<'a, S>> {
        &self.submanager
    }

    pub fn managers_mut(&mut self) -> &mut HashMap<String, CompletionManager<'a, S>> {
        &mut self.submanager
    }

    pub fn find_manager(&self, name: &str) -> Result<&CompletionManager<'a, S>, Error> {
        self.submanager
            .get(name)
            .ok_or_else(|| crate::error!("can not find manager: {name}"))
    }

    pub fn find_manager_mut(&mut self, name: &str) -> Result<&mut CompletionManager<'a, S>, Error> {
        self.submanager
            .get_mut(name)
            .ok_or_else(|| crate::error!("can not find manager: {name}"))
    }
}

impl<'a, S> Complete<SetOpt<S>> for CompletionManager<'a, S>
where
    SetOpt<S>: Opt,
    SetCfg<S>: ConfigValue + Default,
    S: Set + OptValidator + SetValueFindExt,
{
    type Out = ();
    type Ctx<'b> = Context<'b>;
    type Err = Error;

    fn complete<T, W>(&self, s: &mut T, ctx: &mut Self::Ctx<'_>) -> Result<Self::Out, Self::Err>
    where
        T: Shell<SetOpt<S>, W>,
    {
        let Context {
            args,
            curr,
            prev,
            cword,
        } = ctx;

        let mut incomp_arg = Cow::Borrowed(curr.as_ref());
        let mut incomp_val = None;

        if let Some((opt, val)) = aopt_core::str::split_once(curr, '=') {
            incomp_arg = opt;
            incomp_val = Some(val);
        }

        trace!("complete start ...",);
        trace!("curr=`{}`", curr.display());
        trace!("prev=`{}`", prev.display());
        trace!("arg=`{}`", incomp_arg.display());
        trace!("val=`{:?}`", incomp_val.as_ref().map(|v| v.display()));
        trace!("args = `{:?}`", args);

        let mut s = shell::wrapref(s);
        let mut manager = self;
        let mut flags = vec![false; args.len()];
        let mut cmds = vec![];
        let mut manager_list = vec![self];

        for (idx, arg) in args.iter().enumerate() {
            if let Some(arg) = arg.to_str() {
                trace!("finding `{}`", arg);
                for cmd in manager.optset().iter().filter(|v| v.mat_style(Style::Cmd)) {
                    trace!("checking `{}`", cmd.name());
                    if cmd.mat_name(Some(arg)) || cmd.mat_alias(arg) {
                        manager = manager.find_manager(cmd.name())?;

                        flags[idx] = true;
                        cmds.push(cmd);
                        manager_list.push(manager);
                        trace!("find cmd `{}` in args at `{}`", arg, idx);
                        break;
                    }
                }
            }
        }

        let mut available_cmds = vec![];

        // find cmd if val is none
        if let (Some(manager), None) = (manager_list.last(), &incomp_val) {
            trace!("try complete cmd");
            let arg = incomp_arg.to_str().unwrap_or_default();
            let optset = manager.optset();

            for opt in optset.iter().filter(|v| v.mat_style(Style::Cmd)) {
                for name in std::iter::once(opt.name())
                    .chain(
                        opt.alias()
                            .iter()
                            .flat_map(|v| v.iter().map(|v| v.as_str())),
                    )
                    .filter(|v| v.starts_with(arg))
                {
                    trace!("available cmd -> {name}");
                    available_cmds.push((name, opt));
                }
            }
        }

        // find option value like [arg=val]
        if let (Some(arg), Some(val)) = (incomp_arg.to_str(), incomp_val.as_ref()) {
            let bytes = val.as_encoded_bytes();

            trace!("search.1 vals with arg=`{}`, val=`{}`", arg, val.display());
            for manager in manager_list
                .iter()
                .filter(|v| v.optset().split(&Cow::Borrowed(arg)).is_ok())
            {
                let optset = manager.optset();
                let values = manager.values();

                complete_eq(arg, bytes, optset.iter(), values, |name, val, opt| {
                    s.write_eq(name, val, opt)
                })?;
            }
        }

        let mut found_val = false;

        // find option value like [arg val]
        if let (Some(arg), Some(val)) = (prev.to_str(), Some(&curr)) {
            let bytes = val.as_encoded_bytes();

            trace!("search.2 vals with arg=`{}`, val=`{}`", arg, val.display());
            for manager in manager_list
                .iter()
                .filter(|v| v.optset().split(&Cow::Borrowed(arg)).is_ok())
            {
                let optset = manager.optset();
                let values = manager.values();

                found_val = found_val
                    || complete_val(arg, bytes, optset.iter(), values, |val, opt| {
                        s.write_val(val, opt)
                    })?;
            }
        }

        // if we not found any val, print cmd if available
        if !found_val && !available_cmds.is_empty() {
            for (cmd, opt) in available_cmds {
                s.write_cmd(cmd, opt)?;
            }
            return s.finish();
        }

        let mut found_opt = false;

        // find option if val is none
        if let (Some(arg), None) = (incomp_arg.to_str(), incomp_val) {
            trace!("search option with arg=`{}`", arg);
            for p in manager_list
                .iter()
                .map(|v| v.optset())
                .filter(|v| v.split(&Cow::Borrowed(arg)).is_ok())
            {
                found_opt =
                    found_opt || complete_opt(arg, p.iter(), |name, opt| s.write_opt(name, opt))?;
            }
        }

        // if we not found any opt
        if !found_opt && !found_val {
            // complete pos value in last manager
            if let Some(manager) = manager_list.last() {
                let optset = manager.optset();

                trace!("search pos value ...");
                if optset.iter().any(|v| v.mat_style(Style::Pos)) {
                    let values = manager.values();
                    let mut noa_index = 1;
                    let mut index = 0;

                    trace!("start calc noa index ...");
                    while index < args.len() && index < *cword {
                        if !flags[index] {
                            // check if current is option
                            let mut like_opt = false;
                            let mut found_opt = false;
                            let mut need_val = false;
                            let (mut arg, mut val) = (Cow::Borrowed(args[index].as_os_str()), None);

                            if let Some((a, b)) = crate::acore::str::split_once(&args[index], '=') {
                                arg = a;
                                val = Some(b);
                            }
                            // if arg is valid str
                            if let Some(arg) = arg.to_str() {
                                // like an option
                                for p in manager_list
                                    .iter()
                                    .map(|v| v.optset())
                                    .filter(|v| v.split(&Cow::Borrowed(arg)).is_ok())
                                {
                                    like_opt = true;

                                    for opt in p.iter() {
                                        if opt.mat_name(Some(arg)) || opt.mat_alias(arg) {
                                            found_opt = true;
                                            if opt.mat_style(Style::Argument) && val.is_none() {
                                                need_val = true;
                                            }
                                            break;
                                        }
                                    }
                                    if found_opt {
                                        break;
                                    }
                                }
                            }
                            if !like_opt {
                                noa_index += 1;
                            }
                            if need_val && val.is_none() {
                                index += 1;
                            }
                        }
                        index += 1;
                    }

                    let bytes = curr.as_encoded_bytes();

                    if optset.iter().any(|v| v.mat_style(Style::Cmd)) {
                        noa_index += 1;
                    }
                    trace!("noa index = {noa_index}");
                    for pos in optset.iter().filter(|v| v.mat_style(Style::Pos)) {
                        if pos.mat_index(Some((noa_index, noa_index + 1))) {
                            if let Some(getter) = values.get(&pos.uid()) {
                                for val in getter.get_values(pos)? {
                                    if !val.is_empty() && bytes.is_empty()
                                        || bytes
                                            .iter()
                                            .zip(val.as_encoded_bytes())
                                            .all(|(a, b)| *a == *b)
                                    {
                                        trace!(
                                            "available pos(uid = {}) value=`{}`",
                                            pos.uid(),
                                            val.display()
                                        );
                                        s.write_val(val.as_os_str(), pos)?;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }

        s.finish()
    }
}

/// Return [`CompleteCli`] if command line arguments has `--_shell` option.
pub fn get_complete_cli() -> Result<CompleteCli, Error> {
    CompleteCli::parse_env()
}