2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
10 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
13 import java.net.URISyntaxException;
14 import java.util.ArrayList;
15 import java.util.Arrays;
16 import java.util.Date;
17 import java.util.Iterator;
18 import java.util.LinkedList;
19 import java.util.List;
21 import javax.annotation.Nullable;
22 import javax.xml.xpath.XPath;
23 import javax.xml.xpath.XPathExpressionException;
24 import javax.xml.xpath.XPathFactory;
26 import org.antlr.v4.runtime.tree.TerminalNode;
27 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.common.QNameModule;
30 import org.opendaylight.yangtools.yang.common.YangConstants;
31 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
32 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
33 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
35 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
37 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
40 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
41 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
42 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
44 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
45 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
46 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
48 import com.google.common.base.CharMatcher;
49 import com.google.common.base.Splitter;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
53 public final class Utils {
55 private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
56 private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
57 private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
59 private static final char SEPARATOR_NODENAME = '/';
61 private static final String REGEX_PATH_ABS = "/[^/].*";
66 public static List<String> splitPathToNodeNames(String path) {
68 Splitter keySplitter = Splitter.on(SEPARATOR_NODENAME).omitEmptyStrings().trimResults();
69 return keySplitter.splitToList(path);
72 public static void validateXPath(String path) {
74 final XPath xPath = XPathFactory.newInstance().newXPath();
78 } catch (XPathExpressionException e) {
79 throw new IllegalArgumentException("Argument is not valid XPath string", e);
83 public static boolean isXPathAbsolute(String path) {
87 return path.matches(REGEX_PATH_ABS);
90 public static QName trimPrefix(QName identifier) {
91 String prefixedLocalName = identifier.getLocalName();
92 String[] namesParts = prefixedLocalName.split(":");
94 if (namesParts.length == 2) {
95 String localName = namesParts[1];
96 return QName.create(identifier.getModule(), localName);
102 public static boolean isValidStatementDefinition(PrefixToModule prefixes, QNameToStatementDefinition stmtDef,
104 if (stmtDef.get(identifier) != null) {
107 String prefixedLocalName = identifier.getLocalName();
108 String[] namesParts = prefixedLocalName.split(":");
110 if (namesParts.length == 2) {
111 String prefix = namesParts[0];
112 String localName = namesParts[1];
113 if (prefixes != null && prefixes.get(prefix) != null
114 && stmtDef.get(new QName(YangConstants.RFC6020_YIN_NAMESPACE, localName)) != null) {
122 public static Iterable<QName> parseXPath(StmtContext<?, ?, ?> ctx, String path) {
126 List<String> nodeNames = splitPathToNodeNames(path);
127 List<QName> qNames = new ArrayList<>();
129 for (String nodeName : nodeNames) {
131 final QName qName = Utils.qNameFromArgument(ctx, nodeName);
133 } catch (Exception e) {
134 throw new IllegalArgumentException(e);
141 public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
142 StringBuilder sb = new StringBuilder();
143 List<TerminalNode> strings = context.STRING();
144 if (strings.isEmpty()) {
145 strings = Arrays.asList(context.IDENTIFIER());
147 for (TerminalNode stringNode : strings) {
148 final String str = stringNode.getText();
149 char firstChar = str.charAt(0);
150 final CharMatcher quoteMatcher;
151 if (SINGLE_QUOTE_MATCHER.matches(firstChar)) {
152 quoteMatcher = SINGLE_QUOTE_MATCHER;
153 } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) {
154 quoteMatcher = DOUBLE_QUOTE_MATCHER;
159 sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1)));
161 return sb.toString();
164 public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, String value) {
167 QNameModule qNameModule = null;
169 qNameModule = QNameModule.create(new URI(""), new Date(0));
170 } catch (URISyntaxException e) {
171 LOG.warn(e.getMessage(), e);
173 String localName = null;
175 String[] namesParts = value.split(":");
176 switch (namesParts.length) {
178 localName = namesParts[0];
180 if (StmtContextUtils.producesDeclared(ctx.getRoot(), ModuleStatement.class)) {
181 prefix = firstAttributeOf(ctx.getRoot().declaredSubstatements(), PrefixStatement.class);
182 qNameModule = ctx.getFromNamespace(PrefixToModule.class, prefix);
184 } else if (StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
185 String belongsToModuleName = firstAttributeOf(ctx.getRoot().declaredSubstatements(),
186 BelongsToStatement.class);
187 qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
191 prefix = namesParts[0];
192 localName = namesParts[1];
194 ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class,
196 qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier);
198 if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
199 String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
200 qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
208 return QName.create(qNameModule, localName);
212 private static StatementContextBase<?, ?, ?> findCtxOfNodeInSubstatements(
213 StatementContextBase<?, ?, ?> rootStmtCtx, final Iterable<QName> path, boolean searchInEffective) {
215 StatementContextBase<?, ?, ?> parent = rootStmtCtx;
217 Iterator<QName> pathIter = path.iterator();
218 QName targetNode = pathIter.next();
220 while (pathIter.hasNext()) {
222 for (StatementContextBase<?, ?, ?> child : searchInEffective ? parent.effectiveSubstatements() : parent
223 .declaredSubstatements()) {
225 if (targetNode.equals(child.getStatementArgument())) {
227 targetNode = pathIter.next();
231 if (parent.equals(rootStmtCtx)) {
237 StatementContextBase<?, ?, ?> targetCtx = null;
239 for (StatementContextBase<?, ?, ?> child : searchInEffective ? parent.effectiveSubstatements() : parent
240 .declaredSubstatements()) {
242 if (targetNode.equals(child.getStatementArgument())) {
251 public static StatementContextBase<?, ?, ?> findCtxOfNodeInRoot(StatementContextBase<?, ?, ?> rootStmtCtx,
252 final SchemaNodeIdentifier node) {
254 System.out.println(node.getPathFromRoot());
256 StatementContextBase<?, ?, ?> targetCtx = findCtxOfNodeInSubstatements(rootStmtCtx, node.getPathFromRoot(),
259 if (targetCtx == null) {
261 targetCtx = findCtxOfNodeInSubstatements(rootStmtCtx, node.getPathFromRoot(), true);
268 public static StatementContextBase<?, ?, ?> findCtxOfNodeInRoot(StatementContextBase<?, ?, ?> rootStmtCtx,
269 final Iterable<QName> path) {
271 StatementContextBase<?, ?, ?> targetCtx = findCtxOfNodeInSubstatements(rootStmtCtx, path, false);
273 if (targetCtx == null) {
275 targetCtx = findCtxOfNodeInSubstatements(rootStmtCtx, path, true);
281 public static SchemaPath getSchemaPath(StmtContext<?, ?, ?> ctx) {
283 Iterator<Object> argumentsIterator = ctx.getArgumentsFromRoot().iterator();
284 argumentsIterator.next(); // skip root argument
286 List<QName> qNamesFromRoot = new LinkedList<>();
288 while (argumentsIterator.hasNext()) {
289 Object argument = argumentsIterator.next();
290 if (argument instanceof QName) {
291 QName qname = (QName) argument;
292 qNamesFromRoot.add(qname);
294 return SchemaPath.SAME;
298 return SchemaPath.create(qNamesFromRoot, true);