Back (Current repo: lowdown)

lowdown_term_new.3 (2633B)

.\"	$Id$
.\"
.\" Copyright (c) 2020 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate$
.Dt LOWDOWN_TERM_NEW 3
.Os
.Sh NAME
.Nm lowdown_term_new
.Nd allocate a Markdown terminal renderer
.Sh LIBRARY
.Lb liblowdown
.Sh SYNOPSIS
.In sys/queue.h
.In stdio.h
.In lowdown.h
.Ft void *
.Fo lowdown_term_new
.Fa "const struct lowdown_opts *opts"
.Fc
.Sh DESCRIPTION
Allocates a terminal renderer using
.Fa opts->cols ,
.Fa opts->hmargin ,
.Fa opts->vmargin ,
and
.Fa opts->oflags ,
or 80 and all others zero, respectively, if
.Fa opts
is
.Dv NULL .
These fields are documented in
.Xr lowdown 3 .
The returned pointer may be used with multiple invocations of
.Xr lowdown_term_rndr 3
and must be freed with
.Xr lowdown_term_free 3 .
.Pp
The bits recognised in
.Fa opts->oflags
are
.Dv LOWDOWN_TERM_SHORTLINK ,
.Dv LOWDOWN_TERM_NOCOLOUR ,
and
.Dv LOWDOWN_TERM_NOLINK .
.Sh RETURN VALUES
Returns a pointer to the renderer or
.Dv NULL
on memory failure.
The returned pointer must be freed with
.Xr lowdown_term_free 3 .
.Sh EXAMPLES
The following parses
.Va b
of length
.Va bsz
and outputs in ANSI terminal format.
.Bd -literal -offset indent
struct lowdown_buf *out;
struct lowdown_doc *doc;
struct lowdown_node *n;
void *rndr;

if (setlocale(LC_CTYPE, "en_US.UTF-8") == NULL)
	err(1, NULL);

if ((doc = lowdown_doc_new(NULL)) == NULL)
	err(1, NULL);
if ((n = lowdown_doc_parse(doc, NULL, b, bsz, NULL)) == NULL)
	err(1, NULL);
if ((out = lowdown_buf_new(256)) == NULL)
	err(1, NULL);
if ((rndr = lowdown_term_new(NULL)) == NULL)
	err(1, NULL);
if (!lowdown_term_rndr(out, rndr, n))
	err(1, NULL);

fwrite(out->data, 1, out->size, stdout);

lowdown_term_free(rndr);
lowdown_buf_free(out);
lowdown_node_free(n);
lowdown_doc_free(doc);
.Ed
.Sh SEE ALSO
.Xr lowdown 3 ,
.Xr lowdown_term_free 3 ,
.Xr lowdown_term_rndr 3
.Sh STANDARDS
ANSI escape codes are described in ISO/IEC 6429, previously ECMA-48.