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