2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
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;
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.EffectiveStmtCtx.Current;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
34 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
36 public final class KeyStatementSupport
37 extends AbstractStatementSupport<Set<QName>, KeyStatement, KeyEffectiveStatement> {
39 * This is equivalent to {@link YangStatementLexer#SEP}'s definition. Currently equivalent to the non-repeating
43 * {@code SEP: [ \n\r\t]+ -> type(SEP);}.
45 private static final CharMatcher SEP = CharMatcher.anyOf(" \n\r\t").precomputed();
48 * Splitter corresponding to {@code key-arg} ABNF as defined
49 * in <a href="https://tools.ietf.org/html/rfc6020#section-12">RFC6020, section 12</a>:
52 * {@code key-arg = node-identifier *(sep node-identifier)}
55 * We also account for {@link #SEP} not handling repetition by ignoring empty strings.
57 private static final Splitter KEY_ARG_SPLITTER = Splitter.on(SEP).omitEmptyStrings();
59 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
60 SubstatementValidator.builder(YangStmtMapping.KEY).build();
62 public KeyStatementSupport(final YangParserConfiguration config) {
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()), config);
69 public ImmutableSet<QName> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
70 final Builder<QName> builder = ImmutableSet.builder();
72 for (String keyToken : KEY_ARG_SPLITTER.split(value)) {
73 builder.add(StmtContextUtils.parseNodeIdentifier(ctx, keyToken));
77 // Throws NPE on nulls, retains first inserted value, cannot be modified
78 final ImmutableSet<QName> ret = builder.build();
79 SourceException.throwIf(ret.size() != tokens, ctx, "Key argument '%s' contains duplicates", value);
84 public Set<QName> adaptArgumentValue(final StmtContext<Set<QName>, KeyStatement, KeyEffectiveStatement> ctx,
85 final QNameModule targetModule) {
86 final Builder<QName> builder = ImmutableSet.builder();
87 boolean replaced = false;
88 for (final QName qname : ctx.getArgument()) {
89 if (!targetModule.equals(qname.getModule())) {
90 final QName newQname = qname.bindTo(targetModule).intern();
91 builder.add(newQname);
98 // This makes sure we reuse the collection when a grouping is instantiated in the same module.
99 return replaced ? builder.build() : ctx.argument();
103 protected SubstatementValidator getSubstatementValidator() {
104 return SUBSTATEMENT_VALIDATOR;
108 protected KeyStatement createDeclared(final StmtContext<Set<QName>, KeyStatement, ?> ctx,
109 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
110 return DeclaredStatements.createKey(ctx.getRawArgument(), ctx.getArgument(), substatements);
114 protected KeyStatement attachDeclarationReference(final KeyStatement stmt, final DeclarationReference reference) {
115 return DeclaredStatementDecorators.decorateKey(stmt, reference);
119 protected KeyEffectiveStatement createEffective(final Current<Set<QName>, KeyStatement> stmt,
120 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
121 return EffectiveStatements.createKey(stmt.declared(), stmt.getArgument(), substatements);