Search in sources :

Example 1 with ManifestElement

use of org.jetbrains.android.dom.manifest.ManifestElement in project android by JetBrains.

the class AttributeProcessingUtil method registerAttribute.

private static void registerAttribute(@NotNull AttributeDefinition attrDef, @Nullable String parentStyleableName, @Nullable String namespaceKey, @NotNull DomElement element, @NotNull AttributeProcessor callback) {
    String name = attrDef.getName();
    if (!NS_RESOURCES.equals(namespaceKey) && name.startsWith(PREFIX_ANDROID)) {
        // A styleable-definition in the app namespace (user specified or from a library) can include
        // a reference to a platform attribute. In such a case, register it under the android namespace
        // as opposed to the app namespace. See https://code.google.com/p/android/issues/detail?id=171162
        name = name.substring(PREFIX_ANDROID.length());
        namespaceKey = NS_RESOURCES;
    }
    XmlName xmlName = new XmlName(name, namespaceKey);
    final DomExtension extension = callback.processAttribute(xmlName, attrDef, parentStyleableName);
    if (extension == null) {
        return;
    }
    Converter converter = AndroidDomUtil.getSpecificConverter(xmlName, element);
    if (converter == null) {
        if (TOOLS_URI.equals(namespaceKey)) {
            converter = ToolsAttributeUtil.getConverter(attrDef);
        } else {
            converter = AndroidDomUtil.getConverter(attrDef);
            if (converter != null && element.getParentOfType(Manifest.class, true) != null) {
                converter = new ManifestPlaceholderConverter(converter);
            }
        }
    }
    if (converter != null) {
        extension.setConverter(converter, mustBeSoft(converter, attrDef.getFormats()));
    }
    // tag completion. If attribute is not required, no additional action is needed.
    if (element instanceof LayoutElement && isLayoutAttributeRequired(xmlName, element) || element instanceof ManifestElement && AndroidManifestUtils.isRequiredAttribute(xmlName, element)) {
        extension.addCustomAnnotation(new RequiredImpl());
    }
}
Also used : DomExtension(com.intellij.util.xml.reflect.DomExtension) ManifestElement(org.jetbrains.android.dom.manifest.ManifestElement) ManifestPlaceholderConverter(org.jetbrains.android.dom.converters.ManifestPlaceholderConverter) XmlName(com.intellij.util.xml.XmlName) CompositeConverter(org.jetbrains.android.dom.converters.CompositeConverter) Converter(com.intellij.util.xml.Converter) ResourceReferenceConverter(org.jetbrains.android.dom.converters.ResourceReferenceConverter) ManifestPlaceholderConverter(org.jetbrains.android.dom.converters.ManifestPlaceholderConverter) ResolvingConverter(com.intellij.util.xml.ResolvingConverter)

Example 2 with ManifestElement

use of org.jetbrains.android.dom.manifest.ManifestElement in project android by JetBrains.

the class AttributeProcessingUtil method processAttributes.

/**
   * Enumerate attributes that are available for the given XML tag, represented by {@link AndroidDomElement},
   * and "return" them via {@link AttributeProcessor}.
   *
   * Primary user is {@link AndroidDomExtender}, which uses it to provide code completion facilities when
   * editing XML files in text editor.
   *
   * Implementation of the method implements {@link Styleable} annotation handling and dispatches on tag type
   * using instanceof checks for adding attributes that don't come from styleable definitions with statically
   * known names.
   *
   * @param processAllExistingAttrsFirst whether already existing attributes should be returned first
   */
public static void processAttributes(@NotNull AndroidDomElement element, @NotNull AndroidFacet facet, boolean processAllExistingAttrsFirst, @NotNull AttributeProcessor callback) {
    XmlTag tag = element.getXmlTag();
    final Set<XmlName> skippedAttributes = processAllExistingAttrsFirst ? registerExistingAttributes(facet, tag, element, callback) : new HashSet<>();
    if (element instanceof ManifestElement) {
        processManifestAttributes(tag, element, callback);
    } else if (element instanceof LayoutElement) {
        processLayoutAttributes(facet, tag, (LayoutElement) element, skippedAttributes, callback);
    } else if (element instanceof XmlResourceElement) {
        processXmlAttributes(facet, tag, (XmlResourceElement) element, skippedAttributes, callback);
    } else if (element instanceof XmlRawResourceElement) {
        processRawAttributes(tag, callback);
    }
    // If DOM element is annotated with @Styleable annotation, load a styleable definition
    // from Android framework with the name provided in annotation and register all attributes
    // from it for code highlighting and completion.
    final Styleable styleableAnnotation = element.getAnnotation(Styleable.class);
    if (styleableAnnotation == null) {
        return;
    }
    final SystemResourceManager manager = facet.getSystemResourceManager();
    if (manager == null) {
        return;
    }
    final AttributeDefinitions definitions = manager.getAttributeDefinitions();
    if (definitions == null) {
        return;
    }
    if (element instanceof MenuItem) {
        processMenuItemAttributes(facet, element, skippedAttributes, callback);
        return;
    }
    for (String styleableName : styleableAnnotation.value()) {
        final StyleableDefinition styleable = definitions.getStyleableByName(styleableName);
        if (styleable == null) {
            // DOM element is annotated with @Styleable annotation, but styleable definition with
            // provided name is not there in Android framework. This is a bug, so logging it as a warning.
            getLog().warn(String.format("@Styleable(%s) annotation doesn't point to existing styleable", styleableName));
        } else {
            registerStyleableAttributes(element, styleable, ANDROID_URI, callback, skippedAttributes);
        }
    }
    // TODO: figure it out how to make it DRY without introducing new method with lots of arguments
    if (element instanceof InterpolatorElement) {
        final String styleableName = InterpolatorDomFileDescription.getInterpolatorStyleableByTagName(tag.getName());
        if (styleableName != null) {
            final StyleableDefinition styleable = definitions.getStyleableByName(styleableName);
            if (styleable == null) {
                getLog().warn(String.format("%s doesn't point to existing styleable for interpolator", styleableName));
            } else {
                registerStyleableAttributes(element, styleable, ANDROID_URI, callback, skippedAttributes);
            }
        }
    }
}
Also used : ManifestElement(org.jetbrains.android.dom.manifest.ManifestElement) XmlResourceElement(org.jetbrains.android.dom.xml.XmlResourceElement) MenuItem(org.jetbrains.android.dom.menu.MenuItem) XmlRawResourceElement(org.jetbrains.android.dom.raw.XmlRawResourceElement) InterpolatorElement(org.jetbrains.android.dom.animation.InterpolatorElement) XmlName(com.intellij.util.xml.XmlName) SystemResourceManager(org.jetbrains.android.resourceManagers.SystemResourceManager) XmlTag(com.intellij.psi.xml.XmlTag)

Aggregations

XmlName (com.intellij.util.xml.XmlName)2 ManifestElement (org.jetbrains.android.dom.manifest.ManifestElement)2 XmlTag (com.intellij.psi.xml.XmlTag)1 Converter (com.intellij.util.xml.Converter)1 ResolvingConverter (com.intellij.util.xml.ResolvingConverter)1 DomExtension (com.intellij.util.xml.reflect.DomExtension)1 InterpolatorElement (org.jetbrains.android.dom.animation.InterpolatorElement)1 CompositeConverter (org.jetbrains.android.dom.converters.CompositeConverter)1 ManifestPlaceholderConverter (org.jetbrains.android.dom.converters.ManifestPlaceholderConverter)1 ResourceReferenceConverter (org.jetbrains.android.dom.converters.ResourceReferenceConverter)1 MenuItem (org.jetbrains.android.dom.menu.MenuItem)1 XmlRawResourceElement (org.jetbrains.android.dom.raw.XmlRawResourceElement)1 XmlResourceElement (org.jetbrains.android.dom.xml.XmlResourceElement)1 SystemResourceManager (org.jetbrains.android.resourceManagers.SystemResourceManager)1