6502/wudsn-ide
1
0
Fork 0
mirror of https://github.com/peterdell/wudsn-ide.git synced 2024-06-03 06:29:35 +00:00
Code Issues Projects Releases Wiki Activity

Support multiple languages in helo TOC.

Browse Source
This commit is contained in:
peterdell 2021-09-26 22:54:10 +02:00
parent 4599004d1b
commit dc4ab9a552
3 changed files with 111 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
com.wudsn.ide.asm/src/com/wudsn/ide/lng/help/HTMLConstants.java
View File

@ -39,4 +39,6 @@ final class HTMLConstants {
+ NL + HTMLConstants.CONTENT_TYPE + NL + HTMLConstants.STYLE_SHEETS + NL + "</head><body>";
public static final String SUFFIX = "</body>" + NL + "</html>";
public static final String BR = "<br>";
}

74
com.wudsn.ide.asm/src/com/wudsn/ide/lng/help/LanguageHelpContentProducer.java
View File

@ -41,6 +41,7 @@ import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.help.IHelpContentProducer;
import org.w3c.dom.html.HTMLUListElement;
import com.wudsn.ide.base.common.EnumUtility;
import com.wudsn.ide.base.common.HexUtility;
@ -51,9 +52,12 @@ import com.wudsn.ide.base.hardware.HardwareUtility;
import com.wudsn.ide.lng.Language;
import com.wudsn.ide.lng.LanguagePlugin;
import com.wudsn.ide.lng.Target;
import com.wudsn.ide.lng.TargetUtility;
import com.wudsn.ide.lng.Texts;
import com.wudsn.ide.lng.compiler.Compiler;
import com.wudsn.ide.lng.compiler.CompilerDefinition;
import com.wudsn.ide.lng.compiler.CompilerHelp;
import com.wudsn.ide.lng.compiler.CompilerHelp.HelpDocument;
import com.wudsn.ide.lng.compiler.CompilerRegistry;
import com.wudsn.ide.lng.compiler.syntax.CompilerSyntax;
import com.wudsn.ide.lng.compiler.syntax.CompilerSyntaxUtility;
@ -63,6 +67,7 @@ import com.wudsn.ide.lng.compiler.syntax.InstructionSet;
import com.wudsn.ide.lng.compiler.syntax.InstructionType;
import com.wudsn.ide.lng.compiler.syntax.Opcode;
import com.wudsn.ide.lng.compiler.syntax.Opcode.OpcodeAddressingMode;
import com.wudsn.ide.lng.preferences.LanguagePreferences;
import com.wudsn.ide.lng.runner.RunnerDefinition;
import com.wudsn.ide.lng.runner.RunnerId;
import com.wudsn.ide.lng.runner.RunnerRegistry;
@ -116,7 +121,7 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
} else if (href.startsWith(SCHEMA_HARDWARE)) {
return getHardwareInputStream(href);
} else if (href.startsWith(SCHEMA_TARGET)) {
return getCPUInputStream(Language.ASM, href); // TODO: Language handling
return getTargetInputStream(href);
} else if (href.endsWith(".html")) { // Web site documents
return getHTMLInputStream(href);
}
@ -244,6 +249,25 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
return params;
}
/**
* Gets the href for a compiler.
*
* @param section The section or <code>null</code>.
* @param extension The extension or <code>null</code>.
* @return The href to a compiler including a trailing slash, not
* <code>null</code>.
**/
public static String getComplierHref(CompilerDefinition compilerDefinition, String section, String extension) {
if (compilerDefinition == null) {
throw new IllegalArgumentException("Parameter 'compilerDefinition' must not be null.");
}
String result = SCHEMA_COMPILER + compilerDefinition.getLanguage() + "/" + compilerDefinition.getId() + "/";
if (section != null) {
result += section + (extension == null ? EXTENSION : extension);
}
return result;
}
/**
* Gets the input stream for a compiler.
*
@ -264,7 +288,7 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
if (index <= 0) {
return null;
}
String language = path.substring(0, index);
String languageString = path.substring(0, index);
path = path.substring(index + 1);
index = path.indexOf("/");
if (index <= 0) {
@ -278,14 +302,15 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
CompilerRegistry compilerRegistry = languagePlugin.getCompilerRegistry();
// Find non-empty compiler executable path.
Language language = Language.valueOf(languageString);
String compilerKey = CompilerDefinition.getKey(language, compilerId);
Compiler compiler = compilerRegistry.getCompilerByKey(compilerKey);
if (section.startsWith(SECTION_GENERAL)) {
return getInputStream(getCompilerGeneralSection(compiler));
} else if (section.startsWith(SECTION_MANUAL)) {
String compilerExecutablePath = languagePlugin.getPreferences().getCompilerExecutablePath(compilerId);
LanguagePreferences languagePreferences = languagePlugin.getLanguagePreferences(language);
String compilerExecutablePath = languagePreferences.getCompilerExecutablePath(compilerId);
if (StringUtility.isEmpty(compilerExecutablePath)) {
// ERROR: Help for the '{0}' compiler cannot be
// displayed because the path to the compiler executable
@ -298,8 +323,12 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
}
try {
File file = compiler.getDefinition().getHelpFile(compilerExecutablePath);
HelpDocument helpDocDocument = compiler.getDefinition().getHelpForCurrentLocale(compilerExecutablePath);
File file = helpDocDocument.file;
if (file == null) {
throw new RuntimeException(
"Method getCompilerInputStream() must only be called for existing files or folders.");
}
// Handle file requests within the help directory.
List<String> fileNames = getQueryParameters(href).get(SECTION_MANUAL_FILE);
String fileName;
@ -351,6 +380,9 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
writer.writeTableRow(Texts.TOC_COMPILER_HOME_PAGE_LABEL,
HTMLWriter.getLink(compilerDefinition.getHomePageURL(), compilerDefinition.getHomePageURL()));
String helpDocumentPaths = compilerDefinition.getHelpDocumentPaths().replace(",", HTMLConstants.BR);
writer.writeTableRowCode(Texts.TOC_COMPILER_HELP_DOCUMENTS_LABEL, helpDocumentPaths);
Hardware hardware = compilerDefinition.getDefaultHardware();
writer.writeTableRow(Texts.TOC_COMPILER_DEFAULT_HARDWARE_LABEL, HTMLWriter
.getImage(ICONS_PATH + HardwareUtility.getImagePath(hardware), hardware.name(), hardware.name()));
@ -610,7 +642,7 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
return getInputStream(writer);
}
private InputStream getCPUInputStream(Language language, String href) {
private InputStream getTargetInputStream(String href) {
if (href == null) {
throw new IllegalArgumentException("Parameter 'href' must not be null.");
@ -627,7 +659,9 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
HTMLWriter writer = createHeader();
writer.beginTable();
writer.writeTableRow(Texts.TOC_TARGETS_NAME_LABEL, EnumUtility.getText(target));
writer.writeTableRow(Texts.TOC_TARGET_NAME_LABEL, EnumUtility.getText(target));
Language language = TargetUtility.getLanguage(target);
writer.writeTableRow(Texts.TOC_TARGET_LANGUAGE_LABEL, EnumUtility.getText(language));
writer.end();
writer.begin("br", null);
@ -640,24 +674,28 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
writer.writeTableHeader(Texts.TOC_COMPILER_INSTRUCTION_DESCRIPTION_LABEL);
List<CompilerDefinition> compilerDefinitions = compilerRegistry.getCompilerDefinitions(language);
int compilerDefinitionCount = compilerDefinitions.size();
InstructionSet[] instructionSets = new InstructionSet[compilerDefinitions.size()];
for (int c = 0; c < compilerDefinitionCount; c++) {
CompilerDefinition compilerDefinition = compilerDefinitions.get(c);
instructionSets[c] = compilerDefinition.getSyntax().getInstructionSet(target);
writer.writeTableHeader(compilerDefinition.getName());
List<InstructionSet> instructionSets = new ArrayList<InstructionSet>();
for (CompilerDefinition compilerDefinition : compilerDefinitions) {
if (compilerDefinition.getSupportedTargets().contains(target)) {
String compilerHref = "../"
+ LanguageHelpContentProducer.getComplierHref(compilerDefinition, SECTION_GENERAL, null);
writer.writeTableHeader(HTMLWriter.getLink(compilerHref, compilerDefinition.getName()));
instructionSets.add(compilerDefinition.getSyntax().getInstructionSet(target));
}
}
writer.end();
List<String> cellContents = new ArrayList<String>(compilerDefinitionCount);
List<String> cellContents = new ArrayList<String>(instructionSets.size());
for (int opcode = 0; opcode < Opcode.MAX_OPCODES; opcode++) {
String opcodeText = null;
cellContents.clear();
for (int c = 0; c < compilerDefinitionCount; c++) {
InstructionSet instructionSet = instructionSets[c];
for (InstructionSet instructionSet : instructionSets) {
List<OpcodeAddressingMode> opcodeAddressingModes = instructionSet.getOpcodeAddressingModes(opcode);
StringBuffer cellBuffer = new StringBuffer();
for (int m = 0; m < opcodeAddressingModes.size(); m++) {
@ -680,7 +718,7 @@ public final class LanguageHelpContentProducer implements IHelpContentProducer {
writer.writeTableCell(HexUtility.getByteValueHexString(opcode));
writer.writeTableCell(opcodeText);
for (int c = 0; c < compilerDefinitionCount; c++) {
for (int c = 0; c < instructionSets.size(); c++) {
writer.writeTableCell(cellContents.get(c));

96
com.wudsn.ide.asm/src/com/wudsn/ide/lng/help/LanguageTocProvider.java
View File

@ -45,6 +45,7 @@ import com.wudsn.ide.lng.LanguagePlugin;
import com.wudsn.ide.lng.Target;
import com.wudsn.ide.lng.Texts;
import com.wudsn.ide.lng.compiler.CompilerDefinition;
import com.wudsn.ide.lng.compiler.CompilerHelp.HelpDocument;
import com.wudsn.ide.lng.compiler.CompilerRegistry;
import com.wudsn.ide.lng.preferences.LanguagePreferences;
@ -218,9 +219,9 @@ public final class LanguageTocProvider extends AbstractTocProvider {
}
private static List<ITopic> createLanguagesTopics(LanguagePlugin languagePlugin) {
CompilerRegistry compilerRegistry = languagePlugin.getCompilerRegistry();
List<ITopic> topics = new ArrayList<ITopic>();
for (Language language : languagePlugin.getLanguages()) {
CompilerRegistry compilerRegistry = languagePlugin.getCompilerRegistry();
List<CompilerDefinition> compilerDefinitions = compilerRegistry.getCompilerDefinitions(language);
@ -255,63 +256,72 @@ public final class LanguageTocProvider extends AbstractTocProvider {
for (int i = 0; i < size; i++) {
CompilerDefinition compilerDefinition = compilerDefinitions.get(i);
String hrefCompiler = LanguageHelpContentProducer.SCHEMA_COMPILER + compilerDefinition.getLanguage() + "/"
+ compilerDefinition.getId() + "/";
String href = hrefCompiler + LanguageHelpContentProducer.SECTION_GENERAL
+ LanguageHelpContentProducer.EXTENSION;
String href = LanguageHelpContentProducer.getComplierHref(compilerDefinition,
LanguageHelpContentProducer.SECTION_GENERAL, null);
ITopic generalTopic = createTopic("", Texts.TOC_COMPILER_GENERAL_TOPIC_LABEL, href, null);
href = hrefCompiler + LanguageHelpContentProducer.SECTION_INSTRUCTIONS
+ LanguageHelpContentProducer.EXTENSION;
href = LanguageHelpContentProducer.getComplierHref(compilerDefinition,
LanguageHelpContentProducer.SECTION_INSTRUCTIONS, null);
ITopic opcodesTopic = createTopic("", Texts.TOC_COMPILER_INSTRUCTIONS_TOPIC_LABEL, href, null);
LanguagePreferences languagePreferences = LanguagePlugin.getInstance().getPreferences();
LanguagePreferences languagePreferences = LanguagePlugin.getInstance()
.getLanguagePreferences(compilerDefinition.getLanguage());
String compilerExecutablePath = languagePreferences.getCompilerExecutablePath(compilerDefinition.getId());
String icon = "";
List<ITopic> manualTopics = new ArrayList<ITopic>();
try {
File file = compilerDefinition.getHelpFile(compilerExecutablePath);
HelpDocument helpDocument = compilerDefinition.getHelpForCurrentLocale(compilerExecutablePath);
if (helpDocument.file != null) {
File file = helpDocument.file;
// Appending the help file path with the correct file
// extension allows in-place display for example for ".html"
// files.
String extension = file.getPath();
int index = extension.lastIndexOf('.');
if (index > 0) {
extension = extension.substring(index);
if (extension.equalsIgnoreCase(".pdf")) {
icon = "pdf";
// Appending the help file path with the correct file
// extension allows in-place display for example for ".html"
// files.
String extension = file.getPath();
int index = extension.lastIndexOf('.');
if (index > 0) {
extension = extension.substring(index);
if (extension.equalsIgnoreCase(".pdf")) {
icon = "pdf";
}
} else {
extension = ".html";
}
href = LanguageHelpContentProducer.getComplierHref(compilerDefinition,
LanguageHelpContentProducer.SECTION_MANUAL, extension);
if (file.isDirectory()) {
File[] files = file.listFiles();
if (files != null) {
for (File file2 : files) {
String encodedPath;
try {
encodedPath = URLEncoder.encode(file2.getName(), "UTF-8");
} catch (UnsupportedEncodingException ex) {
throw new IllegalArgumentException(
"Cannot encode file name '" + file2.getName() + "'");
}
manualTopics.add(createTopic(
"", file2.getName(), href + "?"
+ LanguageHelpContentProducer.SECTION_MANUAL_FILE + "=" + encodedPath,
null));
}
}
// if the file is folder, the manual does not have own
// content but only sub-topics
href = "";
}
} else {
extension = ".html";
}
href = hrefCompiler + LanguageHelpContentProducer.SECTION_MANUAL + extension;
if (file.isDirectory()) {
File[] files = file.listFiles();
if (files != null) {
for (File file2 : files) {
String encodedPath;
try {
encodedPath = URLEncoder.encode(file2.getName(), "UTF-8");
} catch (UnsupportedEncodingException ex) {
throw new IllegalArgumentException("Cannot encode file name '" + file2.getName() + "'");
}
manualTopics.add(createTopic("", file2.getName(),
href + "?" + LanguageHelpContentProducer.SECTION_MANUAL_FILE + "=" + encodedPath,
null));
}
}
// if the file is folder, the manual does not have own
// content but only sub-topics
href = "";
href = helpDocument.uri.toString(); // TODO Check if this works
}
} catch (CoreException ex) {
href = hrefCompiler + LanguageHelpContentProducer.SECTION_MANUAL + ".html";
href = LanguageHelpContentProducer.getComplierHref(compilerDefinition,
LanguageHelpContentProducer.SECTION_MANUAL, null);
}
ITopic manualTopic = createTopic(icon, Texts.TOC_COMPILER_MANUAL_TOPIC_LABEL, href,