CAPS Universe documentation  1.0.4
All you need to know to be successful
Data Structures | Macros | Typedefs | Enumerations | Functions
libcapsbase.h File Reference

Basic API for everything else of the CAPS universe. More...

Go to the source code of this file.

Data Structures

struct  caps_rect
 Defines a simple rectangle by its width and length in floating point values. More...
 
struct  caps_area
 Defines an area by its left bottom and right top coordinates in floating point values. More...
 
struct  caps_dot_monochrome
 1 bit per component, 8 dots per byte, MSbit is on the left (bit 7). More...
 
struct  caps_dot_grey
 One byte per component, one component per dot. More...
 
struct  caps_dot_rgb
 One byte per component, three components per dot: RGBRGB... More...
 
struct  caps_dot_cmyk
 One byte per component, four components per dot: CMYKCMYK... More...
 

Macros

#define __non_null
 
#define __nonnull(params)
 
#define __format(x, y)
 
#define __format_arg(x)
 
#define __packed
 
#define __maybe_unused
 
#define __deprecated
 
#define __no_return
 
#define __pure
 
#define __const
 
#define __cleanup(x)
 
#define __returns_nonnull
 
#define __warn_unused_res
 
#define __fallthrough
 
#define __cold
 
#define __hot
 
#define __nonstring
 
#define LIBCAPSBASE_MAJOR   1
 
#define LIBCAPSBASE_MINOR   1
 
#define LIBCAPSBASE_MICRO   1
 
#define caps_print_panic(fmt, ...)
 
#define caps_print_error(fmt, ...)
 
#define caps_print_warn(fmt, ...)
 
#define caps_print_info(fmt, ...)
 
#define caps_print_loud(fmt, ...)
 
#define caps_print_noisy(fmt, ...)
 
#define caps_print_debug_template(fmt, ...)
 
#define CAPS_INVALID_IDENTIFIER   (INT64_C(-1))
 
#define CAPS_REC_IS_EMPTY(x)   ((x.width == 0.0) && (x.length == 0.0))
 
#define caps_developers_failure_report(fmt)
 
#define caps_memory_failure_report(fn)
 
#define caps_assert(expr)
 Assert the given expression is true, else terminate the program.
 

Typedefs

typedef int64_t caps_identifier
 

Enumerations

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
}
 Dot colour format definition. More...
 
enum  caps_verbosity {
  LIBCAPS_PANIC = 1 ,
  LIBCAPS_ERROR ,
  LIBCAPS_WARN ,
  LIBCAPS_INFO ,
  LIBCAPS_LOUD ,
  LIBCAPS_NOISY ,
  LIBCAPS_DEBUG
}
 Define the noise level of messages. All messages above a current noise level will be discarded. More...
 

Functions

void caps_libbase_version_get (unsigned *major, unsigned *minor, unsigned *micro)
 
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,...) 6)
 
void caps_developers_failure_report_and_terminate (const char *scope, const char *fn, int ln, const char *message)
 
void caps_memory_failure_report_and_terminate (const char *scope, const char *fn, int ln)
 
void caps_terminate (int rc)
 
char * caps_helper_config_path_create (const char *file_name)
 
int caps_helper_config_dir_fd (void)
 
char * caps_helper_driver_db_path_create (const char *file_name)
 
int caps_helper_driver_db_dir_fd (void)
 
char * caps_helper_driver_config_path_create (const char *file_name)
 
int caps_helper_driver_config_dir_fd (void)
 
char * caps_helper_driver_path_create (const char *file_name)
 
int caps_helper_driver_dir_fd (void)
 
char * caps_helper_device_db_path_create (const char *file_name)
 
int caps_helper_device_db_dir_fd (void)
 
int caps_helper_number_convert (const char *string)
 
int caps_helper_boolean_check (const char *value, int set)
 
int caps_helper_invisible_file_create (int *fd)
 
int caps_helper_file_content_copy (int fd_to, int fd_from)
 
int caps_helper_verbosity_setup (const char *keyword, bool overwrite)
 

Detailed Description

Author
Jürgen Borleis
Warning
Use as experimental