← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/fontconfig/intrepid

« back to all changes in this revision

Viewing changes to doc/fcstring.fncs

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-12-05 14:16:40 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20071205141640-xikzw02c8gpgndze
Tags: 2.5.0-2ubuntu1
* Merge with Debian; remaining changes:
  - conf.d/40-nonlatin.conf: Add `MgOpen Moderna' to the list of fonts
    for which we might fall back to sans-serif.
  - conf.d/60-latin.conf: Prefer DejaVu over Bitstream Vera,
    as done for dapper.
  - 52-languageselector.conf loads language-selector.conf.
  - Include 52-languageselector.conf in the lists in conf.d/Makefile.am so
    that it actually gets installed and used.  Fixes LP 73714.
  - Some hackery in the debconf config script which attempts to upgrade
    user preferences across the many changes which have occurred to the
    debconf questions.  In particular:
    + Do not attempt to divine enable_bitmaps option by reading the
      symlinks in /etc.  This leaves the only way to permanently change
      the behaviour being dpkg-reconfigure.  The divination code was
      wrong and was intended by Debian to preserve pre-debconf
      configuration.  It would be nicer to preserve handmade updates to
      the /etc directory.
    + Always create /etc/fontconfig/conf.d/ symlink for enabling or
      disabling bitmap fonts.  This records the state from debconf
      unambiguously into the filesystem and will make it possible for
      future upgrades (from Edgy or later) to preserve handmade changes.
  - Add a (optional) include for "language-selector.conf" in fonts.conf
  - debian/patches/03_preferred_symbol_font.patch:
    + prefer "Standard Symbols L" as symbol font (Ubuntu: #37745)
  - Fix incorrect location of /usr/share/X11/fonts.
  - Correctly fix the (eg) firefox vs. (eg) evince font metrics problem:
    + New FC_ANY_METRICS property, boolean.
    + Change URW Nimbus and AMT font aliases in 30-{urw,metric}-aliases.conf
      into equivalent <match> directives so that we can add an additional
      test which disables them when the anymetrics property is true.
* Link using -Bsymbolic-functions.
* debian/rules (clean): Clean doc directory.
* debian/rules: Set shell to /bin/bash.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/fcstring.fncs
32
32
@DESC@
33
33
Converts the next Unicode char from <parameter>src</parameter> into
34
34
<parameter>dst</parameter> and returns the number of bytes containing the
35
 
char.  <parameter>src</parameter> nust be at least
 
35
char.  <parameter>src</parameter> must be at least
36
36
<parameter>len</parameter> bytes long.
37
37
@@
38
38
 
97
97
string.
98
98
@@
99
99
 
 
100
@RET@           FcBool
 
101
@FUNC@          FcIsLower
 
102
@TYPE1@         FcChar8                         @ARG1@          c
 
103
@PURPOSE@       check for lower case ASCII character
 
104
@DESC@
 
105
This macro checks whether <parameter>c</parameter> is an lower case ASCII
 
106
letter.
 
107
@@
 
108
 
 
109
@RET@           FcBool
 
110
@FUNC@          FcIsUpper
 
111
@TYPE1@         FcChar8                         @ARG1@          c
 
112
@PURPOSE@       check for upper case ASCII character
 
113
@DESC@
 
114
This macro checks whether <parameter>c</parameter> is a upper case ASCII
 
115
letter.
 
116
@@
 
117
 
 
118
@RET@           FcChar8
 
119
@FUNC@          FcToLower
 
120
@TYPE1@         FcChar8                         @ARG1@          c
 
121
@PURPOSE@       convert upper case ASCII to lower case
 
122
@DESC@
 
123
This macro converts upper case ASCII <parameter>c</parameter> to the
 
124
equivalent lower case letter.
 
125
@@
 
126
 
100
127
@RET@           FcChar8 *
101
128
@FUNC@          FcStrCopy
102
129
@TYPE1@         const FcChar8 *                 @ARG1@          s
119
146
@RET@           FcChar8 *
120
147
@FUNC@          FcStrCopyFilename
121
148
@TYPE1@         const FcChar8 *                 @ARG1@          s
122
 
@PURPOSE@       copy a string, expanding '~'
123
 
@DESC@
124
 
Just like FcStrCopy except that it converts any leading '~' characters in
125
 
<parameter>s</parameter> to the value of the HOME environment variable.
126
 
Returns NULL if '~' is present in <parameter>s</parameter> and HOME is unset.
 
149
@PURPOSE@       create a complete path from a filename
 
150
@DESC@
 
151
<function>FcStrCopyFilename</function> constructs an absolute pathname from
 
152
<parameter>s</parameter>. It converts any leading '~' characters in
 
153
to the value of the HOME environment variable, and any relative paths are
 
154
converted to absolute paths using the current working directory. Sequences
 
155
of '/' characters are converted to a single '/', and names containing the
 
156
current directory '.' or parent directory '..' are correctly reconstructed.
 
157
Returns NULL if '~' is the leading character and HOME is unset or disabled
 
158
(see <function>FcConfigEnableHome</function>).
 
159
@@
 
160
 
 
161
@RET@           int
 
162
@FUNC@          FcStrCmp
 
163
@TYPE1@         const FcChar8 *                 @ARG1@          s1
 
164
@TYPE2@         const FcChar8 *                 @ARG2@          s2
 
165
@PURPOSE@       compare UTF-8 strings
 
166
@DESC@
 
167
Returns the usual &lt;0, 0, &gt;0 result of comparing
 
168
<parameter>s1</parameter> and <parameter>s2</parameter>. 
127
169
@@
128
170
 
129
171
@RET@           int
130
172
@FUNC@          FcStrCmpIgnoreCase
131
173
@TYPE1@         const FcChar8 *                 @ARG1@          s1
132
174
@TYPE2@         const FcChar8 *                 @ARG2@          s2
133
 
@PURPOSE@       compare UTF-8 strings ignoring ASCII case
 
175
@PURPOSE@       compare UTF-8 strings ignoring case
134
176
@DESC@
135
177
Returns the usual &lt;0, 0, &gt;0 result of comparing
136
 
<parameter>s1</parameter> and <parameter>s2</parameter>.  This test is
137
 
case-insensitive in the ASCII range and will operate properly with UTF8
138
 
encoded strings, although it does not check for well formed strings.
 
178
<parameter>s1</parameter> and <parameter>s2</parameter>. This test is
 
179
case-insensitive for all proper UTF-8 encoded strings.
139
180
@@
140
181
 
141
182
@RET@           FcChar8 *
142
183
@FUNC@          FcStrStr
143
 
@TYPE1@         const char *                    @ARG1@          s1
144
 
@TYPE2@         const char *                    @ARG2@          s2
 
184
@TYPE1@         const FcChar8 *                 @ARG1@          s1
 
185
@TYPE2@         const FcChar8 *                 @ARG2@          s2
145
186
@PURPOSE@       locate UTF-8 substring
146
187
@DESC@
147
188
Returns the location of <parameter>s2</parameter> in
148
189
<parameter>s1</parameter>.  Returns NULL if <parameter>s2</parameter>
149
190
is not present in <parameter>s1</parameter>. This test will operate properly
150
 
with UTF8 encoded strings, although it does not check for well formed
151
 
strings.
 
191
with UTF8 encoded strings.
152
192
@@
153
193
 
154
194
@RET@           FcChar8 *
155
195
@FUNC@          FcStrStrIgnoreCase
156
 
@TYPE1@         const char *                    @ARG1@          s1
157
 
@TYPE2@         const char *                    @ARG2@          s2
 
196
@TYPE1@         const FcChar8 *                 @ARG1@          s1
 
197
@TYPE2@         const FcChar8 *                 @ARG2@          s2
158
198
@PURPOSE@       locate UTF-8 substring ignoring ASCII case
159
199
@DESC@
160
200
Returns the location of <parameter>s2</parameter> in 
161
 
<parameter>s1</parameter>, ignoring ASCII case.  Returns NULL if
 
201
<parameter>s1</parameter>, ignoring case.  Returns NULL if
162
202
<parameter>s2</parameter> is not present in <parameter>s1</parameter>.
163
 
This test is case-insensitive in the ASCII range and will operate properly
164
 
with UTF8 encoded strings, although it does not check for well formed
165
 
strings.
166
 
@@
 
203
This test is case-insensitive for all proper UTF-8 encoded strings.
 
204
@@
 
205
 
 
206
@RET@           FcChar8 *
 
207
@FUNC@          FcStrPlus
 
208
@TYPE1@         const FcChar8 *                 @ARG1@          s1
 
209
@TYPE2@         const FcChar8 *                 @ARG2@          s2
 
210
@PURPOSE@       concatenate two strings
 
211
@DESC@
 
212
This function allocates new storage and places the concatenation of
 
213
<parameter>s1</parameter> and <parameter>s2</parameter> there, returning the
 
214
new string.
 
215
@@
 
216
 
 
217
@RET@           void
 
218
@FUNC@          FcStrFree
 
219
@TYPE1@         FcChar8 *                       @ARG1@          s
 
220
@PURPOSE@       free a string
 
221
@DESC@
 
222
This is just a wrapper around free(3) which helps track memory usage of
 
223
strings within the fontconfig library.
167
224
 
168
225
@RET@           FcChar8 *
169
226
@FUNC@          FcStrDirname