path: root/gemtext_text_string.3

.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