2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r17853...
[blender.git] / source / blender / blenlib / BLI_util.h
1 /**
2  * blenlib/BLI_storage_types.h
3  *
4  * Some types for dealing with directories
5  *
6  * $Id$
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33 #ifndef BLI_UTIL_H
34 #define BLI_UTIL_H
35
36 /* XXX doesn't seem to be used, marded for removal
37 #define mallocstructN(x,y,name) (x*)MEM_mallocN((y)* sizeof(x),name)
38 #define callocstructN(x,y,name) (x*)MEM_callocN((y)* sizeof(x),name)
39 */
40
41 struct ListBase;
42 struct direntry;
43
44 char *BLI_gethome(void);
45 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
46 void BLI_make_exist(char *dir);
47 void BLI_make_existing_file(char *name);
48 void BLI_split_dirfile(char *string, char *dir, char *file);
49 void BLI_split_dirfile_basic(const char *string, char *dir, char *file);
50 void BLI_join_dirfile(char *string, const char *dir, const char *file);
51 int BLI_testextensie(const char *str, const char *ext);
52 void BLI_uniquename(struct ListBase *list, void *vlink, char defname[], short name_offs, short len);
53 void BLI_newname(char * name, int add);
54 int BLI_stringdec(char *string, char *kop, char *start, unsigned short *numlen);
55 void BLI_stringenc(char *string, char *kop, char *start, unsigned short numlen, int pic);
56 void BLI_splitdirstring(char *di,char *fi);
57
58 /* make sure path separators conform to system one */
59 void BLI_clean(char *path);
60
61 /**
62          * dir can be any input, like from buttons, and this function
63          * converts it to a regular full path.
64          * Also removes garbage from directory paths, like /../ or double slashes etc 
65          */
66 void BLI_cleanup_file(const char *relabase, char *dir);
67 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
68
69 /* go back one directory */
70 int BLI_parent_dir(char *path);
71
72         /**
73          * Blender's path code replacement function.
74          * Bases @a path strings leading with "//" by the
75          * directory @a basepath, and replaces instances of
76          * '#' with the @a framenum. Results are written
77          * back into @a path.
78          * 
79          * @a path The path to convert
80          * @a basepath The directory to base relative paths with.
81          * @a framenum The framenumber to replace the frame code with.
82          * @retval Returns true if the path was relative (started with "//").
83          */
84 int BLI_convertstringcode(char *path, const char *basepath);
85 int BLI_convertstringframe(char *path, int frame);
86 int BLI_convertstringcwd(char *path);
87
88 void BLI_makestringcode(const char *relfile, char *file);
89
90         /**
91          * Change every @a from in @a string into @a to. The
92          * result will be in @a string
93          *
94          * @a string The string to work on
95          * @a from The character to replace
96          * @a to The character to replace with
97          */
98 void BLI_char_switch(char *string, char from, char to);
99
100 /**
101          * Checks if name is a fully qualified filename to an executable.
102          * If not it searches $PATH for the file. On Windows it also
103          * adds the correct extension (.com .exe etc) from
104          * $PATHEXT if necessary. Also on Windows it translates
105          * the name to its 8.3 version to prevent problems with
106          * spaces and stuff. Final result is returned in fullname.
107          *
108          * @param fullname The full path and full name of the executable
109          * @param name The name of the executable (usually argv[0]) to be checked
110          */
111 void BLI_where_am_i(char *fullname, const char *name);
112
113 char *get_install_dir(void);
114         /**
115          * Gets the temp directory when blender first runs.
116          * If the default path is not found, use try $TEMP
117          * 
118          * Also make sure the temp dir has a trailing slash
119          *
120          * @param fullname The full path to the temp directory
121          */
122 void BLI_where_is_temp(char *fullname, int usertemp);
123
124
125         /**
126          * determines the full path to the application bundle on OS X
127          *
128          * @return path to application bundle
129          */
130 #ifdef __APPLE__
131 char* BLI_getbundle(void);
132 #endif
133
134 #ifdef WITH_ICONV
135 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
136 #endif
137
138 #endif
139