about summary refs log tree commit diff stats
path: root/gemtext_text_string.3
blob: 57881933f64707dee1e77f411f4ddae9fc3bccf9 (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
.Dd 2020-10-22
.Dt gemtext 3
.Os
.Sh NAME
.Nm gemtext_text_string ,
.Nm gemtext_link_link_string ,
.Nm gemtext_link_label_string ,
.Nm gemtext_pre_string ,
.Nm gemtext_h1_string ,
.Nm gemtext_h2_string ,
.Nm gemtext_h3_string ,
.Nm gemtext_ul_string ,
.Nm gemtext_qt_string
.Nd get string representation of gemtext objects
.Sh SYNOPSIS
.In "gemtext.h"
.Ft char *
.Fn gemtext_text_string "struct gemtext *line"
.Ft char *
.Fn gemtext_link_link_string "struct gemtext *line"
.Ft char *
.Fn gemtext_link_label_string "struct gemtext *line"
.Ft char *
.Fn gemtext_pre_string "struct gemtext *line"
.Ft char *
.Fn gemtext_h1_string "struct gemtext *line"
.Ft char *
.Fn gemtext_h2_string "struct gemtext *line"
.Ft char *
.Fn gemtext_h3_string "struct gemtext *line"
.Ft char *
.Fn gemtext_ul_string "struct gemtext *line"
.Ft char *
.Fn gemtext_qt_string "struct gemtext *line"
.Sh DESCRIPTION
Not to be confused with
.Xr gemtext_encode 3
family of functions, these functions return the underlying string of a
.Em struct gemtext*
object, not the encoded
.Nm text/gemini
representation.
.Pp
.Fn gemtext_text_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_link_link_string
returns a pointer to underlying string of
.Em line
containing link.
.Pp
.Fn gemtext_link_label_string
returns a pointer to underlying string of
.Em line
containing link label.
.Pp
.Fn gemtext_pre_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_h1_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_h2_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_h3_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_ul_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_ul_string
returns pointer to underlying string of
.Em line .
.Pp
.Fn gemtext_qt_string
returns pointer to underlying string of
.Em line .
.Sh ERRORS
All above functions never fail.
.Sh RETURN VALUES
Pointers returned by all above functions should never be freed as they're a part of the object they're derived from.
Also, altering the value of data pointed to by returned pointer will affect the object they're derived from.
.Sh SEE ALSO
.Xr gemtext_decode 3 ,
.Xr gemtext_encode 3 ,
.Xr gemtext_type 3 ,
.Xr gemtext_text_new 3 ,
.Xr gemtext_text_strlen 3 ,
.Xr gemtext_list_append 3 ,
.Xr gemtext_free 3
.Sh AUTHORS
.An Ali Fardan Aq Mt raiz@stellarbound.space