1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 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
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

mod action;
use action::Action;

mod transform;
use transform::Context;

use argh::FromArgs;
use regex::Regex;
use std::fmt::Write;
use std::fs::{File, OpenOptions};
use std::io::BufReader;
use std::io::Write as _;
use std::path::PathBuf;
use std::process;

/// Converter from path-based links to intra-doc links for Rust crates.
///
/// This is not perfect and the modified files should still be reviewed after
/// running it.
///
/// By default it will only print the changes and not apply them, use `-a`
/// (`--apply`) to write them.
///
/// If you are modifying `core` or `alloc` instead of `std`, you can pass the
/// `-c core` (`--crate core`) to mark the change in the root crate.
///
/// By default the crate will output the changes it will do (or did when `-a`
/// is passed). If this is not what you want, use the `-q` (`--quiet`) flag
/// to only show errors.
///
/// When `-q` is not given, only files with changes will be displayed.
#[derive(FromArgs, Debug)]
pub struct Args {
    /// prints the crate version and exit.
    #[argh(switch)]
    version: bool,

    /// root crate (examples: `std`, `core`, `my_crate`, ...).
    #[argh(
        option,
        long = "crate",
        short = 'c',
        from_str_fn(check_krate),
        default = "\"std\".into()"
    )]
    krate: String,

    /// apply the proposed changes.
    #[argh(switch, short = 'a')]
    apply: bool,

    /// use rustdoc disambiguators in front of the transformed links
    /// ('type@', ...). Ending disambiguators like '()' and '!' are always
    /// added, regardless of this option.
    #[argh(switch, short = 'd')]
    disambiguate: bool,

    /// do not display changes, only errors when they happen.
    #[argh(switch, short = 'q')]
    quiet: bool,

    /// files to search links in.
    #[argh(positional)]
    paths: Vec<PathBuf>,
}

/// Takes an `Args` instance to transform the paths it contains accordingly
/// with its stored parameters.
pub fn run(args: Args) {
    if args.version {
        println!("cargo-intraconv {}", std::env!("CARGO_PKG_VERSION"));
        return;
    }

    if args.paths.is_empty() {
        eprintln!("No paths were passed as arguments.");
        eprintln!("Usage: target/debug/cargo-intraconv [<paths...>] [--version] [-c <crate>] [-a] [-d] [-q]");
        process::exit(1);
    }

    let display_changes = !args.quiet;

    let mut ctx = Context::new(args.krate, args.disambiguate);
    for path in args.paths {
        if path.as_os_str() == "intraconv" && !path.exists() {
            continue;
        }

        // First display the path of the file that is about to be opened and tested.
        let path_display = path.display().to_string();

        // Then open the file, reporting if it fails.
        let file = match File::open(&path) {
            Ok(file) => BufReader::new(file),
            Err(err) => {
                eprintln!("Failed to open file '{}' for read: {}", &path_display, err);
                continue;
            }
        };

        let actions = match ctx.transform_file(file) {
            Ok(actions) => actions,
            Err(err) => {
                eprintln!("Failed to transform file '{}': {}", &path_display, err);
                continue;
            }
        };

        // Do not allocate when unecessary.
        let mut updated_content = if args.apply {
            String::with_capacity(64 * actions.len())
        } else {
            String::new()
        };

        // Only display the filename when -q is not set and there are changes.
        if display_changes && actions.iter().any(|a| !a.is_unchanged()) {
            println!("{}", &path_display);
            // TODO: Not always perfect because of unicode, fix this.
            println!("{}\n", "=".repeat(path_display.len()));
        }

        // Display the changes that can be made.
        for l in actions {
            if !l.is_unchanged() && display_changes {
                println!("{}\n", l);
            }
            if args.apply {
                write!(updated_content, "{}", l.as_new_line()).unwrap();
            }
        }

        if !args.apply {
            continue;
        }

        let mut file = match OpenOptions::new().write(true).truncate(true).open(path) {
            Ok(file) => file,
            Err(err) => {
                eprintln!("Failed to open file '{}' for write: {}", &path_display, err);
                continue;
            }
        };

        match write!(file, "{}", updated_content) {
            Ok(file) => file,
            Err(err) => {
                eprintln!("Failed to write to '{}': {}", &path_display, err);
                continue;
            }
        };
    }
}

/// Check the given `krate` is exactly one of `std`, `core` or `alloc`.
/// In any other case it will return an error message.
fn check_krate(krate: &str) -> Result<String, String> {
    let krate_regex = Regex::new(r"^[\w_]+$").unwrap();
    if krate_regex.is_match(krate) {
        Ok(krate.into())
    } else {
        Err(format!(
            "The passed crate identifier '{}' is not valid.\n",
            krate
        ))
    }
}