Update yang-xpath-api design
[yangtools.git] / yang / yang-xpath-impl / src / main / java / org / opendaylight / yangtools / yang / xpath / impl / InstanceIdentifierParser.java
1 /*
2  * Copyright (c) 2019 Pantheon Technologies, s.r.o.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.yangtools.yang.xpath.impl;
9
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.yangtools.yang.xpath.impl.ParseTreeUtils.getChild;
12 import static org.opendaylight.yangtools.yang.xpath.impl.ParseTreeUtils.illegalShape;
13 import static org.opendaylight.yangtools.yang.xpath.impl.ParseTreeUtils.verifyToken;
14
15 import com.google.common.collect.ImmutableSet;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.List;
19 import javax.xml.xpath.XPathExpressionException;
20 import org.antlr.v4.runtime.CharStreams;
21 import org.antlr.v4.runtime.CommonTokenStream;
22 import org.antlr.v4.runtime.tree.ParseTree;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.common.YangNamespaceContext;
25 import org.opendaylight.yangtools.yang.xpath.api.YangBinaryOperator;
26 import org.opendaylight.yangtools.yang.xpath.api.YangExpr;
27 import org.opendaylight.yangtools.yang.xpath.api.YangLiteralExpr;
28 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath;
29 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Step;
30 import org.opendaylight.yangtools.yang.xpath.api.YangQNameExpr;
31 import org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis;
32 import org.opendaylight.yangtools.yang.xpath.api.YangXPathMathMode;
33 import org.opendaylight.yangtools.yang.xpath.api.YangXPathMathSupport;
34 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.EqQuotedStringContext;
35 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.InstanceIdentifierContext;
36 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.KeyPredicateContext;
37 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.KeyPredicateExprContext;
38 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.LeafListPredicateContext;
39 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.LeafListPredicateExprContext;
40 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.NodeIdentifierContext;
41 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.PathArgumentContext;
42 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.PosContext;
43 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.PredicateContext;
44 import org.opendaylight.yangtools.yang.xpath.impl.instanceIdentifierParser.QuotedStringContext;
45
46 final class InstanceIdentifierParser {
47
48     private final YangNamespaceContext namespaceContext;
49     private final YangXPathMathSupport<?> mathSupport;
50
51     InstanceIdentifierParser(final YangNamespaceContext namespaceContext, final YangXPathMathMode mathMode) {
52         this.namespaceContext = requireNonNull(namespaceContext);
53         this.mathSupport = mathMode.getSupport();
54     }
55
56     YangLocationPath interpretAsInstanceIdentifier(final YangLiteralExpr expr) throws XPathExpressionException {
57         final xpathLexer lexer = new xpathLexer(CharStreams.fromString(expr.getLiteral()));
58         final instanceIdentifierParser parser = new instanceIdentifierParser(new CommonTokenStream(lexer));
59         lexer.removeErrorListeners();
60         parser.removeErrorListeners();
61
62         // FIXME: add listeners
63
64         final InstanceIdentifierContext id = parser.instanceIdentifier();
65         final int length = id.getChildCount();
66         final List<Step> steps = new ArrayList<>(length / 2);
67         for (int i = 1; i < length; i += 2) {
68             steps.add(parsePathArgument(getChild(id, PathArgumentContext.class, i)));
69         }
70
71         return YangLocationPath.of(true, steps);
72     }
73
74     private Step parsePathArgument(final PathArgumentContext expr) {
75         final QName qname = parseQName(getChild(expr, NodeIdentifierContext.class, 0));
76         switch (expr.getChildCount()) {
77             case 1:
78                 return YangXPathAxis.CHILD.asStep(qname, ImmutableSet.of());
79             case 2:
80                 return YangXPathAxis.CHILD.asStep(qname, parsePredicate(getChild(expr, PredicateContext.class, 1)));
81             default:
82                 throw illegalShape(expr);
83         }
84     }
85
86     private Collection<YangExpr> parsePredicate(final PredicateContext expr) {
87         final ParseTree first = expr.getChild(0);
88         if (first instanceof LeafListPredicateContext) {
89             return ImmutableSet.of(YangBinaryOperator.EQUALS.exprWith(YangLocationPath.self(),
90                 parseEqStringValue(getChild(((LeafListPredicateContext) first)
91                     .getChild(LeafListPredicateExprContext.class, 0), EqQuotedStringContext.class, 1))));
92         } else if (first instanceof PosContext) {
93             return ImmutableSet.of(YangBinaryOperator.EQUALS.exprWith(Functions.POSITION, mathSupport.createNumber(
94                 ((PosContext) first).getToken(instanceIdentifierParser.PositiveIntegerValue, 0).getText())));
95         }
96
97         final int length = expr.getChildCount();
98         final List<YangExpr> ret = new ArrayList<>(length);
99         for (int i = 0; i < length; ++i) {
100             final KeyPredicateExprContext pred = getChild(expr, KeyPredicateContext.class, i)
101                     .getChild(KeyPredicateExprContext.class, 0);
102             ret.add(YangBinaryOperator.EQUALS.exprWith(
103                 YangQNameExpr.of(parseQName(getChild(pred, NodeIdentifierContext.class, 0))),
104                 parseEqStringValue(getChild(pred, EqQuotedStringContext.class, 1))));
105
106         }
107
108         return ret;
109     }
110
111     private QName parseQName(final NodeIdentifierContext expr) {
112         return namespaceContext.createQName(
113             verifyToken(expr, 0, instanceIdentifierParser.Identifier).getText(),
114             verifyToken(expr, 2, instanceIdentifierParser.Identifier).getText());
115     }
116
117     private static YangLiteralExpr parseEqStringValue(final EqQuotedStringContext expr) {
118         return YangLiteralExpr.of(verifyToken(getChild(expr, QuotedStringContext.class, expr.getChildCount() - 1), 1,
119             instanceIdentifierParser.STRING).getText());
120     }
121 }