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

Annotation of src/usr.bin/cvs/rcs.h, Revision 1.16

1.16    ! jfb         1: /*     $OpenBSD: rcs.h,v 1.15 2005/03/05 18:25:30 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:
1.14      jfb        41: #define RCSDIR         "RCS"
1.1       jfb        42: #define RCS_FILE_EXT   ",v"
                     43:
                     44: #define RCS_HEAD_INIT  "1.1"
                     45:
1.12      jfb        46:
                     47: /* lock types */
                     48: #define RCS_LOCK_LOOSE    0
                     49: #define RCS_LOCK_STRICT   1
                     50:
                     51:
1.6       jfb        52: /* RCS keyword expansion modes (kflags) */
                     53: #define RCS_KWEXP_NONE     0x00
                     54: #define RCS_KWEXP_NAME     0x01                /* include keyword name */
                     55: #define RCS_KWEXP_VAL      0x02                /* include keyword value */
                     56: #define RCS_KWEXP_LKR      0x04                /* include name of locker */
                     57: #define RCS_KWEXP_OLD      0x08                /* generate old keyword string */
                     58: #define RCS_KWEXP_ERR      0x10                /* mode has an error */
                     59:
                     60: #define RCS_KWEXP_DEFAULT  (RCS_KWEXP_NAME | RCS_KWEXP_VAL)
                     61: #define RCS_KWEXP_KVL      (RCS_KWEXP_NAME | RCS_KWEXP_VAL | RCS_KWEXP_LKR)
                     62:
1.9       jfb        63: #define RCS_KWEXP_INVAL(k) \
1.13      jfb        64:        ((k & RCS_KWEXP_ERR) || \
                     65:        ((k & RCS_KWEXP_OLD) && (RCS_KWEXP_OLD & ~RCS_KWEXP_OLD)))
1.9       jfb        66:
1.6       jfb        67:
                     68:
                     69: #define RCSNUM_MAXNUM  USHRT_MAX
                     70: #define RCSNUM_MAXLEN  64
                     71:
1.1       jfb        72:
                     73: /* file flags */
1.9       jfb        74: #define RCS_READ    0x01
                     75: #define RCS_WRITE   0x02
                     76: #define RCS_RDWR    (RCS_READ|RCS_WRITE)
                     77: #define RCS_CREATE  0x04                       /* create the file */
                     78:
                     79: /* internal flags */
                     80: #define RCS_PARSED  0x010000   /* file has been parsed */
                     81: #define RCS_SYNCED  0x020000   /* in-memory copy is in sync with disk copy */
                     82: #define RCS_SLOCK   0x040000   /* strict lock */
1.1       jfb        83:
                     84: /* delta flags */
                     85: #define RCS_RD_DEAD   0x01     /* dead */
1.5       jfb        86:
1.14      jfb        87: /* RCS error codes */
                     88: #define RCS_ERR_NOERR    0
                     89: #define RCS_ERR_NOENT    1
                     90: #define RCS_ERR_DUPENT   2
                     91: #define RCS_ERR_BADNUM   3
                     92:
1.5       jfb        93:
1.1       jfb        94: typedef struct rcs_num {
                     95:        u_int      rn_len;
                     96:        u_int16_t *rn_id;
                     97: } RCSNUM;
                     98:
                     99:
1.11      jfb       100: struct rcs_access {
                    101:        char    *ra_name;
                    102:        uid_t    ra_uid;
                    103:        TAILQ_ENTRY(rcs_access) ra_list;
                    104: };
                    105:
1.1       jfb       106: struct rcs_sym {
                    107:        char    *rs_name;
                    108:        RCSNUM  *rs_num;
                    109:        TAILQ_ENTRY(rcs_sym) rs_list;
                    110: };
                    111:
                    112: struct rcs_lock {
                    113:        RCSNUM   *rl_num;
                    114:
                    115:        TAILQ_ENTRY(rcs_lock) rl_list;
                    116: };
                    117:
                    118:
                    119: struct rcs_branch {
                    120:        RCSNUM  *rb_num;
                    121:        TAILQ_ENTRY(rcs_branch) rb_list;
                    122: };
                    123:
                    124: struct rcs_dlist {
                    125:        struct rcs_delta *tqh_first;
                    126:        struct rcs_delta **tqh_last;
                    127: };
                    128:
                    129: struct rcs_delta {
                    130:        RCSNUM      *rd_num;
                    131:        RCSNUM      *rd_next;
                    132:        u_int        rd_flags;
                    133:        struct tm    rd_date;
                    134:        char        *rd_author;
                    135:        char        *rd_state;
                    136:        char        *rd_log;
                    137:        char        *rd_text;
                    138:
                    139:        struct rcs_dlist rd_snodes;
                    140:
                    141:        TAILQ_HEAD(, rcs_branch) rd_branches;
                    142:        TAILQ_ENTRY(rcs_delta)  rd_list;
                    143: };
                    144:
                    145:
                    146: typedef struct rcs_file {
                    147:        char   *rf_path;
                    148:        u_int   rf_ref;
1.9       jfb       149:        mode_t  rf_mode;
1.1       jfb       150:        u_int   rf_flags;
                    151:
                    152:        RCSNUM *rf_head;
                    153:        RCSNUM *rf_branch;
                    154:        char   *rf_comment;
                    155:        char   *rf_expand;
                    156:        char   *rf_desc;
                    157:
1.9       jfb       158:        u_int   rf_ndelta;
1.11      jfb       159:        struct rcs_dlist                  rf_delta;
                    160:        TAILQ_HEAD(rcs_alist, rcs_access) rf_access;
                    161:        TAILQ_HEAD(rcs_slist, rcs_sym)    rf_symbols;
                    162:        TAILQ_HEAD(rcs_llist, rcs_lock)   rf_locks;
1.9       jfb       163:
1.1       jfb       164:
                    165:        void   *rf_pdata;
                    166: } RCSFILE;
                    167:
                    168:
1.14      jfb       169: extern int rcs_errno;
                    170:
                    171:
1.16    ! jfb       172: RCSFILE*      rcs_open          (const char *, int, ...);
        !           173: void          rcs_close         (RCSFILE *);
        !           174: const RCSNUM* rcs_branch_get    (RCSFILE *);
        !           175: int           rcs_branch_set    (RCSFILE *, const RCSNUM *);
        !           176: int           rcs_access_add    (RCSFILE *, const char *);
        !           177: int           rcs_access_remove (RCSFILE *, const char *);
        !           178: int           rcs_access_check  (RCSFILE *, const char *);
        !           179: int           rcs_sym_add       (RCSFILE *, const char *, RCSNUM *);
        !           180: int           rcs_sym_remove    (RCSFILE *, const char *);
        !           181: RCSNUM*       rcs_sym_getrev    (RCSFILE *, const char *);
        !           182: int           rcs_lock_getmode  (RCSFILE *);
        !           183: int           rcs_lock_setmode  (RCSFILE *, int);
        !           184: BUF*          rcs_getrev        (RCSFILE *, RCSNUM *);
        !           185: BUF*          rcs_gethead       (RCSFILE *);
        !           186: RCSNUM*       rcs_getrevbydate  (RCSFILE *, struct tm *);
        !           187: const char*   rcs_desc_get      (RCSFILE *);
        !           188: int           rcs_desc_set      (RCSFILE *, const char *);
        !           189: const char*   rcs_comment_get   (RCSFILE *);
        !           190: int           rcs_comment_set   (RCSFILE *, const char *);
        !           191: int           rcs_kwexp_set     (RCSFILE *, int);
        !           192: int           rcs_kwexp_get     (RCSFILE *);
        !           193: const char*   rcs_errstr        (int);
1.6       jfb       194:
                    195: int       rcs_kflag_get    (const char *);
1.7       jfb       196: void      rcs_kflag_usage  (void);
1.9       jfb       197: int       rcs_kw_expand    (RCSFILE *, u_char *, size_t, size_t *);
1.1       jfb       198:
                    199: BUF*      rcs_patch     (const char *, const char *);
                    200: size_t    rcs_stresc    (int, const char *, char *, size_t *);
                    201:
                    202: RCSNUM*   rcsnum_alloc  (void);
1.8       jfb       203: RCSNUM*   rcsnum_parse  (const char *);
1.1       jfb       204: void      rcsnum_free   (RCSNUM *);
                    205: int       rcsnum_aton   (const char *, char **, RCSNUM *);
                    206: char*     rcsnum_tostr  (const RCSNUM *, char *, size_t);
                    207: int       rcsnum_cpy    (const RCSNUM *, RCSNUM *, u_int);
                    208: int       rcsnum_cmp    (const RCSNUM *, const RCSNUM *, u_int);
                    209:
1.3       jfb       210: /* from cache.c */
                    211: int       rcs_cache_init    (u_int);
                    212: RCSFILE  *rcs_cache_fetch   (const char *path);
                    213: int       rcs_cache_store   (RCSFILE *);
                    214: void      rcs_cache_destroy (void);
1.1       jfb       215:
                    216: #endif /* RCS_H */