yang/rfc8040-parser-support/src/main/java/org/opendaylight/yangtools/rfc8040/parser/YangDataStatementSupport.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.rfc8040.parser;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.rfc8040.model.api.YangDataEffectiveStatement;
  16 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatement;
  17 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatements;
  18 import org.opendaylight.yangtools.yang.common.Empty;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredStatement.WithRawStringArgument.WithSubstatements;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStringStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  32
  33 @Beta
  34 public final class YangDataStatementSupport
  35         extends BaseStringStatementSupport<YangDataStatement, YangDataEffectiveStatement> {
  36     /**
  37      * Declared statement representation of 'yang-data' extension defined in
  38      * <a href="https://tools.ietf.org/html/rfc8040#section-8">RFC 8040</a>.
  39      */
  40     private static final class Declared extends WithSubstatements implements YangDataStatement {
  41         Declared(final String rawArgument, final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  42             super(rawArgument, substatements);
  43         }
  44     }
  45
  46     private static final YangDataStatementSupport INSTANCE = new YangDataStatementSupport(YangDataStatements.YANG_DATA);
  47
  48     private final SubstatementValidator validator;
  49
  50     private YangDataStatementSupport(final StatementDefinition definition) {
  51         super(definition, StatementPolicy.reject());
  52         validator = SubstatementValidator.builder(definition)
  53                 .addMandatory(YangStmtMapping.CONTAINER)
  54                 .addOptional(YangStmtMapping.USES)
  55                 .build();
  56     }
  57
  58     public static YangDataStatementSupport getInstance() {
  59         return INSTANCE;
  60     }
  61
  62     @Override
  63     // FIXME: we could do this in onStatementAdded() instead
  64     public void onFullDefinitionDeclared(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  65         // as per https://tools.ietf.org/html/rfc8040#section-8,
  66         // yang-data is ignored unless it appears as a top-level statement
  67         if (ctx.coerceParentContext().getParentContext() != null) {
  68             ctx.setIsSupportedToBuildEffective(false);
  69             return;
  70         }
  71
  72         // Parse and populate our argument to be picked up when we build the effecitve statement
  73         final String argument = ctx.argument();
  74         SourceException.throwIf(argument == null, ctx, "yang-data requires an argument");
  75         final QName qname = StmtContextUtils.parseIdentifier(ctx, argument);
  76         ctx.addToNs(YangDataArgumentNamespace.class, Empty.getInstance(), qname);
  77     }
  78
  79     @Override
  80     public boolean isIgnoringIfFeatures() {
  81         return true;
  82     }
  83
  84     @Override
  85     public boolean isIgnoringConfig() {
  86         return true;
  87     }
  88
  89     @Override
  90     protected SubstatementValidator getSubstatementValidator() {
  91         return validator;
  92     }
  93
  94     @Override
  95     protected YangDataStatement createDeclared(@NonNull final StmtContext<String, YangDataStatement, ?> ctx,
  96             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  97         return new Declared(ctx.getRawArgument(), substatements);
  98     }
  99
 100     @Override
 101     protected YangDataStatement createEmptyDeclared(final StmtContext<String, YangDataStatement, ?> ctx) {
 102         return createDeclared(ctx, ImmutableList.of());
 103     }
 104
 105     @Override
 106     protected YangDataEffectiveStatement createEffective(final Current<String, YangDataStatement> stmt,
 107             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 108         final QName qname = verifyNotNull(stmt.namespaceItem(YangDataArgumentNamespace.class,
 109             Empty.getInstance()));
 110
 111         // in case of yang-data node we need to perform substatement validation at the point when we have
 112         // effective substatement contexts already available - if the node has only a uses statement declared in it,
 113         // one top-level container node may very well be added to the yang-data as an effective statement
 114         validator.validate(stmt.caerbannog());
 115         return new YangDataEffectiveStatementImpl(stmt, substatements, qname);
 116     }
 117 }