Annotation of src/usr.bin/cvs/rcs.h, Revision 1.13
1.13 ! jfb 1: /* $OpenBSD: rcs.h,v 1.12 2005/03/05 03:30:29 jfb Exp $ */
1.1 jfb 2: /*
3: * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.2 tedu 4: * All rights reserved.
1.1 jfb 5: *
1.2 tedu 6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
1.1 jfb 9: *
1.2 tedu 10: * 1. Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
1.1 jfb 12: * 2. The name of the author may not be used to endorse or promote products
1.2 tedu 13: * derived from this software without specific prior written permission.
1.1 jfb 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
1.2 tedu 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 jfb 25: */
26:
27: #ifndef RCS_H
28: #define RCS_H
29:
30: #include <sys/types.h>
31: #include <sys/queue.h>
32:
33: #include <time.h>
34:
35: #include "buf.h"
36:
37: #define RCS_DIFF_MAXARG 32
38: #define RCS_DIFF_DIV \
39: "==================================================================="
40:
41: #define RCS_FILE_EXT ",v"
42:
43: #define RCS_HEAD_INIT "1.1"
44:
1.12 jfb 45:
46: /* lock types */
47: #define RCS_LOCK_LOOSE 0
48: #define RCS_LOCK_STRICT 1
49:
50:
1.6 jfb 51: /* RCS keyword expansion modes (kflags) */
52: #define RCS_KWEXP_NONE 0x00
53: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
54: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
55: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
56: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
57: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
58:
59: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
60: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
61:
1.9 jfb 62: #define RCS_KWEXP_INVAL(k) \
1.13 ! jfb 63: ((k & RCS_KWEXP_ERR) || \
! 64: ((k & RCS_KWEXP_OLD) && (RCS_KWEXP_OLD & ~RCS_KWEXP_OLD)))
1.9 jfb 65:
1.6 jfb 66:
67:
68: #define RCSNUM_MAXNUM USHRT_MAX
69: #define RCSNUM_MAXLEN 64
70:
1.1 jfb 71:
72: /* file flags */
1.9 jfb 73: #define RCS_READ 0x01
74: #define RCS_WRITE 0x02
75: #define RCS_RDWR (RCS_READ|RCS_WRITE)
76: #define RCS_CREATE 0x04 /* create the file */
77:
78: /* internal flags */
79: #define RCS_PARSED 0x010000 /* file has been parsed */
80: #define RCS_SYNCED 0x020000 /* in-memory copy is in sync with disk copy */
81: #define RCS_SLOCK 0x040000 /* strict lock */
1.1 jfb 82:
83: /* delta flags */
84: #define RCS_RD_DEAD 0x01 /* dead */
1.5 jfb 85:
86:
1.1 jfb 87: typedef struct rcs_num {
88: u_int rn_len;
89: u_int16_t *rn_id;
90: } RCSNUM;
91:
92:
1.11 jfb 93: struct rcs_access {
94: char *ra_name;
95: uid_t ra_uid;
96: TAILQ_ENTRY(rcs_access) ra_list;
97: };
98:
1.1 jfb 99: struct rcs_sym {
100: char *rs_name;
101: RCSNUM *rs_num;
102: TAILQ_ENTRY(rcs_sym) rs_list;
103: };
104:
105: struct rcs_lock {
106: RCSNUM *rl_num;
107:
108: TAILQ_ENTRY(rcs_lock) rl_list;
109: };
110:
111:
112: struct rcs_branch {
113: RCSNUM *rb_num;
114: TAILQ_ENTRY(rcs_branch) rb_list;
115: };
116:
117: struct rcs_dlist {
118: struct rcs_delta *tqh_first;
119: struct rcs_delta **tqh_last;
120: };
121:
122: struct rcs_delta {
123: RCSNUM *rd_num;
124: RCSNUM *rd_next;
125: u_int rd_flags;
126: struct tm rd_date;
127: char *rd_author;
128: char *rd_state;
129: char *rd_log;
130: char *rd_text;
131:
132: struct rcs_dlist rd_snodes;
133:
134: TAILQ_HEAD(, rcs_branch) rd_branches;
135: TAILQ_ENTRY(rcs_delta) rd_list;
136: };
137:
138:
139: typedef struct rcs_file {
140: char *rf_path;
141: u_int rf_ref;
1.9 jfb 142: mode_t rf_mode;
1.1 jfb 143: u_int rf_flags;
144:
145: RCSNUM *rf_head;
146: RCSNUM *rf_branch;
147: char *rf_comment;
148: char *rf_expand;
149: char *rf_desc;
150:
1.9 jfb 151: u_int rf_ndelta;
1.11 jfb 152: struct rcs_dlist rf_delta;
153: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
154: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
155: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 156:
1.1 jfb 157:
158: void *rf_pdata;
159: } RCSFILE;
160:
161:
1.11 jfb 162: RCSFILE* rcs_open (const char *, int, ...);
163: void rcs_close (RCSFILE *);
164: int rcs_access_add (RCSFILE *, const char *);
165: int rcs_access_remove (RCSFILE *, const char *);
166: int rcs_access_check (RCSFILE *, const char *);
167: int rcs_sym_add (RCSFILE *, const char *, RCSNUM *);
168: int rcs_sym_remove (RCSFILE *, const char *);
169: RCSNUM* rcs_sym_getrev (RCSFILE *, const char *);
1.12 jfb 170: int rcs_lock_getmode (RCSFILE *);
171: int rcs_lock_setmode (RCSFILE *, int);
1.11 jfb 172: BUF* rcs_getrev (RCSFILE *, RCSNUM *);
173: BUF* rcs_gethead (RCSFILE *);
174: RCSNUM* rcs_getrevbydate (RCSFILE *, struct tm *);
175: const char* rcs_desc_get (RCSFILE *);
176: int rcs_desc_set (RCSFILE *, const char *);
177: int rcs_kwexp_set (RCSFILE *, int);
178: int rcs_kwexp_get (RCSFILE *);
1.6 jfb 179:
180: int rcs_kflag_get (const char *);
1.7 jfb 181: void rcs_kflag_usage (void);
1.9 jfb 182: int rcs_kw_expand (RCSFILE *, u_char *, size_t, size_t *);
1.1 jfb 183:
184: BUF* rcs_patch (const char *, const char *);
185: size_t rcs_stresc (int, const char *, char *, size_t *);
186:
187: RCSNUM* rcsnum_alloc (void);
1.8 jfb 188: RCSNUM* rcsnum_parse (const char *);
1.1 jfb 189: void rcsnum_free (RCSNUM *);
190: int rcsnum_aton (const char *, char **, RCSNUM *);
191: char* rcsnum_tostr (const RCSNUM *, char *, size_t);
192: int rcsnum_cpy (const RCSNUM *, RCSNUM *, u_int);
193: int rcsnum_cmp (const RCSNUM *, const RCSNUM *, u_int);
194:
1.3 jfb 195: /* from cache.c */
196: int rcs_cache_init (u_int);
197: RCSFILE *rcs_cache_fetch (const char *path);
198: int rcs_cache_store (RCSFILE *);
199: void rcs_cache_destroy (void);
1.1 jfb 200:
201: #endif /* RCS_H */