include/common/SC_DirUtils.h

   1 /*
   2  *  Copyright (c) 2005 Tim Walters. All rights reserved.
   3  *  Created by Tim Walters on 10/19/05.
   4  *
   5  *  This program is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU General Public License as
   7  *  published by the Free Software Foundation; either version 2 of the
   8  *  License, or (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful, but
  11  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  18  *  USA
  19  *
  20  */
  21
  22 #ifndef SC_DIR_UTILS_H_INCLUDED
  23 #define SC_DIR_UTILS_H_INCLUDED
  24
  25 #include <limits.h>
  26 #include <stdio.h>
  27
  28 #ifdef _WIN32
  29 # include <stdio.h>
  30 # ifndef PATH_MAX
  31 #  define PATH_MAX _MAX_PATH
  32 # endif
  33 # include <string.h>
  34 # define snprintf _snprintf
  35 #endif
  36
  37 #include <boost/algorithm/string.hpp>
  38
  39 static inline bool stringCaseCompare(const char * a, const char * b)
  40 {
  41 #if _POSIX_VERSION >= 200112L
  42         return strcasecmp(a, b) == 0;
  43 #else
  44         return boost::iequals(a, b);
  45 #endif
  46 }
  47
  48
  49 # ifndef MAXPATHLEN
  50 #  define MAXPATHLEN PATH_MAX
  51 # endif
  52
  53 #ifdef _WIN32
  54 #define SC_PATH_DELIMITER "\\"
  55 #else
  56 #define SC_PATH_DELIMITER "/"
  57 #endif
  58
  59 // General path utilities
  60
  61 // Add 'component' to 'path' using the platform path separator.
  62 void sc_AppendToPath(char *path, size_t max_size, const char *component);
  63
  64 // Returns the expanded path with users home directory (also in newpath2)
  65 char *sc_StandardizePath(const char *path, char *newpath2);
  66
  67 // Return TRUE iff 'path' is a symbolic link.
  68 bool sc_IsSymlink(const char *path);
  69
  70 // Return TRUE iff 'dirname' is an existing directory.
  71 bool sc_DirectoryExists(const char *dirname);
  72
  73 // Returns TRUE iff 'name' is a directory pertaining to another platform.
  74 bool sc_IsNonHostPlatformDir(const char *name);
  75
  76 // Returns TRUE iff 'name' is to be ignored during compilation.
  77 bool sc_SkipDirectory(const char *name);
  78
  79 int sc_ResolveIfAlias(const char *path, char *returnPath, bool &isAlias, int length);
  80
  81 extern const char * gIdeName; // string used for conditional compilation according to which IDE is in use this session.
  82 // for example, if the value is "scapp" then folders "scide_scapp" will be included, all other "scide_*" excluded.
  83
  84 // Support for Bundles
  85
  86 void sc_GetResourceDirectory(char* pathBuf, int length);
  87 bool sc_IsStandAlone();
  88
  89 #if defined(__APPLE__) && !defined(SC_IPHONE)   // running on OS X
  90 void sc_AppendBundleName(char *str, int size);
  91 #endif
  92 // Support for Extensions
  93
  94 // Get the user home directory.
  95 void sc_GetUserHomeDirectory(char *str, int size);
  96
  97 // Get the System level data directory.
  98 void sc_GetSystemAppSupportDirectory(char *str, int size);
  99
 100 // Get the User level data directory.
 101 void sc_GetUserAppSupportDirectory(char *str, int size);
 102
 103 // Get the System level 'Extensions' directory.
 104 void sc_GetSystemExtensionDirectory(char *str, int size);
 105
 106 // Get the User level 'Extensions' directory.
 107 void sc_GetUserExtensionDirectory(char *str, int size);
 108
 109 // Get the directory for the configuration files.
 110 void sc_GetUserConfigDirectory(char *str, int size);
 111
 112 // Directory access
 113
 114 // Abstract directory handle
 115 struct SC_DirHandle;
 116
 117 // Open directory dirname. Return NULL on failure.
 118 SC_DirHandle* sc_OpenDir(const char *dirname);
 119
 120 // Close directory dir.
 121 void sc_CloseDir(SC_DirHandle *dir);
 122
 123 // Get next entry from directory 'dir' with name 'dirname' and put it into 'path'.
 124 // Skip compilation directories iff 'skipEntry' is TRUE.
 125 // Return TRUE iff pointing to a valid dir entry.
 126 // Return TRUE in 'skipEntry' iff entry should be skipped.
 127 bool sc_ReadDir(SC_DirHandle *dir, const char *dirname, char *path, bool &skipEntry);
 128
 129
 130 // Globbing
 131
 132 // Abstract glob handle
 133 struct SC_GlobHandle;
 134
 135 // Create glob iterator from 'pattern'. Return NULL on failure.
 136 SC_GlobHandle* sc_Glob(const char* pattern);
 137
 138 // Free glob handle.
 139 void sc_GlobFree(SC_GlobHandle* glob);
 140
 141 // Return next path from glob iterator.
 142 // Return NULL at end of stream.
 143 const char* sc_GlobNext(SC_GlobHandle* glob);
 144
 145 #endif // SC_DIR_UTILS_H_INCLUDED