parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/ContainerStatementSupport.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 static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  18 import org.opendaylight.yangtools.yang.model.api.Status;
  19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  20 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerEffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ContainerStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.PresenceEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  28 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  29 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  30 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  31 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  32 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  41
  42 @Beta
  43 public final class ContainerStatementSupport
  44         extends AbstractSchemaTreeStatementSupport<ContainerStatement, ContainerEffectiveStatement> {
  45     private static final SubstatementValidator RFC6020_VALIDATOR =
  46         SubstatementValidator.builder(YangStmtMapping.CONTAINER)
  47             .addAny(YangStmtMapping.ANYXML)
  48             .addAny(YangStmtMapping.CHOICE)
  49             .addOptional(YangStmtMapping.CONFIG)
  50             .addAny(YangStmtMapping.CONTAINER)
  51             .addOptional(YangStmtMapping.DESCRIPTION)
  52             .addAny(YangStmtMapping.GROUPING)
  53             .addAny(YangStmtMapping.IF_FEATURE)
  54             .addAny(YangStmtMapping.LEAF)
  55             .addAny(YangStmtMapping.LEAF_LIST)
  56             .addAny(YangStmtMapping.LIST)
  57             .addAny(YangStmtMapping.MUST)
  58             .addOptional(YangStmtMapping.PRESENCE)
  59             .addOptional(YangStmtMapping.REFERENCE)
  60             .addOptional(YangStmtMapping.STATUS)
  61             .addAny(YangStmtMapping.TYPEDEF)
  62             .addAny(YangStmtMapping.USES)
  63             .addOptional(YangStmtMapping.WHEN)
  64             .build();
  65
  66     private static final SubstatementValidator RFC7950_VALIDATOR =
  67         SubstatementValidator.builder(YangStmtMapping.CONTAINER)
  68             .addAny(YangStmtMapping.ACTION)
  69             .addAny(YangStmtMapping.ANYDATA)
  70             .addAny(YangStmtMapping.ANYXML)
  71             .addAny(YangStmtMapping.CHOICE)
  72             .addOptional(YangStmtMapping.CONFIG)
  73             .addAny(YangStmtMapping.CONTAINER)
  74             .addOptional(YangStmtMapping.DESCRIPTION)
  75             .addAny(YangStmtMapping.GROUPING)
  76             .addAny(YangStmtMapping.IF_FEATURE)
  77             .addAny(YangStmtMapping.LEAF)
  78             .addAny(YangStmtMapping.LEAF_LIST)
  79             .addAny(YangStmtMapping.LIST)
  80             .addAny(YangStmtMapping.MUST)
  81             .addAny(YangStmtMapping.NOTIFICATION)
  82             .addOptional(YangStmtMapping.PRESENCE)
  83             .addOptional(YangStmtMapping.REFERENCE)
  84             .addOptional(YangStmtMapping.STATUS)
  85             .addAny(YangStmtMapping.TYPEDEF)
  86             .addAny(YangStmtMapping.USES)
  87             .addOptional(YangStmtMapping.WHEN)
  88             .build();
  89
  90     private ContainerStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  91         super(YangStmtMapping.CONTAINER, instantiatedPolicy(), config, validator);
  92     }
  93
  94     public static @NonNull ContainerStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  95         return new ContainerStatementSupport(config, RFC6020_VALIDATOR);
  96     }
  97
  98     public static @NonNull ContainerStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  99         return new ContainerStatementSupport(config, RFC7950_VALIDATOR);
 100     }
 101
 102     @Override
 103     protected ContainerStatement createDeclared(final StmtContext<QName, ContainerStatement, ?> ctx,
 104             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 105         return DeclaredStatements.createContainer(ctx.getArgument(), substatements);
 106     }
 107
 108     @Override
 109     protected ContainerStatement attachDeclarationReference(final ContainerStatement stmt,
 110             final DeclarationReference reference) {
 111         return DeclaredStatementDecorators.decorateContainer(stmt, reference);
 112     }
 113
 114     @Override
 115     protected ContainerEffectiveStatement createEffective(final Current<QName, ContainerStatement> stmt,
 116             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 117         EffectiveStmtUtils.checkUniqueGroupings(stmt, substatements);
 118         EffectiveStmtUtils.checkUniqueTypedefs(stmt, substatements);
 119         EffectiveStmtUtils.checkUniqueUses(stmt, substatements);
 120
 121         try {
 122             return EffectiveStatements.createContainer(stmt.declared(), stmt.getArgument(),
 123                 createFlags(stmt, substatements), substatements);
 124         } catch (SubstatementIndexingException e) {
 125             throw new SourceException(e.getMessage(), stmt, e);
 126         }
 127     }
 128
 129     @Override
 130     public ContainerEffectiveStatement copyEffective(final Current<QName, ContainerStatement> stmt,
 131             final ContainerEffectiveStatement original) {
 132         return EffectiveStatements.copyContainer(original, stmt.getArgument(),
 133             createFlags(stmt, original.effectiveSubstatements()));
 134     }
 135
 136     @Override
 137     public EffectiveStatementState extractEffectiveState(final ContainerEffectiveStatement stmt) {
 138         verify(stmt instanceof ContainerSchemaNode, "Unexpected statement %s", stmt);
 139         final var schema = (ContainerSchemaNode) stmt;
 140         return new QNameWithFlagsEffectiveStatementState(stmt.argument(), new FlagsBuilder()
 141             .setHistory(schema)
 142             .setStatus(schema.getStatus())
 143             .setConfiguration(schema.effectiveConfig().orElse(null))
 144             .setPresence(schema.isPresenceContainer())
 145             .toFlags());
 146     }
 147
 148     private static int createFlags(final Current<?, ?> stmt,
 149             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 150         return new FlagsBuilder()
 151             .setHistory(stmt.history())
 152             .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 153             .setConfiguration(stmt.effectiveConfig().asNullable())
 154             .setPresence(findFirstStatement(substatements, PresenceEffectiveStatement.class) != null)
 155             .toFlags();
 156     }
 157 }
 158