Fix for Bug 214649 [Markers] Allow markerAttributeGroupings and markerGroups to be specified within contentGenerators

1 files changed, 54 insertions, 76 deletions

diff --git a/bundles/org.eclipse.ui.ide/schema/markerSupport.exsd b/bundles/org.eclipse.ui.ide/schema/markerSupport.exsd
index 4db07cdbba2..e3c46a2be8e 100644
--- a/bundles/org.eclipse.ui.ide/schema/markerSupport.exsd
+++ b/bundles/org.eclipse.ui.ide/schema/markerSupport.exsd
@@ -190,24 +190,65 @@ ON_ANY_IN_SAME_CONTAINER: on any item with the same top level container as the s
       </complexType>
    </element>
 
+   <element name="markerAttributeGrouping">
+      <annotation>
+         <documentation>
+            markerAttributeGrouping is a definition of attribute mappings for a particular markerType.
+
+markerAttributeGroupings defined at the top level are only applied to the problems view for compatibility with the pre 3.4 API.
+
+It is generally recommended that a markerAttributeGrouping is defined as a child element of a markerGroup.
+         </documentation>
+      </annotation>
+      <complexType>
+         <sequence>
+            <element ref="markerAttributeMapping" minOccurs="0" maxOccurs="unbounded"/>
+         </sequence>
+         <attribute name="markerType" type="string" use="required">
+            <annotation>
+               <documentation>
+                  The id of the markerType this grouping applies to.
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="attribute" type="string">
+            <annotation>
+               <documentation>
+                  The attribute is the name of the attribute to test. If it is not specified then only the defaultGroupingEntry will be checked.
+               </documentation>
+            </annotation>
+         </attribute>
+         <attribute name="defaultGroupingEntry" type="string">
+            <annotation>
+               <documentation>
+                  The defaultGroupingEntry is the optional category for groupings that do not satisfy any of the markerAttributeMappings in the receiver. This default will be applied when the attribute value does not match a mapping or when the attribute is not available.
+               </documentation>
+            </annotation>
+         </attribute>
+      </complexType>
+   </element>
+
    <element name="markerGrouping">
       <annotation>
          <appInfo>
             <meta.element labelAttribute="label"/>
          </appInfo>
          <documentation>
-            A markerGrouping is a definition of a grouping criterea for the marker views that support it . The sort order of the group is the order of specification of attribute mappings.
+            A markerGrouping is a definition of a grouping criterea for the marker views that support it . 
+
+Top level markerGroupings are assumed to belong to the problems content generator.
 
-The markerSupportReferences in a markerGrouping are for references to markerContentGenerator only.  markerGroupings with no markerSupportReferences are assumed to belong to the problems content generator.
+A markerGrouping is usually specified as the child of a markerContentGenerator. It is recommended that a markerContentGenerator defines it&apos;s own markerGroupings if possible.
 
-A markerGrouping is bound to a markerContentGenerator by a markerSupportReference . A markerContentGenerator also specifies it&apos;s markerGroupings via a markerSupportReference. It is recommended that a markerContentGenerator defines it&apos;s own markerGroupings if possible.
+Note that only the problems view supported markerGroupings pre 3.4.
 
-Note that the markerSupportReference support was added in version 3.4  and only the problems view supported markerGroupings pre 3.4.
+If a markerGrouping has id org.eclipse.ui.ide.types the internal types marker grouping will be used.
          </documentation>
       </annotation>
       <complexType>
          <sequence minOccurs="0" maxOccurs="unbounded">
-            <element ref="markerSupportReference"/>
+            <element ref="markerGroupingEntry"/>
+            <element ref="markerAttributeGrouping" minOccurs="0" maxOccurs="unbounded"/>
          </sequence>
          <attribute name="label" type="string" use="required">
             <annotation>
@@ -259,7 +300,9 @@ Note that the markerSupportReference support was added in version 3.4  and only
             <meta.element labelAttribute="label"/>
          </appInfo>
          <documentation>
-            A markerGroupingEntry is the specification of one of the entries in a markerGrouping.
+            A markerGroupingEntry is the specification of one of the entries in a markerGrouping. A top level markerGroupingEntry can only be applied to a top level markerGrouping for compatibility with the pre 3.4 API.
+
+It is recommended that a markerGroupingEntry is specified as a child element of a markerGrouping.
          </documentation>
       </annotation>
       <complexType>
@@ -270,10 +313,12 @@ Note that the markerSupportReference support was added in version 3.4  and only
                </documentation>
             </annotation>
          </attribute>
-         <attribute name="markerGrouping" type="string" use="required">
+         <attribute name="markerGrouping" type="string">
             <annotation>
                <documentation>
                   The markerGrouping is the id of the markerGrouping this entry will be added to.
+
+This attribute is optional if this is defined as a child element of a markerGrouping.
                </documentation>
             </annotation>
          </attribute>
@@ -297,40 +342,6 @@ Note that the markerSupportReference support was added in version 3.4  and only
       </complexType>
    </element>
 
-   <element name="markerAttributeGrouping">
-      <annotation>
-         <documentation>
-            markerAttributeGrouping is a definition of attribute mappings for a particular markerType
-         </documentation>
-      </annotation>
-      <complexType>
-         <sequence>
-            <element ref="markerAttributeMapping" minOccurs="0" maxOccurs="unbounded"/>
-         </sequence>
-         <attribute name="markerType" type="string" use="required">
-            <annotation>
-               <documentation>
-                  The id of the markerType this grouping applies to.
-               </documentation>
-            </annotation>
-         </attribute>
-         <attribute name="attribute" type="string">
-            <annotation>
-               <documentation>
-                  The attribute is the name of the attribute to test. If it is not specified then only the defaultGroupingEntry will be checked.
-               </documentation>
-            </annotation>
-         </attribute>
-         <attribute name="defaultGroupingEntry" type="string">
-            <annotation>
-               <documentation>
-                  The defaultGroupingEntry is the optional category for groupings that do not satisfy any of the markerAttributeMappings in the receiver. This default will be applied when the attribute value does not match a mapping or when the attribute is not available.
-               </documentation>
-            </annotation>
-         </attribute>
-      </complexType>
-   </element>
-
    <element name="markerContentGenerator">
       <annotation>
          <appInfo>
@@ -347,7 +358,7 @@ The markerSupportReferences in a markerContentGenerator are for references to ma
             <element ref="markerFieldReference" minOccurs="1" maxOccurs="unbounded"/>
             <element ref="markerTypeReference" minOccurs="1" maxOccurs="unbounded"/>
             <element ref="markerFieldFilterGrouping" minOccurs="0" maxOccurs="unbounded"/>
-            <element ref="markerSupportReference" minOccurs="0" maxOccurs="unbounded"/>
+            <element ref="markerGrouping" minOccurs="0" maxOccurs="unbounded"/>
          </sequence>
          <attribute name="id" type="string" use="required">
             <annotation>
@@ -369,7 +380,7 @@ The markerSupportReferences in a markerContentGenerator are for references to ma
          <attribute name="defaultMarkerGrouping" type="string">
             <annotation>
                <documentation>
-                  defaultMarkerGrouping is the id of the grouping to use by default.
+                  defaultMarkerGrouping is the id of the grouping to use by default. This grouping must be defined as child element of the markerContentGenerator
                </documentation>
             </annotation>
          </attribute>
@@ -480,7 +491,6 @@ The markerSupport references are references to the markerContentGenerator that t
       </annotation>
       <complexType>
          <sequence>
-            <element ref="markerSupportReference" minOccurs="0" maxOccurs="unbounded"/>
          </sequence>
          <attribute name="id" type="string" use="required">
             <annotation>
@@ -544,38 +554,6 @@ If this value is not set the value is ON_ANY
       </complexType>
    </element>
 
-   <element name="markerSupportReference">
-      <annotation>
-         <documentation>
-            A markerSupportReference is a reference to another markerSupport entry
-         </documentation>
-      </annotation>
-      <complexType>
-         <attribute name="id" type="string">
-            <annotation>
-               <documentation>
-                  The id of the element being referenced
-               </documentation>
-            </annotation>
-         </attribute>
-         <attribute name="type" use="required">
-            <annotation>
-               <documentation>
-                  The element type being referenced.
-               </documentation>
-            </annotation>
-            <simpleType>
-               <restriction base="string">
-                  <enumeration value="markerContentGenerator">
-                  </enumeration>
-                  <enumeration value="markerGrouping">
-                  </enumeration>
-               </restriction>
-            </simpleType>
-         </attribute>
-      </complexType>
-   </element>
-
    <annotation>
       <appInfo>
          <meta.section type="since"/>