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