-
Notifications
You must be signed in to change notification settings - Fork 327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prepare API generator for automatic check #12175
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
4cd2829
Add ApiModificationTest
Akirathan 8d011ee
Fix docs
Akirathan 397a97c
Add DocsGenerateOrderTest
Akirathan 3f5ac61
Merge branch 'develop' into wip/akirathan/10507-api-check
Akirathan 5912148
No signature is generated for empty modules.
Akirathan 1d08eca
Move some methods to DumpTestUtils
Akirathan 96537ad
Implement BindingSorter
Akirathan 0beadba
BindingSorter takes care of extension methods
Akirathan 41c35e3
DocsGenerate respects order of bindings
Akirathan 040ec68
DocsEmitSignatures emits correct markdown format
Akirathan 4b51a45
No signatures for synthetic modules
Akirathan 51becef
Conversion methods are sorted after instance methods
Akirathan 30904f6
Ensure generated docs dir has same structure as src dir
Akirathan ba18ad1
Update Signatures_Spec
Akirathan 8b917c0
Use ScalaConversions
Akirathan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
170 changes: 170 additions & 0 deletions
170
engine/runtime-compiler/src/main/java/org/enso/compiler/docs/BindingSorter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| package org.enso.compiler.docs; | ||
|
|
||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import org.enso.compiler.core.ir.Module; | ||
| import org.enso.compiler.core.ir.module.scope.Definition; | ||
| import org.enso.compiler.core.ir.module.scope.Definition.Data; | ||
| import org.enso.compiler.core.ir.module.scope.Definition.Type; | ||
| import org.enso.compiler.core.ir.module.scope.definition.Method; | ||
| import scala.jdk.javaapi.CollectionConverters; | ||
|
|
||
| /** | ||
| * Bindings are sorted to categories. Every category is sorted alphabetically. | ||
| * Categories are roughly: | ||
| * <ul> | ||
| * <li>Types</li> | ||
| * <li>Instance and static methods on types</li> | ||
| * <li>Module methods</li> | ||
| * <li>Extension and conversion methods</li> | ||
| * </ul> | ||
| */ | ||
| public final class BindingSorter { | ||
| private BindingSorter() {} | ||
|
|
||
| /** | ||
| * Returns sorted list of bindings defined on the given {@code moduleIr}. | ||
| */ | ||
| public static List<Definition> sortedBindings(Module moduleIr) { | ||
| var bindings = CollectionConverters.asJava(moduleIr.bindings()); | ||
| var comparator = new BindingComparator(moduleIr); | ||
| return bindings.stream().sorted(comparator).toList(); | ||
| } | ||
|
|
||
| public static List<Definition.Data> sortConstructors(List<Definition.Data> constructors) { | ||
| var comparator = new ConstructorComparator(); | ||
| return constructors.stream().sorted(comparator).toList(); | ||
| } | ||
|
|
||
|
|
||
| private static int compareTypes(Type type1, Type type2) { | ||
| return type1.name().name().compareTo(type2.name().name()); | ||
| } | ||
|
|
||
|
|
||
| private static final class BindingComparator implements java.util.Comparator<Definition> { | ||
| private final Module moduleIr; | ||
| private Set<String> typeNames; | ||
|
|
||
| private BindingComparator(Module moduleIr) { | ||
| this.moduleIr = moduleIr; | ||
| } | ||
|
|
||
| @Override | ||
| public int compare(Definition def1, Definition def2) { | ||
| return switch (def1) { | ||
| case Method method1 when def2 instanceof Method methods -> | ||
| compareMethods(method1, methods); | ||
| case Type type1 when def2 instanceof Type type2 -> | ||
| compareTypes(type1, type2); | ||
| case Type type1 when def2 instanceof Method method2 -> compareTypeAndMethod(type1, method2); | ||
| case Method method1 when def2 instanceof Type type2 -> | ||
| -compareTypeAndMethod(type2, method1); | ||
| default -> throw new AssertionError("unexpected type " + def1.getClass()); | ||
| }; | ||
| } | ||
|
|
||
| private int compareTypeAndMethod(Type type, Method method) { | ||
| if (method.typeName().isDefined()) { | ||
| if (isExtensionMethod(method)) { | ||
| return -1; | ||
| } | ||
| var typeName = type.name().name(); | ||
| var methodTypeName = method.typeName().get().name(); | ||
| if (typeName.equals(methodTypeName)) { | ||
| return -1; | ||
| } else { | ||
| return typeName.compareTo(methodTypeName); | ||
| } | ||
| } | ||
| return -1; | ||
| } | ||
|
|
||
|
|
||
| private int compareMethods(Method method1, Method method2) { | ||
| return switch (method1) { | ||
| case | ||
| Method.Explicit explicitMethod1 when method2 instanceof Method.Explicit explicitMethod2 -> { | ||
| if (explicitMethod1.isPrivate() != explicitMethod2.isPrivate()) { | ||
| if (explicitMethod1.isPrivate()) { | ||
| yield 1; | ||
| } else { | ||
| yield -1; | ||
| } | ||
| } | ||
| if (isExtensionMethod(explicitMethod1) != isExtensionMethod(explicitMethod2)) { | ||
| if (isExtensionMethod(explicitMethod1)) { | ||
| yield 1; | ||
| } else { | ||
| yield -1; | ||
| } | ||
| } | ||
| var type1 = explicitMethod1.methodReference().typePointer(); | ||
| var type2 = explicitMethod2.methodReference().typePointer(); | ||
| if (type1.isDefined() && type2.isDefined()) { | ||
| // Both methods are instance or static methods - compare by type name | ||
| var typeName1 = type1.get().name(); | ||
| var typeName2 = type2.get().name(); | ||
| if (typeName1.equals(typeName2)) { | ||
| // Methods are defined on the same type | ||
| yield explicitMethod1.methodName().name() | ||
| .compareTo(explicitMethod2.methodName().name()); | ||
| } else { | ||
| yield type1.get().name().compareTo(type2.get().name()); | ||
| } | ||
| } else if (type1.isDefined() && !type2.isDefined()) { | ||
| // Instance or static methods on types have precedence over module methods | ||
| yield -1; | ||
| } else if (!type1.isDefined() && type2.isDefined()) { | ||
| yield 1; | ||
| } | ||
| assert !type1.isDefined() && !type2.isDefined(); | ||
| yield explicitMethod1.methodName().name() | ||
| .compareTo(explicitMethod2.methodName().name()); | ||
| } | ||
| // Comparison of conversion methods is not supported. | ||
| case Method.Conversion conversion1 when method2 instanceof Method.Conversion conversion2 -> | ||
| 0; | ||
| case Method.Explicit explicit when method2 instanceof Method.Conversion -> -1; | ||
| case Method.Conversion conversion when method2 instanceof Method.Explicit -> 1; | ||
| default -> throw new AssertionError( | ||
| "Unexpected type: method1=%s, method2=%s".formatted(method1.getClass(), | ||
| method2.getClass())); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * An extension method is a method that is defined on a type that is defined outside the | ||
| * current module. | ||
| */ | ||
| private boolean isExtensionMethod(Method method) { | ||
| if (method.typeName().isDefined()) { | ||
| var typeName = method.typeName().get().name(); | ||
| return !typeNamesInModule().contains(typeName); | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private Set<String> typeNamesInModule() { | ||
| if (typeNames == null) { | ||
| typeNames = new HashSet<>(); | ||
| moduleIr.bindings().foreach(binding -> { | ||
| if (binding instanceof Definition.Type type) { | ||
| typeNames.add(type.name().name()); | ||
| } | ||
| return null; | ||
| }); | ||
| } | ||
| return typeNames; | ||
| } | ||
| } | ||
|
|
||
| private static final class ConstructorComparator implements java.util.Comparator<Definition.Data> { | ||
|
|
||
| @Override | ||
| public int compare(Data cons1, Data cons2) { | ||
| return cons1.name().name().compareTo(cons2.name().name()); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could select the directory based on the "type of documentation" - e.g.
apifor--docs=apiandmdfor--docsor--docs=md