parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/KeyStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.parser.rfc7950.stmt.meta;
   9
  10 import com.google.common.base.CharMatcher;
  11 import com.google.common.base.Splitter;
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import com.google.common.collect.ImmutableSet.Builder;
  15 import java.util.Set;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.common.QNameModule;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  20 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
  24 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  27 import org.opendaylight.yangtools.yang.parser.antlr.YangStatementLexer;
  28 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  36
  37 public final class KeyStatementSupport
  38         extends AbstractStatementSupport<Set<QName>, KeyStatement, KeyEffectiveStatement> {
  39     /**
  40      * This is equivalent to {@link YangStatementLexer#SEP}'s definition. Currently equivalent to the non-repeating
  41      * part of:
  42      *
  43      * <p>
  44      * {@code SEP: [ \n\r\t]+ -> type(SEP);}.
  45      */
  46     private static final CharMatcher SEP = CharMatcher.anyOf(" \n\r\t").precomputed();
  47
  48     /**
  49      * Splitter corresponding to {@code key-arg} ABNF as defined
  50      * in <a href="https://tools.ietf.org/html/rfc6020#section-12">RFC6020, section 12</a>:
  51      *
  52      * <p>
  53      * {@code key-arg             = node-identifier *(sep node-identifier)}
  54      *
  55      * <p>
  56      * We also account for {@link #SEP} not handling repetition by ignoring empty strings.
  57      */
  58     private static final Splitter KEY_ARG_SPLITTER = Splitter.on(SEP).omitEmptyStrings();
  59
  60     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  61         SubstatementValidator.builder(YangStmtMapping.KEY).build();
  62
  63     public KeyStatementSupport(final YangParserConfiguration config) {
  64         super(YangStmtMapping.KEY, StatementPolicy.copyDeclared(
  65             // Identity comparison is sufficient because adaptArgumentValue() is careful about reuse.
  66             (copy, current, substatements) -> copy.getArgument() == current.getArgument()),
  67             config, SUBSTATEMENT_VALIDATOR);
  68     }
  69
  70     @Override
  71     public ImmutableSet<QName> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  72         final Builder<QName> builder = ImmutableSet.builder();
  73         int tokens = 0;
  74         for (String keyToken : KEY_ARG_SPLITTER.split(value)) {
  75             builder.add(StmtContextUtils.parseNodeIdentifier(ctx, keyToken));
  76             tokens++;
  77         }
  78
  79         // Throws NPE on nulls, retains first inserted value, cannot be modified
  80         final ImmutableSet<QName> ret = builder.build();
  81         SourceException.throwIf(ret.size() != tokens, ctx, "Key argument '%s' contains duplicates", value);
  82         return ret;
  83     }
  84
  85     @Override
  86     public Set<QName> adaptArgumentValue(final StmtContext<Set<QName>, KeyStatement, KeyEffectiveStatement> ctx,
  87             final QNameModule targetModule) {
  88         final Builder<QName> builder = ImmutableSet.builder();
  89         boolean replaced = false;
  90         for (final QName qname : ctx.getArgument()) {
  91             if (!targetModule.equals(qname.getModule())) {
  92                 final QName newQname = qname.bindTo(targetModule).intern();
  93                 builder.add(newQname);
  94                 replaced = true;
  95             } else {
  96                 builder.add(qname);
  97             }
  98         }
  99
 100         // This makes sure we reuse the collection when a grouping is instantiated in the same module.
 101         return replaced ? builder.build() : ctx.argument();
 102     }
 103
 104     @Override
 105     protected KeyStatement createDeclared(final BoundStmtCtx<Set<QName>> ctx,
 106             final ImmutableList<DeclaredStatement<?>> substatements) {
 107         return DeclaredStatements.createKey(ctx.getRawArgument(), ctx.getArgument(), substatements);
 108     }
 109
 110     @Override
 111     protected KeyStatement attachDeclarationReference(final KeyStatement stmt, final DeclarationReference reference) {
 112         return DeclaredStatementDecorators.decorateKey(stmt, reference);
 113     }
 114
 115     @Override
 116     protected KeyEffectiveStatement createEffective(final Current<Set<QName>, KeyStatement> stmt,
 117             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 118         return EffectiveStatements.createKey(stmt.declared(), stmt.getArgument(), substatements);
 119     }
 120 }