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