Skip to content

Feature/services #35

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

Open
ZenHarbinger wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Feature/services #35

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
452e29d
Updated language support to use services.
ZenHarbinger Jan 12, 2017
ab741b2
Updated license header.
ZenHarbinger Jan 12, 2017
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
381 changes: 166 additions & 215 deletions src/main/java/org/fife/rsta/ac/LanguageSupportFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,227 +14,178 @@
import java.beans.PropertyChangeListener;
import java.util.HashMap;
import java.util.Map;
import java.util.ServiceLoader;

import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
import org.fife.ui.rsyntaxtextarea.SyntaxConstants;


/**
* Provides language support (code completion, etc.) for programming
* languages in RSyntaxTextArea. Different languages may have varying
* levels of "support."
* Provides language support (code completion, etc.) for programming languages
* in RSyntaxTextArea. Different languages may have varying levels of "support."
*
* @author Robert Futrell
* @version 1.0
*/
public class LanguageSupportFactory implements PropertyChangeListener {

private static final LanguageSupportFactory INSTANCE =
new LanguageSupportFactory();

/**
* Maps styles to class-names-for-language-supports; this way we can lazily
* create the <code>LanguageSupports</code> when necessary.
*/
private Map<String, String> styleToSupportClass;

/**
* Maps syntax styles to language supports for them.
*/
private Map<String, LanguageSupport> styleToSupport;


/**
* Client property set on RSyntaxTextAreas that points to the current
* language support for that text area.
*/
private static final String LANGUAGE_SUPPORT_PROPERTY =
"org.fife.rsta.ac.LanguageSupport";


/**
* Constructor.
*/
private LanguageSupportFactory() {
createSupportMap();
}


/**
* Adds language support for a language. This is a hook for applications
* using this library to add language support for custom languages.
*
* @param style The language to add support for. This should be one of
* the values defined in {@link SyntaxConstants}. Any previous
* language support for this language is removed.
* @param lsClassName The class name of the <code>LanguageSupport</code>.
*/
public void addLanguageSupport(String style, String lsClassName) {
styleToSupportClass.put(style, lsClassName);
}


/**
* Creates the mapping of syntax styles to language supports.
*/
private void createSupportMap() {

styleToSupport = new HashMap<String, LanguageSupport>();
styleToSupportClass = new HashMap<String, String>();

String prefix = "org.fife.rsta.ac.";

addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_C,
prefix + "c.CLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_CSS,
prefix + "css.CssLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_GROOVY,
prefix + "groovy.GroovyLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_HTML,
prefix + "html.HtmlLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_JAVA,
prefix + "java.JavaLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_JAVASCRIPT,
prefix + "js.JavaScriptLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_JSP,
prefix + "jsp.JspLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_LESS,
prefix + "less.LessLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_PERL,
prefix + "perl.PerlLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_PHP,
prefix + "php.PhpLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_TYPESCRIPT,
prefix + "ts.TypeScriptLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_UNIX_SHELL,
prefix + "sh.ShellLanguageSupport");
addLanguageSupport(SyntaxConstants.SYNTAX_STYLE_XML,
prefix + "xml.XmlLanguageSupport");

}


/**
* Returns the singleton instance of this class.
*
* @return The singleton instance.
*/
public static LanguageSupportFactory get() {
return INSTANCE;
}


/**
* Returns the language support for a programming language.
*
* @param style The language. This should be one of the constants defined
* in {@link SyntaxConstants}.
* @return The language support, or <code>null</code> if none is registered
* for the language specified.
*/
public LanguageSupport getSupportFor(String style) {

LanguageSupport support = styleToSupport.get(style);

if (support==null) {
String supportClazz = styleToSupportClass.get(style);
if (supportClazz!=null) {
try {
Class<?> clazz = Class.forName(supportClazz);
support = (LanguageSupport)clazz.newInstance();
} catch (RuntimeException re) { // FindBugs
throw re;
} catch (Exception e) {
e.printStackTrace();
}
styleToSupport.put(style, support);
// Always remove from classes to load, so we don't try again
styleToSupportClass.remove(style);
}
}

return support;

}


/**
* Installs language support on an RSTA depending on its syntax style.
*
* @param textArea The text area to install language support on.
* @see #uninstallSupport(RSyntaxTextArea)
*/
private void installSupport(RSyntaxTextArea textArea) {
String style = textArea.getSyntaxEditingStyle();
LanguageSupport support = getSupportFor(style);
if (support!=null) {
support.install(textArea);
}
textArea.putClientProperty(LANGUAGE_SUPPORT_PROPERTY, support);
}


/**
* Listens for RSyntaxTextAreas to change what language they're
* highlighting, so language support can be updated appropriately.
*
* @param e The event.
*/
@Override
public void propertyChange(PropertyChangeEvent e) {

RSyntaxTextArea source = (RSyntaxTextArea)e.getSource();
String name = e.getPropertyName();
if (RSyntaxTextArea.SYNTAX_STYLE_PROPERTY.equals(name)) {
uninstallSupport(source);
installSupport(source);
}

}


/**
* Registers an RSyntaxTextArea to receive language support. The text area
* will get support for the currently highlighted language, and if it
* changes what language it is highlighting, the support will change as
* appropriate.
*
* @param textArea The text area to register.
*/
public void register(RSyntaxTextArea textArea) {
installSupport(textArea);
textArea.addPropertyChangeListener(
RSyntaxTextArea.SYNTAX_STYLE_PROPERTY, this);
}


/**
* Uninstalls the language support on an RSyntaxTextArea, if any.
*
* @param textArea The text area.
* @see #installSupport(RSyntaxTextArea)
*/
private void uninstallSupport(RSyntaxTextArea textArea) {
LanguageSupport support = (LanguageSupport)textArea.getClientProperty(
LANGUAGE_SUPPORT_PROPERTY);
if (support!=null) {
support.uninstall(textArea);
}
}


/**
* Un-registers an RSyntaxTextArea. This removes any language support
* on it.
*
* @param textArea The text area.
* @see #register(RSyntaxTextArea)
*/
public void unregister(RSyntaxTextArea textArea) {
uninstallSupport(textArea);
textArea.removePropertyChangeListener(
RSyntaxTextArea.SYNTAX_STYLE_PROPERTY, this);
}


}
public final class LanguageSupportFactory implements PropertyChangeListener {

private static final LanguageSupportFactory INSTANCE
= new LanguageSupportFactory();

/**
* Maps styles to class-names-for-language-supports; this way we can lazily
* create the <code>LanguageSupports</code> when necessary.
*/
private final Map<String, String> styleToSupportClass;

/**
* Maps syntax styles to language supports for them.
*/
private final Map<String, LanguageSupport> styleToSupport;

/**
* Client property set on RSyntaxTextAreas that points to the current
* language support for that text area.
*/
private static final String LANGUAGE_SUPPORT_PROPERTY
= "org.fife.rsta.ac.LanguageSupport";

/**
* Constructor.
*/
private LanguageSupportFactory() {
styleToSupport = new HashMap<String, LanguageSupport>();
styleToSupportClass = new HashMap<String, String>();
ServiceLoader<LanguageSupportRegistration> s = ServiceLoader.load(LanguageSupportRegistration.class);
for(LanguageSupportRegistration l : s) {
addLanguageSupport(l.getLanguage(), l.getLanguageSupportType());
}
}

/**
* Adds language support for a language. This is a hook for applications
* using this library to add language support for custom languages.
*
* @param style The language to add support for. This should be one of the
* values defined in {@link SyntaxConstants}. Any previous language support
* for this language is removed.
* @param lsClassName The class name of the <code>LanguageSupport</code>.
*/
public void addLanguageSupport(String style, String lsClassName) {
styleToSupportClass.put(style, lsClassName);
}

/**
* Returns the singleton instance of this class.
*
* @return The singleton instance.
*/
public static LanguageSupportFactory get() {
return INSTANCE;
}

/**
* Returns the language support for a programming language.
*
* @param style The language. This should be one of the constants defined in
* {@link SyntaxConstants}.
* @return The language support, or <code>null</code> if none is registered
* for the language specified.
*/
public LanguageSupport getSupportFor(String style) {

LanguageSupport support = styleToSupport.get(style);

if (support == null) {
String supportClazz = styleToSupportClass.get(style);
if (supportClazz != null) {
try {
Class<?> clazz = Class.forName(supportClazz);
support = (LanguageSupport) clazz.newInstance();
} catch (RuntimeException re) { // FindBugs
throw re;
} catch (Exception e) {
e.printStackTrace();
}
styleToSupport.put(style, support);
// Always remove from classes to load, so we don't try again
styleToSupportClass.remove(style);
}
}

return support;

}

/**
* Installs language support on an RSTA depending on its syntax style.
*
* @param textArea The text area to install language support on.
* @see #uninstallSupport(RSyntaxTextArea)
*/
private void installSupport(RSyntaxTextArea textArea) {
String style = textArea.getSyntaxEditingStyle();
LanguageSupport support = getSupportFor(style);
if (support != null) {
support.install(textArea);
}
textArea.putClientProperty(LANGUAGE_SUPPORT_PROPERTY, support);
}

/**
* Listens for RSyntaxTextAreas to change what language they're
* highlighting, so language support can be updated appropriately.
*
* @param e The event.
*/
public void propertyChange(PropertyChangeEvent e) {

RSyntaxTextArea source = (RSyntaxTextArea) e.getSource();
String name = e.getPropertyName();
if (RSyntaxTextArea.SYNTAX_STYLE_PROPERTY.equals(name)) {
uninstallSupport(source);
installSupport(source);
}

}

/**
* Registers an RSyntaxTextArea to receive language support. The text area
* will get support for the currently highlighted language, and if it
* changes what language it is highlighting, the support will change as
* appropriate.
*
* @param textArea The text area to register.
*/
public void register(RSyntaxTextArea textArea) {
installSupport(textArea);
textArea.addPropertyChangeListener(
RSyntaxTextArea.SYNTAX_STYLE_PROPERTY, this);
}

/**
* Uninstalls the language support on an RSyntaxTextArea, if any.
*
* @param textArea The text area.
* @see #installSupport(RSyntaxTextArea)
*/
private void uninstallSupport(RSyntaxTextArea textArea) {
LanguageSupport support = (LanguageSupport) textArea.getClientProperty(
LANGUAGE_SUPPORT_PROPERTY);
if (support != null) {
support.uninstall(textArea);
}
}

/**
* Un-registers an RSyntaxTextArea. This removes any language support on it.
*
* @param textArea The text area.
* @see #register(RSyntaxTextArea)
*/
public void unregister(RSyntaxTextArea textArea) {
uninstallSupport(textArea);
textArea.removePropertyChangeListener(
RSyntaxTextArea.SYNTAX_STYLE_PROPERTY, this);
}

}
Loading