code-generator/binding-data-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/gen/impl/DataNodeContainerSerializerSource.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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  */package org.opendaylight.yangtools.binding.data.codec.gen.impl;
   8
   9 import com.google.common.base.Preconditions;
  10 import java.util.HashMap;
  11 import java.util.Map;
  12 import org.opendaylight.yangtools.binding.data.codec.util.ChoiceDispatchSerializer;
  13 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
  14 import org.opendaylight.yangtools.sal.binding.model.api.MethodSignature;
  15 import org.opendaylight.yangtools.sal.binding.model.api.ParameterizedType;
  16 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  17 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  18 import org.opendaylight.yangtools.yang.binding.BindingSerializer;
  19 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  20 import org.opendaylight.yangtools.yang.binding.DataObject;
  21 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerImplementation;
  22 import org.opendaylight.yangtools.yang.binding.DataObjectSerializerRegistry;
  23 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  27 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
  34
  35 abstract class DataNodeContainerSerializerSource extends DataObjectSerializerSource {
  36
  37     protected static final String INPUT = "_input";
  38     private static final String CHOICE_PREFIX = "CHOICE_";
  39
  40     protected final DataNodeContainer schemaNode;
  41     private final GeneratedType dtoType;
  42
  43     DataNodeContainerSerializerSource(final AbstractGenerator generator, final GeneratedType type, final DataNodeContainer node) {
  44         super(generator);
  45         this.dtoType = Preconditions.checkNotNull(type);
  46         this.schemaNode = Preconditions.checkNotNull(node);
  47     }
  48
  49     /**
  50      * Return the character sequence which should be used for start event.
  51      *
  52      * @return Start event character sequence
  53      */
  54     protected abstract CharSequence emitStartEvent();
  55
  56     @Override
  57     protected CharSequence getSerializerBody() {
  58         final StringBuilder b = new StringBuilder();
  59         b.append("{\n");
  60         b.append(statement(assign(DataObjectSerializerRegistry.class.getName(), REGISTRY, "$1")));
  61         b.append(statement(assign(dtoType.getFullyQualifiedName(), INPUT,
  62                 cast(dtoType.getFullyQualifiedName(), "$2"))));
  63         b.append(statement(assign(BindingStreamEventWriter.class.getName(), STREAM, cast(BindingStreamEventWriter.class.getName(), "$3"))));
  64         b.append(statement(assign(BindingSerializer.class.getName(), SERIALIZER, null)));
  65         b.append("if (");
  66         b.append(STREAM);
  67         b.append(" instanceof ");
  68         b.append(BindingSerializer.class.getName());
  69         b.append(") {");
  70         b.append(statement(assign(SERIALIZER, cast(BindingSerializer.class.getName(), STREAM))));
  71         b.append('}');
  72         b.append(statement(emitStartEvent()));
  73
  74         emitBody(b);
  75         emitAfterBody(b);
  76         b.append(statement(endNode()));
  77         b.append(statement("return null"));
  78         b.append('}');
  79         return b;
  80     }
  81
  82     /**
  83      * Allows for customization of emitting code, which is processed after
  84      * normal DataNodeContainer body. Ideal for augmentations or others.
  85      */
  86     protected void emitAfterBody(final StringBuilder b) {
  87         // No-op
  88     }
  89
  90     private static Map<String, Type> collectAllProperties(final GeneratedType type, final Map<String, Type> hashMap) {
  91         for (final MethodSignature definition : type.getMethodDefinitions()) {
  92             hashMap.put(definition.getName(), definition.getReturnType());
  93         }
  94         for (final Type parent : type.getImplements()) {
  95             if (parent instanceof GeneratedType) {
  96                 collectAllProperties((GeneratedType) parent, hashMap);
  97             }
  98         }
  99         return hashMap;
 100     }
 101
 102     private static final String getGetterName(final DataSchemaNode node) {
 103         final TypeDefinition<?> type ;
 104         if (node instanceof LeafSchemaNode) {
 105             type = ((LeafSchemaNode) node).getType();
 106         } else if(node instanceof LeafListSchemaNode) {
 107             type = ((LeafListSchemaNode) node).getType();
 108         } else {
 109             type = null;
 110         }
 111         String prefix = "get";
 112         if(type != null) {
 113             TypeDefinition<?> rootType = type;
 114             while (rootType.getBaseType() != null) {
 115                 rootType = rootType.getBaseType();
 116             }
 117             if(rootType instanceof BooleanTypeDefinition || rootType instanceof EmptyTypeDefinition) {
 118                 prefix = "is";
 119             }
 120         }
 121
 122         return prefix + BindingMapping.getClassName(node.getQName().getLocalName());
 123     }
 124
 125     private void emitBody(final StringBuilder b) {
 126         final Map<String, Type> getterToType = collectAllProperties(dtoType, new HashMap<String, Type>());
 127         for (final DataSchemaNode schemaChild : schemaNode.getChildNodes()) {
 128             if (!schemaChild.isAugmenting()) {
 129                 final String getter = getGetterName(schemaChild);
 130                 final Type childType = getterToType.get(getter);
 131                 emitChild(b, getter, childType, schemaChild);
 132             }
 133         }
 134     }
 135
 136     private void emitChild(final StringBuilder b, final String getterName, final Type childType,
 137             final DataSchemaNode schemaChild) {
 138         b.append(statement(assign(childType, getterName, cast(childType, invoke(INPUT, getterName)))));
 139
 140         b.append("if (").append(getterName).append(" != null) {\n");
 141         emitChildInner(b, getterName, childType, schemaChild);
 142         b.append("}\n");
 143     }
 144
 145     private void emitChildInner(final StringBuilder b, final String getterName, final Type childType,
 146             final DataSchemaNode child) {
 147         if (child instanceof LeafSchemaNode) {
 148             b.append(statement(leafNode(child.getQName().getLocalName(), getterName)));
 149         } else if (child instanceof AnyXmlSchemaNode) {
 150             b.append(statement(anyxmlNode(child.getQName().getLocalName(), getterName)));
 151         } else if (child instanceof LeafListSchemaNode) {
 152             b.append(statement(startLeafSet(child.getQName().getLocalName(),invoke(getterName, "size"))));
 153             final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
 154             b.append(forEach(getterName, valueType, statement(leafSetEntryNode(CURRENT))));
 155             b.append(statement(endNode()));
 156         } else if (child instanceof ListSchemaNode) {
 157             final Type valueType = ((ParameterizedType) childType).getActualTypeArguments()[0];
 158             final ListSchemaNode casted = (ListSchemaNode) child;
 159             emitList(b, getterName, valueType, casted);
 160         } else if (child instanceof ContainerSchemaNode) {
 161             b.append(tryToUseCacheElse(getterName,statement(staticInvokeEmitter(childType, getterName))));
 162         } else if (child instanceof ChoiceSchemaNode) {
 163             final String propertyName = CHOICE_PREFIX + childType.getName();
 164             staticConstant(propertyName, DataObjectSerializerImplementation.class, ChoiceDispatchSerializer.from(loadClass(childType)));
 165             b.append(tryToUseCacheElse(getterName,statement(invoke(propertyName, StreamWriterGenerator.SERIALIZE_METHOD_NAME, REGISTRY, cast(DataObject.class.getName(),getterName), STREAM))));
 166         }
 167     }
 168
 169     private StringBuilder tryToUseCacheElse(final String getterName, final CharSequence statement) {
 170         final StringBuilder b = new StringBuilder();
 171
 172         b.append("if ( ");
 173         b.append(SERIALIZER).append("== null || ");
 174         b.append(invoke(SERIALIZER, "serialize", getterName)).append("== null");
 175         b.append(") {");
 176         b.append(statement);
 177         b.append("}");
 178         return b;
 179     }
 180
 181     private void emitList(final StringBuilder b, final String getterName, final Type valueType,
 182             final ListSchemaNode child) {
 183         final CharSequence startEvent;
 184
 185         b.append(statement(assign("int", "_count", invoke(getterName, "size"))));
 186         if (child.getKeyDefinition().isEmpty()) {
 187             startEvent = startUnkeyedList(classReference(valueType), "_count");
 188         } else if (child.isUserOrdered()) {
 189             startEvent = startOrderedMapNode(classReference(valueType), "_count");
 190         } else {
 191             startEvent = startMapNode(classReference(valueType), "_count");
 192         }
 193         b.append(statement(startEvent));
 194         b.append(forEach(getterName, valueType, tryToUseCacheElse(CURRENT,statement(staticInvokeEmitter(valueType, CURRENT)))));
 195         b.append(statement(endNode()));
 196     }
 197 }