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
/*
* Copyright (c) 2021, 2022 Peter Pentchev <roam@ringlet.net>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
//! Query a program for its features.
//!
//! The [`obtain_features`] function, when passed
//! a [`Config`][crate::defs::Config] object, will run a program with
//! the appropriate command-line options, analyze its output, and
//! build up a list of the supported features.
//!
//! See the crate-level documentation for sample usage.
use std::process::Command;
use anyhow::Context;
use crate::defs::{Config, ObtainError, Obtained};
use crate::expr::parser;
/// Decode a program's output, assuming it is a valid UTF-8 string.
fn decode_output(program: &str, output: Vec<u8>) -> Result<String, ObtainError> {
// FIXME: handle non-UTF-8 stuff
String::from_utf8(output)
.context("Could not decode a valid UTF-8 string")
.map_err(|err| ObtainError::DecodeOutput(program.to_owned(), err))
}
/// Run the specified program, analyze its output.
///
/// See the crate-level documentation for sample usage.
///
/// # Errors
///
/// Will return [`Obtained::Failed`] if the program cannot be executed.
/// Will propagate errors from decoding the program's output as UTF-8 lines.
#[inline]
#[allow(clippy::module_name_repetitions)]
pub fn obtain_features(config: &Config) -> Result<Obtained, ObtainError> {
match Command::new(&config.program)
.args(&[&config.option_name])
.output()
.context(format!("Could not execute {}", config.program))
{
Ok(output) => {
if output.status.success() {
decode_output(&config.program, output.stdout)?
.lines()
.find_map(|line| line.strip_prefix(&config.prefix))
.map_or(Ok(Obtained::NotSupported), |line| {
Ok(Obtained::Features(
parser::parse_features_line(line).map_err(ObtainError::Parse)?,
))
})
} else {
Ok(Obtained::NotSupported)
}
}
Err(err) => Ok(Obtained::Failed(ObtainError::RunProgram(
config.program.clone(),
err,
))),
}
}