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