Populate parser/ hierarchy
[yangtools.git] / parser / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / KeyStatementSupport.java
diff --git a/parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/KeyStatementSupport.java b/parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/KeyStatementSupport.java
new file mode 100644 (file)
index 0000000..51fa88b
--- /dev/null
@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
+
+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.Set;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
+import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
+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.ri.stmt.DeclaredStatementDecorators;
+import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
+import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
+import org.opendaylight.yangtools.yang.parser.antlr.YangStatementLexer;
+import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
+import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
+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 AbstractStatementSupport<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();
+
+    public KeyStatementSupport(final YangParserConfiguration config) {
+        super(YangStmtMapping.KEY, StatementPolicy.copyDeclared(
+            // Identity comparison is sufficient because adaptArgumentValue() is careful about reuse.
+            (copy, current, substatements) -> copy.getArgument() == current.getArgument()),
+            config, SUBSTATEMENT_VALIDATOR);
+    }
+
+    @Override
+    public ImmutableSet<QName> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
+        final Builder<QName> builder = ImmutableSet.builder();
+        int tokens = 0;
+        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 ImmutableSet<QName> ret = builder.build();
+        SourceException.throwIf(ret.size() != tokens, ctx, "Key argument '%s' contains duplicates", value);
+        return ret;
+    }
+
+    @Override
+    public Set<QName> adaptArgumentValue(final StmtContext<Set<QName>, KeyStatement, KeyEffectiveStatement> ctx,
+            final QNameModule targetModule) {
+        final Builder<QName> builder = ImmutableSet.builder();
+        boolean replaced = false;
+        for (final QName qname : ctx.getArgument()) {
+            if (!targetModule.equals(qname.getModule())) {
+                final QName newQname = qname.bindTo(targetModule).intern();
+                builder.add(newQname);
+                replaced = true;
+            } else {
+                builder.add(qname);
+            }
+        }
+
+        // This makes sure we reuse the collection when a grouping is instantiated in the same module.
+        return replaced ? builder.build() : ctx.argument();
+    }
+
+    @Override
+    protected KeyStatement createDeclared(final StmtContext<Set<QName>, KeyStatement, ?> ctx,
+            final ImmutableList<? extends DeclaredStatement<?>> substatements) {
+        return DeclaredStatements.createKey(ctx.getRawArgument(), ctx.getArgument(), substatements);
+    }
+
+    @Override
+    protected KeyStatement attachDeclarationReference(final KeyStatement stmt, final DeclarationReference reference) {
+        return DeclaredStatementDecorators.decorateKey(stmt, reference);
+    }
+
+    @Override
+    protected KeyEffectiveStatement createEffective(final Current<Set<QName>, KeyStatement> stmt,
+            final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
+        return EffectiveStatements.createKey(stmt.declared(), stmt.getArgument(), substatements);
+    }
+}