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

Jump to bottom

WIP - friendly error when pkg-config is not installed #88

Closed
wants to merge 2 commits into from
Closed

WIP - friendly error when pkg-config is not installed #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5beb9e3
first attempt at error handling
eflanagan0 Aug 23, 2019
940d13b
tighten error handling
Aug 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
142 changes: 89 additions & 53 deletions src/lib.rs
View file
Open in desktop
Expand Up @@ -73,7 +73,7 @@ use std::ffi::{OsStr, OsString};
use std::fmt;
use std::io;
use std::ops::{Bound, RangeBounds};
use std::path::{PathBuf, Path};
use std::path::{Path, PathBuf};
use std::process::{Command, Output};
use std::str;

Expand Down Expand Up @@ -108,6 +108,9 @@ pub enum Error {
/// Contains the name of the responsible environment variable.
EnvNoPkgConfig(String),

/// `pkg-config` could not be found on the system
///
NotInstalled,
/// Cross compilation detected.
///
/// Override with `PKG_CONFIG_ALLOW_CROSS=1`.
Expand All @@ -127,11 +130,11 @@ pub enum Error {
// please don't match on this, we're likely to add more variants over time
__Nonexhaustive,
}

impl error::Error for Error {
fn description(&self) -> &str {
match *self {
Error::EnvNoPkgConfig(_) => "pkg-config requested to be aborted",
Error::NotInstalled => "pkg-config does not appear to be installed",
Error::CrossCompilation => {
"pkg-config doesn't handle cross compilation. \
Use PKG_CONFIG_ALLOW_CROSS=1 to override"
Expand All @@ -153,20 +156,28 @@ impl error::Error for Error {
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
match *self {
Error::EnvNoPkgConfig(ref name) => {
write!(f, "Aborted because {} is set", name)
}
Error::CrossCompilation => {
write!(f, "Cross compilation detected. \
Use PKG_CONFIG_ALLOW_CROSS=1 to override")
}
Error::Command { ref command, ref cause } => {
write!(f, "Failed to run `{}`: {}", command, cause)
}
Error::Failure { ref command, ref output } => {
Error::EnvNoPkgConfig(ref name) => write!(f, "Aborted because {} is set", name),
Error::NotInstalled => write!(f, "pkg-config does not appear to be installed"),
Error::CrossCompilation => write!(
f,
"Cross compilation detected. \
Use PKG_CONFIG_ALLOW_CROSS=1 to override"
),
Error::Command {
ref command,
ref cause,
} => write!(f, "Failed to run `{}`: {}", command, cause),
Error::Failure {
ref command,
ref output,
} => {
let stdout = str::from_utf8(&output.stdout).unwrap();
let stderr = str::from_utf8(&output.stderr).unwrap();
write!(f, "`{}` did not exit successfully: {}", command, output.status)?;
write!(
f,
"`{}` did not exit successfully: {}",
command, output.status
)?;
if !stdout.is_empty() {
write!(f, "\n--- stdout\n{}", stdout)?;
}
Expand All @@ -188,31 +199,34 @@ pub fn find_library(name: &str) -> Result<Library, String> {

/// Simple shortcut for using all default options for finding a library.
pub fn probe_library(name: &str) -> Result<Library, Error> {
Config::new().probe(name)
Config::new()?.probe(name)
}

/// Run `pkg-config` to get the value of a variable from a package using
/// --variable.
pub fn get_variable(package: &str, variable: &str) -> Result<String, Error> {
let arg = format!("--variable={}", variable);
let cfg = Config::new();
let cfg = Config::new()?;
let out = run(cfg.command(package, &[&arg]))?;
Ok(str::from_utf8(&out).unwrap().trim_right().to_owned())
}

impl Config {
/// Creates a new set of configuration options which are all initially set
/// to "blank".
pub fn new() -> Config {
Config {
pub fn new() -> Result<Config, Error> {
if let Err(_) = Command::new("pkg-config").arg("-h").output() {
return Err(Error::NotInstalled);
}
Ok(Config {
statik: None,
min_version: Bound::Unbounded,
max_version: Bound::Unbounded,
extra_args: vec![],
print_system_libs: true,
cargo_metadata: true,
env_metadata: false,
}
})
}

/// Indicate whether the `--static` flag should be passed.
Expand Down Expand Up @@ -241,7 +255,7 @@ impl Config {
/// Indicate that the library's version must be in `range`.
pub fn range_version<'a, R>(&mut self, range: R) -> &mut Config
where
R: RangeBounds<&'a str>
R: RangeBounds<&'a str>,
{
self.min_version = match range.start_bound() {
Bound::Included(vers) => Bound::Included(vers.to_string()),
Expand Down Expand Up @@ -301,7 +315,7 @@ impl Config {
pub fn probe(&self, name: &str) -> Result<Library, Error> {
let abort_var_name = format!("{}_NO_PKG_CONFIG", envify(name));
if self.env_var_os(&abort_var_name).is_some() {
return Err(Error::EnvNoPkgConfig(abort_var_name))
return Err(Error::EnvNoPkgConfig(abort_var_name));
} else if !self.target_supported() {
return Err(Error::CrossCompilation);
}
Expand Down Expand Up @@ -336,9 +350,9 @@ impl Config {
Err(_) => {
// if not disabled, and pkg-config is customized,
// then assume it's prepared for cross-compilation
self.targetted_env_var("PKG_CONFIG").is_ok() ||
self.targetted_env_var("PKG_CONFIG_SYSROOT_DIR").is_ok()
},
self.targetted_env_var("PKG_CONFIG").is_ok()
|| self.targetted_env_var("PKG_CONFIG_SYSROOT_DIR").is_ok()
}
}
}

Expand Down Expand Up @@ -382,13 +396,14 @@ impl Config {
}

fn command(&self, name: &str, args: &[&str]) -> Command {
let exe = self.env_var("PKG_CONFIG").unwrap_or_else(|_| String::from("pkg-config"));
let exe = self
.env_var("PKG_CONFIG")
.unwrap_or_else(|_| String::from("pkg-config"));
let mut cmd = Command::new(exe);
if self.is_static(name) {
cmd.arg("--static");
}
cmd.args(args)
.args(&self.extra_args);
cmd.args(args).args(&self.extra_args);

if let Ok(value) = self.targetted_env_var("PKG_CONFIG_PATH") {
cmd.env("PKG_CONFIG_PATH", value);
Expand Down Expand Up @@ -446,7 +461,6 @@ impl Config {
}
}


// Implement Default manualy since Bound does not implement Default.
impl Default for Config {
fn default() -> Config {
Expand Down Expand Up @@ -485,10 +499,11 @@ impl Library {
}

let words = split_flags(output);
let parts = words.iter()
.filter(|l| l.len() > 2)
.map(|arg| (&arg[0..2], &arg[2..]))
.collect::<Vec<_>>();
let parts = words
.iter()
.filter(|l| l.len() > 2)
.map(|arg| (&arg[0..2], &arg[2..]))
.collect::<Vec<_>>();

let mut dirs = Vec::new();
let statik = config.is_static(name);
Expand Down Expand Up @@ -526,21 +541,25 @@ impl Library {
}
"-D" => {
let mut iter = val.split("=");
self.defines.insert(iter.next().unwrap().to_owned(), iter.next().map(|s| s.to_owned()));
self.defines.insert(
iter.next().unwrap().to_owned(),
iter.next().map(|s| s.to_owned()),
);
}
_ => {}
}
}

let mut iter = words.iter()
.flat_map(|arg| if arg.starts_with("-Wl,") {
arg[4..].split(',').collect()
} else {
vec![arg.as_ref()]
});
let mut iter = words.iter().flat_map(|arg| {
if arg.starts_with("-Wl,") {
arg[4..].split(',').collect()
} else {
vec![arg.as_ref()]
}
});
while let Some(part) = iter.next() {
if part != "-framework" {
continue
continue;
}
if let Some(lib) = iter.next() {
let meta = format!("rustc-link-lib=framework={}", lib);
Expand All @@ -556,9 +575,10 @@ impl Library {
}

fn envify(name: &str) -> String {
name.chars().map(|c| c.to_ascii_uppercase()).map(|c| {
if c == '-' {'_'} else {c}
}).collect()
name.chars()
.map(|c| c.to_ascii_uppercase())
.map(|c| if c == '-' { '_' } else { c })
.collect()
}

/// System libraries should only be linked dynamically
Expand All @@ -571,8 +591,7 @@ fn is_static_available(name: &str, dirs: &[PathBuf]) -> bool {
};

dirs.iter().any(|dir| {
!system_roots.iter().any(|sys| dir.starts_with(sys)) &&
dir.join(&libname).exists()
!system_roots.iter().any(|sys| dir.starts_with(sys)) && dir.join(&libname).exists()
})
}

Expand Down Expand Up @@ -613,9 +632,7 @@ fn split_flags(output: &[u8]) -> Vec<String> {
escaped = false;
word.push(b);
}
b'\\' => {
escaped = true
}
b'\\' => escaped = true,
b'\t' | b'\n' | b'\r' | b' ' => {
if !word.is_empty() {
words.push(String::from_utf8(word).unwrap());
Expand All @@ -636,19 +653,38 @@ fn split_flags(output: &[u8]) -> Vec<String> {
#[test]
#[cfg(target_os = "macos")]
fn system_library_mac_test() {
assert!(!is_static_available("PluginManager", &[PathBuf::from("/Library/Frameworks")]));
assert!(!is_static_available("python2.7", &[PathBuf::from("/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/config")]));
assert!(!is_static_available("ffi_convenience", &[PathBuf::from("/Library/Ruby/Gems/2.0.0/gems/ffi-1.9.10/ext/ffi_c/libffi-x86_64/.libs")]));
assert!(!is_static_available(
"PluginManager",
&[PathBuf::from("/Library/Frameworks")]
));
assert!(!is_static_available(
"python2.7",
&[PathBuf::from(
"/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/config"
)]
));
assert!(!is_static_available(
"ffi_convenience",
&[PathBuf::from(
"/Library/Ruby/Gems/2.0.0/gems/ffi-1.9.10/ext/ffi_c/libffi-x86_64/.libs"
)]
));

// Homebrew is in /usr/local, and it's not a part of the OS
if Path::new("/usr/local/lib/libpng16.a").exists() {
assert!(is_static_available("png16", &[PathBuf::from("/usr/local/lib")]));
assert!(is_static_available(
"png16",
&[PathBuf::from("/usr/local/lib")]
));
}
}

#[test]
#[cfg(target_os = "linux")]
fn system_library_linux_test() {
assert!(!is_static_available("util", &[PathBuf::from("/usr/lib/x86_64-linux-gnu")]));
assert!(!is_static_available(
"util",
&[PathBuf::from("/usr/lib/x86_64-linux-gnu")]
));
assert!(!is_static_available("dialog", &[PathBuf::from("/usr/lib")]));
}