source: mainline/uspace/lib/fmtutil/fmtutil.h@ 22cf42d9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 22cf42d9 was 22cf42d9, checked in by Martin Sucha <sucha14@…>, 14 years ago

Add formatting library and display help message wrapped

  • Property mode set to 100644
File size: 2.5 KB
Line 
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
29typedef 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 data user data
42 *
43 * @returns EOK on success or error code on failure
44 */
45typedef int (*line_consumer_fn)(wchar_t *, size_t, void *);
46
47extern int print_aligned_w(const wchar_t *, size_t, align_mode_t);
48extern int print_aligned(const char *, size_t, align_mode_t);
49extern int print_wrapped(const char *, size_t, align_mode_t);
50extern int print_wrapped_console(const char *, align_mode_t);
51
52/** Wrap characters in a wide string to the given length.
53 *
54 * @param wstr the null-terminated wide string to wrap
55 * @param size number of characters to wrap to
56 * @param consumer the function that receives wrapped lines
57 * @param data user data to pass to the consumer function
58 */
59extern int wrap(wchar_t *, size_t, line_consumer_fn, void *);
Note: See TracBrowser for help on using the repository browser.