2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.binding.maven.api.gen.plugin;
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 import java.io.BufferedWriter;
16 import java.io.IOException;
17 import java.io.OutputStream;
18 import java.io.OutputStreamWriter;
19 import java.io.Writer;
20 import java.nio.charset.StandardCharsets;
21 import java.util.Collection;
22 import java.util.List;
24 import java.util.Optional;
26 import java.util.function.Function;
27 import org.apache.maven.project.MavenProject;
28 import org.opendaylight.mdsal.binding.generator.api.BindingGenerator;
29 import org.opendaylight.mdsal.binding.generator.impl.BindingGeneratorImpl;
30 import org.opendaylight.mdsal.binding.java.api.generator.GeneratorJavaFile;
31 import org.opendaylight.mdsal.binding.java.api.generator.YangModuleInfoTemplate;
32 import org.opendaylight.mdsal.binding.model.api.Type;
33 import org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil;
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.BasicCodeGenerator;
39 import org.opendaylight.yangtools.yang2sources.spi.BuildContextAware;
40 import org.opendaylight.yangtools.yang2sources.spi.MavenProjectAware;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.sonatype.plexus.build.incremental.BuildContext;
45 public final class CodeGeneratorImpl implements BasicCodeGenerator, BuildContextAware, MavenProjectAware {
46 private static final Logger LOG = LoggerFactory.getLogger(CodeGeneratorImpl.class);
47 private static final String FS = File.separator;
48 private BuildContext buildContext;
49 private File projectBaseDir;
50 private Map<String, String> additionalConfig;
51 private MavenProject mavenProject;
52 private File resourceBaseDir;
55 public Collection<File> generateSources(final SchemaContext context, final File outputDir,
56 final Set<Module> yangModules, final Function<Module, Optional<String>> moduleResourcePathResolver)
58 final File outputBaseDir;
60 outputBaseDir = outputDir == null ? getDefaultOutputBaseDir() : outputDir;
62 final BindingGenerator bindingGenerator = new BindingGeneratorImpl(true);
63 final List<Type> types = bindingGenerator.generateTypes(context, yangModules);
64 final GeneratorJavaFile generator = new GeneratorJavaFile(buildContext, types);
66 File persistentSourcesDir = null;
67 if (additionalConfig != null) {
68 String persistenSourcesPath = additionalConfig.get("persistentSourcesDir");
69 if (persistenSourcesPath != null) {
70 persistentSourcesDir = new File(persistenSourcesPath);
73 if (persistentSourcesDir == null) {
74 persistentSourcesDir = new File(projectBaseDir, "src" + FS + "main" + FS + "java");
77 List<File> result = generator.generateToFile(outputBaseDir, persistentSourcesDir);
79 result.addAll(generateModuleInfos(outputBaseDir, yangModules, context, moduleResourcePathResolver));
83 private Collection<? extends File> generateModuleInfos(final File outputBaseDir, final Set<Module> yangModules,
84 final SchemaContext context, final Function<Module, Optional<String>> moduleResourcePathResolver) {
85 Builder<File> result = ImmutableSet.builder();
86 Builder<String> bindingProviders = ImmutableSet.builder();
87 for (Module module : yangModules) {
88 Builder<String> currentProvidersBuilder = ImmutableSet.builder();
89 // TODO: do not mutate parameters, output of a method is defined by its return value
90 Set<File> moduleInfoProviders = generateYangModuleInfo(outputBaseDir, module, context,
91 moduleResourcePathResolver, currentProvidersBuilder);
92 ImmutableSet<String> currentProviders = currentProvidersBuilder.build();
93 LOG.info("Adding ModuleInfo providers {}", currentProviders);
94 bindingProviders.addAll(currentProviders);
95 result.addAll(moduleInfoProviders);
98 result.add(writeMetaInfServices(resourceBaseDir, YangModelBindingProvider.class, bindingProviders.build()));
99 return result.build();
102 private File writeMetaInfServices(final File outputBaseDir, final Class<YangModelBindingProvider> serviceClass,
103 final ImmutableSet<String> services) {
104 File metainfServicesFolder = new File(outputBaseDir, "META-INF" + File.separator + "services");
105 metainfServicesFolder.mkdirs();
106 File serviceFile = new File(metainfServicesFolder, serviceClass.getName());
108 String src = Joiner.on('\n').join(services);
110 return writeFile(serviceFile, src);
113 public static final String DEFAULT_OUTPUT_BASE_DIR_PATH = "target" + File.separator + "generated-sources"
114 + File.separator + "maven-sal-api-gen";
116 private File getDefaultOutputBaseDir() {
118 outputBaseDir = new File(DEFAULT_OUTPUT_BASE_DIR_PATH);
119 setOutputBaseDirAsSourceFolder(outputBaseDir, mavenProject);
120 LOG.debug("Adding " + outputBaseDir.getPath() + " as compile source root");
121 return outputBaseDir;
124 private static void setOutputBaseDirAsSourceFolder(final File outputBaseDir, final MavenProject mavenProject) {
125 Preconditions.checkNotNull(mavenProject, "Maven project needs to be set in this phase");
126 mavenProject.addCompileSourceRoot(outputBaseDir.getPath());
130 public void setAdditionalConfig(final Map<String, String> additionalConfiguration) {
131 this.additionalConfig = additionalConfiguration;
135 public void setResourceBaseDir(final File resourceBaseDir) {
136 this.resourceBaseDir = resourceBaseDir;
140 public void setMavenProject(final MavenProject project) {
141 this.mavenProject = project;
142 this.projectBaseDir = project.getBasedir();
146 public void setBuildContext(final BuildContext buildContext) {
147 this.buildContext = Preconditions.checkNotNull(buildContext);
150 private Set<File> generateYangModuleInfo(final File outputBaseDir, final Module module, final SchemaContext ctx,
151 final Function<Module, Optional<String>> moduleResourcePathResolver,
152 final Builder<String> providerSourceSet) {
153 Builder<File> generatedFiles = ImmutableSet.builder();
155 final YangModuleInfoTemplate template = new YangModuleInfoTemplate(module, ctx, moduleResourcePathResolver);
156 String moduleInfoSource = template.generate();
157 if (moduleInfoSource.isEmpty()) {
158 throw new IllegalStateException("Generated code should not be empty!");
160 String providerSource = template.generateModelProvider();
162 final File packageDir = GeneratorJavaFile.packageToDirectory(outputBaseDir,
163 BindingGeneratorUtil.moduleNamespaceToPackageName(module));
165 generatedFiles.add(writeJavaSource(packageDir, BindingMapping.MODULE_INFO_CLASS_NAME, moduleInfoSource));
167 .add(writeJavaSource(packageDir, BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME, providerSource));
168 providerSourceSet.add(template.getModelBindingProviderName());
170 return generatedFiles.build();
174 private File writeJavaSource(final File packageDir, final String className, final String source) {
175 if (!packageDir.exists()) {
178 final File file = new File(packageDir, className + ".java");
179 writeFile(file, source);
183 @SuppressWarnings("checkstyle:illegalCatch")
184 private File writeFile(final File file, final String source) {
185 try (OutputStream stream = buildContext.newFileOutputStream(file)) {
186 try (Writer fw = new OutputStreamWriter(stream, StandardCharsets.UTF_8)) {
187 try (BufferedWriter bw = new BufferedWriter(fw)) {
190 } catch (Exception e) {
191 LOG.error("Could not write file: {}",file,e);
193 } catch (Exception e) {
194 LOG.error("Could not create file: {}",file,e);