blob: 79161619c0712d89a9dcfb6d9a494d5b87eff3be [file] [log] [blame]
scottb@google.com6876b702008-03-07 18:01:39 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!-- -->
scottb@google.com1b420bf2008-09-16 00:43:25 +00003<!-- Copyright 2008 Google Inc. -->
scottb@google.com6876b702008-03-07 18:01:39 +00004<!-- Licensed under the Apache License, Version 2.0 (the "License"); you -->
5<!-- may not use this file except in compliance with the License. You may -->
6<!-- may obtain a copy of the License at -->
7<!-- -->
8<!-- http://www.apache.org/licenses/LICENSE-2.0 -->
9<!-- -->
10<!-- Unless required by applicable law or agreed to in writing, software -->
11<!-- distributed under the License is distributed on an "AS IS" BASIS, -->
12<!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -->
13<!-- implied. License for the specific language governing permissions and -->
14<!-- limitations under the License. -->
15
16<!-- The module root element -->
17<!ELEMENT module (inherits | source | public | super-source | entry-point |
18 stylesheet | script | servlet | replace-with | generate-with |
rice@google.com365c5682009-06-17 19:30:44 +000019 define-property | extend-property | set-property |
20 clear-configuration-property | define-configuration-property |
21 extend-configuration-property | set-configuration-property |
scottb@google.com1b420bf2008-09-16 00:43:25 +000022 property-provider | define-linker | add-linker)*>
gwt.team.bobv99abf172008-03-21 21:11:08 +000023<!ATTLIST module
24 rename-to CDATA #IMPLIED
25>
scottb@google.com6876b702008-03-07 18:01:39 +000026<!-- Inherit the contents of another module -->
27<!ELEMENT inherits EMPTY>
28<!ATTLIST inherits
29 name CDATA #REQUIRED
30>
31<!-- Specify the source path, relative to the classpath location of the module descriptor -->
32<!ELEMENT source (include | exclude)*>
33<!ATTLIST source
34 path CDATA #REQUIRED
35 includes CDATA #IMPLIED
36 excludes CDATA #IMPLIED
scottb@google.com9de92df2008-06-03 21:07:45 +000037 defaultexcludes (yes | no) "yes"
scottb@google.com6876b702008-03-07 18:01:39 +000038 casesensitive (true | false) "true"
39>
40<!-- Specify the public resource path, relative to the classpath location of the module descriptor -->
41<!ELEMENT public (include | exclude)*>
42<!ATTLIST public
43 path CDATA #REQUIRED
44 includes CDATA #IMPLIED
45 excludes CDATA #IMPLIED
scottb@google.com9de92df2008-06-03 21:07:45 +000046 defaultexcludes (yes | no) "yes"
scottb@google.com6876b702008-03-07 18:01:39 +000047 casesensitive (true | false) "true"
48>
49<!-- Specify a source path that rebases subpackages into the root namespace -->
50<!ELEMENT super-source (include | exclude)*>
51<!ATTLIST super-source
52 path CDATA #REQUIRED
53 includes CDATA #IMPLIED
54 excludes CDATA #IMPLIED
scottb@google.com9de92df2008-06-03 21:07:45 +000055 defaultexcludes (yes | no) "yes"
scottb@google.com6876b702008-03-07 18:01:39 +000056 casesensitive (true | false) "true"
57>
58<!ELEMENT include EMPTY>
59<!ATTLIST include
60 name CDATA #REQUIRED
61>
62<!ELEMENT exclude EMPTY>
63<!ATTLIST exclude
64 name CDATA #REQUIRED
gwt.team.bobv8cc661b2008-02-14 00:08:19 +000065>
66
scottb@google.com6876b702008-03-07 18:01:39 +000067<!-- Define a module entry point -->
68<!ELEMENT entry-point EMPTY>
69<!ATTLIST entry-point
70 class CDATA #REQUIRED
71>
72
73<!-- Preload a stylesheet before executing the GWT application -->
74<!ELEMENT stylesheet EMPTY>
75<!ATTLIST stylesheet
76 src CDATA #REQUIRED
77>
78<!-- Preload an external JavaScript file before executing the GWT application -->
79<!ELEMENT script (#PCDATA)>
80<!ATTLIST script
81 src CDATA #REQUIRED
82>
83<!-- Map a named servlet class to a module-relative path in hosted mode -->
84<!ELEMENT servlet EMPTY>
85<!ATTLIST servlet
86 path CDATA #REQUIRED
87 class CDATA #REQUIRED
88>
gwt.team.bobv8cc661b2008-02-14 00:08:19 +000089
gwt.team.bobv99abf172008-03-21 21:11:08 +000090<!-- Adds a Linker to the compilation process -->
91<!ELEMENT add-linker EMPTY>
gwt.team.bobv8cc661b2008-02-14 00:08:19 +000092<!-- A comma-separated list of linker names -->
gwt.team.bobv99abf172008-03-21 21:11:08 +000093<!ATTLIST add-linker
scottb@google.com1b420bf2008-09-16 00:43:25 +000094 name CDATA #REQUIRED
gwt.team.bobv8cc661b2008-02-14 00:08:19 +000095>
96
97<!-- Defines a Linker type to package compiler output -->
gwt.team.bobv99abf172008-03-21 21:11:08 +000098<!ELEMENT define-linker EMPTY>
99<!ATTLIST define-linker
scottb@google.com1b420bf2008-09-16 00:43:25 +0000100 class CDATA #REQUIRED
101 name CDATA #REQUIRED
gwt.team.bobv8cc661b2008-02-14 00:08:19 +0000102>
scottb@google.com6876b702008-03-07 18:01:39 +0000103
104<!-- ^^^ Commonly-used elements ^^^ -->
105<!-- VVV Deferred binding elements VVV -->
106
107<!-- Define a property and allowable values (comma-separated identifiers) -->
108<!ELEMENT define-property EMPTY>
109<!ATTLIST define-property
110 name CDATA #REQUIRED
111 values CDATA #REQUIRED
112>
rice@google.com365c5682009-06-17 19:30:44 +0000113<!-- Define a configuration property -->
114<!ELEMENT define-configuration-property EMPTY>
115<!ATTLIST define-configuration-property
116 name CDATA #REQUIRED
117 is-multi-valued CDATA #REQUIRED
118>
scottb@google.com6876b702008-03-07 18:01:39 +0000119<!-- Set the value of a previously-defined property -->
120<!ELEMENT set-property EMPTY>
121<!ATTLIST set-property
122 name CDATA #REQUIRED
123 value CDATA #REQUIRED
124>
scottb@google.com1b420bf2008-09-16 00:43:25 +0000125<!-- Set the value of a configuration property -->
126<!ELEMENT set-configuration-property EMPTY>
127<!ATTLIST set-configuration-property
128 name CDATA #REQUIRED
129 value CDATA #REQUIRED
130>
scottb@google.com6876b702008-03-07 18:01:39 +0000131<!-- Add additional allowable values to a property -->
132<!ELEMENT extend-property EMPTY>
133<!ATTLIST extend-property
134 name CDATA #REQUIRED
135 values CDATA #REQUIRED
136>
rice@google.com365c5682009-06-17 19:30:44 +0000137<!-- Add additional allowable values to a configuration property -->
138<!ELEMENT extend-configuration-property EMPTY>
139<!ATTLIST extend-configuration-property
140 name CDATA #REQUIRED
141 value CDATA #REQUIRED
142>
143<!-- Remove all allowable values from a configuration property -->
144<!ELEMENT clear-configuration-property EMPTY>
145<!ATTLIST clear-configuration-property
146 name CDATA #REQUIRED
147>
scottb@google.com6876b702008-03-07 18:01:39 +0000148<!-- Define a JavaScript fragment that will return the value for the named property at runtime -->
149<!ELEMENT property-provider (#PCDATA)>
150<!ATTLIST property-provider
151 name CDATA #REQUIRED
152>
153<!-- All possible predicates -->
154<!ENTITY % predicates "when-property-is | when-type-assignable | when-type-is | all | any | none">
155<!-- Deferred binding assignment to substitute a named class -->
156<!ELEMENT replace-with (%predicates;)*>
157<!ATTLIST replace-with
158 class CDATA #REQUIRED
159>
160<!-- Deferred binding assignment to substitute a generated class -->
161<!ELEMENT generate-with (%predicates;)*>
162<!ATTLIST generate-with
163 class CDATA #REQUIRED
164>
165<!-- Deferred binding predicate that is true when a named property has a given value-->
166<!ELEMENT when-property-is EMPTY>
167<!ATTLIST when-property-is
168 name CDATA #REQUIRED
169 value CDATA #REQUIRED
170>
171<!-- Deferred binding predicate that is true for types in the type system that are assignable to the specified type -->
172<!ELEMENT when-type-assignable EMPTY>
173<!ATTLIST when-type-assignable
174 class CDATA #REQUIRED
175>
176<!-- Deferred binding predicate that is true for exactly one type in the type system -->
177<!ELEMENT when-type-is EMPTY>
178<!ATTLIST when-type-is
179 class CDATA #REQUIRED
180>
181<!-- Predicate that ANDs all child conditions -->
182<!ELEMENT all (%predicates;)*>
183<!-- Predicate that ORs all child conditions -->
184<!ELEMENT any (%predicates;)*>
185<!-- Predicate that NANDs all child conditions -->
186<!ELEMENT none (%predicates;)*>