xpath/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.verifyTerminal;
  14 import static org.opendaylight.yangtools.yang.xpath.impl.ParseTreeUtils.verifyToken;
  15
  16 import com.google.common.base.VerifyException;
  17 import com.google.common.collect.ImmutableSet;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import javax.xml.xpath.XPathExpressionException;
  21 import org.antlr.v4.runtime.CharStreams;
  22 import org.antlr.v4.runtime.CommonTokenStream;
  23 import org.opendaylight.yangtools.yang.common.UnresolvedQName;
  24 import org.opendaylight.yangtools.yang.common.YangNamespaceContext;
  25 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierLexer;
  26 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser;
  27 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.EqQuotedStringContext;
  28 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.KeyPredicateContext;
  29 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.KeyPredicateExprContext;
  30 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.LeafListPredicateContext;
  31 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.LeafListPredicateExprContext;
  32 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.NodeIdentifierContext;
  33 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.PathArgumentContext;
  34 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.PosContext;
  35 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.PredicateContext;
  36 import org.opendaylight.yangtools.yang.xpath.antlr.instanceIdentifierParser.QuotedStringContext;
  37 import org.opendaylight.yangtools.yang.xpath.api.YangBinaryOperator;
  38 import org.opendaylight.yangtools.yang.xpath.api.YangExpr;
  39 import org.opendaylight.yangtools.yang.xpath.api.YangLiteralExpr;
  40 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath;
  41 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Absolute;
  42 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.QNameStep;
  43 import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Step;
  44 import org.opendaylight.yangtools.yang.xpath.api.YangQNameExpr;
  45 import org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis;
  46 import org.opendaylight.yangtools.yang.xpath.api.YangXPathMathMode;
  47 import org.opendaylight.yangtools.yang.xpath.api.YangXPathMathSupport;
  48
  49 abstract class InstanceIdentifierParser {
  50     static final class Base extends InstanceIdentifierParser {
  51         Base(final YangXPathMathMode mathMode) {
  52             super(mathMode);
  53         }
  54
  55         @Override
  56         YangQNameExpr createExpr(final String prefix, final String localName) {
  57             return YangQNameExpr.of(UnresolvedQName.Qualified.of(prefix, localName));
  58         }
  59
  60         @Override
  61         QNameStep createChildStep(final String prefix, final String localName, final Collection<YangExpr> predicates) {
  62             return YangXPathAxis.CHILD.asStep(UnresolvedQName.Qualified.of(prefix, localName), predicates);
  63         }
  64     }
  65
  66     static final class Qualified extends InstanceIdentifierParser {
  67         final YangNamespaceContext namespaceContext;
  68
  69         Qualified(final YangXPathMathMode mathMode, final YangNamespaceContext namespaceContext) {
  70             super(mathMode);
  71             this.namespaceContext = requireNonNull(namespaceContext);
  72         }
  73
  74         @Override
  75         QNameStep createChildStep(final String prefix, final String localName, final Collection<YangExpr> predicates) {
  76             return YangXPathAxis.CHILD.asStep(namespaceContext.createQName(prefix, localName), predicates);
  77         }
  78
  79
  80         @Override
  81         YangQNameExpr createExpr(final String prefix, final String localName) {
  82             return YangQNameExpr.of(namespaceContext.createQName(prefix, localName));
  83         }
  84
  85     }
  86
  87     private final YangXPathMathSupport mathSupport;
  88
  89     InstanceIdentifierParser(final YangXPathMathMode mathMode) {
  90         mathSupport = mathMode.getSupport();
  91     }
  92
  93     final Absolute interpretAsInstanceIdentifier(final YangLiteralExpr expr) throws XPathExpressionException {
  94         final var lexer = new instanceIdentifierLexer(CharStreams.fromString(expr.getLiteral()));
  95         final var parser = new instanceIdentifierParser(new CommonTokenStream(lexer));
  96         final var listener = new CapturingErrorListener();
  97         lexer.removeErrorListeners();
  98         lexer.addErrorListener(listener);
  99         parser.removeErrorListeners();
 100         parser.addErrorListener(listener);
 101
 102         final var id = parser.instanceIdentifier();
 103         listener.reportError();
 104
 105         final int length = id.getChildCount();
 106         final var steps = new ArrayList<Step>(length / 2);
 107         for (int i = 1; i < length; i += 2) {
 108             steps.add(parsePathArgument(getChild(id, PathArgumentContext.class, i)));
 109         }
 110
 111         return YangLocationPath.absolute(steps);
 112     }
 113
 114     abstract YangQNameExpr createExpr(String prefix, String localName);
 115
 116     abstract QNameStep createChildStep(String prefix, String localName, Collection<YangExpr> predicates);
 117
 118     private QNameStep parsePathArgument(final PathArgumentContext expr) {
 119         final NodeIdentifierContext childExpr = getChild(expr, NodeIdentifierContext.class, 0);
 120         final String prefix = verifyIdentifier(childExpr, 0);
 121         final String localName = verifyIdentifier(childExpr, 2);
 122
 123         return switch (expr.getChildCount()) {
 124             case 1 -> createChildStep(prefix, localName, ImmutableSet.of());
 125             case 2 -> createChildStep(prefix, localName, parsePredicate(getChild(expr, PredicateContext.class, 1)));
 126             default -> throw illegalShape(expr);
 127         };
 128     }
 129
 130     private Collection<YangExpr> parsePredicate(final PredicateContext expr) {
 131         final var first = expr.getChild(0);
 132         if (first instanceof LeafListPredicateContext llp) {
 133             return ImmutableSet.of(YangBinaryOperator.EQUALS.exprWith(YangLocationPath.self(),
 134                 parseEqStringValue(getChild(llp.getChild(LeafListPredicateExprContext.class, 0),
 135                     EqQuotedStringContext.class, 1))));
 136         } else if (first instanceof PosContext pc) {
 137             return ImmutableSet.of(YangBinaryOperator.EQUALS.exprWith(FunctionSupport.POSITION,
 138                 mathSupport.createNumber(pc.getToken(instanceIdentifierParser.PositiveIntegerValue, 0).getText())));
 139         }
 140
 141         final int length = expr.getChildCount();
 142         final var ret = new ArrayList<YangExpr>(length);
 143         for (int i = 0; i < length; ++i) {
 144             final var pred = getChild(expr, KeyPredicateContext.class, i).getChild(KeyPredicateExprContext.class, 0);
 145             ret.add(YangBinaryOperator.EQUALS.exprWith(
 146                 createChildExpr(getChild(pred, NodeIdentifierContext.class, 0)),
 147                 parseEqStringValue(getChild(pred, EqQuotedStringContext.class, 1))));
 148         }
 149
 150         return ret;
 151     }
 152
 153     private YangQNameExpr createChildExpr(final NodeIdentifierContext expr) {
 154         return createExpr(verifyIdentifier(expr, 0), verifyIdentifier(expr, 2));
 155     }
 156
 157     private static String verifyIdentifier(final NodeIdentifierContext expr, final int child) {
 158         return verifyToken(expr, child, instanceIdentifierParser.Identifier).getText();
 159     }
 160
 161     private static YangLiteralExpr parseEqStringValue(final EqQuotedStringContext expr) {
 162         final var quotedString = getChild(expr, QuotedStringContext.class, expr.getChildCount() - 1);
 163         return switch (quotedString.getChildCount()) {
 164             case 1 -> YangLiteralExpr.empty();
 165             case 2 -> {
 166                 final var terminal = verifyTerminal(quotedString.getChild(0));
 167                 final var token = terminal.getSymbol();
 168                 final var literal = switch (token.getType()) {
 169                     case instanceIdentifierParser.DQUOT_STRING -> unescape(token.getText());
 170                     case instanceIdentifierParser.SQUOT_STRING -> token.getText();
 171                     default -> throw illegalShape(terminal);
 172                 };
 173                 yield YangLiteralExpr.of(literal);
 174             }
 175             default -> throw illegalShape(quotedString);
 176         };
 177     }
 178
 179     private static String unescape(final String escaped) {
 180         final int firstEscape = escaped.indexOf('\\');
 181         return firstEscape == -1 ? escaped : unescape(escaped, firstEscape);
 182     }
 183
 184     private static String unescape(final String escaped, final int firstEscape) {
 185         // Sizing: optimize allocation for only a single escape
 186         final int length = escaped.length();
 187         final var sb = new StringBuilder(length - 1).append(escaped, 0, firstEscape);
 188
 189         int esc = firstEscape;
 190         while (true) {
 191             final var ch = escaped.charAt(esc + 1);
 192             sb.append(
 193                 switch (ch) {
 194                     case 'n' -> '\n';
 195                     case 't' -> '\t';
 196                     case '"' -> '"';
 197                     case '\\' -> '\\';
 198                     default -> throw new VerifyException("Unexpected escaped char '" + ch + "'");
 199                 });
 200
 201             final int start = esc + 2;
 202             esc = escaped.indexOf('\\', start);
 203             if (esc == -1) {
 204                 return sb.append(escaped, start, length).toString();
 205             }
 206
 207             sb.append(escaped, start, esc);
 208         }
 209     }
 210 }