pub struct Wrapped<'a> { /* private fields */ }Implementations§
source§impl<'a> Wrapped<'a>
impl<'a> Wrapped<'a>
sourcepub fn new(cows: Vec<Cow<'a, str>>, style: Style) -> Self
pub fn new(cows: Vec<Cow<'a, str>>, style: Style) -> Self
Examples found in repository?
src/wrapper.rs (line 100)
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
pub fn wrap(&mut self) {
let data_len = self.data.iter().map(|v| v.len()).max().unwrap_or(0);
let mut default_style = vec![Style::default(); data_len];
for line in self.data.iter() {
for (style_mut, col) in default_style.iter_mut().zip(line.iter()) {
let width = display_width(col);
if style_mut.wrap_width < width {
style_mut.wrap_width = width;
}
}
}
for line in self.data.iter() {
let mut wrapped = vec![];
for (col, style) in line.iter().zip(default_style.iter()) {
wrapped.push(Wrapped::new(wrap(col, style.wrap_width), style.clone()));
}
self.output.push(wrapped);
}
}
/// Modify wrap_width if wrap_width is 0
pub fn wrap_with(&mut self, styles: &[Style]) {
let mut styles = styles.to_owned();
let status: Vec<bool> = styles.iter().map(|v| v.wrap_width == 0).collect();
for (line, status) in self.data.iter().zip(status.iter()) {
if *status {
for (style_mut, col) in styles.iter_mut().zip(line.iter()) {
let width = display_width(col);
if style_mut.wrap_width < width {
style_mut.wrap_width = width;
}
}
}
}
for line in self.data.iter() {
let mut wrapped = vec![];
for (col, style) in line.iter().zip(styles.iter()) {
wrapped.push(Wrapped::new(wrap(col, style.wrap_width), style.clone()));
}
self.output.push(wrapped);
}
}sourcepub fn get_style(&self) -> &Style
pub fn get_style(&self) -> &Style
Examples found in repository?
src/format/policy.rs (line 196)
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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
pub fn get_block_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
) -> Cow<'a, str> {
let style = &self.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}
}
impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
let usage = self.get_command_usage(item);
let mut blocks = vec![usage];
let head = item.head();
let foot = item.foot();
let block_spacing = "\n".repeat(1 + self.style.block_spacing);
if !head.is_empty() {
blocks.push(head);
}
for block in item.block() {
if !block.is_empty() {
let help = self.get_block_help(block, item);
if !help.is_empty() {
blocks.push(help);
}
}
}
if !foot.is_empty() {
blocks.push(foot);
}
Some(blocks.join(&block_spacing).into())
}
}
pub struct DefaultAppPolicy<'a, I> {
styles: Vec<Style>, // style for every block
show_global: bool,
hiding_pos: bool,
marker: PhantomData<&'a I>,
}
impl<'a, I> Default for DefaultAppPolicy<'a, I> {
fn default() -> Self {
Self {
styles: Default::default(),
show_global: true,
hiding_pos: true,
marker: Default::default(),
}
}
}
impl<'a, I> DefaultAppPolicy<'a, I> {
pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
Self {
styles,
show_global,
hiding_pos: true,
marker: PhantomData::default(),
}
}
}
impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
pub fn get_block_usage(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &[Store<'a>],
) -> (Vec<String>, Vec<String>) {
let mut usages = vec![];
let mut args = vec![];
for store in item.iter() {
if let Some(store) = stores.iter().find(|v| &v.name() == store) {
let hint = store.hint();
if !hint.is_empty() {
if store.position() {
if store.optional() {
args.push(format!("[{}]", hint));
} else {
args.push(format!("<{}>", hint));
}
} else if store.optional() {
usages.push(format!("[{}]", hint));
} else {
usages.push(format!("<{}>", hint));
}
}
}
}
(usages, args)
}
pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
let global = app.global();
let mut usages = vec![];
let mut args = vec![];
let mut block_hint = vec![];
for block in global.block() {
let (mut block_usages, mut block_args) = self.get_block_usage(block, global);
if !block_usages.is_empty() {
usages.append(&mut block_usages);
}
// if not omit args, using the args, otherwise using hint of block
if !block_args.is_empty() {
args.append(&mut block_args);
}
}
for block in global.block() {
if !block.is_empty() {
let arg = block.hint();
if !arg.is_empty() {
block_hint.push(arg);
}
}
}
let mut ret = String::from("Usage: ");
// all the option usage
let global_usage = usages.join(" ");
let block_hint = block_hint.join(" ");
let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
let args = args.join(" ");
if !global.name().is_empty() {
ret += &global.name();
ret += " ";
}
if !global_usage.is_empty() {
ret += &global_usage;
ret += " ";
}
if !command_usage.is_empty() {
ret += &command_usage;
ret += " ";
}
if self.hiding_pos {
if !block_hint.is_empty() {
ret += &block_hint;
ret += " ";
}
} else {
if !args.is_empty() {
ret += &args;
ret += " ";
}
}
ret.into()
}
pub fn get_block_help(
&self,
block: &Block<'a, Cow<'a, str>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let head = block.head();
let foot = block.foot();
let count = block.len();
let mut data = vec![vec![]; count];
let styles = &self.styles;
let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
let mut any_filled = false;
if block.is_empty() {
return "".into();
}
for (name, data_mut) in block.iter().zip(data.iter_mut()) {
if let Some(command) = app.find_cmd(name.clone()) {
let hint = command.hint();
let help = command.help();
if !hint.is_empty() {
data_mut.push(hint);
any_filled = true;
}
if !help.is_empty() {
data_mut.push(help);
any_filled = true;
}
} else {
panic!("Unknow command {} in block {}", name, block.name());
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
if !wrapped_lines.is_empty() {
// pop last line spacing
wrapped_lines.last_mut().unwrap().pop();
}
let mut usages = vec![];
let wrapped_output = wrapped_lines.join("");
if !head.is_empty() {
usages.push(head);
}
if !foot.is_empty() {
usages.push(foot);
}
if !wrapped_output.is_empty() {
usages.push(wrapped_output.into());
}
usages.join(line_spacing).into()
}
pub fn get_global_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let style = &app.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
if item.is_empty() {
return "".into();
}
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}pub fn set_wrap_width(&mut self, width: usize)
sourcepub fn get_wrap_width(&self) -> usize
pub fn get_wrap_width(&self) -> usize
Examples found in repository?
src/wrapper.rs (line 35)
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
pub fn get_line(&self, line: usize) -> String {
let padding_str = String::from(self.style.padding_char);
if line < self.cows.len() {
let mut ret = " ".repeat(self.style.indent);
let real_width = display_width(self.cows[line].as_ref());
let padding_width = self.get_wrap_width() - real_width;
ret += self.cows[line].as_ref();
match self.style.align {
Align::Left => {
ret += &padding_str.repeat(padding_width);
}
Align::Right => {
ret = padding_str.repeat(padding_width) + &ret;
}
}
ret
} else {
format!(
"{}{}",
" ".repeat(self.style.indent),
padding_str.repeat(self.get_wrap_width())
)
}
}sourcepub fn get_line(&self, line: usize) -> String
pub fn get_line(&self, line: usize) -> String
Examples found in repository?
src/format/policy.rs (line 203)
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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
pub fn get_block_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
) -> Cow<'a, str> {
let style = &self.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}
}
impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
let usage = self.get_command_usage(item);
let mut blocks = vec![usage];
let head = item.head();
let foot = item.foot();
let block_spacing = "\n".repeat(1 + self.style.block_spacing);
if !head.is_empty() {
blocks.push(head);
}
for block in item.block() {
if !block.is_empty() {
let help = self.get_block_help(block, item);
if !help.is_empty() {
blocks.push(help);
}
}
}
if !foot.is_empty() {
blocks.push(foot);
}
Some(blocks.join(&block_spacing).into())
}
}
pub struct DefaultAppPolicy<'a, I> {
styles: Vec<Style>, // style for every block
show_global: bool,
hiding_pos: bool,
marker: PhantomData<&'a I>,
}
impl<'a, I> Default for DefaultAppPolicy<'a, I> {
fn default() -> Self {
Self {
styles: Default::default(),
show_global: true,
hiding_pos: true,
marker: Default::default(),
}
}
}
impl<'a, I> DefaultAppPolicy<'a, I> {
pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
Self {
styles,
show_global,
hiding_pos: true,
marker: PhantomData::default(),
}
}
}
impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
pub fn get_block_usage(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &[Store<'a>],
) -> (Vec<String>, Vec<String>) {
let mut usages = vec![];
let mut args = vec![];
for store in item.iter() {
if let Some(store) = stores.iter().find(|v| &v.name() == store) {
let hint = store.hint();
if !hint.is_empty() {
if store.position() {
if store.optional() {
args.push(format!("[{}]", hint));
} else {
args.push(format!("<{}>", hint));
}
} else if store.optional() {
usages.push(format!("[{}]", hint));
} else {
usages.push(format!("<{}>", hint));
}
}
}
}
(usages, args)
}
pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
let global = app.global();
let mut usages = vec![];
let mut args = vec![];
let mut block_hint = vec![];
for block in global.block() {
let (mut block_usages, mut block_args) = self.get_block_usage(block, global);
if !block_usages.is_empty() {
usages.append(&mut block_usages);
}
// if not omit args, using the args, otherwise using hint of block
if !block_args.is_empty() {
args.append(&mut block_args);
}
}
for block in global.block() {
if !block.is_empty() {
let arg = block.hint();
if !arg.is_empty() {
block_hint.push(arg);
}
}
}
let mut ret = String::from("Usage: ");
// all the option usage
let global_usage = usages.join(" ");
let block_hint = block_hint.join(" ");
let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
let args = args.join(" ");
if !global.name().is_empty() {
ret += &global.name();
ret += " ";
}
if !global_usage.is_empty() {
ret += &global_usage;
ret += " ";
}
if !command_usage.is_empty() {
ret += &command_usage;
ret += " ";
}
if self.hiding_pos {
if !block_hint.is_empty() {
ret += &block_hint;
ret += " ";
}
} else {
if !args.is_empty() {
ret += &args;
ret += " ";
}
}
ret.into()
}
pub fn get_block_help(
&self,
block: &Block<'a, Cow<'a, str>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let head = block.head();
let foot = block.foot();
let count = block.len();
let mut data = vec![vec![]; count];
let styles = &self.styles;
let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
let mut any_filled = false;
if block.is_empty() {
return "".into();
}
for (name, data_mut) in block.iter().zip(data.iter_mut()) {
if let Some(command) = app.find_cmd(name.clone()) {
let hint = command.hint();
let help = command.help();
if !hint.is_empty() {
data_mut.push(hint);
any_filled = true;
}
if !help.is_empty() {
data_mut.push(help);
any_filled = true;
}
} else {
panic!("Unknow command {} in block {}", name, block.name());
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
if !wrapped_lines.is_empty() {
// pop last line spacing
wrapped_lines.last_mut().unwrap().pop();
}
let mut usages = vec![];
let wrapped_output = wrapped_lines.join("");
if !head.is_empty() {
usages.push(head);
}
if !foot.is_empty() {
usages.push(foot);
}
if !wrapped_output.is_empty() {
usages.push(wrapped_output.into());
}
usages.join(line_spacing).into()
}
pub fn get_global_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let style = &app.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
if item.is_empty() {
return "".into();
}
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Examples found in repository?
More examples
src/format/policy.rs (line 195)
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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
pub fn get_block_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
) -> Cow<'a, str> {
let style = &self.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}
}
impl<'a> HelpPolicy<'a, Command<'a>> for DefaultPolicy<'a, Command<'a>> {
fn format(&self, item: &Command<'a>) -> Option<Cow<'a, str>> {
let usage = self.get_command_usage(item);
let mut blocks = vec![usage];
let head = item.head();
let foot = item.foot();
let block_spacing = "\n".repeat(1 + self.style.block_spacing);
if !head.is_empty() {
blocks.push(head);
}
for block in item.block() {
if !block.is_empty() {
let help = self.get_block_help(block, item);
if !help.is_empty() {
blocks.push(help);
}
}
}
if !foot.is_empty() {
blocks.push(foot);
}
Some(blocks.join(&block_spacing).into())
}
}
pub struct DefaultAppPolicy<'a, I> {
styles: Vec<Style>, // style for every block
show_global: bool,
hiding_pos: bool,
marker: PhantomData<&'a I>,
}
impl<'a, I> Default for DefaultAppPolicy<'a, I> {
fn default() -> Self {
Self {
styles: Default::default(),
show_global: true,
hiding_pos: true,
marker: Default::default(),
}
}
}
impl<'a, I> DefaultAppPolicy<'a, I> {
pub fn new(styles: Vec<Style>, show_global: bool) -> Self {
Self {
styles,
show_global,
hiding_pos: true,
marker: PhantomData::default(),
}
}
}
impl<'a, W: Write> DefaultAppPolicy<'a, AppHelp<'a, W>> {
pub fn get_block_usage(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &[Store<'a>],
) -> (Vec<String>, Vec<String>) {
let mut usages = vec![];
let mut args = vec![];
for store in item.iter() {
if let Some(store) = stores.iter().find(|v| &v.name() == store) {
let hint = store.hint();
if !hint.is_empty() {
if store.position() {
if store.optional() {
args.push(format!("[{}]", hint));
} else {
args.push(format!("<{}>", hint));
}
} else if store.optional() {
usages.push(format!("[{}]", hint));
} else {
usages.push(format!("<{}>", hint));
}
}
}
}
(usages, args)
}
pub fn get_app_usage(&self, app: &AppHelp<'a, W>) -> Cow<'a, str> {
let global = app.global();
let mut usages = vec![];
let mut args = vec![];
let mut block_hint = vec![];
for block in global.block() {
let (mut block_usages, mut block_args) = self.get_block_usage(block, global);
if !block_usages.is_empty() {
usages.append(&mut block_usages);
}
// if not omit args, using the args, otherwise using hint of block
if !block_args.is_empty() {
args.append(&mut block_args);
}
}
for block in global.block() {
if !block.is_empty() {
let arg = block.hint();
if !arg.is_empty() {
block_hint.push(arg);
}
}
}
let mut ret = String::from("Usage: ");
// all the option usage
let global_usage = usages.join(" ");
let block_hint = block_hint.join(" ");
let command_usage = if app.has_cmd() { "<COMMAND>" } else { "" };
let args = args.join(" ");
if !global.name().is_empty() {
ret += &global.name();
ret += " ";
}
if !global_usage.is_empty() {
ret += &global_usage;
ret += " ";
}
if !command_usage.is_empty() {
ret += &command_usage;
ret += " ";
}
if self.hiding_pos {
if !block_hint.is_empty() {
ret += &block_hint;
ret += " ";
}
} else {
if !args.is_empty() {
ret += &args;
ret += " ";
}
}
ret.into()
}
pub fn get_block_help(
&self,
block: &Block<'a, Cow<'a, str>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let head = block.head();
let foot = block.foot();
let count = block.len();
let mut data = vec![vec![]; count];
let styles = &self.styles;
let line_spacing = &"\n".repeat(1 + app.style().line_spacing);
let mut any_filled = false;
if block.is_empty() {
return "".into();
}
for (name, data_mut) in block.iter().zip(data.iter_mut()) {
if let Some(command) = app.find_cmd(name.clone()) {
let hint = command.hint();
let help = command.help();
if !hint.is_empty() {
data_mut.push(hint);
any_filled = true;
}
if !help.is_empty() {
data_mut.push(help);
any_filled = true;
}
} else {
panic!("Unknow command {} in block {}", name, block.name());
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
if !wrapped_lines.is_empty() {
// pop last line spacing
wrapped_lines.last_mut().unwrap().pop();
}
let mut usages = vec![];
let wrapped_output = wrapped_lines.join("");
if !head.is_empty() {
usages.push(head);
}
if !foot.is_empty() {
usages.push(foot);
}
if !wrapped_output.is_empty() {
usages.push(wrapped_output.into());
}
usages.join(line_spacing).into()
}
pub fn get_global_help(
&self,
item: &Block<'a, Cow<'a, str>>,
stores: &Vec<Store<'a>>,
app: &AppHelp<'a, W>,
) -> Cow<'a, str> {
let style = &app.style;
let count = item.len();
let head = item.head();
let foot = item.foot();
let line_spacing = &"\n".repeat(1 + style.line_spacing);
let mut output = if head.is_empty() { vec![] } else { vec![head] };
let mut data: Vec<Vec<Cow<'a, str>>> = vec![vec![]; count];
let blocks = item.as_slice();
let styles = &self.styles;
let mut any_filled = false;
if item.is_empty() {
return "".into();
}
for idx in 0..count {
for store in stores {
if store.name() == blocks[idx] {
let hint = store.hint();
let help = store.help();
if !hint.is_empty() {
data[idx].push(hint);
any_filled = true;
}
if !help.is_empty() {
data[idx].push(help);
any_filled = true;
}
}
}
}
if !any_filled {
return "".into();
}
let mut wrapper = Wrapper::new(&data);
if !styles.is_empty() {
wrapper.wrap_with(styles);
} else {
wrapper.wrap();
}
let wrapped = wrapper.get_output();
let mut wrapped_lines = vec![];
for wrapped_line in wrapped {
let max_len = wrapped_line.iter().map(|v| v.len()).max().unwrap_or(1);
let first_style = wrapped_line[0].get_style();
let first_row_spacing = &" ".repeat(first_style.row_spacing);
let first_line_spacing = &"\n".repeat(1 + first_style.line_spacing);
for i in 0..max_len {
let rows = &wrapped_line
.iter()
.map(|v| v.get_line(i))
.collect::<Vec<String>>();
let mut line = rows.join(first_row_spacing);
line.push_str(first_line_spacing);
wrapped_lines.push(line);
}
}
let wrapped_output = wrapped_lines.join("");
if !wrapped_output.is_empty() {
output.push(wrapped_output.into());
}
if !foot.is_empty() {
output.push(foot);
}
let output = output.join(line_spacing);
let output = output.trim_end().to_owned();
output.into()
}