1use nu_engine::command_prelude::*;
2use nu_protocol::ast::{Assignment, Bits, Boolean, Comparison, Math, Operator};
3
4#[derive(Clone)]
5pub struct HelpOperators;
6
7impl Command for HelpOperators {
8 fn name(&self) -> &str {
9 "help operators"
10 }
11
12 fn description(&self) -> &str {
13 "Show help on nushell operators."
14 }
15
16 fn signature(&self) -> Signature {
17 Signature::build("help operators")
18 .category(Category::Core)
19 .input_output_types(vec![(Type::Nothing, Type::table())])
20 .allow_variants_without_examples(true)
21 }
22
23 fn run(
24 &self,
25 _engine_state: &EngineState,
26 _stack: &mut Stack,
27 call: &Call,
28 _input: PipelineData,
29 ) -> Result<PipelineData, ShellError> {
30 let head = call.head;
31 let mut operators = [
32 Operator::Assignment(Assignment::Assign),
33 Operator::Assignment(Assignment::AddAssign),
34 Operator::Assignment(Assignment::SubtractAssign),
35 Operator::Assignment(Assignment::MultiplyAssign),
36 Operator::Assignment(Assignment::DivideAssign),
37 Operator::Assignment(Assignment::ConcatenateAssign),
38 Operator::Comparison(Comparison::Equal),
39 Operator::Comparison(Comparison::NotEqual),
40 Operator::Comparison(Comparison::LessThan),
41 Operator::Comparison(Comparison::GreaterThan),
42 Operator::Comparison(Comparison::LessThanOrEqual),
43 Operator::Comparison(Comparison::GreaterThanOrEqual),
44 Operator::Comparison(Comparison::RegexMatch),
45 Operator::Comparison(Comparison::NotRegexMatch),
46 Operator::Comparison(Comparison::In),
47 Operator::Comparison(Comparison::NotIn),
48 Operator::Comparison(Comparison::Has),
49 Operator::Comparison(Comparison::NotHas),
50 Operator::Comparison(Comparison::StartsWith),
51 Operator::Comparison(Comparison::EndsWith),
52 Operator::Math(Math::Add),
53 Operator::Math(Math::Subtract),
54 Operator::Math(Math::Multiply),
55 Operator::Math(Math::Divide),
56 Operator::Math(Math::FloorDivide),
57 Operator::Math(Math::Modulo),
58 Operator::Math(Math::Pow),
59 Operator::Math(Math::Concatenate),
60 Operator::Bits(Bits::BitOr),
61 Operator::Bits(Bits::BitXor),
62 Operator::Bits(Bits::BitAnd),
63 Operator::Bits(Bits::ShiftLeft),
64 Operator::Bits(Bits::ShiftRight),
65 Operator::Boolean(Boolean::Or),
66 Operator::Boolean(Boolean::Xor),
67 Operator::Boolean(Boolean::And),
68 ]
69 .into_iter()
70 .map(|op| {
71 Value::record(
72 record! {
73 "type" => Value::string(op_type(&op), head),
74 "operator" => Value::string(op.to_string(), head),
75 "name" => Value::string(name(&op), head),
76 "description" => Value::string(description(&op), head),
77 "precedence" => Value::int(op.precedence().into(), head),
78 },
79 head,
80 )
81 })
82 .collect::<Vec<_>>();
83
84 operators.push(Value::record(
85 record! {
86 "type" => Value::string("Boolean", head),
87 "operator" => Value::string("not", head),
88 "name" => Value::string("Not", head),
89 "description" => Value::string("Negates a value or expression.", head),
90 "precedence" => Value::int(55, head),
91 },
92 head,
93 ));
94
95 Ok(Value::list(operators, head).into_pipeline_data())
96 }
97}
98
99fn op_type(operator: &Operator) -> &'static str {
100 match operator {
101 Operator::Comparison(_) => "Comparison",
102 Operator::Math(_) => "Math",
103 Operator::Boolean(_) => "Boolean",
104 Operator::Bits(_) => "Bitwise",
105 Operator::Assignment(_) => "Assignment",
106 }
107}
108
109fn name(operator: &Operator) -> String {
110 match operator {
111 Operator::Comparison(op) => format!("{op:?}"),
112 Operator::Math(op) => format!("{op:?}"),
113 Operator::Boolean(op) => format!("{op:?}"),
114 Operator::Bits(op) => format!("{op:?}"),
115 Operator::Assignment(op) => format!("{op:?}"),
116 }
117}
118
119fn description(operator: &Operator) -> &'static str {
120 match operator {
122 Operator::Comparison(Comparison::Equal) => "Checks if two values are equal.",
123 Operator::Comparison(Comparison::NotEqual) => "Checks if two values are not equal.",
124 Operator::Comparison(Comparison::LessThan) => "Checks if a value is less than another.",
125 Operator::Comparison(Comparison::GreaterThan) => {
126 "Checks if a value is greater than another."
127 }
128 Operator::Comparison(Comparison::LessThanOrEqual) => {
129 "Checks if a value is less than or equal to another."
130 }
131 Operator::Comparison(Comparison::GreaterThanOrEqual) => {
132 "Checks if a value is greater than or equal to another."
133 }
134 Operator::Comparison(Comparison::RegexMatch) => {
135 "Checks if a value matches a regular expression."
136 }
137 Operator::Comparison(Comparison::NotRegexMatch) => {
138 "Checks if a value does not match a regular expression."
139 }
140 Operator::Comparison(Comparison::In) => {
141 "Checks if a value is in a list, is part of a string, or is a key in a record."
142 }
143 Operator::Comparison(Comparison::NotIn) => {
144 "Checks if a value is not in a list, is not part of a string, or is not a key in a record."
145 }
146 Operator::Comparison(Comparison::Has) => {
147 "Checks if a list contains a value, a string contains another, or if a record has a key."
148 }
149 Operator::Comparison(Comparison::NotHas) => {
150 "Checks if a list does not contain a value, a string does not contain another, or if a record does not have a key."
151 }
152 Operator::Comparison(Comparison::StartsWith) => "Checks if a string starts with another.",
153 Operator::Comparison(Comparison::EndsWith) => "Checks if a string ends with another.",
154 Operator::Math(Math::Add) => "Adds two values.",
155 Operator::Math(Math::Subtract) => "Subtracts two values.",
156 Operator::Math(Math::Multiply) => "Multiplies two values.",
157 Operator::Math(Math::Divide) => "Divides two values.",
158 Operator::Math(Math::FloorDivide) => "Divides two values and floors the result.",
159 Operator::Math(Math::Modulo) => "Divides two values and returns the remainder.",
160 Operator::Math(Math::Pow) => "Raises one value to the power of another.",
161 Operator::Math(Math::Concatenate) => {
162 "Concatenates two lists, two strings, or two binary values."
163 }
164 Operator::Boolean(Boolean::Or) => "Checks if either value is true.",
165 Operator::Boolean(Boolean::Xor) => "Checks if one value is true and the other is false.",
166 Operator::Boolean(Boolean::And) => "Checks if both values are true.",
167 Operator::Bits(Bits::BitOr) => "Performs a bitwise OR on two values.",
168 Operator::Bits(Bits::BitXor) => "Performs a bitwise XOR on two values.",
169 Operator::Bits(Bits::BitAnd) => "Performs a bitwise AND on two values.",
170 Operator::Bits(Bits::ShiftLeft) => "Bitwise shifts a value left by another.",
171 Operator::Bits(Bits::ShiftRight) => "Bitwise shifts a value right by another.",
172 Operator::Assignment(Assignment::Assign) => "Assigns a value to a variable.",
173 Operator::Assignment(Assignment::AddAssign) => "Adds a value to a variable.",
174 Operator::Assignment(Assignment::SubtractAssign) => "Subtracts a value from a variable.",
175 Operator::Assignment(Assignment::MultiplyAssign) => "Multiplies a variable by a value.",
176 Operator::Assignment(Assignment::DivideAssign) => "Divides a variable by a value.",
177 Operator::Assignment(Assignment::ConcatenateAssign) => {
178 "Concatenates a list, a string, or a binary value to a variable of the same type."
179 }
180 }
181}
182
183#[cfg(test)]
184mod test {
185 #[test]
186 fn test_examples() {
187 use super::HelpOperators;
188 use crate::test_examples;
189 test_examples(HelpOperators {})
190 }
191}