summaryrefslogtreecommitdiff
path: root/usr.bin/cvs/rcs.h
blob: 5b38cedd6ab8466084076cac944a6e8dc3cdd96c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*	$OpenBSD: rcs.h,v 1.19 2005/04/07 22:08:57 jfb Exp $	*/
/*
 * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef RCS_H
#define RCS_H

#include <sys/types.h>
#include <sys/queue.h>

#include <time.h>

#include "buf.h"

#define RCS_DIFF_MAXARG   32
#define RCS_DIFF_DIV \
	"==================================================================="

#define RCSDIR         "RCS"
#define RCS_FILE_EXT   ",v"

#define RCS_HEAD_BRANCH  "HEAD"
#define RCS_HEAD_INIT    "1.1"
#define RCS_HEAD_REV     ((RCSNUM *)(-1))


#define RCS_STATE_EXP    "Exp"
#define RCS_STATE_DEAD   "dead"

/* lock types */
#define RCS_LOCK_LOOSE    0
#define RCS_LOCK_STRICT   1


/* RCS keyword expansion modes (kflags) */
#define RCS_KWEXP_NONE     0x00
#define RCS_KWEXP_NAME     0x01		/* include keyword name */
#define RCS_KWEXP_VAL      0x02		/* include keyword value */
#define RCS_KWEXP_LKR      0x04		/* include name of locker */
#define RCS_KWEXP_OLD      0x08		/* generate old keyword string */
#define RCS_KWEXP_ERR      0x10		/* mode has an error */

#define RCS_KWEXP_DEFAULT  (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
#define RCS_KWEXP_KVL      (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)

#define RCS_KWEXP_INVAL(k) \
	((k & RCS_KWEXP_ERR) || \
	((k & RCS_KWEXP_OLD) && (RCS_KWEXP_OLD & ~RCS_KWEXP_OLD)))



#define RCSNUM_MAXNUM  USHRT_MAX
#define RCSNUM_MAXLEN  64

#define RCSNUM_ISBRANCH(n)    (((n)->rn_len % 2) == 0)


/* file flags */
#define RCS_READ    0x01
#define RCS_WRITE   0x02
#define RCS_RDWR    (RCS_READ|RCS_WRITE)
#define RCS_CREATE  0x04			/* create the file */

/* internal flags */
#define RCS_PARSED  0x010000   /* file has been parsed */
#define RCS_SYNCED  0x020000   /* in-memory copy is in sync with disk copy */
#define RCS_SLOCK   0x040000   /* strict lock */

/* delta flags */
#define RCS_RD_DEAD   0x01     /* dead */

/* RCS error codes */
#define RCS_ERR_NOERR    0
#define RCS_ERR_NOENT    1
#define RCS_ERR_DUPENT   2
#define RCS_ERR_BADNUM   3


typedef struct rcs_num {
	u_int      rn_len;
	u_int16_t *rn_id;
} RCSNUM;


struct rcs_access {
	char    *ra_name;
	uid_t    ra_uid;
	TAILQ_ENTRY(rcs_access) ra_list;
};

struct rcs_sym {
	char    *rs_name;
	RCSNUM  *rs_num;
	TAILQ_ENTRY(rcs_sym) rs_list;
};

struct rcs_lock {
	char     *rl_name;
	RCSNUM   *rl_num;

	TAILQ_ENTRY(rcs_lock) rl_list;
};


struct rcs_branch {
	RCSNUM  *rb_num;
	TAILQ_ENTRY(rcs_branch) rb_list;
};

struct rcs_dlist {
	struct rcs_delta *tqh_first;
	struct rcs_delta **tqh_last;
};

struct rcs_delta {
	RCSNUM    *rd_num;
	RCSNUM    *rd_next;
	u_int      rd_flags;
	struct tm  rd_date;
	char      *rd_author;
	char      *rd_state;
	char      *rd_log;
	char      *rd_text;
	size_t     rd_tlen;

	struct rcs_dlist         rd_snodes;
	TAILQ_HEAD(, rcs_branch) rd_branches;
	TAILQ_ENTRY(rcs_delta)   rd_list;
};


typedef struct rcs_file {
	char   *rf_path;
	u_int   rf_ref;
	mode_t  rf_mode;
	u_int   rf_flags;

	RCSNUM *rf_head;
	RCSNUM *rf_branch;
	char   *rf_comment;
	char   *rf_expand;
	char   *rf_desc;

	u_int   rf_ndelta;
	struct rcs_dlist                  rf_delta;
	TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
	TAILQ_HEAD(rcs_slist, rcs_sym)    rf_symbols;
	TAILQ_HEAD(rcs_llist, rcs_lock)   rf_locks;

	void   *rf_pdata;
} RCSFILE;


extern int rcs_errno;


RCSFILE*      rcs_open          (const char *, int, ...);
void          rcs_close         (RCSFILE *);
const RCSNUM* rcs_head_get      (RCSFILE *);
int           rcs_head_set      (RCSFILE *, const RCSNUM *);
const RCSNUM* rcs_branch_get    (RCSFILE *);
int           rcs_branch_set    (RCSFILE *, const RCSNUM *);
int           rcs_access_add    (RCSFILE *, const char *);
int           rcs_access_remove (RCSFILE *, const char *);
int           rcs_access_check  (RCSFILE *, const char *);
int           rcs_sym_add       (RCSFILE *, const char *, RCSNUM *);
int           rcs_sym_remove    (RCSFILE *, const char *);
RCSNUM*       rcs_sym_getrev    (RCSFILE *, const char *);
int           rcs_lock_getmode  (RCSFILE *);
int           rcs_lock_setmode  (RCSFILE *, int);
int           rcs_lock_add      (RCSFILE *, const char *, RCSNUM *);
int           rcs_lock_remove   (RCSFILE *, const RCSNUM *);
BUF*          rcs_getrev        (RCSFILE *, RCSNUM *);
BUF*          rcs_gethead       (RCSFILE *);
RCSNUM*       rcs_getrevbydate  (RCSFILE *, struct tm *);
const char*   rcs_desc_get      (RCSFILE *);
int           rcs_desc_set      (RCSFILE *, const char *);
const char*   rcs_comment_get   (RCSFILE *);
int           rcs_comment_set   (RCSFILE *, const char *);
int           rcs_kwexp_set     (RCSFILE *, int);
int           rcs_kwexp_get     (RCSFILE *);
RCSNUM*       rcs_tag_resolve   (RCSFILE *, const char *);
const char*   rcs_errstr        (int);

int       rcs_kflag_get    (const char *);
void      rcs_kflag_usage  (void);
int       rcs_kw_expand    (RCSFILE *, u_char *, size_t, size_t *);

BUF*      rcs_patch     (const char *, const char *);

RCSNUM*   rcsnum_alloc  (void);
RCSNUM*   rcsnum_parse  (const char *);
void      rcsnum_free   (RCSNUM *);
int       rcsnum_aton   (const char *, char **, RCSNUM *);
char*     rcsnum_tostr  (const RCSNUM *, char *, size_t);
int       rcsnum_cpy    (const RCSNUM *, RCSNUM *, u_int);
int       rcsnum_cmp    (const RCSNUM *, const RCSNUM *, u_int);

/* from cache.c */
int       rcs_cache_init    (u_int);
RCSFILE  *rcs_cache_fetch   (const char *path);
int       rcs_cache_store   (RCSFILE *);
void      rcs_cache_destroy (void);

#endif /* RCS_H */