]> git.lizzy.rs Git - minetest.git/blobdiff - src/porting.cpp
Merge pull request #447 from sapier/add_lua_log_parameter_check
[minetest.git] / src / porting.cpp
index 7de042ab571143eb1e69b8d6fd958c60c094cd83..de15de9ce2309b200a59cb8e80c3e364a093cae1 100644 (file)
@@ -3,16 +3,16 @@ Minetest-c55
 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 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 2 of the License, or
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 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.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
@@ -23,9 +23,24 @@ with this program; if not, write to the Free Software Foundation, Inc.,
        See comments in porting.h
 */
 
+#if defined(linux)
+       #include <unistd.h>
+#elif defined(__APPLE__)
+       #include <unistd.h>
+       #include <mach-o/dyld.h>
+#elif defined(__FreeBSD__)
+       #include <unistd.h>
+       #include <sys/types.h>
+       #include <sys/sysctl.h>
+#endif
+
 #include "porting.h"
 #include "config.h"
 #include "debug.h"
+#include "filesys.h"
+#include "log.h"
+#include "util/string.h"
+#include <list>
 
 #ifdef __APPLE__
        #include "CoreFoundation/CoreFoundation.h"
@@ -54,10 +69,11 @@ void sigint_handler(int sig)
        {
                dstream<<DTIME<<"INFO: sigint_handler(): "
                                <<"Ctrl-C pressed, shutting down."<<std::endl;
-               
-               dstream<<DTIME<<"INFO: sigint_handler(): "
+
+               // Comment out for less clutter when testing scripts
+               /*dstream<<DTIME<<"INFO: sigint_handler(): "
                                <<"Printing debug stacks"<<std::endl;
-               debug_stacks_print();
+               debug_stacks_print();*/
 
                g_killed = true;
        }
@@ -69,15 +85,48 @@ void sigint_handler(int sig)
 
 void signal_handler_init(void)
 {
-       dstream<<"signal_handler_init()"<<std::endl;
        (void)signal(SIGINT, sigint_handler);
 }
 
 #else // _WIN32
+       #include <signal.h>
+
+       BOOL WINAPI event_handler(DWORD sig)
+       {
+               switch(sig)
+               {
+               case CTRL_C_EVENT:
+               case CTRL_CLOSE_EVENT:
+               case CTRL_LOGOFF_EVENT:
+               case CTRL_SHUTDOWN_EVENT:
+
+                       if(g_killed == false)
+                       {
+                               dstream<<DTIME<<"INFO: event_handler(): "
+                                               <<"Ctrl+C, Close Event, Logoff Event or Shutdown Event, shutting down."<<std::endl;
+                               // Comment out for less clutter when testing scripts
+                               /*dstream<<DTIME<<"INFO: event_handler(): "
+                                               <<"Printing debug stacks"<<std::endl;
+                               debug_stacks_print();*/
+
+                               g_killed = true;
+                       }
+                       else
+                       {
+                               (void)signal(SIGINT, SIG_DFL);
+                       }
+
+                       break;
+               case CTRL_BREAK_EVENT:
+                       break;
+               }
+
+               return TRUE;
+       }
 
 void signal_handler_init(void)
 {
-       // No-op
+       SetConsoleCtrlHandler( (PHANDLER_ROUTINE)event_handler,TRUE);
 }
 
 #endif
@@ -86,8 +135,14 @@ void signal_handler_init(void)
        Path mangler
 */
 
-std::string path_data = "../data";
-std::string path_userdata = "../";
+// Default to RUN_IN_PLACE style relative paths
+std::string path_share = "..";
+std::string path_user = "..";
+
+std::string getDataPath(const char *subpath)
+{
+       return path_share + DIR_DELIM + subpath;
+}
 
 void pathRemoveFile(char *path, char delim)
 {
@@ -101,65 +156,104 @@ void pathRemoveFile(char *path, char delim)
        path[i] = 0;
 }
 
+bool detectMSVCBuildDir(char *c_path)
+{
+       std::string path(c_path);
+       const char *ends[] = {"bin\\Release", "bin\\Build", NULL};
+       return (removeStringEnd(path, ends) != "");
+}
+
 void initializePaths()
 {
-#ifdef RUN_IN_PLACE
+#if RUN_IN_PLACE
        /*
                Use relative paths if RUN_IN_PLACE
        */
 
-       dstream<<"Using relative paths (RUN_IN_PLACE)"<<std::endl;
+       infostream<<"Using relative paths (RUN_IN_PLACE)"<<std::endl;
 
        /*
                Windows
        */
        #if defined(_WIN32)
-               #include <windows.h>
 
        const DWORD buflen = 1000;
        char buf[buflen];
        DWORD len;
-       
-       // Find path of executable and set path_data relative to it
+
+       // Find path of executable and set path_share relative to it
        len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
        assert(len < buflen);
        pathRemoveFile(buf, '\\');
 
-       // Use "./bin/../data"
-       path_data = std::string(buf) + "/../data";
-               
-       // Use "./bin/../"
-       path_userdata = std::string(buf) + "/../";
+       if(detectMSVCBuildDir(buf)){
+               infostream<<"MSVC build directory detected"<<std::endl;
+               path_share = std::string(buf) + "\\..\\..";
+               path_user = std::string(buf) + "\\..\\..";
+       }
+       else{
+               path_share = std::string(buf) + "\\..";
+               path_user = std::string(buf) + "\\..";
+       }
 
        /*
                Linux
        */
        #elif defined(linux)
-               #include <unistd.h>
-       
+
        char buf[BUFSIZ];
        memset(buf, 0, BUFSIZ);
        // Get path to executable
        assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
-       
+
        pathRemoveFile(buf, '/');
 
-       // Use "./bin/../data"
-       path_data = std::string(buf) + "/../data";
-               
-       // Use "./bin/../"
-       path_userdata = std::string(buf) + "/../";
-       
+       path_share = std::string(buf) + "/..";
+       path_user = std::string(buf) + "/..";
+
        /*
                OS X
        */
        #elif defined(__APPLE__)
-       
+
+       //https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man3/dyld.3.html
+       //TODO: Test this code
+       char buf[BUFSIZ];
+       uint32_t len = sizeof(buf);
+       assert(_NSGetExecutablePath(buf, &len) != 0);
+
+       pathRemoveFile(buf, '/');
+
+       path_share = std::string(buf) + "/..";
+       path_user = std::string(buf) + "/..";
+
+       /*
+               FreeBSD
+       */
+       #elif defined(__FreeBSD__)
+
+       int mib[4];
+       char buf[BUFSIZ];
+       size_t len = sizeof(buf);
+
+       mib[0] = CTL_KERN;
+       mib[1] = KERN_PROC;
+       mib[2] = KERN_PROC_PATHNAME;
+       mib[3] = -1;
+       assert(sysctl(mib, 4, buf, &len, NULL, 0) != -1);
+
+       pathRemoveFile(buf, '/');
+
+       path_share = std::string(buf) + "/..";
+       path_user = std::string(buf) + "/..";
+
+       #else
+
        //TODO: Get path of executable. This assumes working directory is bin/
-       dstream<<"WARNING: Relative path not properly supported on OS X"
+       dstream<<"WARNING: Relative path not properly supported on this platform"
                        <<std::endl;
-       path_data = std::string("../data");
-       path_userdata = std::string("../");
+       path_share = std::string("..");
+       path_user = std::string("..");
 
        #endif
 
@@ -169,55 +263,78 @@ void initializePaths()
                Use platform-specific paths otherwise
        */
 
-       dstream<<"Using system-wide paths (NOT RUN_IN_PLACE)"<<std::endl;
+       infostream<<"Using system-wide paths (NOT RUN_IN_PLACE)"<<std::endl;
 
        /*
                Windows
        */
        #if defined(_WIN32)
-               #include <windows.h>
 
        const DWORD buflen = 1000;
        char buf[buflen];
        DWORD len;
-       
-       // Find path of executable and set path_data relative to it
+
+       // Find path of executable and set path_share relative to it
        len = GetModuleFileName(GetModuleHandle(NULL), buf, buflen);
        assert(len < buflen);
        pathRemoveFile(buf, '\\');
-       
-       // Use "./bin/../data"
-       path_data = std::string(buf) + "/../data";
-       //path_data = std::string(buf) + "/../share/" + APPNAME;
-               
-       // Use "C:\Documents and Settings\user\Application Data\<APPNAME>"
+
+       // Use ".\bin\.."
+       path_share = std::string(buf) + "\\..";
+
+       // Use "C:\Documents and Settings\user\Application Data\<PROJECT_NAME>"
        len = GetEnvironmentVariable("APPDATA", buf, buflen);
        assert(len < buflen);
-       path_userdata = std::string(buf) + "/" + APPNAME;
+       path_user = std::string(buf) + DIR_DELIM + PROJECT_NAME;
 
        /*
                Linux
        */
        #elif defined(linux)
-               #include <unistd.h>
-       
-       char buf[BUFSIZ];
-       memset(buf, 0, BUFSIZ);
+
        // Get path to executable
-       assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
-       
-       pathRemoveFile(buf, '/');
+       std::string bindir = "";
+       {
+               char buf[BUFSIZ];
+               memset(buf, 0, BUFSIZ);
+               assert(readlink("/proc/self/exe", buf, BUFSIZ-1) != -1);
+               pathRemoveFile(buf, '/');
+               bindir = buf;
+       }
+
+       // Find share directory from these.
+       // It is identified by containing the subdirectory "builtin".
+       std::list<std::string> trylist;
+       std::string static_sharedir = STATIC_SHAREDIR;
+       if(static_sharedir != "" && static_sharedir != ".")
+               trylist.push_back(static_sharedir);
+       trylist.push_back(bindir + "/../share/" + PROJECT_NAME);
+       trylist.push_back(bindir + "/..");
+
+       for(std::list<std::string>::const_iterator i = trylist.begin();
+                       i != trylist.end(); i++)
+       {
+               const std::string &trypath = *i;
+               if(!fs::PathExists(trypath) || !fs::PathExists(trypath + "/builtin")){
+                       dstream<<"WARNING: system-wide share not found at \""
+                                       <<trypath<<"\""<<std::endl;
+                       continue;
+               }
+               // Warn if was not the first alternative
+               if(i != trylist.begin()){
+                       dstream<<"WARNING: system-wide share found at \""
+                                       <<trypath<<"\""<<std::endl;
+               }
+               path_share = trypath;
+               break;
+       }
 
-       path_data = std::string(buf) + "/../share/" + APPNAME;
-       //path_data = std::string(INSTALL_PREFIX) + "/share/" + APPNAME;
-       
-       path_userdata = std::string(getenv("HOME")) + "/." + APPNAME;
+       path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
 
        /*
                OS X
        */
        #elif defined(__APPLE__)
-               #include <unistd.h>
 
     // Code based on
     // http://stackoverflow.com/questions/516200/relative-paths-not-working-in-xcode-c
@@ -228,7 +345,7 @@ void initializePaths()
        {
                dstream<<"Bundle resource path: "<<path<<std::endl;
                //chdir(path);
-               path_data = std::string(path) + "/data";
+               path_share = std::string(path) + "/share";
        }
        else
     {
@@ -236,15 +353,17 @@ void initializePaths()
                dstream<<"WARNING: Could not determine bundle resource path"<<std::endl;
     }
     CFRelease(resources_url);
-       
-       path_userdata = std::string(getenv("HOME")) + "/Library/Application Support/" + APPNAME;
-    
+
+       path_user = std::string(getenv("HOME")) + "/Library/Application Support/" + PROJECT_NAME;
+
+       #elif defined(__FreeBSD__)
+
+       path_share = STATIC_SHAREDIR;
+       path_user = std::string(getenv("HOME")) + "/." + PROJECT_NAME;
+
        #endif
 
 #endif // RUN_IN_PLACE
-
-       dstream<<"path_data = "<<path_data<<std::endl;
-       dstream<<"path_userdata = "<<path_userdata<<std::endl;
 }
 
 } //namespace porting