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