includes/parser/Preprocessor.php

   1 <?php
   2 /**
   3  * Interfaces for preprocessors
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * @ingroup Parser
  26  */
  27 interface Preprocessor {
  28         /**
  29          * Create a new preprocessor object based on an initialised Parser object
  30          *
  31          * @param $parser Parser
  32          */
  33         function __construct( $parser );
  34
  35         /**
  36          * Create a new top-level frame for expansion of a page
  37          *
  38          * @return PPFrame
  39          */
  40         function newFrame();
  41
  42         /**
  43          * Create a new custom frame for programmatic use of parameter replacement as used in some extensions
  44          *
  45          * @param $args array
  46          *
  47          * @return PPFrame
  48          */
  49         function newCustomFrame( $args );
  50
  51         /**
  52          * Create a new custom node for programmatic use of parameter replacement as used in some extensions
  53          *
  54          * @param $values
  55          */
  56         function newPartNodeArray( $values );
  57
  58         /**
  59          * Preprocess text to a PPNode
  60          *
  61          * @param $text
  62          * @param $flags
  63          *
  64          * @return PPNode
  65          */
  66         function preprocessToObj( $text, $flags = 0 );
  67 }
  68
  69 /**
  70  * @ingroup Parser
  71  */
  72 interface PPFrame {
  73         const NO_ARGS = 1;
  74         const NO_TEMPLATES = 2;
  75         const STRIP_COMMENTS = 4;
  76         const NO_IGNORE = 8;
  77         const RECOVER_COMMENTS = 16;
  78
  79         const RECOVER_ORIG = 27; // = 1|2|8|16 no constant expression support in PHP yet
  80
  81         /**
  82          * Create a child frame
  83          *
  84          * @param $args array
  85          * @param $title Title
  86          *
  87          * @return PPFrame
  88          */
  89         function newChild( $args = false, $title = false );
  90
  91         /**
  92          * Expand a document tree node
  93          */
  94         function expand( $root, $flags = 0 );
  95
  96         /**
  97          * Implode with flags for expand()
  98          */
  99         function implodeWithFlags( $sep, $flags /*, ... */ );
 100
 101         /**
 102          * Implode with no flags specified
 103          */
 104         function implode( $sep /*, ... */ );
 105
 106         /**
 107          * Makes an object that, when expand()ed, will be the same as one obtained
 108          * with implode()
 109          */
 110         function virtualImplode( $sep /*, ... */ );
 111
 112         /**
 113          * Virtual implode with brackets
 114          */
 115         function virtualBracketedImplode( $start, $sep, $end /*, ... */ );
 116
 117         /**
 118          * Returns true if there are no arguments in this frame
 119          *
 120          * @return bool
 121          */
 122         function isEmpty();
 123
 124         /**
 125          * Returns all arguments of this frame
 126          */
 127         function getArguments();
 128
 129         /**
 130          * Returns all numbered arguments of this frame
 131          */
 132         function getNumberedArguments();
 133
 134         /**
 135          * Returns all named arguments of this frame
 136          */
 137         function getNamedArguments();
 138
 139         /**
 140          * Get an argument to this frame by name
 141          */
 142         function getArgument( $name );
 143
 144         /**
 145          * Returns true if the infinite loop check is OK, false if a loop is detected
 146          *
 147          * @param $title
 148          *
 149          * @return bool
 150          */
 151         function loopCheck( $title );
 152
 153         /**
 154          * Return true if the frame is a template frame
 155          */
 156         function isTemplate();
 157
 158         /**
 159          * Get a title of frame
 160          *
 161          * @return Title
 162          */
 163         function getTitle();
 164 }
 165
 166 /**
 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
 171  *
 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
 177  * @ingroup Parser
 178  */
 179 interface PPNode {
 180         /**
 181          * Get an array-type node containing the children of this node.
 182          * Returns false if this is not a tree node.
 183          */
 184         function getChildren();
 185
 186         /**
 187          * Get the first child of a tree node. False if there isn't one.
 188          *
 189          * @return PPNode
 190          */
 191         function getFirstChild();
 192
 193         /**
 194          * Get the next sibling of any node. False if there isn't one
 195          */
 196         function getNextSibling();
 197
 198         /**
 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.
 201          */
 202         function getChildrenOfType( $type );
 203
 204
 205         /**
 206          * Returns the length of the array, or false if this is not an array-type node
 207          */
 208         function getLength();
 209
 210         /**
 211          * Returns an item of an array-type node
 212          */
 213         function item( $i );
 214
 215         /**
 216          * Get the name of this node. The following names are defined here:
 217          *
 218          *    h             A heading node.
 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
 224          *
 225          * The subclass may define various other names for tree and leaf nodes.
 226          */
 227         function getName();
 228
 229         /**
 230          * Split a <part> node into an associative array containing:
 231          *    name          PPNode name
 232          *    index         String index
 233          *    value         PPNode value
 234          */
 235         function splitArg();
 236
 237         /**
 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.
 240          */
 241         function splitExt();
 242
 243         /**
 244          * Split an <h> node
 245          */
 246         function splitHeading();
 247 }