1 //! Related to out filenames of compilation (e.g. save analysis, binaries).
2 use crate::config::{CrateType, Input, OutputFilenames, OutputType};
5 use rustc_span::symbol::sym;
7 use std::path::{Path, PathBuf};
11 crate_type: CrateType,
12 outputs: &OutputFilenames,
15 let default_filename = filename_for_input(sess, crate_type, crate_name, outputs);
16 let out_filename = outputs
18 .get(&OutputType::Exe)
19 .and_then(|s| s.to_owned())
20 .or_else(|| outputs.single_output_file.clone())
21 .unwrap_or(default_filename);
23 check_file_is_writeable(&out_filename, sess);
28 /// Make sure files are writeable. Mac, FreeBSD, and Windows system linkers
29 /// check this already -- however, the Linux linker will happily overwrite a
30 /// read-only file. We should be consistent.
31 pub fn check_file_is_writeable(file: &Path, sess: &Session) {
32 if !is_writeable(file) {
34 "output file {} is not writeable -- check its \
41 fn is_writeable(p: &Path) -> bool {
44 Ok(m) => !m.permissions().readonly(),
48 pub fn find_crate_name(sess: &Session, attrs: &[ast::Attribute], input: &Input) -> String {
49 let validate = |s: String, span: Option<Span>| {
50 validate_crate_name(sess, &s, span);
54 // Look in attributes 100% of the time to make sure the attribute is marked
55 // as used. After doing this, however, we still prioritize a crate name from
56 // the command line over one found in the #[crate_name] attribute. If we
57 // find both we ensure that they're the same later on as well.
59 sess.find_by_name(attrs, sym::crate_name).and_then(|at| at.value_str().map(|s| (at, s)));
61 if let Some(ref s) = sess.opts.crate_name {
62 if let Some((attr, name)) = attr_crate_name {
63 if name.as_str() != s {
65 "`--crate-name` and `#[crate_name]` are \
66 required to match, but `{s}` != `{name}`"
68 sess.span_err(attr.span, &msg);
71 return validate(s.clone(), None);
74 if let Some((attr, s)) = attr_crate_name {
75 return validate(s.to_string(), Some(attr.span));
77 if let Input::File(ref path) = *input {
78 if let Some(s) = path.file_stem().and_then(|s| s.to_str()) {
79 if s.starts_with('-') {
81 "crate names cannot start with a `-`, but \
82 `{s}` has a leading hyphen"
86 return validate(s.replace('-', "_"), None);
91 "rust_out".to_string()
94 pub fn validate_crate_name(sess: &Session, s: &str, sp: Option<Span>) {
95 let mut err_count = 0;
97 let mut say = |s: &str| {
99 Some(sp) => sess.span_err(sp, s),
105 say("crate name must not be empty");
108 if c.is_alphanumeric() {
114 say(&format!("invalid character `{c}` in crate name: `{s}`"));
119 sess.abort_if_errors();
123 pub fn filename_for_metadata(
126 outputs: &OutputFilenames,
128 // If the command-line specified the path, use that directly.
129 if let Some(Some(out_filename)) = sess.opts.output_types.get(&OutputType::Metadata) {
130 return out_filename.clone();
133 let libname = format!("{}{}", crate_name, sess.opts.cg.extra_filename);
135 let out_filename = outputs
138 .unwrap_or_else(|| outputs.out_directory.join(&format!("lib{libname}.rmeta")));
140 check_file_is_writeable(&out_filename, sess);
145 pub fn filename_for_input(
147 crate_type: CrateType,
149 outputs: &OutputFilenames,
151 let libname = format!("{}{}", crate_name, sess.opts.cg.extra_filename);
154 CrateType::Rlib => outputs.out_directory.join(&format!("lib{libname}.rlib")),
155 CrateType::Cdylib | CrateType::ProcMacro | CrateType::Dylib => {
156 let (prefix, suffix) = (&sess.target.dll_prefix, &sess.target.dll_suffix);
157 outputs.out_directory.join(&format!("{prefix}{libname}{suffix}"))
159 CrateType::Staticlib => {
160 let (prefix, suffix) = (&sess.target.staticlib_prefix, &sess.target.staticlib_suffix);
161 outputs.out_directory.join(&format!("{prefix}{libname}{suffix}"))
163 CrateType::Executable => {
164 let suffix = &sess.target.exe_suffix;
165 let out_filename = outputs.path(OutputType::Exe);
166 if suffix.is_empty() { out_filename } else { out_filename.with_extension(&suffix[1..]) }
171 /// Returns default crate type for target
173 /// Default crate type is used when crate type isn't provided neither
174 /// through cmd line arguments nor through crate attributes
176 /// It is CrateType::Executable for all platforms but iOS as there is no
177 /// way to run iOS binaries anyway without jailbreaking and
178 /// interaction with Rust code through static library is the only
180 pub fn default_output_for_target(sess: &Session) -> CrateType {
181 if !sess.target.executables { CrateType::Staticlib } else { CrateType::Executable }
184 /// Checks if target supports crate_type as output
185 pub fn invalid_output_for_target(sess: &Session, crate_type: CrateType) -> bool {
186 if let CrateType::Cdylib | CrateType::Dylib | CrateType::ProcMacro = crate_type {
187 if !sess.target.dynamic_linking {
190 if sess.crt_static(Some(crate_type)) && !sess.target.crt_static_allows_dylibs {
194 if let CrateType::ProcMacro | CrateType::Dylib = crate_type && sess.target.only_cdylib {
197 if let CrateType::Executable = crate_type && !sess.target.executables {