code cleanup: better use of BLI_array_* (grow in larger steps where possible), includ...
[blender.git] / source / blender / blenlib / BLI_path_util.h
index 56ecec042f29cd77adbbb4b684e1627fd55706b5..e02b48feda7812d3cb4bad657e0873c309b853c6 100644 (file)
@@ -1,6 +1,4 @@
 /*
 /*
- * $Id$
- *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -26,8 +24,8 @@
  *
  * ***** END GPL LICENSE BLOCK *****
  */
  *
  * ***** 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
 
 /** \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_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
 /* 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"
 
 #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 '/'
 #ifdef WIN32
 #define SEP '\\'
 #define ALTSEP '/'
@@ -119,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_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);
 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);
@@ -131,10 +115,10 @@ void BLI_splitdirstring(char *di,char *fi);
 void BLI_clean(char *path);
 
 /**
 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 */
 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 */
@@ -145,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);
 
 /* 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);
 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);
@@ -171,14 +155,14 @@ void BLI_path_rel(char *file, const char *relfile);
 #  define BLI_path_ncmp strncmp
 #endif
 
 #  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
       */
+/**
* 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_char_switch(char *string, char from, char to);
 
        /* Initialize path to program executable */