yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/typedef/TypedefStatementSupport.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.typedef;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.model.api.Status;
  15 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  16 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  17 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.DefaultEffectiveStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  23 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
  24 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  25 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  26 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  33
  34 public final class TypedefStatementSupport extends
  35         BaseQNameStatementSupport<TypedefStatement, TypedefEffectiveStatement> {
  36     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  37         YangStmtMapping.TYPEDEF)
  38         .addOptional(YangStmtMapping.DEFAULT)
  39         .addOptional(YangStmtMapping.DESCRIPTION)
  40         .addOptional(YangStmtMapping.REFERENCE)
  41         .addOptional(YangStmtMapping.STATUS)
  42         .addMandatory(YangStmtMapping.TYPE)
  43         .addOptional(YangStmtMapping.UNITS)
  44         .build();
  45     private static final TypedefStatementSupport INSTANCE = new TypedefStatementSupport();
  46
  47     private TypedefStatementSupport() {
  48         super(YangStmtMapping.TYPEDEF);
  49     }
  50
  51     public static TypedefStatementSupport getInstance() {
  52         return INSTANCE;
  53     }
  54
  55     @Override
  56     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  57         return StmtContextUtils.parseIdentifier(ctx, value);
  58     }
  59
  60     @Override
  61     public void onFullDefinitionDeclared(final Mutable<QName, TypedefStatement, TypedefEffectiveStatement> stmt) {
  62         super.onFullDefinitionDeclared(stmt);
  63
  64         if (stmt != null) {
  65             final Mutable<?, ?, ?> parent = stmt.getParentContext();
  66             if (parent != null) {
  67                 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
  68                 // declarations and parent declarations which have already been declared.
  69                 checkConflict(parent, stmt);
  70                 parent.addContext(TypeNamespace.class, stmt.getArgument(), stmt);
  71             }
  72         }
  73     }
  74
  75     @Override
  76     protected SubstatementValidator getSubstatementValidator() {
  77         return SUBSTATEMENT_VALIDATOR;
  78     }
  79
  80     @Override
  81     protected TypedefStatement createDeclared(final StmtContext<QName, TypedefStatement, ?> ctx,
  82             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  83         checkDeclared(ctx);
  84         return new RegularTypedefStatement(ctx.getArgument(), substatements);
  85     }
  86
  87     @Override
  88     protected TypedefStatement createEmptyDeclared(final StmtContext<QName, TypedefStatement, ?> ctx) {
  89         checkDeclared(ctx);
  90         return new EmptyTypedefStatement(ctx.getArgument());
  91     }
  92
  93     @Override
  94     protected TypedefEffectiveStatement createEffective(final Current<QName, TypedefStatement> stmt,
  95             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  96         final TypedefStatement declared = stmt.declared();
  97         checkState(!substatements.isEmpty(), "Refusing to create empty typedef for %s", stmt.declared());
  98
  99         final TypeEffectiveStatement<?> typeEffectiveStmt = findFirstStatement(substatements,
 100             TypeEffectiveStatement.class);
 101         final String dflt = findFirstArgument(substatements, DefaultEffectiveStatement.class, null);
 102         SourceException.throwIf(
 103             EffectiveStmtUtils.hasDefaultValueMarkedWithIfFeature(stmt.yangVersion(), typeEffectiveStmt, dflt), stmt,
 104             "Typedef '%s' has default value '%s' marked with an if-feature statement.", stmt.argument(), dflt);
 105
 106         return new TypedefEffectiveStatementImpl(declared, stmt.wrapSchemaPath(), computeFlags(substatements),
 107             substatements);
 108     }
 109
 110     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
 111         final QName arg = stmt.getArgument();
 112         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(TypeNamespace.class, arg);
 113         // RFC7950 sections 5.5 and 6.2.1: identifiers must not be shadowed
 114         SourceException.throwIf(existing != null, stmt, "Duplicate name for typedef %s", arg);
 115     }
 116
 117     private static void checkDeclared(final StmtContext<QName, TypedefStatement, ?> ctx) {
 118         // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to ensure
 119         // that a typedef in child scope does not shadow a typedef in parent scope which occurs later in the text.
 120         final StmtContext<?, ?, ?> parent = ctx.getParentContext();
 121         if (parent != null) {
 122             final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
 123             if (grandParent != null) {
 124                 checkConflict(grandParent, ctx);
 125             }
 126         }
 127     }
 128
 129     private static int computeFlags(final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 130         return new FlagsBuilder()
 131                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 132                 .toFlags();
 133     }
 134 }