src/porting.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21         Random portability stuff
  22
  23         See comments in porting.h
  24 */
  25
  26 #include "porting.h"
  27 #include "config.h"
  28 #include "debug.h"
  29 #include "filesys.h"
  30
  31 #ifdef __APPLE__
  32         #include "CoreFoundation/CoreFoundation.h"
  33 #endif
  34
  35 namespace porting
  36 {
  37
  38 /*
  39         Signal handler (grabs Ctrl-C on POSIX systems)
  40 */
  41
  42 bool g_killed = false;
  43
  44 bool * signal_handler_killstatus(void)
  45 {
  46         return &g_killed;
  47 }
  48
  49 #if !defined(_WIN32) // POSIX
  50         #include <signal.h>
  51
  52 void sigint_handler(int sig)
  53 {
  54         if(g_killed == false)
  55         {
  56                 dstream<<DTIME<<"INFO: sigint_handler(): "
  57                                 <<"Ctrl-C pressed, shutting down."<<std::endl;
  58
  59                 // Comment out for less clutter when testing scripts
  60                 /*dstream<<DTIME<<"INFO: sigint_handler(): "
  61                                 <<"Printing debug stacks"<<std::endl;
  62                 debug_stacks_print();*/
  63
  64                 g_killed = true;
  65         }
  66         else
  67         {
  68                 (void)signal(SIGINT, SIG_DFL);
  69         }
  70 }
  71
  72 void signal_handler_init(void)
  73 {
  74         (void)signal(SIGINT, sigint_handler);
  75 }
  76
  77 #else // _WIN32
  78         #include <signal.h>
  79         #include <windows.h>
  80
  81         BOOL WINAPI event_handler(DWORD sig)
  82         {
  83                 switch(sig)
  84                 {
  85                 case CTRL_C_EVENT:
  86                 case CTRL_CLOSE_EVENT:
  87                 case CTRL_LOGOFF_EVENT:
  88                 case CTRL_SHUTDOWN_EVENT:
  89
  90                         if(g_killed == false)
  91                         {
  92                                 dstream<<DTIME<<"INFO: event_handler(): "
  93                                                 <<"Ctrl+C, Close Event, Logoff Event or Shutdown Event, shutting down."<<std::endl;
  94                                 // Comment out for less clutter when testing scripts
  95                                 /*dstream<<DTIME<<"INFO: event_handler(): "
  96                                                 <<"Printing debug stacks"<<std::endl;
  97                                 debug_stacks_print();*/
  98
  99                                 g_killed = true;
 100                         }
 101                         else
 102                         {
 103                                 (void)signal(SIGINT, SIG_DFL);
 104                         }
 105
 106                         break;
 107                 case CTRL_BREAK_EVENT:
 108                         break;
 109                 }
 110
 111                 return TRUE;
 112         }
 113
 114 void signal_handler_init(void)
 115 {
 116         SetConsoleCtrlHandler( (PHANDLER_ROUTINE)event_handler,TRUE);
 117 }
 118
 119 #endif
 120
 121 /*
 122         Path mangler
 123 */
 124
 125 std::string path_share = ".." DIR_DELIM "share";
 126 std::string path_user = ".." DIR_DELIM "user";
 127
 128 std::string getDataPath(const char *subpath)
 129 {
 130         return path_share + DIR_DELIM + subpath;
 131 }
 132
 133 void pathRemoveFile(char *path, char delim)
 134 {
 135         // Remove filename and path delimiter
 136         int i;
 137         for(i = strlen(path)-1; i>=0; i--)
 138         {
 139                 if(path[i] == delim)
 140                         break;
 141         }
 142         path[i] = 0;
 143 }
 144
 145 void initializePaths()
 146 {
 147 #ifdef RUN_IN_PLACE
 148         /*
 149                 Use relative paths if RUN_IN_PLACE
 150         */
 151
 152         dstream<<"Using relative paths (RUN_IN_PLACE)"<<std::endl;
 153
 154         /*
 155                 Windows
 156         */
 157         #if defined(_WIN32)
 158                 #include <windows.h>
 159
 160         const DWORD buflen = 1000;
 161         char buf[buflen];
 162         DWORD len;
 163
 164         // Find path of executable and set path_share relative to it
 165         len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
 166         assert(len < buflen);
 167         pathRemoveFile(buf, '\\');
 168
 169         path_share = std::string(buf) + "\\..\\share";
 170         path_user = std::string(buf) + "\\..\\user";
 171
 172         /*
 173                 Linux
 174         */
 175         #elif defined(linux)
 176                 #include <unistd.h>
 177
 178         char buf[BUFSIZ];
 179         memset(buf, 0, BUFSIZ);
 180         // Get path to executable
 181         assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
 182
 183         pathRemoveFile(buf, '/');
 184
 185         path_share = std::string(buf) + "/../share";
 186         path_user = std::string(buf) + "/../user";
 187
 188         /*
 189                 OS X
 190         */
 191         #elif defined(__APPLE__) || defined(__FreeBSD__)
 192
 193         //TODO: Get path of executable. This assumes working directory is bin/
 194         dstream<<"WARNING: Relative path not properly supported on OS X and FreeBSD"
 195                         <<std::endl;
 196         path_share = std::string("../share");
 197         path_user = std::string("../user");
 198
 199         #endif
 200
 201 #else // RUN_IN_PLACE
 202
 203         /*
 204                 Use platform-specific paths otherwise
 205         */
 206
 207         dstream<<"Using system-wide paths (NOT RUN_IN_PLACE)"<<std::endl;
 208
 209         /*
 210                 Windows
 211         */
 212         #if defined(_WIN32)
 213                 #include <windows.h>
 214
 215         const DWORD buflen = 1000;
 216         char buf[buflen];
 217         DWORD len;
 218
 219         // Find path of executable and set path_share relative to it
 220         len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
 221         assert(len < buflen);
 222         pathRemoveFile(buf, '\\');
 223
 224         // Use ".\bin\..\share"
 225         path_share = std::string(buf) + "\\..\\share";
 226
 227         // Use "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
 228         len = GetEnvironmentVariable("APPDATA", buf, buflen);
 229         assert(len < buflen);
 230         path_user = std::string(buf) + DIR_DELIM + PROJECT_NAME;
 231
 232         /*
 233                 Linux
 234         */
 235         #elif defined(linux)
 236                 #include <unistd.h>
 237
 238         char buf[BUFSIZ];
 239         memset(buf, 0, BUFSIZ);
 240         // Get path to executable
 241         assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
 242
 243         pathRemoveFile(buf, '/');
 244
 245         path_share = std::string(buf) + "/../share/" + PROJECT_NAME;
 246         //path_share = std::string(INSTALL_PREFIX) + "/share/" + PROJECT_NAME;
 247         if (!fs::PathExists(path_share)) {
 248                 dstream<<"WARNING: data path " << path_share << " not found!";
 249                 path_share = std::string(buf) + "/../data";
 250                 dstream<<" Trying " << path_share << std::endl;
 251         }
 252
 253         path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
 254
 255         /*
 256                 OS X
 257         */
 258         #elif defined(__APPLE__)
 259                 #include <unistd.h>
 260
 261     // Code based on
 262     // http://stackoverflow.com/questions/516200/relative-paths-not-working-in-xcode-c
 263     CFBundleRef main_bundle = CFBundleGetMainBundle();
 264     CFURLRef resources_url = CFBundleCopyResourcesDirectoryURL(main_bundle);
 265     char path[PATH_MAX];
 266     if(CFURLGetFileSystemRepresentation(resources_url, TRUE, (UInt8 *)path, PATH_MAX))
 267         {
 268                 dstream<<"Bundle resource path: "<<path<<std::endl;
 269                 //chdir(path);
 270                 path_share = std::string(path) + "/share";
 271         }
 272         else
 273     {
 274         // error!
 275                 dstream<<"WARNING: Could not determine bundle resource path"<<std::endl;
 276     }
 277     CFRelease(resources_url);
 278
 279         path_user = std::string(getenv("HOME")) + "/Library/Application Support/" + PROJECT_NAME;
 280
 281         #elif defined(__FreeBSD__)
 282
 283         path_share = std::string(INSTALL_PREFIX) + "/share/" + PROJECT_NAME;
 284         path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
 285
 286         #endif
 287
 288 #endif // RUN_IN_PLACE
 289 }
 290
 291 } //namespace porting
 292