makefile::ast(3pm) [debian man page]

Makefile::AST(3pm)					User Contributed Perl Documentation					Makefile::AST(3pm)

NAME

       Makefile::AST - AST for (GNU) makefiles

DESCRIPTION

       The structure of this (GNU) makefile AST is designed based on GNU make's data base listing output produced by "--print-data-base".

       This AST library provides the following classes:

       Makefile::AST
	   The primary class for ASTs. Provides interface for node adding and querying, such as "add_implicit_rule", "apply_implicit_rules",
	   "add_explicit_rule", "apply_explicit_rules", "add_var", "add_auto_var", "get_var", as well as lots of other utility functions, like
	   method "eval_var_value" for computing the ultimate values of makefile variables, method "enter_pad" and "leave_pad" for local
	   variable's scoping pad.

       Makefile::AST::Rule::Base
	   This is the base class for the rule nodes in the AST. It has properties like "normal_prereqs", "order_prereqs", "commands", and
	   "colon".

       Makefile::AST::Rule
	   This class represents the de-sugared form of simple rules and implicite rules after application. It inherits from
	   Makefile::AST::Rule::Base, and adds new properties "target" and "other_targets".

       Makefile::AST::Rule::Implicit
	   This class represents the implicit rule nodes in the AST. It inherits from Makefile::AST::Rule::Base, and adds new properties
	   "targets", "match_anything", and "is_terminal".

       Makefile::AST::StemMatch
	   This class encapsulates the file pattern matching (file names containing "%") and stem substitution algorithms.

       Makefile::AST::Variable
	   It represents the makefile variable nodes in the AST, including "name", "value", "flavor", and "origin".

       Makefile::AST::Command
	   Used to encapsulate information regarding makefile rule commands (e.g. command body, command modifiers "@", "-", "+", and etc.) as a
	   whole.

LIMITATIONS AND TODO

       Adding support for other flavors' makes into this AST library should make a huge amount of sense. The most interesting candiate is
       Microsoft's NMAKE.

CODE REPOSITORY

       For the very latest version of this script, check out the source from

       http://github.com/agentzh/makefile-parser-pm <http://github.com/agentzh/makefile-parser-pm>.

       There is anonymous access to all.

AUTHOR

       Zhang "agentzh" Yichun "<agentzh@gmail.com>"

COPYRIGHT AND LICENSE

       Copyright (c) 2007-2008 by Zhang "agentzh" Yichun (agentzh).

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       Makefile::AST::Evaluator, Makefile::Parser::GmakeDB, makesimple, pgmake-db, Makefile::DOM.

perl v5.12.4							    2011-08-17							Makefile::AST(3pm)

grammar::me_ast(n)					   Grammar operations and usage 					grammar::me_ast(n)

__________________________________________________________________________________________________________________________________________________

NAME

       grammar::me_ast - Various representations of ASTs

DESCRIPTION

       This  document  specifies  various representations for the abstract syntax trees (short AST) generated by instances of ME virtual machines,
       independent of variant.	Please go and read the document grammar::me_intro first if you do not know what a ME virtual machine is.

       ASTs and all the representations we specify distinguish between two types of nodes, namely:

       Terminal
	      Terminal nodes refer to the terminal symbols found in the token stream. They are always leaf nodes. I.e. terminal nodes  never  have
	      children.

       Nonterminal
	      Nonterminal  nodes  represent a nonterminal symbol of the grammar used during parsing. They can occur as leaf and inner nodes of the
	      tree.

       Both types of nodes carry basic range information telling a user which parts of the input are covered by the node by providing the location
       of the first and last tokens found within the range. Locations are provided as non-negative integer offsets from the beginning of the token
       stream, with the first token found in the stream located at offset 0 (zero).

       The root of an AS tree can be either a terminal or nonterminal node.

AST VALUES

       This representation of ASTs is a Tcl list. The main list represents the root node of the tree, with the	representations  of  the  children
       nested within.

       Each  node  is represented by a single Tcl list containing three or more elements. The first element is either the empty string or the name
       of a nonterminal symbol (which is never the empty string). The second and third elements are then the  locations  of  the  first  and  last
       tokens.	 Any  additional elements after the third are then the representations of the children, with the leftmost child first, i.e. as the
       fourth element of the list representing the node.

AST OBJECTS

       In this representation an AST is represented by a Tcl object command whose API is compatible to the tree objects provided  by  the  package
       struct::tree. I.e it has to support at least all of the methods described by that package, and may support more.

       Because of this the remainder of the specifications is written using the terms of struct::tree.

       Each  node  of the AST directly maps to a node in the tree object. All data beyond the child nodes, i.e. node type and input locations, are
       stored in attributes of the node in the tree object. They are:

       type   The type of the AST node. The recognized values are terminal and nonterminal.

       range  The locations of the first and last token of the terminal data in the input covered by the node. This is a list containing two loca-
	      tions.

       detail This attribute is present only for nonterminal nodes. It contains the name of the nonterminal symbol stored in the node.

EXTENDED AST OBJECTS

       Extended AST objects are like AST objects, with additional information.

       detail This  attribute is now present at all nodes. Its contents are unchanged for nonterminal nodes. For terminal nodes it contains a list
	      describing all tokens from the input which are covered by the node.

	      Each element of the list contains the token name, the associated lexeme attribute, line number, and column index, in this order.

       range_lc
	      This new attribute is defined for all nodes, and contains the locations from attribute range translated into line number and  column
	      index. Lines are counted from 1, columns are counted from 0.

BUGS, IDEAS, FEEDBACK
       This  document,	and  the package it describes, will undoubtedly contain bugs and other problems.  Please report such in the category gram-
       mar_me of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883].  Please also report any ideas for enhancements  you  may
       have for either package and/or documentation.

KEYWORDS

       AST, abstract syntax tree

CATEGORY

       Grammars and finite automata

COPYRIGHT

       Copyright (c) 2005 Andreas Kupries <andreas_kupries@users.sourceforge.net>

grammar_me								0.1							grammar::me_ast(n)