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