shithub: choc

--- a/man/Makefile.am

+++ b/man/Makefile.am

@@ -1,4 +1,5 @@

 MANPAGE_GEN_FILES = environ.man           \

+                    iwad_paths.man        \

                     doom.template         \

                     heretic.template      \

                     hexen.template        \

--- a/man/doom.template

+++ b/man/doom.template

@@ -10,6 +10,8 @@

 to behave as similar to the original DOS version of Doom as is possible.

.br

 @content

+.SH IWAD SEARCH PATHS

+@include iwad_paths.man

 .SH ENVIRONMENT

 This section describes environment variables that control Chocolate Doom's

 behavior.

--- a/man/environ.man

+++ b/man/environ.man

@@ -1,9 +1,6 @@

.TP

 \fBDOOMWADDIR\fR, \fBDOOMWADPATH\fR

-These environment variables provide paths to search for Doom .WAD files when

-looking for a game IWAD file or a PWAD file specified with the `\-file' option.

-\fBDOOMWADDIR\fR specifies a single path in which to look for WAD files,

-while \fBDOOMWWADPATH\fR specifies a colon-separated list of paths to search.

+See the section, \fBIWAD SEARCH PATHS\fR above.

.TP

 \fBPCSOUND_DRIVER\fR

 When running in PC speaker sound effect mode, this environment variable

--- a/man/heretic.template

+++ b/man/heretic.template

@@ -11,6 +11,8 @@

 possible.

.br

 @content

+.SH IWAD SEARCH PATHS

+@include iwad_paths.man

 .SH ENVIRONMENT

 This section describes environment variables that control Chocolate Heretic's

 behavior.

--- a/man/hexen.template

+++ b/man/hexen.template

@@ -11,6 +11,8 @@

 possible.

.br

 @content

+.SH IWAD SEARCH PATHS

+@include iwad_paths.man

 .SH ENVIRONMENT

 This section describes environment variables that control Chocolate Hexen's

 behavior.

--- /dev/null

+++ b/man/iwad_paths.man

@@ -1,0 +1,48 @@

+To play, an IWAD file is needed. This is a large file containing all of the

+levels, graphics, sound effects, music and other material that make up the

+game. IWAD files are named according to the game; the standard names are:

+.TP

+\fBdoom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad\fR

+Doom, Doom II, Final Doom

+.TP

+\fBheretic.wad, heretic1.wad, hexen.wad, strife1.wad\fR

+Heretic, Hexen and Strife (commercial Doom engine games).

+.TP

+\fBhacx.wad, chex.wad\fR

+Hacx and Chex Quest - more obscure games based on the Doom engine.

+.TP

+\fBfreedm.wad, freedoom1.wad, freedoom2.wad\fR

+The Freedoom open content IWAD files.

+.LP

+The following directory paths are searched in order to find an IWAD:

+.TP

+\fBCurrent working directory\fR

+Any IWAD files found in the current working directory will be used in

+preference to IWADs found in any other directories.

+.TP

+\fBDOOMWADDIR\fR

+This environment variable can be set to contain a path to a single directory

+in which to look for IWAD files. This environment variable is supported by

+most Doom source ports.

+.TP

+\fBDOOMWADPATH\fR

+This environment variable, if set, can contain a colon-separated list of

+directories in which to look for IWAD files, or alternatively full paths to

+specific IWAD files.

+.TP

+\fB$HOME/.local/share/games/doom\fR

+Writeable directory in the user's home directory. The path can be overridden

+using the \fBXDG_DATA_HOME\fR environment variable (see the XDG Base Directory

+Specification).

+.TP

+\fB/usr/local/share/games/doom, /usr/share/games/doom\fR

+System-wide locations that can be accessed by all users. The path

+\fB/usr/share/games/doom\fR is a standard path that is supported by most

+Doom source ports. These paths can be overridden using the \fBXDG_DATA_DIRS\fR

+environment variable (see the XDG Base Directory Specification).

+.LP

+The above can be overridden on a one-time basis by using the \fB\-iwad\fR

+command line parameter to provide the path to an IWAD file to use. This

+parameter can also be used to specify the name of a particular IWAD to use

+from one of the above paths. For example, '\fB-iwad doom.wad\fR' will search

+the above paths for the file \fBdoom.wad\fR to use.

--- a/man/strife.template

+++ b/man/strife.template

@@ -13,6 +13,8 @@

 @content

+.SH IWAD SEARCH PATHS

+@include iwad_paths.man

 .SH ENVIRONMENT

 This section describes environment variables that control Chocolate Strife's

 behavior.

--- a/src/d_iwad.c

+++ b/src/d_iwad.c

@@ -509,47 +509,29 @@

     return mission;

-//

-// Add directories from the list in the DOOMWADPATH environment variable.

-//

-static void AddDoomWadPath(void)

+// Add IWAD directories parsed from splitting a path string containing

+// paths separated by PATH_SEPARATOR. 'suffix' is a string to concatenate

+// to the end of the paths before adding them.

+static void AddIWADPath(char *path, char *suffix)

-    char *doomwadpath;

-    char *p;

+    char *left, *p;

-    // Check the DOOMWADPATH environment variable.

+    path = M_StringDuplicate(path);

-    doomwadpath = getenv("DOOMWADPATH");

-    if (doomwadpath == NULL)

-    {

-        return;

-    }

-    doomwadpath = M_StringDuplicate(doomwadpath);

-    // Add the initial directory

-    AddIWADDir(doomwadpath);

     // Split into individual dirs within the list.

+    left = path;

-    p = doomwadpath;

     for (;;)

-        p = strchr(p, PATH_SEPARATOR);

+        p = strchr(left, PATH_SEPARATOR);

         if (p != NULL)

-            // Break at the separator and store the right hand side

+            // Break at the separator and use the left hand side

             // as another iwad dir

             *p = '\0';

-            p += 1;

-            AddIWADDir(p);

+            AddIWADDir(M_StringJoin(left, suffix, NULL));

+            left = p + 1;

         else

@@ -556,9 +538,68 @@

             break;

+    AddIWADDir(M_StringJoin(left, suffix, NULL));

+    free(path);

+// Add standard directories where IWADs are located on Unix systems.

+// To respect the freedesktop.org specification we support overriding

+// using standard environment variables. See the XDG Base Directory

+// Specification:

+// <http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>

+static void AddXdgDirs(void)

+{

+    char *env, *tmp_env;

+    // Quote:

+    // > $XDG_DATA_HOME defines the base directory relative to which

+    // > user specific data files should be stored. If $XDG_DATA_HOME

+    // > is either not set or empty, a default equal to

+    // > $HOME/.local/share should be used.

+    env = getenv("XDG_DATA_HOME");

+    tmp_env = NULL;

+    if (env == NULL)

+    {

+        char *homedir = getenv("HOME");

+        if (homedir == NULL)

+        {

+            homedir = "/";

+        }

+        tmp_env = M_StringJoin(homedir, "/.local/share", NULL);

+        env = tmp_env;

+    }

+    // We support $XDG_DATA_HOME/games/doom (which will usually be

+    // ~/.local/share/games/doom) as a user-writeable extension to

+    // the usual /usr/share/games/doom location.

+    AddIWADDir(M_StringJoin(env, "/games/doom", NULL));

+    free(tmp_env);

+    // Quote:

+    // > $XDG_DATA_DIRS defines the preference-ordered set of base

+    // > directories to search for data files in addition to the

+    // > $XDG_DATA_HOME base directory. The directories in $XDG_DATA_DIRS

+    // > should be seperated with a colon ':'.

+    // >

+    // > If $XDG_DATA_DIRS is either not set or empty, a value equal to

+    // > /usr/local/share/:/usr/share/ should be used.

+    env = getenv("XDG_DATA_DIRS");

+    if (env == NULL)

+    {

+        // (Trailing / omitted from paths, as it is added below)

+        env = "/usr/local/share:/usr/share";

+    }

+    // The "standard" location for IWADs on Unix that is supported by most

+    // source ports is /usr/share/games/doom - we support this through the

+    // XDG_DATA_DIRS mechanism, through which it can be overridden.

+    AddIWADPath(env, "/games/doom");

+}

//

 // Build a list of IWAD files

//

@@ -565,7 +606,7 @@

 static void BuildIWADDirList(void)

-    char *doomwaddir;

+    char *env;

     if (iwad_dirs_built)

@@ -573,22 +614,22 @@

     // Look in the current directory.  Doom always does this.

     AddIWADDir(".");

     // Add DOOMWADDIR if it is in the environment

+    env = getenv("DOOMWADDIR");

+    if (env != NULL)

+    {

+        AddIWADDir(env);

+    }

-    doomwaddir = getenv("DOOMWADDIR");

-    if (doomwaddir != NULL)

+    // Add dirs from DOOMWADPATH:

+    env = getenv("DOOMWADPATH");

+    if (env != NULL)

-        AddIWADDir(doomwaddir);

-    }

+        AddIWADPath(env, "");

+    }

-    // Add dirs from DOOMWADPATH

-    AddDoomWadPath();

 #ifdef _WIN32

     // Search the registry and find where IWADs have been installed.

@@ -603,12 +644,7 @@

     CheckSteamGUSPatches();

 #else

-    // Standard places where IWAD files are installed under Unix.

-    AddIWADDir("/usr/share/games/doom");

-    AddIWADDir("/usr/local/share/games/doom");

+    AddXdgDirs();

 #endif

     // Don't run this function again.