synched with trunk at revision 30597
[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_PATH_UTIL_H
34 #define BLI_PATH_UTIL_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct ListBase;
41 struct direntry;
42
43 char *BLI_getDefaultDocumentFolder(void);
44
45 char *BLI_get_folder(int folder_id, char *subfolder);
46 char *BLI_get_folder_create(int folder_id, char *subfolder);
47
48 /* folder_id */
49
50 /* general, will find based on user/local/system priority */
51 #define BLENDER_CONFIG                          1
52 #define BLENDER_DATAFILES                       2
53 #define BLENDER_SCRIPTS                         3
54 #define BLENDER_PLUGINS                         4
55 #define BLENDER_PYTHON                          5
56
57 /* user-specific */
58 #define BLENDER_USER_CONFIG                     31
59 #define BLENDER_USER_DATAFILES          32
60 #define BLENDER_USER_SCRIPTS            33
61 #define BLENDER_USER_PLUGINS            34
62 #define BLENDER_USER_AUTOSAVE           35
63
64 /* system */
65 #define BLENDER_SYSTEM_CONFIG           51      /* optional */
66 #define BLENDER_SYSTEM_DATAFILES        52
67 #define BLENDER_SYSTEM_SCRIPTS          53
68 #define BLENDER_SYSTEM_PLUGINS          54
69 #define BLENDER_SYSTEM_PYTHON           54
70
71 #define BLENDER_TEMP                            80
72
73 #define BLENDER_USERFOLDER(id) (id >= BLENDER_USER_CONFIG && id <= BLENDER_USER_PLUGINS)
74
75 #define BLENDER_STARTUP_FILE    "startup.blend"
76 #define BLENDER_BOOKMARK_FILE   "bookmarks.txt"
77 #define BLENDER_HISTORY_FILE    "recent-files.txt"
78
79 #ifdef WIN32
80 #define BLENDER_USER_FORMAT             "%s\\Blender Foundation\\Blender\\%s"
81 #define BLENDER_SYSTEM_FORMAT           "%s\\Blender Foundation\\Blender\\%s"
82 #elif __APPLE__
83 #define BLENDER_USER_FORMAT                     "%s/Blender/%s"
84 #define BLENDER_SYSTEM_FORMAT                   "%s/Blender/%s"
85 #else
86 #define BLENDER_USER_FORMAT                     "%s/.blender/%s"
87 #define BLENDER_SYSTEM_FORMAT                   "%s/blender/%s"
88 #endif
89
90 void BLI_setenv(const char *env, const char *val);
91 void BLI_setenv_if_new(const char *env, const char* val);
92
93 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
94 void BLI_make_exist(char *dir);
95 void BLI_make_existing_file(char *name);
96 void BLI_split_dirfile(const char *string, char *dir, char *file);
97 void BLI_join_dirfile(char *string, const char *dir, const char *file);
98 char *BLI_path_basename(char *path);
99 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);
100 void BLI_getlastdir(const char* dir, char *last, int maxlen);
101 int BLI_testextensie(const char *str, const char *ext);
102 int BLI_replace_extension(char *path, int maxlen, const char *ext);
103 void BLI_uniquename(struct ListBase *list, void *vlink, const char defname[], char delim, short name_offs, short len);
104 void BLI_newname(char * name, int add);
105 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
106 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
107 void BLI_splitdirstring(char *di,char *fi);
108
109 /* make sure path separators conform to system one */
110 void BLI_clean(char *path);
111
112 /**
113          * dir can be any input, like from buttons, and this function
114          * converts it to a regular full path.
115          * Also removes garbage from directory paths, like /../ or double slashes etc 
116          */
117 void BLI_cleanup_file(const char *relabase, char *dir);
118 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
119
120 /* go back one directory */
121 int BLI_parent_dir(char *path);
122
123 /* return whether directory is root and thus has no parent dir */
124 int BLI_has_parent(char *path);
125
126         /**
127          * Blender's path code replacement function.
128          * Bases @a path strings leading with "//" by the
129          * directory @a basepath, and replaces instances of
130          * '#' with the @a framenum. Results are written
131          * back into @a path.
132          * 
133          * @a path The path to convert
134          * @a basepath The directory to base relative paths with.
135          * @a framenum The framenumber to replace the frame code with.
136          * @retval Returns true if the path was relative (started with "//").
137          */
138 int BLI_path_abs(char *path, const char *basepath);
139 int BLI_path_frame(char *path, int frame, int digits);
140 int BLI_path_frame_range(char *path, int sta, int end, int digits);
141 int BLI_path_cwd(char *path);
142
143 void BLI_path_rel(char *file, const char *relfile);
144
145         /**
146          * Change every @a from in @a string into @a to. The
147          * result will be in @a string
148          *
149          * @a string The string to work on
150          * @a from The character to replace
151          * @a to The character to replace with
152          */
153 void BLI_char_switch(char *string, char from, char to);
154
155 /**
156          * Checks if name is a fully qualified filename to an executable.
157          * If not it searches $PATH for the file. On Windows it also
158          * adds the correct extension (.com .exe etc) from
159          * $PATHEXT if necessary. Also on Windows it translates
160          * the name to its 8.3 version to prevent problems with
161          * spaces and stuff. Final result is returned in fullname.
162          *
163          * @param fullname The full path and full name of the executable
164          * @param name The name of the executable (usually argv[0]) to be checked
165          */
166 void BLI_where_am_i(char *fullname, const char *name);
167
168 char *get_install_dir(void);
169         /**
170          * Gets the temp directory when blender first runs.
171          * If the default path is not found, use try $TEMP
172          * 
173          * Also make sure the temp dir has a trailing slash
174          *
175          * @param fullname The full path to the temp directory
176          */
177 void BLI_where_is_temp(char *fullname, int usertemp);
178
179
180 #ifdef WITH_ICONV
181 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
182 #endif
183
184 #ifdef __cplusplus
185 }
186 #endif
187
188 #endif
189