Annotation of src/usr.bin/make/dir.h, Revision 1.26
1.15 espie 1: #ifndef DIR_H
2: #define DIR_H
3:
1.26 ! espie 4: /* $OpenBSD: dir.h,v 1.25 2010/07/19 19:30:37 espie Exp $ */
1.14 espie 5: /* $NetBSD: dir.h,v 1.4 1996/11/06 17:59:05 christos Exp $ */
1.1 deraadt 6:
7: /*
8: * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
9: * Copyright (c) 1988, 1989 by Adam de Boor
10: * Copyright (c) 1989 by Berkeley Softworks
11: * All rights reserved.
12: *
13: * This code is derived from software contributed to Berkeley by
14: * Adam de Boor.
15: *
16: * Redistribution and use in source and binary forms, with or without
17: * modification, are permitted provided that the following conditions
18: * are met:
19: * 1. Redistributions of source code must retain the above copyright
20: * notice, this list of conditions and the following disclaimer.
21: * 2. Redistributions in binary form must reproduce the above copyright
22: * notice, this list of conditions and the following disclaimer in the
23: * documentation and/or other materials provided with the distribution.
1.16 millert 24: * 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 25: * may be used to endorse or promote products derived from this software
26: * without specific prior written permission.
27: *
28: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38: * SUCH DAMAGE.
39: *
1.14 espie 40: * from: @(#)dir.h 8.1 (Berkeley) 6/6/93
1.1 deraadt 41: */
42:
1.15 espie 43: #ifndef TIMESTAMP_TYPE
44: #include "timestamp_t.h"
45: #endif
46:
47: /* dir --
48: * Directory searching using wildcards and/or normal names...
49: * Used both for source wildcarding in the Makefile and for finding
50: * implicit sources.
51: */
52:
53: /* Dir_Init()
54: * Initialize the module.
55: */
56: extern void Dir_Init(void);
57:
58: /* Dir_End()
59: * Cleanup the module.
60: */
61: #ifdef CLEANUP
62: extern void Dir_End(void);
63: #else
64: #define Dir_End()
65: #endif
66:
67: /*
68: * Manipulating paths. By convention, the empty path always allows for
69: * finding files in the current directory.
70: */
71:
72: /* Dir_AddDiri(path, name, end);
73: * Add directory (name, end) to a search path.
74: */
75: extern void Dir_AddDiri(Lst, const char *, const char *);
76: #define Dir_AddDir(l, n) Dir_AddDiri(l, n, NULL)
77:
78: /* Dir_Concat(p1, p2);
79: * Concatenate two paths, adding dirs in p2 to the end of p1, but
80: * avoiding duplicates.
81: */
82: extern void Dir_Concat(Lst, Lst);
83:
1.22 espie 84: /* Dir_Destroy(d);
85: * Destroy a directory in a search path.
1.15 espie 86: */
87: extern void Dir_Destroy(void *);
88:
89: /* p2 = Dir_CopyDir(p);
90: * Return a copy of a directory. Callback to duplicate search paths.
1.1 deraadt 91: */
1.15 espie 92: extern void *Dir_CopyDir(void *);
93:
94: /* Dir_PrintPath(p);
95: * Print the directory names along a given path.
96: */
97: extern void Dir_PrintPath(Lst);
98:
1.1 deraadt 99:
1.15 espie 100: /*
101: * Handling file names, and looking them up in paths
102: */
103:
1.17 espie 104: /* fullname = Dir_FindFileComplexi(name, end, path, checkCurdirFirst)
1.22 espie 105: * Searches for a file (name, end) on a given search path. If it exists,
1.15 espie 106: * return the fullname of the file, otherwise NULL.
107: * The fullname is always a copy, and the caller is responsible for
108: * free()ing it.
1.17 espie 109: * Looking for a simple name always looks in the current directory,
110: * unless checkCurdirFirst is false.
1.15 espie 111: * For complex names, the current directory search only occurs for
112: * paths with dot in them.
113: */
1.17 espie 114: extern char *Dir_FindFileComplexi(const char *, const char *, Lst, bool);
115: #define Dir_FindFilei(n, e, p) Dir_FindFileComplexi(n, e, p, true)
116: #define Dir_FindFileNoDoti(n, e, p) Dir_FindFileComplexi(n, e, p, false)
117: #define Dir_FindFile(n, p) Dir_FindFilei(n, strchr(n, '\0'), p)
118: #define Dir_FindFileNoDot(n, p) Dir_FindFileNoDoti(n, strchr(n, '\0'), p)
1.15 espie 119:
120: /* stamp = Dir_MTime(gn);
121: * Return the modification time of node gn, searching along
1.22 espie 122: * the default search path.
1.15 espie 123: * Side effect: the path and mtime fields of gn are filled in.
124: * Return specific value if file can't be found, to be tested by
125: * is_out_of_date().
126: */
1.14 espie 127: extern TIMESTAMP Dir_MTime(GNode *);
1.15 espie 128:
129:
130:
131:
1.22 espie 132: /*
1.15 espie 133: * Misc
134: */
135:
136: /* string = Dir_MakeFlags(flag, path);
1.22 espie 137: * Given a search path and a command flag, create a string with each
138: * of the directories in the path preceded by the command flag and all
1.15 espie 139: * of them separated by spaces.
140: */
1.14 espie 141: extern char *Dir_MakeFlags(const char *, Lst);
1.15 espie 142:
143:
144: /* List of directories to search when looking for targets. */
1.23 espie 145: extern Lst defaultPath;
1.1 deraadt 146:
1.18 espie 147:
148: /* communication between dir.c and direxpand.c */
1.19 espie 149: struct PathEntry;
150: extern struct PathEntry *dot;
1.18 espie 151: /* Handles wildcard expansion on a given directory. */
1.22 espie 152: extern void Dir_MatchFilesi(const char *, const char *, struct PathEntry *,
1.18 espie 153: Lst);
1.24 espie 154: extern char *PathEntry_name(struct PathEntry *);
1.14 espie 155: #endif /* DIR_H */