2016-10-02 22:30:28 -07:00
#[ cfg(test) ]
mod tests ;
2016-10-23 16:43:52 -07:00
mod app ;
pub use app ::app ;
2016-10-22 23:18:26 -07:00
#[ macro_use ]
extern crate lazy_static ;
2016-10-02 22:30:28 -07:00
extern crate regex ;
2016-10-07 17:56:52 -07:00
extern crate tempdir ;
2016-10-02 22:30:28 -07:00
use std ::io ::prelude ::* ;
2016-10-05 13:58:18 -07:00
use std ::{ fs , fmt , process , io } ;
2016-10-23 23:38:49 -07:00
use std ::collections ::{ BTreeMap , BTreeSet , HashSet } ;
2016-10-02 22:30:28 -07:00
use std ::fmt ::Display ;
use regex ::Regex ;
2016-10-07 17:56:52 -07:00
use std ::os ::unix ::fs ::PermissionsExt ;
2016-10-02 22:30:28 -07:00
macro_rules ! warn {
( $( $arg :tt ) * ) = > { {
extern crate std ;
use std ::io ::prelude ::* ;
let _ = writeln! ( & mut std ::io ::stderr ( ) , $( $arg ) * ) ;
} } ;
}
macro_rules ! die {
( $( $arg :tt ) * ) = > { {
extern crate std ;
warn! ( $( $arg ) * ) ;
std ::process ::exit ( - 1 )
} } ;
}
2016-10-23 16:43:52 -07:00
trait Slurp {
2016-10-02 22:30:28 -07:00
fn slurp ( & mut self ) -> Result < String , std ::io ::Error > ;
}
impl Slurp for fs ::File {
fn slurp ( & mut self ) -> Result < String , std ::io ::Error > {
let mut destination = String ::new ( ) ;
try ! ( self . read_to_string ( & mut destination ) ) ;
Ok ( destination )
}
}
fn re ( pattern : & str ) -> Regex {
Regex ::new ( pattern ) . unwrap ( )
}
2016-10-23 16:43:52 -07:00
#[ derive(PartialEq, Debug) ]
struct Recipe < ' a > {
2016-10-06 17:43:30 -07:00
line_number : usize ,
2016-10-02 22:30:28 -07:00
name : & ' a str ,
2016-10-06 17:43:30 -07:00
lines : Vec < & ' a str > ,
2016-10-23 23:38:49 -07:00
fragments : Vec < Vec < Fragment < ' a > > > ,
variables : BTreeSet < & ' a str > ,
2016-10-09 00:30:33 -07:00
dependencies : Vec < & ' a str > ,
2016-10-23 16:43:52 -07:00
dependency_tokens : Vec < Token < ' a > > ,
arguments : Vec < & ' a str > ,
argument_tokens : Vec < Token < ' a > > ,
2016-10-06 17:43:30 -07:00
shebang : bool ,
2016-10-02 22:30:28 -07:00
}
2016-10-23 23:38:49 -07:00
#[ derive(PartialEq, Debug) ]
2016-10-16 18:59:49 -07:00
enum Fragment < ' a > {
Text { text : & ' a str } ,
Variable { name : & ' a str } ,
}
2016-10-05 13:58:18 -07:00
#[ cfg(unix) ]
2016-10-23 20:39:50 -07:00
fn error_from_signal ( recipe : & str , exit_status : process ::ExitStatus ) -> RunError {
2016-10-05 13:58:18 -07:00
use std ::os ::unix ::process ::ExitStatusExt ;
match exit_status . signal ( ) {
Some ( signal ) = > RunError ::Signal { recipe : recipe , signal : signal } ,
None = > RunError ::UnknownFailure { recipe : recipe } ,
}
}
#[ cfg(windows) ]
2016-10-23 20:39:50 -07:00
fn error_from_signal ( recipe : & str , exit_status : process ::ExitStatus ) -> RunError {
2016-10-05 13:58:18 -07:00
RunError ::UnknownFailure { recipe : recipe }
}
2016-10-03 23:55:55 -07:00
impl < ' a > Recipe < ' a > {
fn run ( & self ) -> Result < ( ) , RunError < ' a > > {
2016-10-07 17:56:52 -07:00
if self . shebang {
let tmp = try ! (
tempdir ::TempDir ::new ( " j " )
. map_err ( | error | RunError ::TmpdirIoError { recipe : self . name , io_error : error } )
) ;
let mut path = tmp . path ( ) . to_path_buf ( ) ;
path . push ( self . name ) ;
{
let mut f = try ! (
fs ::File ::create ( & path )
. map_err ( | error | RunError ::TmpdirIoError { recipe : self . name , io_error : error } )
) ;
let mut text = String ::new ( ) ;
// add the shebang
text + = self . lines [ 0 ] ;
text + = " \n " ;
// add blank lines so that lines in the generated script
// have the same line number as the corresponding lines
// in the justfile
for _ in 1 .. ( self . line_number + 2 ) {
text + = " \n "
}
for line in & self . lines [ 1 .. ] {
text + = line ;
text + = " \n " ;
}
try ! (
f . write_all ( text . as_bytes ( ) )
. map_err ( | error | RunError ::TmpdirIoError { recipe : self . name , io_error : error } )
) ;
2016-10-05 13:58:18 -07:00
}
2016-10-07 17:56:52 -07:00
// get current permissions
let mut perms = try ! (
fs ::metadata ( & path )
. map_err ( | error | RunError ::TmpdirIoError { recipe : self . name , io_error : error } )
) . permissions ( ) ;
// make the script executable
let current_mode = perms . mode ( ) ;
perms . set_mode ( current_mode | 0o100 ) ;
try ! ( fs ::set_permissions ( & path , perms ) . map_err ( | error | RunError ::TmpdirIoError { recipe : self . name , io_error : error } ) ) ;
// run it!
let status = process ::Command ::new ( path ) . status ( ) ;
2016-10-05 13:58:18 -07:00
try ! ( match status {
Ok ( exit_status ) = > if let Some ( code ) = exit_status . code ( ) {
if code = = 0 {
Ok ( ( ) )
} else {
Err ( RunError ::Code { recipe : self . name , code : code } )
}
} else {
Err ( error_from_signal ( self . name , exit_status ) )
} ,
2016-10-07 17:56:52 -07:00
Err ( io_error ) = > Err ( RunError ::TmpdirIoError { recipe : self . name , io_error : io_error } )
2016-10-05 13:58:18 -07:00
} ) ;
2016-10-07 17:56:52 -07:00
} else {
for command in & self . lines {
let mut command = * command ;
2016-10-23 20:39:50 -07:00
if ! command . starts_with ( '@' ) {
2016-10-07 17:56:52 -07:00
warn! ( " {} " , command ) ;
} else {
command = & command [ 1 .. ] ;
}
let status = process ::Command ::new ( " sh " )
. arg ( " -cu " )
. arg ( command )
. status ( ) ;
try ! ( match status {
Ok ( exit_status ) = > if let Some ( code ) = exit_status . code ( ) {
if code = = 0 {
Ok ( ( ) )
} else {
Err ( RunError ::Code { recipe : self . name , code : code } )
}
} else {
Err ( error_from_signal ( self . name , exit_status ) )
} ,
Err ( io_error ) = > Err ( RunError ::IoError { recipe : self . name , io_error : io_error } )
} ) ;
}
2016-10-03 23:55:55 -07:00
}
Ok ( ( ) )
}
}
2016-10-23 16:43:52 -07:00
impl < ' a > Display for Recipe < ' a > {
fn fmt ( & self , f : & mut fmt ::Formatter ) -> Result < ( ) , fmt ::Error > {
try ! ( write! ( f , " {} " , self . name ) ) ;
for argument in & self . arguments {
try ! ( write! ( f , " {} " , argument ) ) ;
}
try ! ( write! ( f , " : " ) ) ;
for dependency in & self . dependencies {
try ! ( write! ( f , " {} " , dependency ) )
}
2016-10-23 23:38:49 -07:00
for ( i , fragments ) in self . fragments . iter ( ) . enumerate ( ) {
2016-10-23 16:43:52 -07:00
if i = = 0 {
try ! ( writeln! ( f , " " ) ) ;
}
2016-10-23 23:38:49 -07:00
for ( j , fragment ) in fragments . iter ( ) . enumerate ( ) {
if j = = 0 {
try ! ( write! ( f , " " ) ) ;
}
match * fragment {
Fragment ::Text { text } = > try ! ( write! ( f , " {} " , text ) ) ,
Fragment ::Variable { name } = > try ! ( write! ( f , " {}{}{} " , " {{ " , name , " }} " ) ) ,
}
}
if i + 1 < self . fragments . len ( ) {
try ! ( write! ( f , " \n " ) ) ;
2016-10-23 16:43:52 -07:00
}
}
Ok ( ( ) )
}
}
2016-10-03 23:55:55 -07:00
fn resolve < ' a > (
recipes : & BTreeMap < & str , Recipe < ' a > > ,
resolved : & mut HashSet < & ' a str > ,
seen : & mut HashSet < & ' a str > ,
stack : & mut Vec < & ' a str > ,
recipe : & Recipe < ' a > ,
) -> Result < ( ) , Error < ' a > > {
if resolved . contains ( recipe . name ) {
return Ok ( ( ) )
}
stack . push ( recipe . name ) ;
seen . insert ( recipe . name ) ;
2016-10-23 16:43:52 -07:00
for dependency_token in & recipe . dependency_tokens {
match recipes . get ( dependency_token . lexeme ) {
2016-10-03 23:55:55 -07:00
Some ( dependency ) = > if ! resolved . contains ( dependency . name ) {
if seen . contains ( dependency . name ) {
let first = stack [ 0 ] ;
stack . push ( first ) ;
2016-10-23 16:43:52 -07:00
return Err ( dependency_token . error ( ErrorKind ::CircularDependency {
recipe : recipe . name ,
2016-10-03 23:55:55 -07:00
circle : stack . iter ( )
. skip_while ( | name | * * name ! = dependency . name )
. cloned ( ) . collect ( )
} ) ) ;
}
2016-10-23 16:43:52 -07:00
return resolve ( recipes , resolved , seen , stack , dependency ) ;
2016-10-03 23:55:55 -07:00
} ,
2016-10-23 16:43:52 -07:00
None = > return Err ( dependency_token . error ( ErrorKind ::UnknownDependency {
recipe : recipe . name ,
unknown : dependency_token . lexeme
2016-10-03 23:55:55 -07:00
} ) ) ,
}
}
resolved . insert ( recipe . name ) ;
stack . pop ( ) ;
Ok ( ( ) )
}
2016-10-22 23:18:26 -07:00
#[ derive(Debug, PartialEq) ]
2016-10-23 16:43:52 -07:00
struct Error < ' a > {
2016-10-22 23:18:26 -07:00
text : & ' a str ,
index : usize ,
line : usize ,
column : usize ,
2016-10-23 16:43:52 -07:00
width : Option < usize > ,
2016-10-22 23:18:26 -07:00
kind : ErrorKind < ' a > ,
2016-10-02 22:30:28 -07:00
}
#[ derive(Debug, PartialEq) ]
enum ErrorKind < ' a > {
2016-10-23 16:43:52 -07:00
BadName { name : & ' a str } ,
CircularDependency { recipe : & ' a str , circle : Vec < & ' a str > } ,
DuplicateDependency { recipe : & ' a str , dependency : & ' a str } ,
DuplicateArgument { recipe : & ' a str , argument : & ' a str } ,
DuplicateRecipe { recipe : & ' a str , first : usize } ,
MixedLeadingWhitespace { whitespace : & ' a str } ,
2016-10-23 23:38:49 -07:00
UnmatchedInterpolationDelimiter { recipe : & ' a str } ,
BadInterpolationVariableName { recipe : & ' a str , text : & ' a str } ,
2016-10-23 16:43:52 -07:00
ExtraLeadingWhitespace ,
2016-10-02 22:30:28 -07:00
InconsistentLeadingWhitespace { expected : & ' a str , found : & ' a str } ,
2016-10-06 17:43:30 -07:00
OuterShebang ,
2016-10-23 16:43:52 -07:00
AssignmentUnimplemented ,
UnknownDependency { recipe : & ' a str , unknown : & ' a str } ,
2016-10-16 18:59:49 -07:00
UnknownStartOfToken ,
2016-10-23 18:46:04 -07:00
UnexpectedToken { expected : Vec < TokenKind > , found : TokenKind } ,
2016-10-22 23:18:26 -07:00
InternalError { message : String } ,
2016-10-02 22:30:28 -07:00
}
fn show_whitespace ( text : & str ) -> String {
text . chars ( ) . map ( | c | match c { '\t' = > 't' , ' ' = > 's' , _ = > c } ) . collect ( )
}
2016-10-23 16:43:52 -07:00
fn mixed_whitespace ( text : & str ) -> bool {
2016-10-02 22:30:28 -07:00
! ( text . chars ( ) . all ( | c | c = = ' ' ) | | text . chars ( ) . all ( | c | c = = '\t' ) )
}
2016-10-23 16:43:52 -07:00
struct Or < ' a , T : ' a + Display > ( & ' a [ T ] ) ;
impl < ' a , T : Display > Display for Or < ' a , T > {
fn fmt ( & self , f : & mut fmt ::Formatter ) -> Result < ( ) , fmt ::Error > {
match self . 0. len ( ) {
0 = > { } ,
1 = > try ! ( write! ( f , " {} " , self . 0 [ 0 ] ) ) ,
2 = > try ! ( write! ( f , " {} or {} " , self . 0 [ 0 ] , self . 0 [ 1 ] ) ) ,
_ = > for ( i , item ) in self . 0. iter ( ) . enumerate ( ) {
try ! ( write! ( f , " {} " , item ) ) ;
if i = = self . 0. len ( ) - 1 {
} else if i = = self . 0. len ( ) - 2 {
try ! ( write! ( f , " , or " ) ) ;
} else {
try ! ( write! ( f , " , " ) )
}
2016-10-02 22:30:28 -07:00
} ,
}
2016-10-23 16:43:52 -07:00
Ok ( ( ) )
2016-10-02 22:30:28 -07:00
}
}
impl < ' a > Display for Error < ' a > {
fn fmt ( & self , f : & mut fmt ::Formatter ) -> Result < ( ) , fmt ::Error > {
try ! ( write! ( f , " justfile:{}: " , self . line ) ) ;
match self . kind {
2016-10-23 16:43:52 -07:00
ErrorKind ::BadName { name } = > {
try ! ( writeln! ( f , " name did not match /[a-z](-?[a-z0-9])*/: {} " , name ) ) ;
}
ErrorKind ::CircularDependency { recipe , ref circle } = > {
try ! ( write! ( f , " recipe {} has circular dependency: {} " , recipe , circle . join ( " -> " ) ) ) ;
return Ok ( ( ) ) ;
}
ErrorKind ::DuplicateArgument { recipe , argument } = > {
try ! ( writeln! ( f , " recipe {} has duplicate argument: {} " , recipe , argument ) ) ;
}
ErrorKind ::UnexpectedToken { ref expected , found } = > {
try ! ( writeln! ( f , " expected {} but found {} " , Or ( expected ) , found ) ) ;
}
ErrorKind ::DuplicateDependency { recipe , dependency } = > {
try ! ( writeln! ( f , " recipe {} has duplicate dependency: {} " , recipe , dependency ) ) ;
}
ErrorKind ::DuplicateRecipe { recipe , first } = > {
try ! ( write! ( f , " duplicate recipe: {} appears on lines {} and {} " ,
recipe , first , self . line ) ) ;
return Ok ( ( ) ) ;
}
ErrorKind ::MixedLeadingWhitespace { whitespace } = > {
try ! ( writeln! ( f ,
" found a mix of tabs and spaces in leading whitespace: {} \n leading whitespace may consist of tabs or spaces, but not both " ,
show_whitespace ( whitespace )
) ) ;
}
ErrorKind ::ExtraLeadingWhitespace = > {
try ! ( writeln! ( f , " recipe line has extra leading whitespace " ) ) ;
}
ErrorKind ::AssignmentUnimplemented = > {
try ! ( writeln! ( f , " variable assignment is not yet implemented " ) ) ;
}
2016-10-02 22:30:28 -07:00
ErrorKind ::InconsistentLeadingWhitespace { expected , found } = > {
try ! ( writeln! ( f ,
2016-10-22 23:18:26 -07:00
" inconsistant leading whitespace: recipe started with \" {} \" but found line with \" {} \" : " ,
2016-10-02 22:30:28 -07:00
show_whitespace ( expected ) , show_whitespace ( found )
) ) ;
}
2016-10-06 17:43:30 -07:00
ErrorKind ::OuterShebang = > {
try ! ( writeln! ( f , " a shebang \" #! \" is reserved syntax outside of recipes " ) )
}
2016-10-23 23:38:49 -07:00
ErrorKind ::UnmatchedInterpolationDelimiter { recipe } = > {
try ! ( writeln! ( f , " recipe {} contains an unmatched {} " , recipe , " {{ " ) )
}
ErrorKind ::BadInterpolationVariableName { recipe , text } = > {
try ! ( writeln! ( f , " recipe {} contains a bad variable interpolation: {} " , recipe , text ) )
}
2016-10-23 16:43:52 -07:00
ErrorKind ::UnknownDependency { recipe , unknown } = > {
try ! ( writeln! ( f , " recipe {} has unknown dependency {} " , recipe , unknown ) ) ;
}
2016-10-16 18:59:49 -07:00
ErrorKind ::UnknownStartOfToken = > {
try ! ( writeln! ( f , " uknown start of token: " ) ) ;
}
2016-10-22 23:18:26 -07:00
ErrorKind ::InternalError { ref message } = > {
try ! ( writeln! ( f , " internal error, this may indicate a bug in j: {} \n consider filing an issue: https://github.com/casey/j/issues/new " , message ) ) ;
}
2016-10-02 22:30:28 -07:00
}
match self . text . lines ( ) . nth ( self . line ) {
Some ( line ) = > try ! ( write! ( f , " {} " , line ) ) ,
2016-10-23 16:43:52 -07:00
None = > if self . index ! = self . text . len ( ) {
try ! ( write! ( f , " internal error: Error has invalid line number: {} " , self . line ) )
} ,
2016-10-07 17:56:52 -07:00
} ;
2016-10-02 22:30:28 -07:00
Ok ( ( ) )
}
}
2016-10-23 16:43:52 -07:00
struct Justfile < ' a > {
2016-10-03 23:55:55 -07:00
recipes : BTreeMap < & ' a str , Recipe < ' a > > ,
2016-10-02 22:30:28 -07:00
}
impl < ' a > Justfile < ' a > {
2016-10-23 16:43:52 -07:00
fn first ( & self ) -> Option < & ' a str > {
2016-10-02 22:30:28 -07:00
let mut first : Option < & Recipe < ' a > > = None ;
2016-10-23 20:39:50 -07:00
for recipe in self . recipes . values ( ) {
2016-10-02 22:30:28 -07:00
if let Some ( first_recipe ) = first {
2016-10-06 17:43:30 -07:00
if recipe . line_number < first_recipe . line_number {
2016-10-02 22:30:28 -07:00
first = Some ( recipe )
}
} else {
first = Some ( recipe ) ;
}
}
first . map ( | recipe | recipe . name )
}
2016-10-23 16:43:52 -07:00
fn count ( & self ) -> usize {
2016-10-03 23:55:55 -07:00
self . recipes . len ( )
}
2016-10-23 16:43:52 -07:00
fn recipes ( & self ) -> Vec < & ' a str > {
2016-10-03 23:55:55 -07:00
self . recipes . keys ( ) . cloned ( ) . collect ( )
}
fn run_recipe ( & self , recipe : & Recipe < ' a > , ran : & mut HashSet < & ' a str > ) -> Result < ( ) , RunError > {
for dependency_name in & recipe . dependencies {
if ! ran . contains ( dependency_name ) {
try ! ( self . run_recipe ( & self . recipes [ dependency_name ] , ran ) ) ;
}
}
try ! ( recipe . run ( ) ) ;
ran . insert ( recipe . name ) ;
Ok ( ( ) )
}
2016-10-23 16:43:52 -07:00
fn run < ' b > ( & ' a self , names : & [ & ' b str ] ) -> Result < ( ) , RunError < ' b > >
2016-10-03 23:55:55 -07:00
where ' a : ' b
{
let mut missing = vec! [ ] ;
for recipe in names {
if ! self . recipes . contains_key ( recipe ) {
missing . push ( * recipe ) ;
2016-10-02 22:30:28 -07:00
}
}
2016-10-23 20:39:50 -07:00
if ! missing . is_empty ( ) {
2016-10-03 23:55:55 -07:00
return Err ( RunError ::UnknownRecipes { recipes : missing } ) ;
}
let recipes = names . iter ( ) . map ( | name | self . recipes . get ( name ) . unwrap ( ) ) . collect ::< Vec < _ > > ( ) ;
let mut ran = HashSet ::new ( ) ;
for recipe in recipes {
try ! ( self . run_recipe ( recipe , & mut ran ) ) ;
}
Ok ( ( ) )
2016-10-02 22:30:28 -07:00
}
2016-10-05 16:03:11 -07:00
2016-10-23 16:43:52 -07:00
fn get ( & self , name : & str ) -> Option < & Recipe < ' a > > {
2016-10-05 16:03:11 -07:00
self . recipes . get ( name )
}
2016-10-03 23:55:55 -07:00
}
2016-10-02 22:30:28 -07:00
2016-10-05 13:58:18 -07:00
#[ derive(Debug) ]
2016-10-23 16:43:52 -07:00
enum RunError < ' a > {
2016-10-03 23:55:55 -07:00
UnknownRecipes { recipes : Vec < & ' a str > } ,
2016-10-05 13:58:18 -07:00
Signal { recipe : & ' a str , signal : i32 } ,
2016-10-03 23:55:55 -07:00
Code { recipe : & ' a str , code : i32 } ,
2016-10-05 13:58:18 -07:00
UnknownFailure { recipe : & ' a str } ,
IoError { recipe : & ' a str , io_error : io ::Error } ,
2016-10-07 17:56:52 -07:00
TmpdirIoError { recipe : & ' a str , io_error : io ::Error } ,
2016-10-03 23:55:55 -07:00
}
impl < ' a > Display for RunError < ' a > {
fn fmt ( & self , f : & mut fmt ::Formatter ) -> Result < ( ) , fmt ::Error > {
2016-10-23 20:39:50 -07:00
match * self {
RunError ::UnknownRecipes { ref recipes } = > {
2016-10-03 23:55:55 -07:00
if recipes . len ( ) = = 1 {
try ! ( write! ( f , " Justfile does not contain recipe: {} " , recipes [ 0 ] ) ) ;
} else {
try ! ( write! ( f , " Justfile does not contain recipes: {} " , recipes . join ( " " ) ) ) ;
} ;
} ,
2016-10-23 20:39:50 -07:00
RunError ::Code { recipe , code } = > {
2016-10-03 23:55:55 -07:00
try ! ( write! ( f , " Recipe \" {} \" failed with code {} " , recipe , code ) ) ;
} ,
2016-10-23 20:39:50 -07:00
RunError ::Signal { recipe , signal } = > {
2016-10-05 13:58:18 -07:00
try ! ( write! ( f , " Recipe \" {} \" wast terminated by signal {} " , recipe , signal ) ) ;
}
2016-10-23 20:39:50 -07:00
RunError ::UnknownFailure { recipe } = > {
2016-10-05 13:58:18 -07:00
try ! ( write! ( f , " Recipe \" {} \" failed for an unknown reason " , recipe ) ) ;
} ,
2016-10-23 20:39:50 -07:00
RunError ::IoError { recipe , ref io_error } = > {
2016-10-05 13:58:18 -07:00
try ! ( match io_error . kind ( ) {
io ::ErrorKind ::NotFound = > write! ( f , " Recipe \" {} \" could not be run because j could not find `sh` the command: \n {} " , recipe , io_error ) ,
io ::ErrorKind ::PermissionDenied = > write! ( f , " Recipe \" {} \" could not be run because j could not run `sh`: \n {} " , recipe , io_error ) ,
_ = > write! ( f , " Recipe \" {} \" could not be run because of an IO error while launching the `sh`: \n {} " , recipe , io_error ) ,
} ) ;
} ,
2016-10-23 20:39:50 -07:00
RunError ::TmpdirIoError { recipe , ref io_error } = >
2016-10-07 17:56:52 -07:00
try ! ( write! ( f , " Recipe \" {} \" could not be run because of an IO error while trying to create a temporary directory or write a file to that directory`: \n {} " , recipe , io_error ) ) ,
2016-10-03 23:55:55 -07:00
}
Ok ( ( ) )
2016-10-02 22:30:28 -07:00
}
}
2016-10-23 16:43:52 -07:00
#[ derive(Debug, PartialEq) ]
2016-10-16 18:59:49 -07:00
struct Token < ' a > {
2016-10-22 23:18:26 -07:00
index : usize ,
2016-10-16 18:59:49 -07:00
line : usize ,
2016-10-22 23:18:26 -07:00
column : usize ,
2016-10-23 16:43:52 -07:00
text : & ' a str ,
2016-10-16 18:59:49 -07:00
prefix : & ' a str ,
lexeme : & ' a str ,
2016-10-23 18:46:04 -07:00
class : TokenKind ,
2016-10-16 18:59:49 -07:00
}
2016-10-22 23:18:26 -07:00
impl < ' a > Token < ' a > {
2016-10-23 16:43:52 -07:00
fn error ( & self , kind : ErrorKind < ' a > ) -> Error < ' a > {
2016-10-22 23:18:26 -07:00
Error {
2016-10-23 16:43:52 -07:00
text : self . text ,
index : self . index + self . prefix . len ( ) ,
2016-10-22 23:18:26 -07:00
line : self . line ,
2016-10-23 16:43:52 -07:00
column : self . column + self . prefix . len ( ) ,
width : Some ( self . lexeme . len ( ) ) ,
2016-10-22 23:18:26 -07:00
kind : kind ,
}
}
}
2016-10-16 18:59:49 -07:00
#[ derive(Debug, PartialEq, Clone, Copy) ]
2016-10-23 18:46:04 -07:00
enum TokenKind {
2016-10-16 18:59:49 -07:00
Name ,
Colon ,
Equals ,
Comment ,
Line ,
Indent ,
Dedent ,
Eol ,
Eof ,
}
2016-10-23 18:46:04 -07:00
impl Display for TokenKind {
2016-10-23 16:43:52 -07:00
fn fmt ( & self , f : & mut fmt ::Formatter ) -> Result < ( ) , fmt ::Error > {
try ! ( write! ( f , " {} " , match * self {
Name = > " name " ,
Colon = > " \" : \" " ,
Equals = > " \" = \" " ,
Comment = > " comment " ,
Line = > " command " ,
Indent = > " indent " ,
Dedent = > " dedent " ,
Eol = > " end of line " ,
Eof = > " end of file " ,
} ) ) ;
Ok ( ( ) )
}
}
2016-10-23 18:46:04 -07:00
use TokenKind ::* ;
2016-10-16 18:59:49 -07:00
fn token ( pattern : & str ) -> Regex {
let mut s = String ::new ( ) ;
s + = r "^(?m)([ \t]*)(" ;
s + = pattern ;
s + = " ) " ;
re ( & s )
}
fn tokenize ( text : & str ) -> Result < Vec < Token > , Error > {
2016-10-22 23:18:26 -07:00
lazy_static! {
2016-10-23 16:43:52 -07:00
static ref EOF : Regex = token ( r "(?-m)$" ) ;
static ref NAME : Regex = token ( r "([a-zA-Z0-9_-]+)" ) ;
static ref COLON : Regex = token ( r ":" ) ;
static ref EQUALS : Regex = token ( r "=" ) ;
static ref COMMENT : Regex = token ( r "#([^!].*)?$" ) ;
static ref EOL : Regex = token ( r "\n|\r\n" ) ;
static ref LINE : Regex = re ( r "^(?m)[ \t]+[^ \t\n\r].*$" ) ;
static ref INDENT : Regex = re ( r "^([ \t]*)[^ \t\n\r]" ) ;
2016-10-16 18:59:49 -07:00
}
fn indentation ( text : & str ) -> Option < & str > {
2016-10-22 23:18:26 -07:00
INDENT . captures ( text ) . map ( | captures | captures . at ( 1 ) . unwrap ( ) )
2016-10-16 18:59:49 -07:00
}
2016-10-22 23:18:26 -07:00
let mut tokens = vec! [ ] ;
let mut rest = text ;
let mut index = 0 ;
let mut line = 0 ;
let mut column = 0 ;
2016-10-16 18:59:49 -07:00
let mut indent : Option < & str > = None ;
2016-10-22 23:18:26 -07:00
macro_rules ! error {
( $kind :expr ) = > { {
Err ( Error {
text : text ,
index : index ,
line : line ,
column : column ,
2016-10-23 16:43:52 -07:00
width : None ,
2016-10-22 23:18:26 -07:00
kind : $kind ,
} )
} } ;
}
2016-10-16 18:59:49 -07:00
loop {
2016-10-22 23:18:26 -07:00
if column = = 0 {
2016-10-16 18:59:49 -07:00
if let Some ( class ) = match ( indent , indentation ( rest ) ) {
2016-10-22 23:18:26 -07:00
// ignore: was no indentation and there still isn't
2016-10-23 20:39:50 -07:00
// or current line is blank
( None , Some ( " " ) ) | ( _ , None ) = > {
2016-10-22 23:18:26 -07:00
None
}
// indent: was no indentation, now there is
2016-10-23 20:39:50 -07:00
( None , Some ( current ) ) = > {
2016-10-23 16:43:52 -07:00
if mixed_whitespace ( current ) {
return error! ( ErrorKind ::MixedLeadingWhitespace { whitespace : current } )
}
2016-10-16 18:59:49 -07:00
indent = Some ( current ) ;
Some ( Indent )
}
2016-10-22 23:18:26 -07:00
// dedent: there was indentation and now there isn't
( Some ( _ ) , Some ( " " ) ) = > {
indent = None ;
Some ( Dedent )
}
// was indentation and still is, check if the new indentation matches
( Some ( previous ) , Some ( current ) ) = > {
2016-10-16 18:59:49 -07:00
if ! current . starts_with ( previous ) {
2016-10-22 23:18:26 -07:00
return error! ( ErrorKind ::InconsistentLeadingWhitespace {
expected : previous ,
found : current
} ) ;
2016-10-16 18:59:49 -07:00
}
None
}
} {
tokens . push ( Token {
2016-10-22 23:18:26 -07:00
index : index ,
2016-10-16 18:59:49 -07:00
line : line ,
2016-10-22 23:18:26 -07:00
column : column ,
2016-10-23 16:43:52 -07:00
text : text ,
2016-10-16 18:59:49 -07:00
prefix : " " ,
lexeme : " " ,
class : class ,
} ) ;
}
}
2016-10-23 16:43:52 -07:00
// insert a dedent if we're indented and we hit the end of the file
if indent . is_some ( ) & & EOF . is_match ( rest ) {
tokens . push ( Token {
index : index ,
line : line ,
column : column ,
text : text ,
prefix : " " ,
lexeme : " " ,
class : Dedent ,
} ) ;
}
2016-10-16 18:59:49 -07:00
let ( prefix , lexeme , class ) =
2016-10-22 23:18:26 -07:00
if let ( 0 , Some ( indent ) , Some ( captures ) ) = ( column , indent , LINE . captures ( rest ) ) {
2016-10-16 18:59:49 -07:00
let line = captures . at ( 0 ) . unwrap ( ) ;
if ! line . starts_with ( indent ) {
2016-10-22 23:18:26 -07:00
return error! ( ErrorKind ::InternalError { message : " unexpected indent " . to_string ( ) } ) ;
2016-10-16 18:59:49 -07:00
}
let ( prefix , lexeme ) = line . split_at ( indent . len ( ) ) ;
( prefix , lexeme , Line )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = NAME . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Name )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = EOL . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Eol )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = EOF . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Eof )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = COLON . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Colon )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = EQUALS . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Equals )
2016-10-22 23:18:26 -07:00
} else if let Some ( captures ) = COMMENT . captures ( rest ) {
2016-10-16 18:59:49 -07:00
( captures . at ( 1 ) . unwrap ( ) , captures . at ( 2 ) . unwrap ( ) , Comment )
} else {
2016-10-22 23:18:26 -07:00
return if rest . starts_with ( " #! " ) {
error! ( ErrorKind ::OuterShebang )
2016-10-16 18:59:49 -07:00
} else {
2016-10-22 23:18:26 -07:00
error! ( ErrorKind ::UnknownStartOfToken )
} ;
2016-10-16 18:59:49 -07:00
} ;
let len = prefix . len ( ) + lexeme . len ( ) ;
tokens . push ( Token {
2016-10-22 23:18:26 -07:00
index : index ,
line : line ,
column : column ,
2016-10-16 18:59:49 -07:00
prefix : prefix ,
2016-10-23 16:43:52 -07:00
text : text ,
2016-10-16 18:59:49 -07:00
lexeme : lexeme ,
class : class ,
} ) ;
match tokens . last ( ) . unwrap ( ) . class {
Eol = > {
line + = 1 ;
2016-10-22 23:18:26 -07:00
column = 0 ;
2016-10-16 18:59:49 -07:00
} ,
Eof = > {
break ;
} ,
_ = > {
2016-10-22 23:18:26 -07:00
column + = len ;
2016-10-16 18:59:49 -07:00
}
}
rest = & rest [ len .. ] ;
2016-10-22 23:18:26 -07:00
index + = len ;
2016-10-16 18:59:49 -07:00
}
Ok ( tokens )
}
2016-10-23 20:39:50 -07:00
fn parse ( text : & str ) -> Result < Justfile , Error > {
2016-10-22 23:18:26 -07:00
let tokens = try ! ( tokenize ( text ) ) ;
2016-10-23 16:43:52 -07:00
let filtered : Vec < _ > = tokens . into_iter ( ) . filter ( | token | token . class ! = Comment ) . collect ( ) ;
if let Some ( token ) = filtered . iter ( ) . find ( | token | {
lazy_static! {
static ref GOOD_NAME : Regex = re ( " ^[a-z](-?[a-z0-9])*$ " ) ;
}
token . class = = Name & & ! GOOD_NAME . is_match ( token . lexeme )
} ) {
return Err ( token . error ( ErrorKind ::BadName { name : token . lexeme } ) ) ;
}
2016-10-22 23:18:26 -07:00
let parser = Parser {
text : text ,
tokens : filtered . into_iter ( ) . peekable ( )
} ;
let justfile = try ! ( parser . file ( ) ) ;
Ok ( justfile )
2016-10-16 18:59:49 -07:00
}
2016-10-22 23:18:26 -07:00
struct Parser < ' a > {
text : & ' a str ,
tokens : std ::iter ::Peekable < std ::vec ::IntoIter < Token < ' a > > >
2016-10-16 18:59:49 -07:00
}
2016-10-22 23:18:26 -07:00
impl < ' a > Parser < ' a > {
2016-10-23 18:46:04 -07:00
fn peek ( & mut self , class : TokenKind ) -> bool {
2016-10-23 16:43:52 -07:00
self . tokens . peek ( ) . unwrap ( ) . class = = class
}
2016-10-23 18:46:04 -07:00
fn accept ( & mut self , class : TokenKind ) -> Option < Token < ' a > > {
2016-10-22 23:18:26 -07:00
if self . peek ( class ) {
self . tokens . next ( )
2016-10-16 18:59:49 -07:00
} else {
None
}
}
2016-10-23 18:46:04 -07:00
fn accepted ( & mut self , class : TokenKind ) -> bool {
2016-10-16 18:59:49 -07:00
self . accept ( class ) . is_some ( )
}
2016-10-23 18:46:04 -07:00
fn expect ( & mut self , class : TokenKind ) -> Option < Token < ' a > > {
2016-10-23 16:43:52 -07:00
if self . peek ( class ) {
self . tokens . next ( ) ;
None
} else {
self . tokens . next ( )
}
2016-10-22 23:18:26 -07:00
}
2016-10-23 16:43:52 -07:00
fn expect_eol ( & mut self ) -> Option < Token < ' a > > {
if self . peek ( Eol ) {
self . accept ( Eol ) ;
None
} else if self . peek ( Eof ) {
None
} else {
self . tokens . next ( )
2016-10-16 18:59:49 -07:00
}
}
2016-10-23 16:43:52 -07:00
fn recipe ( & mut self , name : & ' a str , line_number : usize ) -> Result < Recipe < ' a > , Error < ' a > > {
2016-10-16 18:59:49 -07:00
let mut arguments = vec! [ ] ;
2016-10-23 16:43:52 -07:00
let mut argument_tokens = vec! [ ] ;
while let Some ( argument ) = self . accept ( Name ) {
if arguments . contains ( & argument . lexeme ) {
return Err ( argument . error ( ErrorKind ::DuplicateArgument {
recipe : name , argument : argument . lexeme
} ) ) ;
2016-10-16 18:59:49 -07:00
}
2016-10-23 16:43:52 -07:00
arguments . push ( argument . lexeme ) ;
argument_tokens . push ( argument ) ;
2016-10-16 18:59:49 -07:00
}
2016-10-23 16:43:52 -07:00
if let Some ( token ) = self . expect ( Colon ) {
return Err ( self . unexpected_token ( & token , & [ Name , Colon ] ) ) ;
}
2016-10-16 18:59:49 -07:00
let mut dependencies = vec! [ ] ;
2016-10-23 16:43:52 -07:00
let mut dependency_tokens = vec! [ ] ;
while let Some ( dependency ) = self . accept ( Name ) {
if dependencies . contains ( & dependency . lexeme ) {
return Err ( dependency . error ( ErrorKind ::DuplicateDependency {
recipe : name ,
dependency : dependency . lexeme
} ) ) ;
2016-10-16 18:59:49 -07:00
}
2016-10-23 16:43:52 -07:00
dependencies . push ( dependency . lexeme ) ;
dependency_tokens . push ( dependency ) ;
}
if let Some ( token ) = self . expect_eol ( ) {
return Err ( self . unexpected_token ( & token , & [ Name , Eol , Eof ] ) ) ;
2016-10-16 18:59:49 -07:00
}
2016-10-23 16:43:52 -07:00
let mut lines = vec! [ ] ;
2016-10-23 23:38:49 -07:00
let mut line_tokens = vec! [ ] ;
2016-10-23 16:43:52 -07:00
let mut shebang = false ;
if self . accepted ( Indent ) {
while ! self . peek ( Dedent ) {
if let Some ( line ) = self . accept ( Line ) {
2016-10-23 20:39:50 -07:00
if lines . is_empty ( ) {
2016-10-23 16:43:52 -07:00
if line . lexeme . starts_with ( " #! " ) {
shebang = true ;
}
2016-10-23 20:39:50 -07:00
} else if ! shebang & & ( line . lexeme . starts_with ( ' ' ) | | line . lexeme . starts_with ( '\t' ) ) {
2016-10-23 16:43:52 -07:00
return Err ( line . error ( ErrorKind ::ExtraLeadingWhitespace ) ) ;
}
lines . push ( line . lexeme ) ;
2016-10-23 23:38:49 -07:00
line_tokens . push ( line ) ;
2016-10-23 16:43:52 -07:00
if ! self . peek ( Dedent ) {
if let Some ( token ) = self . expect_eol ( ) {
return Err ( self . unexpected_token ( & token , & [ Eol ] ) ) ;
}
}
} else if let Some ( _ ) = self . accept ( Eol ) {
} else {
let token = self . tokens . next ( ) . unwrap ( ) ;
return Err ( self . unexpected_token ( & token , & [ Line , Eol ] ) ) ;
}
}
if let Some ( token ) = self . expect ( Dedent ) {
return Err ( self . unexpected_token ( & token , & [ Dedent ] ) ) ;
}
}
2016-10-16 18:59:49 -07:00
2016-10-23 23:38:49 -07:00
let mut fragments = vec! [ ] ;
let mut variables = BTreeSet ::new ( ) ;
lazy_static! {
static ref FRAGMENT : Regex = re ( r "^(.*?)\{\{(.*?)\}\}" ) ;
static ref UNMATCHED : Regex = re ( r "^.*?\{\{" ) ;
static ref VARIABLE : Regex = re ( r "^[ \t]*([a-z](-?[a-z0-9])*)[ \t]*$" ) ;
}
for line in & line_tokens {
let mut line_fragments = vec! [ ] ;
let mut rest = line . lexeme ;
while ! rest . is_empty ( ) {
if let Some ( captures ) = FRAGMENT . captures ( rest ) {
let prefix = captures . at ( 1 ) . unwrap ( ) ;
if ! prefix . is_empty ( ) {
line_fragments . push ( Fragment ::Text { text : prefix } ) ;
}
let interior = captures . at ( 2 ) . unwrap ( ) ;
if let Some ( captures ) = VARIABLE . captures ( interior ) {
let name = captures . at ( 1 ) . unwrap ( ) ;
line_fragments . push ( Fragment ::Variable { name : name } ) ;
variables . insert ( name ) ;
} else {
return Err ( line . error ( ErrorKind ::BadInterpolationVariableName {
recipe : name ,
text : interior ,
} ) ) ;
}
rest = & rest [ captures . at ( 0 ) . unwrap ( ) . len ( ) .. ] ;
} else if UNMATCHED . is_match ( rest ) {
return Err ( line . error ( ErrorKind ::UnmatchedInterpolationDelimiter { recipe : name } ) ) ;
} else {
line_fragments . push ( Fragment ::Text { text : rest } ) ;
rest = " " ;
}
}
fragments . push ( line_fragments ) ;
}
2016-10-23 16:43:52 -07:00
Ok ( Recipe {
line_number : line_number ,
name : name ,
dependencies : dependencies ,
dependency_tokens : dependency_tokens ,
arguments : arguments ,
argument_tokens : argument_tokens ,
2016-10-23 23:38:49 -07:00
fragments : fragments ,
variables : variables ,
2016-10-23 16:43:52 -07:00
lines : lines ,
shebang : shebang ,
} )
2016-10-16 18:59:49 -07:00
}
2016-10-22 23:18:26 -07:00
2016-10-23 18:46:04 -07:00
fn unexpected_token ( & self , found : & Token < ' a > , expected : & [ TokenKind ] ) -> Error < ' a > {
2016-10-23 16:43:52 -07:00
found . error ( ErrorKind ::UnexpectedToken {
expected : expected . to_vec ( ) ,
found : found . class ,
} )
2016-10-22 23:18:26 -07:00
}
2016-10-16 18:59:49 -07:00
2016-10-22 23:18:26 -07:00
fn file ( mut self ) -> Result < Justfile < ' a > , Error < ' a > > {
2016-10-23 16:43:52 -07:00
let mut recipes = BTreeMap ::< & str , Recipe > ::new ( ) ;
2016-10-22 23:18:26 -07:00
loop {
match self . tokens . next ( ) {
Some ( token ) = > match token . class {
Eof = > break ,
Eol = > continue ,
2016-10-23 16:43:52 -07:00
Name = > if let Some ( equals ) = self . accept ( Equals ) {
return Err ( equals . error ( ErrorKind ::AssignmentUnimplemented ) ) ;
} else {
if let Some ( recipe ) = recipes . remove ( token . lexeme ) {
return Err ( token . error ( ErrorKind ::DuplicateRecipe {
recipe : recipe . name ,
first : recipe . line_number
} ) ) ;
}
recipes . insert ( token . lexeme , try ! ( self . recipe ( token . lexeme , token . line ) ) ) ;
} ,
Comment = > return Err ( token . error ( ErrorKind ::InternalError {
message : " found comment in token stream " . to_string ( )
} ) ) ,
_ = > return Err ( token . error ( ErrorKind ::InternalError {
2016-10-22 23:18:26 -07:00
message : format ! ( " unhandled token class: {:?} " , token . class )
} ) ) ,
} ,
None = > return Err ( Error {
text : self . text ,
index : 0 ,
line : 0 ,
column : 0 ,
2016-10-23 16:43:52 -07:00
width : None ,
2016-10-22 23:18:26 -07:00
kind : ErrorKind ::InternalError {
message : " unexpected end of token stream " . to_string ( )
}
} ) ,
}
}
2016-10-16 18:59:49 -07:00
2016-10-23 16:43:52 -07:00
if let Some ( token ) = self . tokens . next ( ) {
return Err ( token . error ( ErrorKind ::InternalError {
2016-10-22 23:18:26 -07:00
message : format ! ( " unexpected token remaining after parsing completed: {:?} " , token . class )
} ) )
2016-10-06 17:43:30 -07:00
}
2016-10-23 16:43:52 -07:00
let mut resolved = HashSet ::new ( ) ;
let mut seen = HashSet ::new ( ) ;
let mut stack = vec! [ ] ;
for recipe in recipes . values ( ) {
try ! ( resolve ( & recipes , & mut resolved , & mut seen , & mut stack , & recipe ) ) ;
}
2016-10-22 23:18:26 -07:00
Ok ( Justfile { recipes : recipes } )
2016-10-02 22:30:28 -07:00
}
}