File: unicode%3A%3Aiconvert%3A%3Aconvert_tocase.3

package info (click to toggle)
courier-unicode 2.3.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,480 kB
  • sloc: ansic: 81,752; sh: 4,205; cpp: 2,561; perl: 1,003; makefile: 663
file content (86 lines) | stat: -rw-r--r-- 2,964 bytes parent folder | download | duplicates (2)
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
'\" t
.\"     Title: unicode::iconvert::convert_tocase
.\"    Author: Sam Varshavchik
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 05/18/2024
.\"    Manual: Courier Unicode Library
.\"    Source: Courier Unicode Library
.\"  Language: English
.\"
.TH "UNICODE::ICONVERT::C" "3" "05/18/2024" "Courier Unicode Library" "Courier Unicode Library"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
unicode::iconvert::convert_tocase \- unicode uppercase, lowercase, and titlecase conversion
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <courier\-unicode\&.h>
.fi
.ft
.HP 8
.BI "std::string unicode::iconvert::convert_tocase( const\ std::string\ &" "text" ", const\ std::string\ &" "charset" ", char32_t\ (*" "first_char_func" ")(char32_t), char32_t\ (*" "char_func" ")(char32_t));"
.HP 8
.BI "std::string unicode::iconvert::convert_tocase( const\ std::string\ &" "text" ", const\ std::string\ &" "charset" ", bool\ &" "err" ", char32_t\ (*" "first_char_func" ")(char32_t), char32_t\ (*" "char_func" ")(char32_t));"
.SH "DESCRIPTION"
.PP
The overloaded
\fBunicode::convert::convert_tocase\fR() function converts the
\fItext\fR
parameter, in the
\fIcharset\fR
characters to lowercase, uppercase, and titlecase\&.
\fItext\fR
gets converted, internally, into unicode\&.
\fIfirst_char_func\fR
and
\fIchar_func\fR
are either:
\fBunicode_lc\fR,
\fBunicode_uc\fR, or
\fBunicode_tc\fR\&. If the converted text string is not empty,
\fIfirst_char_func\fR
converts the first unicode character in the text string, and
\fIchar_func\fR
converts any remaining characters\&.
\fBunicode_lc\fR
converts its character to lowercase,
\fBunicode_uc\fR
to uppercase, and
\fBunicode_tc\fR
to titlecase\&. Finally, the unicode string gets converted back to
\fIcharset\fR, which gets returned\&.
.PP
The optional
\fIerr\fR
parameter gets set to true if an error was encounted converting the text string to or from unicode\&.
.SH "SEE ALSO"
.PP
\fBcourier-unicode\fR(7),
\fBunicode::convert::convert\fR(3),
\fBunicode_convert\fR(3),
\fBiconv\fR(3)\&.
.SH "AUTHOR"
.PP
\fBSam Varshavchik\fR
.RS 4
Author
.RE