libcapsprovider.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 <signal.h>
#include <features.h>
 
#include <libcapsbase.h>
#include <libcapscmdparser.h>
#include <libcapstable.h>
#include <libcapsppd.h>
 
#include "libcapsppcommon.h"
 
__BEGIN_DECLS
 
struct argp;
 
#define LIBCAPSPROVIDER_MAJOR 1
#define LIBCAPSPROVIDER_MINOR 1
#define LIBCAPSPROVIDER_MICRO 1
void caps_libprovider_version_get(unsigned *major, unsigned *minor, unsigned *micro) __nonnull();
struct caps_pp_handle;
struct caps_pp_document_desc;
struct caps_pp_handle *caps_pp_instance_create(struct caps_arg_parser *parser) __nonnull() __returns_nonnull __warn_unused_res;
int caps_pp_instance_runtime_prepare(struct caps_pp_handle *instance) __nonnull() __warn_unused_res;
int caps_pp_instance_runtime_implant(struct caps_pp_handle *instance, const char *level, const char *section, const char *key, const char *value) __nonnull((1,2,3,4));
const char *caps_pp_instance_runtime_param_get(struct caps_pp_handle *instance, const char *section, const char *name) __nonnull((1,3));
void caps_pp_instance_mime_setup(struct caps_pp_handle *instance, const struct caps_supported_mime_list *mimes) __nonnull();
void caps_pp_instance_runtime_setup(struct caps_pp_handle *instance, const struct caps_ppd_base *cpb) __nonnull();
int caps_pp_instance_register(struct caps_pp_handle *instance) __nonnull();
void caps_pp_instance_unregister(struct caps_pp_handle *instance) __nonnull();
void caps_pp_instance_destroy(struct caps_pp_handle *instance) __nonnull();
struct caps_ppd_options_table *caps_pp_ppd_options_get(struct caps_pp_handle *instance) __nonnull() __returns_nonnull;
void caps_pp_instance_domain_add(struct caps_pp_handle *instance, const char *domain) __nonnull();
int caps_pp_state_update(struct caps_pp_handle *instance, enum caps_printing_provider_state state, enum caps_printing_provider_reason reason, const char *message) __nonnull((1));
int caps_pp_job_get(struct caps_pp_handle *instance, struct caps_pp_document_desc **job, volatile sig_atomic_t *terminate) __nonnull((1,2)) __warn_unused_res;
int caps_pp_job_check(struct caps_pp_handle *instance, struct caps_pp_document_desc **job) __nonnull() __warn_unused_res;
caps_identifier caps_pp_job_id_get(struct caps_pp_document_desc *job) __nonnull();
void caps_pp_job_done(struct caps_pp_document_desc *job) __nonnull();
int caps_pp_job_fh_get(struct caps_pp_document_desc *job) __nonnull();
const char *caps_pp_job_parameter_get(struct caps_pp_document_desc *job) __nonnull();
void caps_pp_job_progression_report(struct caps_pp_document_desc *job, const struct caps_job_progression *prog) __nonnull();
int caps_pp_job_state_update(struct caps_pp_document_desc *job, enum caps_printing_job_state state, enum caps_printing_job_reason reason, const char *message) __nonnull((1));
__END_DECLS