Refactor InferenceAction
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / TypeStatementImpl.java
index e96db5e9d836c284cb7b1409853891d70bc9635e..968b93c884a43c44b446779852e9c3ce9d2fde88 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  */
 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
 
-import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
+import com.google.common.base.Verify;
+import com.google.common.collect.ImmutableMap;
+import java.util.Collection;
+import java.util.Map;
+import javax.annotation.Nonnull;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.TypeEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.TypeStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.TypedefStatement;
+import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.IntegerTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.StringTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
+import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
+import org.opendaylight.yangtools.yang.parser.spi.TypeNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
+import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.TypeDefEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.BinaryTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.BitsTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.BooleanTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.BuiltinEffectiveStatements;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.DecimalTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.EmptyTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.EnumTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.IdentityrefTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.InstanceIdentifierTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.IntegerTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.LeafrefTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.StringTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.UnionTypeEffectiveStatementImpl;
+import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.type.UnsignedIntegerTypeEffectiveStatementImpl;
 
-import javax.annotation.Nonnull;
-
-public class TypeStatementImpl extends AbstractDeclaredStatement<String> implements TypeStatement {
+public class TypeStatementImpl extends AbstractDeclaredStatement<String>
+        implements TypeStatement {
+    private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
+            .TYPE)
+            .addOptional(YangStmtMapping.BASE)
+            .addAny(YangStmtMapping.BIT)
+            .addAny(YangStmtMapping.ENUM)
+            .addOptional(YangStmtMapping.FRACTION_DIGITS)
+            .addOptional(YangStmtMapping.LENGTH)
+            .addOptional(YangStmtMapping.PATH)
+            .addAny(YangStmtMapping.PATTERN)
+            .addOptional(YangStmtMapping.RANGE)
+            .addOptional(YangStmtMapping.REQUIRE_INSTANCE)
+            .addAny(YangStmtMapping.TYPE)
+            .build();
 
-    protected TypeStatementImpl(StmtContext<String, TypeStatement, ?> context) {
+    protected TypeStatementImpl(final StmtContext<String, TypeStatement, ?> context) {
         super(context);
     }
 
-    public static class Definition extends AbstractStatementSupport<String,TypeStatement,EffectiveStatement<String,TypeStatement>> {
+    public static class Definition
+            extends
+            AbstractStatementSupport<String, TypeStatement, EffectiveStatement<String, TypeStatement>> {
+
+        private static final Map<String, StatementSupport<?, ?, ?>> ARGUMENT_SPECIFIC_SUPPORTS = ImmutableMap
+                .<String, StatementSupport<?, ?, ?>> builder()
+                .put(TypeUtils.DECIMAL64, new Decimal64SpecificationImpl.Definition())
+                .put(TypeUtils.UNION, new UnionSpecificationImpl.Definition())
+                .put(TypeUtils.ENUMERATION, new EnumSpecificationImpl.Definition())
+                .put(TypeUtils.LEAF_REF, new LeafrefSpecificationImpl.Definition())
+                .put(TypeUtils.BITS, new BitsSpecificationImpl.Definition())
+                .put(TypeUtils.IDENTITY_REF, new IdentityRefSpecificationImpl.Definition())
+                .put(TypeUtils.INSTANCE_IDENTIFIER, new InstanceIdentifierSpecificationImpl.Definition()).build();
 
         public Definition() {
-            super(Rfc6020Mapping.TYPE);
+            super(YangStmtMapping.TYPE);
         }
 
-        @Override public String parseArgumentValue(StmtContext<?, ?, ?> ctx,
-                String value) throws SourceException {
+        @Override
+        public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
             return value;
         }
 
-        @Override public TypeStatement createDeclared(
-                StmtContext<String, TypeStatement, ?> ctx) {
-            return new TypeStatementImpl(ctx);
+        @Override
+        public TypeStatement createDeclared(final StmtContext<String, TypeStatement, ?> ctx) {
+            return BuiltinTypeStatement.maybeReplace(new TypeStatementImpl(ctx));
+        }
+
+        @Override
+        public TypeEffectiveStatement<TypeStatement> createEffective(
+                final StmtContext<String, TypeStatement, EffectiveStatement<String, TypeStatement>> ctx) {
+
+            // First look up the proper base type
+            final TypeEffectiveStatement<TypeStatement> typeStmt;
+            switch (ctx.getStatementArgument()) {
+                case TypeUtils.BINARY:
+                    typeStmt = BuiltinEffectiveStatements.BINARY;
+                    break;
+                case TypeUtils.BOOLEAN:
+                    typeStmt = BuiltinEffectiveStatements.BOOLEAN;
+                    break;
+                case TypeUtils.EMPTY:
+                    typeStmt = BuiltinEffectiveStatements.EMPTY;
+                    break;
+                case TypeUtils.INSTANCE_IDENTIFIER:
+                    typeStmt = BuiltinEffectiveStatements.INSTANCE_IDENTIFIER;
+                    break;
+            case TypeUtils.INT8:
+                typeStmt = BuiltinEffectiveStatements.INT8;
+                break;
+            case TypeUtils.INT16:
+                typeStmt = BuiltinEffectiveStatements.INT16;
+                break;
+            case TypeUtils.INT32:
+                typeStmt = BuiltinEffectiveStatements.INT32;
+                break;
+            case TypeUtils.INT64:
+                typeStmt = BuiltinEffectiveStatements.INT64;
+                break;
+            case TypeUtils.STRING:
+                typeStmt = BuiltinEffectiveStatements.STRING;
+                break;
+            case TypeUtils.UINT8:
+                typeStmt = BuiltinEffectiveStatements.UINT8;
+                break;
+            case TypeUtils.UINT16:
+                typeStmt = BuiltinEffectiveStatements.UINT16;
+                break;
+            case TypeUtils.UINT32:
+                typeStmt = BuiltinEffectiveStatements.UINT32;
+                break;
+            case TypeUtils.UINT64:
+                typeStmt = BuiltinEffectiveStatements.UINT64;
+                break;
+            default:
+                final QName qname = Utils.qNameFromArgument(ctx, ctx.getStatementArgument());
+                final StmtContext<?, TypedefStatement, TypedefEffectiveStatement> typedef =
+                        ctx.getFromNamespace(TypeNamespace.class, qname);
+                SourceException.throwIfNull(typedef, ctx.getStatementSourceReference(), "Type '%s' not found", qname);
+
+                final TypedefEffectiveStatement effectiveTypedef = typedef.buildEffective();
+                Verify.verify(effectiveTypedef instanceof TypeDefEffectiveStatementImpl);
+                typeStmt = ((TypeDefEffectiveStatementImpl) effectiveTypedef).asTypeEffectiveStatement();
+            }
+
+            if (ctx.declaredSubstatements().isEmpty() && ctx.effectiveSubstatements().isEmpty()) {
+                return typeStmt;
+            }
+
+            // Now instantiate the proper effective statement for that type
+            final TypeDefinition<?> baseType = typeStmt.getTypeDefinition();
+            if (baseType instanceof BinaryTypeDefinition) {
+                return new BinaryTypeEffectiveStatementImpl(ctx, (BinaryTypeDefinition) baseType);
+            } else if (baseType instanceof BitsTypeDefinition) {
+                return new BitsTypeEffectiveStatementImpl(ctx, (BitsTypeDefinition) baseType);
+            } else if (baseType instanceof BooleanTypeDefinition) {
+                return new BooleanTypeEffectiveStatementImpl(ctx, (BooleanTypeDefinition) baseType);
+            } else if (baseType instanceof DecimalTypeDefinition) {
+                return new DecimalTypeEffectiveStatementImpl(ctx, (DecimalTypeDefinition) baseType);
+            } else if (baseType instanceof EmptyTypeDefinition) {
+                return new EmptyTypeEffectiveStatementImpl(ctx, (EmptyTypeDefinition) baseType);
+            } else if (baseType instanceof EnumTypeDefinition) {
+                return new EnumTypeEffectiveStatementImpl(ctx, (EnumTypeDefinition) baseType);
+            } else if (baseType instanceof IdentityrefTypeDefinition) {
+                return new IdentityrefTypeEffectiveStatementImpl(ctx, (IdentityrefTypeDefinition) baseType);
+            } else if (baseType instanceof InstanceIdentifierTypeDefinition) {
+                return new InstanceIdentifierTypeEffectiveStatementImpl(ctx, (InstanceIdentifierTypeDefinition) baseType);
+            } else if (baseType instanceof IntegerTypeDefinition) {
+                return new IntegerTypeEffectiveStatementImpl(ctx, (IntegerTypeDefinition) baseType);
+            } else if (baseType instanceof LeafrefTypeDefinition) {
+                return new LeafrefTypeEffectiveStatementImpl(ctx, (LeafrefTypeDefinition) baseType);
+            } else if (baseType instanceof StringTypeDefinition) {
+                return new StringTypeEffectiveStatementImpl(ctx, (StringTypeDefinition) baseType);
+            } else if (baseType instanceof UnionTypeDefinition) {
+                return new UnionTypeEffectiveStatementImpl(ctx, (UnionTypeDefinition) baseType);
+            } else if (baseType instanceof UnsignedIntegerTypeDefinition) {
+                return new UnsignedIntegerTypeEffectiveStatementImpl(ctx, (UnsignedIntegerTypeDefinition) baseType);
+            } else {
+                throw new IllegalStateException("Unhandled base type " + baseType);
+            }
+        }
+
+        @Override
+        public void onFullDefinitionDeclared(
+                final Mutable<String, TypeStatement, EffectiveStatement<String, TypeStatement>> stmt) {
+            super.onFullDefinitionDeclared(stmt);
+
+            // if it is yang built-in type, no prerequisite is needed, so simply return
+            if (TypeUtils.isYangBuiltInTypeString(stmt.getStatementArgument())) {
+                return;
+            }
+
+            final QName typeQName = Utils.qNameFromArgument(stmt, stmt.getStatementArgument());
+            final ModelActionBuilder typeAction = stmt.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
+            final Prerequisite<StmtContext<?, ?, ?>> typePrereq = typeAction.requiresCtx(stmt, TypeNamespace.class,
+                    typeQName, ModelProcessingPhase.EFFECTIVE_MODEL);
+            typeAction.mutatesEffectiveCtx(stmt.getParentContext());
+
+            /*
+             * If the type does not exist, throw new InferenceException.
+             * Otherwise perform no operation.
+             */
+            typeAction.apply(new InferenceAction() {
+                @Override
+                public void apply(final InferenceContext ctx) {
+                    // Intentional NOOP
+                }
+
+                @Override
+                public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
+                    InferenceException.throwIf(failed.contains(typePrereq), stmt.getStatementSourceReference(),
+                        "Type [%s] was not found.", typeQName);
+                }
+            });
+        }
+
+        @Override
+        protected SubstatementValidator getSubstatementValidator() {
+            return SUBSTATEMENT_VALIDATOR;
+        }
+
+        @Override
+        public boolean hasArgumentSpecificSupports() {
+            return !ARGUMENT_SPECIFIC_SUPPORTS.isEmpty();
+        }
+
+        @Override
+        public StatementSupport<?, ?, ?> getSupportSpecificForArgument(final String argument) {
+            return ARGUMENT_SPECIFIC_SUPPORTS.get(argument);
         }
 
-        @Override public EffectiveStatement<String, TypeStatement> createEffective(
-                StmtContext<String, TypeStatement, EffectiveStatement<String, TypeStatement>> ctx) {
-            throw new UnsupportedOperationException();
+        @Override
+        public String internArgument(final String rawArgument) {
+            final String found = TypeUtils.findBuiltinString(rawArgument);
+            return found != null ? found : rawArgument;
         }
     }
 
-    @Nonnull @Override
+    @Nonnull
+    @Override
     public String getName() {
         return argument();
     }