Skip to content

refactor(scope): clarify generated method bodies #1525

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.

Sign up for GitHub

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

Merged
joaodinissf merged 2 commits into from
Sep 8, 2026
Merged

refactor(scope): clarify generated method bodies #1525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c208af0
refactor(scope): clarify generated method bodies
joaodinissf Sep 7, 2026
22c92b5
fix(build): compare baseline archive contents
joaodinissf Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 69 additions & 86 deletions ...text.scope/src/com/avaloq/tools/ddk/xtext/scope/generator/ScopeNameProviderGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@
@SuppressWarnings({"checkstyle:MethodName", "nls", "PMD.UnusedFormalParameter"})
public class ScopeNameProviderGenerator {

// CPD-OFF — migrated Xtend generator code, kept faithful; de-dup is a migration follow-up (#1339)

@Inject
private GeneratorUtilX generatorUtilX;

Expand Down Expand Up @@ -79,65 +77,66 @@ public void configure(final GenModelUtilX genModelUtilX, final ScopeModel model)
* Produces the body of the {@code internalGetNameFunctions(EClass)} method. Extracted so the Xbase based
* {@code ScopeJvmModelInferrer} can attach it directly as a method body.
*
* @param it
* @param model
* the scope model, must not be {@code null}
* @return the method body, never {@code null}
*/
public CharSequence internalGetNameFunctionsBody(final ScopeModel it) {
public CharSequence internalGetNameFunctionsBody(final ScopeModel model) {
final StringConcatenation builder = new StringConcatenation();
if (it.getNaming() != null) {
if (model.getNaming() != null) {
final Set<EPackage> packages = new LinkedHashSet<>();
for (final NamingDefinition naming : it.getNaming().getNamings()) {
packages.add(naming.getType().getEPackage());
for (final NamingDefinition definition : model.getNaming().getNamings()) {
packages.add(definition.getType().getEPackage());
}
for (final EPackage p : packages) {
builder.append("if (");
builder.append(genModelUtil.qualifiedPackageInterfaceName(p));
builder.append(".eINSTANCE == eClass.getEPackage()) {");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append("switch (eClass.getClassifierID()) {");
builder.newLine();
builder.newLine();
for (final NamingDefinition n : it.getNaming().getNamings()) {
if (!Objects.equals(n.getType().getEPackage(), p)) {
continue;
}
builder.append(" ");
builder.append("case ");
builder.append(genModelUtil.classifierIdLiteral(n.getType()), " ");
builder.append(":");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append(" ");
builder.append(generatorUtilX.javaContributorComment(generatorUtilX.location(n)), " ");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append(" ");
builder.append("return ");
builder.append(nameFunctions(n.getNaming(), it), " ");
builder.append(";");
builder.newLineIfNotEmpty();
}
builder.newLine();
builder.append(" ");
builder.append("default:");
builder.newLine();
builder.append(" ");
builder.append("return !eClass.getESuperTypes().isEmpty() ? getNameFunctions(eClass.getESuperTypes().get(0)) : null;");
builder.newLine();
builder.append(" ");
builder.append("}");
builder.newLine();
builder.append("}");
builder.newLine();
for (final EPackage ePackage : packages) {
appendPackageSwitch(builder, ePackage, model);
}
}
builder.append("return !eClass.getESuperTypes().isEmpty() ? getNameFunctions(eClass.getESuperTypes().get(0)) : null;");
builder.newLine();
return builder;
}

/** Emits naming cases for one package, retaining definition order. */
private void appendPackageSwitch(final StringConcatenation builder, final EPackage ePackage, final ScopeModel model) {
builder.append("if (");
builder.append(genModelUtil.qualifiedPackageInterfaceName(ePackage));
builder.append(".eINSTANCE == eClass.getEPackage()) {");
builder.newLineIfNotEmpty();
builder.append("""
switch (eClass.getClassifierID()) {

""");
for (final NamingDefinition definition : model.getNaming().getNamings()) {
if (!Objects.equals(definition.getType().getEPackage(), ePackage)) {
continue;
}
appendNamingCase(builder, definition, model);
}
builder.newLine();
builder.append("""
default:
return !eClass.getESuperTypes().isEmpty() ? getNameFunctions(eClass.getESuperTypes().get(0)) : null;
}
}
""");
}

/** Emits a classifier case, including indentation of multiline comments and name functions. */
private void appendNamingCase(final StringConcatenation builder, final NamingDefinition definition, final ScopeModel model) {
builder.append(" case ");
builder.append(genModelUtil.classifierIdLiteral(definition.getType()), " ");
builder.append(":");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append(generatorUtilX.javaContributorComment(generatorUtilX.location(definition)), " ");
builder.newLineIfNotEmpty();
builder.append(" return ");
builder.append(nameFunctions(definition.getNaming(), model), " ");
builder.append(";");
builder.newLineIfNotEmpty();
}

public CharSequence nameFunctions(final Naming it, final ScopeModel model) {
return nameFunctions(it, model, null, null);
}
Expand Down Expand Up @@ -189,8 +188,7 @@ protected String _nameFunction(final IntegerLiteral it, final ScopeModel model,
return "com.avaloq.tools.ddk.xtext.scoping.NameFunctions.fromConstant(String.valueOf(" + it.getVal() + "))";
}

protected String _nameFunction(final FeatureCall it, final ScopeModel model, final String contextName,
final EClass contextType) {
protected String _nameFunction(final FeatureCall it, final ScopeModel model, final String contextName, final EClass contextType) {
final StringConcatenation builder = new StringConcatenation();
final ScopeTranslationContext currentContext = newContext(it, contextName, contextType);
builder.newLineIfNotEmpty();
Expand All @@ -200,23 +198,7 @@ protected String _nameFunction(final FeatureCall it, final ScopeModel model, fin
builder.append(")");
} else if (compiler.isSimpleNavigation(it, currentContext)) {
builder.newLineIfNotEmpty();
builder.append("object -> {");
builder.newLine();
builder.append(" ");
builder.append("final ");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(it)), " ");
builder.append(" obj = (");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(it)), " ");
builder.append(") object;");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append("return toQualifiedName(");
builder.append(compiler.javaExpression(it, currentContext), " ");
builder.append(");");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append("}");
builder.newLine();
appendNameFunctionLambda(builder, it, currentContext);
} else {
builder.append("EXPRESSION_NOT_SUPPORTED(\"");
builder.append(ExpressionExtensions.serialize(it));
Expand All @@ -225,29 +207,12 @@ protected String _nameFunction(final FeatureCall it, final ScopeModel model, fin
return builder.toString();
}

protected String _nameFunction(final OperationCall it, final ScopeModel model, final String contextName,
final EClass contextType) {
protected String _nameFunction(final OperationCall it, final ScopeModel model, final String contextName, final EClass contextType) {
final StringConcatenation builder = new StringConcatenation();
final ScopeTranslationContext currentContext = newContext(it, contextName, contextType);
builder.newLineIfNotEmpty();
if (compiler.isCompilable(it, currentContext)) {
builder.append("object -> {");
builder.newLine();
builder.append(" ");
builder.append("final ");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(it)), " ");
builder.append(" obj = (");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(it)), " ");
builder.append(") object;");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append("return toQualifiedName(");
builder.append(compiler.javaExpression(it, currentContext), " ");
builder.append(");");
builder.newLineIfNotEmpty();
builder.append(" ");
builder.append("}");
builder.newLine();
appendNameFunctionLambda(builder, it, currentContext);
builder.append(" ");
} else {
builder.append("EXPRESSION_NOT_SUPPORTED(\"");
Expand All @@ -256,6 +221,24 @@ protected String _nameFunction(final OperationCall it, final ScopeModel model, f
}
return builder.toString();
}

/** Emits a typed receiver lambda that converts the expression result to a qualified name. */
private void appendNameFunctionLambda(final StringConcatenation builder, final Expression expression, final ScopeTranslationContext context) {
builder.append("object -> {");
builder.newLine();
builder.append(" final ");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(expression)), " ");
builder.append(" obj = (");
builder.append(genModelUtil.instanceClassName(scopeProviderX.scopeType(expression)), " ");
builder.append(") object;");
builder.newLineIfNotEmpty();
builder.append(" return toQualifiedName(");
builder.append(compiler.javaExpression(expression, context), " ");
builder.append(");");
builder.newLineIfNotEmpty();
builder.append(" }");
builder.newLine();
}
// CHECKSTYLE:CONSTANTS-ON

/**
Expand Down
Loading