3 * Interfaces for preprocessors
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
27 interface Preprocessor
{
29 * Create a new preprocessor object based on an initialised Parser object
31 * @param $parser Parser
33 function __construct( $parser );
36 * Create a new top-level frame for expansion of a page
43 * Create a new custom frame for programmatic use of parameter replacement as used in some extensions
49 function newCustomFrame( $args );
52 * Create a new custom node for programmatic use of parameter replacement as used in some extensions
56 function newPartNodeArray( $values );
59 * Preprocess text to a PPNode
66 function preprocessToObj( $text, $flags = 0 );
74 const NO_TEMPLATES
= 2;
75 const STRIP_COMMENTS
= 4;
77 const RECOVER_COMMENTS
= 16;
79 const RECOVER_ORIG
= 27; // = 1|2|8|16 no constant expression support in PHP yet
82 * Create a child frame
89 function newChild( $args = false, $title = false );
92 * Expand a document tree node
94 function expand( $root, $flags = 0 );
97 * Implode with flags for expand()
99 function implodeWithFlags( $sep, $flags /*, ... */ );
102 * Implode with no flags specified
104 function implode( $sep /*, ... */ );
107 * Makes an object that, when expand()ed, will be the same as one obtained
110 function virtualImplode( $sep /*, ... */ );
113 * Virtual implode with brackets
115 function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
118 * Returns true if there are no arguments in this frame
125 * Returns all arguments of this frame
127 function getArguments();
130 * Returns all numbered arguments of this frame
132 function getNumberedArguments();
135 * Returns all named arguments of this frame
137 function getNamedArguments();
140 * Get an argument to this frame by name
142 function getArgument( $name );
145 * Returns true if the infinite loop check is OK, false if a loop is detected
151 function loopCheck( $title );
154 * Return true if the frame is a template frame
156 function isTemplate();
159 * Get a title of frame
167 * There are three types of nodes:
168 * * Tree nodes, which have a name and contain other nodes as children
169 * * Array nodes, which also contain other nodes but aren't considered part of a tree
170 * * Leaf nodes, which contain the actual data
172 * This interface provides access to the tree structure and to the contents of array nodes,
173 * but it does not provide access to the internal structure of leaf nodes. Access to leaf
174 * data is provided via two means:
175 * * PPFrame::expand(), which provides expanded text
176 * * The PPNode::split*() functions, which provide metadata about certain types of tree node
181 * Get an array-type node containing the children of this node.
182 * Returns false if this is not a tree node.
184 function getChildren();
187 * Get the first child of a tree node. False if there isn't one.
191 function getFirstChild();
194 * Get the next sibling of any node. False if there isn't one
196 function getNextSibling();
199 * Get all children of this tree node which have a given name.
200 * Returns an array-type node, or false if this is not a tree node.
202 function getChildrenOfType( $type );
206 * Returns the length of the array, or false if this is not an array-type node
208 function getLength();
211 * Returns an item of an array-type node
216 * Get the name of this node. The following names are defined here:
219 * template A double-brace node.
220 * tplarg A triple-brace node.
221 * title The first argument to a template or tplarg node.
222 * part Subsequent arguments to a template or tplarg node.
223 * #nodelist An array-type node
225 * The subclass may define various other names for tree and leaf nodes.
230 * Split a <part> node into an associative array containing:
238 * Split an <ext> node into an associative array containing name, attr, inner and close
239 * All values in the resulting array are PPNodes. Inner and close are optional.
246 function splitHeading();