yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/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.stmt.rfc6020;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Set;
  15 import javax.annotation.Nonnull;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.common.QNameModule;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  30 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  45 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  47 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  48 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52
  53 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
  54     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  55             .USES)
  56             .addAny(YangStmtMapping.AUGMENT)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addAny(YangStmtMapping.IF_FEATURE)
  59             .addAny(YangStmtMapping.REFINE)
  60             .addOptional(YangStmtMapping.REFERENCE)
  61             .addOptional(YangStmtMapping.STATUS)
  62             .addOptional(YangStmtMapping.WHEN)
  63             .build();
  64
  65     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
  66
  67     protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
  68         super(context);
  69     }
  70
  71     public static class Definition extends
  72             AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
  73
  74         public Definition() {
  75             super(YangStmtMapping.USES);
  76         }
  77
  78         @Override
  79         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  80             return Utils.qNameFromArgument(ctx, value);
  81         }
  82
  83         @Override
  84         public void onFullDefinitionDeclared(
  85                 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
  86             if (!StmtContextUtils.areFeaturesSupported(usesNode)) {
  87                 return;
  88             }
  89
  90             SUBSTATEMENT_VALIDATOR.validate(usesNode);
  91
  92             if (StmtContextUtils.isInExtensionBody(usesNode)) {
  93                 return;
  94             }
  95
  96             ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  97             final QName groupingName = usesNode.getStatementArgument();
  98
  99             final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
 100                     GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
 101             final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
 102                     usesNode.getParentContext());
 103
 104             usesAction.apply(new InferenceAction() {
 105
 106                 @Override
 107                 public void apply() {
 108                     StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
 109                     StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
 110
 111                     try {
 112                         copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 113                         resolveUsesNode(usesNode, targetNodeStmtCtx);
 114                     } catch (SourceException e) {
 115                         LOG.warn(e.getMessage(), e);
 116                         throw e;
 117                     }
 118                 }
 119
 120                 @Override
 121                 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 122                     InferenceException.throwIf(failed.contains(sourceGroupingPre),
 123                             usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
 124                     throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
 125                 }
 126             });
 127         }
 128
 129         @Override
 130         public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
 131             return new UsesStatementImpl(ctx);
 132         }
 133
 134         @Override
 135         public EffectiveStatement<QName, UsesStatement> createEffective(
 136                 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
 137             return new UsesEffectiveStatementImpl(ctx);
 138         }
 139
 140     }
 141
 142     @Nonnull
 143     @Override
 144     public QName getName() {
 145         return argument();
 146     }
 147
 148     @Override
 149     public WhenStatement getWhenStatement() {
 150         return firstDeclared(WhenStatement.class);
 151     }
 152
 153     @Nonnull
 154     @Override
 155     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 156         return allDeclared(IfFeatureStatement.class);
 157     }
 158
 159     @Override
 160     public StatusStatement getStatus() {
 161         return firstDeclared(StatusStatement.class);
 162     }
 163
 164     @Override
 165     public DescriptionStatement getDescription() {
 166         return firstDeclared(DescriptionStatement.class);
 167     }
 168
 169     @Override
 170     public ReferenceStatement getReference() {
 171         return firstDeclared(ReferenceStatement.class);
 172     }
 173
 174     @Nonnull
 175     @Override
 176     public Collection<? extends AugmentStatement> getAugments() {
 177         return allDeclared(AugmentStatement.class);
 178     }
 179
 180     @Nonnull
 181     @Override
 182     public Collection<? extends RefineStatement> getRefines() {
 183         return allDeclared(RefineStatement.class);
 184     }
 185
 186     /**
 187      * @param sourceGrpStmtCtx
 188      *            source grouping statement context
 189      * @param targetCtx
 190      *            target context
 191      * @param usesNode
 192      *            uses node
 193      * @throws SourceException
 194      *             instance of SourceException
 195      */
 196     private static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
 197             final StatementContextBase<?, ?, ?> targetCtx,
 198             final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
 199         final Collection<StatementContextBase<?, ?, ?>> declared = sourceGrpStmtCtx.declaredSubstatements();
 200         final Collection<StatementContextBase<?, ?, ?>> effective = sourceGrpStmtCtx.effectiveSubstatements();
 201         final Collection<StatementContextBase<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 202         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 203
 204         for (final StatementContextBase<?, ?, ?> original : declared) {
 205             if (StmtContextUtils.areFeaturesSupported(original)) {
 206                 copyStatement(original, targetCtx, newQNameModule, buffer);
 207             }
 208         }
 209
 210         for (final StatementContextBase<?, ?, ?> original : effective) {
 211             copyStatement(original, targetCtx, newQNameModule, buffer);
 212         }
 213
 214         targetCtx.addEffectiveSubstatements(buffer);
 215         usesNode.addAsEffectOfStatement(buffer);
 216     }
 217
 218     private static void copyStatement(final StatementContextBase<?, ?, ?> original,
 219             final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
 220             final Collection<StatementContextBase<?, ?, ?>> buffer) {
 221         if (needToCopyByUses(original)) {
 222             final StatementContextBase<?, ?, ?> copy = original.createCopy(targetModule, targetCtx,
 223                     CopyType.ADDED_BY_USES);
 224             buffer.add(copy);
 225         } else if (isReusedByUsesOnTop(original)) {
 226             buffer.add(original);
 227         }
 228     }
 229
 230     private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
 231         YangStmtMapping.TYPE,
 232         YangStmtMapping.TYPEDEF);
 233
 234     private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
 235         return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
 236     }
 237
 238     private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
 239         YangStmtMapping.DESCRIPTION,
 240         YangStmtMapping.REFERENCE,
 241         YangStmtMapping.STATUS);
 242     private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
 243         YangStmtMapping.TYPE,
 244         YangStmtMapping.TYPEDEF,
 245         YangStmtMapping.USES);
 246
 247     public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
 248         final StatementDefinition def = stmtContext.getPublicDefinition();
 249         if (REUSED_DEF_SET.contains(def)) {
 250             LOG.debug("Will reuse {} statement {}", def, stmtContext);
 251             return false;
 252         }
 253         if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
 254             return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
 255         }
 256
 257         LOG.debug("Will copy {} statement {}", def, stmtContext);
 258         return true;
 259     }
 260
 261     public static void resolveUsesNode(
 262             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
 263             final StatementContextBase<?, ?, ?> targetNodeStmtCtx) {
 264         for (final StatementContextBase<?, ?, ?> subStmtCtx : usesNode.declaredSubstatements()) {
 265             if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)) {
 266                 performRefine(subStmtCtx, targetNodeStmtCtx);
 267             }
 268         }
 269     }
 270
 271     private static void performRefine(final StatementContextBase<?, ?, ?> refineCtx,
 272             final StatementContextBase<?, ?, ?> usesParentCtx) {
 273
 274         final Object refineArgument = refineCtx.getStatementArgument();
 275         Preconditions.checkArgument(refineArgument instanceof SchemaNodeIdentifier,
 276                 "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier. At %s", refineArgument,
 277                 refineCtx.getStatementSourceReference());
 278
 279         final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
 280         final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
 281                 refineTargetNodeIdentifier);
 282         Preconditions.checkArgument(refineTargetNodeCtx != null, "Refine target node %s not found. At %s",
 283                 refineTargetNodeIdentifier, refineCtx.getStatementSourceReference());
 284         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 285             LOG.debug(
 286                     "Refine node '{}' in uses '{}' has target node unknown statement '{}'. Refine has been skipped. At line: {}",
 287                     refineCtx.getStatementArgument(), refineCtx.getParentContext().getStatementArgument(),
 288                     refineTargetNodeCtx.getStatementArgument(), refineCtx.getStatementSourceReference());
 289             refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 290             return;
 291         }
 292
 293         addOrReplaceNodes(refineCtx, refineTargetNodeCtx);
 294         refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 295     }
 296
 297     private static void addOrReplaceNodes(final StatementContextBase<?, ?, ?> refineCtx,
 298             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 299         for (final StatementContextBase<?, ?, ?> refineSubstatementCtx : refineCtx.declaredSubstatements()) {
 300             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 301                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 302             }
 303         }
 304     }
 305
 306     private static void addOrReplaceNode(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
 307             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 308
 309         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
 310
 311         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 312                 refineSubstatementCtx.getStatementSourceReference(),
 313                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 314                 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
 315                         .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
 316                         .getPublicDefinition());
 317
 318         if (isAllowedToAddByRefine(refineSubstatementDef)) {
 319             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 320         } else {
 321             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 322             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 323         }
 324     }
 325
 326     private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
 327
 328     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 329         return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
 330     }
 331
 332     private static boolean isSupportedRefineSubstatement(final StatementContextBase<?, ?, ?> refineSubstatementCtx) {
 333         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 334                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 335
 336         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 337                 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
 338                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 339     }
 340
 341     private static boolean isSupportedRefineTarget(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
 342             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 343
 344         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
 345                 .get(refineSubstatementCtx.getPublicDefinition());
 346
 347         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 348                 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
 349     }
 350
 351
 352     private static QNameModule getNewQNameModule(final StatementContextBase<?, ?, ?> targetCtx,
 353             final StmtContext<?, ?, ?> stmtContext) {
 354         if (targetCtx.isRootContext()) {
 355             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 356         }
 357         if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
 358             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx.getRoot());
 359         }
 360
 361         final Object targetStmtArgument = targetCtx.getStatementArgument();
 362         final Object sourceStmtArgument = stmtContext.getStatementArgument();
 363         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 364             return ((QName) targetStmtArgument).getModule();
 365         }
 366
 367         return null;
 368     }
 369
 370 }