Minor renamings and type fiddling.
[ttfautohint.git] / lib / talatin.h
blob5f36d1671219acad4e474bdfd8477a336d1e537f
1 /* talatin.h */
3 /*
4 * Copyright (C) 2011-2014 by Werner Lemberg.
6 * This file is part of the ttfautohint library, and may only be used,
7 * modified, and distributed under the terms given in `COPYING'. By
8 * continuing to use, modify, or distribute this file you indicate that you
9 * have read `COPYING' and understand and accept it fully.
11 * The file `COPYING' mentioned in the previous paragraph is distributed
12 * with the ttfautohint library.
16 /* originally file `aflatin.h' (2011-Mar-28) from FreeType */
18 /* heavily modified 2011 by Werner Lemberg <wl@gnu.org> */
20 #ifndef __TALATIN_H__
21 #define __TALATIN_H__
23 #include "tatypes.h"
24 #include "tahints.h"
27 /* the `latin' writing system */
29 extern const TA_WritingSystemClassRec ta_latin_writing_system_class;
32 /* constants are given with units_per_em == 2048 in mind */
33 #define TA_LATIN_CONSTANT(metrics, c) \
34 (((c) * (FT_Long)((TA_LatinMetrics)(metrics))->units_per_em) / 2048)
37 /* Latin (global) metrics management */
39 #define TA_LATIN_IS_TOP_BLUE(b) \
40 ((b)->properties & TA_BLUE_PROPERTY_LATIN_TOP)
41 #define TA_LATIN_IS_NEUTRAL_BLUE(b) \
42 ((b)->properties & TA_BLUE_PROPERTY_LATIN_NEUTRAL)
43 #define TA_LATIN_IS_X_HEIGHT_BLUE(b) \
44 ((b)->properties & TA_BLUE_PROPERTY_LATIN_X_HEIGHT)
45 #define TA_LATIN_IS_LONG_BLUE(b) \
46 ((b)->properties &TA_BLUE_PROPERTY_LATIN_LONG)
48 #define TA_LATIN_MAX_WIDTHS 16
51 #define TA_LATIN_BLUE_ACTIVE (1 << 0) /* set if zone height is <= 3/4px */
52 #define TA_LATIN_BLUE_TOP (1 << 1) /* set if we have a top blue zone */
53 #define TA_LATIN_BLUE_NEUTRAL (1 << 2) /* set if we have neutral blue zone */
54 #define TA_LATIN_BLUE_ADJUSTMENT (1 << 3) /* used for scale adjustment */
55 /* optimization */
58 typedef struct TA_LatinBlueRec_
60 TA_WidthRec ref;
61 TA_WidthRec shoot;
62 FT_UInt flags;
63 } TA_LatinBlueRec, *TA_LatinBlue;
66 typedef struct TA_LatinAxisRec_
68 FT_Fixed scale;
69 FT_Pos delta;
71 FT_UInt width_count; /* number of used widths */
72 TA_WidthRec widths[TA_LATIN_MAX_WIDTHS]; /* widths array */
73 FT_Pos edge_distance_threshold; /* used for creating edges */
74 FT_Pos standard_width; /* the default stem thickness */
75 FT_Bool extra_light; /* is standard width very light? */
77 /* ignored for horizontal metrics */
78 FT_UInt blue_count;
79 /* we add two blue zones for usWinAscent and usWinDescent */
80 TA_LatinBlueRec blues[TA_BLUE_STRINGSET_MAX + 2];
82 FT_Fixed org_scale;
83 FT_Pos org_delta;
84 } TA_LatinAxisRec, *TA_LatinAxis;
87 typedef struct TA_LatinMetricsRec_
89 TA_StyleMetricsRec root;
90 FT_UInt units_per_em;
91 TA_LatinAxisRec axis[TA_DIMENSION_MAX];
92 } TA_LatinMetricsRec, *TA_LatinMetrics;
95 FT_Error
96 ta_latin_metrics_init(TA_LatinMetrics metrics,
97 FT_Face face);
99 void
100 ta_latin_metrics_scale(TA_LatinMetrics metrics,
101 TA_Scaler scaler);
103 void
104 ta_latin_metrics_init_widths(TA_LatinMetrics metrics,
105 FT_Face face,
106 FT_Bool use_cmap);
108 void
109 ta_latin_metrics_check_digits(TA_LatinMetrics metrics,
110 FT_Face face);
113 #define TA_LATIN_HINTS_HORZ_SNAP (1 << 0) /* enable stem width snapping */
114 #define TA_LATIN_HINTS_VERT_SNAP (1 << 1) /* enable stem height snapping */
115 #define TA_LATIN_HINTS_STEM_ADJUST (1 << 2) /* enable stem width/height */
116 /* adjustment */
117 #define TA_LATIN_HINTS_MONO (1 << 3) /* indicate monochrome rendering */
120 #define TA_LATIN_HINTS_DO_HORZ_SNAP(h) \
121 TA_HINTS_TEST_OTHER(h, TA_LATIN_HINTS_HORZ_SNAP)
122 #define TA_LATIN_HINTS_DO_VERT_SNAP(h) \
123 TA_HINTS_TEST_OTHER(h, TA_LATIN_HINTS_VERT_SNAP)
124 #define TA_LATIN_HINTS_DO_STEM_ADJUST(h) \
125 TA_HINTS_TEST_OTHER(h, TA_LATIN_HINTS_STEM_ADJUST)
126 #define TA_LATIN_HINTS_DO_MONO(h) \
127 TA_HINTS_TEST_OTHER(h, TA_LATIN_HINTS_MONO)
130 /* the next functions shouldn't normally be exported; */
131 /* however, other writing systems might like to use these functions as-is */
133 FT_Error
134 ta_latin_hints_compute_segments(TA_GlyphHints hints,
135 TA_Dimension dim);
136 void
137 ta_latin_hints_link_segments(TA_GlyphHints hints,
138 FT_UInt width_count,
139 TA_WidthRec* widths,
140 TA_Dimension dim);
141 FT_Error
142 ta_latin_hints_compute_edges(TA_GlyphHints hints,
143 TA_Dimension dim);
144 FT_Error
145 ta_latin_hints_detect_features(TA_GlyphHints hints,
146 FT_UInt width_count,
147 TA_WidthRec* widths,
148 TA_Dimension dim);
150 #endif /* __TALATIN_H__ */
152 /* end of talatin.h */