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.SubstatementIndexingException;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseImplicitStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  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         switch (source) {
  99             case CONTEXT:
 100                 return new RegularUndeclaredCaseStatement(ctx.getArgument(), substatements);
 101             case DECLARATION:
 102                 return new RegularCaseStatement(ctx.getArgument(), substatements);
 103             default:
 104                 throw new IllegalStateException("Unhandled statement source " + source);
 105         }
 106     }
 107
 108     @Override
 109     protected CaseStatement createEmptyDeclared(final StmtContext<QName, CaseStatement, ?> ctx) {
 110         final StatementSource source = ctx.source();
 111         switch (source) {
 112             case CONTEXT:
 113                 return new EmptyUndeclaredCaseStatement(ctx.getArgument());
 114             case DECLARATION:
 115                 return new EmptyCaseStatement(ctx.getArgument());
 116             default:
 117                 throw new IllegalStateException("Unhandled statement source " + source);
 118         }
 119     }
 120
 121     @Override
 122     protected CaseEffectiveStatement copyDeclaredEffective(final Current<QName, CaseStatement> stmt,
 123             final CaseEffectiveStatement original) {
 124         return new DeclaredCaseEffectiveStatement((DeclaredCaseEffectiveStatement) original, stmt.effectivePath(),
 125             computeFlags(stmt, original.effectiveSubstatements()), findOriginal(stmt));
 126     }
 127
 128     @Override
 129     protected CaseEffectiveStatement copyUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 130             final CaseEffectiveStatement original) {
 131         return new UndeclaredCaseEffectiveStatement((UndeclaredCaseEffectiveStatement) original, stmt.effectivePath(),
 132             computeFlags(stmt, original.effectiveSubstatements()),findOriginal(stmt));
 133     }
 134
 135     @Override
 136     protected CaseEffectiveStatement createDeclaredEffective(final Current<QName, CaseStatement> stmt,
 137             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 138         try {
 139             return new DeclaredCaseEffectiveStatement(stmt.declared(), substatements, stmt.effectivePath(),
 140                 computeFlags(stmt, substatements), findOriginal(stmt));
 141         } catch (SubstatementIndexingException e) {
 142             throw new SourceException(e.getMessage(), stmt, e);
 143         }
 144     }
 145
 146     @Override
 147     protected CaseEffectiveStatement createUndeclaredEffective(final Current<QName, CaseStatement> stmt,
 148             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 149         try {
 150             return new UndeclaredCaseEffectiveStatement(substatements, stmt.effectivePath(),
 151                 computeFlags(stmt, substatements), findOriginal(stmt));
 152         } catch (SubstatementIndexingException e) {
 153             throw new SourceException(e.getMessage(), stmt, e);
 154         }
 155     }
 156
 157     private static @Nullable CaseSchemaNode findOriginal(final Current<?, ?> stmt) {
 158         return (CaseSchemaNode) stmt.original();
 159     }
 160
 161     private static int computeFlags(final Current<?, ?> stmt,
 162             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 163         final Boolean config;
 164         final EffectiveConfig effective = stmt.effectiveConfig();
 165         switch (effective) {
 166             case FALSE:
 167                 config = Boolean.FALSE;
 168                 break;
 169             case IGNORED:
 170                 config = null;
 171                 break;
 172             case TRUE:
 173                 final Boolean sub = substatementEffectiveConfig(substatements);
 174                 config = sub != null ? sub : Boolean.TRUE;
 175                 break;
 176             case UNDETERMINED:
 177                 config = substatementEffectiveConfig(substatements);
 178                 break;
 179             default:
 180                 throw new IllegalStateException("Unhandled effective config " + effective);
 181         }
 182
 183         return new FlagsBuilder()
 184                 .setHistory(stmt.history())
 185                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 186                 .setConfiguration(config)
 187                 .toFlags();
 188     }
 189
 190     @SuppressFBWarnings(value = "NP_BOOLEAN_RETURN_NULL", justification = "Internal use tagged with @Nullable")
 191     private static @Nullable Boolean substatementEffectiveConfig(
 192             final Collection<? extends EffectiveStatement<?, ?>> substatements) {
 193         for (EffectiveStatement<?, ?> stmt : substatements) {
 194             if (stmt instanceof DataSchemaNode) {
 195                 final Optional<Boolean> opt = ((DataSchemaNode) stmt).effectiveConfig();
 196                 if (opt.isPresent()) {
 197                     return opt.orElseThrow();
 198                 }
 199             }
 200         }
 201         return null;
 202     }
 203 }