parser/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/submodule/SubmoduleStatementSupport.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.submodule;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.findFirstDeclaredSubstatement;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableList;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  17 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  18 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  19 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  26 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  27 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  28 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
  29 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  30 import org.opendaylight.yangtools.yang.parser.spi.ParserNamespaces;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractUnqualifiedStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  40
  41 @Beta
  42 public final class SubmoduleStatementSupport
  43         extends AbstractUnqualifiedStatementSupport<SubmoduleStatement, SubmoduleEffectiveStatement> {
  44     private static final SubstatementValidator RFC6020_VALIDATOR =
  45         SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
  46             .addAny(YangStmtMapping.ANYXML)
  47             .addAny(YangStmtMapping.AUGMENT)
  48             .addMandatory(YangStmtMapping.BELONGS_TO)
  49             .addAny(YangStmtMapping.CHOICE)
  50             .addOptional(YangStmtMapping.CONTACT)
  51             .addAny(YangStmtMapping.CONTAINER)
  52             .addOptional(YangStmtMapping.DESCRIPTION)
  53             .addAny(YangStmtMapping.DEVIATION)
  54             .addAny(YangStmtMapping.EXTENSION)
  55             .addAny(YangStmtMapping.FEATURE)
  56             .addAny(YangStmtMapping.GROUPING)
  57             .addAny(YangStmtMapping.IDENTITY)
  58             .addAny(YangStmtMapping.IMPORT)
  59             .addAny(YangStmtMapping.INCLUDE)
  60             .addAny(YangStmtMapping.LEAF)
  61             .addAny(YangStmtMapping.LEAF_LIST)
  62             .addAny(YangStmtMapping.LIST)
  63             .addAny(YangStmtMapping.NOTIFICATION)
  64             .addOptional(YangStmtMapping.ORGANIZATION)
  65             .addOptional(YangStmtMapping.REFERENCE)
  66             .addAny(YangStmtMapping.REVISION)
  67             .addAny(YangStmtMapping.RPC)
  68             .addAny(YangStmtMapping.TYPEDEF)
  69             .addAny(YangStmtMapping.USES)
  70             .addOptional(YangStmtMapping.YANG_VERSION)
  71             .build();
  72     private static final SubstatementValidator RFC7950_VALIDATOR =
  73         SubstatementValidator.builder(YangStmtMapping.SUBMODULE)
  74             .addAny(YangStmtMapping.ANYDATA)
  75             .addAny(YangStmtMapping.ANYXML)
  76             .addAny(YangStmtMapping.AUGMENT)
  77             .addMandatory(YangStmtMapping.BELONGS_TO)
  78             .addAny(YangStmtMapping.CHOICE)
  79             .addOptional(YangStmtMapping.CONTACT)
  80             .addAny(YangStmtMapping.CONTAINER)
  81             .addOptional(YangStmtMapping.DESCRIPTION)
  82             .addAny(YangStmtMapping.DEVIATION)
  83             .addAny(YangStmtMapping.EXTENSION)
  84             .addAny(YangStmtMapping.FEATURE)
  85             .addAny(YangStmtMapping.GROUPING)
  86             .addAny(YangStmtMapping.IDENTITY)
  87             .addAny(YangStmtMapping.IMPORT)
  88             .addAny(YangStmtMapping.INCLUDE)
  89             .addAny(YangStmtMapping.LEAF)
  90             .addAny(YangStmtMapping.LEAF_LIST)
  91             .addAny(YangStmtMapping.LIST)
  92             .addAny(YangStmtMapping.NOTIFICATION)
  93             .addOptional(YangStmtMapping.ORGANIZATION)
  94             .addOptional(YangStmtMapping.REFERENCE)
  95             .addAny(YangStmtMapping.REVISION)
  96             .addAny(YangStmtMapping.RPC)
  97             .addAny(YangStmtMapping.TYPEDEF)
  98             .addAny(YangStmtMapping.USES)
  99             .addOptional(YangStmtMapping.YANG_VERSION)
 100             .build();
 101
 102     private SubmoduleStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
 103         super(YangStmtMapping.SUBMODULE, StatementPolicy.reject(), config, validator);
 104     }
 105
 106     public static @NonNull SubmoduleStatementSupport rfc6020Instance(final YangParserConfiguration config) {
 107         return new SubmoduleStatementSupport(config, RFC6020_VALIDATOR);
 108     }
 109
 110     public static @NonNull SubmoduleStatementSupport rfc7950Instance(final YangParserConfiguration config) {
 111         return new SubmoduleStatementSupport(config, RFC7950_VALIDATOR);
 112     }
 113
 114     @Override
 115     public void onPreLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
 116         stmt.setRootIdentifier(new SourceIdentifier(stmt.getArgument(),
 117             StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()).orElse(null)));
 118     }
 119
 120     @Override
 121     public void onLinkageDeclared(final Mutable<Unqualified, SubmoduleStatement, SubmoduleEffectiveStatement> stmt) {
 122         final SourceIdentifier submoduleIdentifier = new SourceIdentifier(stmt.getArgument(),
 123             StmtContextUtils.getLatestRevision(stmt.declaredSubstatements()).orElse(null));
 124
 125         final StmtContext<?, SubmoduleStatement, SubmoduleEffectiveStatement>
 126             possibleDuplicateSubmodule = stmt.namespaceItem(ParserNamespaces.SUBMODULE, submoduleIdentifier);
 127         if (possibleDuplicateSubmodule != null && possibleDuplicateSubmodule != stmt) {
 128             throw new SourceException(stmt, "Submodule name collision: %s. At %s", stmt.rawArgument(),
 129                 possibleDuplicateSubmodule.sourceReference());
 130         }
 131
 132         stmt.addToNs(ParserNamespaces.SUBMODULE, submoduleIdentifier, stmt);
 133
 134         final Unqualified belongsToModuleName = firstAttributeOf(stmt.declaredSubstatements(),
 135             BelongsToStatement.class);
 136         final StmtContext<?, ?, ?> prefixSubStmtCtx = SourceException.throwIfNull(
 137             findFirstDeclaredSubstatement(stmt, 0, BelongsToStatement.class, PrefixStatement.class), stmt,
 138             "Prefix of belongsTo statement is missing in submodule [%s]", stmt.rawArgument());
 139
 140         final String prefix = prefixSubStmtCtx.rawArgument();
 141         stmt.addToNs(ParserNamespaces.BELONGSTO_PREFIX_TO_MODULE_NAME, prefix, belongsToModuleName);
 142     }
 143
 144     @Override
 145     protected SubmoduleStatement createDeclared(final BoundStmtCtx<Unqualified> ctx,
 146             final ImmutableList<DeclaredStatement<?>> substatements) {
 147         if (substatements.isEmpty()) {
 148             throw noBelongsTo(ctx);
 149         }
 150         return DeclaredStatements.createSubmodule(ctx.getRawArgument(), ctx.getArgument(), substatements);
 151     }
 152
 153     @Override
 154     protected SubmoduleStatement attachDeclarationReference(final SubmoduleStatement stmt,
 155             final DeclarationReference reference) {
 156         return DeclaredStatementDecorators.decorateSubmodule(stmt, reference);
 157     }
 158
 159     @Override
 160     protected SubmoduleEffectiveStatement createEffective(final Current<Unqualified, SubmoduleStatement> stmt,
 161             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 162         if (substatements.isEmpty()) {
 163             throw noBelongsTo(stmt);
 164         }
 165         try {
 166             return new SubmoduleEffectiveStatementImpl(stmt, substatements);
 167         } catch (SubstatementIndexingException e) {
 168             throw new SourceException(e.getMessage(), stmt, e);
 169         }
 170     }
 171
 172     private static SourceException noBelongsTo(final CommonStmtCtx stmt) {
 173         return new SourceException("No belongs-to declared in submodule", stmt);
 174     }
 175 }