yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/leafref/LeafRefPathParserListenerImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  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.data.impl.leafref;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import com.google.common.collect.Lists;
  13 import java.net.URI;
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import org.antlr.v4.runtime.tree.TerminalNode;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.common.QNameModule;
  20 import org.opendaylight.yangtools.yang.common.Revision;
  21 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.IdentifierContext;
  22 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Node_identifierContext;
  23 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Path_argContext;
  24 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Path_equality_exprContext;
  25 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Path_predicateContext;
  26 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.PrefixContext;
  27 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Rel_path_keyexprContext;
  28 import org.opendaylight.yangtools.yang.data.impl.leafref.LeafRefPathParser.Relative_pathContext;
  29 import org.opendaylight.yangtools.yang.model.api.Module;
  30 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  31 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  33
  34 final class LeafRefPathParserListenerImpl extends LeafRefPathParserBaseListener {
  35
  36     private final List<QNameWithPredicateBuilder> leafRefPathQnameList = new ArrayList<>();
  37     private final SchemaContext schemaContext;
  38     private final Module module;
  39     // FIXME: use for identifier path completion
  40     private final SchemaNode node;
  41
  42     private ParsingState currentParsingState = ParsingState.LEAF_REF_PATH;
  43     private List<QNameWithPredicateBuilder> predicatePathKeyQnameList;
  44     private QNameWithPredicateBuilder currentLeafRefPathQName;
  45     private QNamePredicateBuilder currentPredicate;
  46     private QNameModule currentQnameModule;
  47     private String currentQNameLocalName;
  48     private LeafRefPath leafRefPath;
  49     private boolean relativePath = false;
  50
  51     private enum ParsingState {
  52         LEAF_REF_PATH, PATH_PREDICATE, PREDICATE_PATH_EQUALITY_EXPR, PATH_KEY_EXPR
  53     }
  54
  55     LeafRefPathParserListenerImpl(final SchemaContext schemaContext, final Module currentModule,
  56             final SchemaNode currentNode) {
  57         this.schemaContext = schemaContext;
  58         this.module = currentModule;
  59         this.node = currentNode;
  60     }
  61
  62     @Override
  63     public void enterPath_predicate(final Path_predicateContext ctx) {
  64         currentParsingState = ParsingState.PATH_PREDICATE;
  65         currentPredicate = new QNamePredicateBuilder();
  66     }
  67
  68     @Override
  69     public void exitPath_predicate(final Path_predicateContext ctx) {
  70         currentLeafRefPathQName.addQNamePredicate(currentPredicate.build());
  71         currentPredicate = null;
  72         currentParsingState = ParsingState.LEAF_REF_PATH;
  73     }
  74
  75
  76     @Override
  77     public void enterRel_path_keyexpr(final Rel_path_keyexprContext ctx) {
  78         currentParsingState = ParsingState.PATH_KEY_EXPR;
  79
  80         final List<TerminalNode> dots = ctx.DOTS();
  81         predicatePathKeyQnameList = new ArrayList<>(dots.size());
  82         for (int i = 0; i < dots.size(); ++i) {
  83             predicatePathKeyQnameList.add(QNameWithPredicateBuilder.UP_PARENT_BUILDER);
  84         }
  85     }
  86
  87     @Override
  88     public void exitRel_path_keyexpr(final Rel_path_keyexprContext ctx) {
  89         final LeafRefPath pathKeyExpression = LeafRefPath.create(Lists.transform(predicatePathKeyQnameList,
  90             QNameWithPredicateBuilder::build), false);
  91         currentPredicate.setPathKeyExpression(pathKeyExpression);
  92
  93         currentParsingState = ParsingState.PREDICATE_PATH_EQUALITY_EXPR;
  94     }
  95
  96     @Override
  97     public void enterRelative_path(final Relative_pathContext ctx) {
  98         relativePath = true;
  99         final List<TerminalNode> dots = ctx.DOTS();
 100         for (int i = 0; i < dots.size(); ++i) {
 101             leafRefPathQnameList.add(QNameWithPredicateBuilder.UP_PARENT_BUILDER);
 102         }
 103     }
 104
 105     @Override
 106     public void enterPath_equality_expr(final Path_equality_exprContext ctx) {
 107         currentParsingState = ParsingState.PREDICATE_PATH_EQUALITY_EXPR;
 108     }
 109
 110     @Override
 111     public void exitPath_equality_expr(final Path_equality_exprContext ctx) {
 112         currentParsingState = ParsingState.PATH_PREDICATE;
 113     }
 114
 115     @Override
 116     public void enterPrefix(final PrefixContext ctx) {
 117         final String prefix = ctx.getText();
 118         if (!module.getPrefix().equals(prefix)) {
 119             final Optional<QNameModule> qnameModuleOpt = getQNameModuleForImportPrefix(prefix);
 120             checkArgument(qnameModuleOpt.isPresent(), "No module import for prefix: %s in module: %s", prefix,
 121                 module.getName());
 122             currentQnameModule = qnameModuleOpt.get();
 123         } else {
 124             currentQnameModule = module.getQNameModule();
 125         }
 126     }
 127
 128     @Override
 129     public void exitPath_arg(final Path_argContext ctx) {
 130         leafRefPath = LeafRefPath.create(Lists.transform(leafRefPathQnameList, QNameWithPredicateBuilder::build),
 131             !relativePath);
 132     }
 133
 134     @Override
 135     public void enterIdentifier(final IdentifierContext ctx) {
 136         currentQNameLocalName = ctx.getText();
 137     }
 138
 139     @Override
 140     public void exitNode_identifier(final Node_identifierContext ctx) {
 141         if (currentQnameModule == null) {
 142             currentQnameModule = module.getQNameModule();
 143         }
 144
 145         if (currentParsingState == ParsingState.PREDICATE_PATH_EQUALITY_EXPR) {
 146             currentPredicate.setIdentifier(QName.create(currentQnameModule, currentQNameLocalName));
 147         } else {
 148             final QNameWithPredicateBuilder qnameBuilder = new QNameWithPredicateBuilder(currentQnameModule,
 149                 currentQNameLocalName);
 150
 151             if (currentParsingState == ParsingState.PATH_KEY_EXPR) {
 152                 predicatePathKeyQnameList.add(qnameBuilder);
 153             } else if (currentParsingState == ParsingState.LEAF_REF_PATH) {
 154                 currentLeafRefPathQName = qnameBuilder;
 155                 leafRefPathQnameList.add(qnameBuilder);
 156             }
 157         }
 158         currentQnameModule = null;
 159         currentQNameLocalName = null;
 160     }
 161
 162     public LeafRefPath getLeafRefPath() {
 163         return leafRefPath;
 164     }
 165
 166     private URI getNamespaceForImportPrefix(final String prefix) {
 167         final ModuleImport moduleImport = getModuleImport(prefix);
 168         return schemaContext.findModule(moduleImport.getModuleName(), moduleImport.getRevision()).get().getNamespace();
 169     }
 170
 171     private Optional<QNameModule> getQNameModuleForImportPrefix(final String prefix) {
 172         final ModuleImport moduleImport = getModuleImport(prefix);
 173         if (moduleImport == null) {
 174             return Optional.empty();
 175         }
 176
 177         final String moduleName = moduleImport.getModuleName();
 178         final Optional<Revision> revision = moduleImport.getRevision();
 179         return schemaContext.findModule(moduleName, revision).map(Module::getQNameModule);
 180     }
 181
 182     private ModuleImport getModuleImport(final String prefix) {
 183         return module.getImports().stream().filter(imp -> prefix.equals(imp.getPrefix())).findFirst().orElse(null);
 184     }
 185 }