blob: 75326681f4a192387d831c7a82451e2d92a1052e [file] [log] [blame]
David Tolnay39efd732020-08-30 13:21:51 -07001#[cfg(test)]
2#[path = "test.rs"]
3mod test;
4
David Tolnay9ef74ce2020-09-13 23:24:02 -04005use super::{Opt, Output};
David Tolnay39fa3662020-07-30 20:23:18 -07006use clap::AppSettings;
7use std::ffi::{OsStr, OsString};
8use std::path::PathBuf;
9
10type App = clap::App<'static, 'static>;
11type Arg = clap::Arg<'static, 'static>;
12
13const USAGE: &str = "\
14 cxxbridge <input>.rs Emit .cc file for bridge to stdout
15 cxxbridge <input>.rs --header Emit .h file for bridge to stdout
David Tolnaye32c5022020-09-13 23:03:05 -040016 cxxbridge --header Emit \"rust/cxx.h\" header to stdout\
David Tolnay39fa3662020-07-30 20:23:18 -070017";
18
19const TEMPLATE: &str = "\
20{bin} {version}
21David Tolnay <dtolnay@gmail.com>
22https://github.com/dtolnay/cxx
23
24USAGE:
25 {usage}
26
27ARGS:
28{positionals}
29OPTIONS:
30{unified}\
31";
32
33fn app() -> App {
34 let mut app = App::new("cxxbridge")
35 .usage(USAGE)
36 .template(TEMPLATE)
37 .setting(AppSettings::NextLineHelp)
38 .arg(arg_input())
39 .arg(arg_cxx_impl_annotations())
40 .arg(arg_header())
41 .arg(arg_include())
David Tolnay9ef74ce2020-09-13 23:24:02 -040042 .arg(arg_output())
David Tolnay39fa3662020-07-30 20:23:18 -070043 .help_message("Print help information.")
44 .version_message("Print version information.");
45 if let Some(version) = option_env!("CARGO_PKG_VERSION") {
46 app = app.version(version);
47 }
48 app
49}
50
51const INPUT: &str = "input";
52const CXX_IMPL_ANNOTATIONS: &str = "cxx-impl-annotations";
53const HEADER: &str = "header";
54const INCLUDE: &str = "include";
David Tolnay9ef74ce2020-09-13 23:24:02 -040055const OUTPUT: &str = "output";
David Tolnay39fa3662020-07-30 20:23:18 -070056
57pub(super) fn from_args() -> Opt {
58 let matches = app().get_matches();
David Tolnay64276142020-09-24 10:43:02 -040059
60 let input = matches.value_of_os(INPUT).map(PathBuf::from);
61 let cxx_impl_annotations = matches.value_of(CXX_IMPL_ANNOTATIONS).map(str::to_owned);
62 let header = matches.is_present(HEADER);
63 let include = matches
64 .values_of(INCLUDE)
65 .map_or_else(Vec::new, |v| v.map(str::to_owned).collect());
66 let output = match matches.value_of_os(OUTPUT) {
67 None => Output::Stdout,
68 Some(path) if path == "-" => Output::Stdout,
69 Some(path) => Output::File(PathBuf::from(path)),
70 };
71
David Tolnay39fa3662020-07-30 20:23:18 -070072 Opt {
David Tolnay64276142020-09-24 10:43:02 -040073 input,
74 cxx_impl_annotations,
75 header,
76 include,
77 output,
David Tolnay39fa3662020-07-30 20:23:18 -070078 }
79}
80
81fn validate_utf8(arg: &OsStr) -> Result<(), OsString> {
82 if arg.to_str().is_some() {
83 Ok(())
84 } else {
85 Err(OsString::from("invalid utf-8 sequence"))
86 }
87}
88
89fn arg_input() -> Arg {
90 Arg::with_name(INPUT)
91 .help("Input Rust source file containing #[cxx::bridge].")
92 .required_unless(HEADER)
93}
94
95fn arg_cxx_impl_annotations() -> Arg {
96 const HELP: &str = "\
97Optional annotation for implementations of C++ function wrappers
98that may be exposed to Rust. You may for example need to provide
99__declspec(dllexport) or __attribute__((visibility(\"default\")))
100if Rust code from one shared object or executable depends on
101these C++ functions in another.
102 ";
103 Arg::with_name(CXX_IMPL_ANNOTATIONS)
104 .long(CXX_IMPL_ANNOTATIONS)
105 .takes_value(true)
106 .value_name("annotation")
107 .validator_os(validate_utf8)
108 .help(HELP)
109}
110
111fn arg_header() -> Arg {
David Tolnaye2e47a32020-09-24 10:23:27 -0400112 const HELP: &str = "\
113Emit header with declarations only. Optional if using `-o` with
114a path ending in `.h`.
115 ";
116 Arg::with_name(HEADER).long(HEADER).help(HELP)
David Tolnay39fa3662020-07-30 20:23:18 -0700117}
118
119fn arg_include() -> Arg {
120 const HELP: &str = "\
121Any additional headers to #include. The cxxbridge tool does not
122parse or even require the given paths to exist; they simply go
123into the generated C++ code as #include lines.
124 ";
125 Arg::with_name(INCLUDE)
126 .long(INCLUDE)
127 .short("i")
128 .takes_value(true)
129 .multiple(true)
130 .validator_os(validate_utf8)
131 .help(HELP)
132}
David Tolnay9ef74ce2020-09-13 23:24:02 -0400133
134fn arg_output() -> Arg {
135 const HELP: &str = "\
136Path of file to write as output. Output goes to stdout if -o is
137not specified.
138 ";
139 Arg::with_name(OUTPUT)
140 .long(OUTPUT)
141 .short("o")
142 .takes_value(true)
143 .validator_os(validate_utf8)
144 .help(HELP)
145}