import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Verify.verify;
import static java.util.Objects.requireNonNull;
-import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME;
+import static org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil.encodeAngleBrackets;
+import static org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil.replaceAllIllegalChars;
+import com.google.common.base.CharMatcher;
import com.google.common.collect.ImmutableSortedSet;
import java.lang.reflect.Method;
import java.util.AbstractMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
+import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
+import javax.annotation.processing.Generated;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.xtext.xbase.lib.StringExtensions;
+import org.opendaylight.mdsal.binding.model.api.AnnotationType;
import org.opendaylight.mdsal.binding.model.api.ConcreteType;
-import org.opendaylight.mdsal.binding.model.api.DefaultType;
import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
import org.opendaylight.mdsal.binding.model.api.GeneratedType;
import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
import org.opendaylight.mdsal.binding.model.api.Restrictions;
import org.opendaylight.mdsal.binding.model.api.Type;
-import org.opendaylight.mdsal.binding.model.util.Types;
+import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Multiple;
+import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Single;
+import org.opendaylight.mdsal.binding.model.ri.Types;
import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
import org.opendaylight.yangtools.yang.binding.Augmentable;
import org.opendaylight.yangtools.yang.binding.CodeHelpers;
-
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
+import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DocumentedNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
+import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
+import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
+import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.export.DeclaredStatementFormatter;
/**
* Base Java file template. Contains a non-null type and imports which the generated code refers to.
* {@code java.lang.NullPointerException} as a JavaTypeName.
*/
static final @NonNull JavaTypeName NPE = JavaTypeName.create(NullPointerException.class);
+ /**
+ * {@code java.lang.NoSuchElementException} as a JavaTypeName.
+ */
+ static final @NonNull JavaTypeName NSEE = JavaTypeName.create(NoSuchElementException.class);
/**
* {@code java.lang.Override} as a JavaTypeName.
*/
static final @NonNull JavaTypeName OVERRIDE = JavaTypeName.create(Override.class);
/**
- * {@code java.lang.SuppressWarnings} as a JavaTypeName.
+ * {@code java.lang.void} as a JavaTypeName.
*/
static final @NonNull JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class);
+ /**
+ * {@code java.lang.SuppressWarnings} as a JavaTypeName.
+ */
+ static final @NonNull JavaTypeName VOID = JavaTypeName.create(void.class);
/**
* {@code java.util.Arrays} as a JavaTypeName.
*/
static final @NonNull JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class);
+ /**
+ * {@code javax.annotation.processing.Generated} as a JavaTypeName.
+ */
+ static final @NonNull JavaTypeName GENERATED = JavaTypeName.create(Generated.class);
+
/**
* {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName.
*/
*/
static final @NonNull JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class);
+
private static final Comparator<MethodSignature> METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<>();
+ private static final CharMatcher AMP_MATCHER = CharMatcher.is('&');
+ private static final Pattern TAIL_COMMENT_PATTERN = Pattern.compile("*/", Pattern.LITERAL);
+ private static final DeclaredStatementFormatter YANG_FORMATTER = DeclaredStatementFormatter.builder()
+ .addIgnoredStatement(YangStmtMapping.CONTACT)
+ .addIgnoredStatement(YangStmtMapping.DESCRIPTION)
+ .addIgnoredStatement(YangStmtMapping.REFERENCE)
+ .addIgnoredStatement(YangStmtMapping.ORGANIZATION)
+ .build();
+ private static final int GETTER_PREFIX_LENGTH = BindingMapping.GETTER_PREFIX.length();
private static final Type AUGMENTATION_RET_TYPE;
static {
final Method m;
try {
- m = Augmentable.class.getDeclaredMethod(AUGMENTABLE_AUGMENTATION_NAME, Class.class);
+ m = Augmentable.class.getDeclaredMethod(BindingMapping.AUGMENTABLE_AUGMENTATION_NAME, Class.class);
} catch (NoSuchMethodException e) {
throw new ExceptionInInitializerError(e);
}
- AUGMENTATION_RET_TYPE = DefaultType.of(JavaTypeName.create(m.getReturnType()));
+ AUGMENTATION_RET_TYPE = Type.of(JavaTypeName.create(m.getReturnType()));
}
private final AbstractJavaGeneratedType javaType;
return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS);
}
+ final String generatedAnnotation() {
+ return "@" + importedName(GENERATED) + "(\"mdsal-binding-generator\")";
+ }
+
/**
* Run type analysis, which results in identification of the augmentable type, as well as all methods available
* to the type, expressed as properties.
for (Type implementedIfc : implementedIfcs) {
if (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject)) {
final GeneratedType ifc = (GeneratedType) implementedIfc;
- methods.addAll(ifc.getMethodDefinitions());
+ addImplMethods(methods, ifc);
final ParameterizedType t = collectImplementedMethods(type, methods, ifc.getImplements());
if (t != null && augmentType == null) {
augmentType = t;
}
} else if (Augmentable.class.getName().equals(implementedIfc.getFullyQualifiedName())) {
- augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, DefaultType.of(type.getIdentifier()));
+ augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, Type.of(type.getIdentifier()));
}
}
return augmentType;
}
+ private static void addImplMethods(final Set<MethodSignature> methods, final GeneratedType implType) {
+ for (final MethodSignature implMethod : implType.getMethodDefinitions()) {
+ if (hasOverrideAnnotation(implMethod)) {
+ methods.add(implMethod);
+ } else {
+ final String implMethodName = implMethod.getName();
+ if (BindingMapping.isGetterMethodName(implMethodName)
+ && getterByName(methods, implMethodName).isEmpty()) {
+
+ methods.add(implMethod);
+ }
+ }
+ }
+ }
+
+ protected static Optional<MethodSignature> getterByName(final Iterable<MethodSignature> methods,
+ final String implMethodName) {
+ for (MethodSignature method : methods) {
+ final String methodName = method.getName();
+ if (BindingMapping.isGetterMethodName(methodName) && isSameProperty(method.getName(), implMethodName)) {
+ return Optional.of(method);
+ }
+ }
+ return Optional.empty();
+ }
+
+ protected static String propertyNameFromGetter(final MethodSignature getter) {
+ return propertyNameFromGetter(getter.getName());
+ }
+
+ protected static String propertyNameFromGetter(final String getterName) {
+ final String prefix;
+ if (BindingMapping.isGetterMethodName(getterName)) {
+ prefix = BindingMapping.GETTER_PREFIX;
+ } else if (BindingMapping.isNonnullMethodName(getterName)) {
+ prefix = BindingMapping.NONNULL_PREFIX;
+ } else if (BindingMapping.isRequireMethodName(getterName)) {
+ prefix = BindingMapping.REQUIRE_PREFIX;
+ } else {
+ throw new IllegalArgumentException(getterName + " is not a getter");
+ }
+ return StringExtensions.toFirstLower(getterName.substring(prefix.length()));
+ }
+
+ /**
+ * Check whether specified method has an attached annotation which corresponds to {@code @Override}.
+ *
+ * @param method Method to examine
+ * @return True if there is an override annotation
+ */
+ static boolean hasOverrideAnnotation(final MethodSignature method) {
+ for (final AnnotationType annotation : method.getAnnotations()) {
+ if (OVERRIDE.equals(annotation.getIdentifier())) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ static void appendSnippet(final StringBuilder sb, final GeneratedType type) {
+ type.getYangSourceDefinition().ifPresent(def -> {
+ sb.append('\n');
+
+ if (def instanceof Single) {
+ final DocumentedNode node = ((Single) def).getNode();
+
+ sb.append("<p>\n")
+ .append("This class represents the following YANG schema fragment defined in module <b>")
+ .append(def.getModule().argument().getLocalName()).append("</b>\n")
+ .append("<pre>\n");
+ appendYangSnippet(sb, def.getModule(), ((EffectiveStatement<?, ?>) node).getDeclared());
+ sb.append("</pre>");
+
+ if (node instanceof SchemaNode) {
+ final SchemaNode schema = (SchemaNode) node;
+ sb.append("The schema path to identify an instance is\n");
+ appendPath(sb.append("<i>"), def.getModule(), schema.getPath().getPathFromRoot());
+ sb.append("</i>\n");
+
+ if (hasBuilderClass(schema)) {
+ final String builderName = type.getName() + BindingMapping.BUILDER_SUFFIX;
+
+ sb.append("\n<p>To create instances of this class use {@link ").append(builderName)
+ .append("}.\n")
+ .append("@see ").append(builderName).append('\n');
+ if (node instanceof ListSchemaNode) {
+ final var keyDef = ((ListSchemaNode) node).getKeyDefinition();
+ if (!keyDef.isEmpty()) {
+ sb.append("@see ").append(type.getName()).append(BindingMapping.KEY_SUFFIX);
+ }
+ sb.append('\n');
+ }
+ }
+ }
+ } else if (def instanceof Multiple) {
+ sb.append("<pre>\n");
+ for (SchemaNode node : ((Multiple) def).getNodes()) {
+ appendYangSnippet(sb, def.getModule(), ((EffectiveStatement<?, ?>) node).getDeclared());
+ }
+ sb.append("</pre>\n");
+ }
+ });
+ }
+
+ static String encodeJavadocSymbols(final String description) {
+ // FIXME: Use String.isBlank()?
+ return description == null || description.isEmpty() ? description
+ : TAIL_COMMENT_PATTERN.matcher(AMP_MATCHER.replaceFrom(description, "&")).replaceAll("*/");
+ }
+
+ private static void appendYangSnippet(final StringBuilder sb, final ModuleEffectiveStatement module,
+ final DeclaredStatement<?> stmt) {
+ for (String str : YANG_FORMATTER.toYangTextSnippet(module, stmt)) {
+ sb.append(replaceAllIllegalChars(encodeAngleBrackets(encodeJavadocSymbols(str))));
+ }
+ }
+
+ private static void appendPath(final StringBuilder sb, final ModuleEffectiveStatement module,
+ final List<QName> path) {
+ if (!path.isEmpty()) {
+ // FIXME: this is module name, while when we switch, we end up using QName.toString() -- which is weird
+ sb.append(module.argument().getLocalName());
+ XMLNamespace currentNamespace = path.get(0).getNamespace();
+
+ for (QName pathElement : path) {
+ final XMLNamespace elementNamespace = pathElement.getNamespace();
+ if (!elementNamespace.equals(currentNamespace)) {
+ sb.append(pathElement);
+ currentNamespace = elementNamespace;
+ } else {
+ sb.append(pathElement.getLocalName());
+ }
+ }
+ }
+ }
+
+ private static boolean hasBuilderClass(final SchemaNode schemaNode) {
+ return schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode
+ || schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition;
+ }
+
+ private static boolean isSameProperty(final String getterName1, final String getterName2) {
+ return propertyNameFromGetter(getterName1).equals(propertyNameFromGetter(getterName2));
+ }
+
/**
* Creates set of generated property instances from getter <code>methods</code>.
*
* @param method method signature from which is the method name and return type obtained
* @return generated property instance for the getter <code>method</code>
* @throws IllegalArgumentException <ul>
- * <li>if the <code>method</code> equals <code>null</code></li>
- * <li>if the name of the <code>method</code> equals <code>null</code></li>
- * <li>if the name of the <code>method</code> is empty</li>
- * <li>if the return type of the <code>method</code> equals <code>null</code></li>
- * </ul>
+ * <li>if the {@code method} equals {@code null}</li>
+ * <li>if the name of the {@code method} equals {@code null}</li>
+ * <li>if the name of the {@code method} is empty</li>
+ * <li>if the return type of the {@code method} equals {@code null}</li>
+ * </ul>
*/
private static BuilderGeneratedProperty propertyFromGetter(final MethodSignature method) {
checkArgument(method != null);
if (method.isDefault()) {
return null;
}
- final String prefix = BindingMapping.getGetterPrefix(Types.BOOLEAN.equals(method.getReturnType()));
- if (!method.getName().startsWith(prefix)) {
+ if (!BindingMapping.isGetterMethodName(method.getName())) {
return null;
}
- final String fieldName = StringExtensions.toFirstLower(method.getName().substring(prefix.length()));
+ final String fieldName = StringExtensions.toFirstLower(method.getName().substring(GETTER_PREFIX_LENGTH));
return new BuilderGeneratedProperty(fieldName, method);
}
}
Code Review / mdsal.git / blobdiff