1 /*****************************************************************************/
5 /* Handling of search paths */
9 /* (C) 2000-2010, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
36 /* Exports facilities to search files in a list of directories. */
45 /*****************************************************************************/
47 /*****************************************************************************/
51 /* A search path is a pointer to the list */
52 typedef struct Collection SearchPath;
56 /*****************************************************************************/
58 /*****************************************************************************/
62 SearchPath* NewSearchPath (void);
63 /* Create a new, empty search path list */
65 void AddSearchPath (SearchPath* P, const char* NewPath);
66 /* Add a new search path to the end of an existing list */
68 void AddSearchPathFromEnv (SearchPath* P, const char* EnvVar);
69 /* Add a search path from an environment variable to the end of an existing
73 void AddSubSearchPathFromEnv (SearchPath* P, const char* EnvVar, const char* SubDir);
74 /* Add a search path from an environment variable, adding a subdirectory to
75 * the environment variable value.
78 int PushSearchPath (SearchPath* P, const char* NewPath);
79 /* Add a new search path to the head of an existing search path list, provided
80 * that it's not already there. If the path is already at the first position,
81 * return zero, otherwise return a non zero value.
84 void PopSearchPath (SearchPath* P);
85 /* Remove a search path from the head of an existing search path list */
87 void ForgetSearchPath (SearchPath* P);
88 /* Forget all search paths in the given list */
90 char* SearchFile (const SearchPath* P, const char* File);
91 /* Search for a file in a list of directories. Return a pointer to a malloced
92 * area that contains the complete path, if found, return 0 otherwise.
97 /* End of searchpath.h */