1 /* gstdio.h - GFilename wrappers for C library functions
2  *
3  * Copyright 2004 Tor Lillqvist
4  *
5  * GLib is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU Lesser General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or (at your option) any later version.
9  *
10  * GLib 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 GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with GLib; see the file COPYING.LIB.  If not,
17  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20 
21 #ifndef __G_STDIO_H__
22 #define __G_STDIO_H__
23 
24 #include <glib/gprintf.h>
25 
26 #include <sys/stat.h>
27 
28 G_BEGIN_DECLS
29 
30 #if defined (_MSC_VER) && !defined(_WIN64)
31 
32 /* Make it clear that we mean the struct with 32-bit st_size and
33  * 32-bit st_*time fields as that is how the 32-bit GLib DLL normally
34  * has been compiled. If you get a compiler warning when calling
35  * g_stat(), do take it seriously and make sure that the type of
36  * struct stat the code in GLib fills in matches the struct the type
37  * of struct stat you pass to g_stat(). To avoid hassle, to get file
38  * attributes just use the GIO API instead which doesn't use struct
39  * stat.
40  *
41  * Sure, it would be nicer to use a struct with 64-bit st_size and
42  * 64-bit st_*time fields, but changing that now would break ABI. And
43  * in MinGW, a plain "struct stat" is the one with 32-bit st_size and
44  * st_*time fields.
45  */
46 
47 typedef struct _stat32 GStatBuf;
48 
49 #else
50 
51 typedef struct stat GStatBuf;
52 
53 #endif
54 
55 #if defined(G_OS_UNIX) && !defined(G_STDIO_NO_WRAP_ON_UNIX)
56 
57 /* Just pass on to the system functions, so there's no potential for data
58  * format mismatches, especially with large file interfaces.
59  * A few functions can't be handled in this way, since they are not defined
60  * in a portable system header that we could include here.
61  */
62 
63 #ifndef __GTK_DOC_IGNORE__
64 #define g_chmod   chmod
65 #define g_open    open
66 #define g_creat   creat
67 #define g_rename  rename
68 #define g_mkdir   mkdir
69 #define g_stat    stat
70 #define g_lstat   lstat
71 #define g_remove  remove
72 #define g_fopen   fopen
73 #define g_freopen freopen
74 #define g_utime   utime
75 #endif
76 
77 int g_access (const gchar *filename,
78 	      int          mode);
79 
80 int g_chdir  (const gchar *path);
81 
82 int g_unlink (const gchar *filename);
83 
84 int g_rmdir  (const gchar *filename);
85 
86 #else /* ! G_OS_UNIX */
87 
88 /* Wrappers for C library functions that take pathname arguments. On
89  * Unix, the pathname is a file name as it literally is in the file
90  * system. On well-maintained systems with consistent users who know
91  * what they are doing and no exchange of files with others this would
92  * be a well-defined encoding, preferably UTF-8. On Windows, the
93  * pathname is always in UTF-8, even if that is not the on-disk
94  * encoding, and not the encoding accepted by the C library or Win32
95  * API.
96  */
97 
98 int g_access    (const gchar *filename,
99 		 int          mode);
100 
101 int g_chmod     (const gchar *filename,
102 		 int          mode);
103 
104 int g_open      (const gchar *filename,
105                  int          flags,
106                  int          mode);
107 
108 int g_creat     (const gchar *filename,
109                  int          mode);
110 
111 int g_rename    (const gchar *oldfilename,
112                  const gchar *newfilename);
113 
114 int g_mkdir     (const gchar *filename,
115                  int          mode);
116 
117 int g_chdir     (const gchar *path);
118 
119 int g_stat      (const gchar *filename,
120                  GStatBuf    *buf);
121 
122 int g_lstat     (const gchar *filename,
123                  GStatBuf    *buf);
124 
125 int g_unlink    (const gchar *filename);
126 
127 int g_remove    (const gchar *filename);
128 
129 int g_rmdir     (const gchar *filename);
130 
131 FILE *g_fopen   (const gchar *filename,
132                  const gchar *mode);
133 
134 FILE *g_freopen (const gchar *filename,
135                  const gchar *mode,
136                  FILE        *stream);
137 
138 struct utimbuf;			/* Don't need the real definition of struct utimbuf when just
139 				 * including this header.
140 				 */
141 
142 int g_utime     (const gchar    *filename,
143 		 struct utimbuf *utb);
144 
145 #endif /* G_OS_UNIX */
146 
147 G_END_DECLS
148 
149 #endif /* __G_STDIO_H__ */
150