git.sur5r.net Git - cc65/blob - src/common/searchpath.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                               searchpath.h                                */
   4 /*                                                                           */
   5 /*                         Handling of search paths                          */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2010, 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 /* A search path is a pointer to the list */
  52 typedef struct Collection SearchPath;
  53
  54
  55
  56 /*****************************************************************************/
  57 /*                                   Code                                    */
  58 /*****************************************************************************/
  59
  60
  61
  62 SearchPath* NewSearchPath (void);
  63 /* Create a new, empty search path list */
  64
  65 void AddSearchPath (SearchPath* P, const char* NewPath);
  66 /* Add a new search path to the end of an existing list */
  67
  68 void AddSearchPathFromEnv (SearchPath* P, const char* EnvVar);
  69 /* Add a search path from an environment variable to the end of an existing
  70  * list.
  71  */
  72
  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.
  76  */
  77
  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.
  82  */
  83
  84 void PopSearchPath (SearchPath* P);
  85 /* Remove a search path from the head of an existing search path list */
  86
  87 void ForgetSearchPath (SearchPath* P);
  88 /* Forget all search paths in the given list */
  89
  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.
  93  */
  94
  95
  96
  97 /* End of searchpath.h */
  98 #endif
  99
 100
 101