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 org.opendaylight.yangtools.yang.common.QName;
  11 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  13 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
  14 import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
  15 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  16 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  17 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  18 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  19 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  20 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  21
  22 public final class TypedefStatementSupport extends
  23         AbstractQNameStatementSupport<TypedefStatement, TypedefEffectiveStatement> {
  24     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  25         YangStmtMapping.TYPEDEF)
  26         .addOptional(YangStmtMapping.DEFAULT)
  27         .addOptional(YangStmtMapping.DESCRIPTION)
  28         .addOptional(YangStmtMapping.REFERENCE)
  29         .addOptional(YangStmtMapping.STATUS)
  30         .addMandatory(YangStmtMapping.TYPE)
  31         .addOptional(YangStmtMapping.UNITS)
  32         .build();
  33     private static final TypedefStatementSupport INSTANCE = new TypedefStatementSupport();
  34
  35     private TypedefStatementSupport() {
  36         super(YangStmtMapping.TYPEDEF);
  37     }
  38
  39     public static TypedefStatementSupport getInstance() {
  40         return INSTANCE;
  41     }
  42
  43     @Override
  44     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  45         return StmtContextUtils.parseIdentifier(ctx, value);
  46     }
  47
  48     @Override
  49     public TypedefStatement createDeclared(final StmtContext<QName, TypedefStatement, ?> ctx) {
  50         // Shadowing check: make sure grandparent does not see a conflicting definition. This is required to ensure
  51         // that a typedef in child scope does not shadow a typedef in parent scope which occurs later in the text.
  52         final StmtContext<?, ?, ?> parent = ctx.getParentContext();
  53         if (parent != null) {
  54             final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
  55             if (grandParent != null) {
  56                 checkConflict(grandParent, ctx);
  57             }
  58         }
  59
  60         return new TypedefStatementImpl(ctx);
  61     }
  62
  63     @Override
  64     public TypedefEffectiveStatement createEffective(
  65             final StmtContext<QName, TypedefStatement, TypedefEffectiveStatement> ctx) {
  66         return new TypedefEffectiveStatementImpl(ctx);
  67     }
  68
  69     @Override
  70     public void onFullDefinitionDeclared(final Mutable<QName, TypedefStatement, TypedefEffectiveStatement> stmt) {
  71         super.onFullDefinitionDeclared(stmt);
  72
  73         if (stmt != null) {
  74             final Mutable<?, ?, ?> parent = stmt.getParentContext();
  75             if (parent != null) {
  76                 // Shadowing check: make sure we do not trample on pre-existing definitions. This catches sibling
  77                 // declarations and parent declarations which have already been declared.
  78                 checkConflict(parent, stmt);
  79                 parent.addContext(TypeNamespace.class, stmt.coerceStatementArgument(), stmt);
  80             }
  81         }
  82     }
  83
  84     @Override
  85     protected SubstatementValidator getSubstatementValidator() {
  86         return SUBSTATEMENT_VALIDATOR;
  87     }
  88
  89     private static void checkConflict(final StmtContext<?, ?, ?> parent, final StmtContext<QName, ?, ?> stmt) {
  90         final QName arg = stmt.coerceStatementArgument();
  91         final StmtContext<?, ?, ?> existing = parent.getFromNamespace(TypeNamespace.class, arg);
  92         // RFC7950 sections 5.5 and 6.2.1: identifiers must not be shadowed
  93         SourceException.throwIf(existing != null, stmt.getStatementSourceReference(), "Duplicate name for typedef %s",
  94                 arg);
  95     }
  96 }