libcapsprovider-local.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * (c) 2018 Jürgen 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 2.1 as published by the Free
 * Software Foundation.
 *
 * 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 <stdbool.h>
 
#include <libcapsbase.h>
#include <libcapsinif.h>
#include <libcapsppd-api.h>
 
#include "libcapsprovider.h"
#include "list.h"
 
#define CAPS_DRIVER_INI_NAME "driver-ini"
#define CAPS_DRIVER_INI_NAME_SHORT 'f'
#define CAPS_PARAM_DIRECTORY_NAME "parameter-dir"
#define CAPS_PARAM_DIRECTORY_NAME_SHORT 'd'
struct caps_pp_notifier {
    int (*job_change)(void *data, caps_identifier pr_id, caps_identifier job_id); 
};
 
typedef struct DBusConnection DBusConnection;
 
struct coord_comm {
    DBusConnection* conn;
    const struct caps_pp_notifier *notifier;
    void *data; 
};
 
struct nls_domain {
    const char *domain;
    /* management members */
    LIST_FIELDS(struct nls_domain, list); 
};
 
struct caps_pp_handle {
    struct coord_comm coord_connection;
    caps_identifier pr_id; 
    /* persistent info for the run */
    struct caps_inif_table runtime_config;
    struct caps_supported_mime_list supported_formats; 
    /* dynamic printer driver/provider information */
    const struct caps_ppd_base *printer_base_info; 
    struct caps_ppd_options_table *ppd_options; 
    LIST_HEAD(struct nls_domain, nls_domain_list); 
    int ppd_fd; 
    caps_identifier job_id_next; 
    const char *driver_ini; 
    const char *param_dir; 
};
struct caps_pp_document_desc {
    struct caps_pp_handle *instance; 
    caps_identifier id; 
    int fh; 
    char *parameters; 
};
int coord_connection_create(struct coord_comm *instance, const struct caps_pp_notifier *notifier, void *data) __nonnull((1));
void coord_connection_destroy(struct coord_comm *instance) __nonnull();
int coord_printer_id_create(struct coord_comm *instance, caps_identifier *pr_id) __nonnull() __warn_unused_res;
void coord_printer_id_free(struct coord_comm *instance, caps_identifier pr_id) __nonnull();
int coord_printer_info_setup(struct coord_comm *instance, caps_identifier pr_id, const char *name, const char *info, const char *location, const char *vendor, const char *model, struct caps_supported_mime_list *mime_list) __nonnull();
int coord_printer_ppd_setup(struct coord_comm *instance, caps_identifier pr_id, int fd) __nonnull();
int coord_printer_state_setup(struct coord_comm *instance, caps_identifier pr_id, enum caps_printing_provider_state state_id, enum caps_printing_provider_reason reason_id, const char *state_message) __nonnull();
int coord_job_id_get_next_available(struct coord_comm *instance, caps_identifier pr_id, caps_identifier *job_id) __nonnull() __warn_unused_res;
int coord_job_data_get(struct coord_comm *instance, caps_identifier pr_id, caps_identifier job_id, int *job_fh, char **job_params) __nonnull() __warn_unused_res;
int coord_job_mark_finished(struct coord_comm *instance, caps_identifier pr_id, caps_identifier job_id) __nonnull();
int coord_job_progress_report(struct coord_comm *instance, caps_identifier pr_id, caps_identifier job_id, const struct caps_job_progression *prog) __nonnull();
int coord_job_state_set(struct coord_comm *instance, caps_identifier pr_id, caps_identifier job_id, enum caps_printing_job_state state_id, enum caps_printing_job_reason state_reason_id, const char *state_message) __nonnull();
int coord_notifiers_process(struct coord_comm *instance) __nonnull();
 
static inline __nonnull() __pure bool caps_pp_check_printing_id(struct caps_pp_handle *instance, caps_identifier pr_id)
{
    if (pr_id < 1)
        caps_developers_failure_report("'pr_id' parameter invalid");
    if (instance->pr_id < 1) /* paranoia */
        caps_developers_failure_report("internal 'printing id' invalid");
    return instance->pr_id == pr_id;
}
 
const char *state_message_translate(struct caps_pp_handle *instance, const char *string) __returns_nonnull __nonnull();