155 lines
5.3 KiB
C
155 lines
5.3 KiB
C
/**
|
|
* blenlib/BLI_storage_types.h
|
|
*
|
|
* Some types for dealing with directories
|
|
*
|
|
* $Id$
|
|
*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
#ifndef BLI_UTIL_H
|
|
#define BLI_UTIL_H
|
|
|
|
/* XXX doesn't seem to be used, marded for removal
|
|
#define mallocstructN(x,y,name) (x*)MEM_mallocN((y)* sizeof(x),name)
|
|
#define callocstructN(x,y,name) (x*)MEM_callocN((y)* sizeof(x),name)
|
|
*/
|
|
|
|
struct ListBase;
|
|
struct direntry;
|
|
|
|
char *BLI_gethome(void);
|
|
char *BLI_gethome_folder(char *folder_name, int flag);
|
|
|
|
/* BLI_gethome_folder flag */
|
|
#define BLI_GETHOME_LOCAL 1<<1 /* relative location for portable binaries */
|
|
#define BLI_GETHOME_SYSTEM 1<<2 /* system location, or set from the BLENDERPATH env variable (UNIX only) */
|
|
#define BLI_GETHOME_USER 1<<3 /* home folder ~/.blender */
|
|
#define BLI_GETHOME_ALL (BLI_GETHOME_SYSTEM|BLI_GETHOME_LOCAL|BLI_GETHOME_USER)
|
|
|
|
void BLI_setenv(const char *env, const char *val);
|
|
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(char *name);
|
|
void BLI_split_dirfile(char *string, char *dir, char *file);
|
|
void BLI_split_dirfile_basic(const char *string, char *dir, char *file);
|
|
void BLI_join_dirfile(char *string, const char *dir, const char *file);
|
|
void BLI_getlastdir(const char* dir, char *last, int maxlen);
|
|
int BLI_testextensie(const char *str, const char *ext);
|
|
void BLI_uniquename(struct ListBase *list, void *vlink, char defname[], char delim, short name_offs, short len);
|
|
void BLI_newname(char * name, int add);
|
|
int BLI_stringdec(char *string, char *kop, char *start, unsigned short *numlen);
|
|
void BLI_stringenc(char *string, char *kop, char *start, unsigned short numlen, int pic);
|
|
void BLI_splitdirstring(char *di,char *fi);
|
|
|
|
/* make sure path separators conform to system one */
|
|
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
|
|
*/
|
|
void BLI_cleanup_file(const char *relabase, char *dir);
|
|
void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
|
|
|
|
/* go back one directory */
|
|
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 "//").
|
|
*/
|
|
int BLI_convertstringcode(char *path, const char *basepath);
|
|
int BLI_convertstringframe(char *path, int frame);
|
|
int BLI_convertstringcwd(char *path);
|
|
|
|
void BLI_makestringcode(const char *relfile, char *file);
|
|
|
|
/**
|
|
* 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 char *name);
|
|
|
|
char *get_install_dir(void);
|
|
/**
|
|
* 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, int usertemp);
|
|
|
|
|
|
/**
|
|
* determines the full path to the application bundle on OS X
|
|
*
|
|
* @return path to application bundle
|
|
*/
|
|
#ifdef __APPLE__
|
|
char* BLI_getbundle(void);
|
|
#endif
|
|
|
|
#ifdef WITH_ICONV
|
|
void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
|
|
#endif
|
|
|
|
#endif
|
|
|