Annotation of src/usr.bin/cvs/rcs.h, Revision 1.99
1.99 ! chl 1: /* $OpenBSD: rcs.h,v 1.98 2010/10/31 15:37:34 nicm 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
1.97 tobias 29:
30: #include <stdio.h>
1.99 ! chl 31: #include <time.h>
1.97 tobias 32:
1.1 jfb 33: #include "buf.h"
34:
35: #define RCS_DIFF_DIV \
36: "==================================================================="
37:
1.30 xsa 38: #define RCS_FILE_EXT ",v"
1.1 jfb 39:
1.30 xsa 40: #define RCS_HEAD_BRANCH "HEAD"
41: #define RCS_HEAD_INIT "1.1"
42: #define RCS_HEAD_REV ((RCSNUM *)(-1))
1.23 jfb 43:
1.63 joris 44: #define RCS_CONFLICT_MARKER1 "<<<<<<< "
45: #define RCS_CONFLICT_MARKER2 ">>>>>>> "
46: #define RCS_CONFLICT_MARKER3 "=======\n"
1.23 jfb 47:
1.30 xsa 48: #define RCS_SYM_INVALCHAR "$,.:;@"
1.1 jfb 49:
1.31 joris 50: #define RCS_MAGIC_BRANCH ".0."
1.30 xsa 51: #define RCS_STATE_EXP "Exp"
52: #define RCS_STATE_DEAD "dead"
1.17 jfb 53:
1.12 jfb 54: /* lock types */
1.30 xsa 55: #define RCS_LOCK_INVAL (-1)
56: #define RCS_LOCK_LOOSE 0
57: #define RCS_LOCK_STRICT 1
1.12 jfb 58:
1.46 niallo 59: /*
60: * Keyword expansion table
61: */
62: #define RCS_KW_AUTHOR 0x1000
63: #define RCS_KW_DATE 0x2000
64: #define RCS_KW_LOG 0x4000
65: #define RCS_KW_NAME 0x8000
66: #define RCS_KW_RCSFILE 0x0100
67: #define RCS_KW_REVISION 0x0200
68: #define RCS_KW_SOURCE 0x0400
69: #define RCS_KW_STATE 0x0800
70: #define RCS_KW_FULLPATH 0x0010
1.76 niallo 71: #define RCS_KW_MDOCDATE 0x0020
1.81 tobias 72: #define RCS_KW_LOCKER 0x0040
1.46 niallo 73:
74: #define RCS_KW_ID \
75: (RCS_KW_RCSFILE | RCS_KW_REVISION | RCS_KW_DATE \
76: | RCS_KW_AUTHOR | RCS_KW_STATE)
77:
78: #define RCS_KW_HEADER (RCS_KW_ID | RCS_KW_FULLPATH)
79:
1.6 jfb 80: /* RCS keyword expansion modes (kflags) */
1.83 tobias 81: #define RCS_KWEXP_NONE 0x01 /* do not expand keywords */
82: #define RCS_KWEXP_NAME 0x02 /* include keyword name */
83: #define RCS_KWEXP_VAL 0x04 /* include keyword value */
84: #define RCS_KWEXP_LKR 0x08 /* include name of locker */
85: #define RCS_KWEXP_OLD 0x10 /* generate old keyword string */
86: #define RCS_KWEXP_ERR 0x20 /* mode has an error */
1.6 jfb 87:
1.30 xsa 88: #define RCS_KWEXP_DEFAULT (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
89: #define RCS_KWEXP_KVL (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
1.6 jfb 90:
1.9 jfb 91: #define RCS_KWEXP_INVAL(k) \
1.13 jfb 92: ((k & RCS_KWEXP_ERR) || \
1.51 ray 93: ((k & RCS_KWEXP_OLD) && (k & ~RCS_KWEXP_OLD)))
1.9 jfb 94:
1.46 niallo 95: struct rcs_kw {
96: char kw_str[16];
97: int kw_type;
98: };
99:
100: #define RCS_NKWORDS (sizeof(rcs_expkw)/sizeof(rcs_expkw[0]))
1.6 jfb 101:
1.30 xsa 102: #define RCSNUM_MAXNUM USHRT_MAX
103: #define RCSNUM_MAXLEN 64
1.6 jfb 104:
1.30 xsa 105: #define RCSNUM_ISBRANCH(n) ((n)->rn_len % 2)
1.57 joris 106: #define RCSNUM_ISBRANCHREV(n) (!((n)->rn_len % 2) && ((n)->rn_len >= 4))
1.1 jfb 107:
108: /* file flags */
1.43 niallo 109: #define RCS_READ (1<<0)
1.98 nicm 110: #define RCS_WRITE (1<<1) /* flush changes on rcs_close() */
1.43 niallo 111: #define RCS_CREATE (1<<2) /* create the file */
112: #define RCS_PARSE_FULLY (1<<3) /* fully parse it on open */
1.9 jfb 113:
114: /* internal flags */
1.43 niallo 115: #define RCS_PARSED (1<<4) /* file has been parsed */
116: #define RCS_SYNCED (1<<5) /* in-mem copy is sync with disk copy */
117: #define RCS_SLOCK (1<<6) /* strict lock */
118:
119: /* parser flags */
120: #define PARSED_DELTAS (1<<7) /* all deltas are parsed */
121: #define PARSED_DESC (1<<8) /* the description is parsed */
122: #define PARSED_DELTATEXTS (1<<9) /* all delta texts are parsed */
1.1 jfb 123:
124: /* delta flags */
1.30 xsa 125: #define RCS_RD_DEAD 0x01 /* dead */
1.56 ray 126: #define RCS_RD_SELECT 0x02 /* select for operation */
1.40 joris 127:
1.1 jfb 128: typedef struct rcs_num {
1.30 xsa 129: u_int rn_len;
130: u_int16_t *rn_id;
1.1 jfb 131: } RCSNUM;
132:
1.11 jfb 133: struct rcs_access {
1.30 xsa 134: char *ra_name;
135: TAILQ_ENTRY(rcs_access) ra_list;
1.11 jfb 136: };
137:
1.1 jfb 138: struct rcs_sym {
1.30 xsa 139: char *rs_name;
140: RCSNUM *rs_num;
141: TAILQ_ENTRY(rcs_sym) rs_list;
1.1 jfb 142: };
143:
144: struct rcs_lock {
1.30 xsa 145: char *rl_name;
146: RCSNUM *rl_num;
1.1 jfb 147:
1.94 ray 148: TAILQ_ENTRY(rcs_lock) rl_list;
1.1 jfb 149: };
150:
151: struct rcs_branch {
1.30 xsa 152: RCSNUM *rb_num;
1.94 ray 153: TAILQ_ENTRY(rcs_branch) rb_list;
1.1 jfb 154: };
155:
1.50 ray 156: TAILQ_HEAD(rcs_dlist, rcs_delta);
1.1 jfb 157:
158: struct rcs_delta {
1.30 xsa 159: RCSNUM *rd_num;
160: RCSNUM *rd_next;
1.75 otto 161: int rd_flags;
1.30 xsa 162: struct tm rd_date;
163: char *rd_author;
164: char *rd_state;
165: char *rd_log;
1.42 joris 166: char *rd_locker;
1.30 xsa 167: u_char *rd_text;
168: size_t rd_tlen;
169:
170: TAILQ_HEAD(, rcs_branch) rd_branches;
171: TAILQ_ENTRY(rcs_delta) rd_list;
1.1 jfb 172: };
173:
174:
175: typedef struct rcs_file {
1.97 tobias 176: FILE *rf_file;
1.64 joris 177: int rf_dead;
1.30 xsa 178: char *rf_path;
179: mode_t rf_mode;
1.75 otto 180: int rf_flags;
1.30 xsa 181:
182: RCSNUM *rf_head;
183: RCSNUM *rf_branch;
184: char *rf_comment;
185: char *rf_expand;
186: char *rf_desc;
187:
188: u_int rf_ndelta;
189: struct rcs_dlist rf_delta;
190: TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
191: TAILQ_HEAD(rcs_slist, rcs_sym) rf_symbols;
192: TAILQ_HEAD(rcs_llist, rcs_lock) rf_locks;
1.9 jfb 193:
1.30 xsa 194: void *rf_pdata;
1.1 jfb 195: } RCSFILE;
196:
1.94 ray 197: struct rcs_line;
198: struct rcs_lines;
1.14 jfb 199:
1.62 joris 200: RCSFILE *rcs_open(const char *, int, int, ...);
1.39 xsa 201: void rcs_close(RCSFILE *);
1.68 joris 202: RCSNUM *rcs_head_get(RCSFILE *);
1.43 niallo 203: int rcs_head_set(RCSFILE *, RCSNUM *);
1.92 tobias 204: RCSNUM *rcs_branch_new(RCSFILE *, RCSNUM *);
1.39 xsa 205: const RCSNUM *rcs_branch_get(RCSFILE *);
206: int rcs_branch_set(RCSFILE *, const RCSNUM *);
207: int rcs_access_add(RCSFILE *, const char *);
208: int rcs_access_remove(RCSFILE *, const char *);
209: int rcs_access_check(RCSFILE *, const char *);
1.43 niallo 210: struct rcs_delta *rcs_findrev(RCSFILE *, RCSNUM *);
1.39 xsa 211: int rcs_sym_add(RCSFILE *, const char *, RCSNUM *);
1.69 xsa 212: int rcs_sym_check(const char *);
213: struct rcs_sym *rcs_sym_get(RCSFILE *, const char *);
1.39 xsa 214: int rcs_sym_remove(RCSFILE *, const char *);
215: RCSNUM *rcs_sym_getrev(RCSFILE *, const char *);
1.65 joris 216: RCSNUM *rcs_translate_tag(const char *, RCSFILE *);
1.39 xsa 217: int rcs_lock_getmode(RCSFILE *);
218: int rcs_lock_setmode(RCSFILE *, int);
219: int rcs_lock_add(RCSFILE *, const char *, RCSNUM *);
1.42 joris 220: int rcs_lock_remove(RCSFILE *, const char *, RCSNUM *);
1.70 joris 221: int rcs_deltatext_set(RCSFILE *, RCSNUM *, BUF *);
1.39 xsa 222: const char *rcs_desc_get(RCSFILE *);
1.52 xsa 223: void rcs_desc_set(RCSFILE *, const char *);
1.39 xsa 224: const char *rcs_comment_lookup(const char *);
225: const char *rcs_comment_get(RCSFILE *);
1.53 xsa 226: void rcs_comment_set(RCSFILE *, const char *);
1.47 niallo 227: BUF *rcs_kwexp_buf(BUF *, RCSFILE *, RCSNUM *);
1.58 xsa 228: void rcs_kwexp_set(RCSFILE *, int);
1.39 xsa 229: int rcs_kwexp_get(RCSFILE *);
230: int rcs_rev_add(RCSFILE *, RCSNUM *, const char *, time_t,
231: const char *);
232: time_t rcs_rev_getdate(RCSFILE *, RCSNUM *);
233: int rcs_rev_setlog(RCSFILE *, RCSNUM *, const char *);
234: int rcs_rev_remove(RCSFILE *, RCSNUM *);
235: int rcs_state_set(RCSFILE *, RCSNUM *, const char *);
236: const char *rcs_state_get(RCSFILE *, RCSNUM *);
237: int rcs_state_check(const char *);
238: RCSNUM *rcs_tag_resolve(RCSFILE *, const char *);
1.62 joris 239: void rcs_write(RCSFILE *);
1.88 joris 240: int rcs_rev_write_stmp(RCSFILE *, RCSNUM *, char *, int);
1.72 joris 241: void rcs_rev_write_fd(RCSFILE *, RCSNUM *, int, int);
1.94 ray 242: struct rcs_lines *rcs_rev_getlines(RCSFILE *, RCSNUM *,
243: struct rcs_line ***);
1.80 tobias 244: void rcs_annotate_getlines(RCSFILE *, RCSNUM *,
1.94 ray 245: struct rcs_line ***);
1.73 joris 246: BUF *rcs_rev_getbuf(RCSFILE *, RCSNUM *, int);
1.85 joris 247: void rcs_delta_stats(struct rcs_delta *, int *, int *);
1.30 xsa 248:
249: int rcs_kflag_get(const char *);
250: void rcs_kflag_usage(void);
251: int rcs_kw_expand(RCSFILE *, u_char *, size_t, size_t *);
252:
253: RCSNUM *rcsnum_alloc(void);
254: RCSNUM *rcsnum_parse(const char *);
255: RCSNUM *rcsnum_brtorev(const RCSNUM *);
256: RCSNUM *rcsnum_revtobr(const RCSNUM *);
257: RCSNUM *rcsnum_inc(RCSNUM *);
1.33 joris 258: RCSNUM *rcsnum_dec(RCSNUM *);
1.79 joris 259: RCSNUM *rcsnum_branch_root(RCSNUM *);
1.82 tobias 260: RCSNUM *rcsnum_new_branch(RCSNUM *);
1.30 xsa 261: void rcsnum_free(RCSNUM *);
1.86 tobias 262: int rcsnum_addmagic(RCSNUM *);
1.30 xsa 263: int rcsnum_aton(const char *, char **, RCSNUM *);
264: char *rcsnum_tostr(const RCSNUM *, char *, size_t);
1.55 ray 265: void rcsnum_cpy(const RCSNUM *, RCSNUM *, u_int);
1.67 joris 266: int rcsnum_cmp(RCSNUM *, RCSNUM *, u_int);
267: int rcsnum_differ(RCSNUM *, RCSNUM *);
1.1 jfb 268:
1.30 xsa 269: #endif /* RCS_H */
![[BACK]](/icons/back.gif){kind=icon}
Return to rcs.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / cvs