9a9385e0687a025f8cf692b4e745ddecf5a803f1
[blender.git] / source / blender / blenlib / intern / path_util.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  *
27  * various string, file, list operations.
28  */
29
30 /** \file blender/blenlib/intern/path_util.c
31  *  \ingroup bli
32  */
33
34 #include <ctype.h>
35 #include <string.h>
36 #include <stdlib.h>
37 #include <assert.h>
38
39 #include "DNA_listBase.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_fileops.h"
43 #include "BLI_path_util.h"
44 #include "BLI_string.h"
45 #include "BLI_string_utf8.h"
46 #include "BLI_fnmatch.h"
47
48 #ifdef WIN32
49 #  include "utf_winfunc.h"
50 #  include "utfconv.h"
51 #  include <io.h>
52 #  ifdef _WIN32_IE
53 #    undef _WIN32_IE
54 #  endif
55 #  define _WIN32_IE 0x0501
56 #  include <windows.h>
57 #  include <shlobj.h>
58 #  include "BLI_winstuff.h"
59 #  include "MEM_guardedalloc.h"
60 #endif /* WIN32 */
61
62 /* local */
63 #define UNIQUE_NAME_MAX 128
64
65 /* implementation */
66
67 /**
68  * Looks for a sequence of decimal digits in string, preceding any filename extension,
69  * returning the integer value if found, or 0 if not.
70  *
71  * \param string  String to scan.
72  * \param head  Optional area to return copy of part of string prior to digits, or before dot if no digits.
73  * \param tail  Optional area to return copy of part of string following digits, or from dot if no digits.
74  * \param numlen  Optional to return number of digits found.
75  */
76 int BLI_stringdec(const char *string, char *head, char *tail, unsigned short *numlen)
77 {
78         unsigned int nums = 0, nume = 0;
79         int i;
80         bool found_digit = false;
81         const char * const lslash = BLI_last_slash(string);
82         const unsigned int string_len = strlen(string);
83         const unsigned int lslash_len = lslash != NULL ? (int)(lslash - string) : 0;
84         unsigned int name_end = string_len;
85
86         while (name_end > lslash_len && string[--name_end] != '.') {} /* name ends at dot if present */
87         if (name_end == lslash_len && string[name_end] != '.') name_end = string_len;
88
89         for (i = name_end - 1; i >= (int)lslash_len; i--) {
90                 if (isdigit(string[i])) {
91                         if (found_digit) {
92                                 nums = i;
93                         }
94                         else {
95                                 nume = i;
96                                 nums = i;
97                                 found_digit = true;
98                         }
99                 }
100                 else {
101                         if (found_digit) break;
102                 }
103         }
104
105         if (found_digit) {
106                 if (tail) strcpy(tail, &string[nume + 1]);
107                 if (head) {
108                         strcpy(head, string);
109                         head[nums] = 0;
110                 }
111                 if (numlen) *numlen = nume - nums + 1;
112                 return ((int)atoi(&(string[nums])));
113         }
114         else {
115                 if (tail) strcpy(tail, string + name_end);
116                 if (head) {
117                         /* name_end points to last character of head,
118                          * make it +1 so null-terminator is nicely placed
119                          */
120                         BLI_strncpy(head, string, name_end + 1);
121                 }
122                 if (numlen) *numlen = 0;
123                 return 0;
124         }
125 }
126
127
128 /**
129  * Returns in area pointed to by string a string of the form "<head><pic><tail>", where pic
130  * is formatted as numlen digits with leading zeroes.
131  */
132 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic)
133 {
134         sprintf(string, "%s%.*d%s", head, numlen, MAX2(0, pic), tail);
135 }
136
137 /**
138  * Looks for a numeric suffix preceded by delim character on the end of
139  * name, puts preceding part into *left and value of suffix into *nr.
140  * Returns the length of *left.
141  *
142  * Foo.001 -> "Foo", 1
143  * Returning the length of "Foo"
144  *
145  * \param left  Where to return copy of part preceding delim
146  * \param nr  Where to return value of numeric suffix
147  * \param name  String to split
148  * \param delim  Delimiter character
149  * \return  Length of \a left
150  */
151 int BLI_split_name_num(char *left, int *nr, const char *name, const char delim)
152 {
153         const int name_len = strlen(name);
154
155         *nr = 0;
156         memcpy(left, name, (name_len + 1) * sizeof(char));
157
158         /* name doesn't end with a delimiter "foo." */
159         if ((name_len > 1 && name[name_len - 1] == delim) == 0) {
160                 int a = name_len;
161                 while (a--) {
162                         if (name[a] == delim) {
163                                 left[a] = '\0';  /* truncate left part here */
164                                 *nr = atol(name + a + 1);
165                                 /* casting down to an int, can overflow for large numbers */
166                                 if (*nr < 0)
167                                         *nr = 0;
168                                 return a;
169                         }
170                         else if (isdigit(name[a]) == 0) {
171                                 /* non-numeric suffix - give up */
172                                 break;
173                         }
174                 }
175         }
176
177         return name_len;
178 }
179
180 /**
181  * Looks for a string of digits within name (using BLI_stringdec) and adjusts it by add.
182  */
183 void BLI_newname(char *name, int add)
184 {
185         char head[UNIQUE_NAME_MAX], tail[UNIQUE_NAME_MAX];
186         int pic;
187         unsigned short digits;
188         
189         pic = BLI_stringdec(name, head, tail, &digits);
190         
191         /* are we going from 100 -> 99 or from 10 -> 9 */
192         if (add < 0 && digits < 4 && digits > 0) {
193                 int i, exp;
194                 exp = 1;
195                 for (i = digits; i > 1; i--) exp *= 10;
196                 if (pic >= exp && (pic + add) < exp) digits--;
197         }
198         
199         pic += add;
200         
201         if (digits == 4 && pic < 0) pic = 0;
202         BLI_stringenc(name, head, tail, digits, pic);
203 }
204
205 /**
206  * Ensures name is unique (according to criteria specified by caller in unique_check callback),
207  * incrementing its numeric suffix as necessary. Returns true if name had to be adjusted.
208  *
209  * \param unique_check  Return true if name is not unique
210  * \param arg  Additional arg to unique_check--meaning is up to caller
211  * \param defname  To initialize name if latter is empty
212  * \param delim  Delimits numeric suffix in name
213  * \param name  Name to be ensured unique
214  * \param name_len  Maximum length of name area
215  * \return true if there if the name was changed
216  */
217 bool BLI_uniquename_cb(bool (*unique_check)(void *arg, const char *name),
218                        void *arg, const char *defname, char delim, char *name, int name_len)
219 {
220         if (name[0] == '\0') {
221                 BLI_strncpy(name, defname, name_len);
222         }
223
224         if (unique_check(arg, name)) {
225                 char numstr[16];
226                 char tempname[UNIQUE_NAME_MAX];
227                 char left[UNIQUE_NAME_MAX];
228                 int number;
229                 int len = BLI_split_name_num(left, &number, name, delim);
230                 do {
231                         const int numlen = BLI_snprintf(numstr, sizeof(numstr), "%c%03d", delim, ++number);
232
233                         /* highly unlikely the string only has enough room for the number
234                          * but support anyway */
235                         if ((len == 0) || (numlen >= name_len)) {
236                                 /* number is know not to be utf-8 */
237                                 BLI_strncpy(tempname, numstr, name_len);
238                         }
239                         else {
240                                 char *tempname_buf;
241                                 tempname[0] = '\0';
242                                 tempname_buf = BLI_strncat_utf8(tempname, left, name_len - numlen);
243                                 memcpy(tempname_buf, numstr, numlen + 1);
244                         }
245                 } while (unique_check(arg, tempname));
246
247                 BLI_strncpy(name, tempname, name_len);
248                 
249                 return true;
250         }
251         
252         return false;
253 }
254
255 /* little helper macro for BLI_uniquename */
256 #ifndef GIVE_STRADDR
257 #  define GIVE_STRADDR(data, offset) ( ((char *)data) + offset)
258 #endif
259
260 /* Generic function to set a unique name. It is only designed to be used in situations
261  * where the name is part of the struct, and also that the name is at most UNIQUE_NAME_MAX chars long.
262  * 
263  * For places where this is used, see constraint.c for example...
264  *
265  *  name_offs: should be calculated using offsetof(structname, membername) macro from stddef.h
266  *  len: maximum length of string (to prevent overflows, etc.)
267  *  defname: the name that should be used by default if none is specified already
268  *  delim: the character which acts as a delimiter between parts of the name
269  */
270 static bool uniquename_find_dupe(ListBase *list, void *vlink, const char *name, int name_offs)
271 {
272         Link *link;
273
274         for (link = list->first; link; link = link->next) {
275                 if (link != vlink) {
276                         if (STREQ(GIVE_STRADDR(link, name_offs), name)) {
277                                 return true;
278                         }
279                 }
280         }
281
282         return false;
283 }
284
285 static bool uniquename_unique_check(void *arg, const char *name)
286 {
287         struct {ListBase *lb; void *vlink; int name_offs; } *data = arg;
288         return uniquename_find_dupe(data->lb, data->vlink, name, data->name_offs);
289 }
290
291 /**
292  * Ensures that the specified block has a unique name within the containing list,
293  * incrementing its numeric suffix as necessary.
294  *
295  * \param list  List containing the block
296  * \param vlink  The block to check the name for
297  * \param defname  To initialize block name if latter is empty
298  * \param delim  Delimits numeric suffix in name
299  * \param name_offs  Offset of name within block structure
300  * \param name_len  Maximum length of name area
301  */
302 void BLI_uniquename(ListBase *list, void *vlink, const char *defname, char delim, int name_offs, int name_len)
303 {
304         struct {ListBase *lb; void *vlink; int name_offs; } data;
305         data.lb = list;
306         data.vlink = vlink;
307         data.name_offs = name_offs;
308
309         assert((name_len > 1) && (name_len <= UNIQUE_NAME_MAX));
310
311         /* See if we are given an empty string */
312         if (ELEM(NULL, vlink, defname))
313                 return;
314
315         BLI_uniquename_cb(uniquename_unique_check, &data, defname, delim, GIVE_STRADDR(vlink, name_offs), name_len);
316 }
317
318 static int BLI_path_unc_prefix_len(const char *path); /* defined below in same file */
319
320 /* ******************** string encoding ***************** */
321
322 /* This is quite an ugly function... its purpose is to
323  * take the dir name, make it absolute, and clean it up, replacing
324  * excess file entry stuff (like /tmp/../tmp/../)
325  * note that dir isn't protected for max string names... 
326  * 
327  * If relbase is NULL then its ignored
328  */
329
330 void BLI_cleanup_path(const char *relabase, char *path)
331 {
332         ptrdiff_t a;
333         char *start, *eind;
334         if (relabase) {
335                 BLI_path_abs(path, relabase);
336         }
337         else {
338                 if (path[0] == '/' && path[1] == '/') {
339                         if (path[2] == '\0') {
340                                 return; /* path is "//" - cant clean it */
341                         }
342                         path = path + 2;  /* leave the initial "//" untouched */
343                 }
344         }
345         
346         /* Note
347          *   memmove(start, eind, strlen(eind) + 1);
348          * is the same as
349          *   strcpy( start, eind ); 
350          * except strcpy should not be used because there is overlap,
351          * so use memmove's slightly more obscure syntax - Campbell
352          */
353         
354 #ifdef WIN32
355         while ( (start = strstr(path, "\\..\\")) ) {
356                 eind = start + strlen("\\..\\") - 1;
357                 a = start - path - 1;
358                 while (a > 0) {
359                         if (path[a] == '\\') break;
360                         a--;
361                 }
362                 if (a < 0) {
363                         break;
364                 }
365                 else {
366                         memmove(path + a, eind, strlen(eind) + 1);
367                 }
368         }
369
370         while ( (start = strstr(path, "\\.\\")) ) {
371                 eind = start + strlen("\\.\\") - 1;
372                 memmove(start, eind, strlen(eind) + 1);
373         }
374
375         /* remove two consecutive backslashes, but skip the UNC prefix,
376          * which needs to be preserved */
377         while ( (start = strstr(path + BLI_path_unc_prefix_len(path), "\\\\")) ) {
378                 eind = start + strlen("\\\\") - 1;
379                 memmove(start, eind, strlen(eind) + 1);
380         }
381 #else
382         while ( (start = strstr(path, "/../")) ) {
383                 a = start - path - 1;
384                 if (a > 0) {
385                         /* <prefix>/<parent>/../<postfix> => <prefix>/<postfix> */
386                         eind = start + (4 - 1) /* strlen("/../") - 1 */; /* strip "/.." and keep last "/" */
387                         while (a > 0 && path[a] != '/') { /* find start of <parent> */
388                                 a--;
389                         }
390                         memmove(path + a, eind, strlen(eind) + 1);
391                 }
392                 else {
393                         /* support for odd paths: eg /../home/me --> /home/me
394                          * this is a valid path in blender but we cant handle this the usual way below
395                          * simply strip this prefix then evaluate the path as usual.
396                          * pythons os.path.normpath() does this */
397
398                         /* Note: previous version of following call used an offset of 3 instead of 4,
399                          * which meant that the "/../home/me" example actually became "home/me".
400                          * Using offset of 3 gives behaviour consistent with the abovementioned
401                          * Python routine. */
402                         memmove(path, path + 3, strlen(path + 3) + 1);
403                 }
404         }
405
406         while ( (start = strstr(path, "/./")) ) {
407                 eind = start + (3 - 1) /* strlen("/./") - 1 */;
408                 memmove(start, eind, strlen(eind) + 1);
409         }
410
411         while ( (start = strstr(path, "//")) ) {
412                 eind = start + (2 - 1) /* strlen("//") - 1 */;
413                 memmove(start, eind, strlen(eind) + 1);
414         }
415 #endif
416 }
417
418 void BLI_cleanup_dir(const char *relabase, char *dir)
419 {
420         BLI_cleanup_path(relabase, dir);
421         BLI_add_slash(dir);
422
423 }
424
425 void BLI_cleanup_file(const char *relabase, char *path)
426 {
427         BLI_cleanup_path(relabase, path);
428         BLI_del_slash(path);
429 }
430
431 /**
432  * Does path begin with the special "//" prefix that Blender uses to indicate
433  * a path relative to the .blend file.
434  */
435 bool BLI_path_is_rel(const char *path)
436 {
437         return path[0] == '/' && path[1] == '/';
438 }
439
440 /* return true if the path is a UNC share */
441 bool BLI_path_is_unc(const char *name)
442 {
443         return name[0] == '\\' && name[1] == '\\';
444 }
445
446 /**
447  * Returns the length of the identifying prefix
448  * of a UNC path which can start with '\\' (short version)
449  * or '\\?\' (long version)
450  * If the path is not a UNC path, return 0
451  */
452 static int BLI_path_unc_prefix_len(const char *path)
453 {
454         if (BLI_path_is_unc(path)) {
455                 if ((path[2] == '?') && (path[3] == '\\') ) {
456                         /* we assume long UNC path like \\?\server\share\folder etc... */
457                         return 4;
458                 }
459                 else {
460                         return 2;
461                 }
462         }
463
464         return 0;
465 }
466
467 #if defined(WIN32)
468
469 /* return true if the path is absolute ie starts with a drive specifier (eg A:\) or is a UNC path */
470 static bool BLI_path_is_abs(const char *name)
471 {
472         return (name[1] == ':' && (name[2] == '\\' || name[2] == '/') ) || BLI_path_is_unc(name);
473 }
474
475 static wchar_t *next_slash(wchar_t *path)
476 {
477         wchar_t *slash = path;
478         while (*slash && *slash != L'\\') slash++;
479         return slash;
480 }
481
482 /* adds a slash if the unc path points sto a share */
483 static void BLI_path_add_slash_to_share(wchar_t *uncpath)
484 {
485         wchar_t *slash_after_server = next_slash(uncpath + 2);
486         if (*slash_after_server) {
487                 wchar_t *slash_after_share = next_slash(slash_after_server + 1);
488                 if (!(*slash_after_share)) {
489                         slash_after_share[0] = L'\\';
490                         slash_after_share[1] = L'\0';
491                 }
492         }
493 }
494
495 static void BLI_path_unc_to_short(wchar_t *unc)
496 {
497         wchar_t tmp[PATH_MAX];
498
499         int len = wcslen(unc);
500         int copy_start = 0;
501         /* convert:
502          *    \\?\UNC\server\share\folder\... to \\server\share\folder\...
503          *    \\?\C:\ to C:\ and \\?\C:\folder\... to C:\folder\...
504          */
505         if ((len > 3) &&
506             (unc[0] ==  L'\\') &&
507             (unc[1] ==  L'\\') &&
508             (unc[2] ==  L'?') &&
509             ((unc[3] ==  L'\\') || (unc[3] ==  L'/')))
510         {
511                 if ((len > 5) && (unc[5] ==  L':')) {
512                         wcsncpy(tmp, unc + 4, len - 4);
513                         tmp[len - 4] = L'\0';
514                         wcscpy(unc, tmp);
515                 }
516                 else if ((len > 7) && (wcsncmp(&unc[4], L"UNC", 3) == 0) &&
517                          ((unc[7] ==  L'\\') || (unc[7] ==  L'/')))
518                 {
519                         tmp[0] = L'\\';
520                         tmp[1] = L'\\';
521                         wcsncpy(tmp + 2, unc + 8, len - 8);
522                         tmp[len - 6] = L'\0';
523                         wcscpy(unc, tmp);
524                 }
525         }
526 }
527
528 void BLI_cleanup_unc(char *path, int maxlen)
529 {
530         wchar_t *tmp_16 = alloc_utf16_from_8(path, 1);
531         BLI_cleanup_unc_16(tmp_16);
532         conv_utf_16_to_8(tmp_16, path, maxlen);
533 }
534
535 void BLI_cleanup_unc_16(wchar_t *path_16)
536 {
537         BLI_path_unc_to_short(path_16);
538         BLI_path_add_slash_to_share(path_16);
539 }
540 #endif
541
542 /**
543  * Replaces *file with a relative version (prefixed by "//") such that BLI_path_abs, given
544  * the same *relfile, will convert it back to its original value.
545  */
546 void BLI_path_rel(char *file, const char *relfile)
547 {
548         const char *lslash;
549         char temp[FILE_MAX];
550         char res[FILE_MAX];
551         
552         /* if file is already relative, bail out */
553         if (BLI_path_is_rel(file)) {
554                 return;
555         }
556         
557         /* also bail out if relative path is not set */
558         if (relfile[0] == '\0') {
559                 return;
560         }
561
562 #ifdef WIN32
563         if (BLI_strnlen(relfile, 3) > 2 && !BLI_path_is_abs(relfile)) {
564                 char *ptemp;
565                 /* fix missing volume name in relative base,
566                  * can happen with old recent-files.txt files */
567                 get_default_root(temp);
568                 ptemp = &temp[2];
569                 if (relfile[0] != '\\' && relfile[0] != '/') {
570                         ptemp++;
571                 }
572                 BLI_strncpy(ptemp, relfile, FILE_MAX - 3);
573         }
574         else {
575                 BLI_strncpy(temp, relfile, FILE_MAX);
576         }
577
578         if (BLI_strnlen(file, 3) > 2) {
579                 bool is_unc = BLI_path_is_unc(file);
580
581                 /* Ensure paths are both UNC paths or are both drives */
582                 if (BLI_path_is_unc(temp) != is_unc) {
583                         return;
584                 }
585
586                 /* Ensure both UNC paths are on the same share */
587                 if (is_unc) {
588                         int off;
589                         int slash = 0;
590                         for (off = 0; temp[off] && slash < 4; off++) {
591                                 if (temp[off] != file[off])
592                                         return;
593
594                                 if (temp[off] == '\\')
595                                         slash++;
596                         }
597                 }
598                 else if (temp[1] == ':' && file[1] == ':' && temp[0] != file[0]) {
599                         return;
600                 }
601         }
602 #else
603         BLI_strncpy(temp, relfile, FILE_MAX);
604 #endif
605
606         BLI_char_switch(temp + BLI_path_unc_prefix_len(temp), '\\', '/');
607         BLI_char_switch(file + BLI_path_unc_prefix_len(file), '\\', '/');
608         
609         /* remove /./ which confuse the following slash counting... */
610         BLI_cleanup_path(NULL, file);
611         BLI_cleanup_path(NULL, temp);
612         
613         /* the last slash in the file indicates where the path part ends */
614         lslash = BLI_last_slash(temp);
615
616         if (lslash) {
617                 /* find the prefix of the filename that is equal for both filenames.
618                  * This is replaced by the two slashes at the beginning */
619                 const char *p = temp;
620                 const char *q = file;
621                 char *r = res;
622
623 #ifdef WIN32
624                 while (tolower(*p) == tolower(*q))
625 #else
626                 while (*p == *q)
627 #endif
628                 {
629                         p++;
630                         q++;
631
632                         /* don't search beyond the end of the string
633                          * in the rare case they match */
634                         if ((*p == '\0') || (*q == '\0')) {
635                                 break;
636                         }
637                 }
638
639                 /* we might have passed the slash when the beginning of a dir matches 
640                  * so we rewind. Only check on the actual filename
641                  */
642                 if (*q != '/') {
643                         while ( (q >= file) && (*q != '/') ) { --q; --p; }
644                 }
645                 else if (*p != '/') {
646                         while ( (p >= temp) && (*p != '/') ) { --p; --q; }
647                 }
648                 
649                 r += BLI_strcpy_rlen(r, "//");
650
651                 /* p now points to the slash that is at the beginning of the part
652                  * where the path is different from the relative path. 
653                  * We count the number of directories we need to go up in the
654                  * hierarchy to arrive at the common 'prefix' of the path
655                  */
656                 if (p < temp) p = temp;
657                 while (p && p < lslash) {
658                         if (*p == '/') {
659                                 r += BLI_strcpy_rlen(r, "../");
660                         }
661                         p++;
662                 }
663
664                 /* don't copy the slash at the beginning */
665                 r += BLI_strcpy_rlen(r, q + 1);
666                 
667 #ifdef  WIN32
668                 BLI_char_switch(res + 2, '/', '\\');
669 #endif
670                 strcpy(file, res);
671         }
672 }
673
674 /**
675  * Appends a suffix to the string, fitting it before the extension
676  *
677  * string = Foo.png, suffix = 123, separator = _
678  * Foo.png -> Foo_123.png
679  *
680  * \param string  original (and final) string
681  * \param maxlen  Maximum length of string
682  * \param suffix  String to append to the original string
683  * \param sep Optional separator character
684  * \return  true if succeeded
685  */
686 bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep)
687 {
688         const size_t string_len = strlen(string);
689         const size_t suffix_len = strlen(suffix);
690         const size_t sep_len = strlen(sep);
691         ssize_t a;
692         char extension[FILE_MAX];
693         bool has_extension = false;
694
695         if (string_len + sep_len + suffix_len >= maxlen)
696                 return false;
697
698         for (a = string_len - 1; a >= 0; a--) {
699                 if (string[a] == '.') {
700                         has_extension = true;
701                         break;
702                 }
703                 else if (ELEM(string[a], '/', '\\')) {
704                         break;
705                 }
706         }
707
708         if (!has_extension)
709                 a = string_len;
710
711         BLI_strncpy(extension, string + a, sizeof(extension));
712         sprintf(string + a, "%s%s%s", sep, suffix, extension);
713         return true;
714 }
715
716 /**
717  * Replaces path with the path of its parent directory, returning true if
718  * it was able to find a parent directory within the pathname.
719  */
720 bool BLI_parent_dir(char *path)
721 {
722         const char parent_dir[] = {'.', '.', SEP, '\0'}; /* "../" or "..\\" */
723         char tmp[FILE_MAX + 4];
724
725         BLI_join_dirfile(tmp, sizeof(tmp), path, parent_dir);
726         BLI_cleanup_dir(NULL, tmp); /* does all the work of normalizing the path for us */
727
728         if (!BLI_testextensie(tmp, parent_dir)) {
729                 BLI_strncpy(path, tmp, sizeof(tmp));
730                 return true;
731         }
732         else {
733                 return false;
734         }
735 }
736
737 /**
738  * Looks for a sequence of "#" characters in the last slash-separated component of *path,
739  * returning the indexes of the first and one past the last character in the sequence in
740  * *char_start and *char_end respectively. Returns true if such a sequence was found.
741  */
742 static bool stringframe_chars(const char *path, int *char_start, int *char_end)
743 {
744         unsigned int ch_sta, ch_end, i;
745         /* Insert current frame: file### -> file001 */
746         ch_sta = ch_end = 0;
747         for (i = 0; path[i] != '\0'; i++) {
748                 if (path[i] == '\\' || path[i] == '/') {
749                         ch_end = 0; /* this is a directory name, don't use any hashes we found */
750                 }
751                 else if (path[i] == '#') {
752                         ch_sta = i;
753                         ch_end = ch_sta + 1;
754                         while (path[ch_end] == '#') {
755                                 ch_end++;
756                         }
757                         i = ch_end - 1; /* keep searching */
758                         
759                         /* don't break, there may be a slash after this that invalidates the previous #'s */
760                 }
761         }
762
763         if (ch_end) {
764                 *char_start = ch_sta;
765                 *char_end = ch_end;
766                 return true;
767         }
768         else {
769                 *char_start = -1;
770                 *char_end = -1;
771                 return false;
772         }
773 }
774
775 /**
776  * Ensure *path contains at least one "#" character in its last slash-separated
777  * component, appending one digits long if not.
778  */
779 static void ensure_digits(char *path, int digits)
780 {
781         char *file = (char *)BLI_last_slash(path);
782
783         if (file == NULL)
784                 file = path;
785
786         if (strrchr(file, '#') == NULL) {
787                 int len = strlen(file);
788
789                 while (digits--) {
790                         file[len++] = '#';
791                 }
792                 file[len] = '\0';
793         }
794 }
795
796 /**
797  * Replaces "#" character sequence in last slash-separated component of *path
798  * with frame as decimal integer, with leading zeroes as necessary, to make digits digits.
799  */
800 bool BLI_path_frame(char *path, int frame, int digits)
801 {
802         int ch_sta, ch_end;
803
804         if (digits)
805                 ensure_digits(path, digits);
806
807         if (stringframe_chars(path, &ch_sta, &ch_end)) { /* warning, ch_end is the last # +1 */
808                 char tmp[FILE_MAX];
809                 BLI_snprintf(tmp, sizeof(tmp),
810                              "%.*s%.*d%s",
811                              ch_sta, path, ch_end - ch_sta, frame, path + ch_end);
812                 BLI_strncpy(path, tmp, FILE_MAX);
813                 return true;
814         }
815         return false;
816 }
817
818 /**
819  * Replaces "#" character sequence in last slash-separated component of *path
820  * with sta and end as decimal integers, with leading zeroes as necessary, to make digits
821  * digits each, with a hyphen in-between.
822  */
823 bool BLI_path_frame_range(char *path, int sta, int end, int digits)
824 {
825         int ch_sta, ch_end;
826
827         if (digits)
828                 ensure_digits(path, digits);
829
830         if (stringframe_chars(path, &ch_sta, &ch_end)) { /* warning, ch_end is the last # +1 */
831                 char tmp[FILE_MAX];
832                 BLI_snprintf(tmp, sizeof(tmp),
833                              "%.*s%.*d-%.*d%s",
834                              ch_sta, path, ch_end - ch_sta, sta, ch_end - ch_sta, end, path + ch_end);
835                 BLI_strncpy(path, tmp, FILE_MAX);
836                 return true;
837         }
838         return false;
839 }
840
841 /**
842  * Check if we have '#' chars, usable for #BLI_path_frame, #BLI_path_frame_range
843  */
844 bool BLI_path_frame_check_chars(const char *path)
845 {
846         int ch_sta, ch_end;  /* dummy args */
847         return stringframe_chars(path, &ch_sta, &ch_end);
848 }
849
850 /**
851  * If path begins with "//", strips that and replaces it with basepath directory. Also converts
852  * a drive-letter prefix to something more sensible if this is a non-drive-letter-based system.
853  * Returns true if "//" prefix expansion was done.
854  */
855 bool BLI_path_abs(char *path, const char *basepath)
856 {
857         const bool wasrelative = BLI_path_is_rel(path);
858         char tmp[FILE_MAX];
859         char base[FILE_MAX];
860 #ifdef WIN32
861
862         /* without this: "" --> "C:\" */
863         if (*path == '\0') {
864                 return wasrelative;
865         }
866
867         /* we are checking here if we have an absolute path that is not in the current
868          * blend file as a lib main - we are basically checking for the case that a 
869          * UNIX root '/' is passed.
870          */
871         if (!wasrelative && !BLI_path_is_abs(path)) {
872                 char *p = path;
873                 get_default_root(tmp);
874                 // get rid of the slashes at the beginning of the path
875                 while (*p == '\\' || *p == '/') {
876                         p++;
877                 }
878                 strcat(tmp, p);
879         }
880         else {
881                 BLI_strncpy(tmp, path, FILE_MAX);
882         }
883 #else
884         BLI_strncpy(tmp, path, sizeof(tmp));
885         
886         /* Check for loading a windows path on a posix system
887          * in this case, there is no use in trying C:/ since it 
888          * will never exist on a unix os.
889          * 
890          * Add a / prefix and lowercase the driveletter, remove the :
891          * C:\foo.JPG -> /c/foo.JPG */
892         
893         if (isalpha(tmp[0]) && tmp[1] == ':' && (tmp[2] == '\\' || tmp[2] == '/') ) {
894                 tmp[1] = tolower(tmp[0]); /* replace ':' with driveletter */
895                 tmp[0] = '/'; 
896                 /* '\' the slash will be converted later */
897         }
898         
899 #endif
900
901         /* push slashes into unix mode - strings entering this part are
902          * potentially messed up: having both back- and forward slashes.
903          * Here we push into one conform direction, and at the end we
904          * push them into the system specific dir. This ensures uniformity
905          * of paths and solving some problems (and prevent potential future
906          * ones) -jesterKing.
907          * For UNC paths the first characters containing the UNC prefix
908          * shouldn't be switched as we need to distinguish them from
909          * paths relative to the .blend file -elubie */
910         BLI_char_switch(tmp + BLI_path_unc_prefix_len(tmp), '\\', '/');
911
912         /* Paths starting with // will get the blend file as their base,
913          * this isn't standard in any os but is used in blender all over the place */
914         if (wasrelative) {
915                 const char *lslash;
916                 BLI_strncpy(base, basepath, sizeof(base));
917
918                 /* file component is ignored, so don't bother with the trailing slash */
919                 BLI_cleanup_path(NULL, base);
920                 lslash = BLI_last_slash(base);
921                 BLI_char_switch(base + BLI_path_unc_prefix_len(base), '\\', '/');
922
923                 if (lslash) {
924                         const int baselen = (int) (lslash - base) + 1;  /* length up to and including last "/" */
925                         /* use path for temp storage here, we copy back over it right away */
926                         BLI_strncpy(path, tmp + 2, FILE_MAX);  /* strip "//" */
927                         
928                         memcpy(tmp, base, baselen);  /* prefix with base up to last "/" */
929                         BLI_strncpy(tmp + baselen, path, sizeof(tmp) - baselen);  /* append path after "//" */
930                         BLI_strncpy(path, tmp, FILE_MAX);  /* return as result */
931                 }
932                 else {
933                         /* base doesn't seem to be a directory--ignore it and just strip "//" prefix on path */
934                         BLI_strncpy(path, tmp + 2, FILE_MAX);
935                 }
936         }
937         else {
938                 /* base ignored */
939                 BLI_strncpy(path, tmp, FILE_MAX);
940         }
941
942         BLI_cleanup_path(NULL, path);
943
944 #ifdef WIN32
945         /* skip first two chars, which in case of
946          * absolute path will be drive:/blabla and
947          * in case of relpath //blabla/. So relpath
948          * // will be retained, rest will be nice and
949          * shiny win32 backward slashes :) -jesterKing
950          */
951         BLI_char_switch(path + 2, '/', '\\');
952 #endif
953         
954         return wasrelative;
955 }
956
957
958 /**
959  * Expands path relative to the current working directory, if it was relative.
960  * Returns true if such expansion was done.
961  *
962  * \note Should only be done with command line paths.
963  * this is _not_ something blenders internal paths support like the "//" prefix
964  */
965 bool BLI_path_cwd(char *path)
966 {
967         bool wasrelative = true;
968         const int filelen = strlen(path);
969         
970 #ifdef WIN32
971         if ((filelen >= 3 && BLI_path_is_abs(path)) || BLI_path_is_unc(path))
972                 wasrelative = false;
973 #else
974         if (filelen >= 2 && path[0] == '/')
975                 wasrelative = false;
976 #endif
977         
978         if (wasrelative) {
979                 char cwd[FILE_MAX] = "";
980                 BLI_current_working_dir(cwd, sizeof(cwd)); /* in case the full path to the blend isn't used */
981                 
982                 if (cwd[0] == '\0') {
983                         printf("Could not get the current working directory - $PWD for an unknown reason.\n");
984                 }
985                 else {
986                         /* uses the blend path relative to cwd important for loading relative linked files.
987                          *
988                          * cwd should contain c:\ etc on win32 so the relbase can be NULL
989                          * relbase being NULL also prevents // being misunderstood as relative to the current
990                          * blend file which isn't a feature we want to use in this case since were dealing
991                          * with a path from the command line, rather than from inside Blender */
992
993                         char origpath[FILE_MAX];
994                         BLI_strncpy(origpath, path, FILE_MAX);
995                         
996                         BLI_make_file_string(NULL, path, cwd, origpath); 
997                 }
998         }
999         
1000         return wasrelative;
1001 }
1002
1003 /**
1004  * Copies into *last the part of *dir following the second-last slash.
1005  */
1006 void BLI_getlastdir(const char *dir, char *last, const size_t maxlen)
1007 {
1008         const char *s = dir;
1009         const char *lslash = NULL;
1010         const char *prevslash = NULL;
1011         while (*s) {
1012                 if ((*s == '\\') || (*s == '/')) {
1013                         prevslash = lslash;
1014                         lslash = s;
1015                 }
1016                 s++;
1017         }
1018         if (prevslash) {
1019                 BLI_strncpy(last, prevslash + 1, maxlen);
1020         }
1021         else {
1022                 BLI_strncpy(last, dir, maxlen);
1023         }
1024 }
1025
1026
1027
1028
1029 /**
1030  * Sets the specified environment variable to the specified value,
1031  * and clears it if val == NULL.
1032  */
1033 void BLI_setenv(const char *env, const char *val)
1034 {
1035         /* free windows */
1036 #if (defined(WIN32) || defined(WIN64)) && defined(FREE_WINDOWS)
1037         char *envstr;
1038
1039         if (val)
1040                 envstr = BLI_sprintfN("%s=%s", env, val);
1041         else
1042                 envstr = BLI_sprintfN("%s=", env);
1043
1044         putenv(envstr);
1045         MEM_freeN(envstr);
1046
1047         /* non-free windows */
1048 #elif (defined(WIN32) || defined(WIN64)) /* not free windows */
1049         uputenv(env, val);
1050
1051
1052 #else
1053         /* linux/osx/bsd */
1054         if (val)
1055                 setenv(env, val, 1);
1056         else
1057                 unsetenv(env);
1058 #endif
1059 }
1060
1061
1062 /**
1063  * Only set an env var if already not there.
1064  * Like Unix setenv(env, val, 0);
1065  *
1066  * (not used anywhere).
1067  */
1068 void BLI_setenv_if_new(const char *env, const char *val)
1069 {
1070         if (getenv(env) == NULL)
1071                 BLI_setenv(env, val);
1072 }
1073
1074 /**
1075  * Change every \a from in \a string into \a to. The
1076  * result will be in \a string
1077  *
1078  * \param string The string to work on
1079  * \param from The character to replace
1080  * \param to The character to replace with
1081  */
1082 void BLI_char_switch(char *string, char from, char to) 
1083 {
1084         while (*string != 0) {
1085                 if (*string == from) *string = to;
1086                 string++;
1087         }
1088 }
1089
1090 /**
1091  * Strips off nonexistent subdirectories from the end of *dir, leaving the path of
1092  * the lowest-level directory that does exist.
1093  */
1094 void BLI_make_exist(char *dir)
1095 {
1096         int a;
1097
1098         BLI_char_switch(dir, ALTSEP, SEP);
1099
1100         a = strlen(dir);
1101
1102         while (!BLI_is_dir(dir)) {
1103                 a--;
1104                 while (dir[a] != SEP) {
1105                         a--;
1106                         if (a <= 0) break;
1107                 }
1108                 if (a >= 0) {
1109                         dir[a + 1] = '\0';
1110                 }
1111                 else {
1112 #ifdef WIN32
1113                         get_default_root(dir);
1114 #else
1115                         strcpy(dir, "/");
1116 #endif
1117                         break;
1118                 }
1119         }
1120 }
1121
1122 /**
1123  * Ensures that the parent directory of *name exists.
1124  */
1125 void BLI_make_existing_file(const char *name)
1126 {
1127         char di[FILE_MAX];
1128         BLI_split_dir_part(name, di, sizeof(di));
1129
1130         /* make if the dir doesn't exist */
1131         BLI_dir_create_recursive(di);
1132 }
1133
1134 /**
1135  * Returns in *string the concatenation of *dir and *file (also with *relabase on the
1136  * front if specified and *dir begins with "//"). Normalizes all occurrences of path
1137  * separators, including ensuring there is exactly one between the copies of *dir and *file,
1138  * and between the copies of *relabase and *dir.
1139  *
1140  * \param relabase  Optional prefix to substitute for "//" on front of *dir
1141  * \param string  Area to return result
1142  */
1143 void BLI_make_file_string(const char *relabase, char *string, const char *dir, const char *file)
1144 {
1145         int sl;
1146
1147         if (string) {
1148                 /* ensure this is always set even if dir/file are NULL */
1149                 string[0] = '\0';
1150
1151                 if (ELEM(NULL, dir, file)) {
1152                         return; /* We don't want any NULLs */
1153                 }
1154         }
1155         else {
1156                 return; /* string is NULL, probably shouldnt happen but return anyway */
1157         }
1158
1159
1160         /* we first push all slashes into unix mode, just to make sure we don't get
1161          * any mess with slashes later on. -jesterKing */
1162         /* constant strings can be passed for those parameters - don't change them - elubie */
1163 #if 0
1164         BLI_char_switch(relabase, '\\', '/');
1165         BLI_char_switch(dir, '\\', '/');
1166         BLI_char_switch(file, '\\', '/');
1167 #endif
1168
1169         /* Resolve relative references */
1170         if (relabase && dir[0] == '/' && dir[1] == '/') {
1171                 char *lslash;
1172                 
1173                 /* Get the file name, chop everything past the last slash (ie. the filename) */
1174                 strcpy(string, relabase);
1175                 
1176                 lslash = (char *)BLI_last_slash(string);
1177                 if (lslash) *(lslash + 1) = 0;
1178
1179                 dir += 2; /* Skip over the relative reference */
1180         }
1181 #ifdef WIN32
1182         else {
1183                 if (BLI_strnlen(dir, 3) >= 2 && dir[1] == ':') {
1184                         BLI_strncpy(string, dir, 3);
1185                         dir += 2;
1186                 }
1187                 else if (BLI_strnlen(dir, 3) >= 2 && BLI_path_is_unc(dir)) {
1188                         string[0] = 0;
1189                 }
1190                 else { /* no drive specified */
1191                            /* first option: get the drive from the relabase if it has one */
1192                         if (relabase && BLI_strnlen(relabase, 3) >= 2 && relabase[1] == ':') {
1193                                 BLI_strncpy(string, relabase, 3);
1194                                 string[2] = '\\';
1195                                 string[3] = '\0';
1196                         }
1197                         else { /* we're out of luck here, guessing the first valid drive, usually c:\ */
1198                                 get_default_root(string);
1199                         }
1200                         
1201                         /* ignore leading slashes */
1202                         while (*dir == '/' || *dir == '\\') dir++;
1203                 }
1204         }
1205 #endif
1206
1207         strcat(string, dir);
1208
1209         /* Make sure string ends in one (and only one) slash */
1210         /* first trim all slashes from the end of the string */
1211         sl = strlen(string);
1212         while (sl > 0 && (string[sl - 1] == '/' || string[sl - 1] == '\\') ) {
1213                 string[sl - 1] = '\0';
1214                 sl--;
1215         }
1216         /* since we've now removed all slashes, put back one slash at the end. */
1217         strcat(string, "/");
1218         
1219         while (*file && (*file == '/' || *file == '\\')) /* Trim slashes from the front of file */
1220                 file++;
1221                 
1222         strcat(string, file);
1223         
1224         /* Push all slashes to the system preferred direction */
1225         BLI_path_native_slash(string);
1226 }
1227
1228 static bool testextensie_ex(const char *str, const size_t str_len,
1229                             const char *ext, const size_t ext_len)
1230 {
1231         BLI_assert(strlen(str) == str_len);
1232         BLI_assert(strlen(ext) == ext_len);
1233
1234         return  (((str_len == 0 || ext_len == 0 || ext_len >= str_len) == 0) &&
1235                  (BLI_strcasecmp(ext, str + str_len - ext_len) == 0));
1236 }
1237
1238 /* does str end with ext. */
1239 bool BLI_testextensie(const char *str, const char *ext)
1240 {
1241         return testextensie_ex(str, strlen(str), ext, strlen(ext));
1242 }
1243
1244 bool BLI_testextensie_n(const char *str, ...)
1245 {
1246         const size_t str_len = strlen(str);
1247
1248         va_list args;
1249         const char *ext;
1250         bool ret = false;
1251
1252         va_start(args, str);
1253
1254         while ((ext = (const char *) va_arg(args, void *))) {
1255                 if (testextensie_ex(str, str_len, ext, strlen(ext))) {
1256                         ret = true;
1257                         goto finally;
1258                 }
1259         }
1260
1261 finally:
1262         va_end(args);
1263
1264         return ret;
1265 }
1266
1267 /* does str end with any of the suffixes in *ext_array. */
1268 bool BLI_testextensie_array(const char *str, const char **ext_array)
1269 {
1270         const size_t str_len = strlen(str);
1271         int i = 0;
1272
1273         while (ext_array[i]) {
1274                 if (testextensie_ex(str, str_len, ext_array[i], strlen(ext_array[i]))) {
1275                         return true;
1276                 }
1277
1278                 i++;
1279         }
1280         return false;
1281 }
1282
1283 /**
1284  * Semicolon separated wildcards, eg:
1285  *  '*.zip;*.py;*.exe'
1286  * does str match any of the semicolon-separated glob patterns in fnmatch.
1287  */
1288 bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch)
1289 {
1290         const char *ext_step = ext_fnmatch;
1291         char pattern[16];
1292
1293         while (ext_step[0]) {
1294                 const char *ext_next;
1295                 int len_ext;
1296
1297                 if ((ext_next = strchr(ext_step, ';'))) {
1298                         len_ext = (int)(ext_next - ext_step) + 1;
1299                 }
1300                 else {
1301                         len_ext = sizeof(pattern);
1302                 }
1303
1304                 BLI_strncpy(pattern, ext_step, len_ext);
1305
1306                 if (fnmatch(pattern, str, FNM_CASEFOLD) == 0) {
1307                         return true;
1308                 }
1309                 ext_step += len_ext;
1310         }
1311
1312         return false;
1313 }
1314
1315
1316 /**
1317  * Removes any existing extension on the end of \a path and appends \a ext.
1318  * \return false if there was no room.
1319  */
1320 bool BLI_replace_extension(char *path, size_t maxlen, const char *ext)
1321 {
1322         const size_t path_len = strlen(path);
1323         const size_t ext_len = strlen(ext);
1324         ssize_t a;
1325
1326         for (a = path_len - 1; a >= 0; a--) {
1327                 if (ELEM(path[a], '.', '/', '\\')) {
1328                         break;
1329                 }
1330         }
1331
1332         if ((a < 0) || (path[a] != '.')) {
1333                 a = path_len;
1334         }
1335
1336         if (a + ext_len >= maxlen)
1337                 return false;
1338
1339         memcpy(path + a, ext, ext_len + 1);
1340         return true;
1341 }
1342
1343 /**
1344  * Strip's trailing '.'s and adds the extension only when needed
1345  */
1346 bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext)
1347 {
1348         const size_t path_len = strlen(path);
1349         const size_t ext_len = strlen(ext);
1350         ssize_t a;
1351
1352         /* first check the extension is already there */
1353         if (    (ext_len <= path_len) &&
1354                 (strcmp(path + (path_len - ext_len), ext) == 0))
1355         {
1356                 return true;
1357         }
1358
1359         for (a = path_len - 1; a >= 0; a--) {
1360                 if (path[a] == '.') {
1361                         path[a] = '\0';
1362                 }
1363                 else {
1364                         break;
1365                 }
1366         }
1367         a++;
1368
1369         if (a + ext_len >= maxlen)
1370                 return false;
1371
1372         memcpy(path + a, ext, ext_len + 1);
1373         return true;
1374 }
1375
1376 bool BLI_ensure_filename(char *filepath, size_t maxlen, const char *filename)
1377 {
1378         char *c = (char *)BLI_last_slash(filepath);
1379         if (!c || ((c - filepath) < maxlen - (strlen(filename) + 1))) {
1380                 strcpy(c ? &c[1] : filepath, filename);
1381                 return true;
1382         }
1383         return false;
1384 }
1385
1386 /* Converts "/foo/bar.txt" to "/foo/" and "bar.txt"
1387  * - wont change 'string'
1388  * - wont create any directories
1389  * - dosnt use CWD, or deal with relative paths.
1390  * - Only fill's in *dir and *file when they are non NULL
1391  * */
1392 void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen)
1393 {
1394         const char *lslash_str = BLI_last_slash(string);
1395         const size_t lslash = lslash_str ? (size_t)(lslash_str - string) + 1 : 0;
1396
1397         if (dir) {
1398                 if (lslash) {
1399                         BLI_strncpy(dir, string, MIN2(dirlen, lslash + 1)); /* +1 to include the slash and the last char */
1400                 }
1401                 else {
1402                         dir[0] = '\0';
1403                 }
1404         }
1405         
1406         if (file) {
1407                 BLI_strncpy(file, string + lslash, filelen);
1408         }
1409 }
1410
1411 /**
1412  * Copies the parent directory part of string into *dir, max length dirlen.
1413  */
1414 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen)
1415 {
1416         BLI_split_dirfile(string, dir, NULL, dirlen, 0);
1417 }
1418
1419 /**
1420  * Copies the leaf filename part of string into *file, max length filelen.
1421  */
1422 void BLI_split_file_part(const char *string, char *file, const size_t filelen)
1423 {
1424         BLI_split_dirfile(string, NULL, file, 0, filelen);
1425 }
1426
1427 /**
1428  * Append a filename to a dir, ensuring slash separates.
1429  */
1430 void BLI_path_append(char *__restrict dst, const size_t maxlen, const char *__restrict file)
1431 {
1432         size_t dirlen = BLI_strnlen(dst, maxlen);
1433
1434         /* inline BLI_add_slash */
1435         if ((dirlen > 0) && (dst[dirlen - 1] != SEP)) {
1436                 dst[dirlen++] = SEP;
1437                 dst[dirlen] = '\0';
1438         }
1439
1440         if (dirlen >= maxlen) {
1441                 return; /* fills the path */
1442         }
1443
1444         BLI_strncpy(dst + dirlen, file, maxlen - dirlen);
1445 }
1446
1447 /**
1448  * Simple appending of filename to dir, does not check for valid path!
1449  * Puts result into *dst, which may be same area as *dir.
1450  */
1451 void BLI_join_dirfile(char *__restrict dst, const size_t maxlen, const char *__restrict dir, const char *__restrict file)
1452 {
1453         size_t dirlen = BLI_strnlen(dir, maxlen);
1454
1455         /* args can't match */
1456         BLI_assert(!ELEM(dst, dir, file));
1457
1458         if (dirlen == maxlen) {
1459                 memcpy(dst, dir, dirlen);
1460                 dst[dirlen - 1] = '\0';
1461                 return; /* dir fills the path */
1462         }
1463         else {
1464                 memcpy(dst, dir, dirlen + 1);
1465         }
1466
1467         if (dirlen + 1 >= maxlen) {
1468                 return; /* fills the path */
1469         }
1470
1471         /* inline BLI_add_slash */
1472         if ((dirlen > 0) && (dst[dirlen - 1] != SEP)) {
1473                 dst[dirlen++] = SEP;
1474                 dst[dirlen] = '\0';
1475         }
1476
1477         if (dirlen >= maxlen) {
1478                 return; /* fills the path */
1479         }
1480
1481         BLI_strncpy(dst + dirlen, file, maxlen - dirlen);
1482 }
1483
1484 /**
1485  * like pythons os.path.basename()
1486  *
1487  * \return The pointer into \a path string immediately after last slash,
1488  * or start of \a path if none found.
1489  */
1490 const char *BLI_path_basename(const char *path)
1491 {
1492         const char * const filename = BLI_last_slash(path);
1493         return filename ? filename + 1 : path;
1494 }
1495
1496 /* UNUSED */
1497 #if 0
1498 /**
1499  * Produce image export path.
1500  * 
1501  * Returns:
1502  * 0        if image filename is empty or if destination path
1503  *          matches image path (i.e. both are the same file).
1504  * 2        if source is identical to destination.
1505  * 1        if rebase was successful
1506  * -------------------------------------------------------------
1507  * Hint: Trailing slash in dest_dir is optional.
1508  *
1509  * Logic:
1510  *
1511  * - if an image is "below" current .blend file directory:
1512  *   rebuild the same dir structure in dest_dir
1513  *
1514  *   Example: 
1515  *   src : //textures/foo/bar.png
1516  *   dest: [dest_dir]/textures/foo/bar.png.
1517  *
1518  * - if an image is not "below" current .blend file directory,
1519  *   disregard it's path and copy it into the destination  
1520  *   directory.
1521  *
1522  *   Example:
1523  *   src : //../foo/bar.png becomes
1524  *   dest: [dest_dir]/bar.png.
1525  *
1526  * This logic ensures that all image paths are relative and
1527  * that a user gets his images in one place. It'll also provide
1528  * consistent behavior across exporters.
1529  * IMPORTANT NOTE: If base_dir contains an empty string, then
1530  * this function returns wrong results!
1531  * XXX: test on empty base_dir and return an error ?
1532  */
1533
1534 /**
1535  *
1536  * \param abs  Optional string to return new full path
1537  * \param abs_len  Size of *abs string
1538  * \param rel  Optional area to return new path relative to parent directory of .blend file
1539  *             (only meaningful if item is in a subdirectory thereof)
1540  * \param rel_len  Size of *rel area
1541  * \param base_dir  Path of .blend file
1542  * \param src_dir  Original path of item (any initial "//" will be expanded to
1543  *                 parent directory of .blend file)
1544  * \param dest_dir  New directory into which item will be moved
1545  * \return bli_rebase_state
1546  *
1547  * \note Not actually used anywhere!
1548  */
1549 int BLI_rebase_path(char *abs, size_t abs_len,
1550                     char *rel, size_t rel_len,
1551                     const char *base_dir, const char *src_dir, const char *dest_dir)
1552 {
1553         char path[FILE_MAX];  /* original full path of item */
1554         char dir[FILE_MAX];   /* directory part of src_dir */
1555         char base[FILE_MAX];  /* basename part of src_dir */
1556         char blend_dir[FILE_MAX];   /* directory, where current .blend file resides */
1557         char dest_path[FILE_MAX];
1558         char rel_dir[FILE_MAX];
1559         int len;
1560
1561         if (abs)
1562                 abs[0] = 0;
1563
1564         if (rel)
1565                 rel[0] = 0;
1566
1567         BLI_split_dir_part(base_dir, blend_dir, sizeof(blend_dir));
1568
1569         if (src_dir[0] == '\0')
1570                 return BLI_REBASE_NO_SRCDIR;
1571
1572         BLI_strncpy(path, src_dir, sizeof(path));
1573
1574         /* expand "//" in filename and get absolute path */
1575         BLI_path_abs(path, base_dir);
1576
1577         /* get the directory part */
1578         BLI_split_dirfile(path, dir, base, sizeof(dir), sizeof(base));
1579
1580         len = strlen(blend_dir);
1581
1582         rel_dir[0] = 0;
1583
1584         /* if image is "below" current .blend file directory */
1585         if (!BLI_path_ncmp(path, blend_dir, len)) {
1586
1587                 if (BLI_path_cmp(dir, blend_dir) == 0) {
1588                         /* image is directly in .blend file parent directory => put directly in dest_dir */
1589                         BLI_join_dirfile(dest_path, sizeof(dest_path), dest_dir, base);
1590                 }
1591                 else {
1592                         /* "below" (in subdirectory of .blend file parent directory) => put in same relative directory structure in dest_dir */
1593                         /* rel = image_path_dir - blend_dir */
1594                         BLI_strncpy(rel_dir, dir + len, sizeof(rel_dir));
1595                         /* subdirectories relative to blend_dir */
1596                         BLI_join_dirfile(dest_path, sizeof(dest_path), dest_dir, rel_dir);
1597                         /* same subdirectories relative to dest_dir */
1598                         BLI_path_append(dest_path, sizeof(dest_path), base);
1599                         /* keeping original item basename */
1600                 }
1601
1602         }
1603         /* image is out of current directory -- just put straight in dest_dir */
1604         else {
1605                 BLI_join_dirfile(dest_path, sizeof(dest_path), dest_dir, base);
1606         }
1607
1608         if (abs)
1609                 BLI_strncpy(abs, dest_path, abs_len);
1610
1611         if (rel) {
1612                 strncat(rel, rel_dir, rel_len);
1613                 strncat(rel, base, rel_len); /* FIXME: could overflow rel area! */
1614         }
1615
1616         /* return 2 if (src == dest) */
1617         if (BLI_path_cmp(path, dest_path) == 0) {
1618                 // if (G.debug & G_DEBUG) printf("%s and %s are the same file\n", path, dest_path);
1619                 return BLI_REBASE_IDENTITY;
1620         }
1621
1622         return BLI_REBASE_OK;
1623 }
1624 #endif
1625
1626
1627 /**
1628  * Returns pointer to the leftmost path separator in string. Not actually used anywhere.
1629  */
1630 const char *BLI_first_slash(const char *string)
1631 {
1632         const char * const ffslash = strchr(string, '/');
1633         const char * const fbslash = strchr(string, '\\');
1634         
1635         if (!ffslash) return fbslash;
1636         else if (!fbslash) return ffslash;
1637         
1638         if ((intptr_t)ffslash < (intptr_t)fbslash) return ffslash;
1639         else return fbslash;
1640 }
1641
1642 /**
1643  * Returns pointer to the rightmost path separator in string.
1644  */
1645 const char *BLI_last_slash(const char *string)
1646 {
1647         const char * const lfslash = strrchr(string, '/');
1648         const char * const lbslash = strrchr(string, '\\');
1649
1650         if (!lfslash) return lbslash; 
1651         else if (!lbslash) return lfslash;
1652         
1653         if ((intptr_t)lfslash < (intptr_t)lbslash) return lbslash;
1654         else return lfslash;
1655 }
1656
1657 /**
1658  * Appends a slash to string if there isn't one there already.
1659  * Returns the new length of the string.
1660  */
1661 int BLI_add_slash(char *string)
1662 {
1663         int len = strlen(string);
1664         if (len == 0 || string[len - 1] != SEP) {
1665                 string[len] = SEP;
1666                 string[len + 1] = '\0';
1667                 return len + 1;
1668         }
1669         return len;
1670 }
1671
1672 /**
1673  * Removes the last slash and everything after it to the end of string, if there is one.
1674  */
1675 void BLI_del_slash(char *string)
1676 {
1677         int len = strlen(string);
1678         while (len) {
1679                 if (string[len - 1] == SEP) {
1680                         string[len - 1] = '\0';
1681                         len--;
1682                 }
1683                 else {
1684                         break;
1685                 }
1686         }
1687 }
1688
1689 /**
1690  * Changes to the path separators to the native ones for this OS.
1691  */
1692 void BLI_path_native_slash(char *path)
1693 {
1694 #ifdef WIN32
1695         if (path && BLI_strnlen(path, 3) > 2) {
1696                 BLI_char_switch(path + 2, '/', '\\');
1697         }
1698 #else
1699         BLI_char_switch(path + BLI_path_unc_prefix_len(path), '\\', '/');
1700 #endif
1701 }
1702
1703
1704 #ifdef WITH_ICONV
1705
1706 /**
1707  * Converts a string encoded in the charset named by *code to UTF-8.
1708  * Opens a new iconv context each time it is run, which is probably not the
1709  * most efficient. */
1710 void BLI_string_to_utf8(char *original, char *utf_8, const char *code)
1711 {
1712         size_t inbytesleft = strlen(original);
1713         size_t outbytesleft = 512;
1714         size_t rv = 0;
1715         iconv_t cd;
1716         
1717         if (NULL == code) {
1718                 code = locale_charset();
1719         }
1720         cd = iconv_open("UTF-8", code);
1721
1722         if (cd == (iconv_t)(-1)) {
1723                 printf("iconv_open Error");
1724                 *utf_8 = '\0';
1725                 return;
1726         }
1727         rv = iconv(cd, &original, &inbytesleft, &utf_8, &outbytesleft);
1728         if (rv == (size_t) -1) {
1729                 printf("iconv Error\n");
1730                 iconv_close(cd);
1731                 return;
1732         }
1733         *utf_8 = '\0';
1734         iconv_close(cd);
1735 }
1736 #endif // WITH_ICONV