Merge pull request #2230 from BFH-ktt1/newvhdl

Moved to VHDL syntax highlighting provided by RSyntaxTextArea as proposed by #2174
This commit is contained in:
Prof. Dr. Theo Kluter 2025-05-08 10:28:15 +02:00 committed by GitHub
commit 2e50fed533
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 6 additions and 549 deletions

View File

@ -42,9 +42,6 @@ dependencies {
implementation("commons-cli:commons-cli:1.9.0")
implementation("org.apache.commons:commons-text:1.13.1")
// NOTE: Do not upgrade the jflex version. Later versions do not work.
compileOnly("de.jflex:jflex:1.4.1")
// NOTE: Be aware of reported issues with Eclipse and Batik
// See: https://github.com/logisim-evolution/logisim-evolution/issues/709
// implementation("org.apache.xmlgraphics:batik-swing:1.14")
@ -742,55 +739,6 @@ tasks.register("genBuildInfo") {
}
}
/**
* Task genVhdlSyntax
*
* Generates the VhdlSyntax.java file
*/
open class ExecOperationsJarTask @Inject constructor(@Internal val execOperations: ExecOperations) : Jar()
tasks.register<ExecOperationsJarTask>("genVhdlSyntax") {
val sourceFile = "${projectDir}/src/main/jflex/com/cburch/logisim/vhdl/syntax/VhdlSyntax.jflex"
val skeletonFile = "${projectDir}/support/jflex/skeleton.default"
val buildDir = ext.get(BUILD_DIR) as String
val targetDir = "${buildDir}/generated/logisim/java/com/cburch/logisim/vhdl/syntax/"
group = "build"
description = "Generates VhdlSyntax.java"
inputs.files(sourceFile)
inputs.files(skeletonFile)
outputs.dir(targetDir)
var jflexJarFileName = ""
doFirst() {
configurations.compileClasspath {
resolvedConfiguration.resolvedArtifacts.forEach { ra: ResolvedArtifact ->
val id = ra.moduleVersion.id
if ("de.jflex".equals(id.group) && "jflex".equals(id.name)) {
jflexJarFileName = ra.file.toString()
}
}
}
if (jflexJarFileName.isEmpty()) {
throw GradleException("Could not find jflex jar file.")
}
}
doLast() {
logging.captureStandardOutput(LogLevel.DEBUG)
execOperations.javaexec {
classpath = files(jflexJarFileName)
args = listOf(
"--nobak",
"-d", targetDir,
"--skel", skeletonFile,
sourceFile
)
}
}
}
/**
* Task: genFiles
*
@ -799,7 +747,7 @@ tasks.register<ExecOperationsJarTask>("genVhdlSyntax") {
tasks.register("genFiles") {
group = "build"
description = "Generates all generated files."
dependsOn("genBuildInfo", "genVhdlSyntax")
dependsOn("genBuildInfo")
}
/**

View File

@ -22,7 +22,6 @@ import com.cburch.logisim.util.JFileChoosers;
import com.cburch.logisim.util.JInputDialog;
import com.cburch.logisim.util.LocaleListener;
import com.cburch.logisim.util.LocaleManager;
import com.cburch.logisim.vhdl.syntax.VhdlSyntax;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Dialog;
@ -40,6 +39,7 @@ import javax.swing.JPanel;
import javax.swing.event.DocumentEvent;
import org.fife.ui.rsyntaxtextarea.RSyntaxDocument;
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
import org.fife.ui.rsyntaxtextarea.SyntaxConstants;
import org.fife.ui.rtextarea.RTextScrollPane;
public class HdlContentEditor extends JDialog implements JInputDialog {
@ -226,7 +226,7 @@ public class HdlContentEditor extends JDialog implements JInputDialog {
validate.addActionListener(frameListener);
editor = new RSyntaxTextArea(ROWS, COLUMNS);
((RSyntaxDocument) editor.getDocument()).setSyntaxStyle(new VhdlSyntax());
((RSyntaxDocument) editor.getDocument()).setSyntaxStyle(SyntaxConstants.SYNTAX_STYLE_VHDL);
editor.setCodeFoldingEnabled(true);
editor.setAntiAliasingEnabled(true);
editor.getDocument().addDocumentListener(editorListener);

View File

@ -41,9 +41,8 @@ import javax.swing.JDialog;
import javax.swing.JFileChooser;
import javax.swing.JPanel;
import javax.swing.event.DocumentEvent;
import org.fife.ui.rsyntaxtextarea.AbstractTokenMakerFactory;
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
import org.fife.ui.rsyntaxtextarea.TokenMakerFactory;
import org.fife.ui.rsyntaxtextarea.SyntaxConstants;
import org.fife.ui.rtextarea.RTextScrollPane;
public class HdlContentEditor extends JDialog implements JInputDialog {
@ -217,10 +216,8 @@ public class HdlContentEditor extends JDialog implements JInputDialog {
close.addActionListener(frameListener);
validate.addActionListener(frameListener);
AbstractTokenMakerFactory atmf = (AbstractTokenMakerFactory) TokenMakerFactory.getDefaultInstance();
atmf.putMapping("text/vhdl", "com.cburch.logisim.vhdl.syntax.VhdlSyntax");
editor = new RSyntaxTextArea(ROWS, COLUMNS);
editor.setSyntaxEditingStyle("text/vhdl");
editor.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_VHDL);
editor.setCodeFoldingEnabled(true);
editor.setAntiAliasingEnabled(true);
editor.getDocument().addDocumentListener(editorListener);

View File

@ -21,7 +21,6 @@ import com.cburch.logisim.util.JFileChoosers;
import com.cburch.logisim.vhdl.base.HdlModel;
import com.cburch.logisim.vhdl.base.HdlModelListener;
import com.cburch.logisim.vhdl.file.HdlFile;
import com.cburch.logisim.vhdl.syntax.VhdlSyntax;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.Dimension;
@ -174,7 +173,7 @@ public class HdlContentView extends JPanel
editor = new RSyntaxTextArea(ROWS, COLUMNS);
if (lang.equals("vhdl")) {
((RSyntaxDocument) editor.getDocument()).setSyntaxStyle(new VhdlSyntax());
((RSyntaxDocument) editor.getDocument()).setSyntaxStyle(SyntaxConstants.SYNTAX_STYLE_VHDL);
} else {
editor.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_DELPHI);
}

View File

@ -1,487 +0,0 @@
/*
* WARNING: THIS IS AUTO-GENERATED FILE - DO NOT EDIT!
****************************************************************
*
* To update this file edit src/main/java/com/cburch/logisim/vhdl/syntax/VhdlSyntax.flex
* then use Jflex (https://jflex.de/) to generate this file from it.
*
* See: https://github.com/logisim-evolution/logisim-evolution/issues/563
*/
/*
* Logisim-evolution - digital logic design tool and simulator
* Copyright by the Logisim-evolution developers
*
* https://github.com/logisim-evolution/
*
* This is free software released under GNU GPLv3 license
*/
/*
* Generated on 2/20/16 10:40 PM
*/
package com.cburch.logisim.vhdl.syntax;
import java.io.Reader;
import java.io.IOException;
import javax.swing.text.Segment;
import org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker;
import org.fife.ui.rsyntaxtextarea.Token;
import org.fife.ui.rsyntaxtextarea.TokenImpl;
/**
* VHDL Syntax Highlighting for RSyntaxTextArea.
* Generated by kwalsh@holycross.edu using TokenTokenMaker.
*/
%%
%public
%class VhdlSyntax
%extends AbstractJFlexTokenMaker
%unicode
%ignorecase
%type org.fife.ui.rsyntaxtextarea.Token
%{
/**
* Constructor. This must be here because JFlex does not generate a
* no-parameter constructor.
*/
public VhdlSyntax() {
}
/**
* Adds the token specified to the current linked list of tokens.
*
* @param tokenType The token's type.
* @see #addToken(int, int, int)
*/
private void addHyperlinkToken(int start, int end, int tokenType) {
int so = start + offsetShift;
addToken(zzBuffer, start,end, tokenType, so, true);
}
/**
* Adds the token specified to the current linked list of tokens.
*
* @param tokenType The token's type.
*/
private void addToken(int tokenType) {
addToken(zzStartRead, zzMarkedPos-1, tokenType);
}
/**
* Adds the token specified to the current linked list of tokens.
*
* @param tokenType The token's type.
* @see #addHyperlinkToken(int, int, int)
*/
private void addToken(int start, int end, int tokenType) {
int so = start + offsetShift;
addToken(zzBuffer, start,end, tokenType, so, false);
}
/**
* Adds the token specified to the current linked list of tokens.
*
* @param array The character array.
* @param start The starting offset in the array.
* @param end The ending offset in the array.
* @param tokenType The token's type.
* @param startOffset The offset in the document at which this token
* occurs.
* @param hyperlink Whether this token is a hyperlink.
*/
public void addToken(char[] array, int start, int end, int tokenType,
int startOffset, boolean hyperlink) {
super.addToken(array, start,end, tokenType, startOffset, hyperlink);
zzStartRead = zzMarkedPos;
}
/**
* {@inheritDoc}
*/
public String[] getLineCommentStartAndEnd(int languageIndex) {
return new String[] { "--", null };
}
/**
* Returns the first token in the linked list of tokens generated
* from <code>text</code>. This method must be implemented by
* subclasses so they can correctly implement syntax highlighting.
*
* @param text The text from which to get tokens.
* @param initialTokenType The token type we should start with.
* @param startOffset The offset into the document at which
* <code>text</code> starts.
* @return The first <code>Token</code> in a linked list representing
* the syntax highlighted text.
*/
public Token getTokenList(Segment text, int initialTokenType, int startOffset) {
resetTokenList();
this.offsetShift = -text.offset + startOffset;
// Start off in the proper state.
int state = Token.NULL;
switch (initialTokenType) {
/* No multi-line comments */
/* No documentation comments */
default:
state = Token.NULL;
}
s = text;
try {
yyreset(zzReader);
yybegin(state);
return yylex();
} catch (IOException ioe) {
ioe.printStackTrace();
return new TokenImpl();
}
}
/**
* Refills the input buffer.
*
* @return <code>true</code> if EOF was reached, otherwise
* <code>false</code>.
*/
private boolean zzRefill() {
return zzCurrentPos>=s.offset+s.count;
}
public final int yystate() {
return zzLexicalState;
}
/**
* Resets the scanner to read from a new input stream.
* Does not close the old reader.
*
* All internal variables are reset, the old input stream
* <b>cannot</b> be reused (internal buffer is discarded and lost).
* Lexical state is set to <tt>YY_INITIAL</tt>.
*
* @param reader the new input stream
*/
public final void yyreset(Reader reader) {
// 's' has been updated.
zzBuffer = s.array;
/*
* We replaced the line below with the two below it because zzRefill
* no longer "refills" the buffer (since the way we do it, it's always
* "full" the first time through, since it points to the segment's
* array). So, we assign zzEndRead here.
*/
//zzStartRead = zzEndRead = s.offset;
zzStartRead = s.offset;
zzEndRead = zzStartRead + s.count - 1;
zzCurrentPos = zzMarkedPos = zzPushbackPos = s.offset;
zzLexicalState = YYINITIAL;
zzReader = reader;
zzAtBOL = true;
zzAtEOF = false;
}
%}
Letter = [A-Za-z]
LetterOrUnderscore = ({Letter}|"_")
NonzeroDigit = [1-9]
Digit = ("0"|{NonzeroDigit})
HexDigit = ({Digit}|[A-Fa-f])
OctalDigit = ([0-7])
AnyCharacterButApostropheOrBackSlash = ([^\\'])
AnyCharacterButDoubleQuoteOrBackSlash = ([^\\\"\n])
EscapedSourceCharacter = ("u"{HexDigit}{HexDigit}{HexDigit}{HexDigit})
Escape = ("\\"(([btnfr\"'\\])|([0123]{OctalDigit}?{OctalDigit}?)|({OctalDigit}{OctalDigit}?)|{EscapedSourceCharacter}))
NonSeparator = ([^\t\f\r\n\ \(\)\{\}\[\]\;\,\.\=\>\<\!\~\?\:\+\-\*\/\&\|\^\%\"\']|"#"|"\\")
IdentifierStart = ({LetterOrUnderscore}|"$")
IdentifierPart = ({IdentifierStart}|{Digit}|("\\"{EscapedSourceCharacter}))
LineTerminator = (\n)
WhiteSpace = ([ \t\f]+)
CharLiteral = ([\']({AnyCharacterButApostropheOrBackSlash}|{Escape})[\'])
UnclosedCharLiteral = ([\'][^\'\n]*)
ErrorCharLiteral = ({UnclosedCharLiteral}[\'])
StringLiteral = ([\"]({AnyCharacterButDoubleQuoteOrBackSlash}|{Escape})*[\"])
UnclosedStringLiteral = ([\"]([\\].|[^\\\"])*[^\"]?)
ErrorStringLiteral = ({UnclosedStringLiteral}[\"])
/* No multi-line comments */
/* No documentation comments */
LineCommentBegin = "--"
IntegerLiteral = ({Digit}+)
HexLiteral = (0x{HexDigit}+)
FloatLiteral = (({Digit}+)("."{Digit}+)?(e[+-]?{Digit}+)? | ({Digit}+)?("."{Digit}+)(e[+-]?{Digit}+)?)
ErrorNumberFormat = (({IntegerLiteral}|{HexLiteral}|{FloatLiteral}){NonSeparator}+)
Separator = ([\(\)\{\}\[\]])
Separator2 = ([\;,.])
Identifier = ({IdentifierStart}{IdentifierPart}*)
URLGenDelim = ([:\/\?#\[\]@])
URLSubDelim = ([\!\$&'\(\)\*\+,;=])
URLUnreserved = ({LetterOrUnderscore}|{Digit}|[\-\.\~])
URLCharacter = ({URLGenDelim}|{URLSubDelim}|{URLUnreserved}|[%])
URLCharacters = ({URLCharacter}*)
URLEndCharacter = ([\/\$]|{Letter}|{Digit})
URL = (((https?|f(tp|ile))"://"|"www.")({URLCharacters}{URLEndCharacter})?)
/* No string state */
/* No char state */
/* No MLC state */
/* No documentation comment state */
%state EOL_COMMENT
%%
<YYINITIAL> {
/* Keywords */
"abs" |
"access" |
"after" |
"alias" |
"all" |
"and" |
"architecture" |
"array" |
"assert" |
"attribute" |
"begin" |
"block" |
"body" |
"buffer" |
"bus" |
"case" |
"component" |
"configuration" |
"constant" |
"disconnect" |
"downto" |
"else" |
"elsif" |
"end" |
"entity" |
"exit" |
"file" |
"for" |
"function" |
"generate" |
"generic" |
"group" |
"guarded" |
"if" |
"impure" |
"in" |
"inertial" |
"inout" |
"is" |
"label" |
"library" |
"linkage" |
"literal" |
"loop" |
"map" |
"mod" |
"nand" |
"new" |
"next" |
"nor" |
"not" |
"null" |
"of" |
"on" |
"open" |
"or" |
"others" |
"out" |
"package" |
"port" |
"postponed" |
"procedure" |
"process" |
"pure" |
"range" |
"record" |
"register" |
"reject" |
"rem" |
"report" |
"return" |
"rol" |
"ror" |
"select" |
"severity" |
"shared" |
"signal" |
"sla" |
"sll" |
"sra" |
"srl" |
"subtype" |
"then" |
"to" |
"transport" |
"type" |
"unaffected" |
"units" |
"until" |
"use" |
"variable" |
"wait" |
"when" |
"while" |
"with" |
"xnor" |
"xor" { addToken(Token.RESERVED_WORD); }
/* Keywords 2 (just an optional set of keywords colored differently) */
"'ACTIVE" |
"'ASCENDING" |
"'ASCENDING" |
"'ASCENDING" |
"'BASE" |
"'DELAYED" |
"'DRIVING" |
"'DRIVING_VALUE" |
"'EVENT" |
"'HIGH" |
"'HIGH" |
"'HIGH" |
"'IMAGE" |
"'INSTANCE_NAME" |
"'LAST_ACTIVE" |
"'LAST_EVENT" |
"'LAST_VALUE" |
"'LEFT" |
"'LEFT" |
"'LEFT" |
"'LEFTOF" |
"'LENGTH" |
"'LENGTH" |
"'LOW" |
"'LOW" |
"'LOW" |
"'PATH_NAME" |
"'POS" |
"'PRED" |
"'QUIET" |
"'QUIET" |
"'RANGE" |
"'RANGE" |
"'REVERSE_RANGE" |
"'REVERSE_RANGE" |
"'RIGHT" |
"'RIGHT" |
"'RIGHT" |
"'RIGHTOF" |
"'SIMPLE_NAME" |
"'STABLE" |
"'STABLE" |
"'SUCC" |
"'TRANSACTION" |
"'VAL" |
"'VALUE" { addToken(Token.RESERVED_WORD_2); }
/* Data types */
"bit" |
"bit_vector" |
"boolean" |
"integer" |
"natural" |
"positive" |
"std_logic" |
"std_logic_unsigned" |
"std_logic_vector" |
"std_logis_signed" { addToken(Token.DATA_TYPE); }
/* Functions */
"'-'" |
"'0'" |
"'1'" |
"'H'" |
"'L'" |
"'U'" |
"'W'" |
"'X'" |
"'Z'" |
"false" |
"true" { addToken(Token.FUNCTION); }
{LineTerminator} { addNullToken(); return firstToken; }
{Identifier} { addToken(Token.IDENTIFIER); }
{WhiteSpace} { addToken(Token.WHITESPACE); }
/* String/Character literals. */
{CharLiteral} { addToken(Token.LITERAL_CHAR); }
{UnclosedCharLiteral} { addToken(Token.ERROR_CHAR); addNullToken(); return firstToken; }
{ErrorCharLiteral} { addToken(Token.ERROR_CHAR); }
{StringLiteral} { addToken(Token.LITERAL_STRING_DOUBLE_QUOTE); }
{UnclosedStringLiteral} { addToken(Token.ERROR_STRING_DOUBLE); addNullToken(); return firstToken; }
{ErrorStringLiteral} { addToken(Token.ERROR_STRING_DOUBLE); }
/* Comment literals. */
/* No multi-line comments */
/* No documentation comments */
{LineCommentBegin} { start = zzMarkedPos-2; yybegin(EOL_COMMENT); }
/* Separators. */
{Separator} { addToken(Token.SEPARATOR); }
{Separator2} { addToken(Token.IDENTIFIER); }
/* Operators. */
"&" |
"(" |
")" |
"*" |
"**" |
"+" |
"-" |
"." |
"/" |
"/=" |
":" |
":=" |
";" |
"<" |
"<=" |
"=" |
"=>" |
">" |
">=" { addToken(Token.OPERATOR); }
/* Numbers */
{IntegerLiteral} { addToken(Token.LITERAL_NUMBER_DECIMAL_INT); }
{HexLiteral} { addToken(Token.LITERAL_NUMBER_HEXADECIMAL); }
{FloatLiteral} { addToken(Token.LITERAL_NUMBER_FLOAT); }
{ErrorNumberFormat} { addToken(Token.ERROR_NUMBER_FORMAT); }
/* Ended with a line not in a string or comment. */
<<EOF>> { addNullToken(); return firstToken; }
/* Catch any other (unhandled) characters. */
. { addToken(Token.IDENTIFIER); }
}
/* No char state */
/* No string state */
/* No multi-line comment state */
/* No documentation comment state */
<EOL_COMMENT> {
[^hwf\n]+ {}
{URL} { int temp=zzStartRead; addToken(start,zzStartRead-1, Token.COMMENT_EOL); addHyperlinkToken(temp,zzMarkedPos-1, Token.COMMENT_EOL); start = zzMarkedPos; }
[hwf] {}
\n { addToken(start,zzStartRead-1, Token.COMMENT_EOL); addNullToken(); return firstToken; }
<<EOF>> { addToken(start,zzStartRead-1, Token.COMMENT_EOL); addNullToken(); return firstToken; }
}