binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/util/DefaultSourceCodeGenerator.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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  */
   8
   9 package org.opendaylight.mdsal.binding.generator.util;
  10
  11 import com.google.common.io.Files;
  12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  13 import java.io.BufferedWriter;
  14 import java.io.File;
  15 import java.io.IOException;
  16 import java.nio.charset.StandardCharsets;
  17 import javassist.CtClass;
  18 import javassist.CtField;
  19 import javassist.CtMethod;
  20 import javassist.Modifier;
  21 import javassist.NotFoundException;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 /**
  26  * The default implementation of the SourceCodeGenerator interface that generates readable source code
  27  * for a runtime generated class. The appendField/appendMethod methods output source code to a temporary
  28  * StringBuilder. When outputGeneratedSource is called, the entire class source code is generated and
  29  * written to a file under a specified directory.
  30  *
  31  * @author Thomas Pantelis
  32  */
  33 public class DefaultSourceCodeGenerator implements SourceCodeGenerator {
  34     private static final Logger LOG = LoggerFactory.getLogger(DefaultSourceCodeGenerator.class);
  35
  36     private static final String GENERATED_SOURCE_DIR_PROP = "org.opendaylight.yangtools.sal.generatedCodecSourceDir";
  37
  38     private final StringBuilder builder = new StringBuilder();
  39     private final String generatedSourceDir;
  40
  41     /**
  42      * Constructor.
  43      *
  44      * @param generatedSourceDir the directory in which to put generated source files. If null, the directory
  45      *     is obtained from a system property (<i>org.opendaylight.yangtools.sal.generatedCodecSourceDir</i>) or
  46      *     defaults to "generated-codecs".
  47      */
  48     public DefaultSourceCodeGenerator(final String generatedSourceDir) {
  49         if (generatedSourceDir != null) {
  50             this.generatedSourceDir = generatedSourceDir;
  51         } else {
  52             this.generatedSourceDir = System.getProperty(GENERATED_SOURCE_DIR_PROP, "generated-codecs");
  53         }
  54     }
  55
  56     @Override
  57     public void appendField(final CtField field, final String value) {
  58         try {
  59             builder.append('\n')
  60                     .append(Modifier.toString(field.getModifiers()))
  61                     .append(' ').append(field.getType().getName()).append(' ')
  62                     .append(field.getName());
  63             if (value != null) {
  64                 builder.append(" = ").append(value);
  65             }
  66
  67             builder.append(";\n");
  68         } catch (NotFoundException e) {
  69             LOG.error("Error building field source for {}", field.getName(), e);
  70         }
  71     }
  72
  73     @Override
  74     public void appendMethod(final CtMethod method, final String code) {
  75         try {
  76             builder.append('\n')
  77                     .append(Modifier.toString(method.getModifiers()))
  78                     .append(' ').append(method.getReturnType().getName())
  79                     .append(' ').append(method.getName()).append("( ");
  80
  81             CtClass[] paramTypes = method.getParameterTypes();
  82             if (paramTypes != null) {
  83                 for (int i = 0; i < paramTypes.length; i++) {
  84                     if (i > 0) {
  85                         builder.append(", ");
  86                     }
  87                     builder.append(paramTypes[i].getName()).append(" $")
  88                             .append(i + 1);
  89                 }
  90             }
  91
  92             builder.append(" )\n").append(code).append("\n\n");
  93         } catch (NotFoundException e) {
  94             LOG.error("Error building method source for {}", method.getName(), e);
  95         }
  96     }
  97
  98     @Override
  99     @SuppressFBWarnings("RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE")
 100     public void outputGeneratedSource(final CtClass ctClass) {
 101         String name = ctClass.getName();
 102
 103         StringBuilder classBuilder = new StringBuilder();
 104         classBuilder.append(Modifier.toString(ctClass.getModifiers()))
 105                 .append(" class ").append(ctClass.getSimpleName());
 106
 107         try {
 108             CtClass superClass = ctClass.getSuperclass();
 109             if (superClass != null) {
 110                 classBuilder.append(" extends ").append(superClass.getName());
 111             }
 112
 113             CtClass[] interfaces = ctClass.getInterfaces();
 114             if (interfaces.length > 0) {
 115                 classBuilder.append(" implements ");
 116                 for (int i = 0; i < interfaces.length; i++) {
 117                     if (i > 0) {
 118                         classBuilder.append(", ");
 119                     }
 120
 121                     classBuilder.append(interfaces[i].getName());
 122                 }
 123             }
 124
 125             classBuilder.append(" {\n").append(builder).append("\n}");
 126         } catch (NotFoundException e) {
 127             LOG.error("Error building class source for {}", name, e);
 128             return;
 129         }
 130
 131         File dir = new File(generatedSourceDir);
 132         if (!dir.mkdir()) {
 133             LOG.warn("Failed to create directory {}, attempting to continue", generatedSourceDir);
 134         }
 135
 136         try (BufferedWriter writer = Files.newWriter(new File(dir, name + ".java"), StandardCharsets.UTF_8)) {
 137             writer.append(classBuilder);
 138             writer.flush();
 139         } catch (IOException e) {
 140             LOG.error("Error writing class source for {}", name, e);
 141         }
 142     }
 143 }