Annotation of src/usr.bin/cvs/file.h, Revision 1.29
1.29 ! niallo 1: /* $OpenBSD: file.h,v 1.28 2005/08/17 16:23:19 joris 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.26 xsa 41: #define CVS_FILE_MAXDEPTH 32
1.9 jfb 42:
43:
1.26 xsa 44: #define CF_STAT 0x01 /* obsolete */
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 admin files if they're missing */
51: #define CF_NOSYMS 0x80 /* ignore symbolic links */
52: #define CF_NOFILES 0x100 /* don't load any files inside a directory */
1.1 jfb 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: */
1.26 xsa 64: #define CVS_FST_UNKNOWN 0 /* Unknown */
65: #define CVS_FST_UPTODATE 1 /* Up-to-date */
66: #define CVS_FST_MODIFIED 2 /* Locally Modified */
67: #define CVS_FST_ADDED 3 /* Locally Added */
68: #define CVS_FST_REMOVED 4 /* Locally Removed */
69: #define CVS_FST_CONFLICT 5 /* Unresolved Conflict */
70: #define CVS_FST_PATCHED 6
71: #define CVS_FST_LOST 7 /* Needs Checkout */
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.26 xsa 77: struct cvs_file *cf_parent; /* parent directory (NULL if none) */
1.25 joris 78:
79: /*
80: * cf_name contains the basename of the fullpath
81: * cf_dir contains the parent directory the file or dir is in.
82: * if cf_dir is NULL the file is in the parent directory.
83: */
1.29 ! niallo 84: char *cf_name;
! 85: char *cf_dir;
1.25 joris 86:
1.28 joris 87: /* pointer to the parent directory's entry file */
88: void *cf_entry;
89:
1.26 xsa 90: mode_t cf_mode;
91: u_int8_t cf_cvstat; /* cvs status of the file */
92: u_int8_t cf_type; /* uses values from dirent.h */
93: u_int16_t cf_flags;
1.16 jfb 94:
95: union {
96: struct {
1.26 xsa 97: RCSNUM *cd_lrev; /* local revision */
98: time_t cd_etime; /* time in Entries file */
99: time_t cd_mtime;
100: char *cd_tag;
101: char *cd_opts;
1.16 jfb 102: } cf_reg;
103: struct {
1.26 xsa 104: char *cd_repo;
105: struct cvsroot *cd_root;
106: struct cvs_flist cd_files;
1.16 jfb 107: } cf_dir;
108: } cf_td;
1.1 jfb 109:
1.26 xsa 110: SIMPLEQ_ENTRY(cvs_file) cf_list;
1.1 jfb 111: } CVSFILE;
112:
1.16 jfb 113: /* only valid for regular files */
1.26 xsa 114: #define cf_etime cf_td.cf_reg.cd_etime
115: #define cf_mtime cf_td.cf_reg.cd_mtime
116: #define cf_lrev cf_td.cf_reg.cd_lrev
117: #define cf_tag cf_td.cf_reg.cd_tag
118: #define cf_opts cf_td.cf_reg.cd_opts
1.16 jfb 119:
120: /* only valid for directories */
1.26 xsa 121: #define cf_files cf_td.cf_dir.cd_files
122: #define cf_repo cf_td.cf_dir.cd_repo
123: #define cf_root cf_td.cf_dir.cd_root
1.1 jfb 124:
1.8 jfb 125:
1.26 xsa 126: #define CVS_DIRF_STATIC 0x01
127: #define CVS_DIRF_STICKY 0x02
128: #define CVS_DIRF_BASE 0x04
1.27 joris 129: #define CVS_FILE_ONDISK 0x08
1.8 jfb 130:
1.13 jfb 131: #define CVS_DIR_ROOT(f) ((((f)->cf_type == DT_DIR) && \
1.16 jfb 132: ((f)->cf_root != NULL)) ? (f)->cf_root : \
133: (((f)->cf_parent == NULL) ? NULL : (f)->cf_parent->cf_root))
1.3 jfb 134:
135: #define CVS_DIR_REPO(f) (((f)->cf_type == DT_DIR) ? \
1.16 jfb 136: (f)->cf_repo : (((f)->cf_parent == NULL) ? \
137: NULL : (f)->cf_parent->cf_repo))
1.2 jfb 138:
1.26 xsa 139: int cvs_file_init(void);
140: int cvs_file_ignore(const char *);
141: int cvs_file_chkign(const char *);
142: int cvs_file_get(const char *, int, int (*)(CVSFILE *, void *),
143: void *, struct cvs_flist *);
144: int cvs_file_getspec(char **, int, int, int (*)(CVSFILE *, void *),
145: void *, struct cvs_flist *);
146: CVSFILE *cvs_file_loadinfo(char *, int, int (*)(CVSFILE *, void *), void *,
147: int);
148:
149: CVSFILE *cvs_file_create(CVSFILE *, const char *, u_int, mode_t);
150: CVSFILE *cvs_file_copy(CVSFILE *);
151: int cvs_file_attach(CVSFILE *, CVSFILE *);
152: int cvs_file_examine(CVSFILE *, int (*)(CVSFILE *, void *), void *);
153:
154: int cvs_file_init(void);
155: int cvs_file_ignore(const char *);
156: int cvs_file_chkign(const char *);
157: CVSFILE *cvs_file_load(const char *, int);
158: CVSFILE *cvs_file_find(CVSFILE *, const char *);
159: char *cvs_file_getpath(CVSFILE *, char *, size_t);
160: void cvs_file_free(CVSFILE *);
161: int cvs_file_prune(char *);
1.1 jfb 162:
1.26 xsa 163: #endif /* FILE_H */