Annotation of src/usr.bin/cvs/cvs.h, Revision 1.18
1.1 jfb 1: /* $OpenBSD$ */
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 CVS_H
28: #define CVS_H
29:
30: #include <sys/param.h>
1.8 jfb 31: #include <stdio.h>
1.9 jfb 32: #include <dirent.h>
33:
1.1 jfb 34: #include "rcs.h"
35:
36: #define CVS_VERSION "OpenCVS 0.1"
37:
38:
39: #define CVS_HIST_CACHE 128
40: #define CVS_HIST_NBFLD 6
41:
42:
43: #define CVS_CKSUM_LEN 33 /* length of a CVS checksum string */
44:
45:
46: /* operations */
1.8 jfb 47: #define CVS_OP_ANY 0 /* all operations */
1.1 jfb 48: #define CVS_OP_ADD 1
49: #define CVS_OP_ANNOTATE 2
1.16 jfb 50: #define CVS_OP_CHECKOUT 3
51: #define CVS_OP_COMMIT 4
52: #define CVS_OP_DIFF 5
53: #define CVS_OP_HISTORY 6
54: #define CVS_OP_IMPORT 7
55: #define CVS_OP_INIT 8
56: #define CVS_OP_LOG 9
57: #define CVS_OP_REMOVE 10
58: #define CVS_OP_SERVER 11
59: #define CVS_OP_STATUS 12
60: #define CVS_OP_TAG 13
61: #define CVS_OP_UPDATE 14
62: #define CVS_OP_VERSION 15
1.1 jfb 63:
64:
65:
66:
67: /* methods */
68: #define CVS_METHOD_NONE 0
69: #define CVS_METHOD_LOCAL 1 /* local access */
70: #define CVS_METHOD_SERVER 2 /* tunnel through CVS_RSH */
71: #define CVS_METHOD_PSERVER 3 /* cvs pserver */
72: #define CVS_METHOD_KSERVER 4 /* kerberos */
73: #define CVS_METHOD_GSERVER 5 /* gssapi server */
74: #define CVS_METHOD_EXT 6
75: #define CVS_METHOD_FORK 7 /* local but fork */
76:
77: #define CVS_CMD_MAXNAMELEN 16
78: #define CVS_CMD_MAXALIAS 2
79: #define CVS_CMD_MAXDESCRLEN 64
80:
81:
82: /* defaults */
83: #define CVS_RSH_DEFAULT "ssh"
84: #define CVS_EDITOR_DEFAULT "vi"
85:
86:
87: /* server-side paths */
88: #define CVS_PATH_ROOT "CVSROOT"
89: #define CVS_PATH_COMMITINFO CVS_PATH_ROOT "/commitinfo"
90: #define CVS_PATH_CONFIG CVS_PATH_ROOT "/config"
91: #define CVS_PATH_CVSIGNORE CVS_PATH_ROOT "/cvsignore"
92: #define CVS_PATH_CVSWRAPPERS CVS_PATH_ROOT "/cvswrappers"
93: #define CVS_PATH_EDITINFO CVS_PATH_ROOT "/editinfo"
94: #define CVS_PATH_HISTORY CVS_PATH_ROOT "/history"
95: #define CVS_PATH_LOGINFO CVS_PATH_ROOT "/loginfo"
96: #define CVS_PATH_MODULES CVS_PATH_ROOT "/modules"
97: #define CVS_PATH_NOTIFY CVS_PATH_ROOT "/notify"
98: #define CVS_PATH_RCSINFO CVS_PATH_ROOT "/rcsinfo"
99: #define CVS_PATH_TAGINFO CVS_PATH_ROOT "/taginfo"
100: #define CVS_PATH_VERIFYMSG CVS_PATH_ROOT "/verifymsg"
101:
102:
103: /* client-side paths */
104: #define CVS_PATH_RC ".cvsrc"
105: #define CVS_PATH_CVSDIR "CVS"
106: #define CVS_PATH_ENTRIES CVS_PATH_CVSDIR "/Entries"
107: #define CVS_PATH_STATICENTRIES CVS_PATH_CVSDIR "/Entries.Static"
108: #define CVS_PATH_LOGENTRIES CVS_PATH_CVSDIR "/Entries.Log"
109: #define CVS_PATH_ROOTSPEC CVS_PATH_CVSDIR "/Root"
1.10 jfb 110: #define CVS_PATH_REPOSITORY CVS_PATH_CVSDIR "/Repository"
1.1 jfb 111:
112:
1.7 jfb 113: struct cvs_file;
114: struct cvs_dir;
115:
116:
1.1 jfb 117: struct cvs_op {
118: u_int co_op;
119: uid_t co_uid; /* user performing the operation */
120: char *co_path; /* target path of the operation */
121: char *co_tag; /* tag or branch, NULL if HEAD */
122: };
123:
124:
125:
126: struct cvsroot {
1.11 jfb 127: char *cr_str;
1.1 jfb 128: u_int cr_method;
129: char *cr_buf;
130: char *cr_user;
131: char *cr_pass;
132: char *cr_host;
133: char *cr_dir;
134: u_int cr_port;
1.11 jfb 135: u_int cr_ref;
136:
137: /* connection data */
138: FILE *cr_srvin;
139: FILE *cr_srvout;
1.1 jfb 140: };
141:
142:
143: #define CVS_HIST_ADDED 'A'
144: #define CVS_HIST_EXPORT 'E'
145: #define CVS_HIST_RELEASE 'F'
146: #define CVS_HIST_MODIFIED 'M'
147: #define CVS_HIST_CHECKOUT 'O'
148: #define CVS_HIST_COMMIT 'R'
149: #define CVS_HIST_TAG 'T'
150:
151:
152: #define CVS_ENT_NONE 0
153: #define CVS_ENT_FILE 1
154: #define CVS_ENT_DIR 2
155:
1.17 jfb 156: #define CVS_ENTF_SYNC 0x01 /* contents of disk and memory match */
157: #define CVS_ENTF_WR 0x02 /* file is opened for writing too */
158:
1.1 jfb 159:
160: struct cvs_ent {
161: char *ce_line;
162: char *ce_buf;
163: u_int ce_type;
164: char *ce_name;
165: RCSNUM *ce_rev;
166: char *ce_timestamp;
167: char *ce_opts;
168: char *ce_tag;
1.4 jfb 169: TAILQ_ENTRY(cvs_ent) ce_list;
1.1 jfb 170: };
171:
172: typedef struct cvs_entries {
173: char *cef_path;
1.3 jfb 174: FILE *cef_file;
1.17 jfb 175: u_int cef_flags;
1.1 jfb 176:
1.4 jfb 177: TAILQ_HEAD(, cvs_ent) cef_ent;
178: struct cvs_ent *cef_cur;
1.1 jfb 179: } CVSENTRIES;
180:
181:
182:
183: struct cvs_hent {
184: char ch_event;
185: time_t ch_date;
186: uid_t ch_uid;
187: char *ch_user;
188: char *ch_curdir;
189: char *ch_repo;
190: RCSNUM *ch_rev;
191: char *ch_arg;
192: };
193:
194:
195: typedef struct cvs_histfile {
196: int chf_fd;
197: char *chf_buf; /* read buffer */
198: size_t chf_blen; /* buffer size */
199: size_t chf_bused; /* bytes used in buffer */
200:
201: off_t chf_off; /* next read */
202: u_int chf_sindex; /* history entry index of first in array */
203: u_int chf_cindex; /* current index (for getnext()) */
204: u_int chf_nbhent; /* number of valid entries in the array */
205:
206: struct cvs_hent chf_hent[CVS_HIST_CACHE];
207:
208: } CVSHIST;
209:
210:
1.15 jfb 211: #ifdef CVS
1.18 ! jfb 212: extern char *cvs_editor;
1.15 jfb 213: #endif
214:
215:
1.1 jfb 216:
217: /* client command handlers */
218: int cvs_add (int, char **);
1.9 jfb 219: int cvs_checkout (int, char **);
1.1 jfb 220: int cvs_commit (int, char **);
221: int cvs_diff (int, char **);
222: int cvs_getlog (int, char **);
223: int cvs_history (int, char **);
224: int cvs_init (int, char **);
225: int cvs_server (int, char **);
1.15 jfb 226: int cvs_status (int, char **);
1.1 jfb 227: int cvs_update (int, char **);
228: int cvs_version (int, char **);
229:
230:
231: /* from root.c */
232: struct cvsroot* cvsroot_parse (const char *);
233: void cvsroot_free (struct cvsroot *);
234: struct cvsroot* cvsroot_get (const char *);
1.2 jfb 235:
236:
1.1 jfb 237: /* Entries API */
1.3 jfb 238: CVSENTRIES* cvs_ent_open (const char *, int);
1.1 jfb 239: struct cvs_ent* cvs_ent_get (CVSENTRIES *, const char *);
240: struct cvs_ent* cvs_ent_next (CVSENTRIES *);
241: int cvs_ent_add (CVSENTRIES *, struct cvs_ent *);
1.5 jfb 242: int cvs_ent_addln (CVSENTRIES *, const char *);
1.1 jfb 243: int cvs_ent_remove (CVSENTRIES *, const char *);
1.17 jfb 244: int cvs_ent_write (CVSENTRIES *);
1.1 jfb 245: struct cvs_ent* cvs_ent_parse (const char *);
246: void cvs_ent_close (CVSENTRIES *);
1.8 jfb 247: void cvs_ent_free (struct cvs_ent *);
248: struct cvs_ent* cvs_ent_getent (const char *);
1.1 jfb 249:
250: /* history API */
251: CVSHIST* cvs_hist_open (const char *);
252: void cvs_hist_close (CVSHIST *);
253: int cvs_hist_parse (CVSHIST *);
254: struct cvs_hent* cvs_hist_getnext (CVSHIST *);
255: int cvs_hist_append (CVSHIST *, struct cvs_hent *);
256:
257:
258: /* from util.c */
259: int cvs_readrepo (const char *, char *, size_t);
260: int cvs_splitpath (const char *, char *, size_t, char *, size_t);
261: int cvs_modetostr (mode_t, char *, size_t);
262: int cvs_strtomode (const char *, mode_t *);
1.10 jfb 263: int cvs_mkadmin (struct cvs_file *, mode_t);
1.1 jfb 264: int cvs_cksum (const char *, char *, size_t);
265: int cvs_exec (int, char **, int []);
1.6 jfb 266: int cvs_getargv (const char *, char **, int);
267: void cvs_freeargv (char **, int);
1.1 jfb 268:
269:
270: #endif /* CVS_H */