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