code cleanup: better use of BLI_array_* (grow in larger steps where possible), includ...
[blender.git] / source / blender / blenlib / BLI_path_util.h
index 3b27e4dafa04d6192591a2b78f4743924faf1add..e02b48feda7812d3cb4bad657e0873c309b853c6 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * $Id$
- *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -26,8 +24,8 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
-#ifndef BLI_PATH_UTIL_H
-#define BLI_PATH_UTIL_H
+#ifndef __BLI_PATH_UTIL_H__
+#define __BLI_PATH_UTIL_H__
 
 /** \file BLI_path_util.h
  *  \ingroup bli
@@ -65,10 +63,6 @@ char *BLI_get_folder_version(const int id, const int ver, const int do_check);
 #define BLENDER_SYSTEM_PLUGINS         54
 #define BLENDER_SYSTEM_PYTHON          54
 
-#define BLENDER_TEMP                           80
-
-#define BLENDER_USERFOLDER(id) (id >= BLENDER_USER_CONFIG && id <= BLENDER_USER_PLUGINS)
-
 /* for BLI_get_folder_version only */
 #define BLENDER_RESOURCE_PATH_USER             0
 #define BLENDER_RESOURCE_PATH_LOCAL            1
@@ -78,17 +72,6 @@ char *BLI_get_folder_version(const int id, const int ver, const int do_check);
 #define BLENDER_BOOKMARK_FILE  "bookmarks.txt"
 #define BLENDER_HISTORY_FILE   "recent-files.txt"
 
-#ifdef WIN32
-#define BLENDER_USER_FORMAT            "%s\\Blender Foundation\\Blender\\%s"
-#define BLENDER_SYSTEM_FORMAT          "%s\\Blender Foundation\\Blender\\%s"
-#elif defined(__APPLE__)
-#define BLENDER_USER_FORMAT                    "%s/Blender/%s"
-#define BLENDER_SYSTEM_FORMAT                  "%s/Blender/%s"
-#else
-#define BLENDER_USER_FORMAT                    "%s/.blender/%s"
-#define BLENDER_SYSTEM_FORMAT                  "%s/blender/%s"
-#endif
-
 #ifdef WIN32
 #define SEP '\\'
 #define ALTSEP '/'
@@ -98,13 +81,14 @@ char *BLI_get_folder_version(const int id, const int ver, const int do_check);
 #endif
 
 void BLI_setenv(const char *env, const char *val);
-char *BLI_getenv(const char *env);
 void BLI_setenv_if_new(const char *env, const char* val);
 
 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
 void BLI_make_exist(char *dir);
 void BLI_make_existing_file(const char *name);
-void BLI_split_dirfile(const char *string, char *dir, char *file);
+void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
+void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
+void BLI_split_file_part(const char *string, char *file, const size_t filelen);
 void BLI_join_dirfile(char *string, const size_t maxlen, const char *dir, const char *file);
 char *BLI_path_basename(char *path);
 int BKE_rebase_path(char *abs, size_t abs_len, char *rel, size_t rel_len, const char *base_dir, const char *src_dir, const char *dest_dir);
@@ -118,6 +102,7 @@ int BLI_testextensie(const char *str, const char *ext);
 int BLI_testextensie_array(const char *str, const char **ext_array);
 int BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
 int BLI_replace_extension(char *path, size_t maxlen, const char *ext);
+int BLI_ensure_extension(char *path, size_t maxlen, const char *ext);
 void BLI_uniquename(struct ListBase *list, void *vlink, const char defname[], char delim, short name_offs, short len);
 int BLI_uniquename_cb(int (*unique_check)(void *, const char *), void *arg, const char defname[], char delim, char *name, short name_len);
 void BLI_newname(char * name, int add);
@@ -130,10 +115,10 @@ void BLI_splitdirstring(char *di,char *fi);
 void BLI_clean(char *path);
 
 /**
       * dir can be any input, like from buttons, and this function
       * converts it to a regular full path.
       * Also removes garbage from directory paths, like /../ or double slashes etc 
       */
+ * dir can be any input, like from buttons, and this function
+ * converts it to a regular full path.
+ * Also removes garbage from directory paths, like /../ or double slashes etc 
+ */
 void BLI_cleanup_file(const char *relabase, char *dir); /* removes trailing slash */
 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
 void BLI_cleanup_path(const char *relabase, char *dir); /* doesn't touch trailing slash */
@@ -144,18 +129,18 @@ int BLI_parent_dir(char *path);
 /* return whether directory is root and thus has no parent dir */
 int BLI_has_parent(char *path);
 
-       /**
       * Blender's path code replacement function.
       * Bases @a path strings leading with "//" by the
       * directory @a basepath, and replaces instances of
       * '#' with the @a framenum. Results are written
       * back into @a path.
       
       * @a path The path to convert
       * @a basepath The directory to base relative paths with.
       * @a framenum The framenumber to replace the frame code with.
       * @retval Returns true if the path was relative (started with "//").
       */
+/**
+ * Blender's path code replacement function.
* Bases \a path strings leading with "//" by the
* directory \a basepath, and replaces instances of
* '#' with the \a framenum. Results are written
* back into \a path.
+ * 
* \a path The path to convert
* \a basepath The directory to base relative paths with.
* \a framenum The framenumber to replace the frame code with.
* \retval Returns true if the path was relative (started with "//").
+ */
 int BLI_path_abs(char *path, const char *basepath);
 int BLI_path_frame(char *path, int frame, int digits);
 int BLI_path_frame_range(char *path, int sta, int end, int digits);
@@ -170,39 +155,30 @@ void BLI_path_rel(char *file, const char *relfile);
 #  define BLI_path_ncmp strncmp
 #endif
 
-       /**
-        * Change every @a from in @a string into @a to. The
-        * result will be in @a string
-        *
-        * @a string The string to work on
-        * @a from The character to replace
-        * @a to The character to replace with
-        */
-void BLI_char_switch(char *string, char from, char to);
-
 /**
-        * Checks if name is a fully qualified filename to an executable.
-        * If not it searches $PATH for the file. On Windows it also
-        * adds the correct extension (.com .exe etc) from
-        * $PATHEXT if necessary. Also on Windows it translates
-        * the name to its 8.3 version to prevent problems with
-        * spaces and stuff. Final result is returned in fullname.
-        *
-        * @param fullname The full path and full name of the executable
-        * @param name The name of the executable (usually argv[0]) to be checked
-        */
-void BLI_where_am_i(char *fullname, const size_t maxlen, const char *name);
-
-       /**
-        * Gets the temp directory when blender first runs.
-        * If the default path is not found, use try $TEMP
-        * 
-        * Also make sure the temp dir has a trailing slash
-        *
-        * @param fullname The full path to the temp directory
-        */
-void BLI_where_is_temp(char *fullname, const size_t maxlen, int usertemp);
+ * Change every \a from in \a string into \a to. The
+ * result will be in \a string
+ *
+ * \a string The string to work on
+ * \a from The character to replace
+ * \a to The character to replace with
+ */
+void BLI_char_switch(char *string, char from, char to);
 
+       /* Initialize path to program executable */
+void BLI_init_program_path(const char *argv0);
+       /* Initialize path to temporary directory.
+        * NOTE: On Window userdir will be set to the temporary directory! */
+void BLI_init_temporary_dir(char *userdir);
+
+       /* Path to executable */
+const char *BLI_program_path(void);
+       /* Path to directory of executable */
+const char *BLI_program_dir(void);
+       /* Path to temporary directory (with trailing slash) */
+const char *BLI_temporary_dir(void);
+       /* Path to the system temporary directory (with trailing slash) */
+void BLI_system_temporary_dir(char *dir);
 
 #ifdef WITH_ICONV
 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);