Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
29.41% covered (danger)
29.41%
5 / 17
CRAP
85.81% covered (warning)
85.81%
127 / 148
CachingStack
0.00% covered (danger)
0.00%
0 / 1
29.41% covered (danger)
29.41%
5 / 17
86.81
85.81% covered (warning)
85.81%
127 / 148
 getScopeTypesToStack
0.00% covered (danger)
0.00%
0 / 1
20
96.77% covered (success)
96.77%
30 / 31
 push
100.00% covered (success)
100.00%
1 / 1
6
100.00% covered (success)
100.00%
18 / 18
 pop
0.00% covered (danger)
0.00%
0 / 1
8.01
94.44% covered (success)
94.44%
17 / 18
 replace
0.00% covered (danger)
0.00%
0 / 1
10.11
89.66% covered (warning)
89.66%
26 / 29
 remove
0.00% covered (danger)
0.00%
0 / 1
4.01
90.91% covered (success)
90.91%
10 / 11
 isInScope
0.00% covered (danger)
0.00%
0 / 1
2.15
66.67% covered (warning)
66.67%
2 / 3
 isElementInScope
0.00% covered (danger)
0.00%
0 / 1
5.03
90.00% covered (success)
90.00%
9 / 10
 isOneOfSetInScope
100.00% covered (success)
100.00%
1 / 1
3
100.00% covered (success)
100.00%
4 / 4
 isInListScope
0.00% covered (danger)
0.00%
0 / 1
2.15
66.67% covered (warning)
66.67%
2 / 3
 isInButtonScope
0.00% covered (danger)
0.00%
0 / 1
2.15
66.67% covered (warning)
66.67%
2 / 3
 isInTableScope
0.00% covered (danger)
0.00%
0 / 1
2.15
66.67% covered (warning)
66.67%
2 / 3
 isInSelectScope
0.00% covered (danger)
0.00%
0 / 1
2.15
66.67% covered (warning)
66.67%
2 / 3
 item
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 length
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 hasTemplate
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 dump
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 6
 scopeDump
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 3
<?php
namespace RemexHtml\TreeBuilder;
use RemexHtml\HTMLData;
/**
 * An implementation of the "stack of open elements" which includes a cache of
 * elements currently in the various kinds of scope. It presumably has good
 * worst-case performance at the expense of somewhat slower updates.
 */
class CachingStack extends Stack {
    private const SCOPE_DEFAULT = 0;
    private const SCOPE_LIST = 1;
    private const SCOPE_BUTTON = 2;
    private const SCOPE_TABLE = 3;
    private const SCOPE_SELECT = 4;
    private static $allScopes = [ self::SCOPE_DEFAULT, self::SCOPE_LIST, self::SCOPE_BUTTON,
        self::SCOPE_TABLE, self::SCOPE_SELECT ];
    private static $nonTableScopes = [ self::SCOPE_DEFAULT, self::SCOPE_LIST, self::SCOPE_BUTTON,
        self::SCOPE_SELECT ];
    private static $listScopes = [ self::SCOPE_LIST, self::SCOPE_SELECT ];
    private static $buttonScopes = [ self::SCOPE_BUTTON, self::SCOPE_SELECT ];
    private static $selectOnly = [ self::SCOPE_SELECT ];
    private static $mathBreakers = [
        'mi' => true,
        'mo' => true,
        'mn' => true,
        'ms' => true,
        'mtext' => true,
        'annotation-xml' => true
    ];
    private static $svgBreakers = [
        'foreignObject' => true,
        'desc' => true,
        'title' => true
    ];
    /**
     * If you compile every predicate of the form "an X element in Y scope" in
     * the HTML 5 spec, you discover that every element name X corresponds to
     * at most one such scope Y. This is useful because it means when we see
     * a new element, we need to add it to at most one scope cache.
     *
     * This is a list of such statements in the spec, and the scope they relate
     * to. All formatting elements are included as SCOPE_DEFAULT since the AAA
     * involves pulling an item out of the AFE list and checking if it is in
     * scope.
     */
    private static $predicateMap = [
        'a' => self::SCOPE_DEFAULT,
        'address' => self::SCOPE_DEFAULT,
        'applet' => self::SCOPE_DEFAULT,
        'article' => self::SCOPE_DEFAULT,
        'aside' => self::SCOPE_DEFAULT,
        'b' => self::SCOPE_DEFAULT,
        'big' => self::SCOPE_DEFAULT,
        'blockquote' => self::SCOPE_DEFAULT,
        'body' => self::SCOPE_DEFAULT,
        'button' => self::SCOPE_DEFAULT,
        'caption' => self::SCOPE_TABLE,
        'center' => self::SCOPE_DEFAULT,
        'code' => self::SCOPE_DEFAULT,
        'dd' => self::SCOPE_DEFAULT,
        'details' => self::SCOPE_DEFAULT,
        'dialog' => self::SCOPE_DEFAULT,
        'dir' => self::SCOPE_DEFAULT,
        'div' => self::SCOPE_DEFAULT,
        'dl' => self::SCOPE_DEFAULT,
        'dt' => self::SCOPE_DEFAULT,
        'em' => self::SCOPE_DEFAULT,
        'fieldset' => self::SCOPE_DEFAULT,
        'figcaption' => self::SCOPE_DEFAULT,
        'figure' => self::SCOPE_DEFAULT,
        'font' => self::SCOPE_DEFAULT,
        'footer' => self::SCOPE_DEFAULT,
        'form' => self::SCOPE_DEFAULT,
        'h1' => self::SCOPE_DEFAULT,
        'h2' => self::SCOPE_DEFAULT,
        'h3' => self::SCOPE_DEFAULT,
        'h4' => self::SCOPE_DEFAULT,
        'h5' => self::SCOPE_DEFAULT,
        'h6' => self::SCOPE_DEFAULT,
        'header' => self::SCOPE_DEFAULT,
        'hgroup' => self::SCOPE_DEFAULT,
        'i' => self::SCOPE_DEFAULT,
        'li' => self::SCOPE_LIST,
        'listing' => self::SCOPE_DEFAULT,
        'main' => self::SCOPE_DEFAULT,
        'marquee' => self::SCOPE_DEFAULT,
        'menu' => self::SCOPE_DEFAULT,
        'nav' => self::SCOPE_DEFAULT,
        'nobr' => self::SCOPE_DEFAULT,
        'object' => self::SCOPE_DEFAULT,
        'ol' => self::SCOPE_DEFAULT,
        'p' => self::SCOPE_BUTTON,
        'pre' => self::SCOPE_DEFAULT,
        'ruby' => self::SCOPE_DEFAULT,
        's' => self::SCOPE_DEFAULT,
        'section' => self::SCOPE_DEFAULT,
        'select' => self::SCOPE_SELECT,
        'small' => self::SCOPE_DEFAULT,
        'strike' => self::SCOPE_DEFAULT,
        'strong' => self::SCOPE_DEFAULT,
        'summary' => self::SCOPE_DEFAULT,
        'table' => self::SCOPE_TABLE,
        'tbody' => self::SCOPE_TABLE,
        'td' => self::SCOPE_TABLE,
        'tfoot' => self::SCOPE_TABLE,
        'th' => self::SCOPE_TABLE,
        'thead' => self::SCOPE_TABLE,
        'tr' => self::SCOPE_TABLE,
        'tt' => self::SCOPE_DEFAULT,
        'u' => self::SCOPE_DEFAULT,
        'ul' => self::SCOPE_DEFAULT,
    ];
    /**
     * The stack of open elements
     */
    private $elements = [];
    /**
     * A cache of the elements which are currently in a given scope.
     * The first key is the scope ID, the second key is the element name, and the
     * value is the first Element in a singly-linked list of Element objects,
     * linked by $element->nextEltInScope.
     *
     * @todo Benchmark time and memory compared to an array stack instead of an
     * SLL. The SLL here is maybe not quite so well justified as some other
     * SLLs in RemexHtml.
     *
     * @var array<int,array<string,Element>>
     */
    private $scopes = [
        self::SCOPE_DEFAULT => [],
        self::SCOPE_LIST => [],
        self::SCOPE_BUTTON => [],
        self::SCOPE_TABLE => [],
        self::SCOPE_SELECT => []
    ];
    /**
     * This is the part of the scope cache which stores scope lists for objects
     * which are not currently in scope. The first key is the scope ID, the
     * second key is the stack index, the third key is the element name,
     * and the value is the Element object.
     *
     * @var array<int,array<int,array<string,Element>>>
     */
    private $scopeStacks = [
        self::SCOPE_DEFAULT => [],
        self::SCOPE_LIST => [],
        self::SCOPE_BUTTON => [],
        self::SCOPE_TABLE => [],
        self::SCOPE_SELECT => []
    ];
    /**
     * The number of <template> elements in the stack of open elements. This
     * speeds up the hot function hasTemplate().
     */
    private $templateCount;
    /**
     * For a given namespace and element name, get the list of scopes
     * for which a new scope should be created and the old one needs to
     * be pushed onto the scope stack.
     *
     * @param string $ns
     * @param string $name
     * @return int[]
     */
    private function getScopeTypesToStack( $ns, $name ) {
        if ( $ns === HTMLData::NS_HTML ) {