2018-01-01 09:26:34 +01:00
|
|
|
/*
|
|
|
|
libfort
|
|
|
|
|
|
|
|
MIT License
|
|
|
|
|
|
|
|
Copyright (c) 2017 - 2018 Seleznev Anton
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
|
|
copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LIBFORT_H
|
|
|
|
#define LIBFORT_H
|
|
|
|
|
|
|
|
#include <stddef.h>
|
2018-01-01 19:45:01 +01:00
|
|
|
#include <stdlib.h>
|
2018-03-18 10:17:33 +01:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <limits.h>
|
2018-01-01 09:26:34 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Configuration
|
|
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
|
|
* libfort configuration macros
|
|
|
|
* (to enable/disable some options this macros should be defined/undefined)
|
2018-01-01 09:26:34 +01:00
|
|
|
*/
|
2018-04-16 20:01:45 +02:00
|
|
|
/** #define FT_CONGIG_HAVE_WCHAR */
|
|
|
|
|
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
* Determine compiler
|
|
|
|
*****************************************************************************/
|
2018-01-01 09:26:34 +01:00
|
|
|
#if defined(__clang__)
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_CLANG_COMPILER
|
2018-01-01 09:26:34 +01:00
|
|
|
#elif defined(__GNUC__)
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_GCC_COMPILER
|
2018-01-01 09:26:34 +01:00
|
|
|
#elif defined(_MSC_VER)
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_MICROSOFT_COMPILER
|
2018-01-01 09:26:34 +01:00
|
|
|
#else
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_UNDEFINED_COMPILER
|
2018-01-01 09:26:34 +01:00
|
|
|
#endif
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Declare restrict
|
|
|
|
*****************************************************************************/
|
2018-03-31 12:33:37 +02:00
|
|
|
/*
|
2018-03-18 10:17:33 +01:00
|
|
|
#if defined(__cplusplus)
|
|
|
|
#if defined(FT_CLANG_COMPILER)
|
|
|
|
#define FT_RESTRICT __restrict__
|
|
|
|
#else
|
|
|
|
#define FT_RESTRICT __restrict
|
2018-03-31 12:33:37 +02:00
|
|
|
#endif // if defined(FT_CLANG_COMPILER)
|
2018-03-18 10:17:33 +01:00
|
|
|
#else
|
|
|
|
#if __STDC_VERSION__ < 199901L
|
|
|
|
#define FT_RESTRICT
|
|
|
|
#else
|
|
|
|
#define FT_RESTRICT restrict
|
2018-03-31 12:33:37 +02:00
|
|
|
#endif // __STDC_VERSION__ < 199901L
|
|
|
|
#endif // if defined(__cplusplus)
|
|
|
|
*/
|
2018-03-09 10:44:16 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Declare inline
|
|
|
|
*****************************************************************************/
|
2018-03-09 10:44:16 +01:00
|
|
|
#if defined(__cplusplus)
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_INLINE inline
|
2018-03-09 10:44:16 +01:00
|
|
|
#else
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_INLINE __inline
|
2018-03-09 10:44:16 +01:00
|
|
|
#endif /* if defined(__cplusplus) */
|
|
|
|
|
2018-03-09 09:17:12 +01:00
|
|
|
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Attribute format for argument checking
|
|
|
|
*****************************************************************************/
|
2018-03-14 19:30:27 +01:00
|
|
|
#if defined(FT_CLANG_COMPILER) || defined(FT_GCC_COMPILER)
|
|
|
|
#define FT_PRINTF_ATTRIBUTE_FORMAT(string_index, first_to_check) \
|
2018-01-22 19:31:03 +01:00
|
|
|
__attribute__ ((format (printf, string_index, first_to_check)))
|
|
|
|
#else
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_PRINTF_ATTRIBUTE_FORMAT(string_index, first_to_check)
|
|
|
|
#endif /* defined(FT_CLANG_COMPILER) || defined(FT_GCC_COMPILER) */
|
2018-01-22 19:31:03 +01:00
|
|
|
|
2018-01-01 09:26:34 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* C++ needs to know that types and declarations are C, not C++.
|
|
|
|
*****************************************************************************/
|
2018-03-31 12:33:37 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
# define FT_BEGIN_DECLS extern "C" {
|
|
|
|
# define FT_END_DECLS }
|
2018-01-01 09:26:34 +01:00
|
|
|
#else
|
2018-03-14 19:30:27 +01:00
|
|
|
# define FT_BEGIN_DECLS
|
|
|
|
# define FT_END_DECLS
|
2018-01-01 09:26:34 +01:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
2018-03-14 19:30:27 +01:00
|
|
|
#ifndef FT_EXTERN
|
|
|
|
#define FT_EXTERN extern
|
2018-01-02 20:48:38 +01:00
|
|
|
#endif
|
|
|
|
|
2018-01-20 19:27:24 +01:00
|
|
|
|
2018-04-08 14:48:15 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* RETURN CODES
|
2018-04-16 20:01:45 +02:00
|
|
|
*****************************************************************************/
|
2018-04-08 14:48:15 +02:00
|
|
|
typedef int fort_status_t;
|
|
|
|
#define FT_SUCCESS 0
|
|
|
|
#define FT_MEMORY_ERROR -1
|
|
|
|
#define FT_ERROR -2
|
|
|
|
#define FT_EINVAL -3
|
|
|
|
#define IS_SUCCESS(arg) ((arg) >= 0)
|
|
|
|
#define IS_ERROR(arg) ((arg) < 0)
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/*****************************************************************************
|
|
|
|
* Wchar support
|
|
|
|
*****************************************************************************/
|
2018-03-09 09:11:40 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
#if defined(FT_CONGIG_HAVE_WCHAR)
|
2018-03-14 19:30:27 +01:00
|
|
|
#define FT_HAVE_WCHAR
|
2018-04-16 20:01:45 +02:00
|
|
|
#endif
|
2018-03-05 19:08:14 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
* Helper macros
|
|
|
|
*****************************************************************************/
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-01-20 19:27:24 +01:00
|
|
|
#define STR_2_CAT_(arg1, arg2) \
|
|
|
|
arg1##arg2
|
|
|
|
#define STR_2_CAT(arg1, arg2) \
|
|
|
|
STR_2_CAT_(arg1, arg2)
|
|
|
|
|
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
static FT_INLINE int ft_check_if_string_helper(const char *str)
|
2018-01-20 19:27:24 +01:00
|
|
|
{
|
|
|
|
(void)str;
|
2018-01-22 19:31:03 +01:00
|
|
|
return 0;
|
2018-01-20 19:27:24 +01:00
|
|
|
}
|
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
static FT_INLINE int ft_check_if_wstring_helper(const wchar_t *str)
|
2018-03-05 19:08:14 +01:00
|
|
|
{
|
|
|
|
(void)str;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2018-03-17 19:53:38 +01:00
|
|
|
#define FORT_NARGS_IMPL_(x1,x2,x3,x4,x5,x6,x7,x8,x9,x10,x11,x12,x13,x14,x15,N,...) N
|
|
|
|
#define FT_EXPAND_(x) x
|
|
|
|
#define PP_NARG(...) \
|
|
|
|
FT_EXPAND_(FORT_NARGS_IMPL_(__VA_ARGS__,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1,0))
|
|
|
|
|
|
|
|
#define CHECK_IF_STRING_32(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_31(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_31(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_30(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_30(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_29(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_29(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_28(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_28(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_27(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_27(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_26(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_26(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_25(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_25(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_24(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_24(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_23(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_23(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_22(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_22(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_21(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_21(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_20(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_20(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_19(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_19(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_18(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_18(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_17(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_17(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_16(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_16(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_15(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_15(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_14(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_14(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_13(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_13(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_12(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_12(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_11(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_11(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_10(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_10(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_9(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_9(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_8(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_8(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_7(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_7(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_6(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_6(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_5(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_5(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_4(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_4(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_3(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_3(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_2(checker,__VA_ARGS__)))
|
|
|
|
#define CHECK_IF_STRING_2(checker,arg,...) (checker(arg),FT_EXPAND_(CHECK_IF_STRING_1(checker,__VA_ARGS__)))
|
2018-03-14 19:30:27 +01:00
|
|
|
#define CHECK_IF_STRING_1(checker,arg) (checker(arg))
|
2018-03-05 19:08:14 +01:00
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
#define CHECK_IF_ARGS_ARE_STRINGS__(checker,func, ...) \
|
|
|
|
FT_EXPAND_(func(checker,__VA_ARGS__))
|
|
|
|
#define CHECK_IF_ARGS_ARE_STRINGS_(checker,basis, n, ...) \
|
|
|
|
CHECK_IF_ARGS_ARE_STRINGS__(checker,STR_2_CAT_(basis, n), __VA_ARGS__)
|
|
|
|
#define CHECK_IF_ARGS_ARE_STRINGS(...) \
|
|
|
|
CHECK_IF_ARGS_ARE_STRINGS_(ft_check_if_string_helper,CHECK_IF_STRING_,PP_NARG(__VA_ARGS__), __VA_ARGS__)
|
2018-03-14 19:30:27 +01:00
|
|
|
#ifdef FT_HAVE_WCHAR
|
2018-04-01 10:36:52 +02:00
|
|
|
#define CHECK_IF_ARGS_ARE_WSTRINGS(...) \
|
|
|
|
CHECK_IF_ARGS_ARE_STRINGS_(ft_check_if_wstring_helper,CHECK_IF_STRING_,PP_NARG(__VA_ARGS__), __VA_ARGS__)
|
2018-03-05 19:08:14 +01:00
|
|
|
#endif
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/*****************************************************************************
|
|
|
|
* libfort API
|
|
|
|
*****************************************************************************/
|
|
|
|
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-03-14 19:30:27 +01:00
|
|
|
FT_BEGIN_DECLS
|
2018-02-27 19:53:00 +01:00
|
|
|
|
|
|
|
struct fort_table;
|
|
|
|
typedef struct fort_table FTABLE;
|
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
/**
|
|
|
|
* Create formatted table.
|
|
|
|
*
|
|
|
|
* @return
|
2018-04-16 20:01:45 +02:00
|
|
|
* The pointer to the new allocated FTABLE, on success. NULL on error.
|
2018-04-01 10:36:52 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN FTABLE *ft_create_table(void);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
/**
|
|
|
|
* Destroy formatted table.
|
|
|
|
*
|
|
|
|
* Destroy formatted table and free all resources allocated during table creation
|
|
|
|
* and work with it.
|
|
|
|
*
|
|
|
|
* @param table
|
2018-04-16 20:01:45 +02:00
|
|
|
* Pointer to formatted table previousley created with ft_create_table. If
|
|
|
|
* table is a null pointer, the function does nothing.
|
2018-04-01 10:36:52 +02:00
|
|
|
*/
|
|
|
|
FT_EXTERN void ft_destroy_table(FTABLE *table);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
/**
|
|
|
|
* Move current position to the first cell of the next line(row).
|
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN void ft_ln(FTABLE *table);
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Get row number of the current cell.
|
2018-04-16 20:01:45 +02:00
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
* @return
|
2018-04-22 20:42:22 +02:00
|
|
|
* Row number of the current cell.
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-04-01 10:36:52 +02:00
|
|
|
FT_EXTERN size_t ft_cur_row(FTABLE *table);
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Get column number of the current cell.
|
2018-04-16 20:01:45 +02:00
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
* @return
|
2018-04-22 20:42:22 +02:00
|
|
|
* Column number of the current cell.
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-04-01 10:36:52 +02:00
|
|
|
FT_EXTERN size_t ft_cur_col(FTABLE *table);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-04-22 20:42:22 +02:00
|
|
|
/**
|
|
|
|
* Set current cell position.
|
|
|
|
*
|
|
|
|
* Current cell - cell that will be edited with all modifiing functions
|
|
|
|
* (ft_printf, ft_write ...).
|
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
* @param row
|
|
|
|
* New row number for the current cell.
|
|
|
|
* @param col
|
|
|
|
* New row number for the current cell.
|
|
|
|
*/
|
|
|
|
FT_EXTERN void ft_set_cur_cell(FTABLE *table, size_t row, size_t col);
|
|
|
|
|
|
|
|
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-03-14 19:30:27 +01:00
|
|
|
#if defined(FT_CLANG_COMPILER) || defined(FT_GCC_COMPILER)
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Writes data formatted acording to the format string to a variety of table
|
|
|
|
* cells.
|
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
* @param fmt
|
|
|
|
* Pointer to a null-terminated multibyte string specifying how to interpret
|
|
|
|
* the data. The format string consists of ordinary characters (except % and |),
|
|
|
|
* which are copied unchanged into the output stream, and conversion
|
|
|
|
* specifications. Conversion specifications are the same as for standard
|
|
|
|
* printf function. Character '|' in the format string is treated as a cell
|
|
|
|
* separator.
|
|
|
|
* @param ...
|
|
|
|
* Arguments specifying data to print. Similarly to standard printf-like
|
|
|
|
* functions if any argument after default conversions is not the type
|
|
|
|
* expected by the corresponding conversion specifier, or if there are fewer
|
|
|
|
* arguments than required by format, the behavior is undefined. If there are
|
|
|
|
* more arguments than required by format, the extraneous arguments are
|
|
|
|
* evaluated and ignored.
|
|
|
|
* @return
|
2018-04-22 20:42:22 +02:00
|
|
|
* - Number of printed cells
|
|
|
|
* - (<0): In case of error
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_printf(FTABLE *table, const char *fmt, ...) FT_PRINTF_ATTRIBUTE_FORMAT(2, 3);
|
2018-04-16 20:01:45 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Writes data formatted acording to the format string to a variety of table
|
|
|
|
* cells and moves current position to the first cell of the next line(row).
|
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Pointer to formatted table.
|
|
|
|
* @param fmt
|
|
|
|
* Pointer to a null-terminated multibyte string specifying how to interpret
|
|
|
|
* the data. The format string consists of ordinary characters (except % and |),
|
|
|
|
* which are copied unchanged into the output stream, and conversion
|
|
|
|
* specifications. Conversion specifications are the same as for standard
|
|
|
|
* printf function. Character '|' in the format string is treated as a cell
|
|
|
|
* separator.
|
|
|
|
* @param ...
|
|
|
|
* Arguments specifying data to print. Similarly to standard printf-like
|
|
|
|
* functions if any argument after default conversions is not the type
|
|
|
|
* expected by the corresponding conversion specifier, or if there are fewer
|
|
|
|
* arguments than required by format, the behavior is undefined. If there are
|
|
|
|
* more arguments than required by format, the extraneous arguments are
|
|
|
|
* evaluated and ignored.
|
|
|
|
* @return
|
2018-04-22 20:42:22 +02:00
|
|
|
* - Number of printed cells.
|
|
|
|
* - (<0): In case of error.
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_printf_ln(FTABLE *table, const char *fmt, ...) FT_PRINTF_ATTRIBUTE_FORMAT(2, 3);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
|
|
|
#else
|
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_printf_impl(FTABLE *table, const char *fmt, ...) FT_PRINTF_ATTRIBUTE_FORMAT(2, 3);
|
|
|
|
FT_EXTERN int ft_printf_ln_impl(FTABLE *table, const char *fmt, ...) FT_PRINTF_ATTRIBUTE_FORMAT(2, 3);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
|
|
|
#define ft_printf(table, ...) \
|
|
|
|
(( 0 ? fprintf(stderr, __VA_ARGS__) : 1), ft_printf_impl(table, __VA_ARGS__))
|
|
|
|
#define ft_printf_ln(table, ...) \
|
|
|
|
(( 0 ? fprintf(stderr, __VA_ARGS__) : 1), ft_printf_ln_impl(table, __VA_ARGS__))
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_write(FTABLE *table, const char *cell_content);
|
|
|
|
FT_EXTERN int ft_write_ln(FTABLE *table, const char *cell_content);
|
2018-02-27 19:53:00 +01:00
|
|
|
|
2018-01-20 19:27:24 +01:00
|
|
|
#define FT_NWRITE(table, ...)\
|
2018-01-22 19:31:03 +01:00
|
|
|
(0 ? CHECK_IF_ARGS_ARE_STRINGS(__VA_ARGS__) : ft_nwrite(table, PP_NARG(__VA_ARGS__), __VA_ARGS__))
|
2018-01-21 09:19:18 +01:00
|
|
|
#define FT_NWRITE_LN(table, ...)\
|
2018-01-22 19:31:03 +01:00
|
|
|
(0 ? CHECK_IF_ARGS_ARE_STRINGS(__VA_ARGS__) : ft_nwrite_ln(table, PP_NARG(__VA_ARGS__), __VA_ARGS__))
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_nwrite(FTABLE *table, size_t n, const char *cell_content, ...);
|
|
|
|
FT_EXTERN int ft_nwrite_ln(FTABLE *table, size_t n, const char *cell_content, ...);
|
2018-01-20 19:27:24 +01:00
|
|
|
|
|
|
|
|
2018-03-05 19:08:14 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
2018-01-20 19:27:24 +01:00
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_row_write(FTABLE *table, size_t cols, const char *row_cells[]);
|
|
|
|
FT_EXTERN int ft_row_write_ln(FTABLE *table, size_t cols, const char *row_cells[]);
|
2018-01-20 19:27:24 +01:00
|
|
|
|
2018-03-17 19:53:38 +01:00
|
|
|
#if !defined(__cplusplus) && !defined(FT_MICROSOFT_COMPILER)
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_s_table_write(FTABLE *table, size_t rows, size_t cols, const char *table_cells[rows][cols]);
|
|
|
|
FT_EXTERN int ft_s_table_write_ln(FTABLE *table, size_t rows, size_t cols, const char *table_cells[rows][cols]);
|
2018-01-20 19:27:24 +01:00
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_table_write(FTABLE *table, size_t rows, size_t cols, const char * * table_cells[rows]);
|
|
|
|
FT_EXTERN int ft_table_write_ln(FTABLE *table, size_t rows, size_t cols, const char * * table_cells[rows]);
|
2018-03-17 19:53:38 +01:00
|
|
|
#endif
|
2018-01-20 19:27:24 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
/**
|
|
|
|
* Add separator after the current row.
|
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Formatted table.
|
|
|
|
* @return
|
|
|
|
* - 0: Success; separator was added.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_add_separator(FTABLE *table);
|
2018-01-20 19:27:24 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
/**
|
|
|
|
* Convert table to string representation.
|
|
|
|
*
|
|
|
|
* FTABLE has ownership of the returned pointer. So there is no need to
|
|
|
|
* free it. To take ownership user should explicitly copy the returned
|
2018-04-16 20:01:45 +02:00
|
|
|
* string with strdup or similar functions.
|
|
|
|
*
|
|
|
|
* Returned pointer may be later invalidated by:
|
2018-04-22 20:42:22 +02:00
|
|
|
* - Calling ft_destroy_table;
|
|
|
|
* - Other invocations of ft_to_string.
|
2018-04-01 10:36:52 +02:00
|
|
|
*
|
|
|
|
* @param table
|
|
|
|
* Formatted table.
|
|
|
|
* @return
|
|
|
|
* The pointer to the string representation of formatted table, on success.
|
|
|
|
* NULL on error with ft_errno set appropriately.
|
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN const char *ft_to_string(const FTABLE *table);
|
2018-01-03 08:40:54 +01:00
|
|
|
|
2018-01-07 10:22:26 +01:00
|
|
|
|
2018-03-18 10:17:33 +01:00
|
|
|
|
|
|
|
|
2018-04-01 10:36:52 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
2018-03-18 10:17:33 +01:00
|
|
|
|
|
|
|
|
2018-04-01 12:27:02 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Structure describing border appearance.
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
struct ft_border_chars {
|
2018-02-25 09:39:41 +01:00
|
|
|
char top_border_ch;
|
|
|
|
char separator_ch;
|
|
|
|
char bottom_border_ch;
|
|
|
|
char side_border_ch;
|
|
|
|
char out_intersect_ch;
|
|
|
|
char in_intersect_ch;
|
|
|
|
};
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Structure describing border style.
|
2018-04-16 20:01:45 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
struct ft_border_style {
|
2018-03-12 20:28:55 +01:00
|
|
|
struct ft_border_chars border_chs;
|
|
|
|
struct ft_border_chars header_border_chs;
|
2018-03-14 19:30:27 +01:00
|
|
|
char hor_separator_char;
|
2018-03-12 20:28:55 +01:00
|
|
|
};
|
|
|
|
|
2018-04-01 12:27:02 +02:00
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Built-in table border styles.
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
extern struct ft_border_style *FT_BASIC_STYLE;
|
|
|
|
extern struct ft_border_style *FT_SIMPLE_STYLE;
|
|
|
|
extern struct ft_border_style *FT_PLAIN_STYLE;
|
|
|
|
extern struct ft_border_style *FT_DOT_STYLE;
|
|
|
|
extern struct ft_border_style *FT_EMPTY_STYLE;
|
2018-03-12 20:28:55 +01:00
|
|
|
|
2018-04-01 12:27:02 +02:00
|
|
|
/**
|
|
|
|
* Set default border style for all new formatted tables.
|
|
|
|
*
|
|
|
|
* @param style
|
2018-04-22 20:42:22 +02:00
|
|
|
* Pointer to border style.
|
2018-04-01 12:27:02 +02:00
|
|
|
* @return
|
|
|
|
* - 0: Success; default border style was changed.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-14 20:18:59 +01:00
|
|
|
FT_EXTERN int ft_set_default_border_style(struct ft_border_style *style);
|
2018-04-01 12:27:02 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set border style for the table.
|
|
|
|
*
|
|
|
|
* @param table
|
2018-04-22 20:42:22 +02:00
|
|
|
* A pointer to the FTABLE structure.
|
2018-04-01 12:27:02 +02:00
|
|
|
* @param style
|
2018-04-22 20:42:22 +02:00
|
|
|
* Pointer to border style.
|
2018-04-01 12:27:02 +02:00
|
|
|
* @return
|
|
|
|
* - 0: Success; table border style was changed.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_set_border_style(FTABLE *table, struct ft_border_style *style);
|
2018-03-14 20:18:59 +01:00
|
|
|
|
2018-04-01 12:27:02 +02:00
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Special macros to define cell position (row and column).
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
|
|
|
#define FT_ANY_COLUMN (UINT_MAX)
|
|
|
|
#define FT_CUR_COLUMN (UINT_MAX - 1)
|
|
|
|
#define FT_ANY_ROW (UINT_MAX)
|
|
|
|
#define FT_CUR_ROW (UINT_MAX - 1)
|
|
|
|
|
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell options identifiers.
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
|
|
|
#define FT_COPT_MIN_WIDTH (0x01U << 0) /**< Minimum width */
|
|
|
|
#define FT_COPT_TEXT_ALIGN (0x01U << 1) /**< Text alignmemnt */
|
|
|
|
#define FT_COPT_TOP_PADDING (0x01U << 2) /**< Top padding for cell content */
|
|
|
|
#define FT_COPT_BOTTOM_PADDING (0x01U << 3) /**< Bottom padding for cell content */
|
|
|
|
#define FT_COPT_LEFT_PADDING (0x01U << 4) /**< Left padding for cell content */
|
|
|
|
#define FT_COPT_RIGHT_PADDING (0x01U << 5) /**< Right padding for cell content */
|
|
|
|
#define FT_COPT_EMPTY_STR_HEIGHT (0x01U << 6) /**< Height of empty cell */
|
|
|
|
#define FT_COPT_ROW_TYPE (0x01U << 7) /**< Row type */
|
|
|
|
|
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Alignment of cell content.
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
|
|
|
enum ft_text_alignment {
|
|
|
|
FT_ALIGNED_LEFT,
|
|
|
|
FT_ALIGNED_CENTER,
|
|
|
|
FT_ALIGNED_RIGHT
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Type of table row.
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
|
|
|
enum ft_row_type {
|
|
|
|
FT_ROW_COMMON,
|
|
|
|
FT_ROW_HEADER
|
|
|
|
};
|
|
|
|
|
2018-04-01 12:40:56 +02:00
|
|
|
/**
|
|
|
|
* Set default cell option for all new formatted tables.
|
|
|
|
*
|
|
|
|
* @param option
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell option identifier.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @param value
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell option value.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @return
|
|
|
|
* - 0: Success; default cell option was changed.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-25 10:11:08 +02:00
|
|
|
FT_EXTERN int ft_set_default_cell_option(uint32_t option, int value);
|
2018-04-01 12:40:56 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set option for the specified cell of the table.
|
|
|
|
*
|
|
|
|
* @param table
|
2018-04-22 20:42:22 +02:00
|
|
|
* A pointer to the FTABLE structure.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @param row
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell row.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @param col
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell column.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @param option
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell option identifier.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @param value
|
2018-04-22 20:42:22 +02:00
|
|
|
* Cell option value.
|
2018-04-01 12:40:56 +02:00
|
|
|
* @return
|
2018-04-01 15:01:30 +02:00
|
|
|
* - 0: Success; cell option was changed.
|
2018-04-01 12:40:56 +02:00
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-04-17 19:14:50 +02:00
|
|
|
FT_EXTERN int ft_set_cell_option(FTABLE *table, size_t row, size_t col, uint32_t option, int value);
|
2018-03-25 10:11:08 +02:00
|
|
|
|
2018-04-01 12:27:02 +02:00
|
|
|
/**
|
2018-04-22 20:42:22 +02:00
|
|
|
* Table options identifiers.
|
2018-04-01 12:27:02 +02:00
|
|
|
*/
|
|
|
|
#define FT_TOPT_LEFT_MARGIN (0x01U << 0)
|
|
|
|
#define FT_TOPT_TOP_MARGIN (0x01U << 1)
|
|
|
|
#define FT_TOPT_RIGHT_MARGIN (0x01U << 2)
|
|
|
|
#define FT_TOPT_BOTTOM_MARGIN (0x01U << 3)
|
|
|
|
|
2018-04-01 15:01:30 +02:00
|
|
|
/**
|
|
|
|
* Set default table option.
|
|
|
|
*
|
|
|
|
* @param option
|
2018-04-22 20:42:22 +02:00
|
|
|
* Table option identifier.
|
2018-04-01 15:01:30 +02:00
|
|
|
* @param value
|
2018-04-22 20:42:22 +02:00
|
|
|
* Table option value.
|
2018-04-01 15:01:30 +02:00
|
|
|
* @return
|
|
|
|
* - 0: Success; default table option was changed.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-25 10:11:08 +02:00
|
|
|
FT_EXTERN int ft_set_default_tbl_option(uint32_t option, int value);
|
2018-04-01 15:01:30 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set table option.
|
|
|
|
*
|
|
|
|
* @param table
|
2018-04-22 20:42:22 +02:00
|
|
|
* A pointer to the FTABLE structure.
|
2018-04-01 15:01:30 +02:00
|
|
|
* @param option
|
2018-04-22 20:42:22 +02:00
|
|
|
* Table option identifier.
|
2018-04-01 15:01:30 +02:00
|
|
|
* @param value
|
2018-04-22 20:42:22 +02:00
|
|
|
* Table option value.
|
2018-04-01 15:01:30 +02:00
|
|
|
* @return
|
|
|
|
* - 0: Success; default table option was changed.
|
|
|
|
* - (-1): !!!!!!!! todo
|
|
|
|
*/
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_set_tbl_option(FTABLE *table, uint32_t option, int value);
|
2018-03-14 20:18:59 +01:00
|
|
|
|
|
|
|
|
2018-04-16 20:01:45 +02:00
|
|
|
/**
|
|
|
|
* Set functions for memory allocation and deallocation to be used instead of
|
|
|
|
* standard ones.
|
|
|
|
*
|
|
|
|
* @param f_malloc
|
|
|
|
* Pointer to a function for memory allocation that should be used instead of
|
|
|
|
* malloc.
|
|
|
|
* @param f_free
|
|
|
|
* Pointer to a function for memory deallocation that should be used instead
|
|
|
|
* of free.
|
|
|
|
* @note
|
|
|
|
* To return memory allocation/deallocation functions to their standard values
|
|
|
|
* set f_malloc and f_free to NULL.
|
|
|
|
*/
|
2018-04-04 21:13:37 +02:00
|
|
|
FT_EXTERN void ft_set_memory_funcs(void *(*f_malloc)(size_t size), void (*f_free)(void *ptr));
|
2018-03-14 20:18:59 +01:00
|
|
|
|
|
|
|
|
|
|
|
#ifdef FT_HAVE_WCHAR
|
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_wwrite(FTABLE *table, const wchar_t *cell_content);
|
|
|
|
FT_EXTERN int ft_wwrite_ln(FTABLE *table, const wchar_t *cell_content);
|
2018-03-14 20:18:59 +01:00
|
|
|
|
|
|
|
#define FT_NWWRITE(table, ...)\
|
|
|
|
(0 ? CHECK_IF_ARGS_ARE_WSTRINGS(__VA_ARGS__) : ft_nwwrite(table, PP_NARG(__VA_ARGS__), __VA_ARGS__))
|
|
|
|
#define FT_NWWRITE_LN(table, ...)\
|
|
|
|
(0 ? CHECK_IF_ARGS_ARE_WSTRINGS(__VA_ARGS__) : ft_nwwrite_ln(table, PP_NARG(__VA_ARGS__), __VA_ARGS__))
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_nwwrite(FTABLE *table, size_t n, const wchar_t *cell_content, ...);
|
|
|
|
FT_EXTERN int ft_nwwrite_ln(FTABLE *table, size_t n, const wchar_t *cell_content, ...);
|
2018-03-14 20:18:59 +01:00
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN int ft_row_wwrite(FTABLE *table, size_t cols, const wchar_t *row_cells[]);
|
|
|
|
FT_EXTERN int ft_row_wwrite_ln(FTABLE *table, size_t cols, const wchar_t *row_cells[]);
|
2018-03-14 20:18:59 +01:00
|
|
|
|
2018-03-31 12:33:37 +02:00
|
|
|
FT_EXTERN const wchar_t *ft_to_wstring(const FTABLE *table);
|
2018-03-14 20:18:59 +01:00
|
|
|
#endif
|
2018-02-25 09:39:41 +01:00
|
|
|
|
2018-02-25 19:43:20 +01:00
|
|
|
|
2018-02-25 09:39:41 +01:00
|
|
|
|
2018-03-14 19:30:27 +01:00
|
|
|
FT_END_DECLS
|
2018-01-01 09:26:34 +01:00
|
|
|
|
2018-03-09 10:44:16 +01:00
|
|
|
#endif /* LIBFORT_H */
|