.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Makefile::AST::Evaluator 3pm" .TH Makefile::AST::Evaluator 3pm "2011-08-17" "perl v5.12.4" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Makefile::AST::Evaluator \- Evaluator and runtime for Makefile::AST instances .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Makefile::AST::Evaluator; \& \& $Makefile::AST::Evaluator::JustPrint = 0; \& $Makefile::AST::Evaluator::Quiet = 1; \& $Makefile::AST::Evaluator::IgnoreErrors = 1; \& $Makefile::AST::Evaluator::AlwaysMake = 1; \& $Makefile::AST::Evaluator::Question = 1; \& \& # $ast is a Makefile::AST instance: \& my $eval = Makefile::AST::Evaluator\->new($ast); \& \& Makefile::AST::Evaluator\->add_trigger( \& firing_rule => sub { \& my ($self, $rule, $ast_cmds) = @_; \& my $target = $rule\->target; \& my $colon = $rule\->colon; \& my @normal_prereqs = @{ $rule\->normal_prereqs }; \& # ... \& } \& ); \& $eval\->set_required_target($user_makefile) \& $eval\->make($goal); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module implementes an evaluator or a runtime for makefile ASTs represented by Makefile::AST instances. .PP It \*(L"executes\*(R" the specified \s-1GNU\s0 make \s-1AST\s0 by the \s-1GNU\s0 makefile semantics. Note that, \*(L"execution\*(R" not necessarily mean building a project tree by firing makefile rule commands. Actually you can defining your own triggers by calling the add_trigger method. (See the \*(L"\s-1SYNOPSIS\s0\*(R" for examples.) In other words, you can do more interesting things like plotting the call path tree of a Makefile using Graphviz, or translating the original makefile to another form (like what the makesimple script does). .PP It's worth mentioning that, most of the construction algorithm for topological graph s (including implicit rule application) have already been implemented in Makefile::AST and its child node classes. .SH "CONFIGURE VARIABLES" .IX Header "CONFIGURE VARIABLES" This module provides several package variables (i.e. static class variables) for controlling the behavior of the evaluator. .PP Particularly the user needs to set the \f(CW$AlwaysMake\fR variable to true and \f(CW$Question\fR to true, if she wants to use the evaluator to do special tasks like plotting dependency graphs and translating \s-1GNU\s0 makefiles to other format. .PP Setting \f(CW$AlwaysMake\fR to true will force the evaluator to ignore the timestamps of external files appeared in the makefiles while setting \f(CW$Question\fR to true will prevent the evaluator from executing the shell commands specified in the makefile rules. .PP Here's the detailed listing for all the config variables: .ie n .IP "$Question" 4 .el .IP "\f(CW$Question\fR" 4 .IX Item "$Question" This variable corresponds to the command-line option \f(CW\*(C`\-q\*(C'\fR or <\-\-question> in \s-1GNU\s0 make. Its purpose is to make the evaluator enter the \*(L"questioning mode\*(R", i.e., a mode in which \f(CW\*(C`make\*(C'\fR will never try executing rule commands unless it has to, \f(CW\*(C`and\*(C'\fR echoing is suppressed at the same time. .ie n .IP "$AlwaysMake" 4 .el .IP "\f(CW$AlwaysMake\fR" 4 .IX Item "$AlwaysMake" This variable corresponds to the command-line option \f(CW\*(C`\-B\*(C'\fR or \f(CW\*(C`\-\-always\-make\*(C'\fR. It forces re-constructing all the rule's targets related to the goal, ignoring the timestamp or existence of targets' dependencies. .ie n .IP "$Quiet" 4 .el .IP "\f(CW$Quiet\fR" 4 .IX Item "$Quiet" It corresponds to \s-1GNU\s0 make's command-line option \f(CW\*(C`\-s\*(C'\fR, \f(CW\*(C`\-\-silent\*(C'\fR, or \f(CW\*(C`\-\-quiet\*(C'\fR. Its effect is to cancel the echoing of shell commands being executed. .ie n .IP "$JustPrint" 4 .el .IP "\f(CW$JustPrint\fR" 4 .IX Item "$JustPrint" This variable corresponds to \s-1GNU\s0 make's command line option \f(CW\*(C`\-n\*(C'\fR, \f(CW\*(C`\-\-just\-print\*(C'\fR, \f(CW\*(C`\-\-dry\-run\*(C'\fR, or \f(CW\*(C`\-\-recon\*(C'\fR. Its effect is to print out the shell commands requiring execution but without actually executing them. .ie n .IP "$IgnoreErrors" 4 .el .IP "\f(CW$IgnoreErrors\fR" 4 .IX Item "$IgnoreErrors" This variable corresponds to \s-1GNU\s0 make's command line option \f(CW\*(C`\-i\*(C'\fR or \f(CW\*(C`\-\-ignore\-errors\*(C'\fRi\*:XXIt's used to ignore the errors of shell commands being executed during the make process. The default behavior is quitting as soon as a shell command without the \f(CW\*(C`\-\*(C'\fR modifier fails. .SH "CLASS TRIGGERS" .IX Header "CLASS TRIGGERS" The \f(CW\*(C`make_by_rule\*(C'\fR method of this class defines a trigger named \f(CW\*(C`firing_rule\*(C'\fR via the Class::Trait module. Everytime the \f(CW\*(C`make_by_rule\*(C'\fR method reaches the trigger point, it will invoke the user's processing handler with the following three arguments: the self object, the Makefile::AST::Rule object, and the corresponding \f(CW\*(C`Makefile::AST::Command\*(C'\fR object in the context. .PP By registering his own processing handlers for the \f(CW\*(C`firing_rule\*(C'\fR trigger, the user's code can reuse the evaluator to do his own cool things without traversing the makefile ASTs himself. .PP See the \*(L"\s-1SYNOPSIS\s0\*(R" for code examples. .SH "CODE REPOSITORY" .IX Header "CODE REPOSITORY" For the very latest version of this script, check out the source from .PP http://github.com/agentzh/makefile\-parser\-pm . .PP There is anonymous access to all. .SH "AUTHOR" .IX Header "AUTHOR" Zhang \*(L"agentzh\*(R" Yichun \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (c) 2007\-2008 by Zhang \*(L"agentzh\*(R" Yichun (agentzh). .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" Makefile::AST, Makefile::Parser::GmakeDB, pgmake-db, makesimple, Makefile::DOM.