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