rcs.h revision 1.9 
1/*	$OpenBSD: rcs.h,v 1.9 2010/07/23 21:46:05 ray Exp $	*/
2/*
3 * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.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 *
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. The name of the author may not be used to endorse or promote products
13 *    derived from this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#ifndef RCS_H
28#define RCS_H
29
30#include <sys/queue.h>
31
32#include "buf.h"
33
34#define RCS_DIFF_MAXARG		32
35#define RCS_DIFF_DIV \
36	"==================================================================="
37
38#define RCSDIR			"RCS"
39#define RCS_FILE_EXT		",v"
40
41#define RCS_HEAD_BRANCH		"HEAD"
42#define RCS_HEAD_INIT		"1.1"
43#define RCS_HEAD_REV		((RCSNUM *)(-1))
44
45
46#define RCS_SYM_INVALCHAR	"$,.:;@"
47
48#define RCS_MAGIC_BRANCH	".0."
49#define RCS_STATE_EXP		"Exp"
50#define RCS_STATE_DEAD		"dead"
51
52/* lock types */
53#define RCS_LOCK_INVAL		(-1)
54#define RCS_LOCK_LOOSE		0
55#define RCS_LOCK_STRICT		1
56
57/*
58 * Keyword expansion table
59 */
60#define RCS_KW_AUTHOR		0x1000
61#define RCS_KW_DATE		0x2000
62#define RCS_KW_LOG		0x4000
63#define RCS_KW_NAME		0x8000
64#define RCS_KW_RCSFILE		0x0100
65#define RCS_KW_REVISION		0x0200
66#define RCS_KW_SOURCE		0x0400
67#define RCS_KW_STATE		0x0800
68#define RCS_KW_FULLPATH		0x0010
69
70#define RCS_KW_ID \
71	(RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \
72	| RCS_KW_AUTHOR | RCS_KW_STATE)
73
74#define RCS_KW_HEADER	(RCS_KW_ID | RCS_KW_FULLPATH)
75
76/* RCS keyword expansion modes (kflags) */
77#define RCS_KWEXP_NONE	0x00
78#define RCS_KWEXP_NAME	0x01	/* include keyword name */
79#define RCS_KWEXP_VAL	0x02	/* include keyword value */
80#define RCS_KWEXP_LKR	0x04	/* include name of locker */
81#define RCS_KWEXP_OLD	0x08	/* generate old keyword string */
82#define RCS_KWEXP_ERR	0x10	/* mode has an error */
83
84#define RCS_KWEXP_DEFAULT	(RCS_KWEXP_NAME | RCS_KWEXP_VAL)
85#define RCS_KWEXP_KVL		(RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
86
87#define RCS_KWEXP_INVAL(k) \
88	((k & RCS_KWEXP_ERR) || \
89	((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
90
91struct rcs_kw {
92	char	kw_str[16];
93	int	kw_type;
94};
95
96#define RCS_NKWORDS	(sizeof(rcs_expkw)/sizeof(rcs_expkw[0]))
97
98#define RCSNUM_MAXNUM	USHRT_MAX
99#define RCSNUM_MAXLEN	64
100
101#define RCSNUM_ISBRANCH(n)	((n)->rn_len % 2)
102#define RCSNUM_ISBRANCHREV(n)	(!((n)->rn_len % 2) && ((n)->rn_len >= 4))
103#define RCSNUM_NO_MAGIC		(1<<0)
104
105/* file flags */
106#define RCS_READ	  (1<<0)
107#define RCS_WRITE	  (1<<1)
108#define RCS_RDWR	  (RCS_READ|RCS_WRITE)
109#define RCS_CREATE	  (1<<2)  /* create the file */
110#define RCS_PARSE_FULLY   (1<<3)  /* fully parse it on open */
111
112/* internal flags */
113#define RCS_PARSED	  (1<<4)  /* file has been parsed */
114#define RCS_SYNCED	  (1<<5)  /* in-mem copy is sync with disk copy */
115#define RCS_SLOCK	  (1<<6)  /* strict lock */
116
117/* parser flags */
118#define PARSED_DELTAS     (1<<7)  /* all deltas are parsed */
119#define PARSED_DESC       (1<<8)  /* the description is parsed */
120#define PARSED_DELTATEXTS (1<<9)  /* all delta texts are parsed */
121
122/* delta flags */
123#define RCS_RD_DEAD	0x01	/* dead */
124#define RCS_RD_SELECT	0x02	/* select for operation */
125
126/* RCS error codes */
127#define RCS_ERR_NOERR	0
128#define RCS_ERR_NOENT	1
129#define RCS_ERR_DUPENT	2
130#define RCS_ERR_BADNUM	3
131#define RCS_ERR_BADSYM	4
132#define RCS_ERR_PARSE	5
133#define RCS_ERR_ERRNO	255
134
135/* used for rcs_checkout_rev */
136#define CHECKOUT_REV_CREATED	1
137#define CHECKOUT_REV_MERGED	2
138#define CHECKOUT_REV_REMOVED	3
139#define CHECKOUT_REV_UPDATED	4
140
141typedef struct rcs_num {
142	u_int		 rn_len;
143	u_int16_t	*rn_id;
144} RCSNUM;
145
146struct rcs_access {
147	char			*ra_name;
148	uid_t			 ra_uid;
149	TAILQ_ENTRY(rcs_access)	 ra_list;
150};
151
152struct rcs_sym {
153	char			*rs_name;
154	RCSNUM			*rs_num;
155	TAILQ_ENTRY(rcs_sym)	 rs_list;
156};
157
158struct rcs_lock {
159	char	*rl_name;
160	RCSNUM	*rl_num;
161
162	TAILQ_ENTRY(rcs_lock)	 rl_list;
163};
164
165struct rcs_branch {
166	RCSNUM			*rb_num;
167	TAILQ_ENTRY(rcs_branch)	 rb_list;
168};
169
170TAILQ_HEAD(rcs_dlist, rcs_delta);
171
172struct rcs_delta {
173	RCSNUM		*rd_num;
174	RCSNUM		*rd_next;
175	u_int		 rd_flags;
176	struct tm	 rd_date;
177	char		*rd_author;
178	char		*rd_state;
179	char		*rd_log;
180	char		*rd_locker;
181	u_char		*rd_text;
182	size_t		 rd_tlen;
183
184	TAILQ_HEAD(, rcs_branch)	rd_branches;
185	TAILQ_ENTRY(rcs_delta)		rd_list;
186};
187
188
189typedef struct rcs_file {
190	int	 rf_fd;
191	char	*rf_path;
192	mode_t	 rf_mode;
193	u_int	 rf_flags;
194
195	RCSNUM	*rf_head;
196	RCSNUM	*rf_branch;
197	char	*rf_comment;
198	char	*rf_expand;
199	char	*rf_desc;
200
201	u_int					rf_ndelta;
202	struct rcs_dlist			rf_delta;
203	TAILQ_HEAD(rcs_alist, rcs_access)	rf_access;
204	TAILQ_HEAD(rcs_slist, rcs_sym)		rf_symbols;
205	TAILQ_HEAD(rcs_llist, rcs_lock)		rf_locks;
206
207	void	*rf_pdata;
208} RCSFILE;
209
210extern int rcs_errno;
211
212RCSFILE			*rcs_open(const char *, int, int, ...);
213void			 rcs_close(RCSFILE *);
214const RCSNUM		*rcs_head_get(RCSFILE *);
215int			 rcs_head_set(RCSFILE *, RCSNUM *);
216const RCSNUM		*rcs_branch_get(RCSFILE *);
217int			 rcs_branch_set(RCSFILE *, const RCSNUM *);
218int			 rcs_access_add(RCSFILE *, const char *);
219int			 rcs_access_remove(RCSFILE *, const char *);
220int			 rcs_access_check(RCSFILE *, const char *);
221struct rcs_delta	*rcs_findrev(RCSFILE *, RCSNUM *);
222int			 rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
223int			 rcs_sym_remove(RCSFILE *, const char *);
224RCSNUM			*rcs_sym_getrev(RCSFILE *, const char *);
225int			 rcs_sym_check(const char *);
226int			 rcs_lock_getmode(RCSFILE *);
227int			 rcs_lock_setmode(RCSFILE *, int);
228int			 rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
229int			 rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
230BUF			*rcs_getrev(RCSFILE *, RCSNUM *);
231int			 rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *);
232const char		*rcs_desc_get(RCSFILE *);
233void			 rcs_desc_set(RCSFILE *, const char *);
234const char		*rcs_comment_lookup(const char *);
235const char		*rcs_comment_get(RCSFILE *);
236void			 rcs_comment_set(RCSFILE *, const char *);
237BUF			*rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
238void			 rcs_kwexp_set(RCSFILE *, int);
239int			 rcs_kwexp_get(RCSFILE *);
240int			 rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
241			     const char *);
242time_t			 rcs_rev_getdate(RCSFILE *, RCSNUM *);
243int			 rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
244int			 rcs_rev_remove(RCSFILE *, RCSNUM *);
245int			 rcs_state_set(RCSFILE *, RCSNUM *, const char *);
246const char		*rcs_state_get(RCSFILE *, RCSNUM *);
247int			 rcs_state_check(const char *);
248RCSNUM			*rcs_tag_resolve(RCSFILE *, const char *);
249const char		*rcs_errstr(int);
250void			 rcs_write(RCSFILE *);
251void			 rcs_delta_stats(struct rcs_delta *, int *, int *);
252
253int	rcs_kflag_get(const char *);
254void	rcs_kflag_usage(void);
255int	rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
256
257RCSNUM	*rcsnum_alloc(void);
258RCSNUM	*rcsnum_parse(const char *);
259RCSNUM	*rcsnum_brtorev(const RCSNUM *);
260RCSNUM	*rcsnum_revtobr(const RCSNUM *);
261RCSNUM	*rcsnum_inc(RCSNUM *);
262RCSNUM	*rcsnum_dec(RCSNUM *);
263void	 rcsnum_free(RCSNUM *);
264int	 rcsnum_addmagic(RCSNUM *);
265int	 rcsnum_aton(const char *, char **, RCSNUM *);
266char	*rcsnum_tostr(const RCSNUM *, char *, size_t);
267void	 rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
268int	 rcsnum_cmp(const RCSNUM *, const RCSNUM *, u_int);
269
270/* rcstime.c */
271void	 rcs_set_tz(char *, struct rcs_delta *, struct tm *);
272extern char *timezone_flag;
273extern int rcsnum_flags;
274
275#endif	/* RCS_H */
276