parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/UniqueStatementSupport.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.meta;
   9
  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;
  15 import java.util.Set;
  16 import java.util.regex.Pattern;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueStatement;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  28 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  29 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  36 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  37
  38 public final class UniqueStatementSupport
  39         extends AbstractStatementSupport<Set<Descendant>, UniqueStatement, UniqueEffectiveStatement> {
  40     /**
  41      * Support 'sep' ABNF rule in RFC7950 section 14. CRLF pattern is used to squash line-break from CRLF to LF form
  42      * and then we use SEP_SPLITTER, which can operate on single characters.
  43      */
  44     private static final Pattern CRLF_PATTERN = Pattern.compile("\r\n", Pattern.LITERAL);
  45     private static final Splitter SEP_SPLITTER = Splitter.on(CharMatcher.anyOf(" \t\n").precomputed())
  46             .omitEmptyStrings();
  47
  48     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  49         SubstatementValidator.builder(YangStmtMapping.UNIQUE).build();
  50
  51     public UniqueStatementSupport(final YangParserConfiguration config) {
  52         // FIXME: This reflects what the current implementation does. We really want to define an adaptArgumentValue(),
  53         //        but how that plays with the argument and expectations needs to be investigated.
  54         super(YangStmtMapping.UNIQUE, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
  55     }
  56
  57     @Override
  58     public ImmutableSet<Descendant> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  59         final ImmutableSet<Descendant> uniqueConstraints = parseUniqueConstraintArgument(ctx, value);
  60         SourceException.throwIf(uniqueConstraints.isEmpty(), ctx,
  61             "Invalid argument value '%s' of unique statement. The value must contains at least one descendant schema "
  62                 + "node identifier.", value);
  63         return uniqueConstraints;
  64     }
  65
  66     @Override
  67     protected UniqueStatement createDeclared(final BoundStmtCtx<Set<Descendant>> ctx,
  68             final ImmutableList<DeclaredStatement<?>> substatements) {
  69         return DeclaredStatements.createUnique(ctx.getRawArgument(), ctx.getArgument(), substatements);
  70     }
  71
  72     @Override
  73     protected UniqueStatement attachDeclarationReference(final UniqueStatement stmt,
  74             final DeclarationReference reference) {
  75         return DeclaredStatementDecorators.decorateUnique(stmt, reference);
  76     }
  77
  78     @Override
  79     protected UniqueEffectiveStatement createEffective(final Current<Set<Descendant>, UniqueStatement> stmt,
  80             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  81         return EffectiveStatements.createUnique(stmt.declared(), substatements);
  82     }
  83
  84     private static ImmutableSet<Descendant> parseUniqueConstraintArgument(final StmtContext<?, ?, ?> ctx,
  85             final String argumentValue) {
  86         // deal with 'line-break' rule, which is either "\n" or "\r\n", but not "\r"
  87         final String nocrlf = CRLF_PATTERN.matcher(argumentValue).replaceAll("\n");
  88
  89         final Set<Descendant> uniqueConstraintNodes = new HashSet<>();
  90         for (final String uniqueArgToken : SEP_SPLITTER.split(nocrlf)) {
  91             final SchemaNodeIdentifier nodeIdentifier = ArgumentUtils.nodeIdentifierFromPath(ctx, uniqueArgToken);
  92             SourceException.throwIf(nodeIdentifier instanceof Absolute, ctx,
  93                 "Unique statement argument '%s' contains schema node identifier '%s' which is not in the descendant "
  94                     + "node identifier form.", argumentValue, uniqueArgToken);
  95             uniqueConstraintNodes.add((Descendant) nodeIdentifier);
  96         }
  97         return ImmutableSet.copyOf(uniqueConstraintNodes);
  98     }
  99 }