//----------------------------------------------------------------------------- // // Copyright 1996 id Software // Copyright 1999-2016 Randy Heit // Copyright 2002-2016 Christoph Oelckers // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see http://www.gnu.org/licenses/ // //----------------------------------------------------------------------------- // // cmdlib.c (mostly borrowed from the Q2 source) #ifdef _WIN32 #include #include #else #include #include #include #if !defined(__sun) #include #endif #endif #include "doomtype.h" #include "cmdlib.h" #include "i_system.h" #include "v_text.h" #include "sc_man.h" #include #include #include /* progdir will hold the path up to the game directory, including the slash f:\quake\ /raid/quake/ gamedir will hold progdir + the game directory (id1, id2, etc) */ FString progdir; //========================================================================== // // IsSeperator // // Returns true if the character is a path seperator. // //========================================================================== static inline bool IsSeperator (int c) { if (c == '/') return true; #ifdef WIN32 if (c == '\\' || c == ':') return true; #endif return false; } //========================================================================== // // FixPathSeperator // // Convert backslashes to forward slashes. // //========================================================================== void FixPathSeperator (char *path) { while (*path) { if (*path == '\\') *path = '/'; path++; } } //========================================================================== // // copystring // // Replacement for strdup that uses new instead of malloc. // //========================================================================== char *copystring (const char *s) { char *b; if (s) { size_t len = strlen (s) + 1; b = new char[len]; memcpy (b, s, len); } else { b = new char[1]; b[0] = '\0'; } return b; } //========================================================================== // // ReplaceString // // Do not use in new code. // //========================================================================== void ReplaceString (char **ptr, const char *str) { if (*ptr) { if (*ptr == str) return; delete[] *ptr; } *ptr = copystring (str); } /* ============================================================================= MISC FUNCTIONS ============================================================================= */ //========================================================================== // // Q_filelength // //========================================================================== int Q_filelength (FILE *f) { int pos; int end; pos = ftell (f); fseek (f, 0, SEEK_END); end = ftell (f); fseek (f, pos, SEEK_SET); return end; } //========================================================================== // // FileExists // // Returns true if the given path exists and is a readable file. // //========================================================================== bool FileExists (const char *filename) { struct stat buff; // [RH] Empty filenames are never there if (filename == NULL || *filename == 0) return false; return stat(filename, &buff) == 0 && !(buff.st_mode & S_IFDIR); } //========================================================================== // // DirEntryExists // // Returns true if the given path exists, be it a directory or a file. // //========================================================================== bool DirEntryExists(const char *pathname) { if (pathname == NULL || *pathname == 0) return false; struct stat info; return stat(pathname, &info) == 0; } //========================================================================== // // DefaultExtension -- char array version // // Appends the extension to a pathname if it does not already have one. // //========================================================================== void DefaultExtension (char *path, const char *extension) { char *src; // // if path doesn't have a .EXT, append extension // (extension should include the .) // src = path + strlen(path) - 1; while (src != path && !IsSeperator(*src)) { if (*src == '.') return; // it has an extension src--; } strcat (path, extension); } //========================================================================== // // DefaultExtension -- FString version // // Appends the extension to a pathname if it does not already have one. // //========================================================================== void DefaultExtension (FString &path, const char *extension) { const char *src = &path[int(path.Len())-1]; while (src != &path[0] && !IsSeperator(*src)) { if (*src == '.') return; // it has an extension src--; } path += extension; } //========================================================================== // // ExtractFilePath // // Returns the directory part of a pathname. // // FIXME: should include the slash, otherwise // backing to an empty path will be wrong when appending a slash // //========================================================================== FString ExtractFilePath (const char *path) { const char *src; src = path + strlen(path) - 1; // // back up until a \ or the start // while (src != path && !IsSeperator(*(src-1))) src--; return FString(path, src - path); } //========================================================================== // // ExtractFileBase // // Returns the file part of a pathname, optionally including the extension. // //========================================================================== FString ExtractFileBase (const char *path, bool include_extension) { const char *src, *dot; src = path + strlen(path) - 1; if (src >= path) { // back up until a / or the start while (src != path && !IsSeperator(*(src-1))) src--; // Check for files with drive specification but no path #if defined(_WIN32) || defined(DOS) if (src == path && src[0] != 0) { if (src[1] == ':') src += 2; } #endif if (!include_extension) { dot = src; while (*dot && *dot != '.') { dot++; } return FString(src, dot - src); } else { return FString(src); } } return FString(); } //========================================================================== // // ParseHex // //========================================================================== int ParseHex (const char *hex, FScriptPosition *sc) { const char *str; int num; num = 0; str = hex; while (*str) { num <<= 4; if (*str >= '0' && *str <= '9') num += *str-'0'; else if (*str >= 'a' && *str <= 'f') num += 10 + *str-'a'; else if (*str >= 'A' && *str <= 'F') num += 10 + *str-'A'; else { if (!sc) Printf ("Bad hex number: %s\n",hex); else sc->Message(MSG_WARNING, "Bad hex number: %s", hex); return 0; } str++; } return num; } //========================================================================== // // IsNum // // [RH] Returns true if the specified string is a valid decimal number // //========================================================================== bool IsNum (const char *str) { while (*str) { if (((*str < '0') || (*str > '9')) && (*str != '-')) { return false; } str++; } return true; } //========================================================================== // // CheckWildcards // // [RH] Checks if text matches the wildcard pattern using ? or * // //========================================================================== bool CheckWildcards (const char *pattern, const char *text) { if (pattern == NULL || text == NULL) return true; while (*pattern) { if (*pattern == '*') { char stop = tolower (*++pattern); while (*text && tolower(*text) != stop) { text++; } if (*text && tolower(*text) == stop) { if (CheckWildcards (pattern, text++)) { return true; } pattern--; } } else if (*pattern == '?' || tolower(*pattern) == tolower(*text)) { pattern++; text++; } else { return false; } } return (*pattern | *text) == 0; } //========================================================================== // // FormatGUID // // [RH] Print a GUID to a text buffer using the standard format. // //========================================================================== void FormatGUID (char *buffer, size_t buffsize, const GUID &guid) { mysnprintf (buffer, buffsize, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}", (uint32_t)guid.Data1, guid.Data2, guid.Data3, guid.Data4[0], guid.Data4[1], guid.Data4[2], guid.Data4[3], guid.Data4[4], guid.Data4[5], guid.Data4[6], guid.Data4[7]); } //========================================================================== // // myasctime // // [RH] Returns the current local time as ASCII, even if it's too early // //========================================================================== const char *myasctime () { time_t clock; struct tm *lt; time (&clock); lt = localtime (&clock); if (lt != NULL) { return asctime (lt); } else { return "Pre Jan 01 00:00:00 1970\n"; } } //========================================================================== // // CreatePath // // Creates a directory including all levels necessary // //========================================================================== #ifdef _WIN32 void DoCreatePath(const char *fn) { char drive[_MAX_DRIVE]; char path[PATH_MAX]; char p[PATH_MAX]; int i; _splitpath(fn,drive,path,NULL,NULL); _makepath(p,drive,path,NULL,NULL); i=(int)strlen(p); if (p[i-1]=='/' || p[i-1]=='\\') p[i-1]=0; if (*path) DoCreatePath(p); _mkdir(p); } void CreatePath(const char *fn) { char c = fn[strlen(fn)-1]; if (c != '\\' && c != '/') { FString name(fn); name += '/'; DoCreatePath(name); } else { DoCreatePath(fn); } } #else void CreatePath(const char *fn) { char *copy, *p; if (fn[0] == '/' && fn[1] == '\0') { return; } p = copy = strdup(fn); do { p = strchr(p + 1, '/'); if (p != NULL) { *p = '\0'; } struct stat info; if (stat(copy, &info) == 0) { if (info.st_mode & S_IFDIR) goto exists; } if (mkdir(copy, 0755) == -1) { // failed free(copy); return; } exists: if (p != NULL) { *p = '/'; } } while (p); free(copy); } #endif //========================================================================== // // strbin -- In-place version // // [RH] Replaces the escape sequences in a string with actual escaped characters. // This operation is done in-place. The result is the new length of the string. // //========================================================================== int strbin (char *str) { char *start = str; char *p = str, c; int i; while ( (c = *p++) ) { if (c != '\\') { *str++ = c; } else { switch (*p) { case 'a': *str++ = '\a'; break; case 'b': *str++ = '\b'; break; case 'c': *str++ = '\034'; // TEXTCOLOR_ESCAPE break; case 'f': *str++ = '\f'; break; case 'n': *str++ = '\n'; break; case 't': *str++ = '\t'; break; case 'r': *str++ = '\r'; break; case 'v': *str++ = '\v'; break; case '?': *str++ = '\?'; break; case '\n': break; case 'x': case 'X': c = 0; for (i = 0; i < 2; i++) { p++; if (*p >= '0' && *p <= '9') c = (c << 4) + *p-'0'; else if (*p >= 'a' && *p <= 'f') c = (c << 4) + 10 + *p-'a'; else if (*p >= 'A' && *p <= 'F') c = (c << 4) + 10 + *p-'A'; else { p--; break; } } *str++ = c; break; case '0': case '1': case '2': case '3': case '4': case '5': case '6': case '7': c = *p - '0'; for (i = 0; i < 2; i++) { p++; if (*p >= '0' && *p <= '7') c = (c << 3) + *p - '0'; else { p--; break; } } *str++ = c; break; default: *str++ = *p; break; } p++; } } *str = 0; return int(str - start); } //========================================================================== // // strbin1 -- String-creating version // // [RH] Replaces the escape sequences in a string with actual escaped characters. // The result is a new string. // //========================================================================== FString strbin1 (const char *start) { FString result; const char *p = start; char c; int i; while ( (c = *p++) ) { if (c != '\\') { result << c; } else { switch (*p) { case 'a': result << '\a'; break; case 'b': result << '\b'; break; case 'c': result << '\034'; // TEXTCOLOR_ESCAPE break; case 'f': result << '\f'; break; case 'n': result << '\n'; break; case 't': result << '\t'; break; case 'r': result << '\r'; break; case 'v': result << '\v'; break; case '?': result << '\?'; break; case '\n': break; case 'x': case 'X': c = 0; for (i = 0; i < 2; i++) { p++; if (*p >= '0' && *p <= '9') c = (c << 4) + *p-'0'; else if (*p >= 'a' && *p <= 'f') c = (c << 4) + 10 + *p-'a'; else if (*p >= 'A' && *p <= 'F') c = (c << 4) + 10 + *p-'A'; else { p--; break; } } result << c; break; case '0': case '1': case '2': case '3': case '4': case '5': case '6': case '7': c = *p - '0'; for (i = 0; i < 2; i++) { p++; if (*p >= '0' && *p <= '7') c = (c << 3) + *p - '0'; else { p--; break; } } result << c; break; default: result << *p; break; } p++; } } return result; } //========================================================================== // // CleanseString // // Does some mild sanity checking on a string: If it ends with an incomplete // color escape, the escape is removed. // //========================================================================== char *CleanseString(char *str) { char *escape = strrchr(str, TEXTCOLOR_ESCAPE); if (escape != NULL) { if (escape[1] == '\0') { *escape = '\0'; } else if (escape[1] == '[') { char *close = strchr(escape + 2, ']'); if (close == NULL) { *escape = '\0'; } } } return str; } //========================================================================== // // ExpandEnvVars // // Expands environment variable references in a string. Intended primarily // for use with IWAD search paths in config files. // //========================================================================== FString ExpandEnvVars(const char *searchpathstring) { static const char envvarnamechars[] = "01234567890" "ABCDEFGHIJKLMNOPQRSTUVWXYZ" "_" "abcdefghijklmnopqrstuvwxyz"; if (searchpathstring == NULL) return FString(""); const char *dollar = strchr(searchpathstring, '$'); if (dollar == NULL) { return FString(searchpathstring); } const char *nextchars = searchpathstring; FString out = FString(searchpathstring, dollar - searchpathstring); while ( (dollar != NULL) && (*nextchars != 0) ) { size_t length = strspn(dollar + 1, envvarnamechars); if (length != 0) { FString varname = FString(dollar + 1, length); if (stricmp(varname, "progdir") == 0) { out += progdir; } else { char *varvalue = getenv(varname); if ( (varvalue != NULL) && (strlen(varvalue) != 0) ) { out += varvalue; } } } else { out += '$'; } nextchars = dollar + length + 1; dollar = strchr(nextchars, '$'); if (dollar != NULL) { out += FString(nextchars, dollar - nextchars); } } if (*nextchars != 0) { out += nextchars; } return out; } //========================================================================== // // NicePath // // Handles paths with leading ~ characters on Unix as well as environment // variable substitution. On Windows, this is identical to ExpandEnvVars. // //========================================================================== FString NicePath(const char *path) { #ifdef _WIN32 return ExpandEnvVars(path); #else if (path == NULL || *path == '\0') { return FString(""); } if (*path != '~') { return ExpandEnvVars(path); } passwd *pwstruct; const char *slash; if (path[1] == '/' || path[1] == '\0') { // Get my home directory pwstruct = getpwuid(getuid()); slash = path + 1; } else { // Get somebody else's home directory slash = strchr(path, '/'); if (slash == NULL) { slash = path + strlen(path); } FString who(path, slash - path); pwstruct = getpwnam(who); } if (pwstruct == NULL) { return ExpandEnvVars(path); } FString where(pwstruct->pw_dir); if (*slash != '\0') { where += ExpandEnvVars(slash); } return where; #endif } #ifdef _WIN32 //========================================================================== // // ScanDirectory // //========================================================================== void ScanDirectory(TArray &list, const char *dirpath) { struct _finddata_t fileinfo; intptr_t handle; FString dirmatch; dirmatch << dirpath << "*"; if ((handle = _findfirst(dirmatch, &fileinfo)) == -1) { I_Error("Could not scan '%s': %s\n", dirpath, strerror(errno)); } else { do { if (fileinfo.attrib & _A_HIDDEN) { // Skip hidden files and directories. (Prevents SVN bookkeeping // info from being included.) continue; } if (fileinfo.attrib & _A_SUBDIR) { if (fileinfo.name[0] == '.' && (fileinfo.name[1] == '\0' || (fileinfo.name[1] == '.' && fileinfo.name[2] == '\0'))) { // Do not record . and .. directories. continue; } FFileList *fl = &list[list.Reserve(1)]; fl->Filename << dirpath << fileinfo.name; fl->isDirectory = true; FString newdir = fl->Filename; newdir << "/"; ScanDirectory(list, newdir); } else { FFileList *fl = &list[list.Reserve(1)]; fl->Filename << dirpath << fileinfo.name; fl->isDirectory = false; } } while (_findnext(handle, &fileinfo) == 0); _findclose(handle); } } #elif defined(__sun) || defined(__linux__) //========================================================================== // // ScanDirectory // Solaris version // // Given NULL-terminated array of directory paths, create trees for them. // //========================================================================== void ScanDirectory(TArray &list, const char *dirpath) { DIR *directory = opendir(dirpath); if(directory == NULL) return; struct dirent *file; while((file = readdir(directory)) != NULL) { if(file->d_name[0] == '.') //File is hidden or ./.. directory so ignore it. continue; FFileList *fl = &list[list.Reserve(1)]; fl->Filename << dirpath << file->d_name; struct stat fileStat; stat(fl->Filename, &fileStat); fl->isDirectory = S_ISDIR(fileStat.st_mode); if(fl->isDirectory) { FString newdir = fl->Filename; newdir += "/"; ScanDirectory(list, newdir); continue; } } closedir(directory); } #else //========================================================================== // // ScanDirectory // 4.4BSD version // //========================================================================== void ScanDirectory(TArray &list, const char *dirpath) { char * const argv[] = {new char[strlen(dirpath)+1], NULL }; memcpy(argv[0], dirpath, strlen(dirpath)+1); FTS *fts; FTSENT *ent; fts = fts_open(argv, FTS_LOGICAL, NULL); if (fts == NULL) { I_Error("Failed to start directory traversal: %s\n", strerror(errno)); delete[] argv[0]; return; } while ((ent = fts_read(fts)) != NULL) { if (ent->fts_info == FTS_D && ent->fts_name[0] == '.') { // Skip hidden directories. (Prevents SVN bookkeeping // info from being included.) fts_set(fts, ent, FTS_SKIP); } if (ent->fts_info == FTS_D && ent->fts_level == 0) { FFileList *fl = &list[list.Reserve(1)]; fl->Filename = ent->fts_path; fl->isDirectory = true; } if (ent->fts_info == FTS_F) { // We're only interested in remembering files. FFileList *fl = &list[list.Reserve(1)]; fl->Filename = ent->fts_path; fl->isDirectory = false; } } fts_close(fts); delete[] argv[0]; } #endif