1 /* 2 * ------+---------+---------+---------+---------+---------+---------+---------* 3 * Copyright (c) 2002 - 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 * or FreeBSD, Inc. 31 * 32 * ------+---------+---------+---------+---------+---------+---------+---------* 33 * $FreeBSD: src/usr.sbin/lpr/common_source/matchjobs.h,v 1.1.2.1 2002/07/26 03:12:06 gad Exp $ 34 * ------+---------+---------+---------+---------+---------+---------+---------* 35 */ 36 37 #include <sys/queue.h> 38 39 /* 40 * The "matcheduser" field is *only* valid during the call to the 41 * given "doentry()" routine, and is only set if the specification 42 * included a userid. 43 */ 44 struct jobspec { 45 STAILQ_ENTRY(jobspec) nextjs; 46 char *wantedhost; 47 char *wanteduser; 48 char *matcheduser; /* only valid for "doentry()" */ 49 char *fmtoutput; /* set by format_jobspec() */ 50 long startnum; 51 long endrange; 52 int pluralfmt; /* boolean set by format_jobspec() */ 53 uint matchcnt; 54 }; 55 STAILQ_HEAD(jobspec_hdr, jobspec); 56 57 /* 58 * Format options for format_jobspec. 59 */ 60 #define FMTJS_TERSE 1 /* user:jobrange@host */ 61 #define FMTJS_VERBOSE 2 /* jobrange from user@host */ 62 63 /* 64 * Options for scanq_jobspec. 65 * 66 * The caller must choose the order that entries should be scanned: 67 * 1) JSORDER: Matched jobs are processed (by calling the "doentry()" 68 * routine) in the order that the user specified those jobs. 69 * 2) QORDER: Matched jobs are processed in the order that the jobs are 70 * listed the queue. This guarantees that the "doentry()" routine 71 * will be called only once per job. 72 * 73 * There is a "job_matched" variable in struct jobqueue, which is used 74 * to make sure that the "doentry()" will only be called once for any 75 * given job in JSORDER processing. The "doentry()" routine can turn 76 * that off, if it does want to be called multiple times when the job 77 * is matched by multiple specifiers. 78 * 79 * The JSORDER processing will also call the "doentry()" routine once 80 * after each scan of the queue, with the jobqueue set to null. This 81 * provides a way for the caller to print out a summary message for 82 * each jobspec that was given. 83 */ 84 #define SCQ_JSORDER 0x0001 /* follow the user-specified order */ 85 #define SCQ_QORDER 0x0002 /* the order of jobs in the queue */ 86 87 #include <sys/cdefs.h> 88 __BEGIN_DECLS 89 struct jobqueue; 90 91 typedef int process_jqe(void *_myinfo, struct jobqueue *_jq, 92 struct jobspec *_jspec); 93 94 void format_jobspec(struct jobspec *_jspec, int _fmt_wanted); 95 void free_jobspec(struct jobspec_hdr *_js_hdr); 96 int scanq_jobspec(int _qitems, struct jobqueue **_squeue, int _sopts, 97 struct jobspec_hdr *_js_hdr, process_jqe _doentry, 98 void *_doentryinfo); 99 int parse_jobspec(char *_jobstr, struct jobspec_hdr *_js_hdr); 100 __END_DECLS 101 102