.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "doc::unibi_format 3"
.TH doc::unibi_format 3 "2018-02-19" "unibilium-2.0.0" "unibilium"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
unibi_format, unibi_run \- interpret a terminfo format string
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  #include <unibilium.h>
\&  
\&  void unibi_format(
\&      unibi_var_t var_dyn[26],
\&      unibi_var_t var_static[26],
\&      const char *fmt,
\&      unibi_var_t param[9],
\&      void (*out)(void *, const char *, size_t),
\&      void *ctx1,
\&      void (*pad)(void *, size_t, int, int),
\&      void *ctx2
\&  );
\&  
\&  size_t unibi_run(const char *fmt, unibi_var_t param[9], char *p, size_t n);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`unibi_format\*(C'\fR takes a format string \fIfmt\fR and executes it. All output is
done by (possibly repeated) calls to \fIout\fR. In the calls to \fIout\fR the first
argument is always \fIctx1\fR, the second argument is a pointer to a chunk of
data, and the third argument is a count specifying the size of the chunk in
bytes.
.PP
\&\fIpad\fR is used when the format string contains \f(CW\*(C`$<...>\*(C'\fR padding
instructions. In the calls to \fIpad\fR the first argument is always \fIctx2\fR, the
second argument is the delay in tenths of milliseconds, the third argument is a
boolean flag indicating whether \f(CW\*(C`*\*(C'\fR (proportional delay) was specified in the
format string, and the fourth argument is a boolean flag indicating whether
\&\f(CW\*(C`/\*(C'\fR (forced padding) was specified in the format string. Thus a format string
of \f(CW\*(C`$<5/>\*(C'\fR would translate into \f(CW\*(C`pad(ctx2, 50, 0, 1)\*(C'\fR. You may pass a
null pointer for \fIpad\fR; in that case padding instructions are silently
skipped.
.PP
The values of \fIparam\fR are used for the format codes \f(CW%p1\fR .. \f(CW%p9\fR; the
values of \fIvar_dyn\fR and \fIvar_static\fR are used for the so-called
dynamic/static variables \f(CW%Pa\fR .. \f(CW%Pz\fR and \f(CW%PA\fR .. \f(CW%PZ\fR, respectively.
.PP
\&\f(CW\*(C`unibi_run\*(C'\fR is a wrapper around \f(CW\*(C`unibi_format\*(C'\fR. It passes two arrays (each
initialized to 26 zeroes) as \fIvar_dyn\fR and \fIvar_static\fR. \fIfmt\fR and \fIparam\fR
are passed on unchanged. It ignores padding and places all normal output in the
buffer pointed to by \fIp\fR. \fIn\fR is the size of the buffer; at most \fIn\fR bytes
will be written to \fIp\fR.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\f(CW\*(C`unibi_run\*(C'\fR returns the number of bytes that would have been written if the
buffer was big enough. Thus the number of valid bytes in \fIp\fR after a call to
\&\f(CW\*(C`unibi_run\*(C'\fR is the minimum of \fIn\fR and the return value of \f(CW\*(C`unibi_run\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIunibi_var_from_num\fR\|(3),
\&\fIunibi_var_from_str\fR\|(3),
\&\fIunibilium.h\fR\|(3)