Annotation of src/usr.bin/cvs/file.h, Revision 1.9
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 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:
35: struct cvs_file;
36: struct cvs_dir;
1.5 jfb 37: struct cvs_entries;
1.1 jfb 38:
39:
1.9 ! jfb 40: #define CVS_FILE_MAXDEPTH 32
! 41: #define CVS_FILE_NBUCKETS 256
! 42:
! 43:
! 44:
1.6 jfb 45: #define CF_STAT 0x01 /* obsolete */
1.3 jfb 46: #define CF_IGNORE 0x02 /* apply regular ignore rules */
47: #define CF_RECURSE 0x04 /* recurse on directory operations */
48: #define CF_SORT 0x08 /* all files are sorted alphabetically */
49: #define CF_KNOWN 0x10 /* only recurse in directories known to CVS */
50: #define CF_CREATE 0x20 /* create if file does not exist */
51: #define CF_MKADMIN 0x40 /* create administrative files if they're missing */
1.8 jfb 52: #define CF_NOSYMS 0x80 /* ignore symbolic links */
1.1 jfb 53:
54:
55: /*
56: * The cvs_file structure is used to represent any file or directory within
57: * the CVS tree's hierarchy. The <cf_path> field is a path relative to the
58: * directory in which the cvs command was executed. The <cf_parent> field
59: * points back to the parent node in the directory tree structure (it is
60: * NULL if the directory is at the wd of the command).
61: *
62: * The <cf_cvstat> field gives the file's status with regards to the CVS
63: * repository. The file can be in any one of the CVS_FST_* states.
64: * If the file's type is DT_DIR, then the <cf_ddat> pointer will point to
65: * a cvs_dir structure containing data specific to the directory (such as
66: * the contents of the directory's CVS/Entries, CVS/Root, etc.).
67: */
68:
69: #define CVS_FST_UNKNOWN 0
70: #define CVS_FST_UPTODATE 1
71: #define CVS_FST_MODIFIED 2
72: #define CVS_FST_ADDED 3
73: #define CVS_FST_REMOVED 4
74: #define CVS_FST_CONFLICT 5
75: #define CVS_FST_PATCHED 6
76:
1.9 ! jfb 77:
! 78: struct cvs_fname {
! 79: char *cf_name;
! 80: u_int cf_ref;
! 81: SLIST_ENTRY(cvs_fname) cf_list;
! 82: };
! 83:
1.1 jfb 84:
85: TAILQ_HEAD(cvs_flist, cvs_file);
86:
87:
88: typedef struct cvs_file {
1.9 ! jfb 89: struct cvs_file *cf_parent; /* parent directory (NULL if none) */
! 90: struct cvs_fname *cf_name;
! 91: mode_t cf_mode;
! 92: time_t cf_mtime;
! 93: u_int16_t cf_cvstat; /* cvs status of the file */
! 94: u_int16_t cf_type; /* uses values from dirent.h */
! 95: struct cvs_dir *cf_ddat; /* only for directories */
1.1 jfb 96:
97: TAILQ_ENTRY(cvs_file) cf_list;
98: } CVSFILE;
99:
1.9 ! jfb 100: #define CVS_FILE_NAME(cf) (cf->cf_name->cf_name)
1.1 jfb 101:
1.8 jfb 102:
103: #define CVS_DIRF_STATIC 0x01
104: #define CVS_DIRF_STICKY 0x02
105:
106:
1.1 jfb 107: struct cvs_dir {
1.5 jfb 108: struct cvsroot *cd_root;
109: char *cd_repo;
110: struct cvs_entries *cd_ent;
111: struct cvs_flist cd_files;
1.9 ! jfb 112: u_int16_t cd_nfiles;
! 113: u_int16_t cd_flags;
1.1 jfb 114: };
115:
1.2 jfb 116:
1.3 jfb 117: #define CVS_DIR_ROOT(f) (((f)->cf_type == DT_DIR) ? \
1.2 jfb 118: (f)->cf_ddat->cd_root : (((f)->cf_parent == NULL) ? \
119: NULL : (f)->cf_parent->cf_ddat->cd_root))
120:
1.3 jfb 121: #define CVS_DIR_ENTRIES(f) (((f)->cf_type == DT_DIR) ? \
122: (f)->cf_ddat->cd_ent : (((f)->cf_parent == NULL) ? \
123: NULL : (f)->cf_parent->cf_ddat->cd_ent))
124:
125: #define CVS_DIR_REPO(f) (((f)->cf_type == DT_DIR) ? \
126: (f)->cf_ddat->cd_repo : (((f)->cf_parent == NULL) ? \
127: NULL : (f)->cf_parent->cf_ddat->cd_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.2 jfb 135: CVSFILE* cvs_file_find (CVSFILE *, const char *);
1.7 jfb 136: int cvs_file_attach (CVSFILE *, CVSFILE *);
1.9 ! jfb 137: char* cvs_file_getpath (CVSFILE *, char *, size_t);
1.2 jfb 138: int cvs_file_examine (CVSFILE *, int (*)(CVSFILE *, void *), void *);
1.9 ! jfb 139: void cvs_file_free (CVSFILE *);
1.1 jfb 140:
141:
142: #endif /* FILE_H */