svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[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 char *BLI_gethome_folder(char *folder_name);
46
47 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
48 void BLI_make_exist(char *dir);
49 void BLI_make_existing_file(char *name);
50 void BLI_split_dirfile(char *string, char *dir, char *file);
51 void BLI_split_dirfile_basic(const char *string, char *dir, char *file);
52 void BLI_join_dirfile(char *string, const char *dir, const char *file);
53 void BLI_getlastdir(const char* dir, char *last, int maxlen);
54 int BLI_testextensie(const char *str, const char *ext);
55 void BLI_uniquename(struct ListBase *list, void *vlink, char defname[], char delim, short name_offs, short len);
56 void BLI_newname(char * name, int add);
57 int BLI_stringdec(char *string, char *kop, char *start, unsigned short *numlen);
58 void BLI_stringenc(char *string, char *kop, char *start, unsigned short numlen, int pic);
59 void BLI_splitdirstring(char *di,char *fi);
60
61 /* make sure path separators conform to system one */
62 void BLI_clean(char *path);
63
64 /**
65          * dir can be any input, like from buttons, and this function
66          * converts it to a regular full path.
67          * Also removes garbage from directory paths, like /../ or double slashes etc 
68          */
69 void BLI_cleanup_file(const char *relabase, char *dir);
70 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
71
72 /* go back one directory */
73 int BLI_parent_dir(char *path);
74
75         /**
76          * Blender's path code replacement function.
77          * Bases @a path strings leading with "//" by the
78          * directory @a basepath, and replaces instances of
79          * '#' with the @a framenum. Results are written
80          * back into @a path.
81          * 
82          * @a path The path to convert
83          * @a basepath The directory to base relative paths with.
84          * @a framenum The framenumber to replace the frame code with.
85          * @retval Returns true if the path was relative (started with "//").
86          */
87 int BLI_convertstringcode(char *path, const char *basepath);
88 int BLI_convertstringframe(char *path, int frame);
89 int BLI_convertstringcwd(char *path);
90
91 void BLI_makestringcode(const char *relfile, char *file);
92
93         /**
94          * Change every @a from in @a string into @a to. The
95          * result will be in @a string
96          *
97          * @a string The string to work on
98          * @a from The character to replace
99          * @a to The character to replace with
100          */
101 void BLI_char_switch(char *string, char from, char to);
102
103 /**
104          * Checks if name is a fully qualified filename to an executable.
105          * If not it searches $PATH for the file. On Windows it also
106          * adds the correct extension (.com .exe etc) from
107          * $PATHEXT if necessary. Also on Windows it translates
108          * the name to its 8.3 version to prevent problems with
109          * spaces and stuff. Final result is returned in fullname.
110          *
111          * @param fullname The full path and full name of the executable
112          * @param name The name of the executable (usually argv[0]) to be checked
113          */
114 void BLI_where_am_i(char *fullname, const char *name);
115
116 char *get_install_dir(void);
117         /**
118          * Gets the temp directory when blender first runs.
119          * If the default path is not found, use try $TEMP
120          * 
121          * Also make sure the temp dir has a trailing slash
122          *
123          * @param fullname The full path to the temp directory
124          */
125 void BLI_where_is_temp(char *fullname, int usertemp);
126
127
128         /**
129          * determines the full path to the application bundle on OS X
130          *
131          * @return path to application bundle
132          */
133 #ifdef __APPLE__
134 char* BLI_getbundle(void);
135 #endif
136
137 #ifdef WITH_ICONV
138 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
139 #endif
140
141 #endif
142