Use correct key-arg splitting
[yangtools.git] / yang / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / key / KeyStatementSupport.java
index 3c514691c3d4a841e6c41c0e5fcceb9fb4ba7178..27aa30050e60357ea414f7b5e285235c63dcc6bf 100644 (file)
@@ -8,13 +8,13 @@
 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.key;
 
 import static com.google.common.base.Verify.verify;
-import static com.google.common.base.Verify.verifyNotNull;
 
+import com.google.common.base.CharMatcher;
 import com.google.common.base.Splitter;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet.Builder;
-import java.util.Collection;
+import java.util.Set;
 import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.QNameModule;
@@ -23,23 +23,44 @@ import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.KeyStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
+import org.opendaylight.yangtools.yang.parser.antlr.YangStatementLexer;
 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
+import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 
 public final class KeyStatementSupport
-        extends BaseStatementSupport<Collection<SchemaNodeIdentifier>, KeyStatement, KeyEffectiveStatement> {
-    private static final Splitter LIST_KEY_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
+        extends BaseStatementSupport<Set<QName>, KeyStatement, KeyEffectiveStatement> {
+    /**
+     * This is equivalent to {@link YangStatementLexer#SEP}'s definition. Currently equivalent to the non-repeating
+     * part of:
+     *
+     * <p>
+     * {@code SEP: [ \n\r\t]+ -> type(SEP);}.
+     */
+    private static final CharMatcher SEP = CharMatcher.anyOf(" \n\r\t").precomputed();
+
+    /**
+     * Splitter corresponding to {@code key-arg} ABNF as defined
+     * in <a href="https://tools.ietf.org/html/rfc6020#section-12">RFC6020, section 12</a>:
+     *
+     * <p>
+     * {@code key-arg             = node-identifier *(sep node-identifier)}
+     *
+     * <p>
+     * We also account for {@link #SEP} not handling repetition by ignoring empty strings.
+     */
+    private static final Splitter KEY_ARG_SPLITTER = Splitter.on(SEP).omitEmptyStrings();
+
     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
         YangStmtMapping.KEY)
         .build();
     private static final KeyStatementSupport INSTANCE = new KeyStatementSupport();
 
     private KeyStatementSupport() {
-        super(YangStmtMapping.KEY);
+        super(YangStmtMapping.KEY, CopyPolicy.DECLARED_COPY);
     }
 
     public static KeyStatementSupport getInstance() {
@@ -47,41 +68,38 @@ public final class KeyStatementSupport
     }
 
     @Override
-    public Collection<SchemaNodeIdentifier> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
-        final Builder<SchemaNodeIdentifier> builder = ImmutableSet.builder();
+    public ImmutableSet<QName> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
+        final Builder<QName> builder = ImmutableSet.builder();
         int tokens = 0;
-        for (String keyToken : LIST_KEY_SPLITTER.split(value)) {
-            builder.add(SchemaNodeIdentifier.SAME.createChild(StmtContextUtils.parseNodeIdentifier(ctx, keyToken)));
+        for (String keyToken : KEY_ARG_SPLITTER.split(value)) {
+            builder.add(StmtContextUtils.parseNodeIdentifier(ctx, keyToken));
             tokens++;
         }
 
         // Throws NPE on nulls, retains first inserted value, cannot be modified
-        final Collection<SchemaNodeIdentifier> ret = builder.build();
-        SourceException.throwIf(ret.size() != tokens, ctx.getStatementSourceReference(),
-                "Key argument '%s' contains duplicates", value);
+        final ImmutableSet<QName> ret = builder.build();
+        SourceException.throwIf(ret.size() != tokens, ctx, "Key argument '%s' contains duplicates", value);
         return ret;
     }
 
     @Override
-    public Collection<SchemaNodeIdentifier> adaptArgumentValue(
-            final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, KeyEffectiveStatement> ctx,
+    public Set<QName> adaptArgumentValue(final StmtContext<Set<QName>, KeyStatement, KeyEffectiveStatement> ctx,
             final QNameModule targetModule) {
-        final Builder<SchemaNodeIdentifier> builder = ImmutableSet.builder();
+        final Builder<QName> builder = ImmutableSet.builder();
         boolean replaced = false;
-        for (final SchemaNodeIdentifier arg : ctx.coerceStatementArgument()) {
-            final QName qname = arg.getLastComponent();
+        for (final QName qname : ctx.getArgument()) {
             if (!targetModule.equals(qname.getModule())) {
                 final QName newQname = qname.bindTo(targetModule).intern();
-                builder.add(SchemaNodeIdentifier.SAME.createChild(newQname));
+                builder.add(newQname);
                 replaced = true;
             } else {
-                builder.add(arg);
+                builder.add(qname);
             }
         }
 
         // This makes sure we reuse the collection when a grouping is
         // instantiated in the same module
-        return replaced ? builder.build() : ctx.getStatementArgument();
+        return replaced ? builder.build() : ctx.argument();
     }
 
     @Override
@@ -90,45 +108,40 @@ public final class KeyStatementSupport
     }
 
     @Override
-    protected KeyStatement createDeclared(final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?> ctx,
+    protected KeyStatement createDeclared(final StmtContext<Set<QName>, KeyStatement, ?> ctx,
             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
-        return new RegularKeyStatement(ctx, substatements);
+        return new RegularKeyStatement(ctx.getRawArgument(), ctx.getArgument(), substatements);
     }
 
     @Override
-    protected KeyStatement createEmptyDeclared(
-            final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, ?> ctx) {
-        return new EmptyKeyStatement(ctx);
+    protected KeyStatement createEmptyDeclared(final StmtContext<Set<QName>, KeyStatement, ?> ctx) {
+        return new EmptyKeyStatement(ctx.getRawArgument(), ctx.getArgument());
     }
 
     @Override
-    protected KeyEffectiveStatement createEffective(
-            final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, KeyEffectiveStatement> ctx,
-            final KeyStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
-        final Collection<SchemaNodeIdentifier> arg = ctx.coerceStatementArgument();
+    protected KeyEffectiveStatement createEffective(final Current<Set<QName>, KeyStatement> stmt,
+            final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+        final Set<QName> arg = stmt.getArgument();
+        final KeyStatement declared = stmt.declared();
+        if (substatements.isEmpty()) {
+            return arg.equals(declared.argument()) ? new EmptyLocalKeyEffectiveStatement(declared)
+                : new EmptyForeignKeyEffectiveStatement(declared, arg);
+        }
+
         return arg.equals(declared.argument()) ? new RegularLocalKeyEffectiveStatement(declared, substatements)
                 : new RegularForeignKeyEffectiveStatement(declared, arg, substatements);
     }
 
-    @Override
-    protected KeyEffectiveStatement createEmptyEffective(
-            final StmtContext<Collection<SchemaNodeIdentifier>, KeyStatement, KeyEffectiveStatement> ctx,
-            final KeyStatement declared) {
-        final Collection<SchemaNodeIdentifier> arg = ctx.coerceStatementArgument();
-        return arg.equals(declared.argument()) ? new EmptyLocalKeyEffectiveStatement(declared)
-                : new EmptyForeignKeyEffectiveStatement(declared, arg);
-    }
-
-    static @NonNull Object maskCollection(final @NonNull Collection<SchemaNodeIdentifier> coll) {
-        return coll.size() == 1 ? verifyNotNull(coll.iterator().next()) : coll;
+    static @NonNull Object maskSet(final @NonNull Set<QName> set) {
+        return set.size() == 1 ? set.iterator().next() : set;
     }
 
     @SuppressWarnings("unchecked")
-    static @NonNull Collection<SchemaNodeIdentifier> unmaskCollection(final @NonNull Object masked) {
-        if (masked instanceof Collection) {
-            return (Collection<SchemaNodeIdentifier>) masked;
+    static @NonNull Set<QName> unmaskSet(final @NonNull Object masked) {
+        if (masked instanceof Set) {
+            return (Set<QName>) masked;
         }
-        verify(masked instanceof SchemaNodeIdentifier, "Unexpected argument %s", masked);
-        return ImmutableSet.of((SchemaNodeIdentifier) masked);
+        verify(masked instanceof QName, "Unexpected argument %s", masked);
+        return ImmutableSet.of((QName) masked);
     }
 }