[BACK]Return to cvs.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / cvs

Annotation of src/usr.bin/cvs/cvs.h, Revision 1.59

1.59    ! joris       1: /*     $OpenBSD: cvs.h,v 1.58 2005/05/24 04:12:25 jfb Exp $    */
1.1       jfb         2: /*
                      3:  * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.35      tedu        4:  * All rights reserved.
1.1       jfb         5:  *
1.35      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.35      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.35      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.35      tedu       24:  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1       jfb        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
1.58      jfb        38: #define CVS_VERSION_MINOR 3
                     39: #define CVS_VERSION       "OpenCVS 0.3"
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:
1.50      joris      48: /* error codes */
1.51      jfb        49: #define CVS_EX_OK      0
1.50      joris      50: #define CVS_EX_USAGE   1
                     51: #define CVS_EX_DATA    2
                     52: #define CVS_EX_PROTO   3
                     53: #define CVS_EX_FILE    4
1.52      jfb        54: #define CVS_EX_BADTAG  5
1.53      jfb        55: #define CVS_EX_BADROOT 6
1.1       jfb        56:
                     57: /* operations */
1.19      jfb        58: #define CVS_OP_UNKNOWN      0
1.1       jfb        59: #define CVS_OP_ADD          1
1.43      jfb        60: #define CVS_OP_ADMIN        2
                     61: #define CVS_OP_ANNOTATE     3
                     62: #define CVS_OP_CHECKOUT     4
                     63: #define CVS_OP_COMMIT       5
                     64: #define CVS_OP_DIFF         6
                     65: #define CVS_OP_EDIT         7
                     66: #define CVS_OP_EDITORS      8
                     67: #define CVS_OP_EXPORT       9
                     68: #define CVS_OP_HISTORY     10
                     69: #define CVS_OP_IMPORT      11
                     70: #define CVS_OP_INIT        12
                     71: #define CVS_OP_LOG         13
                     72: #define CVS_OP_RANNOTATE   14
                     73: #define CVS_OP_RDIFF       15
                     74: #define CVS_OP_RELEASE     16
                     75: #define CVS_OP_REMOVE      17
                     76: #define CVS_OP_RLOG        18
                     77: #define CVS_OP_RTAG        19
                     78: #define CVS_OP_SERVER      20
                     79: #define CVS_OP_STATUS      21
                     80: #define CVS_OP_TAG         22
                     81: #define CVS_OP_UNEDIT      23
                     82: #define CVS_OP_UPDATE      24
                     83: #define CVS_OP_VERSION     25
                     84: #define CVS_OP_WATCH       26
                     85: #define CVS_OP_WATCHERS    27
1.1       jfb        86:
1.19      jfb        87: #define CVS_OP_ANY         64     /* all operations */
1.1       jfb        88:
                     89:
                     90: /* methods */
                     91: #define CVS_METHOD_NONE       0
                     92: #define CVS_METHOD_LOCAL      1    /* local access */
                     93: #define CVS_METHOD_SERVER     2    /* tunnel through CVS_RSH */
                     94: #define CVS_METHOD_PSERVER    3    /* cvs pserver */
                     95: #define CVS_METHOD_KSERVER    4    /* kerberos */
                     96: #define CVS_METHOD_GSERVER    5    /* gssapi server */
                     97: #define CVS_METHOD_EXT        6
                     98: #define CVS_METHOD_FORK       7    /* local but fork */
                     99:
                    100: #define CVS_CMD_MAXNAMELEN   16
                    101: #define CVS_CMD_MAXALIAS      2
                    102: #define CVS_CMD_MAXDESCRLEN  64
1.34      jfb       103: #define CVS_CMD_MAXARG      128
1.1       jfb       104:
                    105:
                    106: /* defaults */
1.21      jfb       107: #define CVS_SERVER_DEFAULT  "cvs"
1.1       jfb       108: #define CVS_RSH_DEFAULT     "ssh"
                    109: #define CVS_EDITOR_DEFAULT  "vi"
                    110:
                    111:
                    112: /* server-side paths */
                    113: #define CVS_PATH_ROOT         "CVSROOT"
                    114: #define CVS_PATH_COMMITINFO   CVS_PATH_ROOT "/commitinfo"
                    115: #define CVS_PATH_CONFIG       CVS_PATH_ROOT "/config"
                    116: #define CVS_PATH_CVSIGNORE    CVS_PATH_ROOT "/cvsignore"
                    117: #define CVS_PATH_CVSWRAPPERS  CVS_PATH_ROOT "/cvswrappers"
                    118: #define CVS_PATH_EDITINFO     CVS_PATH_ROOT "/editinfo"
                    119: #define CVS_PATH_HISTORY      CVS_PATH_ROOT "/history"
                    120: #define CVS_PATH_LOGINFO      CVS_PATH_ROOT "/loginfo"
                    121: #define CVS_PATH_MODULES      CVS_PATH_ROOT "/modules"
                    122: #define CVS_PATH_NOTIFY       CVS_PATH_ROOT "/notify"
                    123: #define CVS_PATH_RCSINFO      CVS_PATH_ROOT "/rcsinfo"
                    124: #define CVS_PATH_TAGINFO      CVS_PATH_ROOT "/taginfo"
                    125: #define CVS_PATH_VERIFYMSG    CVS_PATH_ROOT "/verifymsg"
                    126:
                    127:
                    128: /* client-side paths */
                    129: #define CVS_PATH_RC             ".cvsrc"
                    130: #define CVS_PATH_CVSDIR         "CVS"
                    131: #define CVS_PATH_ENTRIES        CVS_PATH_CVSDIR "/Entries"
                    132: #define CVS_PATH_STATICENTRIES  CVS_PATH_CVSDIR "/Entries.Static"
                    133: #define CVS_PATH_LOGENTRIES     CVS_PATH_CVSDIR "/Entries.Log"
                    134: #define CVS_PATH_ROOTSPEC       CVS_PATH_CVSDIR "/Root"
1.10      jfb       135: #define CVS_PATH_REPOSITORY     CVS_PATH_CVSDIR "/Repository"
1.1       jfb       136:
1.46      joris     137:
                    138: /* flags for cmd_flags */
                    139: #define CVS_CMD_ALLOWSPEC      0x01
                    140: #define CVS_CMD_SENDARGS1      0x04
                    141: #define CVS_CMD_SENDARGS2      0x08
                    142: #define CVS_CMD_SENDDIR                0x10
                    143:
1.58      jfb       144:
1.46      joris     145: struct cvs_cmd {
1.58      jfb       146:        int   cmd_op;
                    147:        int   cmd_req;
                    148:        char  cmd_name[CVS_CMD_MAXNAMELEN];
                    149:        char  cmd_alias[CVS_CMD_MAXALIAS][CVS_CMD_MAXNAMELEN];
                    150:        char  cmd_descr[CVS_CMD_MAXDESCRLEN];
1.46      joris     151:        char *cmd_synopsis;
                    152:        char *cmd_opts;
                    153:        char *cmd_defargs;
1.58      jfb       154:        int   file_flags;
                    155:
                    156:        /* operations vector */
                    157:        int (*cmd_init)        (struct cvs_cmd *, int, char **, int *);
                    158:        int (*cmd_pre_exec)    (struct cvsroot *);
                    159:        int (*cmd_exec_remote) (CVSFILE *, void *);
                    160:        int (*cmd_exec_local)  (CVSFILE *, void *);
                    161:        int (*cmd_post_exec)   (struct cvsroot *);
                    162:        int (*cmd_cleanup)     (void);
                    163:
                    164:        /* flags for cvs_file_get() */
                    165:        int   cmd_flags;
1.46      joris     166: };
1.1       jfb       167:
1.7       jfb       168: struct cvs_file;
                    169: struct cvs_dir;
1.19      jfb       170: struct cvs_flist;
1.7       jfb       171:
1.41      jfb       172: struct cvs_var {
                    173:        char   *cv_name;
                    174:        char   *cv_val;
                    175:        TAILQ_ENTRY(cvs_var) cv_link;
                    176: };
                    177:
                    178:
                    179:
1.1       jfb       180: struct cvs_op {
1.19      jfb       181:        u_int             co_op;
                    182:        uid_t             co_uid;    /* user performing the operation */
                    183:        char             *co_tag;    /* tag or branch, NULL if HEAD */
                    184:        char             *co_msg;    /* message string (on commit or add) */
                    185:        struct cvs_flist  co_files;
1.1       jfb       186: };
                    187:
                    188:
1.36      jfb       189: #define CVS_ROOT_CONNECTED    0x01
                    190:
1.1       jfb       191: struct cvsroot {
1.11      jfb       192:        char   *cr_str;
1.1       jfb       193:        u_int   cr_method;
                    194:        char   *cr_buf;
                    195:        char   *cr_user;
                    196:        char   *cr_pass;
                    197:        char   *cr_host;
                    198:        char   *cr_dir;
                    199:        u_int   cr_port;
1.11      jfb       200:        u_int   cr_ref;
                    201:
                    202:        /* connection data */
1.36      jfb       203:        u_int   cr_flags;
1.11      jfb       204:        FILE   *cr_srvin;
                    205:        FILE   *cr_srvout;
1.21      jfb       206:        FILE   *cr_srverr;
1.29      jfb       207:        char   *cr_version;     /* version of remote server */
                    208:        u_char  cr_vrmask[16];  /* mask of valid requests supported by server */
1.1       jfb       209: };
1.20      jfb       210:
1.29      jfb       211: #define CVS_SETVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] |=  (1 << ((rq) % 8)))
                    212: #define CVS_GETVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] &   (1 << ((rq) % 8)))
                    213: #define CVS_CLRVR(rt, rq)  ((rt)->cr_vrmask[(rq) / 8] &= ~(1 << ((rq) % 8)))
1.20      jfb       214: #define CVS_RSTVR(rt)      memset((rt)->cr_vrmask, 0, sizeof((rt)->cr_vrmask))
1.1       jfb       215:
                    216:
                    217: #define CVS_HIST_ADDED    'A'
                    218: #define CVS_HIST_EXPORT   'E'
                    219: #define CVS_HIST_RELEASE  'F'
                    220: #define CVS_HIST_MODIFIED 'M'
                    221: #define CVS_HIST_CHECKOUT 'O'
                    222: #define CVS_HIST_COMMIT   'R'
                    223: #define CVS_HIST_TAG      'T'
                    224:
                    225:
1.28      jfb       226: #define CVS_DATE_DUMMY  "dummy timestamp"
                    227: #define CVS_DATE_DMSEC  (time_t)-1
1.27      jfb       228:
1.1       jfb       229: #define CVS_ENT_NONE    0
                    230: #define CVS_ENT_FILE    1
                    231: #define CVS_ENT_DIR     2
1.27      jfb       232:
1.44      jfb       233: #define CVS_ENT_REG      0
                    234: #define CVS_ENT_ADDED    1
                    235: #define CVS_ENT_REMOVED  2
                    236:
1.1       jfb       237:
1.17      jfb       238: #define CVS_ENTF_SYNC   0x01    /* contents of disk and memory match */
                    239: #define CVS_ENTF_WR     0x02    /* file is opened for writing too */
                    240:
1.1       jfb       241:
                    242: struct cvs_ent {
1.44      jfb       243:        char      *ce_buf;
                    244:        u_int16_t  ce_type;
                    245:        u_int16_t  ce_status;
                    246:        char      *ce_name;
                    247:        RCSNUM    *ce_rev;
                    248:        time_t     ce_mtime;
                    249:        char      *ce_opts;
                    250:        char      *ce_tag;
1.4       jfb       251:        TAILQ_ENTRY(cvs_ent) ce_list;
1.1       jfb       252: };
                    253:
                    254: typedef struct cvs_entries {
                    255:        char    *cef_path;
1.3       jfb       256:        FILE    *cef_file;
1.17      jfb       257:        u_int    cef_flags;
1.1       jfb       258:
1.4       jfb       259:        TAILQ_HEAD(, cvs_ent) cef_ent;
                    260:        struct cvs_ent       *cef_cur;
1.1       jfb       261: } CVSENTRIES;
                    262:
                    263:
                    264: struct cvs_hent {
                    265:        char    ch_event;
                    266:        time_t  ch_date;
                    267:        uid_t   ch_uid;
                    268:        char   *ch_user;
                    269:        char   *ch_curdir;
                    270:        char   *ch_repo;
                    271:        RCSNUM *ch_rev;
                    272:        char   *ch_arg;
                    273: };
                    274:
                    275:
                    276: typedef struct cvs_histfile {
                    277:        int     chf_fd;
                    278:        char   *chf_buf;       /* read buffer */
                    279:        size_t  chf_blen;      /* buffer size */
                    280:        size_t  chf_bused;     /* bytes used in buffer */
                    281:
                    282:        off_t   chf_off;       /* next read */
                    283:        u_int   chf_sindex;    /* history entry index of first in array */
                    284:        u_int   chf_cindex;    /* current index (for getnext()) */
                    285:        u_int   chf_nbhent;    /* number of valid entries in the array */
                    286:
                    287:        struct cvs_hent chf_hent[CVS_HIST_CACHE];
                    288:
                    289: } CVSHIST;
                    290:
                    291:
1.15      jfb       292: #ifdef CVS
1.42      jfb       293:
1.22      jfb       294: extern char *cvs_command;
1.18      jfb       295: extern char *cvs_editor;
1.30      krapht    296: extern char *cvs_msg;
1.42      jfb       297: extern char *cvs_rsh;
1.22      jfb       298:
1.42      jfb       299: extern int  verbosity;
                    300: extern int  cvs_trace;
                    301: extern int  cvs_nolog;
                    302: extern int  cvs_compress;
                    303: extern int  cvs_cmdop;
                    304: extern int  cvs_nocase;
1.57      xsa       305: extern int  cvs_noexec;
1.42      jfb       306: extern int  cvs_readonly;
1.22      jfb       307:
1.23      jfb       308: extern CVSFILE *cvs_files;
                    309:
1.15      jfb       310: #endif
                    311:
1.58      jfb       312: extern struct cvs_cmd *cvs_cdt[];
1.1       jfb       313:
1.58      jfb       314: extern struct cvs_cmd cvs_cmd_add;
                    315: extern struct cvs_cmd cvs_cmd_admin;
                    316: extern struct cvs_cmd cvs_cmd_annotate;
                    317: extern struct cvs_cmd cvs_cmd_checkout;
                    318: extern struct cvs_cmd cvs_cmd_commit;
                    319: extern struct cvs_cmd cvs_cmd_diff;
                    320: extern struct cvs_cmd cvs_cmd_edit;
                    321: extern struct cvs_cmd cvs_cmd_editors;
                    322: extern struct cvs_cmd cvs_cmd_export;
                    323: extern struct cvs_cmd cvs_cmd_history;
                    324: extern struct cvs_cmd cvs_cmd_import;
                    325: extern struct cvs_cmd cvs_cmd_init;
                    326: extern struct cvs_cmd cvs_cmd_log;
                    327: extern struct cvs_cmd cvs_cmd_login;
                    328: extern struct cvs_cmd cvs_cmd_logout;
                    329: extern struct cvs_cmd cvs_cmd_rdiff;
                    330: extern struct cvs_cmd cvs_cmd_release;
                    331: extern struct cvs_cmd cvs_cmd_remove;
                    332: extern struct cvs_cmd cvs_cmd_rlog;
                    333: extern struct cvs_cmd cvs_cmd_rtag;
                    334: extern struct cvs_cmd cvs_cmd_status;
                    335: extern struct cvs_cmd cvs_cmd_tag;
                    336: extern struct cvs_cmd cvs_cmd_update;
                    337: extern struct cvs_cmd cvs_cmd_version;
                    338: extern struct cvs_cmd cvs_cmd_server;
                    339: extern struct cvs_cmd cvs_cmd_unedit;
                    340: extern struct cvs_cmd cvs_cmd_watch;
                    341: extern struct cvs_cmd cvs_cmd_watchers;
                    342:
                    343:
                    344: struct cvs_cmd* cvs_findcmd       (const char *);
                    345: struct cvs_cmd* cvs_findcmdbyreq  (int);
                    346: int             cvs_startcmd      (struct cvs_cmd *, int, char **);
                    347: int             cvs_server        (int, char **);
1.41      jfb       348:
                    349: int         cvs_var_set   (const char *, const char *);
                    350: int         cvs_var_unset (const char *);
                    351: const char* cvs_var_get   (const char *);
1.1       jfb       352:
                    353:
                    354: /* from root.c */
                    355: struct cvsroot*  cvsroot_parse (const char *);
                    356: void             cvsroot_free  (struct cvsroot *);
                    357: struct cvsroot*  cvsroot_get   (const char *);
1.2       jfb       358:
                    359:
1.1       jfb       360: /* Entries API */
1.3       jfb       361: CVSENTRIES*      cvs_ent_open   (const char *, int);
1.1       jfb       362: struct cvs_ent*  cvs_ent_get    (CVSENTRIES *, const char *);
                    363: struct cvs_ent*  cvs_ent_next   (CVSENTRIES *);
                    364: int              cvs_ent_add    (CVSENTRIES *, struct cvs_ent *);
1.5       jfb       365: int              cvs_ent_addln  (CVSENTRIES *, const char *);
1.1       jfb       366: int              cvs_ent_remove (CVSENTRIES *, const char *);
1.17      jfb       367: int              cvs_ent_write  (CVSENTRIES *);
1.1       jfb       368: struct cvs_ent*  cvs_ent_parse  (const char *);
                    369: void             cvs_ent_close  (CVSENTRIES *);
1.8       jfb       370: void             cvs_ent_free   (struct cvs_ent *);
                    371: struct cvs_ent*  cvs_ent_getent (const char *);
1.1       jfb       372:
                    373: /* history API */
                    374: CVSHIST*         cvs_hist_open    (const char *);
                    375: void             cvs_hist_close   (CVSHIST *);
                    376: int              cvs_hist_parse   (CVSHIST *);
                    377: struct cvs_hent* cvs_hist_getnext (CVSHIST *);
                    378: int              cvs_hist_append  (CVSHIST *, struct cvs_hent *);
                    379:
1.31      jfb       380: /* from logmsg.c */
                    381: char*  cvs_logmsg_open (const char *);
1.37      jfb       382: char*  cvs_logmsg_get  (const char *, struct cvs_flist *, struct cvs_flist *, struct cvs_flist *);
1.31      jfb       383: int    cvs_logmsg_send (struct cvsroot *, const char *);
1.1       jfb       384:
1.56      jfb       385:
                    386: time_t cvs_date_parse  (const char *);
1.28      jfb       387:
1.1       jfb       388: int    cvs_readrepo   (const char *, char *, size_t);
                    389: int    cvs_modetostr  (mode_t, char *, size_t);
                    390: int    cvs_strtomode  (const char *, mode_t *);
1.26      jfb       391: int    cvs_splitpath  (const char *, char *, size_t, char **);
1.59    ! joris     392: int    cvs_mkadmin    (const char *, const char *, const char *);
1.1       jfb       393: int    cvs_cksum      (const char *, char *, size_t);
                    394: int    cvs_exec       (int, char **, int []);
1.6       jfb       395: int    cvs_getargv    (const char *, char **, int);
1.55      joris     396: int    cvs_remove_dir (const char *);
1.34      jfb       397: char** cvs_makeargv   (const char *, int *);
1.6       jfb       398: void   cvs_freeargv   (char **, int);
1.1       jfb       399:
                    400:
                    401: #endif /* CVS_H */