Fix build error on Windows 32 bit.
[blender-staging.git] / source / blender / blenlib / intern / storage.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * Reorganised mar-01 nzc
27  * Some really low-level file thingies.
28  */
29
30 /** \file blender/blenlib/intern/storage.c
31  *  \ingroup bli
32  */
33
34 #include <sys/types.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37
38 #include <sys/stat.h>
39
40 #if defined(__NetBSD__) || defined(__DragonFly__) || defined(__HAIKU__)
41    /* Other modern unix os's should probably use this also */
42 #  include <sys/statvfs.h>
43 #  define USE_STATFS_STATVFS
44 #endif
45
46 #if defined(__APPLE__) || defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) || defined(__DragonFly__)
47    /* For statfs */
48 #  include <sys/param.h>
49 #  include <sys/mount.h>
50 #endif
51
52 #if defined(__linux__) || defined(__hpux) || defined(__GNU__) || defined(__GLIBC__)
53 #  include <sys/vfs.h>
54 #endif
55
56 #include <fcntl.h>
57 #include <string.h>  /* strcpy etc.. */
58
59 #ifdef WIN32
60 #  include <io.h>
61 #  include <direct.h>
62 #  include "BLI_winstuff.h"
63 #  include "utfconv.h"
64 #else
65 #  include <sys/ioctl.h>
66 #  include <unistd.h>
67 #  include <pwd.h>
68 #endif
69
70 /* lib includes */
71 #include "MEM_guardedalloc.h"
72
73 #include "BLI_utildefines.h"
74 #include "BLI_linklist.h"
75 #include "BLI_string.h"
76 #include "BLI_fileops.h"
77 #include "BLI_fileops_types.h"
78 #include "BLI_path_util.h"
79
80 /**
81  * Copies the current working directory into *dir (max size maxncpy), and
82  * returns a pointer to same.
83  *
84  * \note can return NULL when the size is not big enough
85  */
86 char *BLI_current_working_dir(char *dir, const size_t maxncpy)
87 {
88         const char *pwd = getenv("PWD");
89         if (pwd) {
90                 size_t srclen = BLI_strnlen(pwd, maxncpy);
91                 if (srclen != maxncpy) {
92                         memcpy(dir, pwd, srclen + 1);
93                         return dir;
94                 }
95                 else {
96                         return NULL;
97                 }
98         }
99
100         return getcwd(dir, maxncpy);
101 }
102
103 /**
104  * Returns the number of free bytes on the volume containing the specified pathname. */
105 /* Not actually used anywhere.
106  */
107 double BLI_dir_free_space(const char *dir)
108 {
109 #ifdef WIN32
110         DWORD sectorspc, bytesps, freec, clusters;
111         char tmp[4];
112
113         tmp[0] = '\\'; tmp[1] = 0; /* Just a failsafe */
114         if (dir[0] == '/' || dir[0] == '\\') {
115                 tmp[0] = '\\';
116                 tmp[1] = 0;
117         }
118         else if (dir[1] == ':') {
119                 tmp[0] = dir[0];
120                 tmp[1] = ':';
121                 tmp[2] = '\\';
122                 tmp[3] = 0;
123         }
124
125         GetDiskFreeSpace(tmp, &sectorspc, &bytesps, &freec, &clusters);
126
127         return (double) (freec * bytesps * sectorspc);
128 #else
129
130 #ifdef USE_STATFS_STATVFS
131         struct statvfs disk;
132 #else
133         struct statfs disk;
134 #endif
135
136         char name[FILE_MAXDIR], *slash;
137         int len = strlen(dir);
138
139         if (len >= FILE_MAXDIR) /* path too long */
140                 return -1;
141
142         strcpy(name, dir);
143
144         if (len) {
145                 slash = strrchr(name, '/');
146                 if (slash) slash[1] = 0;
147         }
148         else {
149                 strcpy(name, "/");
150         }
151
152 #if  defined(USE_STATFS_STATVFS)
153         if (statvfs(name, &disk)) return -1;
154 #elif defined(USE_STATFS_4ARGS)
155         if (statfs(name, &disk, sizeof(struct statfs), 0)) return -1;
156 #else
157         if (statfs(name, &disk)) return -1;
158 #endif
159
160         return ( ((double) disk.f_bsize) * ((double) disk.f_bfree));
161 #endif
162 }
163
164
165 /**
166  * Returns the file size of an opened file descriptor.
167  */
168 size_t BLI_file_descriptor_size(int file)
169 {
170         struct stat st;
171         if ((file < 0) || (fstat(file, &st) == -1))
172                 return -1;
173         return st.st_size;
174 }
175
176 /**
177  * Returns the size of a file.
178  */
179 size_t BLI_file_size(const char *path)
180 {
181         BLI_stat_t stats;
182         if (BLI_stat(path, &stats) == -1)
183                 return -1;
184         return stats.st_size;
185 }
186
187 /**
188  * Returns the st_mode from stat-ing the specified path name, or 0 if stat fails
189  * (most likely doesn't exist or no access).
190  */
191 int BLI_exists(const char *name)
192 {
193 #if defined(WIN32)
194         BLI_stat_t st;
195         wchar_t *tmp_16 = alloc_utf16_from_8(name, 1);
196         int len, res;
197         unsigned int old_error_mode;
198
199         len = wcslen(tmp_16);
200         /* in Windows #stat doesn't recognize dir ending on a slash
201          * so we remove it here */
202         if (len > 3 && (tmp_16[len - 1] == L'\\' || tmp_16[len - 1] == L'/')) {
203                 tmp_16[len - 1] = '\0';
204         }
205         /* two special cases where the trailing slash is needed:
206          * 1. after the share part of a UNC path
207          * 2. after the C:\ when the path is the volume only
208          */
209         if ((len >= 3) && (tmp_16[0] ==  L'\\') && (tmp_16[1] ==  L'\\')) {
210                 BLI_cleanup_unc_16(tmp_16);
211         }
212
213         if ((tmp_16[1] ==  L':') && (tmp_16[2] ==  L'\0')) {
214                 tmp_16[2] = L'\\';
215                 tmp_16[3] = L'\0';
216         }
217
218
219         /* change error mode so user does not get a "no disk in drive" popup
220          * when looking for a file on an empty CD/DVD drive */
221         old_error_mode = SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOOPENFILEERRORBOX);
222
223         res = BLI_wstat(tmp_16, &st);
224
225         SetErrorMode(old_error_mode);
226
227         free(tmp_16);
228         if (res == -1) return(0);
229 #else
230         struct stat st;
231         BLI_assert(!BLI_path_is_rel(name));
232         if (stat(name, &st)) return(0);
233 #endif
234         return(st.st_mode);
235 }
236
237
238 #ifdef WIN32
239 int BLI_stat(const char *path, BLI_stat_t *buffer)
240 {
241         int r;
242         UTF16_ENCODE(path);
243
244         r = BLI_wstat(path_16, buffer);
245
246         UTF16_UN_ENCODE(path);
247         return r;
248 }
249
250 int BLI_wstat(const wchar_t *path, BLI_stat_t *buffer)
251 {
252 #if defined(_MSC_VER)
253         return _wstat64(path, buffer);
254 #else
255         return _wstat(path, buffer);
256 #endif
257 }
258 #else
259 int BLI_stat(const char *path, struct stat *buffer)
260 {
261         return stat(path, buffer);
262 }
263 #endif
264
265 /**
266  * Does the specified path point to a directory?
267  * \note Would be better in fileops.c except that it needs stat.h so add here
268  */
269 bool BLI_is_dir(const char *file)
270 {
271         return S_ISDIR(BLI_exists(file));
272 }
273
274 /**
275  * Does the specified path point to a non-directory?
276  */
277 bool BLI_is_file(const char *path)
278 {
279         const int mode = BLI_exists(path);
280         return (mode && !S_ISDIR(mode));
281 }
282
283 void *BLI_file_read_text_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size)
284 {
285         FILE *fp = BLI_fopen(filepath, "r");
286         void *mem = NULL;
287
288         if (fp) {
289                 fseek(fp, 0L, SEEK_END);
290                 const long int filelen = ftell(fp);
291                 if (filelen == -1) {
292                         goto finally;
293                 }
294                 fseek(fp, 0L, SEEK_SET);
295
296                 mem = MEM_mallocN(filelen + pad_bytes, __func__);
297                 if (mem == NULL) {
298                         goto finally;
299                 }
300
301                 const long int filelen_read = fread(mem, 1, filelen, fp);
302                 if ((filelen_read < 0) || ferror(fp)) {
303                         MEM_freeN(mem);
304                         mem = NULL;
305                         goto finally;
306                 }
307
308                 if (filelen_read < filelen) {
309                         mem = MEM_reallocN(mem, filelen_read + pad_bytes);
310                         if (mem == NULL) {
311                                 goto finally;
312                         }
313                 }
314
315                 *r_size = filelen_read;
316
317 finally:
318                 fclose(fp);
319         }
320
321         return mem;
322 }
323
324 void *BLI_file_read_binary_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size)
325 {
326         FILE *fp = BLI_fopen(filepath, "rb");
327         void *mem = NULL;
328
329         if (fp) {
330                 fseek(fp, 0L, SEEK_END);
331                 const long int filelen = ftell(fp);
332                 if (filelen == -1) {
333                         goto finally;
334                 }
335                 fseek(fp, 0L, SEEK_SET);
336
337                 mem = MEM_mallocN(filelen + pad_bytes, __func__);
338                 if (mem == NULL) {
339                         goto finally;
340                 }
341
342                 const long int filelen_read = fread(mem, 1, filelen, fp);
343                 if ((filelen_read != filelen) || ferror(fp)) {
344                         MEM_freeN(mem);
345                         mem = NULL;
346                         goto finally;
347                 }
348
349                 *r_size = filelen_read;
350
351 finally:
352                 fclose(fp);
353         }
354
355         return mem;
356 }
357
358 /**
359  * Reads the contents of a text file and returns the lines in a linked list.
360  */
361 LinkNode *BLI_file_read_as_lines(const char *name)
362 {
363         FILE *fp = BLI_fopen(name, "r");
364         LinkNodePair lines = {NULL, NULL};
365         char *buf;
366         size_t size;
367
368         if (!fp) return NULL;
369
370         fseek(fp, 0, SEEK_END);
371         size = (size_t)ftell(fp);
372         fseek(fp, 0, SEEK_SET);
373
374         if (UNLIKELY(size == (size_t)-1)) {
375                 fclose(fp);
376                 return NULL;
377         }
378
379         buf = MEM_mallocN(size, "file_as_lines");
380         if (buf) {
381                 size_t i, last = 0;
382
383                 /*
384                  * size = because on win32 reading
385                  * all the bytes in the file will return
386                  * less bytes because of `CRNL` changes.
387                  */
388                 size = fread(buf, 1, size, fp);
389                 for (i = 0; i <= size; i++) {
390                         if (i == size || buf[i] == '\n') {
391                                 char *line = BLI_strdupn(&buf[last], i - last);
392                                 BLI_linklist_append(&lines, line);
393                                 last = i + 1;
394                         }
395                 }
396
397                 MEM_freeN(buf);
398         }
399
400         fclose(fp);
401
402         return lines.list;
403 }
404
405 /*
406  * Frees memory from a previous call to BLI_file_read_as_lines.
407  */
408 void BLI_file_free_lines(LinkNode *lines)
409 {
410         BLI_linklist_freeN(lines);
411 }
412
413 /** is file1 older then file2 */
414 bool BLI_file_older(const char *file1, const char *file2)
415 {
416 #ifdef WIN32
417         struct _stat st1, st2;
418
419         UTF16_ENCODE(file1);
420         UTF16_ENCODE(file2);
421
422         if (_wstat(file1_16, &st1)) return false;
423         if (_wstat(file2_16, &st2)) return false;
424
425         UTF16_UN_ENCODE(file2);
426         UTF16_UN_ENCODE(file1);
427 #else
428         struct stat st1, st2;
429
430         if (stat(file1, &st1)) return false;
431         if (stat(file2, &st2)) return false;
432 #endif
433         return (st1.st_mtime < st2.st_mtime);
434 }