Commit 8a8c6022bff205c7e98d6bef30ccc78f8f1fd8e0
2006-04-22T12:24:52
Formatting, copyright years, documentation.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
diff --git a/ChangeLog b/ChangeLog
index bef707b..e37d177 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,16 +1,25 @@
2006-04-21 David Turner <david@freetype.org>
- * include/freetype/ftincrem.h, include/freetype/ftmodapi.h,
- include/freetype/freetype.h: Documentation update
+ * include/freetype/ftincrem.h: Documentation updates.
+ (FT_Incremental_Interface): New typedef.
- * src/sfnt/ttcmap.c: removed compiler warnings (gcc-4.0.2)
+ * include/freetype/ftmodapi.h, include/freetype/ftglyph.h:
+ Documentation updates.
+
+ * include/freetype/freetype.h: Documentation update.
+ (FT_HAS_FAST_GLYPHS): Always set to 0.
+
+ * include/freetype/ftstroke.h, src/base/ftstroke.c (FT_Stroker_New):
+ Take an FT_Library argument instead of FT_Memory.
+
+ * src/sfnt/ttcmap.c: Remove compiler warnings (gcc-4.0.2).
2006-04-13 David Turner <david@freetype.org>
- * src/autofit/afloader.c: removing superfluous code in the auto-fitter's
- loader
+ * src/autofit/afloader.c (af_loader_init, af_loader_load_g): Remove
+ superfluous code in the auto-fitter's loader.
-2006-04-05 Detlef Wrkner <TetiSoft@apg.lahn.de>
+2006-04-05 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile: Added FT2_BUILD_LIBRARY define.
@@ -43,7 +52,7 @@
* builds/unix/install.mk (uninstall): Don't handle `cache'
directory which no longer exists.
-2006-03-29 Detlef Wrkner <TetiSoft@apg.lahn.de>
+2006-03-29 Detlef Würkner <TetiSoft@apg.lahn.de>
* src/psaux/psconv.c: Changed some variables which are expected to
hold negative values from `char' to `FT_Char' to allow building with
@@ -1622,7 +1631,7 @@
(tt_face_build_cmaps): Check table and offset correctly (equality is
missing).
-2005-11-15 Detlef Wrkner <TetiSoft@apg.lahn.de>
+2005-11-15 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/smakefile: Adjusted the compiler options
to the current sources, now really builds the gxvalid, gzip
@@ -1640,7 +1649,7 @@
builds/mac/FreeType.ppc_carbon.make.txt:
Updated for MPW to build all available modules.
-2005-11-21 H�ard Wall <haavardw@ifi.uio.no>
+2005-11-21 Håvard Wall <haavardw@ifi.uio.no>
* src/bdf/bdfdrivr.c (bdf_interpret_style, BDF_Face_Done): Fix small
memory leak.
@@ -1699,14 +1708,14 @@
FT_Done_Memory), builds/win32/ftdebug.c (FT_Message, FT_Panic):
s/FT_EXPORT/FT_BASE/.
-2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de>
+2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/src/base/ftdebug.c (FT_Trace_Get_Count,
FT_Trace_Get_Name, FT_Message, FT_Panic),
builds/amiga/src/base/ftsystem.c (FT_New_Memory, FT_Done_Memory,
FT_Stream_Open): s/FT_EXPORT/FT_BASE/.
-2005-11-17 Detlef Wrkner <TetiSoft@apg.lahn.de>
+2005-11-17 Detlef Würkner <TetiSoft@apg.lahn.de>
* builds/amiga/makefile, builds/amiga/makefile.os4,
builds/amiga/smakefile,
@@ -1790,7 +1799,7 @@
* src/type1/t1afm.c (T1_Read_PFM): Zero offset means `no kerning
table available'. From Sergey Tolstov <stolstov@esri.com>.
-2005-11-03 Ville Syrj�� <syrjala@sci.fi>
+2005-11-03 Ville Syrjälä <syrjala@sci.fi>
* src/base/ftobjs.c (FT_Open_Face): Avoid possible memory leak.
diff --git a/include/freetype/freetype.h b/include/freetype/freetype.h
index 3f3925f..2097c58 100644
--- a/include/freetype/freetype.h
+++ b/include/freetype/freetype.h
@@ -211,8 +211,8 @@ FT_BEGIN_HEADER
/* <Description> */
/* A structure used to model the metrics of a single glyph. The */
/* values are expressed in 26.6 fractional pixel format; if the flag */
- /* @FT_LOAD_NO_SCALE was used when loading the glyph, values are */
- /* expressed in font units instead. */
+ /* @FT_LOAD_NO_SCALE has been used while loading the glyph, values */
+ /* are expressed in font units instead. */
/* */
/* <Fields> */
/* width :: */
@@ -412,16 +412,16 @@ FT_BEGIN_HEADER
/* */
/* <Note> */
/* Each @FT_Face has an _active_ @FT_Size object that is used by */
- /* functions like @FT_Load_Glyph to determine the scaling transform */
- /* used to load and hint glyph and metrics. */
+ /* functions like @FT_Load_Glyph to determine the scaling */
+ /* transformation which is used to load and hint glyphs and metrics. */
/* */
/* You can use @FT_Set_Char_Size, @FT_Set_Pixel_Sizes, */
/* @FT_Request_Size or even @FT_Select_Size to change the content */
- /* (i.e. scale) of the active @FT_Size. */
+ /* (i.e., the scaling values) of the active @FT_Size. */
/* */
- /* You can use @FT_New_Size to create additionnal size objects for a */
+ /* You can use @FT_New_Size to create additional size objects for a */
/* given @FT_Face, but they won't be used by other functions until */
- /* you activate it through @FT_Activate_Size. Only one size can be */
+ /* you activate it through @FT_Activate_Size. Only one size can be */
/* activated at any given time per face. */
/* */
/* <Also> */
@@ -520,12 +520,12 @@ FT_BEGIN_HEADER
/* */
/* <Description> */
/* An enumeration used to specify character sets supported by */
- /* charmaps. Used in the @FT_Select_Charmap API function. */
+ /* charmaps. Used in the @FT_Select_Charmap API function. */
/* */
/* <Note> */
- /* Despite the name, this enum lists specific character repertories */
- /* (i.e. charsets), and not text encoding methods (e.g. UTF-8, */
- /* UTF-16, GB2312_EUC, etc...) */
+ /* Despite the name, this enumeration lists specific character */
+ /* repertories (i.e., charsets), and not text encoding methods (e.g., */
+ /* UTF-8, UTF-16, GB2312_EUC, etc.). */
/* */
/* Because of 32-bit charcodes defined in Unicode (i.e., surrogates), */
/* all character codes must be expressed as FT_Longs. */
@@ -1156,10 +1156,10 @@ FT_BEGIN_HEADER
* FT_HAS_FAST_GLYPHS( face )
*
* @description:
- * Deprecated;
+ * Deprecated.
*
*/
-#define FT_HAS_FAST_GLYPHS( face ) 0
+#define FT_HAS_FAST_GLYPHS( face ) 0
/*************************************************************************
@@ -1334,7 +1334,7 @@ FT_BEGIN_HEADER
/* hence the forward structure declaration. */
/* */
/* You can however retrieve subglyph information with */
- /* @FT_Get_SubGlyph_Info */
+ /* @FT_Get_SubGlyph_Info. */
/* */
typedef struct FT_SubGlyphRec_* FT_SubGlyph;
@@ -1945,7 +1945,7 @@ FT_BEGIN_HEADER
/* depends on the font format (and thus the font driver). */
/* */
/* Client applications are expected to know what they are doing */
- /* when invoking this function. Most drivers simply do not implement */
+ /* when invoking this function. Most drivers simply do not implement */
/* file attachments. */
/* */
FT_EXPORT( FT_Error )
@@ -2912,11 +2912,11 @@ FT_BEGIN_HEADER
/* The glyph index. 0 means `undefined character code'. */
/* */
/* <Note> */
- /* If you use FreeType to manipulate the content of font files */
+ /* If you use FreeType to manipulate the contents of font files */
/* directly, be aware that the glyph index returned by this function */
/* doesn't always correspond to the internal indices used within */
- /* the file. This is done to ensure that value 0 always correspond */
- /* to 'missing glyph' */
+ /* the file. This is done to ensure that value 0 always corresponds */
+ /* to the `missing glyph'. */
/* */
FT_EXPORT( FT_UInt )
FT_Get_Char_Index( FT_Face face,
diff --git a/include/freetype/ftcache.h b/include/freetype/ftcache.h
index 430f4af..58c149a 100644
--- a/include/freetype/ftcache.h
+++ b/include/freetype/ftcache.h
@@ -285,10 +285,10 @@ FT_BEGIN_HEADER
/* library :: The parent FreeType library handle to use. */
/* */
/* max_faces :: Maximum number of opened @FT_Face objects managed by */
- /* this cache instance. Use 0 for defaults */
+ /* this cache instance. Use 0 for defaults. */
/* */
/* max_sizes :: Maximum number of opened @FT_Size objects managed by */
- /* this cache instance. Use 0 for defaults */
+ /* this cache instance. Use 0 for defaults. */
/* */
/* max_bytes :: Maximum number of bytes to use for cached data nodes. */
/* Use 0 for defaults. Note that this value does not */
@@ -500,27 +500,33 @@ FT_BEGIN_HEADER
FTC_Manager manager );
- /**
- * @function: FTC_Manager_RemoveFaceID
- *
- * @description:
- * a special function used to indicate to the cache manager that
- * a given @FTC_FaceID is no longer valid, either because it
- * content changed, or because it was deallocated/uninstalled
- *
- * @input:
- * manager :: cache manager handle
- * face_id :: the @FTC_FaceID to be removed
- *
- * @note:
- * this function will flush all nodes from the cache corresponding
- * to this face_id, with the exception of nodes with a non-0 reference
- * count.
- *
- * these nodes are however modified internally so as to never appear
- * in later lookups with the same face_id value, and to be immediately
- * destroyed when released by all their users.
- */
+ /*************************************************************************
+ *
+ * @function:
+ * FTC_Manager_RemoveFaceID
+ *
+ * @description:
+ * A special function used to indicate to the cache manager that
+ * a given @FTC_FaceID is no longer valid, either because its
+ * content changed, or because it was deallocated or uninstalled.
+ *
+ * @input:
+ * manager ::
+ * The cache manager handle.
+ *
+ * face_id ::
+ * The @FTC_FaceID to be removed.
+ *
+ * @note:
+ * This function flushes all nodes from the cache corresponding to this
+ * `face_id', with the exception of nodes with a non-null reference
+ * count.
+ *
+ * Such nodes are however modified internally so as to never appear
+ * in later lookups with the same `face_id' value, and to be immediately
+ * destroyed when released by all their users.
+ *
+ */
FT_EXPORT( void )
FTC_Manager_RemoveFaceID( FTC_Manager manager,
FTC_FaceID face_id );
@@ -626,18 +632,29 @@ FT_BEGIN_HEADER
/*************************************************************************/
/*************************************************************************/
- /**
- * @struct: FTC_ImageTypeRec
- *
- * @description:
- * a structure used to model the type of images in a glyph cache
- *
- * @fields:
- * face_id :: the face id
- * width :: width in pixels
- * height :: height in pixels
- * flags :: load flags, as in @FT_Load_Glyph
- */
+
+ /*************************************************************************
+ *
+ * @struct:
+ * FTC_ImageTypeRec
+ *
+ * @description:
+ * A structure used to model the type of images in a glyph cache.
+ *
+ * @fields:
+ * face_id ::
+ * The face ID.
+ *
+ * width ::
+ * The width in pixels.
+ *
+ * height ::
+ * The height in pixels.
+ *
+ * flags ::
+ * The load flags, as in @FT_Load_Glyph.
+ *
+ */
typedef struct FTC_ImageTypeRec_
{
FTC_FaceID face_id;
@@ -647,12 +664,16 @@ FT_BEGIN_HEADER
} FTC_ImageTypeRec;
- /**
- * @type: FTC_ImageType
- *
- * @description:
- * handle to an @FTC_ImageTypeRec structure
- */
+
+ /*************************************************************************
+ *
+ * @type:
+ * FTC_ImageType
+ *
+ * @description:
+ * A handle to an @FTC_ImageTypeRec structure.
+ *
+ */
typedef struct FTC_ImageTypeRec_* FTC_ImageType;
diff --git a/include/freetype/ftglyph.h b/include/freetype/ftglyph.h
index 2b6b4b5..73d3607 100644
--- a/include/freetype/ftglyph.h
+++ b/include/freetype/ftglyph.h
@@ -4,7 +4,7 @@
/* */
/* FreeType convenience functions to handle glyphs (specification). */
/* */
-/* Copyright 1996-2001, 2002, 2003 by */
+/* Copyright 1996-2001, 2002, 2003, 2006 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -151,7 +151,7 @@ FT_BEGIN_HEADER
/* */
/* <Note> */
/* You can typecast a @FT_Glyph to @FT_BitmapGlyph if you have */
- /* 'glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access */
+ /* `glyph->format == FT_GLYPH_FORMAT_BITMAP'. This lets you access */
/* the bitmap's contents easily. */
/* */
/* The corresponding pixel buffer is always owned by the BitmapGlyph */
@@ -195,7 +195,7 @@ FT_BEGIN_HEADER
/* */
/* <Note> */
/* You can typecast a @FT_Glyph to @FT_OutlineGlyph if you have */
- /* 'glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access */
+ /* `glyph->format == FT_GLYPH_FORMAT_OUTLINE'. This lets you access */
/* the outline's content easily. */
/* */
/* As the outline is extracted from a glyph slot, its coordinates are */
@@ -277,7 +277,7 @@ FT_BEGIN_HEADER
/* expressed in 1/64th of a pixel. */
/* */
/* <Return> */
- /* FreeType error code (if not 0, the glyph format is not scalable) */
+ /* FreeType error code (if not 0, the glyph format is not scalable). */
/* */
/* <Note> */
/* The 2x2 transformation matrix is also applied to the glyph's */
diff --git a/include/freetype/ftincrem.h b/include/freetype/ftincrem.h
index 6cf3c2d..3db0f79 100644
--- a/include/freetype/ftincrem.h
+++ b/include/freetype/ftincrem.h
@@ -31,7 +31,7 @@
FT_BEGIN_HEADER
- /***************************************************************
+ /***************************************************************************
*
* @section:
* incremental
@@ -43,21 +43,22 @@ FT_BEGIN_HEADER
* Custom Glyph Loading
*
* @description:
- * This section contains various functions used to perform
- * so-called "incremental" glyph loading. This is a mode where
- * all glyphs loaded from a given FT_Face are provided by the
- * client application,
- *
- * Apart from that, all other tables are loaded normally from
- * the font file. This mode is useful when FreeType is used
- * within another engine, e.g. a Postscript Imaging Processor.
- *
- * to enable this mode, you must use @FT_Open_Face, passing
- * an @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag
- * and a @FT_Incremental_Interface value. See the comments
- * for @FT_Incremental_InterfaceRec for an example.
+ * This section contains various functions used to perform so-called
+ * `incremental' glyph loading. This is a mode where all glyphs loaded
+ * from a given @FT_Face are provided by the client application,
+ *
+ * Apart from that, all other tables are loaded normally from the font
+ * file. This mode is useful when FreeType is used within another
+ * engine, e.g., a Postscript Imaging Processor.
+ *
+ * To enable this mode, you must use @FT_Open_Face, passing an
+ * @FT_Parameter with the @FT_PARAM_TAG_INCREMENTAL tag and an
+ * @FT_Incremental_Interface value. See the comments for
+ * @FT_Incremental_InterfaceRec for an example.
+ *
*/
+
/***************************************************************************
*
* @type:
@@ -295,11 +296,15 @@ FT_BEGIN_HEADER
} FT_Incremental_InterfaceRec;
- /***
- * @type: FT_Incremental_Interface
+
+ /***************************************************************************
+ *
+ * @type:
+ * FT_Incremental_Interface
*
* @description:
- * a pointer to a @FT_Incremental_InterfaceRec structure
+ * A pointer to an @FT_Incremental_InterfaceRec structure.
+ *
*/
typedef FT_Incremental_InterfaceRec* FT_Incremental_Interface;
diff --git a/include/freetype/ftmodapi.h b/include/freetype/ftmodapi.h
index bb6c342..27dc269 100644
--- a/include/freetype/ftmodapi.h
+++ b/include/freetype/ftmodapi.h
@@ -307,22 +307,23 @@ FT_BEGIN_HEADER
FT_Add_Default_Modules( FT_Library library );
- /***************************************************************
- *
- * @section:
- * ttengine
- *
- * @title:
- * TrueType Engine
- *
- * @abstract:
- * TrueType bytecode support
- *
- * @description:
- * This section contains a function used to query the level
- * of TrueType bytecode support compiled in this version of
- * the library.
- */
+ /**************************************************************************
+ *
+ * @section:
+ * ttengine
+ *
+ * @title:
+ * The TrueType Engine
+ *
+ * @abstract:
+ * TrueType bytecode support
+ *
+ * @description:
+ * This section contains a function used to query the level of TrueType
+ * bytecode support compiled in this version of the library.
+ *
+ */
+
/**************************************************************************
*
diff --git a/include/freetype/ftstroke.h b/include/freetype/ftstroke.h
index 00ec085..bf9d26d 100644
--- a/include/freetype/ftstroke.h
+++ b/include/freetype/ftstroke.h
@@ -188,7 +188,8 @@ FT_BEGIN_HEADER
* `outside' borders of a given outline.
*
* @input:
- * outline :: The source outline handle.
+ * outline ::
+ * The source outline handle.
*
* @return:
* The border index. @FT_STROKER_BORDER_LEFT for empty or invalid
@@ -207,10 +208,12 @@ FT_BEGIN_HEADER
* Create a new stroker object.
*
* @input:
- * library :: FreeType library handle
+ * library ::
+ * FreeType library handle
*
* @output:
- * astroker :: A new stroker object handle. NULL in case of error.
+ * astroker ::
+ * A new stroker object handle. NULL in case of error.
*
* @return:
* FreeType error code. 0 means success.
@@ -638,8 +641,8 @@ FT_BEGIN_HEADER
* Stroke a given outline glyph object with a given stroker.
*
* @inout:
- * pglyph :: Source glyph handle on input, new glyph handle
- * on output.
+ * pglyph ::
+ * Source glyph handle on input, new glyph handle on output.
*
* @input:
* stroker ::
diff --git a/src/base/ftstroke.c b/src/base/ftstroke.c
index c5200b3..8f7e045 100644
--- a/src/base/ftstroke.c
+++ b/src/base/ftstroke.c
@@ -4,7 +4,7 @@
/* */
/* FreeType path stroker (body). */
/* */
-/* Copyright 2002, 2003, 2004, 2005 by */
+/* Copyright 2002, 2003, 2004, 2005, 2006 by */
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
/* */
/* This file is part of the FreeType project, and may only be used, */
@@ -723,6 +723,7 @@
FT_Memory memory;
FT_Stroker stroker;
+
if ( !library )
return FT_Err_Invalid_Argument;