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