Annotation of src/usr.bin/cvs/rcs.h, Revision 1.10
1.10 ! jfb 1: /* $OpenBSD: rcs.h,v 1.9 2005/02/27 00:22:08 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.6 jfb 45: /* RCS keyword expansion modes (kflags) */
46: #define RCS_KWEXP_NONE 0x00
47: #define RCS_KWEXP_NAME 0x01 /* include keyword name */
48: #define RCS_KWEXP_VAL 0x02 /* include keyword value */
49: #define RCS_KWEXP_LKR 0x04 /* include name of locker */
50: #define RCS_KWEXP_OLD 0x08 /* generate old keyword string */
51: #define RCS_KWEXP_ERR 0x10 /* mode has an error */
52:
53: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
54: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
55:
1.9 jfb 56: #define RCS_KWEXP_INVAL(k) \
57: ((k & RCS_KWEXP_ERR) || ((k & RCS_KWEXP_OLD) != RCS_KWEXP_OLD))
58:
1.6 jfb 59:
60:
61: #define RCSNUM_MAXNUM USHRT_MAX
62: #define RCSNUM_MAXLEN 64
63:
1.1 jfb 64:
65: /* file flags */
1.9 jfb 66: #define RCS_READ 0x01
67: #define RCS_WRITE 0x02
68: #define RCS_RDWR (RCS_READ|RCS_WRITE)
69: #define RCS_CREATE 0x04 /* create the file */
70:
71: /* internal flags */
72: #define RCS_PARSED 0x010000 /* file has been parsed */
73: #define RCS_SYNCED 0x020000 /* in-memory copy is in sync with disk copy */
74: #define RCS_SLOCK 0x040000 /* strict lock */
1.1 jfb 75:
76: /* delta flags */
77: #define RCS_RD_DEAD 0x01 /* dead */
1.5 jfb 78:
79:
1.1 jfb 80: typedef struct rcs_num {
81: u_int rn_len;
82: u_int16_t *rn_id;
83: } RCSNUM;
84:
85:
86: struct rcs_sym {
87: char *rs_name;
88: RCSNUM *rs_num;
89: TAILQ_ENTRY(rcs_sym) rs_list;
90: };
91:
92: struct rcs_lock {
93: RCSNUM *rl_num;
94:
95: TAILQ_ENTRY(rcs_lock) rl_list;
96: };
97:
98:
99: struct rcs_branch {
100: RCSNUM *rb_num;
101: TAILQ_ENTRY(rcs_branch) rb_list;
102: };
103:
104: struct rcs_dlist {
105: struct rcs_delta *tqh_first;
106: struct rcs_delta **tqh_last;
107: };
108:
109: struct rcs_delta {
110: RCSNUM *rd_num;
111: RCSNUM *rd_next;
112: u_int rd_flags;
113: struct tm rd_date;
114: char *rd_author;
115: char *rd_state;
116: char *rd_log;
117: char *rd_text;
118:
119: struct rcs_dlist rd_snodes;
120:
121: TAILQ_HEAD(, rcs_branch) rd_branches;
122: TAILQ_ENTRY(rcs_delta) rd_list;
123: };
124:
125:
126: typedef struct rcs_file {
127: char *rf_path;
128: u_int rf_ref;
1.9 jfb 129: mode_t rf_mode;
1.1 jfb 130: u_int rf_flags;
131:
132: RCSNUM *rf_head;
133: RCSNUM *rf_branch;
134: char *rf_comment;
135: char *rf_expand;
136: char *rf_desc;
137:
1.9 jfb 138: u_int rf_ndelta;
139: struct rcs_dlist rf_delta;
140: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
141: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
142:
1.1 jfb 143:
144: void *rf_pdata;
145: } RCSFILE;
146:
147:
1.10 ! jfb 148: RCSFILE* rcs_open (const char *, int, ...);
! 149: void rcs_close (RCSFILE *);
! 150: int rcs_sym_add (RCSFILE *, const char *, RCSNUM *);
! 151: int rcs_sym_remove (RCSFILE *, const char *);
! 152: RCSNUM* rcs_sym_getrev (RCSFILE *, const char *);
! 153: BUF* rcs_getrev (RCSFILE *, RCSNUM *);
! 154: BUF* rcs_gethead (RCSFILE *);
! 155: RCSNUM* rcs_getrevbydate (RCSFILE *, struct tm *);
! 156: const char* rcs_desc_get (RCSFILE *);
! 157: int rcs_desc_set (RCSFILE *, const char *);
! 158: int rcs_kwexp_set (RCSFILE *, int);
! 159: int rcs_kwexp_get (RCSFILE *);
1.6 jfb 160:
161: int rcs_kflag_get (const char *);
1.7 jfb 162: void rcs_kflag_usage (void);
1.9 jfb 163: int rcs_kw_expand (RCSFILE *, u_char *, size_t, size_t *);
1.1 jfb 164:
165: BUF* rcs_patch (const char *, const char *);
166: size_t rcs_stresc (int, const char *, char *, size_t *);
167:
168: RCSNUM* rcsnum_alloc (void);
1.8 jfb 169: RCSNUM* rcsnum_parse (const char *);
1.1 jfb 170: void rcsnum_free (RCSNUM *);
171: int rcsnum_aton (const char *, char **, RCSNUM *);
172: char* rcsnum_tostr (const RCSNUM *, char *, size_t);
173: int rcsnum_cpy (const RCSNUM *, RCSNUM *, u_int);
174: int rcsnum_cmp (const RCSNUM *, const RCSNUM *, u_int);
175:
1.3 jfb 176: /* from cache.c */
177: int rcs_cache_init (u_int);
178: RCSFILE *rcs_cache_fetch (const char *path);
179: int rcs_cache_store (RCSFILE *);
180: void rcs_cache_destroy (void);
1.1 jfb 181:
182: #endif /* RCS_H */