printing-coordinator-local.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * (c) 2017 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 Lesser General Public License 2.1 as published by the Free
 * Software Foundation.
 *
 * This program 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 General Public License for more details.
 */
#include <stdlib.h>
#include <stdint.h>
#include <pthread.h>
#include <stdbool.h>
#include <unistd.h>
#include <time.h> /* Force the correct "time_t" size according to the man page */
#include <fcntl.h>
#include <errno.h>
#include <inttypes.h>
#include <libcapsbase.h>
#include <libcapsinif.h>
#include <libcapsppd.h>
 
#include "libcapsppcommon.h"
#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 DEBUG
# define caps_invalidate_pointer(pointer) (pointer = NULL)
#else
# define caps_invalidate_pointer(pointer)
#endif
 
#ifdef DEBUG
# define caps_print_debug(fmt, ...) caps_print_debug_template(fmt, ##__VA_ARGS__)
#else
# define caps_print_debug(fmt, ...)
#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)
 
struct object_state_prn {
    enum caps_printing_provider_state id; 
    enum caps_printing_provider_reason reason; 
    char *message; 
};
 
struct object_state_job {
    enum caps_printing_job_state id; 
    enum caps_printing_job_reason reason;  
    char *message; 
};
 
struct object_progression_job {
    unsigned flags; 
    unsigned copy; 
    unsigned cpage; 
    unsigned dmedia; 
    unsigned fmedia; 
};
 
#define CONFIG_TIMEOUT 30000
 
#include "list.h"
 
struct caps_printer;
 
struct caps_coordinator {
    pthread_mutex_t printer_list_lock; 
    LIST_HEAD(struct caps_printer, printer_list); 
};
 
/* The coordinator internal printing management function */
 
void caps_init_runtime_data(struct caps_coordinator *database) __nonnull();
void caps_exit_runtime_data(struct caps_coordinator *database) __nonnull();
 
/* 'printing provider' specific API */
caps_identifier pc_provider_unique_printer_id_create(struct caps_coordinator *database, unsigned property) __nonnull();
int pc_provider_printer_id_free(struct caps_coordinator *database, unsigned property, caps_identifier pr_id) __nonnull();
caps_identifier pc_provider_id_by_property_get(struct caps_coordinator *database, unsigned property) __nonnull();
void pc_provider_orphaned_printer_free(struct caps_coordinator *database, unsigned property) __nonnull();
int pc_provider_printer_state_set(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, const struct object_state_prn *state) __nonnull();
int pc_provider_printer_info_set(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, const char *name, const char *info, const char *loction, const char *vendor, const char *model, struct caps_supported_mime_list *list) __nonnull();
int pc_provider_ppd_set(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, int fh) __nonnull();
 
caps_identifier pc_provider_job_id_prepare(struct caps_coordinator *database, unsigned property, caps_identifier pr_id) __nonnull();
int pc_provider_job_get(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, caps_identifier job_id, int *fh, const char **parameter) __nonnull();
int pc_provider_job_state_set(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, caps_identifier job_id, const struct object_state_job *state) __nonnull();
int pc_provider_printing_progression_report(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, caps_identifier job_id, const struct object_progression_job *p) __nonnull();
caps_identifier pc_provider_job_drain(struct caps_coordinator *database, caps_identifier pr_id) __nonnull();
int pc_provider_job_finished(struct caps_coordinator *database, unsigned property, caps_identifier pr_id, caps_identifier job_id) __nonnull();
 
/* 'printing client' specific API */
int pc_client_job_cancel(struct caps_coordinator *database, caps_identifier *pr_id, caps_identifier job_id) __nonnull();
 
int pc_client_job_state_get(struct caps_coordinator *database, caps_identifier job_id, const struct object_state_job **state) __nonnull();
int pc_client_job_progression_get(struct caps_coordinator *database, caps_identifier job_id, const struct object_progression_job **p) __nonnull();
int pc_client_printer_state_get(struct caps_coordinator *database, caps_identifier pr_id, const struct object_state_prn **state) __nonnull();
 
/* internally used, not for external users */
struct caps_printer_info {
    const char *name;
    const char *info;
    const char *location;
    const char *vendor;
    const char *model;
    struct caps_supported_mime_list document_format_supported; /* TODO deep copy or not? */
};
 
void pc_client_printer_list_get(struct caps_coordinator *database, caps_identifier **list, unsigned *cnt) __nonnull();
int pc_client_printer_info_get(struct caps_coordinator *database, caps_identifier pr_id, struct caps_printer_info *info) __nonnull();
caps_identifier pc_client_job_commit(struct caps_coordinator *database, caps_identifier pr_id, int fh, const char *params) __nonnull((1));
int pc_client_printer_ppd_get(struct caps_coordinator *database, caps_identifier pr_id) __nonnull();
 
#define CAPS_RUNTIME_CONFIG_LEVEL "base"
 
void runtime_configuration_base_read_in(struct caps_inif_table *runtime_config) __nonnull();
void runtime_configuration_class_merge_in(struct caps_inif_table *runtime_config, enum caps_user_class clss) __nonnull();
void runtime_configuration_apply(struct caps_inif_table *runtime_config, enum caps_user_class clss, const char *package) __nonnull((1));
void runtime_configuration_apply_verbosity(const struct caps_inif_table *runtime_config) __nonnull();
static inline bool is_fd_valid(int fd)
{
    return fcntl(fd, F_GETFL) != -1 || errno != EBADF;
}