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