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 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
/*!
# Manifest Dir Macros
This crate provides function-like macros to check or operate paths relative to **CARGO_MANIFEST_DIR** at compile time.
## Examples
```rust
#[macro_use] extern crate manifest_dir_macros;
println!(path!("Cargo.toml"));
println!(path!("src/lib.rs"));
println!(path!("src", "lib.rs"));
println!(path!("src", "lib.rs", "/bin"));
println!(path!("/usr"));
println!(exist_path!("Cargo.toml"));
println!(directory_path!("src"));
println!(not_directory_path!("Cargo.toml"));
println!(file_path!("Cargo.toml"));
println!(relative_path!("Cargo.toml"));
println!(directory_relative_path!("src"));
println!(not_directory_relative_path!("Cargo.toml"));
println!(file_relative_path!("Cargo.toml"));
println!(get_file_name!("src/lib.rs"));
println!(get_file_name!(default = "main.rs", "/"));
println!(get_file_stem!("src/lib.rs"));
println!(get_file_stem!(default = "lib", "/"));
println!(get_extension!("src/lib.rs"));
println!(get_extension!(default = "rs", "src/lib"));
println!(get_parent!("src/lib.rs"));
println!(get_parent!(default = "/home", "/"));
#[cfg(feature = "mime_guess")]
{
println!(mime_guess!("src/lib.rs"));
println!(mime_guess!(default = "application/octet-stream", "Cargo.lock"));
}
// The `tuple` feature lets these macros above support to input nested literal string tuples, which is useful when you want to use these macros inside a `macro_rule!` macro and concatenate with other literal strings.
// `$x:expr` matchers can be used in these macros thus.
#[cfg(feature = "tuple")]
{
println!(path!(("foo",)));
println!(path!(("foo", "bar")));
println!(path!("a", ("foo", "bar")));
println!(path!(("foo", "bar"), "a"));
println!(path!(("foo", "bar"), ("a", "b")));
println!(path!(("foo", "bar", ("a", "b")), ("c", "d")));
}
```
*/
mod functions;
mod join_builder;
use std::{env, path::PathBuf};
use functions::*;
use join_builder::*;
use once_cell::sync::Lazy;
use proc_macro::TokenStream;
#[cfg(feature = "mime_guess")]
use quote::quote;
use syn::parse_macro_input;
static MANIFEST_DIR: Lazy<PathBuf> = Lazy::new(|| {
let s = env::var_os("CARGO_MANIFEST_DIR").expect("we need CARGO_MANIFEST_DIR");
#[cfg(all(windows, feature = "replace-separator"))]
let s = beautify_windows_path_os(s).expect("a UTF8-encodable CARGO_MANIFEST_DIR");
PathBuf::from(s)
});
/// Allows input an absolute path, or a relative path. If a relative path is input, it will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = syn::parse_macro_input!(input as JoinBuilder).into();
let p =
if original_path.is_absolute() { original_path } else { MANIFEST_DIR.join(original_path) };
output_path(p)
}
/// Allows input an absolute path, or a relative path. (multiple components are supported) If a relative path is input, it will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must exist.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn exist_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
let p =
if original_path.is_absolute() { original_path } else { MANIFEST_DIR.join(original_path) };
if p.exists() {
output_path(p)
} else {
compile_error_not_exist(p)
}
}
/// Allows input an absolute path, or a relative path. If a relative path is input, it will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must be an existing directory.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn directory_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
let p =
if original_path.is_absolute() { original_path } else { MANIFEST_DIR.join(original_path) };
if p.is_dir() {
output_path(p)
} else {
compile_error_not_directory(p)
}
}
/// Allows input an absolute path, or a relative path. If a relative path is input, it will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must not be an existing directory.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn not_directory_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
let p =
if original_path.is_absolute() { original_path } else { MANIFEST_DIR.join(original_path) };
if p.metadata().map(|m| !m.is_dir()).unwrap_or(false) {
output_path(p)
} else {
compile_error_directory(p)
}
}
/// Allows input an absolute path, or a relative path. If a relative path is input, it will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must be an existing file.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn file_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
let p =
if original_path.is_absolute() { original_path } else { MANIFEST_DIR.join(original_path) };
if p.is_file() {
output_path(p)
} else {
compile_error_not_file(p)
}
}
/// Allows input a relative path. It will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn relative_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_relative() {
output_path(MANIFEST_DIR.join(original_path))
} else {
compile_error_not_relative(original_path)
}
}
/// Allows input a relative path. It will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must exist.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn exist_relative_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_relative() {
let p = MANIFEST_DIR.join(original_path);
if p.exists() {
output_path(p)
} else {
compile_error_not_exist(p)
}
} else {
compile_error_not_relative(original_path)
}
}
/// Allows input a relative path. It will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must be a directory.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn directory_relative_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_relative() {
let p = MANIFEST_DIR.join(original_path);
if p.is_dir() {
output_path(p)
} else {
compile_error_not_directory(p)
}
} else {
compile_error_not_relative(original_path)
}
}
/// Allows input a relative path. It will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must not be a directory.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn not_directory_relative_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_relative() {
let p = MANIFEST_DIR.join(original_path);
if p.metadata().map(|m| !m.is_dir()).unwrap_or(false) {
output_path(p)
} else {
compile_error_directory(p)
}
} else {
compile_error_not_relative(original_path)
}
}
/// Allows input a relative path. It will be relative to the CARGO_MANIFEST_DIR (a directory where your `Cargo.toml` located). Returns an absolute path, and it must be a file.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn file_relative_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_relative() {
let p = MANIFEST_DIR.join(original_path);
if p.is_file() {
output_path(p)
} else {
compile_error_not_file(p)
}
} else {
compile_error_not_relative(original_path)
}
}
/// Allows input a absolute path. Checks and returns the absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn absolute_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_absolute() {
output_path(original_path)
} else {
compile_error_not_absolute(original_path)
}
}
/// Allows input a absolute path. Checks whether it exists and returns the absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn exist_absolute_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_absolute() {
if original_path.exists() {
output_path(original_path)
} else {
compile_error_not_exist(original_path)
}
} else {
compile_error_not_absolute(original_path)
}
}
/// Allows input a absolute path. Checks whether it is a directory and returns the absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn directory_absolute_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_absolute() {
if original_path.is_dir() {
output_path(original_path)
} else {
compile_error_not_directory(original_path)
}
} else {
compile_error_not_absolute(original_path)
}
}
/// Allows input a absolute path. Checks whether it is not a directory and returns the absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn not_directory_absolute_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_absolute() {
if original_path.metadata().map(|m| !m.is_dir()).unwrap_or(false) {
output_path(original_path)
} else {
compile_error_directory(original_path)
}
} else {
compile_error_not_absolute(original_path)
}
}
/// Allows input a absolute path. Checks whether it is a file and returns the absolute path.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn file_absolute_path(input: TokenStream) -> TokenStream {
let original_path: PathBuf = parse_macro_input!(input as JoinBuilder).into();
if original_path.is_absolute() {
if original_path.is_file() {
output_path(original_path)
} else {
compile_error_not_file(original_path)
}
} else {
compile_error_not_absolute(original_path)
}
}
/// Gets the file name for other purposes. If there is no file name, the default value will be used, or a compile error will be shown.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn get_file_name(input: TokenStream) -> TokenStream {
let jb = parse_macro_input!(input as JoinBuilderNoBeautifyWithDefaultValue);
match jb.0.file_name() {
Some(file_name) => output_os_str(file_name),
None => match jb.1 {
Some(expr) => output_expr(&expr),
None => compile_error(format!("The path {:?} has no file name", jb.0)),
},
}
}
/// Gets the file stem for other purposes. If there is no file stem, the default value will be used, or a compile error will be shown.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn get_file_stem(input: TokenStream) -> TokenStream {
let jb = parse_macro_input!(input as JoinBuilderNoBeautifyWithDefaultValue);
match jb.0.file_stem() {
Some(file_stem) => output_os_str(file_stem),
None => match jb.1 {
Some(expr) => output_expr(&expr),
None => compile_error(format!("The path {:?} has no file stem", jb.0)),
},
}
}
/// Gets the file extension for other purposes. If there is no file extension, the default value will be used, or a compile error will be shown.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn get_extension(input: TokenStream) -> TokenStream {
let jb = parse_macro_input!(input as JoinBuilderNoBeautifyWithDefaultValue);
match jb.0.extension() {
Some(extension) => output_os_str(extension),
None => match jb.1 {
Some(expr) => output_expr(&expr),
None => compile_error(format!("The path {:?} has no file extension", jb.0)),
},
}
}
/// Gets the parent for other purposes. If there is no parent, the default value will be used, or a compile error will be shown.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn get_parent(input: TokenStream) -> TokenStream {
let jb = parse_macro_input!(input as JoinBuilderWithDefaultValue);
match jb.0.parent() {
Some(parent) => output_path(parent),
None => match jb.1 {
Some(expr) => output_expr(&expr),
None => compile_error(format!("The path {:?} has no parent", jb.0)),
},
}
}
#[cfg(feature = "mime_guess")]
/// Guesses the mime type by the path. If the guess fails, the default value will be used, or a compile error will be shown.
///
/// Multiple components can be input by using commas to separate them.
#[proc_macro]
pub fn mime_guess(input: TokenStream) -> TokenStream {
let jb = parse_macro_input!(input as JoinBuilderNoBeautifyWithDefaultValue);
match jb
.0
.extension()
.and_then(|ext| ext.to_str())
.and_then(|ext| mime_guess::from_ext(ext).first())
.map(|mime| mime.to_string())
{
Some(mime) => {
let code = quote! {
#mime
};
code.into()
},
None => match jb.1 {
Some(expr) => output_expr(&expr),
None => {
compile_error(format!("The path {:?} can not be guessed for its mime type", jb.0))
},
},
}
}