org.netbeans.api.languages.LibrarySupport Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.api.languages;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import org.openide.ErrorManager;
import org.openide.util.Lookup;
import org.openide.xml.XMLUtil;
/**
* Support for definition of libraries. Used for code completion.
*
* @author Jan Jancura
*/
public abstract class LibrarySupport {
/**
* Crates new Instance of LibrarySupport and reads library definition from give resource file.
*
* @param resourceName a name of resource file
*/
public static LibrarySupport create (String resourceName) {
return new LibraryImpl (resourceName);
}
/**
* Crates new Instance of LibrarySupport and reads library definition from give resource files.
*
* @param resourceNames names of resource files
*/
public static LibrarySupport create (List resourceNames) {
return new DelegatingLibrarySupport (resourceNames);
}
/**
* Returns list of items for given context (e.g. list of static methods
* for fiven class name).
*
* @param context
* @return list of items for given context
*/
public abstract List getItems (String context);
public abstract List getCompletionItems (String context);
/**
* Returns property for given item, context and property name.
*
* @param context a context
* @param item an item
* @param propertyName a name of property
*/
public abstract String getProperty (String context, String item, String propertyName);
private static class LibraryImpl extends LibrarySupport {
private String resourceName;
LibraryImpl (String resourceName) {
this.resourceName = resourceName;
}
private Map> keys = new HashMap> ();
public List getItems (String context) {
List k = keys.get (context);
if (k == null) {
Map>> m = getItems ().get (context);
if (m == null) return null;
k = new ArrayList (m.keySet ());
Collections.sort (k);
k = Collections.unmodifiableList (k);
keys.put (context, k);
}
return k;
}
public List getCompletionItems (String context) {
List result = new ArrayList ();
Map>> items = getItems ().get (context);
if (items == null) return result;
Iterator it = items.keySet ().iterator ();
while (it.hasNext ()) {
String name = it.next();
List> items2 = items.get (name);
Iterator> it2 = items2.iterator ();
while (it2.hasNext()) {
Map properties = it2.next();
CompletionItem.Type type = null;
String stype = properties.get ("type");
if ("class".equals (stype))
type = CompletionItem.Type.CLASS;
else
if ("field".equals (stype))
type = CompletionItem.Type.FIELD;
else
if ("constant".equals (stype))
type = CompletionItem.Type.CONSTANT;
else
if ("constructor".equals (stype))
type = CompletionItem.Type.CONSTRUCTOR;
else
if ("interface".equals (stype))
type = CompletionItem.Type.INTERFACE;
else
if ("keyword".equals (stype))
type = CompletionItem.Type.KEYWORD;
else
if ("local".equals (stype))
type = CompletionItem.Type.LOCAL;
else
if ("method".equals (stype))
type = CompletionItem.Type.METHOD;
else
if ("parameter".equals (stype))
type = CompletionItem.Type.PARAMETER;
result.add (CompletionItem.create (
name,
properties.get ("description"),
properties.get ("library"),
type,
200
));
}
}
return result;
}
/**
* Returns property for given item, context and property name.
*
* @param context a context
* @param item an item
* @param propertyName a name of property
*/
public String getProperty (String context, String item, String propertyName) {
Map>> m = getItems ().get (context);
if (m == null) return null;
List> l = m.get (item);
if (l == null) return null;
if (l.size () > 1)
throw new IllegalArgumentException ();
return l.get (0).get (propertyName);
}
// generics support methods ................................................
// context>name>property>value
private Map>>> items;
private Map>>> getItems () {
if (items == null)
try {
XMLReader reader = XMLUtil.createXMLReader ();
Handler handler = new Handler ();
reader.setEntityResolver (handler);
reader.setContentHandler (handler);
ClassLoader loader = (ClassLoader) Lookup.getDefault ().
lookup (ClassLoader.class);
InputStream is = loader.getResourceAsStream (resourceName);
try {
reader.parse (new InputSource (is));
} finally {
is.close ();
}
items = handler.result;
} catch (Exception ex) {
ErrorManager.getDefault ().notify (ex);
items = Collections.>>> emptyMap ();
}
return items;
}
}
static class Handler extends DefaultHandler {
//context>key>propertyname>propertyvalue
Map>>> result = new HashMap>>> ();
public void startElement (
String uri,
String localName,
String name,
Attributes attributes
) throws SAXException {
try {
if (name.equals ("node")) {
String contexts = attributes.getValue ("context");
String key = attributes.getValue ("key");
Map properties = null;
if (attributes.getLength () > 2) {
properties = new HashMap ();
int i, k = attributes.getLength ();
for (i = 0; i < k; i++) {
String propertyName = attributes.getQName (i);
if ("context".equals (propertyName)) continue;
if ("key".equals (propertyName)) continue;
properties.put (propertyName, attributes.getValue (i));
}
}
while (true) {
int i = contexts.indexOf (',');
String context = i >= 0 ?
contexts.substring (0, i).trim () : contexts;
Map>> names = result.get (context);
if (names == null) {
names = new HashMap>> ();
result.put (context, names);
}
List> entries = names.get (key);
if (entries == null) {
entries = new ArrayList> ();
names.put (key, entries);
}
entries.add (properties);
if (i < 0) break;
contexts = contexts.substring (i + 1);
}
}
} catch (Exception ex) {
ErrorManager.getDefault ().notify (ex);
}
}
public InputSource resolveEntity (String pubid, String sysid) {
return new InputSource (
new java.io.ByteArrayInputStream (new byte [0])
);
}
}
static class DelegatingLibrarySupport extends LibrarySupport {
private List libraries = new ArrayList ();
DelegatingLibrarySupport (
List resources
) {
Iterator it = resources.iterator ();
while (it.hasNext ()) {
String resource = it.next();
libraries.add (new LibraryImpl (resource));
}
}
public List getItems (String context) {
List result = new ArrayList ();
Iterator it = libraries.iterator ();
while (it.hasNext ()) {
LibrarySupport librarySupport = it.next();
result.addAll (librarySupport.getItems (context));
}
return result;
}
public List getCompletionItems (String context) {
List result = new ArrayList ();
Iterator it = libraries.iterator ();
while (it.hasNext ()) {
LibrarySupport librarySupport = it.next();
result.addAll (librarySupport.getCompletionItems (context));
}
return result;
}
public String getProperty (
String context,
String item,
String propertyName
) {
Iterator it = libraries.iterator ();
while (it.hasNext ()) {
LibrarySupport librarySupport = it.next();
String result = librarySupport.getProperty (context, item, propertyName);
if (result != null)
return result;
}
return null;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy