libcapsdriver.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * (c) 2022 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 General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */
 
#include <stdio.h>
#include <features.h>
 
#include <libcapsbase.h>
#include <libcapscmdparser.h>
#include <libcapsppd.h>
 
__BEGIN_DECLS
 
/* Opaque handle type */
struct caps_drv;
enum caps_drv_prn_tweaks {
    CAPS_TWEAK_SKIP_STATUS = 1, 
    CAPS_TWEAK_SKIP_STATUS_WHEN_PRINTING = 2, 
};
 
#define LIBCAPSDRIVER_MAJOR 1
#define LIBCAPSDRIVER_MINOR 3
#define LIBCAPSDRIVER_MICRO 0
void caps_libdriver_version_get(unsigned *major, unsigned *minor, unsigned *micro) __nonnull();
struct caps_generic_driver {
    int (*init)(struct caps_drv*, void*); 
    int (*printer_adaptions)(struct caps_drv*, void*); 
    int (*job_start)(struct caps_drv*, void*); 
    int (*job_finish)(struct caps_drv*, void*); 
    int (*page_setup)(struct caps_drv*, void*); 
    int (*page_print)(struct caps_drv*, void*); 
    int (*printer_monitor)(struct caps_drv*, void*); 
    int (*exit)(struct caps_drv*, void*); 
};
 
struct caps_drv *caps_drv_init(struct caps_arg_parser parser[2]) __nonnull() __returns_nonnull;
void caps_drv_exit(struct caps_drv *cdrv) __nonnull();
int caps_drv_run(struct caps_drv *cdrv, const struct caps_generic_driver *cb, void *private) __nonnull((1,2));
int caps_drv_terminate_now(struct caps_drv *cdrv) __nonnull();
FILE *caps_drv_to_stream(struct caps_drv *cdrv) __nonnull();
void caps_drv_private_set(struct caps_drv *cdrv, void *private) __nonnull((1));
void *caps_drv_private_get(struct caps_drv *cdrv) __nonnull();
const char *caps_drv_setup_value_get(struct caps_drv *cdrv, const char *section, const char *key) __nonnull((1,3));
int caps_drv_setup_boolean_get(struct caps_drv *cdrv, const char *section, const char *key) __nonnull((1,3));
void caps_drv_printer_desc_set(struct caps_drv *cdrv, const struct caps_ppd_base *desc) __nonnull();
int caps_drv_is_printing(struct caps_drv *cdrv) __nonnull();
int caps_drv_is_offline(struct caps_drv *cdrv) __nonnull();
int caps_drv_is_empty(struct caps_drv *cdrv) __nonnull();
int caps_drv_is_fault_state(struct caps_drv *cdrv) __nonnull();
struct caps_drv_page_limits {
    unsigned max_line_length; 
    unsigned max_width; 
    unsigned max_length; 
    enum caps_colour_format cf; 
};
struct caps_drv_page_limits caps_drv_job_limits_get(struct caps_drv *cdrv) __nonnull();
const char *caps_drv_job_value_get(struct caps_drv *cdrv, const char *designator, const char *name) __nonnull((1,2));
const char *caps_drv_job_choice_get(struct caps_drv *cdrv, const char *designator) __nonnull();
int caps_drv_job_is_duplex(struct caps_drv *cdrv) __nonnull();
const char *caps_drv_print_medium_format_name_get(struct caps_drv *cdrv) __nonnull();
struct caps_rect caps_drv_print_medium_size_get(struct caps_drv *cdrv) __nonnull();
struct caps_area caps_drv_print_medium_margins_get(struct caps_drv *cdrv) __nonnull();
enum caps_ppd_paper_leading_edges caps_drv_print_medium_orientation_get(struct caps_drv *cdrv) __nonnull();
struct caps_area caps_drv_print_medium_imageable_get(struct caps_drv *cdrv) __nonnull();
struct caps_ppd_resolution caps_drv_print_resolution_get(struct caps_drv *cdrv) __nonnull();
enum caps_colour_format caps_drv_print_colour_get(struct caps_drv *cdrv) __nonnull();
void caps_drv_job_canceled(struct caps_drv *cdrv, const char *message) __nonnull();
unsigned caps_drv_page_number_get(struct caps_drv *cdrv) __nonnull();
unsigned caps_drv_page_copies_get(struct caps_drv *cdrv) __nonnull();
int caps_drv_page_is_duplex_front(struct caps_drv *cdrv) __nonnull();
int caps_drv_page_is_duplex_reverse(struct caps_drv *cdrv) __nonnull();
int caps_drv_page_is_last_page(struct caps_drv *cdrv) __nonnull();
int caps_drv_print_medium_is_to_be_ejected(struct caps_drv *cdrv) __nonnull();
struct caps_rect caps_drv_doc_page_size_get(struct caps_drv *cdrv) __nonnull();
int caps_drv_predictive_size_get(struct caps_drv *cdrv, struct caps_rect size, struct caps_rect *psize) __nonnull();
int caps_drv_print_medium_default_setup(struct caps_drv *cdrv) __nonnull();
int caps_drv_print_medium_colour_format_set(struct caps_drv *cdrv, enum caps_colour_format cf) __nonnull();
int caps_drv_print_medium_size_set(struct caps_drv *cdrv, struct caps_rect page_size) __nonnull();
int caps_drv_print_medium_favoured_rotation_set(struct caps_drv *cdrv, int rot) __nonnull();
int caps_drv_print_medium_width_set(struct caps_drv *cdrv, double min, double max) __nonnull();
int caps_drv_print_medium_length_set(struct caps_drv *cdrv, double min, double max) __nonnull();
int caps_drv_print_medium_margins_set(struct caps_drv *cdrv, struct caps_area margins) __nonnull();
int caps_drv_print_medium_resolution_set(struct caps_drv *cdrv, double x_res, double y_res) __nonnull();
ssize_t caps_drv_raster_line_length_get(struct caps_drv *cdrv) __nonnull();
void *caps_drv_raster_line_copy_get(struct caps_drv *cdrv, void * __restrict line_buf, unsigned line_no) __nonnull((1));
unsigned caps_drv_raster_width_get(struct caps_drv *cdrv) __nonnull();
unsigned caps_drv_raster_length_get(struct caps_drv *cdrv) __nonnull();
enum caps_colour_format caps_drv_raster_cf_get(struct caps_drv *cdrv) __nonnull();
struct caps_drv_raw_raster {
    unsigned covering_width; 
    unsigned covering_length; 
    unsigned skipped_top_lines; 
    unsigned skipped_left_dots; 
    unsigned width; 
    unsigned length; 
    enum caps_colour_format cf; 
    size_t line_length; 
};
int caps_drv_raw_raster_info_get(struct caps_drv *cdrv, struct caps_drv_raw_raster *rr) __nonnull();
const void *caps_drv_raw_raster_line_get(struct caps_drv *cdrv, unsigned line_no) __nonnull() __returns_nonnull;
const char *caps_drv_medium_name_from_size_get(const struct caps_rect *size) __nonnull();
struct caps_rect caps_drv_medium_size_from_name_get(const char *paper_name) __nonnull();
struct caps_rasterizer;
struct caps_rasterizer *caps_drv_to_rstr(struct caps_drv *cdrv) __nonnull();
struct caps_rstr_page_desc;
const struct caps_rstr_page_desc *caps_drv_to_caps_rstr_page_desc(struct caps_drv *cdrv) __nonnull();
struct caps_rstr_page;
struct caps_rstr_page *caps_drv_to_caps_rstr_page(struct caps_drv *cdrv) __nonnull();
struct caps_rstr_raster;
const struct caps_rstr_raster *caps_drv_to_caps_rstr_raster(struct caps_drv *cdrv) __nonnull();
struct caps_worker_idx {
    int (*idx_process)(void *anonymous_data, unsigned index_no); 
    int (*idx_is_ready)(void *anonymous_data, unsigned index_no); 
    int (*idx_send)(void *anonymous_data, unsigned index_no); 
};
 
struct caps_worker_idx_context;
int caps_worker_idx_create(struct caps_worker_idx_context **wctx, const struct caps_worker_idx *ciw, void *anonymous_data, unsigned index_cnt, unsigned thread_cnt) __nonnull((1,2,3)) __warn_unused_res;
void caps_worker_idx_destroy(struct caps_worker_idx_context *wctx) __nonnull();
int caps_worker_idx_start(struct caps_worker_idx_context *wctx) __nonnull();
void caps_worker_idx_stop(struct caps_worker_idx_context *wctx) __nonnull();
__END_DECLS