libcapsdriver-local.h

Go to the documentation of this file.

/*
 * 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 <unistd.h>
#include <fcntl.h>
#include <errno.h>
 
#include <libcapsbase.h>
#include <libcapsraster-api.h>
 
#include "libcapsdriver.h"
 
#ifdef DEBUG
# define caps_print_debug(fmt, ...) caps_print_debug_template(fmt, ##__VA_ARGS__)
#else
# define caps_print_debug(fmt, ...)
#endif
 
#ifdef DSO_HIDDEN
# define DSO_VISIBLE __attribute__ ((visibility("default")))
#else
# define DSO_VISIBLE
#endif /* DSO_HIDDEN */
 
#ifndef ARRAY_SIZE
# define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
#endif
 
#ifdef ENABLE_NLS
 
# ifndef PACKAGE
#  error "Missing 'PACKAGE' macro: include 'config.h' first"
# endif /* PACKAGE */
 
# define _(string) dgettext(PACKAGE, string)
# include <libintl.h>
 
#else /* ENABLE_NLS */
 
# define _(string) (string)
 
#endif /* ENABLE_NLS */
 
#define NLS_(string) (string)
 
#define MAX(a,b) ((a) > (b) ? a : b)
 
static __const inline unsigned DOTS_TO_BYTES(unsigned dots)
{
    return (dots + 7) / 8;
}
 
static __const inline size_t DOTS_TO_INDEX(size_t dots)
{
    return dots / 8;
}
 
enum halftone_type {
    HT_METHOD_NONE,
    HT_METHOD_AV, 
    HT_METHOD_ORDERED, 
    HT_METHOD_FLS, 
    HT_METHOD_JJN, 
    HT_METHOD_ST, 
    HT_METHOG_AT, 
    HT_METHOD_BU, 
    HT_METHOD_SI1, 
    HT_METHOD_SI2, 
    HT_METHOD_SI3, 
};
 
struct caps_drv {
    struct caps_pp_handle *pc; 
    const struct caps_generic_driver *cb; 
    void *cb_data; 
    FILE *prn_stream; 
    int prn_desc; 
    unsigned prn_status; 
    enum caps_drv_prn_tweaks prn_tweaks; 
    struct caps_ppd_base printer_desc; 
    unsigned busy_due_to_printing; 
    struct caps_rasterizer *rstr; 
    const struct caps_rstr_page_desc *page; 
    struct caps_rstr_page page_setup; 
    struct caps_rstr_raster raster_desc;
 
    /* the following data is valid only while processing a job */
    struct caps_pp_document_desc *job_data;
    unsigned job_status_set:1; 
    /* colour format emulation support */
    enum halftone_type ht_method; 
    enum caps_colour_format emulate; 
    struct caps_dot_monochrome *mono_buf; 
    unsigned line_stride; 
};
 
/* Just to hide the implementation */
static inline bool job_final_state_already_set(const struct caps_drv *cdrv)
{
    return cdrv->job_status_set;
}
 
int caps_drv_jobs_loop(struct caps_drv *drvi, const char *filename, const char *params) __nonnull((1));
int caps_drv_page_loop(struct caps_drv *drvi) __nonnull();
int caps_drv_printer_check(struct caps_drv *drvi) __nonnull(); // internal only
int caps_drv_global_stream_io(struct caps_drv *drvi) __nonnull(); // internal only
void caps_drv_printer_tweak_status(struct caps_drv *drvi) __nonnull(); // internal only
 
void caps_drv_shutdown(struct caps_pp_handle *instance) __nonnull();
void caps_drv_start_up_state(struct caps_pp_handle *instance) __nonnull();
void caps_drv_idle(struct caps_pp_handle *instance) __nonnull();
void caps_drv_power_saving(struct caps_pp_handle *instance) __nonnull();
void caps_drv_printing(struct caps_pp_handle *instance) __nonnull();
void caps_drv_out_of_paper(struct caps_pp_handle *instance) __nonnull();
void caps_drv_error(struct caps_pp_handle *instance) __nonnull();
 
void caps_drv_job_start(struct caps_drv *cdrv) __nonnull();
void caps_drv_job_completed(struct caps_drv *cdrv) __nonnull();
void caps_drv_job_stopped(struct caps_drv *cdrv) __nonnull();
void caps_drv_job_aborted(struct caps_drv *cdrv, enum caps_printing_job_reason reason, const char *message) __nonnull((1));
 
void caps_drv_emulation_stop(struct caps_drv *cdrv) __nonnull();
int caps_drv_print_medium_default_post_setup(struct caps_drv *cdrv) __nonnull();
int caps_drv_emulation_setup(struct caps_drv *cdrv) __nonnull();
 
/* internal dithering support */
 
struct drv_halftone_converter;
 
struct drv_halftone_converter *ht_get(enum halftone_type t, unsigned cnt) __returns_nonnull;
void ht_put(struct drv_halftone_converter *ht) __nonnull();
int ht_grey_line_add(struct drv_halftone_converter *ht, unsigned cnt, const struct caps_dot_grey raw[cnt]) __nonnull((1));
int ht_emptyline_add(struct drv_halftone_converter *ht) __nonnull();
int ht_drain(struct drv_halftone_converter *ht) __nonnull();
unsigned ht_monochrome_line_get(struct drv_halftone_converter *ht, enum caps_colour_format cf, unsigned cnt, struct caps_dot_monochrome ln[cnt]) __nonnull();
static inline int fd_is_valid(int fd)
{
    errno = 0;
    return fcntl(fd, F_GETFD) != -1 || errno != EBADF;
}