Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LOWDOWN_TREE_RNDR(3)	    Library Functions Manual	  LOWDOWN_TREE_RNDR(3)

NAME
       lowdown_tree_rndr -- render Markdown into debugging output

LIBRARY
       library "liblowdown"

SYNOPSIS
       #include	<sys/queue.h>
       #include	<stdio.h>
       #include	<lowdown.h>

       int
       lowdown_tree_rndr(struct	lowdown_buf *out,
	   const struct	lowdown_node *n, const struct lowdown_opts *opts);

DESCRIPTION
       Renders	 a   node   tree   n   created	 by   lowdown_doc_parse(3)  or
       lowdown_diff(3).	 The output is written into out, which	must  be  ini-
       tialised	and freed by the caller.

       The  output  consists of	an UTF-8 tree.	The format is not standardised
       and subject to change.

       Unlike other renderers, lowdown_tree_rndr() accepts no options and thus
       has no context.

RETURN VALUES
       Returns zero on failure to allocate memory, non-zero on success.

EXAMPLES
       The following parses b of length	bsz and	outputs	the parse tree.

	     struct lowdown_buf	*out;
	     struct lowdown_doc	*doc;
	     struct lowdown_node *n;
	     void *rndr;

	     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	(!lowdown_tree_rndr(out, n))
		     err(1, NULL);

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

	     lowdown_buf_free(out);
	     lowdown_node_free(n);
	     lowdown_doc_free(doc);

SEE ALSO
       lowdown(3)

FreeBSD	Ports 14.quarterly	  $Mdocdate$		  LOWDOWN_TREE_RNDR(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=lowdown_tree_rndr&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help