src/common/paths.h

/* RCSid $Id: paths.h,v 2.31 2023/04/07 19:06:18 greg Exp $ */
/*
 * Definitions for paths on different machines
 */
#ifndef _RAD_PATHS_H_
#define _RAD_PATHS_H_

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>

#if defined(_WIN32) || defined(_WIN64)
  #include <io.h>
  #include <direct.h> /* getcwd(), chdir(), _mkdir(), etc. */
  #define getcwd _getcwd
  #define chdir _chdir

  #define access                _access
  #define mkdir(dirname,perms)  _mkdir(dirname)
  /* The windows _popen with the native shell breaks '\\\n' escapes.
   * RT_WINPROC (used by SCons) enables our replacement functions to fix that.
   * XXX This should really not depend on the compiler used! */
  #if 1 /* defined(_MSC_VER) && !defined(RT_WINPROC) */
    #define popen(cmd,mode)     _popen(cmd,mode)
    #define pclose(p)           _pclose(p)
  #else
    #define popen(cmd,mode)     win_popen(cmd,mode)
    #define pclose(p)           win_pclose(p)
  #endif
  #define kill(pid,sig)         win_kill(pid,sig)
  #define nice(inc)             win_nice(inc)
  #define PATH_MAX              _MAX_PATH
  #define NULL_DEVICE           "NUL"
  #define DIRSEP                '/'
  #define ISDIRSEP(c)           (((c)=='/') | ((c)=='\\'))
  #define ISABS(s)              ( ISDIRSEP((s)[0]) \
                || ( isupper((s)[0]) | islower((s)[0]) \
                        && (s)[1]==':' && ISDIRSEP((s)[2]) ) )
  #define CASEDIRSEP            case '/': case '\\'
  #define PATHSEP               ';'
  #define CURDIR                '.'
  #define DEFAULT_TEMPDIRS      {"C:/TMP", "C:/TEMP", ".", NULL}
  #define TEMPLATE              "rtXXXXXX"
  #define TEMPLEN               8
  #define ULIBVAR               "RAYPATH"
  #ifndef DEFPATH
    #define DEFPATH             ";c:/ray/lib"
  #endif
  #define SPECIALS              " \t\"$*?|"
  #define QUOTCHAR              '"'
  /* <io.h> only does half the work for access() */
  #ifndef F_OK
    #define  F_OK 00
    #define  W_OK 02
  #endif
  #ifndef R_OK
    #define X_OK 01
    #define R_OK 04
  #endif
  /* to make the permissions user specific we'd need to use CreateFile() */
  #ifndef S_IRUSR
    #define S_IRUSR _S_IREAD
    #define S_IWUSR _S_IWRITE
  #endif

#else /* everything but Windows */
  #include <unistd.h>
  #include <sys/param.h>

  #define RMAX_PATH_MAX 4096 /* our own maximum */
  #ifndef PATH_MAX
    #define PATH_MAX 512
  #elif PATH_MAX > RMAX_PATH_MAX /* the OS is exaggerating */
    #undef PATH_MAX
    #define PATH_MAX RMAX_PATH_MAX
  #endif

  #ifdef AMIGA

        #define NULL_DEVICE     "NIL:"
    #define DIRSEP              '/'
    #define ISABS(s)            ISDIRSEP((s)[0])
    #define PATHSEP             ';'
        #define CURDIR          '.'
    #define DEFAULT_TEMPDIRS    {"/var/tmp", "/usr/tmp", "/tmp", ".", NULL}
    #define TEMPLATE            "/tmp/rtXXXXXX"
    #define TEMPLEN             13
    #define ULIBVAR             "RAYPATH"
    #ifndef DEFPATH
      #define DEFPATH           ";/ray/lib"
    #endif

  #else

    /* posix */

        /* this is defined as _PATH_DEVNULL in /usr/include/paths.h on Linux */
        #define NULL_DEVICE     "/dev/null"
    #define DIRSEP              '/'
    #define ISABS(s)            ISDIRSEP((s)[0])
    #define PATHSEP             ':'
        #define CURDIR          '.'
    #define DEFAULT_TEMPDIRS    {"/var/tmp", "/usr/tmp", "/tmp", ".", NULL}
    #define TEMPLATE            "/tmp/rtXXXXXX"
    #define TEMPLEN             13
    #define ULIBVAR             "RAYPATH"
    #ifndef DEFPATH
      #define DEFPATH           ":/usr/local/lib/ray"
    #endif
    #define SPECIALS            " \t\n'\"()${}*?[];|&"
    #define QUOTCHAR            '\''
    #define ALTQUOT             '"'

  #endif
#endif

#ifndef ISDIRSEP
  #define ISDIRSEP(c)   ((c)==DIRSEP)
#endif
#ifndef CASEDIRSEP
  #define CASEDIRSEP    case DIRSEP
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if defined(_WIN32) || defined(_WIN64)
  extern FILE *win_popen(char *command, char *type);
  extern int win_pclose(FILE *p);
#endif

/* Set global progname and return path-free version of argv[0] */
extern char  *fixargv0(char *arg0);
extern char  *progname;

/* Check if any of the characters in str2 are found in str1 */
extern int matchany(const char *str1, const char *str2);

/* Convert a set of arguments into a command line for pipe() or system() */
extern char *convert_commandline(char *cmd, const int len, char *av[]);

/* Find a writeable directory for temporary files */
/* If s is NULL, we return a static string */
extern char *temp_directory(char *s, size_t len);

/* Compose a *currently* unique name within a temporary directory */
/* If s is NULL, we return a static string */
/* If templ is NULL, we take our default template */
/* WARNING: On Windows, there's a maximum of 27 unique names within
            one process for the same template. */
extern char *temp_filename(char *s, size_t len, char *templ);

/* Same as above, but also open the file and return the descriptor */
/* This one is supposed to protect against race conditions on unix */
/* WARNING: On Windows, there's no protection against race conditions */
extern int temp_fd(char *s, size_t len, char *templ);

/* Same as above, but return a file pointer instead of a descriptor */
extern FILE *temp_fp(char *s, size_t len, char *templ);

/* Concatenate two strings, leaving exactly one DIRSEP in between */
extern char *append_filepath(char *s1, char *s2, size_t len);


#ifdef __cplusplus
}
#endif
#endif /* _RAD_PATHS_H_ */

Revision:	2.32
Committed:	Tue Jun 3 21:31:51 2025 UTC (44 hours, 33 minutes ago) by greg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	HEAD
Changes since 2.31:	+5 -4 lines
Log Message:	refactor: More consistent use of global char * progname and fixargv0()
#	User	Rev	Content
1	greg	2.32	/* RCSid $Id: paths.h,v 2.31 2023/04/07 19:06:18 greg Exp $ */
2	greg	2.1	/*
3			* Definitions for paths on different machines
4	greg	2.9	*/
5	schorsch	2.12	#ifndef _RAD_PATHS_H_
6			#define _RAD_PATHS_H_
7	greg	2.1
8	schorsch	2.16	#include <stdio.h>
9	schorsch	2.13	#include <stdlib.h>
10			#include <string.h>
11	schorsch	2.17	#include <fcntl.h>
12			#include <sys/types.h>
13			#include <sys/stat.h>
14	schorsch	2.16
15	schorsch	2.27	#if defined(_WIN32) \|\| defined(_WIN64)
16	schorsch	2.14	#include <io.h>
17	schorsch	2.22	#include <direct.h> /* getcwd(), chdir(), _mkdir(), etc. */
18	schorsch	2.27	#define getcwd _getcwd
19			#define chdir _chdir
20	greg	2.1
21	greg	2.25	#define access _access
22			#define mkdir(dirname,perms) _mkdir(dirname)
23	schorsch	2.28	/* The windows _popen with the native shell breaks '\\\n' escapes.
24			* RT_WINPROC (used by SCons) enables our replacement functions to fix that.
25			* XXX This should really not depend on the compiler used! */
26	greg	2.31	#if 1 /* defined(_MSC_VER) && !defined(RT_WINPROC) */
27	greg	2.25	#define popen(cmd,mode) _popen(cmd,mode)
28			#define pclose(p) _pclose(p)
29			#else
30			#define popen(cmd,mode) win_popen(cmd,mode)
31			#define pclose(p) win_pclose(p)
32			#endif
33			#define kill(pid,sig) win_kill(pid,sig)
34			#define nice(inc) win_nice(inc)
35	greg	2.26	#define PATH_MAX _MAX_PATH
36	greg	2.25	#define NULL_DEVICE "NUL"
37	schorsch	2.14	#define DIRSEP '/'
38	greg	2.25	#define ISDIRSEP(c) (((c)=='/') \| ((c)=='\\'))
39			#define ISABS(s) ( ISDIRSEP((s)[0]) \
40	greg	2.24	\|\| ( isupper((s)[0]) \| islower((s)[0]) \
41			&& (s)[1]==':' && ISDIRSEP((s)[2]) ) )
42	greg	2.25	#define CASEDIRSEP case '/': case '\\'
43	schorsch	2.14	#define PATHSEP ';'
44			#define CURDIR '.'
45	greg	2.25	#define DEFAULT_TEMPDIRS {"C:/TMP", "C:/TEMP", ".", NULL}
46			#define TEMPLATE "rtXXXXXX"
47	schorsch	2.14	#define TEMPLEN 8
48			#define ULIBVAR "RAYPATH"
49			#ifndef DEFPATH
50			#define DEFPATH ";c:/ray/lib"
51			#endif
52	greg	2.25	#define SPECIALS " \t\"$*?\|"
53			#define QUOTCHAR '"'
54	schorsch	2.14	/* <io.h> only does half the work for access() */
55			#ifndef F_OK
56			#define F_OK 00
57			#define W_OK 02
58	greg	2.23	#endif
59			#ifndef R_OK
60			#define X_OK 01
61			#define R_OK 04
62	schorsch	2.14	#endif
63	schorsch	2.17	/* to make the permissions user specific we'd need to use CreateFile() */
64			#ifndef S_IRUSR
65			#define S_IRUSR _S_IREAD
66			#define S_IWUSR _S_IWRITE
67			#endif
68	schorsch	2.19
69	schorsch	2.16	#else /* everything but Windows */
70			#include <unistd.h>
71			#include <sys/param.h>
72
73			#define RMAX_PATH_MAX 4096 /* our own maximum */
74			#ifndef PATH_MAX
75			#define PATH_MAX 512
76			#elif PATH_MAX > RMAX_PATH_MAX /* the OS is exaggerating */
77			#undef PATH_MAX
78			#define PATH_MAX RMAX_PATH_MAX
79	schorsch	2.14	#endif
80
81			#ifdef AMIGA
82
83	schorsch	2.20	#define NULL_DEVICE "NIL:"
84	schorsch	2.14	#define DIRSEP '/'
85	greg	2.24	#define ISABS(s) ISDIRSEP((s)[0])
86	schorsch	2.14	#define PATHSEP ';'
87			#define CURDIR '.'
88	greg	2.25	#define DEFAULT_TEMPDIRS {"/var/tmp", "/usr/tmp", "/tmp", ".", NULL}
89			#define TEMPLATE "/tmp/rtXXXXXX"
90	schorsch	2.14	#define TEMPLEN 13
91			#define ULIBVAR "RAYPATH"
92			#ifndef DEFPATH
93			#define DEFPATH ";/ray/lib"
94			#endif
95
96			#else
97
98	schorsch	2.16	/* posix */
99
100			/* this is defined as _PATH_DEVNULL in /usr/include/paths.h on Linux */
101			#define NULL_DEVICE "/dev/null"
102	schorsch	2.14	#define DIRSEP '/'
103	greg	2.24	#define ISABS(s) ISDIRSEP((s)[0])
104	schorsch	2.14	#define PATHSEP ':'
105			#define CURDIR '.'
106	greg	2.25	#define DEFAULT_TEMPDIRS {"/var/tmp", "/usr/tmp", "/tmp", ".", NULL}
107			#define TEMPLATE "/tmp/rtXXXXXX"
108	greg	2.30	#define TEMPLEN 13
109	schorsch	2.14	#define ULIBVAR "RAYPATH"
110			#ifndef DEFPATH
111			#define DEFPATH ":/usr/local/lib/ray"
112			#endif
113	greg	2.25	#define SPECIALS " \t\n'\"()${}*?[];\|&"
114			#define QUOTCHAR '\''
115			#define ALTQUOT '"'
116	greg	2.1
117	schorsch	2.14	#endif
118	greg	2.2	#endif
119
120			#ifndef ISDIRSEP
121	schorsch	2.14	#define ISDIRSEP(c) ((c)==DIRSEP)
122	greg	2.2	#endif
123			#ifndef CASEDIRSEP
124	schorsch	2.14	#define CASEDIRSEP case DIRSEP
125	greg	2.1	#endif
126
127	schorsch	2.19	#ifdef __cplusplus
128			extern "C" {
129			#endif
130	schorsch	2.13
131	schorsch	2.27	#if defined(_WIN32) \|\| defined(_WIN64)
132	greg	2.25	extern FILE win_popen(char command, char *type);
133			extern int win_pclose(FILE *p);
134			#endif
135
136	greg	2.32	/* Set global progname and return path-free version of argv[0] */
137			extern char fixargv0(char arg0);
138			extern char *progname;
139
140	greg	2.25	/* Check if any of the characters in str2 are found in str1 */
141			extern int matchany(const char str1, const char str2);
142
143			/* Convert a set of arguments into a command line for pipe() or system() */
144			extern char convert_commandline(char cmd, const int len, char *av[]);
145
146	schorsch	2.13	/* Find a writeable directory for temporary files */
147			/* If s is NULL, we return a static string */
148			extern char temp_directory(char s, size_t len);
149
150			/* Compose a currently unique name within a temporary directory */
151			/* If s is NULL, we return a static string */
152			/* If templ is NULL, we take our default template */
153			/* WARNING: On Windows, there's a maximum of 27 unique names within
154			one process for the same template. */
155			extern char temp_filename(char s, size_t len, char *templ);
156
157			/* Same as above, but also open the file and return the descriptor */
158			/* This one is supposed to protect against race conditions on unix */
159			/* WARNING: On Windows, there's no protection against race conditions */
160	schorsch	2.16	extern int temp_fd(char s, size_t len, char templ);
161
162			/* Same as above, but return a file pointer instead of a descriptor */
163			extern FILE temp_fp(char s, size_t len, char *templ);
164	schorsch	2.13
165			/* Concatenate two strings, leaving exactly one DIRSEP in between */
166			extern char append_filepath(char s1, char *s2, size_t len);
167	schorsch	2.12
168
169			#ifdef __cplusplus
170			}
171			#endif
172			#endif /* _RAD_PATHS_H_ */
173