parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/meta/CaseStatementSupport.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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.Status;
  23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.meta.StatementOrigin;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.CaseEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.CaseStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  32 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  33 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  34 import org.opendaylight.yangtools.yang.model.ri.stmt.ImplicitStatements;
  35 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  36 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  37 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStatementState;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent.EffectiveConfig;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameWithFlagsEffectiveStatementState;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  45
  46 @Beta
  47 public final class CaseStatementSupport
  48         extends AbstractImplicitStatementSupport<CaseStatement, CaseEffectiveStatement> {
  49     private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CASE)
  50             .addAny(YangStmtMapping.ANYXML)
  51             .addAny(YangStmtMapping.CHOICE)
  52             .addAny(YangStmtMapping.CONTAINER)
  53             .addOptional(YangStmtMapping.DESCRIPTION)
  54             .addAny(YangStmtMapping.IF_FEATURE)
  55             .addAny(YangStmtMapping.LEAF)
  56             .addAny(YangStmtMapping.LEAF_LIST)
  57             .addAny(YangStmtMapping.LIST)
  58             .addOptional(YangStmtMapping.REFERENCE)
  59             .addOptional(YangStmtMapping.STATUS)
  60             .addAny(YangStmtMapping.USES)
  61             .addOptional(YangStmtMapping.WHEN)
  62             .build();
  63     private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.CASE)
  64             .addAny(YangStmtMapping.ANYDATA)
  65             .addAny(YangStmtMapping.ANYXML)
  66             .addAny(YangStmtMapping.CHOICE)
  67             .addAny(YangStmtMapping.CONTAINER)
  68             .addOptional(YangStmtMapping.DESCRIPTION)
  69             .addAny(YangStmtMapping.IF_FEATURE)
  70             .addAny(YangStmtMapping.LEAF)
  71             .addAny(YangStmtMapping.LEAF_LIST)
  72             .addAny(YangStmtMapping.LIST)
  73             .addOptional(YangStmtMapping.REFERENCE)
  74             .addOptional(YangStmtMapping.STATUS)
  75             .addAny(YangStmtMapping.USES)
  76             .addOptional(YangStmtMapping.WHEN)
  77             .build();
  78
  79     private CaseStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  80         super(YangStmtMapping.CASE, instantiatedPolicy(), config, validator);
  81     }
  82
  83     public static @NonNull CaseStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  84         return new CaseStatementSupport(config, RFC6020_VALIDATOR);
  85     }
  86
  87     public static @NonNull CaseStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  88         return new CaseStatementSupport(config, RFC7950_VALIDATOR);
  89     }
  90
  91     @Override
  92     protected CaseStatement createDeclared(final StmtContext<QName, CaseStatement, ?> ctx,
  93             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  94         final StatementOrigin origin = ctx.origin();
  95         switch (origin) {
  96             case CONTEXT:
  97                 return ImplicitStatements.createCase(ctx.getArgument(), substatements);
  98             case DECLARATION:
  99                 return DeclaredStatements.createCase(ctx.getArgument(), substatements);
 100             default:
 101                 throw new IllegalStateException("Unhandled statement origin " + origin);
 102         }
 103     }
 104
 105     @Override
 106     protected CaseStatement attachDeclarationReference(final CaseStatement stmt, final DeclarationReference reference) {
 107         return DeclaredStatementDecorators.decorateCase(stmt, reference);
 108     }
 109
 110     @Override
 111     protected CaseEffectiveStatement copyDeclaredEffective(final Current<QName, CaseStatement> stmt,
 112             final CaseEffectiveStatement original) {
 113         return EffectiveStatements.copyCase(original, stmt.getArgument(),
 114             computeFlags(stmt, original.effectiveSubstatements()));
 115     }
 116
 117     @Override
 118     protected CaseEffectiveStatement copyUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 119             final CaseEffectiveStatement original) {
 120         return EffectiveStatements.copyCase(original, stmt.getArgument(),
 121             computeFlags(stmt, original.effectiveSubstatements()));
 122     }
 123
 124     @Override
 125     protected CaseEffectiveStatement createDeclaredEffective(final Current<QName, CaseStatement> stmt,
 126             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 127         try {
 128             return EffectiveStatements.createCase(stmt.declared(), stmt.getArgument(),
 129                 computeFlags(stmt, substatements), substatements);
 130         } catch (SubstatementIndexingException e) {
 131             throw new SourceException(e.getMessage(), stmt, e);
 132         }
 133     }
 134
 135     @Override
 136     protected CaseEffectiveStatement createUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 137             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 138         try {
 139             return EffectiveStatements.createCase(stmt.getArgument(), computeFlags(stmt, substatements), substatements);
 140         } catch (SubstatementIndexingException e) {
 141             throw new SourceException(e.getMessage(), stmt, e);
 142         }
 143     }
 144
 145     @Override
 146     public EffectiveStatementState extractEffectiveState(final CaseEffectiveStatement stmt) {
 147         verify(stmt instanceof CaseSchemaNode, "Unexpected statement %s", stmt);
 148         final var schema = (CaseSchemaNode) stmt;
 149         return new QNameWithFlagsEffectiveStatementState(stmt.argument(), new FlagsBuilder()
 150             .setHistory(schema)
 151             .setStatus(schema.getStatus())
 152             .setConfiguration(schema.effectiveConfig().orElse(null))
 153             .toFlags());
 154     }
 155
 156     private static int computeFlags(final Current<?, ?> stmt,
 157             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 158         final Boolean config;
 159         final EffectiveConfig effective = stmt.effectiveConfig();
 160         switch (effective) {
 161             case FALSE:
 162                 config = Boolean.FALSE;
 163                 break;
 164             case IGNORED:
 165                 config = null;
 166                 break;
 167             case TRUE:
 168                 final Boolean sub = substatementEffectiveConfig(substatements);
 169                 config = sub != null ? sub : Boolean.TRUE;
 170                 break;
 171             case UNDETERMINED:
 172                 config = substatementEffectiveConfig(substatements);
 173                 break;
 174             default:
 175                 throw new IllegalStateException("Unhandled effective config " + effective);
 176         }
 177
 178         return new FlagsBuilder()
 179                 .setHistory(stmt.history())
 180                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 181                 .setConfiguration(config)
 182                 .toFlags();
 183     }
 184
 185     @SuppressFBWarnings(value = "NP_BOOLEAN_RETURN_NULL", justification = "Internal use tagged with @Nullable")
 186     private static @Nullable Boolean substatementEffectiveConfig(
 187             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 188         for (EffectiveStatement<?, ?> stmt : substatements) {
 189             if (stmt instanceof DataSchemaNode) {
 190                 final Optional<Boolean> opt = ((DataSchemaNode) stmt).effectiveConfig();
 191                 if (opt.isPresent()) {
 192                     return opt.orElseThrow();
 193                 }
 194             }
 195         }
 196         return null;
 197     }
 198 }