Skip to content

chore: remove LfNormalizingFileSystemAccess (step 2/2, closes #1345) #1354

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

Draft
joaodinissf wants to merge 2 commits into
base: chore/emit-lf-step-1
Choose a base branch
from
Draft

chore: remove LfNormalizingFileSystemAccess (step 2/2, closes #1345) #1354

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
765822d
chore: emit LF explicitly in KeywordAnalysisHelper
joaodinissf May 19, 2026
293bf38
chore: remove LfNormalizingFileSystemAccess (now superseded by config)
joaodinissf May 19, 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
12 changes: 5 additions & 7 deletions ...avaloq.tools.ddk.check.core/src/com/avaloq/tools/ddk/check/generator/CheckGenerator.xtend
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import com.google.inject.Inject
import org.eclipse.emf.ecore.resource.Resource
import org.eclipse.xtext.generator.AbstractFileSystemAccess
import org.eclipse.xtext.generator.IFileSystemAccess
import org.eclipse.xtext.generator.IFileSystemAccess2
import org.eclipse.xtext.xbase.compiler.JvmModelGenerator

import static org.eclipse.xtext.xbase.lib.IteratorExtensions.*
Expand All @@ -37,24 +36,23 @@ class CheckGenerator extends JvmModelGenerator {
@Inject ICheckGeneratorConfigProvider generatorConfigProvider;

override void doGenerate(Resource resource, IFileSystemAccess fsa) {
val lfFsa = new LfNormalizingFileSystemAccess(fsa as IFileSystemAccess2)
super.doGenerate(resource, lfFsa); // Generate validator, catalog, and preference initializer from inferred Jvm models.
super.doGenerate(resource, fsa); // Generate validator, catalog, and preference initializer from inferred Jvm models.
val config = generatorConfigProvider.get(resource?.URI);
for (catalog : toIterable(resource.allContents).filter(typeof(CheckCatalog))) {

lfFsa.generateFile(catalog.issueCodesFilePath, catalog.compileIssueCodes)
lfFsa.generateFile(catalog.standaloneSetupPath, catalog.compileStandaloneSetup)
fsa.generateFile(catalog.issueCodesFilePath, catalog.compileIssueCodes)
fsa.generateFile(catalog.standaloneSetupPath, catalog.compileStandaloneSetup)

// change output path for service registry
lfFsa.generateFile(
fsa.generateFile(
CheckUtil::serviceRegistryClassName,
CheckGeneratorConstants::CHECK_REGISTRY_OUTPUT,
catalog.generateServiceRegistry(CheckUtil::serviceRegistryClassName, fsa)
)
// generate documentation for SCA-checks only
if(config !== null && (config.doGenerateDocumentationForAllChecks || !config.generateLanguageInternalChecks)){
// change output path for html files to docs/
lfFsa.generateFile(catalog.docFileName, CheckGeneratorConstants::CHECK_DOC_OUTPUT, catalog.compileDoc)
fsa.generateFile(catalog.docFileName, CheckGeneratorConstants::CHECK_DOC_OUTPUT, catalog.compileDoc)
}
}
}
Expand Down
126 changes: 0 additions & 126 deletions ...dk.check.core/src/com/avaloq/tools/ddk/check/generator/LfNormalizingFileSystemAccess.java
View file
Open in desktop

This file was deleted.

5 changes: 1 addition & 4 deletions ...ols.ddk.checkcfg.core/src/com/avaloq/tools/ddk/checkcfg/generator/CheckCfgGenerator.xtend
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@
*******************************************************************************/
package com.avaloq.tools.ddk.checkcfg.generator

import com.avaloq.tools.ddk.check.generator.LfNormalizingFileSystemAccess
import com.avaloq.tools.ddk.check.runtime.configuration.ICheckConfigurationStoreService
import com.avaloq.tools.ddk.checkcfg.checkcfg.CheckConfiguration
import com.google.inject.Inject
import org.eclipse.emf.ecore.resource.Resource
import org.eclipse.xtext.generator.AbstractFileSystemAccess
import org.eclipse.xtext.generator.IFileSystemAccess
import org.eclipse.xtext.generator.IFileSystemAccess2
import org.eclipse.xtext.generator.IGenerator

import static org.eclipse.xtext.xbase.lib.IteratorExtensions.*
Expand All @@ -39,9 +37,8 @@ class CheckCfgGenerator implements IGenerator {
if (fsa instanceof AbstractFileSystemAccess) {
fsa.setOutputPath(outputPath)
}
val lfFsa = new LfNormalizingFileSystemAccess(fsa as IFileSystemAccess2)
for (configuration:toIterable(resource.allContents).filter(typeof(CheckConfiguration))) {
lfFsa.generateFile(configuration.fileName, configuration.compile)
fsa.generateFile(configuration.fileName, configuration.compile)
}
}

Expand Down
138 changes: 71 additions & 67 deletions ...enerator/src/com/avaloq/tools/ddk/xtext/generator/parser/antlr/KeywordAnalysisHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@

package com.avaloq.tools.ddk.xtext.generator.parser.antlr;

import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
Expand Down Expand Up @@ -178,99 +179,102 @@ private boolean hasLetters(final String keyword) {
* if an I/O error occurs
*/
public void printViolations(final String srcGenPath) {
try {
String fileName = getKeywordsDiagnosticReportFileName(srcGenPath);
PrintWriter writer = new PrintWriter(new File(fileName), StandardCharsets.UTF_8);
writer.println("Please check in this file, so a diff can be used to detect unexpected changes");
writer.println();
writer.println(" identifiers rejected - are not listed in MWE2 file as reserved words");
writer.println(" (or keywords), but are not accepted by the rule.");
writer.println(" reserved words accepted - listed in MWE2 as reserved, but accepted.");
writer.println();
writer.println("Read more on https://ddk.tools.avaloq.com/keywords.html");
writer.println();
writer.println("Specification");
writer.println();
writer.println("RESERVED WORDS");
String fileName = getKeywordsDiagnosticReportFileName(srcGenPath);
try (BufferedWriter writer = Files.newBufferedWriter(new File(fileName).toPath(), StandardCharsets.UTF_8)) {
writeLine(writer, "Please check in this file, so a diff can be used to detect unexpected changes");
writeLine(writer, "");
writeLine(writer, " identifiers rejected - are not listed in MWE2 file as reserved words");
writeLine(writer, " (or keywords), but are not accepted by the rule.");
writeLine(writer, " reserved words accepted - listed in MWE2 as reserved, but accepted.");
writeLine(writer, "");
writeLine(writer, "Read more on https://ddk.tools.avaloq.com/keywords.html");
writeLine(writer, "");
writeLine(writer, "Specification");
writeLine(writer, "");
writeLine(writer, "RESERVED WORDS");
int count = 0;
String indent = " ";
for (String word : reservedWords) {
if (count++ % WORDS_PER_ROW == 0) {
writer.println();
writer.print(indent);
writeLine(writer, "");
writer.write(indent);
}
writer.print(Strings.padEnd(word, WORDS_PADDING, ' '));
writer.write(Strings.padEnd(word, WORDS_PADDING, ' '));
}
writer.println();
writer.println();
writer.println("KEYWORDS");
writeLine(writer, "");
writeLine(writer, "");
writeLine(writer, "KEYWORDS");
count = 0;
for (String word : keywordsSpec) {
if (count++ % WORDS_PER_ROW == 0) {
writer.println();
writer.print(indent);
writeLine(writer, "");
writer.write(indent);
}
writer.print(Strings.padEnd(word, WORDS_PADDING, ' '));
writer.write(Strings.padEnd(word, WORDS_PADDING, ' '));
}
writer.println();
writeLine(writer, "");
boolean problemsReported = false;
for (String ruleName : keywordsViolatingSpec.keySet()) {
writer.println();
writer.print("RULE: ");
writer.println(ruleName);
writeLine(writer, "");
writer.write("RULE: ");
writeLine(writer, ruleName);
Set<String> kwSet = keywordsViolatingSpec.get(ruleName);
writer.println(" Identifiers rejected (PROBLEM if non empty): ");
writeLine(writer, " Identifiers rejected (PROBLEM if non empty): ");
for (String kw : Sets.difference(kwSet, keywordsSpec)) {
problemsReported = true; // only rejected are real problems
writer.print(indent);
writer.println(kw);
writer.write(indent);
writeLine(writer, kw);
}
writer.println();
writeLine(writer, "");
Set<String> rwSet = keywordsSofterThanSpec.get(ruleName);
writer.println(" Reserved words rejected: ");
writeLine(writer, " Reserved words rejected: ");
for (String kw : Sets.difference(reservedWords, rwSet)) {
writer.print(indent);
writer.println(kw);
writer.write(indent);
writeLine(writer, kw);
}
writer.println();
writer.println(" Reserved words accepted: ");
writeLine(writer, "");
writeLine(writer, " Reserved words accepted: ");
for (String kw : rwSet) {
writer.print(indent);
writer.println(kw);
writer.write(indent);
writeLine(writer, kw);
}
writer.println();
writer.println(" Keywords rejected: ");
writeLine(writer, "");
writeLine(writer, " Keywords rejected: ");
for (String kw : Sets.intersection(keywordsSpec, kwSet)) {
writer.print(indent);
writer.println(kw);
writer.write(indent);
writeLine(writer, kw);
}
writer.println();
writer.println(" Keywords accepted: ");
writeLine(writer, "");
writeLine(writer, " Keywords accepted: ");
for (String kw : Sets.difference(keywordsSpec, kwSet)) {
writer.print(indent);
writer.println(kw);
writer.write(indent);
writeLine(writer, kw);
}
writer.println();
writeLine(writer, "");
}
if (problemsReported) {
LOGGER.error("REJECTED KEYWORDS BY ID RULES DETECTED.");
LOGGER.error("Read {} !", fileName);
writer.println();
writer.println("(!) Problems were detected: neither reserved words nor keywords, but rejected by identifier rules");
writer.println("Use " + Path.fromPortableString(getReportFileName(srcGenPath)).lastSegment() + " to find out why these words are keywords.");
writeLine(writer, "");
writeLine(writer, "(!) Problems were detected: neither reserved words nor keywords, but rejected by identifier rules");
writeLine(writer, "Use " + Path.fromPortableString(getReportFileName(srcGenPath)).lastSegment() + " to find out why these words are keywords.");
}
writer.println();
writer.println("The following rules were not checked, but might also be relevant");
writeLine(writer, "");
writeLine(writer, "The following rules were not checked, but might also be relevant");
for (String ruleName : uncheckedRules) {
writer.print(indent);
writer.println(ruleName);
writer.write(indent);
writeLine(writer, ruleName);
}
writer.println("if any of them is used to parse identifiers, add them to identifierRules in MWE2 file");
writer.close();
writeLine(writer, "if any of them is used to parse identifiers, add them to identifierRules in MWE2 file");
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}

/** Write {@code line} followed by an LF newline, regardless of platform. */
private static void writeLine(final BufferedWriter writer, final String line) throws IOException {
writer.write(line);
writer.write('\n');
}

/**
Expand Down Expand Up @@ -439,19 +443,19 @@ public List<Grammar> getAllGrammars() {
* if an I/O error occurs
*/
public void printReport(final String srcGenPath) {
try {
String fileName = getReportFileName(srcGenPath);
PrintWriter writer = new PrintWriter(new File(fileName), StandardCharsets.UTF_8);
writer.print(report.build());
writer.close();
String docuFileName = getDocFileName(srcGenPath);
PrintWriter docuWriter = new PrintWriter(new File(docuFileName), StandardCharsets.UTF_8);
docuWriter.print(new CombinedGrammarReportBuilder(grammarExtensions).getDocumentation(grammar, parserRules, enumRules));
docuWriter.close();
LOGGER.info("report on keywords is written into {}", fileName);
String fileName = getReportFileName(srcGenPath);
String docuFileName = getDocFileName(srcGenPath);
try (BufferedWriter writer = Files.newBufferedWriter(new File(fileName).toPath(), StandardCharsets.UTF_8)) {
writer.write(report.build());
} catch (IOException e) {
throw new UncheckedIOException(e);
}
try (BufferedWriter docuWriter = Files.newBufferedWriter(new File(docuFileName).toPath(), StandardCharsets.UTF_8)) {
docuWriter.write(new CombinedGrammarReportBuilder(grammarExtensions).getDocumentation(grammar, parserRules, enumRules));
} catch (IOException e) {
throw new UncheckedIOException(e);
}
LOGGER.info("report on keywords is written into {}", fileName);
}

/**
Expand Down