src/common/paths.h

/* RCSid $Id: paths.h,v 2.24 2012/06/29 23:09:06 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>

#ifdef _WIN32
  #include <io.h>
  #include <direct.h> /* getcwd(), chdir(), _mkdir(), etc. */

  #define access                _access
  #define mkdir(dirname,perms)  _mkdir(dirname)
  #ifdef _MSC_VER
    #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
    #define      fixargv0(a0)   (a0)

  #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             17
    #define ULIBVAR             "RAYPATH"
    #ifndef DEFPATH
      #define DEFPATH           ":/usr/local/lib/ray"
    #endif
    #define SPECIALS            " \t\n'\"()${}*?[];|&"
    #define QUOTCHAR            '\''
    #define ALTQUOT             '"'
    #define      fixargv0(a0)   (a0)

  #endif
#endif

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

#ifdef __cplusplus
extern "C" {
#endif

#if _WIN32
  extern FILE *win_popen(char *command, char *type);
  extern int win_pclose(FILE *p);
  extern int win_kill(RT_PID pid, int sig /* ignored */);
  extern char  *fixargv0();
#endif

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