pango-utils.h 5.82 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/* Pango
 * pango-utils.c: Utilities for internal functions and modules
 *
 * Copyright (C) 2000 Red Hat Software
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

22
23
24
#ifndef __PANGO_UTILS_H__
#define __PANGO_UTILS_H__

25
26
#include <stdio.h>
#include <glib.h>
27
#include <pango/pango-font.h>
28

29
30
G_BEGIN_DECLS

31
PANGO_DEPRECATED
32
33
char **  pango_split_file_list (const char *str);

34
PANGO_DEPRECATED
Owen Taylor's avatar
Owen Taylor committed
35
char    *pango_trim_string     (const char *str);
36
PANGO_DEPRECATED
37
gint     pango_read_line      (FILE        *stream,
38
			       GString     *str);
39
PANGO_DEPRECATED
40
gboolean pango_skip_space     (const char **pos);
41
PANGO_DEPRECATED
42
43
gboolean pango_scan_word      (const char **pos,
			       GString     *out);
44
PANGO_DEPRECATED
45
46
gboolean pango_scan_string    (const char **pos,
			       GString     *out);
47
PANGO_DEPRECATED
48
49
50
gboolean pango_scan_int       (const char **pos,
			       int         *out);

51
PANGO_DEPRECATED
52
53
54
55
56
57
gboolean pango_parse_enum     (GType       type,
			       const char *str,
			       int        *value,
			       gboolean    warn,
			       char      **possible_values);

58
59
60
/* Functions for parsing textual representations
 * of PangoFontDescription fields. They return TRUE if the input string
 * contains a valid value, which then has been assigned to the corresponding
61
62
63
 * field in the PangoFontDescription. If the warn parameter is TRUE,
 * a warning is printed (with g_warning) if the string does not
 * contain a valid value.
64
 */
65
PANGO_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
66
67
68
gboolean pango_parse_style   (const char   *str,
			      PangoStyle   *style,
			      gboolean      warn);
69
PANGO_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
70
71
72
gboolean pango_parse_variant (const char   *str,
			      PangoVariant *variant,
			      gboolean      warn);
73
PANGO_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
74
75
76
gboolean pango_parse_weight  (const char   *str,
			      PangoWeight  *weight,
			      gboolean      warn);
77
PANGO_AVAILABLE_IN_ALL
Owen Taylor's avatar
Owen Taylor committed
78
79
80
81
82
gboolean pango_parse_stretch (const char   *str,
			      PangoStretch *stretch,
			      gboolean      warn);


83
84
/* Hint line position and thickness.
 */
85
PANGO_AVAILABLE_IN_1_12
86
87
88
void pango_quantize_line_geometry (int *thickness,
				   int *position);

Behdad Esfahbod's avatar
Behdad Esfahbod committed
89
/* A routine from fribidi that we either wrap or provide ourselves.
90
 */
91
PANGO_AVAILABLE_IN_1_4
92
93
guint8 * pango_log2vis_get_embedding_levels (const gchar    *text,
					     int             length,
94
					     PangoDirection *pbase_dir);
95

Behdad Esfahbod's avatar
Behdad Esfahbod committed
96
97
98
/* Unicode characters that are zero-width and should not be rendered
 * normally.
 */
99
PANGO_AVAILABLE_IN_1_10
100
gboolean pango_is_zero_width (gunichar ch) G_GNUC_CONST;
Behdad Esfahbod's avatar
Behdad Esfahbod committed
101

102
103
104
105
106
107
PANGO_AVAILABLE_IN_ALL
void     pango_find_paragraph_boundary (const char *text,
                                        int         length,
                                        int        *paragraph_delimiter_index,
                                        int        *next_paragraph_start);

108
109
110
/* Pango version checking */

/* Encode a Pango version as an integer */
111
112
113
114
115
116
117
118
119
120
/**
 * PANGO_VERSION_ENCODE:
 * @major: the major component of the version number
 * @minor: the minor component of the version number
 * @micro: the micro component of the version number
 *
 * This macro encodes the given Pango version into an integer.  The numbers
 * returned by %PANGO_VERSION and pango_version() are encoded using this macro.
 * Two encoded version numbers can be compared as integers.
 */
121
122
123
124
125
126
#define PANGO_VERSION_ENCODE(major, minor, micro) (     \
	  ((major) * 10000)                             \
	+ ((minor) *   100)                             \
	+ ((micro) *     1))

/* Encoded version of Pango at compile-time */
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
/**
 * PANGO_VERSION:
 *
 * The version of Pango available at compile-time, encoded using PANGO_VERSION_ENCODE().
 */
/**
 * PANGO_VERSION_STRING:
 *
 * A string literal containing the version of Pango available at compile-time.
 */
/**
 * PANGO_VERSION_MAJOR:
 *
 * The major component of the version of Pango available at compile-time.
 */
/**
 * PANGO_VERSION_MINOR:
 *
 * The minor component of the version of Pango available at compile-time.
 */
/**
 * PANGO_VERSION_MICRO:
 *
 * The micro component of the version of Pango available at compile-time.
 */
152
153
154
155
156
157
#define PANGO_VERSION PANGO_VERSION_ENCODE(     \
	PANGO_VERSION_MAJOR,                    \
	PANGO_VERSION_MINOR,                    \
	PANGO_VERSION_MICRO)

/* Check that compile-time Pango is as new as required */
158
159
160
161
162
163
164
165
166
/**
 * PANGO_VERSION_CHECK:
 * @major: the major component of the version number
 * @minor: the minor component of the version number
 * @micro: the micro component of the version number
 *
 * Checks that the version of Pango available at compile-time is not older than
 * the provided version number.
 */
167
168
169
170
171
#define PANGO_VERSION_CHECK(major,minor,micro)    \
	(PANGO_VERSION >= PANGO_VERSION_ENCODE(major,minor,micro))


/* Return encoded version of Pango at run-time */
172
PANGO_AVAILABLE_IN_1_16
173
174
175
int pango_version (void) G_GNUC_CONST;

/* Return run-time Pango version as an string */
176
PANGO_AVAILABLE_IN_1_16
177
const char * pango_version_string (void) G_GNUC_CONST;
178
179

/* Check that run-time Pango is as new as required */
180
PANGO_AVAILABLE_IN_1_16
181
182
183
const char * pango_version_check (int required_major,
                                  int required_minor,
                                  int required_micro) G_GNUC_CONST;
184

185
186
187
G_END_DECLS

#endif /* __PANGO_UTILS_H__ */