Add ref counting to font config patterns so that FcFontSort return values
[platform/upstream/fontconfig.git] / fonts.dtd
1 <!-- This is the Document Type Definition for font configuration files -->
2 <!ELEMENT fontconfig (dir | 
3                       cache | 
4                       include | 
5                       config |
6                       match | 
7                       alias)* >
8
9 <!-- 
10     Add a directory that provides fonts
11 -->
12 <!ELEMENT dir (#PCDATA)>
13 <!ATTLIST dir xml:space (default|preserve) 'preserve'>
14
15 <!--
16     Define the per-user file that holds cache font information.
17
18     If the filename begins with '~', it is replaced with the users
19     home directory path.
20 -->
21 <!ELEMENT cache (#PCDATA)>
22 <!ATTLIST cache xml:space (default|preserve) 'preserve'>
23
24 <!--
25     Reference another configuration file; note that this
26     is another complete font configuration file and not
27     just a file included by the XML parser.
28
29     Set 'ignore_missing' to 'yes' if errors are to be ignored.
30
31     If the filename begins with '~', it is replaced with the users
32     home directory path.
33 -->
34 <!ELEMENT include (#PCDATA)>
35 <!ATTLIST include
36           ignore_missing    (no|yes)            "no"
37           xml:space         (default|preserve)  "preserve">
38
39 <!--
40     Global library configuration data
41  -->
42 <!ELEMENT config (blank|rescan)*>
43
44 <!--
45     Specify the set of Unicode encoding values which
46     represent glyphs that are allowed to contain no
47     data.  With this list, fontconfig can examine
48     fonts for broken glyphs and eliminate them from
49     the set of valid Unicode chars.  This idea
50     was borrowed from Mozilla
51  -->
52 <!ELEMENT blank (int)*>
53
54 <!--
55     Aliases are just a special case for multiple match elements
56
57     They are syntactically equivalent to:
58
59     <match>
60         <test name="family">
61             <string value=[family]/>
62         </test>
63         <edit name="family" mode="prepend">
64             <string value=[prefer]/>
65             ...
66         </edit>
67         <edit name="family" mode="append">
68             <string value=[accept]/>
69             ...
70         </edit>
71         <edit name="family" mode="append_last">
72             <string value=[default]/>
73             ...
74         </edit>
75     </match>
76 -->
77 <!--
78     Periodically rescan the font configuration and
79     directories to synch internal state with filesystem
80  -->
81 <!ELEMENT rescan (int)>
82
83
84 <!ELEMENT alias (family*, prefer?, accept?, default?)>
85 <!ELEMENT prefer (family)*>
86 <!ELEMENT accept (family)*>
87 <!ELEMENT default (family)*>
88 <!ELEMENT family (#PCDATA)>
89 <!ATTLIST family xml:space (default|preserve) 'preserve'>
90
91 <!ENTITY % expr 'int|double|string|matrix|bool|charset
92                 |name|const
93                 |or|and|eq|not_eq|less|less_eq|more|more_eq
94                 |plus|minus|times|divide|not|if'>
95
96 <!--
97     Match and edit patterns.
98
99     If 'target' is 'pattern', execute the match before selecting a font.
100     if 'target' is 'font', execute the match on the result of a font
101     selection.
102 -->
103 <!ELEMENT match (test*, edit*)>
104 <!ATTLIST match
105           target (pattern|font) "pattern">
106
107 <!--
108     Match a field in a pattern
109
110     if 'qual' is 'any', then the match succeeds if any value in the field matches.
111     if 'qual' is 'all', then the match succeeds only if all values match.
112     if 'qual' is 'first', then the match succeeds only if the first value matches.
113     if 'qual' is 'not_first', then the match succeeds only if any value other than
114         the first matches.
115 -->
116 <!ELEMENT test (%expr;)*>
117 <!ATTLIST test 
118           qual (any|all|first|not_first)    "any"
119           name CDATA        #REQUIRED
120           compare (eq|not_eq|less|less_eq|more|more_eq) "eq">
121
122 <!--
123     Edit a field in a pattern
124
125     The enclosed values are used together to edit the list of values
126     associated with 'name'.
127
128     If 'name' matches one of those used in a test element for this match element:
129         if 'mode' is 'assign', replace the matched value.
130         if 'mode' is 'assign_replace', replace all of the values
131         if 'mode' is 'prepend', insert before the matched value
132         if 'mode' is 'append', insert after the matched value
133         if 'mode' is 'prepend_first', insert before all of the values
134         if 'mode' is 'append_last', insert after all of the values
135     If 'name' doesn't match any of those used in a test element:
136         if 'mode' is 'assign' or 'assign_replace, replace all of the values
137         if 'mode' is 'prepend' or 'prepend_first', insert before all of the values
138         if 'mode' is 'append' or 'append_last', insert after all of the values
139 -->
140 <!ELEMENT edit (%expr;)*>
141 <!ATTLIST edit
142           name CDATA        #REQUIRED
143           mode (assign|assign_replace|prepend|append|prepend_first|append_last) "assign">
144
145 <!--
146     Elements of expressions follow
147 -->
148 <!ELEMENT int (#PCDATA)>
149 <!ATTLIST int xml:space (default|preserve) 'preserve'>
150 <!ELEMENT double (#PCDATA)>
151 <!ATTLIST double xml:space (default|preserve) 'preserve'>
152 <!ELEMENT string (#PCDATA)>
153 <!ATTLIST string xml:space (default|preserve) 'preserve'>
154 <!ELEMENT matrix (double,double,double,double)>
155 <!ELEMENT bool (true|false)>
156 <!ELEMENT charset (#PCDATA)>
157 <!ATTLIST charset xml:space (default|preserve) 'preserve'>
158 <!ELEMENT name (#PCDATA)>
159 <!ATTLIST name xml:space (default|preserve) 'preserve'>
160 <!ELEMENT const (#PCDATA)>
161 <!ATTLIST const xml:space (default|preserve) 'preserve'>
162 <!ELEMENT or (%expr;)*>
163 <!ELEMENT and (%expr;)*>
164 <!ELEMENT eq ((%expr;), (%expr;))>
165 <!ELEMENT not_eq ((%expr;), (%expr;))>
166 <!ELEMENT less ((%expr;), (%expr;))>
167 <!ELEMENT less_eq ((%expr;), (%expr;))>
168 <!ELEMENT more ((%expr;), (%expr;))>
169 <!ELEMENT more_eq ((%expr;), (%expr;))>
170 <!ELEMENT plus (%expr;)*>
171 <!ELEMENT minus (%expr;)*>
172 <!ELEMENT times (%expr;)*>
173 <!ELEMENT divide (%expr;)*>
174 <!ELEMENT not (%expr;)>
175 <!ELEMENT if ((%expr;), (%expr;), (%expr;))>