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