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
mod opts;
mod rule_map;
pub use opts::Opts;
use std::io::{BufRead, BufReader};
use std::path::PathBuf;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use std::{fs, fs::File};
use crate::context::Context;
use crate::error::MakeError;
use crate::expand::expand;
use crate::logger::Logger;
use crate::vars::Vars;
use rule_map::{Rule, RuleMap};
const COMMENT_INDICATOR: char = '#';
// struct PhysicalLine {
// content: String,
// index: usize,
// }
// struct LogicalLine {
// physical_lines: Vec<PhysicalLine>,
// smushed: String,
// breaks: Vec<usize>,
// }
/// The internal representation of a makefile.
#[derive(Debug)]
pub struct Makefile<L: Logger> {
pub opts: Opts,
pub logger: Box<L>,
rule_map: RuleMap,
default_target: Option<String>,
// Parser state.
pub vars: Vars,
current_rule: Option<Rule>,
context: Context,
}
impl<L: Logger> Makefile<L> {
/// Principal interface for reading and parsing a makefile.
pub fn new(path: PathBuf, opts: Opts, logger: Box<L>, vars: Vars) -> Result<Self, MakeError> {
// Initialize the `Makefile` struct with default values.
let mut makefile = Self {
opts,
logger: logger,
rule_map: RuleMap::new(),
default_target: None,
vars: vars,
current_rule: None,
context: path.clone().into(),
};
// Open the makefile and run it through the parser.
let file = File::open(&path).map_err(|e| {
MakeError::new(format!("Could not read makefile ({}).", e), path.into())
})?;
makefile.parse(BufReader::new(file))?;
Ok(makefile)
}
/// Iterate over the makefile's lines, call `parse_line` to handle the actual parsing logic, and
/// manage context.
fn parse<R: BufRead>(&mut self, stream: R) -> Result<(), MakeError> {
self.current_rule = None;
for (i, result) in stream.lines().enumerate() {
// Set the context line number and extract the line.
self.context.line_index = Some(i);
let line = result.map_err(|e| MakeError::new(e.to_string(), self.context.clone()))?;
self.context.content = Some(line.clone());
// Parse the line.
self.parse_line(line)?;
}
// Always push two blank lines at the end to terminate trailing rules, even if the last rule
// contained a trailing backslash.
self.parse_line("".to_string())?;
self.parse_line("".to_string())?;
Ok(())
}
/// The line parser is where the "meat" of the parsing occurs. This is responsible for
/// extracting rules from the physical lines of the makefile stream, properly handling escaped
/// newlines and semicolons, and also managing state, such as variable assignments and
/// annotating when the parser moves in-to and out-of a rule definition.
fn parse_line(&mut self, line: String) -> Result<(), MakeError> {
// Handle recipe lines.
let recipe_prefix = &self.vars.get(".RECIPEPREFIX").value;
if line.starts_with(recipe_prefix) {
// If line starts with the recipe prefix, then push it to the current rule.
match &mut self.current_rule {
None => return Err(MakeError::new("recipe without rule", self.context.clone())),
Some(r) => {
// Strip the recipe prefix first.
let cmd = line
.strip_prefix(recipe_prefix)
.expect("line known to start with a recipe prefix")
.trim()
.to_string();
if !cmd.is_empty() {
r.recipe.push(
expand(cmd.as_str(), &self.vars)
.map_err(|e| MakeError::new(e, self.context.clone()))?,
);
}
}
}
return Ok(());
}
// Anything other than recipe lines terminate a rule definition.
if let Some(rule) = self.current_rule.take() {
// If there is no default target, see if we can assign one.
if self.default_target.is_none() {
for target in rule.targets.iter() {
// Set default target if none is specified and this is a normal target.
if self.default_target.is_none() && !target.starts_with('.') {
self.default_target = Some(target.clone());
}
}
}
// Add the rule to the `rule_map`.
self.rule_map.insert(rule, &self.logger)?;
}
// Ignore pure comments and blank lines.
let trimmed_line = line.trim();
if trimmed_line.starts_with(COMMENT_INDICATOR) || trimmed_line.is_empty() {
return Ok(());
}
// Handle rule definitions.
if let Some((targets, mut deps)) = line.split_once(':') {
// First, if deps start with another `:`, then this is a double-colon rule, so we should
// mark it as such.
let mut double_colon = false;
if let Some(ch) = deps.chars().next() {
if ch == ':' {
deps = &deps[1..];
double_colon = true;
}
}
// There could be a semicolon after prerequisites, in which case we should parse
// everything after that as a rule line.
let rule = deps.split_once(';').map(|(d, r)| {
deps = d;
r
});
self.current_rule = Some(Rule {
targets: expand(targets, &self.vars)
.map_err(|e| MakeError::new(e, self.context.clone()))?
.split_whitespace()
.map(|s| s.to_string())
.collect(),
prerequisites: expand(deps, &self.vars)
.map_err(|e| MakeError::new(e, self.context.clone()))?
.split_whitespace()
.map(|s| s.to_string())
.collect(),
recipe: vec![],
context: self.context.clone(),
double_colon,
});
// Add rule line if we found one.
if let Some(r) = rule {
self.parse_line(format!("{}{}", self.vars.get(".RECIPEPREFIX").value, r))?;
}
return Ok(());
}
// Handle variable assignments.
if let Some((k, v)) = line.split_once('=') {
if let Err(e) = self.vars.set(
k,
&expand(v.trim_start(), &self.vars)
.map_err(|e| MakeError::new(e, self.context.clone()))?,
false,
) {
return Err(MakeError::new(e, self.context.clone()));
};
return Ok(());
}
// Otherwise, throw error if line is not recognizable.
Err(MakeError::new("Invalid line type.", self.context.clone()))
}
/// Principal interface for executing a parsed makefile, given a list of targets.
pub fn execute(&self, mut targets: Vec<String>) -> Result<(), MakeError> {
// Set targets list to default target if none were provided.
if targets.is_empty() {
match &self.default_target {
None => {
return Err(MakeError::new(
"No target specified and no default target found.",
Context::new(),
))
}
Some(t) => targets.push(t.clone()),
}
}
for target in targets {
self.rule_map.execute(self, &target)?;
}
Ok(())
}
/// Get the `mtime` of a file. Note that the return value also signals whether or not the file
/// is accessible, so a `None` value represents either the file not existing or the current user
/// not having the appropriate permissions to access the file.
///
/// TODO: Consider bailing on a file permissions issue? Not sure if POSIX specifies some
/// behavior here or if the major implementations halt execution on a permissions error.
fn get_mtime(&self, file: &String) -> Option<SystemTime> {
match fs::metadata(file) {
Ok(metadata) => {
if self.opts.old_file.contains(file) {
Some(UNIX_EPOCH)
} else if self.opts.new_file.contains(file) {
// 1 year in the future.
Some(SystemTime::now() + Duration::from_secs(365 * 24 * 60 * 60))
} else {
metadata.modified().ok()
}
}
Err(_) => None,
}
}
}