1use std::io::Write;
2
3use clap::builder::StyledStr;
4use clap::*;
5
6use crate::generator::{utils, Generator};
7use crate::INTERNAL_ERROR_MSG;
8
9/// Generate powershell completion file
10#[derive(Copy, Clone, PartialEq, Eq, Debug)]
11pub struct PowerShell;
12
13impl Generator for PowerShell {
14 fn file_name(&self, name: &str) -> String {
15 format!("_{name}.ps1")
16 }
17
18 fn generate(&self, cmd: &Command, buf: &mut dyn Write) {
19 let bin_name = cmd
20 .get_bin_name()
21 .expect("crate::generate should have set the bin_name");
22
23 let subcommands_cases = generate_inner(cmd, "");
24
25 let result = format!(
26 r#"
27using namespace System.Management.Automation
28using namespace System.Management.Automation.Language
29
30Register-ArgumentCompleter -Native -CommandName '{bin_name}' -ScriptBlock {{
31 param($wordToComplete, $commandAst, $cursorPosition)
32
33 $commandElements = $commandAst.CommandElements
34 $command = @(
35 '{bin_name}'
36 for ($i = 1; $i -lt $commandElements.Count; $i++) {{
37 $element = $commandElements[$i]
38 if ($element -isnot [StringConstantExpressionAst] -or
39 $element.StringConstantType -ne [StringConstantType]::BareWord -or
40 $element.Value.StartsWith('-') -or
41 $element.Value -eq $wordToComplete) {{
42 break
43 }}
44 $element.Value
45 }}) -join ';'
46
47 $completions = @(switch ($command) {{{subcommands_cases}
48 }})
49
50 $completions.Where{{ $_.CompletionText -like "$wordToComplete*" }} |
51 Sort-Object -Property ListItemText
52}}
53"#
54 );
55
56 w!(buf, result.as_bytes());
57 }
58}
59
60// Escape string inside single quotes
61fn escape_string(string: &str) -> String {
62 string.replace(from:'\'', to:"''")
63}
64
65fn get_tooltip<T: ToString>(help: Option<&StyledStr>, data: T) -> String {
66 match help {
67 Some(help: &StyledStr) => escape_string(&help.to_string()),
68 _ => data.to_string(),
69 }
70}
71
72fn generate_inner(p: &Command, previous_command_name: &str) -> String {
73 debug!("generate_inner");
74
75 let command_name = if previous_command_name.is_empty() {
76 p.get_bin_name().expect(INTERNAL_ERROR_MSG).to_string()
77 } else {
78 format!("{};{}", previous_command_name, &p.get_name())
79 };
80
81 let mut completions = String::new();
82 let preamble = String::from("\n [CompletionResult]::new(");
83
84 for option in p.get_opts() {
85 generate_aliases(&mut completions, &preamble, option);
86 }
87
88 for flag in utils::flags(p) {
89 generate_aliases(&mut completions, &preamble, &flag);
90 }
91
92 for subcommand in p.get_subcommands() {
93 let data = &subcommand.get_name();
94 let tooltip = get_tooltip(subcommand.get_about(), data);
95
96 completions.push_str(&preamble);
97 completions.push_str(
98 format!("'{data}', '{data}', [CompletionResultType]::ParameterValue, '{tooltip}')")
99 .as_str(),
100 );
101 }
102
103 let mut subcommands_cases = format!(
104 r"
105 '{}' {{{}
106 break
107 }}",
108 &command_name, completions
109 );
110
111 for subcommand in p.get_subcommands() {
112 let subcommand_subcommands_cases = generate_inner(subcommand, &command_name);
113 subcommands_cases.push_str(&subcommand_subcommands_cases);
114 }
115
116 subcommands_cases
117}
118
119fn generate_aliases(completions: &mut String, preamble: &String, arg: &Arg) {
120 use std::fmt::Write as _;
121
122 if let Some(aliases: Vec) = arg.get_short_and_visible_aliases() {
123 let tooltip: String = get_tooltip(arg.get_help(), data:aliases[0]);
124 for alias: char in aliases {
125 let _ = write!(
126 completions,
127 "{preamble}'-{alias}', '{alias}{}', [CompletionResultType]::ParameterName, '{tooltip}')",
128 // make PowerShell realize there is a difference between `-s` and `-S`
129 if alias.is_uppercase() { " " } else { "" },
130 );
131 }
132 }
133 if let Some(aliases: Vec<&str>) = arg.get_long_and_visible_aliases() {
134 let tooltip: String = get_tooltip(arg.get_help(), data:aliases[0]);
135 for alias: &str in aliases {
136 let _ = write!(
137 completions,
138 "{preamble}'--{alias}', '{alias}', [CompletionResultType]::ParameterName, '{tooltip}')"
139 );
140 }
141 }
142}
143