yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/uses/UsesStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.uses;
   9
  10 import com.google.common.base.Verify;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Optional;
  15 import java.util.Set;
  16 import javax.annotation.Nonnull;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.common.QNameModule;
  19 import org.opendaylight.yangtools.yang.common.YangVersion;
  20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.SchemaNodeIdentifierBuildNamespace;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  41 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  42 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  43 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  44 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 final class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
  49     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
  50
  51     UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
  52         super(context);
  53     }
  54
  55     @Nonnull
  56     @Override
  57     public QName getName() {
  58         return argument();
  59     }
  60
  61     @Override
  62     public WhenStatement getWhenStatement() {
  63         return firstDeclared(WhenStatement.class);
  64     }
  65
  66     @Nonnull
  67     @Override
  68     public Collection<? extends IfFeatureStatement> getIfFeatures() {
  69         return allDeclared(IfFeatureStatement.class);
  70     }
  71
  72     @Override
  73     public StatusStatement getStatus() {
  74         return firstDeclared(StatusStatement.class);
  75     }
  76
  77     @Override
  78     public DescriptionStatement getDescription() {
  79         return firstDeclared(DescriptionStatement.class);
  80     }
  81
  82     @Override
  83     public ReferenceStatement getReference() {
  84         return firstDeclared(ReferenceStatement.class);
  85     }
  86
  87     @Nonnull
  88     @Override
  89     public Collection<? extends AugmentStatement> getAugments() {
  90         return allDeclared(AugmentStatement.class);
  91     }
  92
  93     @Nonnull
  94     @Override
  95     public Collection<? extends RefineStatement> getRefines() {
  96         return allDeclared(RefineStatement.class);
  97     }
  98
  99     /**
 100      * Copy statements from a grouping to a target node.
 101      *
 102      * @param sourceGrpStmtCtx
 103      *            source grouping statement context
 104      * @param targetCtx
 105      *            target context
 106      * @param usesNode
 107      *            uses node
 108      * @throws SourceException
 109      *             instance of SourceException
 110      */
 111     static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
 112             final StatementContextBase<?, ?, ?> targetCtx,
 113             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
 114         final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
 115         final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
 116         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 117         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 118
 119         for (final Mutable<?, ?, ?> original : declared) {
 120             if (original.isSupportedByFeatures()) {
 121                 copyStatement(original, targetCtx, newQNameModule, buffer);
 122             }
 123         }
 124
 125         for (final Mutable<?, ?, ?> original : effective) {
 126             copyStatement(original, targetCtx, newQNameModule, buffer);
 127         }
 128
 129         targetCtx.addEffectiveSubstatements(buffer);
 130         usesNode.addAsEffectOfStatement(buffer);
 131     }
 132
 133     private static void copyStatement(final Mutable<?, ?, ?> original,
 134             final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
 135             final Collection<Mutable<?, ?, ?>> buffer) {
 136         if (needToCopyByUses(original)) {
 137             final Mutable<?, ?, ?> copy = targetCtx.childCopyOf(original, CopyType.ADDED_BY_USES, targetModule);
 138             buffer.add(copy);
 139         } else if (isReusedByUsesOnTop(original)) {
 140             buffer.add(original);
 141         }
 142     }
 143
 144     private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
 145         YangStmtMapping.TYPE,
 146         YangStmtMapping.TYPEDEF);
 147
 148     private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
 149         return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
 150     }
 151
 152     private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
 153         YangStmtMapping.DESCRIPTION,
 154         YangStmtMapping.REFERENCE,
 155         YangStmtMapping.STATUS);
 156     private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
 157         YangStmtMapping.TYPE,
 158         YangStmtMapping.TYPEDEF,
 159         YangStmtMapping.USES);
 160
 161     public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
 162         final StatementDefinition def = stmtContext.getPublicDefinition();
 163         if (REUSED_DEF_SET.contains(def)) {
 164             LOG.debug("Will reuse {} statement {}", def, stmtContext);
 165             return false;
 166         }
 167         if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
 168             return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
 169         }
 170
 171         LOG.debug("Will copy {} statement {}", def, stmtContext);
 172         return true;
 173     }
 174
 175     public static void resolveUsesNode(
 176             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
 177             final StmtContext<?, ?, ?> targetNodeStmtCtx) {
 178         for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
 179             if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
 180                     && areFeaturesSupported(subStmtCtx)) {
 181                 performRefine(subStmtCtx, targetNodeStmtCtx);
 182             }
 183         }
 184     }
 185
 186     private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
 187         /*
 188          * In case of Yang 1.1, checks whether features are supported.
 189          */
 190         return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || subStmtCtx.isSupportedByFeatures();
 191     }
 192
 193     private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
 194         final Object refineArgument = subStmtCtx.getStatementArgument();
 195         InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
 196             subStmtCtx.getStatementSourceReference(),
 197             "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
 198
 199         final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaNodeIdentifierBuildNamespace.findNode(
 200             usesParentCtx, (SchemaNodeIdentifier) refineArgument);
 201         InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx.getStatementSourceReference(),
 202             "Refine target node %s not found.", refineArgument);
 203
 204         final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
 205         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 206             LOG.debug("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
 207                 + "Refine has been skipped. At line: {}", subStmtCtx.getStatementArgument(),
 208                 subStmtCtx.getParentContext().getStatementArgument(),
 209                 refineTargetNodeCtx.getStatementArgument(), subStmtCtx.getStatementSourceReference());
 210             subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 211             return;
 212         }
 213
 214         Verify.verify(refineTargetNodeCtx instanceof StatementContextBase);
 215         addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
 216         subStmtCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 217     }
 218
 219     private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
 220             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 221         for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
 222             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 223                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 224             }
 225         }
 226     }
 227
 228     private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
 229             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 230
 231         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
 232
 233         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 234                 refineSubstatementCtx.getStatementSourceReference(),
 235                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 236                 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
 237                         .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
 238                         .getPublicDefinition());
 239
 240         if (isAllowedToAddByRefine(refineSubstatementDef)) {
 241             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 242         } else {
 243             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 244             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 245         }
 246     }
 247
 248     private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
 249
 250     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 251         return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
 252     }
 253
 254     private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
 255         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 256                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 257
 258         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 259                 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
 260                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 261     }
 262
 263     private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
 264             final StmtContext<?, ?, ?> refineTargetNodeCtx) {
 265         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
 266                 .get(refineSubstatementCtx.getPublicDefinition());
 267
 268         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 269                 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
 270     }
 271
 272
 273     private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
 274             final StmtContext<?, ?, ?> stmtContext) {
 275         if (targetCtx.getParentContext() == null) {
 276             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 277         }
 278         if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
 279             return StmtContextUtils.getRootModuleQName(targetCtx);
 280         }
 281
 282         final Object targetStmtArgument = targetCtx.getStatementArgument();
 283         final Object sourceStmtArgument = stmtContext.getStatementArgument();
 284         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 285             return ((QName) targetStmtArgument).getModule();
 286         }
 287
 288         return null;
 289     }
 290 }