libcapsbase.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * (c) 2018 Juergen Borleis <projects@caps-printing.org>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
 
#include <stdio.h>
#include <stdbool.h>
#include <stdint.h>
#include <features.h>
 
__BEGIN_DECLS
 
#define __non_null __attribute__((nonnull))
#ifdef DOXYGEN
# define __nonnull(params) __attribute__ ((__nonnull__ params))
#endif
#define __format(x,y) __attribute__((format (printf, x, y)))
#define __format_arg(x) __attribute__((format_arg (x)))
#define __packed __attribute__((packed))
#define __maybe_unused __attribute__((unused))
#define __deprecated __attribute__((deprecated))
#define __no_return __attribute__((noreturn))
#define __pure __attribute__((pure))
#define __const __attribute__((const))
#define __cleanup(x) __attribute__((cleanup (x)))
#define __returns_nonnull __attribute__((returns_nonnull))
#define __warn_unused_res __attribute__((warn_unused_result))
#define __fallthrough __attribute__((fallthrough))
#define __cold __attribute__((cold))
#define __hot __attribute__((hot))
#if __has_attribute(nonstring)
# define __nonstring __attribute__((nonstring))
#else
# define __nonstring
#endif
#define LIBCAPSBASE_MAJOR 1
#define LIBCAPSBASE_MINOR 1
#define LIBCAPSBASE_MICRO 1
void caps_libbase_version_get(unsigned *major, unsigned *minor, unsigned *micro) __nonnull();
#define caps_print_panic(fmt, ...) caps_message_print(LIBCAPS_PANIC, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_error(fmt, ...) caps_message_print(LIBCAPS_ERROR, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_warn(fmt, ...) caps_message_print(LIBCAPS_WARN, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_info(fmt, ...) caps_message_print(LIBCAPS_INFO, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_loud(fmt, ...) caps_message_print(LIBCAPS_LOUD, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_noisy(fmt, ...) caps_message_print(LIBCAPS_NOISY, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
#define caps_print_debug_template(fmt, ...) caps_message_print(LIBCAPS_DEBUG, PACKAGE, __func__, __LINE__, fmt, ##__VA_ARGS__)
typedef int64_t caps_identifier;
#define CAPS_INVALID_IDENTIFIER (INT64_C(-1))
struct caps_rect {
    double width; 
    double length; 
};
#define CAPS_REC_IS_EMPTY(x) ((x.width == 0.0) && (x.length == 0.0))
struct caps_area {
    double left; 
    double bottom; 
    double right; 
    double top; 
};
enum caps_colour_format {
    CAPS_CF_NONE = 0, 
    CAPS_CF_MONOCHROME0 = 1, 
    CAPS_CF_MONOCHROME1 = 2, 
    CAPS_CF_GREY = 4, 
    CAPS_CF_RGB = 8, 
    CAPS_CF_CMYK = 16, 
};
struct caps_dot_monochrome {
    uint8_t pgroup;
} __packed;
struct caps_dot_grey {
    uint8_t luminance;
} __packed;
struct caps_dot_rgb {
    uint8_t red; 
    uint8_t green; 
    uint8_t blue; 
} __packed;
struct caps_dot_cmyk {
    uint8_t cyan; 
    uint8_t magenta; 
    uint8_t yellow; 
    uint8_t key; 
} __packed;
enum caps_verbosity {
    LIBCAPS_PANIC = 1, 
    LIBCAPS_ERROR, 
    LIBCAPS_WARN, 
    LIBCAPS_INFO, 
    LIBCAPS_LOUD, 
    LIBCAPS_NOISY, 
    LIBCAPS_DEBUG, 
};
void caps_libbase_init(void);
void caps_verbosity_level_set(enum caps_verbosity level, bool overwrite);
void caps_message_stream_set(FILE *stream);
void caps_message_print(enum caps_verbosity level, const char *scope, const char *fn, int ln, const char *format, ...) __format(5,6);
#define caps_developers_failure_report(fmt) caps_developers_failure_report_and_terminate(PACKAGE, __func__, __LINE__, fmt)
void caps_developers_failure_report_and_terminate(const char *scope, const char *fn, int ln, const char *message) __no_return __nonnull();
#define caps_memory_failure_report(fn) caps_memory_failure_report_and_terminate(PACKAGE, fn, __LINE__)
void caps_memory_failure_report_and_terminate(const char *scope, const char *fn, int ln) __no_return __nonnull();
void caps_terminate(int rc) __no_return;
#ifdef NDEBUG
# define caps_assert(expr)
#else
# define caps_assert(expr) if (!(expr)) { \
        caps_message_print(LIBCAPS_PANIC, PACKAGE, __func__, __LINE__, "%s: Assertion '%s' failed\n", __FILE__, __STRING(expr)); \
        caps_terminate(1); \
}
#endif
char *caps_helper_config_path_create(const char *file_name) __warn_unused_res __returns_nonnull;
int caps_helper_config_dir_fd(void) __warn_unused_res;
char *caps_helper_driver_db_path_create(const char *file_name) __warn_unused_res __returns_nonnull;
int caps_helper_driver_db_dir_fd(void) __warn_unused_res;
char *caps_helper_driver_config_path_create(const char *file_name) __warn_unused_res __returns_nonnull;
int caps_helper_driver_config_dir_fd(void) __warn_unused_res;
char *caps_helper_driver_path_create(const char *file_name) __warn_unused_res __returns_nonnull;
int caps_helper_driver_dir_fd(void) __warn_unused_res;
char *caps_helper_device_db_path_create(const char *file_name) __warn_unused_res __returns_nonnull;
int caps_helper_device_db_dir_fd(void) __warn_unused_res;
int caps_helper_number_convert(const char *string) __nonnull();
int caps_helper_boolean_check(const char *value, int set);
int caps_helper_invisible_file_create(int *fd) __nonnull() __warn_unused_res;
int caps_helper_file_content_copy(int fd_to, int fd_from);
int caps_helper_verbosity_setup(const char *keyword, bool overwrite);
__END_DECLS