1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Parameterized string expansion
14 use std::mem::replace;
16 #[deriving(PartialEq)]
26 FormatPattern(Flags, FormatState),
28 SeekIfElsePercent(int),
33 #[deriving(PartialEq)]
40 /// Types of parameters a capability can use
48 /// Container for static and dynamic variable arrays
49 pub struct Variables {
50 /// Static variables A-Z
52 /// Dynamic variables a-z
57 /// Return a new zero-initialized Variables
58 pub fn new() -> Variables {
61 Number(0), Number(0), Number(0), Number(0), Number(0),
62 Number(0), Number(0), Number(0), Number(0), Number(0),
63 Number(0), Number(0), Number(0), Number(0), Number(0),
64 Number(0), Number(0), Number(0), Number(0), Number(0),
65 Number(0), Number(0), Number(0), Number(0), Number(0),
69 Number(0), Number(0), Number(0), Number(0), Number(0),
70 Number(0), Number(0), Number(0), Number(0), Number(0),
71 Number(0), Number(0), Number(0), Number(0), Number(0),
72 Number(0), Number(0), Number(0), Number(0), Number(0),
73 Number(0), Number(0), Number(0), Number(0), Number(0),
81 Expand a parameterized capability
84 * `cap` - string to expand
85 * `params` - vector of params for %p1 etc
86 * `vars` - Variables struct for %Pa etc
88 To be compatible with ncurses, `vars` should be the same between calls to `expand` for
89 multiple capabilities for the same terminal.
91 pub fn expand(cap: &[u8], params: &[Param], vars: &mut Variables)
92 -> Result<Vec<u8> , String> {
93 let mut state = Nothing;
95 // expanded cap will only rarely be larger than the cap itself
96 let mut output = Vec::with_capacity(cap.len());
98 let mut stack: Vec<Param> = Vec::new();
100 // Copy parameters into a local vector for mutability
102 Number(0), Number(0), Number(0), Number(0), Number(0),
103 Number(0), Number(0), Number(0), Number(0),
105 for (dst, src) in mparams.iter_mut().zip(params.iter()) {
106 *dst = (*src).clone();
109 for &c in cap.iter() {
111 let mut old_state = state;
122 '%' => { output.push(c); state = Nothing },
123 'c' => if stack.len() > 0 {
124 match stack.pop().unwrap() {
125 // if c is 0, use 0200 (128) for ncurses compatibility
127 output.push(if c == 0 {
133 _ => return Err("a non-char was used with %c".to_string())
135 } else { return Err("stack is empty".to_string()) },
136 'p' => state = PushParam,
137 'P' => state = SetVar,
138 'g' => state = GetVar,
139 '\'' => state = CharConstant,
140 '{' => state = IntConstant(0),
141 'l' => if stack.len() > 0 {
142 match stack.pop().unwrap() {
143 Words(s) => stack.push(Number(s.len() as int)),
144 _ => return Err("a non-str was used with %l".to_string())
146 } else { return Err("stack is empty".to_string()) },
147 '+' => if stack.len() > 1 {
148 match (stack.pop().unwrap(), stack.pop().unwrap()) {
149 (Number(y), Number(x)) => stack.push(Number(x + y)),
150 _ => return Err("non-numbers on stack with +".to_string())
152 } else { return Err("stack is empty".to_string()) },
153 '-' => if stack.len() > 1 {
154 match (stack.pop().unwrap(), stack.pop().unwrap()) {
155 (Number(y), Number(x)) => stack.push(Number(x - y)),
156 _ => return Err("non-numbers on stack with -".to_string())
158 } else { return Err("stack is empty".to_string()) },
159 '*' => if stack.len() > 1 {
160 match (stack.pop().unwrap(), stack.pop().unwrap()) {
161 (Number(y), Number(x)) => stack.push(Number(x * y)),
162 _ => return Err("non-numbers on stack with *".to_string())
164 } else { return Err("stack is empty".to_string()) },
165 '/' => if stack.len() > 1 {
166 match (stack.pop().unwrap(), stack.pop().unwrap()) {
167 (Number(y), Number(x)) => stack.push(Number(x / y)),
168 _ => return Err("non-numbers on stack with /".to_string())
170 } else { return Err("stack is empty".to_string()) },
171 'm' => if stack.len() > 1 {
172 match (stack.pop().unwrap(), stack.pop().unwrap()) {
173 (Number(y), Number(x)) => stack.push(Number(x % y)),
174 _ => return Err("non-numbers on stack with %".to_string())
176 } else { return Err("stack is empty".to_string()) },
177 '&' => if stack.len() > 1 {
178 match (stack.pop().unwrap(), stack.pop().unwrap()) {
179 (Number(y), Number(x)) => stack.push(Number(x & y)),
180 _ => return Err("non-numbers on stack with &".to_string())
182 } else { return Err("stack is empty".to_string()) },
183 '|' => if stack.len() > 1 {
184 match (stack.pop().unwrap(), stack.pop().unwrap()) {
185 (Number(y), Number(x)) => stack.push(Number(x | y)),
186 _ => return Err("non-numbers on stack with |".to_string())
188 } else { return Err("stack is empty".to_string()) },
189 '^' => if stack.len() > 1 {
190 match (stack.pop().unwrap(), stack.pop().unwrap()) {
191 (Number(y), Number(x)) => stack.push(Number(x ^ y)),
192 _ => return Err("non-numbers on stack with ^".to_string())
194 } else { return Err("stack is empty".to_string()) },
195 '=' => if stack.len() > 1 {
196 match (stack.pop().unwrap(), stack.pop().unwrap()) {
197 (Number(y), Number(x)) => stack.push(Number(if x == y { 1 }
199 _ => return Err("non-numbers on stack with =".to_string())
201 } else { return Err("stack is empty".to_string()) },
202 '>' => if stack.len() > 1 {
203 match (stack.pop().unwrap(), stack.pop().unwrap()) {
204 (Number(y), Number(x)) => stack.push(Number(if x > y { 1 }
206 _ => return Err("non-numbers on stack with >".to_string())
208 } else { return Err("stack is empty".to_string()) },
209 '<' => if stack.len() > 1 {
210 match (stack.pop().unwrap(), stack.pop().unwrap()) {
211 (Number(y), Number(x)) => stack.push(Number(if x < y { 1 }
213 _ => return Err("non-numbers on stack with <".to_string())
215 } else { return Err("stack is empty".to_string()) },
216 'A' => if stack.len() > 1 {
217 match (stack.pop().unwrap(), stack.pop().unwrap()) {
218 (Number(0), Number(_)) => stack.push(Number(0)),
219 (Number(_), Number(0)) => stack.push(Number(0)),
220 (Number(_), Number(_)) => stack.push(Number(1)),
221 _ => return Err("non-numbers on stack with logical and".to_string())
223 } else { return Err("stack is empty".to_string()) },
224 'O' => if stack.len() > 1 {
225 match (stack.pop().unwrap(), stack.pop().unwrap()) {
226 (Number(0), Number(0)) => stack.push(Number(0)),
227 (Number(_), Number(_)) => stack.push(Number(1)),
228 _ => return Err("non-numbers on stack with logical or".to_string())
230 } else { return Err("stack is empty".to_string()) },
231 '!' => if stack.len() > 0 {
232 match stack.pop().unwrap() {
233 Number(0) => stack.push(Number(1)),
234 Number(_) => stack.push(Number(0)),
235 _ => return Err("non-number on stack with logical not".to_string())
237 } else { return Err("stack is empty".to_string()) },
238 '~' => if stack.len() > 0 {
239 match stack.pop().unwrap() {
240 Number(x) => stack.push(Number(!x)),
241 _ => return Err("non-number on stack with %~".to_string())
243 } else { return Err("stack is empty".to_string()) },
244 'i' => match (mparams[0].clone(), mparams[1].clone()) {
245 (Number(x), Number(y)) => {
246 mparams[0] = Number(x+1);
247 mparams[1] = Number(y+1);
249 (_, _) => return Err("first two params not numbers with %i".to_string())
252 // printf-style support for %doxXs
253 'd'|'o'|'x'|'X'|'s' => if stack.len() > 0 {
254 let flags = Flags::new();
255 let res = format(stack.pop().unwrap(), FormatOp::from_char(cur), flags);
256 if res.is_err() { return res }
257 output.push_all(res.unwrap().as_slice())
258 } else { return Err("stack is empty".to_string()) },
259 ':'|'#'|' '|'.'|'0'..'9' => {
260 let mut flags = Flags::new();
261 let mut fstate = FormatStateFlags;
264 '#' => flags.alternate = true,
265 ' ' => flags.space = true,
266 '.' => fstate = FormatStatePrecision,
268 flags.width = cur as uint - '0' as uint;
269 fstate = FormatStateWidth;
273 state = FormatPattern(flags, fstate);
278 't' => if stack.len() > 0 {
279 match stack.pop().unwrap() {
280 Number(0) => state = SeekIfElse(0),
282 _ => return Err("non-number on stack \
283 with conditional".to_string())
285 } else { return Err("stack is empty".to_string()) },
286 'e' => state = SeekIfEnd(0),
290 return Err(format!("unrecognized format option {}", cur))
295 // params are 1-indexed
296 stack.push(mparams[match char::to_digit(cur, 10) {
298 None => return Err("bad param number".to_string())
302 if cur >= 'A' && cur <= 'Z' {
304 let idx = (cur as u8) - b'A';
305 vars.sta[idx as uint] = stack.pop().unwrap();
306 } else { return Err("stack is empty".to_string()) }
307 } else if cur >= 'a' && cur <= 'z' {
309 let idx = (cur as u8) - b'a';
310 vars.dyn[idx as uint] = stack.pop().unwrap();
311 } else { return Err("stack is empty".to_string()) }
313 return Err("bad variable name in %P".to_string());
317 if cur >= 'A' && cur <= 'Z' {
318 let idx = (cur as u8) - b'A';
319 stack.push(vars.sta[idx as uint].clone());
320 } else if cur >= 'a' && cur <= 'z' {
321 let idx = (cur as u8) - b'a';
322 stack.push(vars.dyn[idx as uint].clone());
324 return Err("bad variable name in %g".to_string());
328 stack.push(Number(c as int));
333 return Err("malformed character constant".to_string());
339 stack.push(Number(i));
343 state = IntConstant(i*10 + (cur as int - '0' as int));
346 _ => return Err("bad int constant".to_string())
349 FormatPattern(ref mut flags, ref mut fstate) => {
351 match (*fstate, cur) {
352 (_,'d')|(_,'o')|(_,'x')|(_,'X')|(_,'s') => if stack.len() > 0 {
353 let res = format(stack.pop().unwrap(), FormatOp::from_char(cur), *flags);
354 if res.is_err() { return res }
355 output.push_all(res.unwrap().as_slice());
356 // will cause state to go to Nothing
357 old_state = FormatPattern(*flags, *fstate);
358 } else { return Err("stack is empty".to_string()) },
359 (FormatStateFlags,'#') => {
360 flags.alternate = true;
362 (FormatStateFlags,'-') => {
365 (FormatStateFlags,'+') => {
368 (FormatStateFlags,' ') => {
371 (FormatStateFlags,'0'..'9') => {
372 flags.width = cur as uint - '0' as uint;
373 *fstate = FormatStateWidth;
375 (FormatStateFlags,'.') => {
376 *fstate = FormatStatePrecision;
378 (FormatStateWidth,'0'..'9') => {
379 let old = flags.width;
380 flags.width = flags.width * 10 + (cur as uint - '0' as uint);
381 if flags.width < old { return Err("format width overflow".to_string()) }
383 (FormatStateWidth,'.') => {
384 *fstate = FormatStatePrecision;
386 (FormatStatePrecision,'0'..'9') => {
387 let old = flags.precision;
388 flags.precision = flags.precision * 10 + (cur as uint - '0' as uint);
389 if flags.precision < old {
390 return Err("format precision overflow".to_string())
393 _ => return Err("invalid format specifier".to_string())
396 SeekIfElse(level) => {
398 state = SeekIfElsePercent(level);
402 SeekIfElsePercent(level) => {
407 state = SeekIfElse(level-1);
409 } else if cur == 'e' && level == 0 {
411 } else if cur == '?' {
412 state = SeekIfElse(level+1);
414 state = SeekIfElse(level);
417 SeekIfEnd(level) => {
419 state = SeekIfEndPercent(level);
423 SeekIfEndPercent(level) => {
428 state = SeekIfEnd(level-1);
430 } else if cur == '?' {
431 state = SeekIfEnd(level+1);
433 state = SeekIfEnd(level);
437 if state == old_state {
444 #[deriving(PartialEq)]
456 Flags{ width: 0, precision: 0, alternate: false,
457 left: false, sign: false, space: false }
470 fn from_char(c: char) -> FormatOp {
477 _ => fail!("bad FormatOp char")
480 fn to_char(self) -> char {
491 fn format(val: Param, op: FormatOp, flags: Flags) -> Result<Vec<u8> ,String> {
492 let mut s = match val {
494 let s = match (op, flags.sign) {
495 (FormatDigit, true) => format!("{:+d}", d).into_bytes(),
496 (FormatDigit, false) => format!("{:d}", d).into_bytes(),
497 (FormatOctal, _) => format!("{:o}", d).into_bytes(),
498 (FormatHex, _) => format!("{:x}", d).into_bytes(),
499 (FormatHEX, _) => format!("{:X}", d).into_bytes(),
500 (FormatString, _) => {
501 return Err("non-number on stack with %s".to_string())
504 let mut s: Vec<u8> = s.into_iter().collect();
505 if flags.precision > s.len() {
506 let mut s_ = Vec::with_capacity(flags.precision);
507 let n = flags.precision - s.len();
509 s_.extend(s.into_iter());
512 assert!(!s.is_empty(), "string conversion produced empty result");
515 if flags.space && !(s[0] == b'-' || s[0] == b'+' ) {
520 if flags.alternate && s[0] != b'0' {
526 let s_ = replace(&mut s, vec!(b'0', b'x'));
527 s.extend(s_.into_iter());
538 let s_ = replace(&mut s, vec!(b'0', b'X'));
539 s.extend(s_.into_iter());
542 FormatString => unreachable!()
549 let mut s = s.as_bytes().to_vec();
550 if flags.precision > 0 && flags.precision < s.len() {
551 s.truncate(flags.precision);
556 return Err(format!("non-string on stack with %{}",
562 if flags.width > s.len() {
563 let n = flags.width - s.len();
567 let mut s_ = Vec::with_capacity(flags.width);
569 s_.extend(s.into_iter());
578 use super::{expand,Words,Variables,Number};
582 fn test_basic_setabf() {
583 let s = b"\\E[48;5;%p1%dm";
584 assert_eq!(expand(s, [Number(1)], &mut Variables::new()).unwrap(),
585 "\\E[48;5;1m".bytes().collect());
589 fn test_multiple_int_constants() {
590 assert_eq!(expand(b"%{1}%{2}%d%d", [], &mut Variables::new()).unwrap(),
591 "21".bytes().collect());
596 let mut vars = Variables::new();
597 assert_eq!(expand(b"%p1%d%p2%d%p3%d%i%p1%d%p2%d%p3%d",
598 [Number(1),Number(2),Number(3)], &mut vars),
599 Ok("123233".bytes().collect()));
600 assert_eq!(expand(b"%p1%d%p2%d%i%p1%d%p2%d", [], &mut vars),
601 Ok("0011".bytes().collect()));
605 fn test_param_stack_failure_conditions() {
606 let mut varstruct = Variables::new();
607 let vars = &mut varstruct;
608 let caps = ["%d", "%c", "%s", "%Pa", "%l", "%!", "%~"];
609 for cap in caps.iter() {
610 let res = expand(cap.as_bytes(), [], vars);
611 assert!(res.is_err(),
612 "Op {} succeeded incorrectly with 0 stack entries", *cap);
613 let p = if *cap == "%s" || *cap == "%l" {
614 Words("foo".to_string())
618 let res = expand("%p1".bytes().collect::<Vec<_>>()
619 .append(cap.as_bytes()).as_slice(),
623 "Op {} failed with 1 stack entry: {}", *cap, res.unwrap_err());
625 let caps = ["%+", "%-", "%*", "%/", "%m", "%&", "%|", "%A", "%O"];
626 for cap in caps.iter() {
627 let res = expand(cap.as_bytes(), [], vars);
628 assert!(res.is_err(),
629 "Binop {} succeeded incorrectly with 0 stack entries", *cap);
630 let res = expand("%{1}".bytes().collect::<Vec<_>>()
631 .append(cap.as_bytes()).as_slice(),
634 assert!(res.is_err(),
635 "Binop {} succeeded incorrectly with 1 stack entry", *cap);
636 let res = expand("%{1}%{2}".bytes().collect::<Vec<_>>()
637 .append(cap.as_bytes()).as_slice(),
641 "Binop {} failed with 2 stack entries: {}", *cap, res.unwrap_err());
646 fn test_push_bad_param() {
647 assert!(expand(b"%pa", [], &mut Variables::new()).is_err());
651 fn test_comparison_ops() {
652 let v = [('<', [1u8, 0u8, 0u8]), ('=', [0u8, 1u8, 0u8]), ('>', [0u8, 0u8, 1u8])];
653 for &(op, bs) in v.iter() {
654 let s = format!("%{{1}}%{{2}}%{}%d", op);
655 let res = expand(s.as_bytes(), [], &mut Variables::new());
656 assert!(res.is_ok(), res.unwrap_err());
657 assert_eq!(res.unwrap(), vec!(b'0' + bs[0]));
658 let s = format!("%{{1}}%{{1}}%{}%d", op);
659 let res = expand(s.as_bytes(), [], &mut Variables::new());
660 assert!(res.is_ok(), res.unwrap_err());
661 assert_eq!(res.unwrap(), vec!(b'0' + bs[1]));
662 let s = format!("%{{2}}%{{1}}%{}%d", op);
663 let res = expand(s.as_bytes(), [], &mut Variables::new());
664 assert!(res.is_ok(), res.unwrap_err());
665 assert_eq!(res.unwrap(), vec!(b'0' + bs[2]));
670 fn test_conditionals() {
671 let mut vars = Variables::new();
672 let s = b"\\E[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m";
673 let res = expand(s, [Number(1)], &mut vars);
674 assert!(res.is_ok(), res.unwrap_err());
675 assert_eq!(res.unwrap(),
676 "\\E[31m".bytes().collect());
677 let res = expand(s, [Number(8)], &mut vars);
678 assert!(res.is_ok(), res.unwrap_err());
679 assert_eq!(res.unwrap(),
680 "\\E[90m".bytes().collect());
681 let res = expand(s, [Number(42)], &mut vars);
682 assert!(res.is_ok(), res.unwrap_err());
683 assert_eq!(res.unwrap(),
684 "\\E[38;5;42m".bytes().collect());
689 let mut varstruct = Variables::new();
690 let vars = &mut varstruct;
691 assert_eq!(expand(b"%p1%s%p2%2s%p3%2s%p4%.2s",
692 [Words("foo".to_string()),
693 Words("foo".to_string()),
694 Words("f".to_string()),
695 Words("foo".to_string())], vars),
696 Ok("foofoo ffo".bytes().collect()));
697 assert_eq!(expand(b"%p1%:-4.2s", [Words("foo".to_string())], vars),
698 Ok("fo ".bytes().collect()));
700 assert_eq!(expand(b"%p1%d%p1%.3d%p1%5d%p1%:+d", [Number(1)], vars),
701 Ok("1001 1+1".bytes().collect()));
702 assert_eq!(expand(b"%p1%o%p1%#o%p2%6.4x%p2%#6.4X", [Number(15), Number(27)], vars),
703 Ok("17017 001b0X001B".bytes().collect()));