The upcoming release of RSyntaxTextArea will support syntax highlighting and code folding for .htaccess files. This was just added in SVN commit 814.
Archive for the ‘RSyntaxTextArea’ Category
Does anybody really need Java 1.4 support anymore? RSTA is one of the few remaining, active Swing libraries that supports this ancient version of Java. It reached its EOL in 2008 (almost 5 years ago!), and even its extended support ended in February 2013. Being a syntax highlighting text component, there hasn’t really been anything added to the JDK from Java 5 onward that would benefit it, so I’ve been keeping its minimum JRE version back at 1.4, just to keep it as “compatible” as possible. However, there are a few drawbacks because of this:
- There is one API change in the JDK that occurred between Java 1.4.2 and 1.5 that affects RSTA. The code in the repository builds cleanly when built with a true 1.4 JDK, but you will receive an error for XmlParser.java when building with Java 5+ (even if you set -source 1.4). When building RSTA with the included Ant build scripts, you will get a big fat explanation of this spit to stdout, so you know rectify the situation if it happens to you (just add a throws-clause to a single method), but Java novices may not fully understand what’s not working. Moving the bar up to 1.5 will clean this issue up entirely.
- One area where the JDK does offer nice new functionality for an editor like RSTA is XML parsing. We could add schema-based squiggle underline validation to XML files.
- It would be a little nice to modernize the code base.
If anyone feels strongly that we should keep releasing pre-built versions of RSTA that run on Java 1.4, please let me know, preferably in the forums.
Because I haven’t had much time to work on RSTA lately, I’ve been thinking about making a list of work items in an attempt to get motivated. So here’s what’s on the list so far for the next RSTA release:
- Performance improvements, particularly for word wrap with very long lines. This has been asked for a couple of times in the forums. I’ve done some work, that will be available in the next SVN commit, that will improve performance to some degree. One of RSTA’s primary issues here is that modelToView()/viewToModel() calculations are relatively expensive, and for very long word-wrapped lines, they are called literally dozens of times whenever text is inserted or the window is resized. As a first pass, I’m refactoring things a bit so that the data used by these method calls is cached much more aggressively; this seems to improve things quite nicely. Moving forward, I might also try to minimize the number of calls to these methods in general, though that will be a more difficult task. There were also some performance improvements made to WrappedLineView.java in the JDK, around the Java 5 timeframe, that RSTA may be able to learn from/graciously borrow.
- Syntax highlighting for R.
- Syntax highlighting for .htaccess files.
- API in AutoComplete libarary to specify the expected type of arguments in a parameterized completion.
Any other suggestions?
Have you ever been interested in integrating syntax highlighting for your own, custom language into RSyntaxTextArea? Now there’s finally a guide to help you do just that!
This “developers documentation” section describes in detail how syntax highlighting is implemented in RSTA, and multiple ways that you can add your own. In the future, it’ll have similar documentation on adding code folding, code folding, and squiggle-underline parsing.
Feedback is welcome!
RSyntaxTextArea 2.0.7 was just released on SourceForge! Here’s a list of the cool new stuff:
- setBracketMatchingEnabled(boolean) now checks for brackets “to the right” of the caret if one is not found “to the left.”
- Added API for applications to create custom hyperlinks in RSyntaxTextArea, though this API should not be considered stable.
- Added “mark occurrences” support for XML. Currently just highlights the tag name at the current caret position and its match.
- Fixed issue when auto-inserting spaces for tabs.
- Major refactoring of rendering code.
- “Traditional” selection rendering is now supported; that is, selected text can now be rendered as syntax highlighted tokens with a “selection” background (as it was previously), or as text as a single color with the “selection” background (as standard text components do). See RSyntaxTextArea.setUseSelectedTextColor(boolean).
- Fixed performance issue in FoldingAwareIconRowHeader when it paints “active regions.”
- Added some new token types to better differentiate markup tokens from “regular” language tokens. This allows for better syntax highlighting for stuff like HTML, JSP, and PHP.
- Added Visual Basic syntax highlighting.
- In RSTAUI, a new TextFilePropertiesDialog was added. This dialog shows the currently edited text file’s path, size, word count, encoding, line terminator, and more. Further, when using a TextEditorPane, you can modify the file’s encoding or line terminator directly from the dialog.
- RSTALanguageSupport: HTML, PHP, JSP and XML now have an option to automatically add closing tags when opening tags are typed (e.g. add “</foo>” when “<foo>” is typed). By default this option is enabled. HTML, PHP and JSP only auto-close tags closeable in the HTML 5 spec; XML closes all tags. This option is separate from the XML “auto-complete closing tag name when ‘</’ is typed” option.
Below are a couple of screenshots showing off the new JSDoc syntax highlighting and code completion. The first one shows auto-completion kicking in after typing “@” in a documentation comment. The second screenshot shows the parameterized assistance you get for “@param”:
Go check it out!
Syntax highlighting for Visual Basic was just added into SVN. I probably won’t bother with code folding support for VB any time soon, since I don’t ever write code in it, but if you’re itching to contribute, I’m always willing to take patches!
If you grab the latest from SVN, RSyntaxTextArea has improved theming support. First, RSTA supports the following new token styles:
- Markup language comments (i.e. “<!– … –>”)
- CDATA delimiters, separate from the CDATA content itself (e.g. “<![CDATA[" and "]]>”)
- Entity references
Note that all of these are related to markup languages, such as XML, HTML, JSP and PHP. Previously, the lexers for each of these languages identified and colorized all of these constructs, but re-used token styles for other token types when rendering them. For example, entity references were previously rendered using the “variable” token style. This wasn’t optimal, as it meant that theme designers had to be aware of this token-style re-use when creating custom Themes, if they wanted their Themes to be as pretty as possible. Not so any longer!
Another new feature is that RSyntaxTextArea now supports the standard editor behavior of selected text using a different font color than unselected text. Previously, selected text always still rendered using the proper syntax highlighting styles. Now, this is configurable via the setUseSelectedTextColor(boolean)/getUseSelectedTextColor() API. Theme XML can also specify how a theme wants this property set. Below is a screenshot that compare the “dark” default theme, which has this property set to false, and the “eclipse” default theme, which has this property set to true:
Themes can also now use a special value “default” for selection foreground and background colors, which means “use the LookAndFeel’s (not system’s!) default for these values). Check out the theme DTD for specifics.
These changes do unfortunately mean that themes created for older RSyntaxTextArea versions will no longer work with (the upcoming) 2.0.7+, as they will not pass validation against the DTD. They can be easily updated however, so I don’t see this as much of an issue.
Finally, all of the sample themes have been updated to use the new features above. Also, a new sample theme was added to the mix: idea! Thanks to Mikle Garin for this theme. This is obviously based off of IntelliJ IDEA‘s default theme.
Who knows, maybe a theme based off of its new Darcula will show up next.
RSyntaxTextArea 2.0.6 was just released on SourceForge! Included are new versions of AutoComplete, RSTALanguageSupport, and SpellChecker.
RSTA now provides syntax highlighting and code folding for JSON:
Further, the AutoComplete and RSTALanguageSupport libraries now look good in Substance (in particular, Insubstantial). Previously, these libraries used DefaultListCellRenderer for their completion choices. Substance, being the barrel of fun that it is, forces libraries to extend its own DefaultSubstanceListCellRenderer, otherwise they aren’t rendered with Substance’s striping, gradients and rollover effects. Now, RSTA and its cousins detect when Substance is the current Look and Feel, and render with a DefaultSubstanceListCellRenderer when necessary. Easy peasy!
(Pardon the fact that I didn’t update the editor color scheme to be dark as well!). This is done via reflection, so there is still no build dependency on Substance. This of course assumes that the DefaultSubstanceListCellRenderer class name and package don’t change in future releases of Insubstantial, but I highly doubt that’ll happen, considering it’s a maintenance fork of the original Substance. And if something goes horribly wrong, the library should fall back into its default rendering path anyway.
The outline trees (JavaOutlineTree, XmlOutlineTree, etc.) still use DefaultTreeCellRenderer, but applications can use the same technique here – wrap the standard renderers for these components with SubstanceDefaultTreeCellRenderer, call delegate.getTreeCellRendererComponent(), then set the Substance renderer’s icon and text based on the delegate’s values. Come to think of it, I’m not sure why I didn’t have the libraries automatically delegate like I did with the completion choices lists… maybe next release. One thing you do lose from this delegation is the rollover effect – the render “looks” the same, but the animated rollover effect depends on the actual renderer being a DefaultSubstance*Renderer. Since we’re only *delegating* to one, we’ll look like it, but won’t get the rollover effect.
RSyntaxTextArea 18.104.22.168 was just released on SourceForge! This release fixes the problem with typing the ‘/’ character on non-QWERTY keyboards, so is a must-upgrade if you’re using 2.0.5 (2.0.4 did not have this bug). It also updates the Arabic translation (thanks Mawaheb!).
The AutoComplete, SpellChecker, and RSTAUI add-on libraries were also updated with Arabic translation updates.
RSyntaxTextArea 2.0.5 was just released on SourceForge! Here’s a recap of what’s new:
- Code folding added for HTML, JSP, and PHP.
- Added NSIS syntax highlighting and code folding.
- Added code folding and highlighting of multi-line strings for Scala.
- Added Java 7 features to Groovy highlighting (underscores in numeric literals, binary literals, and new core classes/interfaces/enums).
- Wildcards can be specified in Go to Member dialogs.
- Tool tips can now be specified for icons in IconRowHeader.
- Fixed an issue with CompleteMarkupTagAction and ToggleLineCommentAction conflicting with each other only on *nix (Windows and OS X didn’t have this issue).
- Allow for non-ConfigurableCarets to be set via setCaret(), to allow for Swing’s “composed text” changes (hidden in private API).
- Fixed possible NPE in XmlTreeCellUI for environments where desktop AA hints cannot be determined.
- Updated translations – Italian (Argaar), German (Domenic), Korean (Changkyoon), Japanese (Josh), and Hungarian (Zityi).