minhngoc25a
/
freetype2
mirror of git://git.savannah.gnu.org/freetype/freetype2.git
2
1
Fork 2
Code Issues 4 Releases Wiki Activity
freetype2/include/freetype/ftchapters.h

169 lines
2.9 KiB
C
Raw Normal View History

[GSoC] include/*.*, devel/*.*: Convert block comments to `light' style. This second and final monster commit was created by applying Nikhil's scripts `docconverter.py' and `markify.py' to all C header and source files, followed up by minor manual clean-up. No change in functionality, of course. I used commit f7419907bc6044b9b7057f9789866426c804ba82 from https://github.com/nikramakrishnan/freetype-docs.git.
2018-06-03 22:00:42 +02:00
/****************************************************************************
*
* This file defines the structure of the FreeType reference.
* It is used by the python script that generates the HTML files.
*
*/
Adding OpenType validation module. The code is based on the (unfinished) `otlayout' module but has been heavily modified to make it much more compact. * src/otvalid/*: New module. * include/freetype/ftotval.h, src/base/ftotval.c, include/freetype/internal/services/svotval.h: New files. * include/freetype/config/ftmodule.h: Add otv_module_class. * include/freetype/config/ftheader.h (FT_OPENTYPE_VALIDATE_H): New macro. * include/freetype/internal/ftserv.h (FT_SERVICE_OPENTYPE_VALIDATE_H): New macro. * include/freetype/internal/fttrace.h (otvmodule, otvcommon, otvbase, otvgdef, otvgpos, otvgsub, otvjstf): New trace components. * include/freetype/ftchapters.h: Updated. * src/base/Jamfile (Library), src/base/descrip.mms (OBJS), src/base/rules.mk (BASE_EXT_SRC): Updated. * docs/CHANGES: Updated.
2004-09-10 16:39:00 +02:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* general_remarks
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* General Remarks
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Add preamble.
2020-10-30 18:53:17 +01:00
* preamble
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* header_inclusion
* user_allocation
*
*/
* include/freetype/freetype.h, include/freetype/ftchapters.h: Add a preliminary section with some explanations about user allocation. * src/tools/docmaker/tohtml.py (HtmlFormatter.section_enter): Don't abort if there are no data types, functions, etc., in a section. Print synopsis only if we have a data type, function, etc. * docs/INSTALL.ANY, docs/INSTALL, docs/INSTALL.UNX, docs/CUSTOMIZE, docs/INSTALL.GNU, docs/TRUETYPE, docs/DEBUG, docs/UPGRADE.UNX, docs/VERSION.DLL, docs/formats.txt: Revised, formatted.
2005-08-30 02:22:46 +02:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* core_api
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Core API
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* basic_types
API documentation: Re-organize chapters and sections * Split the very long 'Base Interface' section into smaller sections. * Split the 'Core API' chapter into two chapters. * Remove single enumeration values from `@order` fields since they have no effect.
2023-04-24 09:48:09 +02:00
* library_setup
* face_creation
* font_testing_macros
* sizing_and_scaling
* glyph_retrieval
* character_mapping
* information_retrieval
* other_api_data
*
*/
/**************************************************************************
*
* @chapter:
* extended_api
*
* @title:
* Extended API
*
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* glyph_variants
More minor doc fixes.
2018-06-18 11:10:14 +02:00
* color_management
* layer_management
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* glyph_management
* mac_specific
* sizes_management
* header_file_macros
*
*/
documentation updates for 2.1.2
2002-06-23 12:57:31 +02:00
* include/freetype/freetype.h, include/freetype/ftchapters.h: Add a preliminary section with some explanations about user allocation. * src/tools/docmaker/tohtml.py (HtmlFormatter.section_enter): Don't abort if there are no data types, functions, etc., in a section. Print synopsis only if we have a data type, function, etc. * docs/INSTALL.ANY, docs/INSTALL, docs/INSTALL.UNX, docs/CUSTOMIZE, docs/INSTALL.GNU, docs/TRUETYPE, docs/DEBUG, docs/UPGRADE.UNX, docs/VERSION.DLL, docs/formats.txt: Revised, formatted.
2005-08-30 02:22:46 +02:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* format_specific
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Format-Specific API
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* multiple_masters
* truetype_tables
* type1_tables
* sfnt_names
* bdf_fonts
* cid_fonts
* pfr_fonts
* winfnt_fonts
More documentation on handling OT-SVG.
2022-01-23 12:03:44 +01:00
* svg_fonts
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* font_formats
* gasp_table
*
*/
update docmaker.py to support chapters and section block ordering updated public header files, as well as "ftchapters.h" which only contains comment that hold the list of section chapters..
2001-02-13 18:42:49 +01:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* module_specific
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Controlling FreeType Modules
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* auto_hinter
* cff_driver
* t1_cid_driver
* tt_driver
* pcf_driver
More documentation on handling OT-SVG.
2022-01-23 12:03:44 +01:00
* ot_svg_driver
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* properties
* parameter_tags
* lcd_rendering
*
*/
[cff] Add a new Type 2 interpreter and hinter. This work, written by Dave Arnold <darnold@adobe.com> and fully integrated into FreeType by me, is a donation by Adobe in collaboration with Google. It is vastly superior to the old CFF engine, and it will replace it soon. Right now, it is still off by default, and you have to explicitly select it using the new `hinting-engine' property of the cff driver. For convenience, (most of) the new files are committed separately. * include/freetype/config/ftheader.h (FT_CFF_DRIVER_H): New macro. * include/freetype/ftcffdrv.h: New file to access CFF driver properties. * include/freetype/fterrdef.h (FT_Err_Glyph_Too_Big): New error code. * include/freetype/internal/fttrace.h: Add `cf2blues', `cf2hints', and `cf2interp'. * src/cff/cffgload.h (CFF_SubFont): New member `current_subfont'. * src/cff/cffobjs.h (CFF_DriverRec): New members `hinting_engine' and `no_stem_darkening'. * src/cff/cfftypes.h (CFF_FontRec): New member `cf2_instance'. * src/cff/cff.c: Include new files. * src/cff/cffdrivr.c (cff_property_set, cff_property_get): Handle `hinting-engine' and `no-stem-darkening' properties (only the Adobe engine listens to them). * src/cff/cffgload.c: Include `cf2ft.h'. (cff_decoder_prepare): Initialize `current_subfont'. (cff_build_add_point): Handle Adobe engine which uses 16.16 coordinates. (cff_slot_load): Handle FT_LOAD_NO_SCALE and FT_LOAD_NO_HINTING separately. Choose rendering engine based on `hinting_engine' property. * src/cff/cffload.c (cff_font_done): Call finalizer of the Adobe engine. * src/cff/cffobjs.c: Include FT_CFF_DRIVER_H. (cff_driver_init): Set default property values. * src/cff/rules.mk (CFF_DRV_SRC, CFF_DRV_H): Add new files. * src/cff/cf2*.*: New files, containing the Adobe engine.
2013-04-13 18:53:28 +02:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* cache_subsystem
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Cache Sub-System
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* cache_subsystem
*
*/
* src/autohint/ahtypes.h (AH_Hinter): Add elements `disable_horz_edges', `disable_vert_edges'. * src/autohint/ahhint.c (ah_hint_edges_3, ah_hinter_hint_edges): Use them (and remove static variables with the same names). * src/pcf/pcfutil.c (BitOrderInvert): Add `const'. * docs/glnames.py: Updated to latest pstables.h changes. * src/psnames/pstables.h: Add more `const'. * src/pcf/pcfutil.c: Ditto. * src/base/ftglyph.c (FT_Glyph_To_Bitmap): Fixing typo (FT_Glyph_Done -> FT_Done_Glyph). * include/freetype/ttnameid.h: Added some new Microsoft language codes and LCIDs as found in Office Xp. * builds/hurd/detect.mk: New file. Added support to detect the GNU Hurd operating system as Unix-like. Fix submitted by Anthony Fok <foka@debian.org>. * src/type1/t1gload.c (T1_Load_Glyph): Set glyph control data to the the Type 1 glyph charstring (used by conversion programs). Submitted by Ha Shao <hashao@chinese.com>. * src/base/ftgrays.c (grays_sweep): The function didn't exit immediately if `num_cells' was 0 as it should. Thanks to Boris for finding this out. * src/base/ftglyph.c (FT_Glyph_To_Bitmap): Fixed memory leak when bitmap rendering fails (thanks to Graham Asher). * docs/docmaker.py, include/freetype/*.h: Updated the DocMaker script to support chapters and section block ordering. Updated the public header files accordingly. * src/base/ftglyph.c (FT_Glyph_Copy): Advance width and glyph format were not correctly copied.
2001-03-04 22:53:08 +01:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* support_api
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Support API
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* computations
* list_processing
* outline_processing
* quick_advance
* bitmap_handling
* raster
* glyph_stroker
* system_interface
* module_management
* gzip
* lzw
* bzip2
[base] Add public API to change the levels of tracing components. * include/freetype/ftlogging.h: New header file. * include/freetype/internal/ftdebug.h [FT_LOGGING]: Include `ftlogging.h`. * src/base/ftdebug.c (ft_custom_trace_level): New variable. (ft_debug_init): Update to support change of levels of tracing components of FreeType at run-time. (FT_Trace_Set_Level): New function to change the levels of tracing components at run-time. (FT_Trace_Set_Default_Level): New function to reset the levels of tracing components back to default.
2020-08-26 18:00:35 +02:00
* debugging_apis
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
*/
Describe error values and strings in the documentation.
2015-07-23 13:35:07 +02:00
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
Make `/****...' comments in public headers uniformly end on column 77.
2018-09-04 08:00:58 +02:00
/**************************************************************************
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @chapter:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* error_codes
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @title:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* Error Codes
*
Change documentation markup tags to lowercase. Implemented as per discussion in http://lists.nongnu.org/archive/html/freetype-devel/2018-06/msg00073.html No change in functionality, of course.
2018-06-17 21:08:36 +02:00
* @sections:
Fix documentation indentation; s/@const/@enum/; harmonize doc keywords.
2018-06-17 11:22:37 +02:00
* error_enumerations
* error_code_values
*
*/
/* END */