libcapsclient.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * (c) 2017 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 <stdlib.h>
#include <stdbool.h>
#include <features.h>
#include <libcapsbase.h>
 
#include "libcapsppcommon.h"
 
__BEGIN_DECLS
 
#define LIBCAPSCLIENT_MAJOR 1
#define LIBCAPSCLIENT_MINOR 1
#define LIBCAPSCLIENT_MICRO 1
void caps_libclient_version_get(unsigned *major, unsigned *minor, unsigned *micro) __nonnull();
struct caps_cl_printer_state;
struct caps_cl_job_state;
struct caps_cl_notifier {
    int (*provider_change)(void *data, caps_identifier pr_id, struct caps_cl_printer_state *pstate);
    int (*job_change)(void *data, caps_identifier pr_id, caps_identifier job_id, struct caps_cl_job_state *jstate, struct caps_job_progression *jprogression);
};
struct caps_cl_handle;
struct caps_cl_handle *caps_cl_instance_create(void) __returns_nonnull;
int caps_cl_instance_register(struct caps_cl_handle *instance, const struct caps_cl_notifier *notifier, void *data) __nonnull((1));
void caps_cl_instance_unregister(struct caps_cl_handle *instance) __nonnull();
void caps_cl_instance_destroy(struct caps_cl_handle *instance) __nonnull();
struct caps_cl_printer_list {
    size_t cnt; 
    caps_identifier list[0]; 
};
int caps_cl_printer_list_get(struct caps_cl_handle *instance, struct caps_cl_printer_list **list) __nonnull() __warn_unused_res;
struct caps_cl_printer_info {
    char *name; 
    char *info; 
    char *location; 
    char *vendor; 
    char *model; 
    struct caps_supported_mime_list supported_formats; 
};
int caps_cl_printer_info_get(struct caps_cl_handle *instance, caps_identifier printer_id, struct caps_cl_printer_info **info) __nonnull() __warn_unused_res;
void caps_cl_printer_info_destroy(struct caps_cl_handle *instance, struct caps_cl_printer_info *info) __nonnull();
struct caps_cl_printer_state {
    enum caps_printing_provider_state state; 
    enum caps_printing_provider_reason reason; 
    char message[256]; 
};
int caps_cl_printer_state_get(struct caps_cl_handle *instance, caps_identifier printer_id, struct caps_cl_printer_state *state) __nonnull() __warn_unused_res;
int caps_cl_printer_PPD_get(struct caps_cl_handle *instance, caps_identifier printer_id, int *ppdfh) __nonnull() __warn_unused_res;
int caps_cl_printer_name_to_id(struct caps_cl_handle *instance, const char *name, caps_identifier *printer_id) __nonnull() __warn_unused_res;
#define CAPS_NOTIFIER_HANDLED 0
#define CAPS_NOTIFIER_NOT_YET_HANDLED 1
int caps_cl_notifiers_process(struct caps_cl_handle *instance) __nonnull();
int caps_cl_connection_fd_get(struct caps_cl_handle *instance) __nonnull();
int caps_cl_error_messages_catch(struct caps_cl_handle *instance, char **ptr, size_t *size) __nonnull();
void caps_cl_error_messages_reset(struct caps_cl_handle *instance) __nonnull();
int caps_cl_job_commit(struct caps_cl_handle *instance, caps_identifier printer_id, int job_fd, const char *parameter, caps_identifier *job_id) __nonnull((1, 5)) __warn_unused_res;
struct caps_cl_job_state {
    enum caps_printing_job_state id; 
    enum caps_printing_job_reason reason_id; 
    char message[256]; 
};
int caps_cl_job_state_get(struct caps_cl_handle *instance, caps_identifier job_id, struct caps_cl_job_state *state) __nonnull() __warn_unused_res;
bool caps_cl_job_check_if_done(struct caps_cl_handle *instance, const struct caps_cl_job_state *state) __nonnull() __warn_unused_res;
int caps_cl_job_progression_get(struct caps_cl_handle *instance, caps_identifier job_id, struct caps_job_progression *prog) __nonnull();
int caps_cl_job_cancel(struct caps_cl_handle *instance, caps_identifier job_id) __nonnull();
__END_DECLS