ctlinfo.h revision 330449 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * ------+---------+---------+---------+---------+---------+---------+---------*
5 * Copyright (c) 2001,2011  - Garance Alistair Drosehn <gad@FreeBSD.org>.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *   1. Redistributions of source code must retain the above copyright
12 *      notice, this list of conditions and the following disclaimer.
13 *   2. Redistributions in binary form must reproduce the above copyright
14 *      notice, this list of conditions and the following disclaimer in the
15 *      documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * The views and conclusions contained in the software and documentation
30 * are those of the authors and should not be interpreted as representing
31 * official policies, either expressed or implied, of the FreeBSD Project.
32 *
33 * ------+---------+---------+---------+---------+---------+---------+---------*
34 * $FreeBSD: stable/11/usr.sbin/lpr/common_source/ctlinfo.h 330449 2018-03-05 07:26:05Z eadler $
35 * ------+---------+---------+---------+---------+---------+---------+---------*
36 */
37
38/*
39 * ctlinfo - This collection of routines will know everything there is to
40 * know about the information inside a control file ('cf*') which is used
41 * to describe a print job in lpr & friends.  The eventual goal is that it
42 * will be the ONLY source file to know what's inside these control-files.
43 */
44
45struct cjprivate;			/* used internal to ctl* routines */
46
47struct cjobinfo {
48	int	 cji_dfcount;		/* number of data files to print */
49	int	 cji_uncount;		/* number of unlink-file requests */
50	char	*cji_accthost;		/* the host that this job came from,
51					 * for accounting purposes (usually
52					 * the host where the original 'lpr'
53					 * was done) */
54	char	*cji_acctuser;		/* userid who should be charged for
55					 * this job (usually, the userid which
56					 * did the original 'lpr') */
57	char	*cji_class;		/* class-name */
58	char	*cji_curqueue;		/* printer-queue that this cf-file is
59					 * curently sitting in (mainly used
60					 * in syslog error messages) */
61	char	*cji_fname;		/* filename of the control file */
62	char	*cji_jobname;		/* job-name (for banner) */
63	char	*cji_mailto;		/* userid to send email to (or null) */
64	char	*cji_headruser;		/* "literal" user-name (for banner) or
65					 * NULL if no banner-page is wanted */
66	struct cjprivate *cji_priv;
67};
68
69#include "lp.cdefs.h"		/* A cross-platform version of <sys/cdefs.h> */
70
71__BEGIN_DECLS
72void		 ctl_freeinf(struct cjobinfo *_cjinf);
73struct cjobinfo	*ctl_readcf(const char *_ptrname, const char *_cfname);
74char		*ctl_renametf(const char *_ptrname, const char *_tfname);
75__END_DECLS
76