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