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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                               searchpath.h                                */
   4 /*                                                                           */
   5 /*                    Search path path handling for ld65                     */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2009, 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. 8 of these
  37  * lists are managed, and each list can contain an arbitrary number of
  38  * directories. The "Where" argument is actually a bitset, specifying which
  39  * of the search lists should be used when adding paths or searching files.
  40  */
  41
  42
  43
  44 #ifndef SEARCHPATH_H
  45 #define SEARCHPATH_H
  46
  47
  48
  49 /*****************************************************************************/
  50 /*                                   Data                                    */
  51 /*****************************************************************************/
  52
  53
  54
  55 /* Maximum number of search paths */
  56 #define MAX_SEARCH_PATHS        8
  57
  58
  59
  60 /*****************************************************************************/
  61 /*                                   Code                                    */
  62 /*****************************************************************************/
  63
  64
  65
  66 void AddSearchPath (const char* NewPath, unsigned Where);
  67 /* Add a new search path to the existing one */
  68
  69 void AddSearchPathFromEnv (const char* EnvVar, unsigned Where);
  70 /* Add a search path from an environment variable */
  71
  72 void AddSubSearchPathFromEnv (const char* EnvVar, const char* SubDir, unsigned Where);
  73 /* Add a search path from an environment variable, adding a subdirectory to
  74  * the environment variable value.
  75  */
  76
  77 void ForgetAllSearchPaths (unsigned Where);
  78 /* Forget all search paths in the given lists. */
  79
  80 char* SearchFile (const char* Name, unsigned Where);
  81 /* Search for a file in a list of directories. Return a pointer to a malloced
  82  * area that contains the complete path, if found, return 0 otherwise.
  83  */
  84
  85
  86
  87 /* End of searchpath.h */
  88 #endif
  89
  90
  91