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.java.api.generator
10 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getClassName
11 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getRootPackageName
12 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODEL_BINDING_PROVIDER_CLASS_NAME
13 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODULE_INFO_CLASS_NAME
14 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.MODULE_INFO_QNAMEOF_METHOD_NAME
16 import com.google.common.base.Preconditions
17 import com.google.common.collect.ImmutableSet
18 import java.util.Comparator
19 import java.util.HashSet
20 import java.util.Optional
22 import java.util.TreeMap
23 import java.util.function.Function
24 import org.eclipse.xtend.lib.annotations.Accessors
25 import org.opendaylight.yangtools.yang.binding.YangModuleInfo
26 import org.opendaylight.yangtools.yang.common.Revision
27 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext
28 import org.opendaylight.yangtools.yang.model.api.Module
29 import org.opendaylight.yangtools.yang.model.api.ModuleLike
30 import org.opendaylight.yangtools.yang.model.api.Submodule
33 * Template for {@link YangModuleInfo} implementation for a particular module. Aside from fulfilling that contract,
34 * this class provides a static {@code createQName(String)} method, which is used by co-generated code to initialize
37 final class YangModuleInfoTemplate {
38 static val Comparator<Optional<Revision>> REVISION_COMPARATOR =
39 [ Optional<Revision> first, Optional<Revision> second | Revision.compare(first, second) ]
41 // These are always imported. Note we need to import even java.lang members, as there can be conflicting definitions
43 static val CORE_IMPORT_STR = '''
44 import com.google.common.collect.ImmutableSet;
45 import java.lang.Override;
46 import java.lang.String;
47 import org.eclipse.jdt.annotation.NonNull;
48 import org.opendaylight.yangtools.yang.binding.ResourceYangModuleInfo;
49 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
50 import org.opendaylight.yangtools.yang.common.QName;
52 static val EXT_IMPORT_STR = '''
53 import com.google.common.collect.ImmutableSet;
54 import java.lang.Override;
55 import java.lang.String;
56 import java.util.HashSet;
58 import org.eclipse.jdt.annotation.NonNull;
59 import org.opendaylight.yangtools.yang.binding.ResourceYangModuleInfo;
60 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
61 import org.opendaylight.yangtools.yang.common.QName;
65 val EffectiveModelContext ctx
66 val Function<ModuleLike, Optional<String>> moduleFilePathResolver
68 var importedTypes = CORE_IMPORT_STR
71 val String packageName
74 val String modelBindingProviderName
76 new(Module module, EffectiveModelContext ctx, Function<ModuleLike, Optional<String>> moduleFilePathResolver) {
77 Preconditions.checkArgument(module !== null, "Module must not be null.")
80 this.moduleFilePathResolver = moduleFilePathResolver
81 packageName = module.QNameModule.rootPackageName;
82 modelBindingProviderName = '''«packageName».«MODEL_BINDING_PROVIDER_CLASS_NAME»'''
85 def String generate() {
86 val Set<Submodule> submodules = new HashSet
87 collectSubmodules(submodules, module)
91 * The {@link ResourceYangModuleInfo} for {@code «module.name»} module.
93 @«JavaFileTemplate.GENERATED»("mdsal-binding-generator")
94 public final class «MODULE_INFO_CLASS_NAME» extends ResourceYangModuleInfo {
95 «val rev = module.revision»
96 private static final @NonNull QName NAME = QName.create("«module.QNameModule.namespace.toString»", «IF rev.present»"«rev.get.toString»", «ENDIF»"«module.name»").intern();
97 private static final @NonNull YangModuleInfo INSTANCE = new «MODULE_INFO_CLASS_NAME»();
99 private final @NonNull ImmutableSet<YangModuleInfo> importedModules;
102 * Return the singleton instance of this class.
104 * @return The singleton instance
106 public static @NonNull YangModuleInfo getInstance() {
111 * Create an interned {@link QName} with specified {@code localName} and namespace/revision of this
114 * @param localName local name
116 * @throws NullPointerException if {@code localName} is null
117 * @throws IllegalArgumentException if localName is not a valid YANG identifier
119 public static @NonNull QName «MODULE_INFO_QNAMEOF_METHOD_NAME»(final String localName) {
120 return QName.create(NAME, localName).intern();
123 «classBody(module, MODULE_INFO_CLASS_NAME, submodules)»
127 package «packageName»;
135 def String generateModelProvider() '''
136 package «packageName»;
138 import java.lang.Override;
139 import java.util.ServiceLoader;
140 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
141 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
144 * The {@link YangModelBindingProvider} for {@code «module.name»} module. This class should not be used
145 * directly, but rather through {@link ServiceLoader}.
147 @«JavaFileTemplate.GENERATED»("mdsal-binding-generator")
148 public final class «MODEL_BINDING_PROVIDER_CLASS_NAME» implements YangModelBindingProvider {
150 * Construct a new provider.
152 public «MODEL_BINDING_PROVIDER_CLASS_NAME»() {
157 public YangModuleInfo getModuleInfo() {
158 return «MODULE_INFO_CLASS_NAME».getInstance();
163 private static def void collectSubmodules(Set<Submodule> dest, ModuleLike module) {
164 for (Submodule submodule : module.submodules) {
165 if (dest.add(submodule)) {
166 collectSubmodules(dest, submodule)
171 private def CharSequence classBody(ModuleLike m, String className, Set<Submodule> submodules) '''
172 private «className»() {
173 «IF !m.imports.empty || !submodules.empty»
175 Set<YangModuleInfo> set = new HashSet<>();
177 «IF !m.imports.empty»
178 «FOR imp : m.imports»
179 «val name = imp.moduleName.localName»
180 «val rev = imp.revision»
182 «val TreeMap<Optional<Revision>, Module> sorted = new TreeMap(REVISION_COMPARATOR)»
183 «FOR module : ctx.modules»
184 «IF name.equals(module.name)»
185 «sorted.put(module.revision, module)»
188 set.add(«sorted.lastEntry().value.QNameModule.rootPackageName».«MODULE_INFO_CLASS_NAME».getInstance());
190 set.add(«(ctx.findModule(name, rev).orElseThrow.QNameModule).rootPackageName».«MODULE_INFO_CLASS_NAME».getInstance());
194 «FOR submodule : submodules»
195 set.add(«submodule.name.className»Info.getInstance());
197 «IF m.imports.empty && submodules.empty»
198 importedModules = ImmutableSet.of();
200 importedModules = ImmutableSet.copyOf(set);
205 public QName getName() {
210 protected String resourceName() {
211 return "«sourcePath(m)»";
215 public ImmutableSet<YangModuleInfo> getImportedModules() {
216 return importedModules;
218 «generateSubInfo(submodules)»
221 private def void extendImports() {
222 importedTypes = EXT_IMPORT_STR
225 private def sourcePath(ModuleLike module) {
226 val opt = moduleFilePathResolver.apply(module)
227 Preconditions.checkState(opt.isPresent, "Module %s does not have a file path", module)
231 private def generateSubInfo(Set<Submodule> submodules) '''
232 «FOR submodule : submodules»
233 «val className = submodule.name.className»
235 private static final class «className»Info extends ResourceYangModuleInfo {
236 «val rev = submodule.revision»
237 private final @NonNull QName NAME = QName.create("«submodule.QNameModule.namespace.toString»", «
238 IF rev.present»"«rev.get.toString»", «ENDIF»"«submodule.name»").intern();
239 private static final @NonNull YangModuleInfo INSTANCE = new «className»Info();
241 private final @NonNull ImmutableSet<YangModuleInfo> importedModules;
243 public static @NonNull YangModuleInfo getInstance() {
247 «classBody(submodule, className + "Info", ImmutableSet.of)»