xref: /freebsd/usr.sbin/newsyslog/extern.h (revision aca5021d5f7dcab1e11692923266373e35322d9a)
1 /*-
2  * ------+---------+---------+---------+---------+---------+---------+---------*
3  * Copyright (c) 2003  - 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 #include <sys/cdefs.h>
37 #include <time.h>
38 
39 #define	PTM_PARSE_ISO8601	0x0001	/* Parse ISO-standard format */
40 #define	PTM_PARSE_DWM		0x0002	/* Parse Day-Week-Month format */
41 #define	PTM_PARSE_MATCHDOM	0x0004	/* If the user specifies a day-of-month,
42 					 * then the result should be a month
43 					 * which actually has that day.  Eg:
44 					 * the user requests "day 31" when
45 					 * the present month is February. */
46 
47 struct ptime_data;
48 
49 /* Some global variables from newsyslog.c which might be of interest */
50 extern int	 dbg_at_times;		/* cmdline debugging option */
51 extern int	 noaction;		/* command-line option */
52 extern int	 verbose;		/* command-line option */
53 extern struct ptime_data *dbg_timenow;
54 
55 __BEGIN_DECLS
56 struct ptime_data *ptime_init(const struct ptime_data *_optsrc);
57 int		 ptime_adjust4dst(struct ptime_data *_ptime, const struct
58 		    ptime_data *_dstsrc);
59 int		 ptime_free(struct ptime_data *_ptime);
60 int		 ptime_relparse(struct ptime_data *_ptime, int _parseopts,
61 		    time_t _basetime, const char *_str);
62 const char	*ptimeget_ctime(const struct ptime_data *_ptime);
63 double		 ptimeget_diff(const struct ptime_data *_minuend,
64 		    const struct ptime_data *_subtrahend);
65 time_t		 ptimeget_secs(const struct ptime_data *_ptime);
66 int		 ptimeset_nxtime(struct ptime_data *_ptime);
67 int		 ptimeset_time(struct ptime_data *_ptime, time_t _secs);
68 __END_DECLS
69