206 lines
7.3 KiB
C
206 lines
7.3 KiB
C
/*
|
|
* ***** 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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_PATH_UTIL_H__
|
|
#define __BLI_PATH_UTIL_H__
|
|
|
|
/** \file BLI_path_util.h
|
|
* \ingroup bli
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
struct ListBase;
|
|
struct direntry;
|
|
|
|
const char *BLI_getDefaultDocumentFolder(void);
|
|
|
|
const char *BLI_get_folder(int folder_id, const char *subfolder);
|
|
const char *BLI_get_folder_create(int folder_id, const char *subfolder);
|
|
const char *BLI_get_user_folder_notest(int folder_id, const char *subfolder);
|
|
const char *BLI_get_folder_version(const int id, const int ver, const bool do_check);
|
|
|
|
/* folder_id */
|
|
|
|
/* general, will find based on user/local/system priority */
|
|
#define BLENDER_DATAFILES 2
|
|
|
|
/* user-specific */
|
|
#define BLENDER_USER_CONFIG 31
|
|
#define BLENDER_USER_DATAFILES 32
|
|
#define BLENDER_USER_SCRIPTS 33
|
|
#define BLENDER_USER_AUTOSAVE 34
|
|
|
|
/* system */
|
|
#define BLENDER_SYSTEM_DATAFILES 52
|
|
#define BLENDER_SYSTEM_SCRIPTS 53
|
|
#define BLENDER_SYSTEM_PYTHON 54
|
|
|
|
/* for BLI_get_folder_version only */
|
|
#define BLENDER_RESOURCE_PATH_USER 0
|
|
#define BLENDER_RESOURCE_PATH_LOCAL 1
|
|
#define BLENDER_RESOURCE_PATH_SYSTEM 2
|
|
|
|
#define BLENDER_STARTUP_FILE "startup.blend"
|
|
#define BLENDER_USERPREF_FILE "userpref.blend"
|
|
#define BLENDER_QUIT_FILE "quit.blend"
|
|
#define BLENDER_BOOKMARK_FILE "bookmarks.txt"
|
|
#define BLENDER_HISTORY_FILE "recent-files.txt"
|
|
|
|
#ifdef WIN32
|
|
#define SEP '\\'
|
|
#define ALTSEP '/'
|
|
#else
|
|
#define SEP '/'
|
|
#define ALTSEP '\\'
|
|
#endif
|
|
|
|
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(const char *name);
|
|
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_path_append(char *__restrict dst, const size_t maxlen,
|
|
const char *__restrict file) ATTR_NONNULL();
|
|
void BLI_join_dirfile(char *__restrict string, const size_t maxlen,
|
|
const char *__restrict dir, const char *__restrict file) ATTR_NONNULL();
|
|
const char *BLI_path_basename(const char *path);
|
|
|
|
typedef enum bli_rebase_state {
|
|
BLI_REBASE_NO_SRCDIR = 0,
|
|
BLI_REBASE_OK = 1,
|
|
BLI_REBASE_IDENTITY = 2
|
|
} bli_rebase_state;
|
|
|
|
int BLI_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);
|
|
|
|
const char *BLI_last_slash(const char *string);
|
|
int BLI_add_slash(char *string);
|
|
void BLI_del_slash(char *string);
|
|
const char *BLI_first_slash(const char *string);
|
|
|
|
void BLI_getlastdir(const char *dir, char *last, const size_t maxlen);
|
|
bool BLI_testextensie(const char *str, const char *ext);
|
|
bool BLI_testextensie_array(const char *str, const char **ext_array);
|
|
bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
|
|
bool BLI_replace_extension(char *path, size_t maxlen, const char *ext);
|
|
bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext);
|
|
bool BLI_ensure_filename(char *filepath, size_t maxlen, const char *filename);
|
|
void BLI_uniquename(struct ListBase *list, void *vlink, const char *defname, char delim, short name_offs, short len);
|
|
bool BLI_uniquename_cb(bool (*unique_check)(void *arg, const char *name),
|
|
void *arg, const char * defname, char delim, char *name, short name_len);
|
|
void BLI_newname(char *name, int add);
|
|
int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
|
|
void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
|
|
int BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
|
|
|
|
/* make sure path separators conform to system one */
|
|
void BLI_clean(char *path) ATTR_NONNULL();
|
|
|
|
/**
|
|
* 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 *path); /* 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 *path); /* doesn't touch trailing slash */
|
|
|
|
/* go back one directory */
|
|
bool BLI_parent_dir(char *path);
|
|
|
|
/* return whether directory is root and thus has no parent dir */
|
|
bool 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 "//").
|
|
*/
|
|
bool BLI_path_abs(char *path, const char *basepath);
|
|
bool BLI_path_frame(char *path, int frame, int digits);
|
|
bool BLI_path_frame_range(char *path, int sta, int end, int digits);
|
|
bool BLI_path_cwd(char *path);
|
|
void BLI_path_rel(char *file, const char *relfile);
|
|
|
|
bool BLI_path_is_rel(const char *path);
|
|
|
|
/* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
|
|
#if defined(WIN32)
|
|
# define BLI_path_cmp BLI_strcasecmp
|
|
# define BLI_path_ncmp BLI_strncasecmp
|
|
#else
|
|
# define BLI_path_cmp strcmp
|
|
# define BLI_path_ncmp strncmp
|
|
#endif
|
|
|
|
void BLI_char_switch(char *string, char from, char to) ATTR_NONNULL();
|
|
|
|
/* 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);
|
|
|
|
const char *BLI_program_path(void);
|
|
const char *BLI_program_dir(void);
|
|
const char *BLI_temporary_dir(void);
|
|
void BLI_system_temporary_dir(char *dir);
|
|
|
|
#ifdef WITH_ICONV
|
|
void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
|
|
#endif
|
|
|
|
/* these values need to be hardcoded in structs, dna does not recognize defines */
|
|
/* also defined in DNA_space_types.h */
|
|
#ifndef FILE_MAXDIR
|
|
# define FILE_MAXDIR 768
|
|
# define FILE_MAXFILE 256
|
|
# define FILE_MAX 1024
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|