summaryrefslogtreecommitdiff
path: root/dviware/dvi2bitmap/doc_libdvi2bitmap/man/man3/Util.3
blob: 974406721eae418766162041815037745d78e0fc (plain)
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
.TH "Util" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Util \- 
.PP
Various utility functions\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBstring_list\fP & \fBtokenise_string\fP (string str)"
.br
.RI "\fITokenise string at whitespace\&. \fP"
.ti -1c
.RI "char ** \fBstring_list_to_array\fP (\fBstring_list\fP &l)"
.br
.RI "\fIConvert a \fCstring_list\fP to a null-terminated array of character pointers\&. \fP"
.ti -1c
.RI "void \fBdelete_string_array\fP (char **sl)"
.br
.RI "\fIDeletes the array of strings returned by \fBstring_list_to_array\fP\&. \fP"
.ti -1c
.RI "bool \fBparseRGB\fP (\fBBitmap::BitmapColour\fP &, const char *)"
.br
.RI "\fIParse an RGB specification\&. \fP"
.ti -1c
.RI "void \fBverbosity\fP (const \fBverbosities\fP level)"
.br
.RI "\fISets the verbosity of the methods in this class\&. \fP"
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "\fBverbosities\fP \fBverbosity_\fP = \fBnormal\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Various utility functions\&. 
.SH "Function Documentation"
.PP 
.SS "void Util::delete_string_array (char **sl)"

.PP
Deletes the array of strings returned by \fBstring_list_to_array\fP\&. 
.PP
\fBParameters:\fP
.RS 4
\fIsl\fP a null-terminated array of strings 
.RE
.PP

.SS "bool Util::parseRGB (\fBBitmap::BitmapColour\fP &rgb, const char *s)"

.PP
Parse an RGB specification\&. This is either a sequence of three integers separated by slashes (or in fact any non-number character), or else a string of the form \fC#RRGGBB\fP\&. Set the `rgb' structure to the resulting numbers\&. The integers must be in the range [0,255], and may be specified in decimal, octal, or hex\&.
.PP
\fBParameters:\fP
.RS 4
\fIrgb\fP the \fCBitmapColour\fP corresponding to the \fCs\fP argument 
.br
\fIs\fP the RGB specification
.RE
.PP
\fBReturns:\fP
.RS 4
true if the parse is successful\&. 
.RE
.PP

.PP
References Bitmap::BitmapColour_s::blue, Bitmap::BitmapColour_s::green, and Bitmap::BitmapColour_s::red\&.
.PP
Referenced by main()\&.
.SS "char ** Util::string_list_to_array (\fBstring_list\fP &l)"

.PP
Convert a \fCstring_list\fP to a null-terminated array of character pointers\&. The resulting array can conveniently be deleted using \fBdelete_string_array\fP\&.
.PP
\fBParameters:\fP
.RS 4
\fIl\fP a string_list 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to a null-terminated array of null-terminated character arrays 
.RE
.PP

.PP
Referenced by PipeStream::PipeStream()\&.
.SS "\fBstring_list\fP & Util::tokenise_string (stringstr)"

.PP
Tokenise string at whitespace\&. 
.PP
\fBParameters:\fP
.RS 4
\fIstr\fP the string to be tokenised 
.RE
.PP
\fBReturns:\fP
.RS 4
a list containing the whitespace-separated tokens in the string 
.RE
.PP

.PP
References normal, and verbosity_\&.
.PP
Referenced by main(), and PipeStream::PipeStream()\&.
.SS "void Util::verbosity (const \fBverbosities\fPlevel)"

.PP
Sets the verbosity of the methods in this class\&. 
.PP
\fBParameters:\fP
.RS 4
\fIlevel\fP how verbose the class's methods should be 
.RE
.PP

.PP
References verbosity_\&.
.PP
Referenced by main()\&.
.SH "Variable Documentation"
.PP 
.SS "\fBverbosities\fP Util::verbosity_ = \fBnormal\fP"

.PP
Referenced by InputByteStream::bindToFileDescriptor(), Bitmap::Bitmap(), InputByteStream::bufferSeek(), InputByteStream::close(), PkFont::fontgenCommand(), PkFont::magnification(), InputByteStream::openSourceSpec(), Bitmap::paint(), InputByteStream::reloadBuffer(), Bitmap::rule(), Bitmap::scaleDown(), Bitmap::strut(), PkFont::substitute_font_string(), tokenise_string(), verbosity(), and Bitmap::write()\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for dvi2bitmap from the source code\&.