| 1 | /*
|
|---|
| 2 | * Copyright (c) 2011 Martin Sucha
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | typedef enum {
|
|---|
| 30 | ALIGN_LEFT,
|
|---|
| 31 | ALIGN_RIGHT,
|
|---|
| 32 | ALIGN_CENTER,
|
|---|
| 33 | ALIGN_JUSTIFY
|
|---|
| 34 | } align_mode_t;
|
|---|
| 35 |
|
|---|
| 36 | /** Callback that processes a line of characters.
|
|---|
| 37 | * (e.g. as a result of wrap operation)
|
|---|
| 38 | *
|
|---|
| 39 | * @param content pointer to line data (note: this is NOT null-terminated)
|
|---|
| 40 | * @param size number of characters in line
|
|---|
| 41 | * @param end_of_para true if the line is the last line of the paragraph
|
|---|
| 42 | * @param data user data
|
|---|
| 43 | *
|
|---|
| 44 | * @returns EOK on success or an error code on failure
|
|---|
| 45 | */
|
|---|
| 46 | typedef errno_t (*line_consumer_fn)(char32_t *, size_t, bool, void *);
|
|---|
| 47 |
|
|---|
| 48 | extern errno_t print_aligned_w(const char32_t *, size_t, bool, align_mode_t);
|
|---|
| 49 | extern errno_t print_aligned(const char *, size_t, bool, align_mode_t);
|
|---|
| 50 | extern errno_t print_wrapped(const char *, size_t, align_mode_t);
|
|---|
| 51 | extern errno_t print_wrapped_console(const char *, align_mode_t);
|
|---|
| 52 |
|
|---|
| 53 | /** Wrap characters in a wide string to the given length.
|
|---|
| 54 | *
|
|---|
| 55 | * @param wstr the null-terminated wide string to wrap
|
|---|
| 56 | * @param size number of characters to wrap to
|
|---|
| 57 | * @param consumer the function that receives wrapped lines
|
|---|
| 58 | * @param data user data to pass to the consumer function
|
|---|
| 59 | */
|
|---|
| 60 | extern errno_t wrap(char32_t *, size_t, line_consumer_fn, void *);
|
|---|
