Return to ml.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/ml.h, Revision 1.12

1.12    ! kristaps    1: /* $Id: ml.h,v 1.11 2008/12/09 17:09:12 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,
                     36:        MD_NS_DEFAULT,
                     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.10      kristaps   49:                        enum roffmsec, const char *);
1.7       kristaps   50:        int     (*ml_end)(struct md_mbuf *,
1.3       kristaps   51:                        const struct md_args *);
1.8       kristaps   52:        ssize_t (*ml_beginstring)(struct md_mbuf *,
                     53:                        const struct md_args *,
                     54:                        const char *, size_t);
                     55:        ssize_t (*ml_endstring)(struct md_mbuf *,
                     56:                        const struct md_args *,
                     57:                        const char *, size_t);
1.7       kristaps   58:        ssize_t (*ml_endtag)(struct md_mbuf *,
                     59:                        void *, const struct md_args *,
                     60:                        enum md_ns, int);
                     61:        ssize_t (*ml_begintag)(struct md_mbuf *,
                     62:                        void *, const struct md_args *,
                     63:                        enum md_ns, int,
1.3       kristaps   64:                        const int *, const char **);
1.7       kristaps   65:        int     (*ml_alloc)(void **);
                     66:        void    (*ml_free)(void *);
                     67: };
1.1       kristaps   68:
                     69: __BEGIN_DECLS
                     70:
1.5       kristaps   71: int              ml_putstring(struct md_mbuf *,
                     72:                        const char *, size_t *);
1.1       kristaps   73: int              ml_nputstring(struct md_mbuf *,
                     74:                        const char *, size_t, size_t *);
                     75: int              ml_nputs(struct md_mbuf *,
                     76:                        const char *, size_t, size_t *);
1.2       kristaps   77: int              ml_puts(struct md_mbuf *, const char *, size_t *);
1.1       kristaps   78: int              ml_putchars(struct md_mbuf *,
                     79:                        char, size_t, size_t *);
                     80:
1.12    ! kristaps   81: /* FIXME: move into mlg.h or private.h. */
1.7       kristaps   82: struct md_mlg   *mlg_alloc(const struct md_args *,
1.1       kristaps   83:                        const struct md_rbuf *, struct md_mbuf *,
1.7       kristaps   84:                        const struct ml_cbs *);
1.1       kristaps   85: int              mlg_exit(struct md_mlg *, int);
                     86: int              mlg_line(struct md_mlg *, char *);
                     87:
1.12    ! kristaps   88: int              ml_tagput(struct md_mbuf *,
        !            89:                        enum ml_scope, const char *, size_t *);
        !            90:
1.1       kristaps   91: __END_DECLS
                     92:
                     93: #endif /*!ML_H*/