usr.sbin/lpr/common_source/ctlinfo.h

   1 /*
   2  * ------+---------+---------+---------+---------+---------+---------+---------*
   3  * Copyright (c) 2001  - 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: src/usr.sbin/lpr/common_source/ctlinfo.h,v 1.1.2.2 2002/07/14 23:47:09 gad Exp $
  33  * $DragonFly: src/usr.sbin/lpr/common_source/ctlinfo.h,v 1.2 2003/06/17 04:29:56 dillon Exp $
  34  * ------+---------+---------+---------+---------+---------+---------+---------*
  35  */
  36
  37 /*
  38  * ctlinfo - This collection of routines will know everything there is to
  39  * know about the information inside a control file ('cf*') which is used
  40  * to describe a print job in lpr & friends.  The eventual goal is that it
  41  * will be the ONLY source file to know what's inside these control-files.
  42  */
  43
  44 struct cjprivate;                       /* used internal to ctl* routines */
  45
  46 struct cjobinfo {
  47         int      cji_dfcount;           /* number of data files to print */
  48         int      cji_uncount;           /* number of unlink-file requests */
  49         char    *cji_accthost;          /* the host that this job came from,
  50                                          * for accounting purposes (usually
  51                                          * the host where the original 'lpr'
  52                                          * was done) */
  53         char    *cji_acctuser;          /* userid who should be charged for
  54                                          * this job (usually, the userid which
  55                                          * did the original 'lpr') */
  56         char    *cji_class;             /* class-name */
  57         char    *cji_curqueue;          /* printer-queue that this cf-file is
  58                                          * curently sitting in (mainly used
  59                                          * in syslog error messages) */
  60         char    *cji_fname;             /* filename of the control file */
  61         char    *cji_jobname;           /* job-name (for banner) */
  62         char    *cji_mailto;            /* userid to send email to (or null) */
  63         char    *cji_username;          /* "literal" user-name (for banner) or
  64                                          * NULL if no banner-page is wanted */
  65         struct cjprivate *cji_priv;
  66 };
  67
  68 #include <sys/cdefs.h>
  69
  70 __BEGIN_DECLS
  71 void             ctl_freeinf(struct cjobinfo *_cjinf);
  72 struct cjobinfo *ctl_readcf(const char *_ptrname, const char *_cfname);
  73 char            *ctl_renametf(const char *_ptrname, const char *_tfname);
  74 __END_DECLS