Annotation of src/usr.bin/cvs/file.h, Revision 1.17
1.17 ! joris 1: /* $OpenBSD: file.h,v 1.16 2005/04/18 21:02:50 jfb Exp $ */
1.1 jfb 2: /*
3: * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
1.11 tedu 4: * All rights reserved.
1.1 jfb 5: *
1.11 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.11 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.11 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.11 tedu 24: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 jfb 25: */
26:
27: #ifndef FILE_H
28: #define FILE_H
29:
30: #include <sys/param.h>
1.3 jfb 31:
1.1 jfb 32: #include <dirent.h>
1.9 jfb 33: #include <search.h>
1.1 jfb 34:
1.16 jfb 35: #include "rcs.h"
36:
1.1 jfb 37: struct cvs_file;
1.5 jfb 38: struct cvs_entries;
1.1 jfb 39:
40:
1.9 jfb 41: #define CVS_FILE_MAXDEPTH 32
42:
43:
1.6 jfb 44: #define CF_STAT 0x01 /* obsolete */
1.3 jfb 45: #define CF_IGNORE 0x02 /* apply regular ignore rules */
46: #define CF_RECURSE 0x04 /* recurse on directory operations */
47: #define CF_SORT 0x08 /* all files are sorted alphabetically */
48: #define CF_KNOWN 0x10 /* only recurse in directories known to CVS */
49: #define CF_CREATE 0x20 /* create if file does not exist */
50: #define CF_MKADMIN 0x40 /* create administrative files if they're missing */
1.8 jfb 51: #define CF_NOSYMS 0x80 /* ignore symbolic links */
1.1 jfb 52:
53:
54: /*
55: * The cvs_file structure is used to represent any file or directory within
56: * the CVS tree's hierarchy. The <cf_path> field is a path relative to the
57: * directory in which the cvs command was executed. The <cf_parent> field
58: * points back to the parent node in the directory tree structure (it is
59: * NULL if the directory is at the wd of the command).
60: *
61: * The <cf_cvstat> field gives the file's status with regards to the CVS
62: * repository. The file can be in any one of the CVS_FST_* states.
63: */
64: #define CVS_FST_UNKNOWN 0
65: #define CVS_FST_UPTODATE 1
66: #define CVS_FST_MODIFIED 2
67: #define CVS_FST_ADDED 3
68: #define CVS_FST_REMOVED 4
69: #define CVS_FST_CONFLICT 5
70: #define CVS_FST_PATCHED 6
1.12 jfb 71: #define CVS_FST_LOST 7
1.1 jfb 72:
1.11 tedu 73:
1.16 jfb 74: SIMPLEQ_HEAD(cvs_flist, cvs_file);
1.1 jfb 75:
76: typedef struct cvs_file {
1.9 jfb 77: struct cvs_file *cf_parent; /* parent directory (NULL if none) */
1.15 jfb 78: char *cf_name;
1.9 jfb 79: mode_t cf_mode;
1.16 jfb 80: u_int8_t cf_cvstat; /* cvs status of the file */
81: u_int8_t cf_type; /* uses values from dirent.h */
82: u_int16_t cf_flags;
83:
84: union {
85: struct {
86: RCSNUM *cd_lrev; /* local revision */
87: time_t cd_mtime;
88: char *cd_tag;
89: char *cd_opts;
90: } cf_reg;
91: struct {
92: char *cd_repo;
93: struct cvsroot *cd_root;
94: struct cvs_flist cd_files;
95: } cf_dir;
96: } cf_td;
1.1 jfb 97:
1.16 jfb 98: SIMPLEQ_ENTRY(cvs_file) cf_list;
1.1 jfb 99: } CVSFILE;
100:
1.16 jfb 101: /* only valid for regular files */
102: #define cf_mtime cf_td.cf_reg.cd_mtime
103: #define cf_lrev cf_td.cf_reg.cd_lrev
104: #define cf_tag cf_td.cf_reg.cd_tag
105:
106: /* only valid for directories */
107: #define cf_files cf_td.cf_dir.cd_files
108: #define cf_repo cf_td.cf_dir.cd_repo
109: #define cf_root cf_td.cf_dir.cd_root
110:
1.15 jfb 111: #define CVS_FILE_NAME(cf) (cf->cf_name)
112:
1.1 jfb 113:
1.8 jfb 114:
115: #define CVS_DIRF_STATIC 0x01
116: #define CVS_DIRF_STICKY 0x02
1.14 joris 117: #define CVS_DIRF_BASE 0x04
1.17 ! joris 118:
! 119: #define CVS_GDIR_IGNORE 0x08
1.8 jfb 120:
1.13 jfb 121: #define CVS_DIR_ROOT(f) ((((f)->cf_type == DT_DIR) && \
1.16 jfb 122: ((f)->cf_root != NULL)) ? (f)->cf_root : \
123: (((f)->cf_parent == NULL) ? NULL : (f)->cf_parent->cf_root))
1.3 jfb 124:
125: #define CVS_DIR_REPO(f) (((f)->cf_type == DT_DIR) ? \
1.16 jfb 126: (f)->cf_repo : (((f)->cf_parent == NULL) ? \
127: NULL : (f)->cf_parent->cf_repo))
1.2 jfb 128:
1.1 jfb 129: int cvs_file_init (void);
130: int cvs_file_ignore (const char *);
131: int cvs_file_chkign (const char *);
132: CVSFILE* cvs_file_get (const char *, int);
133: CVSFILE* cvs_file_getspec (char **, int, int);
1.9 jfb 134: CVSFILE* cvs_file_create (CVSFILE *, const char *, u_int, mode_t);
1.10 jfb 135: CVSFILE* cvs_file_copy (CVSFILE *);
1.2 jfb 136: CVSFILE* cvs_file_find (CVSFILE *, const char *);
1.7 jfb 137: int cvs_file_attach (CVSFILE *, CVSFILE *);
1.9 jfb 138: char* cvs_file_getpath (CVSFILE *, char *, size_t);
1.2 jfb 139: int cvs_file_examine (CVSFILE *, int (*)(CVSFILE *, void *), void *);
1.9 jfb 140: void cvs_file_free (CVSFILE *);
1.1 jfb 141:
142:
143: #endif /* FILE_H */