blob: dca3d1e2a430c1b113657d17758bfb0739fe0150 (
plain) (
blame)
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
|
.TH LIBNORMALFORM_VARIABLE 3 LIBNORMALFORM
.SH NAME
libnormalform_variable \- Boolean variable
.SH SYNOPSIS
.nf
#include <libnormalform.h>
enum libnormalform_value {
\fILIBNORMALFORM_FALSE\fP = 0,
\fILIBNORMALFORM_TRUE\fP = 1
};
struct libnormalform_variable {
enum libnormalform_value \fIvalue\fP;
void *\fIuser_data\fP;
const char *\fIidentifier;
struct libnormalform_variable *\fIcopy_for_clone\fP;
};
LIBNORMALFORM_SENTENCE *libnormalform_variable(struct libnormalform_variable *\fIvariable\fP);
.fi
.PP
Link with
.IR -lnormalform .
.SH DESCRIPTION
The
.BR libnormalform_variable ()
function creates a sentence object out
of an application-managed variable.
.PP
.I variable->value
is used only be the
.BR libnormalform_evaluate (3)
function and must be set to either
.I LIBNORMALFORM_FALSE
or
.I LIBNORMALFORM_TRUE
before the
.BR libnormalform_evaluate (3)
function is called, to let the
function know what value the
variable has for that specific
call to the
.BR libnormalform_evaluate (3)
function.
.PP
See
.BR libnormalform_to_string (3)
for the purpose of
.IR variable->identifier ,
it need not be set before the
.BR libnormalform_to_string (3)
function is called.
.PP
See
.BR libnormalform_clone (3)
for the purpose of
.IR variable->copy_for_clone ,
it need not be set before the
.BR libnormalform_clone (3)
function is called.
.PP
The application can set
.I variable->user_data
set freely, and can opt to leave it
unset. It is never used or reference
by the library, but it could be used
by the application to identify the
variable.
.PP
.I variable
must not be
.IR NULL .
.PP
The returned pointer shall either be
deallocated with the
.BR libnormalform_free (3)
function or be relinquished by being
used as part of another sentence.
.SH RETURN VALUE
Upon successful completion, the
.BR libnormalform_variable ()
function returns an sentence object of
the variable; otherwise, the function
returns
.I NULL
and sets
.I errno
to indicate the error.
.SH ERRORS
The
.BR libnormalform_variable ()
function fails if:
.TP
.B ENOMEM
Insufficient memory was available to
create the sentence object.
.SH ATTRIBUTES
For an explanation of the terms used in this
section, see
.BR attributes (7)
and
.IR "info \(dq(libc)POSIX Safety Concepts\(dq" .
.TS
allbox;
lb lb lb
l l l.
Interface Attribute Value
T{
.BR libnormalform_variable ()
T} Thread safety MT-Safe
T{
.BR libnormalform_variable ()
T} Async-signal safety AS-Unsafe heap
T{
.BR libnormalform_variable ()
T} Async-cancel safety AC-Safe mem, AC-Unsafe heap
.TE
.SH SEE ALSO
.BR libnormalform (7),
.BR libnormalform_function (3)
|
