99f426dcc68c888492f3f730cbab95e8e7e9469d
[yangtools.git] / 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 com.google.common.base.Joiner;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableSet;
13 import com.google.common.collect.ImmutableSet.Builder;
14
15 import java.io.BufferedWriter;
16 import java.io.File;
17 import java.io.IOException;
18 import java.io.OutputStream;
19 import java.io.OutputStreamWriter;
20 import java.io.Writer;
21 import java.util.Collection;
22 import java.util.List;
23 import java.util.Map;
24 import java.util.Set;
25
26 import org.apache.maven.plugin.logging.Log;
27 import org.apache.maven.project.MavenProject;
28 import org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil;
29 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
30 import org.opendaylight.yangtools.sal.binding.generator.impl.BindingGeneratorImpl;
31 import org.opendaylight.yangtools.sal.binding.model.api.Type;
32 import org.opendaylight.yangtools.sal.java.api.generator.GeneratorJavaFile;
33 import org.opendaylight.yangtools.sal.java.api.generator.YangModuleInfoTemplate;
34 import org.opendaylight.yangtools.yang.binding.BindingMapping;
35 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
36 import org.opendaylight.yangtools.yang.model.api.Module;
37 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
38 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
39 import org.opendaylight.yangtools.yang2sources.spi.CodeGenerator;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import org.sonatype.plexus.build.incremental.BuildContext;
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(true);
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(final File outputBaseDir, final Set<Module> yangModules,
83                                                            final SchemaContext context) {
84         Builder<File> result = ImmutableSet.builder();
85         Builder<String> bindingProviders = ImmutableSet.builder();
86         for (Module module : yangModules) {
87             Builder<String> currentProvidersBuilder = ImmutableSet.builder();
88             // TODO: do not mutate parameters, output of a method is defined by its return value
89             Set<File> moduleInfoProviders = generateYangModuleInfo(outputBaseDir, module, context, currentProvidersBuilder);
90             ImmutableSet<String> currentProviders = currentProvidersBuilder.build();
91             logger.info("Adding ModuleInfo providers {}", currentProviders);
92             bindingProviders.addAll(currentProviders);
93             result.addAll(moduleInfoProviders);
94         }
95
96         result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
97         return result.build();
98     }
99
100     private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
101             final ImmutableSet<String> services) {
102         File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
103         metainfServicesFolder.mkdirs();
104         File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
105
106         String src = Joiner.on('\n').join(services);
107
108         return writeFile(serviceFile, src);
109     }
110
111     public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
112             + File.separator + "maven-sal-api-gen";
113
114     private File getDefaultOutputBaseDir() {
115         File outputBaseDir;
116         outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
117         setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
118         logger.debug("Adding " + outputBaseDir.getPath() + " as compile source root");
119         return outputBaseDir;
120     }
121
122     private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
123         Preconditions.checkNotNull(mavenProject, "Maven project needs to be set in this phase");
124         mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
125     }
126
127     @Override
128     public void setLog(final Log log) {
129     }
130
131     @Override
132     public void setAdditionalConfig(final Map<String, String> additionalConfiguration) {
133         this.additionalConfig = additionalConfiguration;
134     }
135
136     @Override
137     public void setResourceBaseDir(final File resourceBaseDir) {
138         this.resourceBaseDir = resourceBaseDir;
139     }
140
141     @Override
142     public void setMavenProject(final MavenProject project) {
143         this.mavenProject = project;
144         this.projectBaseDir = project.getBasedir();
145     }
146
147     @Override
148     public void setBuildContext(final BuildContext buildContext) {
149         this.buildContext = Preconditions.checkNotNull(buildContext);
150     }
151
152     private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module, final SchemaContext ctx,
153             final Builder<String> providerSourceSet) {
154         Builder<File> generatedFiles = ImmutableSet.<File> builder();
155
156         final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx);
157         String moduleInfoSource = template.generate();
158         if (moduleInfoSource.isEmpty()) {
159             throw new IllegalStateException("Generated code should not be empty!");
160         }
161         String providerSource = template.generateModelProvider();
162
163         final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
164                 BindingGeneratorUtil.moduleNamespaceToPackageName(module));
165
166         generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
167         generatedFiles
168                 .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
169         providerSourceSet.add(template.getModelBindingProviderName());
170
171         return generatedFiles.build();
172
173     }
174
175     private File writeJavaSource(final File packageDir, final String className, final String source) {
176         if (!packageDir.exists()) {
177             packageDir.mkdirs();
178         }
179         final File file = new File(packageDir, className + ".java");
180         writeFile(file, source);
181         return file;
182     }
183
184     private File writeFile(final File file, final String source) {
185         try (final OutputStream stream = buildContext.newFileOutputStream(file)) {
186             try (final Writer fw = new OutputStreamWriter(stream)) {
187                 try (final BufferedWriter bw = new BufferedWriter(fw)) {
188                     bw.write(source);
189                 }
190             } catch (Exception e) {
191                 logger.error("Could not write file: {}",file,e);
192             }
193         } catch (Exception e) {
194             logger.error("Could not create file: {}",file,e);
195         }
196         return file;
197     }
198
199 }