Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table-ized output formatting #9

Merged
merged 3 commits into from
Jun 24, 2018
Merged

Table-ized output formatting #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4b2975
Format output as table + tree by default
alexmaco Jun 23, 2018
c6a83f5
wire up --compact arg to control compact output
alexmaco Jun 23, 2018
b4e938c
convert output colorizer from fn to closure
alexmaco Jun 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 89 additions & 29 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ pub struct UnsafeCounter {
in_unsafe_block: bool,
}

impl UnsafeCounter {
fn has_unsafe(&self) -> bool {
self.functions.unsafe_num > 0
|| self.exprs.unsafe_num > 0
|| self.itemimpls.unsafe_num > 0
|| self.itemtraits.unsafe_num > 0
|| self.methods.unsafe_num > 0
}
}

impl<'ast> visit::Visit<'ast> for UnsafeCounter {
fn visit_item_fn(&mut self, i: &ItemFn) {
// fn definitions
Expand Down Expand Up @@ -263,6 +273,11 @@ struct Args {
#[structopt(short = "Z", value_name = "FLAG")]
/// Unstable (nightly-only) flags to Cargo
unstable_flags: Vec<String>,

//TODO: some real args, keep these when refactoring
#[structopt(long = "compact")]
/// Display compact output instead of table
compact: bool,
}

enum Charset {
Expand Down Expand Up @@ -394,7 +409,11 @@ fn real_main(args: Args, config: &mut Config) -> CliResult {
};

println!();
println!("{}", "Compact unsafe info: (functions, expressions, impls, traits, methods)".bold());
if args.compact {
println!("{}", "Compact unsafe info: (functions, expressions, impls, traits, methods)".bold());
} else {
println!("{}", UNSAFE_COUNTERS_HEADER.iter().map(|s| s.to_owned()).collect::<Vec<_>>().join(" ").bold());
}
println!();

if args.duplicates {
Expand All @@ -408,6 +427,7 @@ fn real_main(args: Args, config: &mut Config) -> CliResult {
symbols,
prefix,
args.all,
args.compact,
);
println!();
}
Expand All @@ -420,6 +440,7 @@ fn real_main(args: Args, config: &mut Config) -> CliResult {
symbols,
prefix,
args.all,
args.compact,
);
}

Expand Down Expand Up @@ -583,6 +604,7 @@ fn print_tree<'a>(
symbols: &Symbols,
prefix: Prefix,
all: bool,
compact_output: bool,
) {
let mut visited_deps = HashSet::new();
let mut levels_continue = vec![];
Expand All @@ -598,6 +620,7 @@ fn print_tree<'a>(
&mut levels_continue,
prefix,
all,
compact_output,
);
}

Expand All @@ -613,59 +636,70 @@ fn print_dependency<'a>(
levels_continue: &mut Vec<bool>,
prefix: Prefix,
all: bool,
compact_output: bool,
) {
let new = all || visited_deps.insert(package.id);
//let star = if new { "" } else { " (*)" };

match prefix {
Prefix::Depth => print!("{} ", levels_continue.len()),
let treevines = match prefix {
Prefix::Depth => format!("{} ", levels_continue.len()),
Prefix::Indent => {
let mut buf = String::new();
if let Some((&last_continues, rest)) = levels_continue.split_last() {
for &continues in rest {
let c = if continues { symbols.down } else { " " };
print!("{} ", c);
buf.push_str(&format!("{} ", c));
}

let c = if last_continues {
symbols.tee
} else {
symbols.ell
};
print!("{0}{1}{1} ", c, symbols.right);
buf.push_str(&format!("{0}{1}{1} ", c, symbols.right));
}
buf
},
Prefix::None => ()
}
Prefix::None => "".into(),
};

// TODO: Add command line flag for this and make it default to false.
let allow_partial_results = true;

let counters = find_unsafe(
package.pack.root(),
allow_partial_results);
let counts = [
counters.functions.unsafe_num,
counters.exprs.unsafe_num,
counters.itemimpls.unsafe_num,
counters.itemtraits.unsafe_num,
counters.methods.unsafe_num
];
let unsafe_found = counts.iter().any(|c| *c > 0);

let unsafe_found = counters.has_unsafe();
let colorize = |s: String| {
if unsafe_found {
s.red().bold()
} else {
s.green()
}
};

let rad = if unsafe_found { "☢" } else { "" };
let compact_unsafe_info =
counts
.iter()
.map(|c| c.to_string())
.collect::<Vec<String>>()
.join(", ");
let line = format!(
"{} ({})",
format.display(
package.id,
package.pack.manifest().metadata()),
compact_unsafe_info);
let line = if unsafe_found { line.red().bold() } else { line.green() };
println!("{} {}", line, rad);

let dep_name = colorize(format!("{}", format.display(
package.id,
package.pack.manifest().metadata())
));

if compact_output {
let compact_unsafe_info = format!("({}, {}, {}, {}, {})",
counters.functions.unsafe_num,
counters.exprs.unsafe_num,
counters.itemimpls.unsafe_num,
counters.itemtraits.unsafe_num,
counters.methods.unsafe_num,
);
println!("{}{} {} {}", treevines, dep_name, colorize(compact_unsafe_info), rad);
} else {
let unsafe_info = colorize(table_row(&counters));
println!("{} {: <1} {}{}", unsafe_info, rad, treevines, dep_name);
}

if !new {
return;
}
Expand Down Expand Up @@ -699,6 +733,7 @@ fn print_dependency<'a>(
levels_continue,
prefix,
all,
compact_output,
);
print_dependency_kind(
Kind::Build,
Expand All @@ -711,6 +746,7 @@ fn print_dependency<'a>(
levels_continue,
prefix,
all,
compact_output,
);
print_dependency_kind(
Kind::Development,
Expand All @@ -723,6 +759,7 @@ fn print_dependency<'a>(
levels_continue,
prefix,
all,
compact_output,
);
}

Expand All @@ -737,6 +774,7 @@ fn print_dependency_kind<'a>(
levels_continue: &mut Vec<bool>,
prefix: Prefix,
all: bool,
compact_output: bool,
) {
if deps.is_empty() {
return;
Expand All @@ -752,6 +790,9 @@ fn print_dependency_kind<'a>(
};
if let Prefix::Indent = prefix {
if let Some(name) = name {
if !compact_output {
print!("{}", table_row_empty());
}
for &continues in &**levels_continue {
let c = if continues { symbols.down } else { " " };
print!("{} ", c);
Expand All @@ -774,7 +815,26 @@ fn print_dependency_kind<'a>(
levels_continue,
prefix,
all,
compact_output,
);
levels_continue.pop();
}
}

// TODO: use a table library, or factor the tableness out in a smarter way
const UNSAFE_COUNTERS_HEADER : [&'static str; 6] = ["Functions ", "Expressions ", "Impls ", "Traits ", "Methods ", "Dependency"];

fn table_row_empty() -> String {
" ".repeat(UNSAFE_COUNTERS_HEADER.iter().take(5).map(|s| s.len()).sum::<usize>() + UNSAFE_COUNTERS_HEADER.len() + 1)
}

fn table_row(count: &UnsafeCounter) -> String {
format!(
"{: <9} {: <11} {: <5} {: <6} {: <7}",
count.functions.unsafe_num,
count.exprs.unsafe_num,
count.itemimpls.unsafe_num,
count.itemtraits.unsafe_num,
count.methods.unsafe_num,
)
}