1/*****************************************************************************/
2/* */
3/* searchpath.h */
4/* */
5/* Handling of search paths */
6/* */
7/* */
8/* */
9/* (C) 2000-2013, Ullrich von Bassewitz */
10/* Roemerstrasse 52 */
11/* D-70794 Filderstadt */
12/* EMail: uz@cc65.org */
13/* */
14/* */
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. */
18/* */
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: */
22/* */
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 */
30/* distribution. */
31/* */
32/*****************************************************************************/
33
34
35
36/* Exports facilities to search files in a list of directories. */
37
38
39
40#ifndef SEARCHPATH_H
41#define SEARCHPATH_H
42
43
44
45/*****************************************************************************/
46/* Data */
47/*****************************************************************************/
48
49
50
51/* Convert argument to C string */
52#define _STRINGIZE(arg) #arg
53#define STRINGIZE(arg) _STRINGIZE(arg)
54
55/* A search path is a pointer to the list */
56typedef struct Collection SearchPaths;
57
58
59
60/*****************************************************************************/
61/* Code */
62/*****************************************************************************/
63
64
65
66SearchPaths* NewSearchPath (void);
67/* Create a new, empty search path list */
68
69void AddSearchPath (SearchPaths* P, const char* NewPath);
70/* Add a new search path to the end of an existing list */
71
72void AddSearchPathFromEnv (SearchPaths* P, const char* EnvVar);
73/* Add a search path from an environment variable to the end of an existing
74** list.
75*/
76
77void AddSubSearchPathFromEnv (SearchPaths* P, const char* EnvVar, const char* SubDir);
78/* Add a search path from an environment variable, adding a subdirectory to
79** the environment variable value.
80*/
81
82void AddSubSearchPathFromWinBin (SearchPaths* P, const char* SubDir);
83/* Windows only:
84** Add a search path from the running binary, adding a subdirectory to
85** the parent directory of the directory containing the binary.
86*/
87
88int PushSearchPath (SearchPaths* P, const char* NewPath);
89/* Add a new search path to the head of an existing search path list, provided
90** that it's not already there. If the path is already at the first position,
91** return zero, otherwise return a non zero value.
92*/
93
94void PopSearchPath (SearchPaths* P);
95/* Remove a search path from the head of an existing search path list */
96
97char* GetSearchPath (SearchPaths* P, unsigned Index);
98/* Return the search path at the given index, if the index is valid, return an
99** empty string otherwise.
100*/
101
102char* SearchFile (const SearchPaths* P, const char* File);
103/* Search for a file in a list of directories. Return a pointer to a malloced
104** area that contains the complete path, if found, return 0 otherwise.
105*/
106
107
108
109/* End of searchpath.h */
110
111#endif
112