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.unique;
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 java.util.HashSet;
16 import java.util.regex.Pattern;
17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
18 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
20 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
21 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
22 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
23 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueStatement;
25 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
26 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
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.SubstatementValidator;
31 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
33 public final class UniqueStatementSupport
34 extends AbstractStatementSupport<Set<Descendant>, UniqueStatement, UniqueEffectiveStatement> {
36 * Support 'sep' ABNF rule in RFC7950 section 14. CRLF pattern is used to squash line-break from CRLF to LF form
37 * and then we use SEP_SPLITTER, which can operate on single characters.
39 private static final Pattern CRLF_PATTERN = Pattern.compile("\r\n", Pattern.LITERAL);
40 private static final Splitter SEP_SPLITTER = Splitter.on(CharMatcher.anyOf(" \t\n").precomputed())
43 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
44 YangStmtMapping.UNIQUE)
46 private static final UniqueStatementSupport INSTANCE = new UniqueStatementSupport();
48 private UniqueStatementSupport() {
49 // FIXME: This reflects what the current implementation does. We really want to define an adaptArgumentValue(),
50 // but how that plays with the argument and expectations needs to be investigated.
51 super(YangStmtMapping.UNIQUE, StatementPolicy.contextIndependent());
54 public static UniqueStatementSupport getInstance() {
59 public ImmutableSet<Descendant> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
60 final ImmutableSet<Descendant> uniqueConstraints = parseUniqueConstraintArgument(ctx, value);
61 SourceException.throwIf(uniqueConstraints.isEmpty(), ctx,
62 "Invalid argument value '%s' of unique statement. The value must contains at least one descendant schema "
63 + "node identifier.", value);
64 return uniqueConstraints;
68 protected SubstatementValidator getSubstatementValidator() {
69 return SUBSTATEMENT_VALIDATOR;
73 protected UniqueStatement createDeclared(final StmtContext<Set<Descendant>, UniqueStatement, ?> ctx,
74 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
75 return DeclaredStatements.createUnique(ctx.getRawArgument(), ctx.getArgument(), substatements);
79 protected UniqueStatement createEmptyDeclared(final StmtContext<Set<Descendant>, UniqueStatement, ?> ctx) {
80 return DeclaredStatements.createUnique(ctx.getRawArgument(), ctx.getArgument());
84 protected UniqueEffectiveStatement createEffective(final Current<Set<Descendant>, UniqueStatement> stmt,
85 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
86 return substatements.isEmpty() ? new EmptyUniqueEffectiveStatement(stmt.declared())
87 : new RegularUniqueEffectiveStatement(stmt.declared(), substatements);
91 private static ImmutableSet<Descendant> parseUniqueConstraintArgument(final StmtContext<?, ?, ?> ctx,
92 final String argumentValue) {
93 // deal with 'line-break' rule, which is either "\n" or "\r\n", but not "\r"
94 final String nocrlf = CRLF_PATTERN.matcher(argumentValue).replaceAll("\n");
96 final Set<Descendant> uniqueConstraintNodes = new HashSet<>();
97 for (final String uniqueArgToken : SEP_SPLITTER.split(nocrlf)) {
98 final SchemaNodeIdentifier nodeIdentifier = ArgumentUtils.nodeIdentifierFromPath(ctx, uniqueArgToken);
99 SourceException.throwIf(nodeIdentifier instanceof Absolute, ctx,
100 "Unique statement argument '%s' contains schema node identifier '%s' which is not in the descendant "
101 + "node identifier form.", argumentValue, uniqueArgToken);
102 uniqueConstraintNodes.add((Descendant) nodeIdentifier);
104 return ImmutableSet.copyOf(uniqueConstraintNodes);