code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/maven/sal/api/gen/plugin/CodeGeneratorImpl.java

   1 /*
   2  * Copyright (c) 2013 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  */
   8 package org.opendaylight.yangtools.maven.sal.api.gen.plugin;
   9
  10 import java.io.BufferedWriter;
  11 import java.io.File;
  12 import java.io.IOException;
  13 import java.io.OutputStream;
  14 import java.io.OutputStreamWriter;
  15 import java.io.Writer;
  16 import java.util.Collection;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Set;
  20
  21 import org.apache.maven.plugin.logging.Log;
  22 import org.apache.maven.project.MavenProject;
  23 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
  24 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
  25 import org.opendaylight.yangtools.sal.binding.generator.impl.BindingGeneratorImpl;
  26 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  27 import org.opendaylight.yangtools.sal.java.api.generator.GeneratorJavaFile;
  28 import org.opendaylight.yangtools.sal.java.api.generator.YangModuleInfoTemplate;
  29 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  30 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  31 import org.opendaylight.yangtools.yang.model.api.Module;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
  34 import org.opendaylight.yangtools.yang2sources.spi.CodeGenerator;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.sonatype.plexus.build.incremental.BuildContext;
  38
  39 import com.google.common.base.Joiner;
  40 import com.google.common.base.Preconditions;
  41 import com.google.common.collect.ImmutableSet;
  42 import com.google.common.collect.ImmutableSet.Builder;
  43
  44 public final class CodeGeneratorImpl implements CodeGenerator, BuildContextAware {
  45     private static final String FS = File.separator;
  46     private BuildContext buildContext;
  47     private File projectBaseDir;
  48     private Map<String, String> additionalConfig;
  49
  50     private static final Logger logger = LoggerFactory.getLogger(CodeGeneratorImpl.class);
  51     private MavenProject mavenProject;
  52     private File resourceBaseDir;
  53
  54     @Override
  55     public Collection<File> generateSources(final SchemaContext context, final File outputDir,
  56             final Set<Module> yangModules) throws IOException {
  57         final File outputBaseDir;
  58
  59         outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
  60
  61         final BindingGenerator bindingGenerator = new BindingGeneratorImpl();
  62         final List<Type> types = bindingGenerator.generateTypes(context, yangModules);
  63         final GeneratorJavaFile generator = new GeneratorJavaFile(buildContext, types);
  64
  65         File persistentSourcesDir = null;
  66         if (additionalConfig != null) {
  67             String persistenSourcesPath = additionalConfig.get("persistentSourcesDir");
  68             if (persistenSourcesPath != null) {
  69                 persistentSourcesDir = new File(persistenSourcesPath);
  70             }
  71         }
  72         if (persistentSourcesDir == null) {
  73             persistentSourcesDir = new File(projectBaseDir, "src" + FS + "main" + FS + "java");
  74         }
  75
  76         List<File> result = generator.generateToFile(outputBaseDir, persistentSourcesDir);
  77
  78         result.addAll(generateModuleInfos(outputBaseDir, yangModules, context));
  79         return result;
  80     }
  81
  82     private Collection<? extends File> generateModuleInfos(File outputBaseDir, Set<Module> yangModules,
  83             SchemaContext context) {
  84         Builder<File> result = ImmutableSet.builder();
  85         Builder<String> bindingProviders = ImmutableSet.builder();
  86         for (Module module : yangModules) {
  87             result.addAll(generateYangModuleInfo(outputBaseDir, module, context, bindingProviders));
  88         }
  89
  90         result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
  91         return result.build();
  92     }
  93
  94     private File writeMetaInfServices(File outputBaseDir, Class<YangModelBindingProvider> serviceClass,
  95             ImmutableSet<String> services) {
  96         File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
  97         metainfServicesFolder.mkdirs();
  98         File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
  99
 100         String src = Joiner.on('\n').join(services);
 101
 102         return writeFile(serviceFile, src);
 103     }
 104
 105     public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
 106             + File.separator + "maven-sal-api-gen";
 107
 108     private File getDefaultOutputBaseDir() {
 109         File outputBaseDir;
 110         outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
 111         setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
 112         logger.debug("Adding " + outputBaseDir.getPath() + " as compile source root");
 113         return outputBaseDir;
 114     }
 115
 116     private static void setOutputBaseDirAsSourceFolder(File outputBaseDir, MavenProject mavenProject) {
 117         Preconditions.checkNotNull(mavenProject, "Maven project needs to be set in this phase");
 118         mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
 119     }
 120
 121     @Override
 122     public void setLog(Log log) {
 123     }
 124
 125     @Override
 126     public void setAdditionalConfig(Map<String, String> additionalConfiguration) {
 127         this.additionalConfig = additionalConfiguration;
 128     }
 129
 130     @Override
 131     public void setResourceBaseDir(File resourceBaseDir) {
 132         this.resourceBaseDir = resourceBaseDir;
 133     }
 134
 135     @Override
 136     public void setMavenProject(MavenProject project) {
 137         this.mavenProject = project;
 138         this.projectBaseDir = project.getBasedir();
 139     }
 140
 141     @Override
 142     public void setBuildContext(BuildContext buildContext) {
 143         this.buildContext = Preconditions.checkNotNull(buildContext);
 144     }
 145
 146     private Set<File> generateYangModuleInfo(File outputBaseDir, Module module, SchemaContext ctx,
 147             Builder<String> providerSourceSet) {
 148         Builder<File> generatedFiles = ImmutableSet.<File> builder();
 149
 150         final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx);
 151         String moduleInfoSource = template.generate();
 152         if (moduleInfoSource.isEmpty()) {
 153             throw new IllegalStateException("Generated code should not be empty!");
 154         }
 155         String providerSource = template.generateModelProvider();
 156
 157         final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
 158                 BindingGeneratorUtil.moduleNamespaceToPackageName(module));
 159
 160         generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
 161         generatedFiles
 162                 .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
 163         providerSourceSet.add(template.getModelBindingProviderName());
 164
 165         return generatedFiles.build();
 166
 167     }
 168
 169     private File writeJavaSource(File packageDir, String className, String source) {
 170         if (!packageDir.exists()) {
 171             packageDir.mkdirs();
 172         }
 173         final File file = new File(packageDir, className + ".java");
 174         writeFile(file, source);
 175         return file;
 176     }
 177
 178     private File writeFile(File file, String source) {
 179         try (final OutputStream stream = buildContext.newFileOutputStream(file)) {
 180             try (final Writer fw = new OutputStreamWriter(stream)) {
 181                 try (final BufferedWriter bw = new BufferedWriter(fw)) {
 182                     bw.write(source);
 183                 }
 184             } catch (Exception e) {
 185                 logger.error("Could not write file: {}",file,e);
 186             }
 187         } catch (Exception e) {
 188             logger.error("Could not create file: {}",file,e);
 189         }
 190         return file;
 191     }
 192
 193 }