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