antlr.v4.runtime.tree.xpath.XPathElement source code

1 /*
2  * [The "BSD license"]
3  *  Copyright (c) 2012 Terence Parr
4  *  Copyright (c) 2012 Sam Harwell
5  *  Copyright (c) 2017 Egbert Voigt
6  *  All rights reserved.
7  *
8  *  Redistribution and use in source and binary forms, with or without
9  *  modification, are permitted provided that the following conditions
10  *  are met:
11  *
12  *  1. Redistributions of source code must retain the above copyright
13  *     notice, this list of conditions and the following disclaimer.
14  *  2. Redistributions in binary form must reproduce the above copyright
15  *     notice, this list of conditions and the following disclaimer in the
16  *     documentation and/or other materials provided with the distribution.
17  *  3. The name of the author may not be used to endorse or promote products
18  *     derived from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  *  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  *  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  *  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 module antlr.v4.runtime.tree.xpath.XPathElement;
33 
34 import std.format;
35 import antlr.v4.runtime.tree.ParseTree;
36 
37 /**
38  * TODO add class description
39  */
40 abstract class XPathElement
41 {
42 
43     protected string nodeName;
44 
45     /**
46      * @uml
47      * @read
48      * @write
49      */
50     public bool invert_;
51 
52     /**
53      * @uml
54      * Construct element like {@code /ID} or {@code ID} or {@code /*} etc...
55      * op is null if just node
56      */
57     public this(string nodeName)
58     {
59         this.nodeName = nodeName;
60     }
61 
62     /**
63      * @uml
64      * Given tree rooted at {@code t} return all nodes matched by this path
65      * element.
66      */
67     abstract public ParseTree[] evaluate(ParseTree t);
68 
69     /**
70      * @uml
71      * @override
72      */
73     public override string toString()
74     {
75         string inv = invert_ ? "!" : "";
76         return format("%1$s[%2$s%3$s]", this.classinfo.name, inv, nodeName);
77     }
78 
79     public final bool invert()
80     {
81         return this.invert_;
82     }
83 
84     public final void invert(bool invert)
85     {
86         this.invert_ = invert;
87     }
88 
89 }