c2html: src/c2html.h@1b12cf799fee (annotated)

src/c2html.h@1b12cf799fee (annotated)

src/c2html.h

Mon, 24 Apr 2023 20:54:38 +0200

author: Mike Becker <universe@uap-core.de>
date: Mon, 24 Apr 2023 20:54:38 +0200
changeset 66: 1b12cf799fee
parent 57: eba880c1705c
child 70: 60cecca5e484
permissions: -rw-r--r--

upgrade to ucx 3.0

 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
  * Copyright 2016 Mike Becker. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  *
  *   1. Redistributions of source code must retain the above copyright
  *      notice, this list of conditions and the following disclaimer.
  *
  *   2. Redistributions in binary form must reproduce the above copyright
  *      notice, this list of conditions and the following disclaimer in the
  *      documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
  */
 #ifndef C2HTML_H
 #define C2HTML_H
 #include <stdio.h>
 #include <cx/list.h>
 #include "highlighter.h"
 #ifdef __cplusplus
 extern "C" {
 #endif
 #define VERSION_MAJOR   3
 #define VERSION_MINOR   0
 #define VERSION_DEVELOP 0 /* set this to zero for release version */
 /**
  * Writes the formatted source data to the output buffer.
  *
  * @param inputbuffer the source file data as string
  * @param inputbuflen the length of the source file
  * @param outbuf the output buffer
  * @param wfnc a write function for the output buffer
  * @param hltr the highlighter function
  * @param showln zero, if line numbers shall be omitted, nonzero otherwise
  *
  * @return total amount of bytes written to the output buffer
  *
  * @see c2html_plain_highlighter()
  * @see c2html_c_highlighter()
  * @see c2html_java_highlighter()
  */
 size_t c2html_bformat(char const* inputbuffer, size_t inputbuflen,
                       void* outbuf, cx_write_func wfnc,
                       c2html_highlighter_func hltr, int showln);
 /**
  * Writes the formatted source data to the output buffer.
  *
  * This function takes a list of \c char* that point to the beginning of each
  * line. These pointers may point directly into the source text and the strings
  * do not need to be zero-terminated, but the line-breaks must be included.
  *
  * @param lines a list of pointers to the beginning of each line
  * @param outbuf the output buffer
  * @param wfnc a write function for the output buffer
  * @param hltr the highlighter function
  * @param showln zero, if line numbers shall be omitted, nonzero otherwise
  *
  * @return total amount of bytes written to the output buffer
  *
  * @see c2html_plain_highlighter()
  * @see c2html_c_highlighter()
  * @see c2html_java_highlighter()
  */
 size_t c2html_format(CxList const* lines,
                      void* outbuf, cx_write_func wfnc,
                      c2html_highlighter_func hltr, int showln);
 #ifdef __cplusplus
 }
 #endif
 #endif /* C2HTML_H */

Mercurial > hg > c2html / annotate

src/c2html.h@1b12cf799fee (annotated)

src/c2html.h