yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/extension/UnrecognizedStatementSupport.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.extension;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import java.util.Optional;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.model.api.meta.ArgumentDefinition;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  17 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  18 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.UnrecognizedStatement;
  21 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.OverrideChildStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  29
  30 final class UnrecognizedStatementSupport
  31         extends AbstractStatementSupport<Object, UnrecognizedStatement, UnrecognizedEffectiveStatement>
  32         implements OverrideChildStatementSupport {
  33     private final YangParserConfiguration config;
  34
  35     UnrecognizedStatementSupport(final StatementDefinition publicDefinition, final YangParserConfiguration config) {
  36         // We have no idea about the statement's semantics, hence there should be noone interested in its semantics.
  37         // Nevertheless it may be of interest for various hacks to understand there was an extension involved.
  38         super(publicDefinition, StatementPolicy.exactReplica(), config);
  39         this.config = requireNonNull(config);
  40     }
  41
  42     @Override
  43     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  44         return value;
  45     }
  46
  47     @Override
  48     public UnrecognizedStatementSupport statementDefinitionOverrideOf(final StatementDefinition childDef) {
  49         /*
  50          * This code wraps statements encountered inside an extension so they do not get confused with regular
  51          * statements.
  52          */
  53         final QName baseQName = getStatementName();
  54         final QName statementName = QName.create(baseQName, childDef.getStatementName().getLocalName());
  55
  56         final ModelDefinedStatementDefinition def;
  57         final Optional<ArgumentDefinition> optArgDef = childDef.getArgumentDefinition();
  58         if (optArgDef.isPresent()) {
  59             final ArgumentDefinition argDef = optArgDef.get();
  60             def = new ModelDefinedStatementDefinition(statementName, argDef.getArgumentName(), argDef.isYinElement());
  61         } else {
  62             def = new ModelDefinedStatementDefinition(statementName);
  63         }
  64         return new UnrecognizedStatementSupport(def, config);
  65     }
  66
  67     @Override
  68     protected SubstatementValidator getSubstatementValidator() {
  69         // We know nothing about this statement
  70         return null;
  71     }
  72
  73     @Override
  74     protected UnrecognizedStatement createDeclared(final StmtContext<Object, UnrecognizedStatement, ?> ctx,
  75             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  76         return new UnrecognizedStatementImpl(ctx.rawArgument(), ctx.publicDefinition(), substatements);
  77     }
  78
  79     @Override
  80     protected UnrecognizedStatement attachDeclarationReference(final UnrecognizedStatement stmt,
  81             final DeclarationReference reference) {
  82         return new RefUnrecognizedStatement(stmt, reference);
  83     }
  84
  85     // createEffective() should never be called, ensure that for each declared statement
  86
  87     @Override
  88     public void onStatementAdded(final Mutable<Object, UnrecognizedStatement, UnrecognizedEffectiveStatement> stmt) {
  89         stmt.setIsSupportedToBuildEffective(false);
  90     }
  91
  92     @Override
  93     protected UnrecognizedEffectiveStatement createEffective(final Current<Object, UnrecognizedStatement> stmt,
  94             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  95         throw new InferenceException(stmt, "Attempted to instantiate unrecognized effective statement %s",
  96             stmt.publicDefinition());
  97     }
  98 }