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