Return to ml.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/ml.h, Revision 1.15

1.15    ! kristaps    1: /* $Id: ml.h,v 1.14 2008/12/10 12:05:33 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
                      4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the
                      7:  * above copyright notice and this permission notice appear in all
                      8:  * copies.
                      9:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
                     11:  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
                     12:  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
                     13:  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
                     14:  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
                     15:  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
                     16:  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
                     17:  * PERFORMANCE OF THIS SOFTWARE.
                     18:  */
                     19: #ifndef ML_H
                     20: #define ML_H
                     21:
1.12      kristaps   22: #include "private.h"
                     23:
                     24: #define        COLUMNS           72
                     25: #define        INDENT_SZ         4
                     26: #define        INDENT(x)         ((x) > MAXINDENT ? MAXINDENT : (x))
                     27: #define        MAXINDENT         10
                     28:
1.1       kristaps   29: struct md_mlg;
                     30:
                     31: enum   md_ns {
                     32:        MD_NS_BLOCK,
1.2       kristaps   33:        MD_NS_HEAD,
                     34:        MD_NS_BODY,
1.1       kristaps   35:        MD_NS_INLINE,
1.15    ! kristaps   36:        MD_NS_DEFAULT
1.1       kristaps   37: };
                     38:
1.12      kristaps   39: enum   ml_scope {
                     40:        ML_OPEN,
                     41:        ML_CLOSE
                     42: };
                     43:
1.7       kristaps   44: struct ml_cbs {
                     45:        int     (*ml_begin)(struct md_mbuf *,
                     46:                        const struct md_args *,
                     47:                        const struct tm *,
                     48:                        const char *, const char *,
1.13      kristaps   49:                        enum roffmsec, enum roffvol);
1.7       kristaps   50:        int     (*ml_end)(struct md_mbuf *,
1.14      kristaps   51:                        const struct md_args *,
                     52:                        const struct tm *,
                     53:                        const char *, const char *,
                     54:                        enum roffmsec, enum roffvol);
1.8       kristaps   55:        ssize_t (*ml_beginstring)(struct md_mbuf *,
                     56:                        const struct md_args *,
                     57:                        const char *, size_t);
                     58:        ssize_t (*ml_endstring)(struct md_mbuf *,
                     59:                        const struct md_args *,
                     60:                        const char *, size_t);
1.7       kristaps   61:        ssize_t (*ml_endtag)(struct md_mbuf *,
                     62:                        void *, const struct md_args *,
                     63:                        enum md_ns, int);
                     64:        ssize_t (*ml_begintag)(struct md_mbuf *,
                     65:                        void *, const struct md_args *,
                     66:                        enum md_ns, int,
1.3       kristaps   67:                        const int *, const char **);
1.7       kristaps   68:        int     (*ml_alloc)(void **);
                     69:        void    (*ml_free)(void *);
                     70: };
1.1       kristaps   71:
                     72: __BEGIN_DECLS
                     73:
1.5       kristaps   74: int              ml_putstring(struct md_mbuf *,
                     75:                        const char *, size_t *);
1.1       kristaps   76: int              ml_nputstring(struct md_mbuf *,
                     77:                        const char *, size_t, size_t *);
                     78: int              ml_nputs(struct md_mbuf *,
                     79:                        const char *, size_t, size_t *);
1.2       kristaps   80: int              ml_puts(struct md_mbuf *, const char *, size_t *);
1.1       kristaps   81: int              ml_putchars(struct md_mbuf *,
                     82:                        char, size_t, size_t *);
                     83:
1.12      kristaps   84: /* FIXME: move into mlg.h or private.h. */
1.7       kristaps   85: struct md_mlg   *mlg_alloc(const struct md_args *,
1.1       kristaps   86:                        const struct md_rbuf *, struct md_mbuf *,
1.7       kristaps   87:                        const struct ml_cbs *);
1.1       kristaps   88: int              mlg_exit(struct md_mlg *, int);
                     89: int              mlg_line(struct md_mlg *, char *);
                     90:
1.12      kristaps   91: int              ml_tagput(struct md_mbuf *,
                     92:                        enum ml_scope, const char *, size_t *);
                     93:
1.1       kristaps   94: __END_DECLS
                     95:
                     96: #endif /*!ML_H*/