file_path.h

Go to the documentation of this file.

/* Copyright (C) 2010-2018 The RetroArch team
 *
 * ---------------------------------------------------------------------------------------
 * The following license statement only applies to this file (file_path.h).
 * ---------------------------------------------------------------------------------------
 *
 * Permission is hereby granted, free of charge,
 * to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef __LIBRETRO_SDK_FILE_PATH_H
#define __LIBRETRO_SDK_FILE_PATH_H

#include <stdio.h>
#include <stdint.h>
#include <stddef.h>
#include <sys/types.h>

#include <retro_common_api.h>

#include <boolean.h>

RETRO_BEGIN_DECLS

/* Order in this enum is equivalent to negative sort order in filelist
 * (i.e. DIRECTORY is on top of PLAIN_FILE) */
enum
{
 RARCH_FILETYPE_UNSET,
 RARCH_PLAIN_FILE,
 RARCH_COMPRESSED_FILE_IN_ARCHIVE,
 RARCH_COMPRESSED_ARCHIVE,
 RARCH_DIRECTORY,
 RARCH_FILE_UNSUPPORTED
};


bool path_is_compressed_file(const char *path);

#define path_contains_compressed_file(path) (path_get_archive_delim((path)) != NULL)

const char *path_get_archive_delim(const char *path);

const char *path_get_extension(const char *path);

char *path_remove_extension(char *path);

const char *path_basename(const char *path);

void path_basedir(char *path);

void path_parent_dir(char *path);

void path_resolve_realpath(char *buf, size_t size);

bool path_is_absolute(const char *path);

void fill_pathname(char *out_path, const char *in_path,
 const char *replace, size_t size);

void fill_dated_filename(char *out_filename,
 const char *ext, size_t size);

void fill_str_dated_filename(char *out_filename,
 const char *in_str, const char *ext, size_t size);

void fill_pathname_noext(char *out_path, const char *in_path,
 const char *replace, size_t size);

char *find_last_slash(const char *str);

void fill_pathname_dir(char *in_dir, const char *in_basename,
 const char *replace, size_t size);

void fill_pathname_base(char *out_path, const char *in_path, size_t size);

void fill_pathname_base_noext(char *out_dir,
 const char *in_path, size_t size);

void fill_pathname_base_ext(char *out,
 const char *in_path, const char *ext,
 size_t size);

void fill_pathname_basedir(char *out_path, const char *in_path, size_t size);

void fill_pathname_basedir_noext(char *out_dir,
 const char *in_path, size_t size);

bool fill_pathname_parent_dir_name(char *out_dir,
 const char *in_dir, size_t size);

void fill_pathname_parent_dir(char *out_dir,
 const char *in_dir, size_t size);

void fill_pathname_resolve_relative(char *out_path, const char *in_refpath,
 const char *in_path, size_t size);

void fill_pathname_join(char *out_path, const char *dir,
 const char *path, size_t size);

void fill_pathname_join_special_ext(char *out_path,
 const char *dir, const char *path,
 const char *last, const char *ext,
 size_t size);

void fill_pathname_join_concat_noext(
 char *out_path,
 const char *dir, const char *path,
 const char *concat,
 size_t size);

void fill_pathname_join_concat(char *out_path,
 const char *dir, const char *path,
 const char *concat,
 size_t size);

void fill_pathname_join_noext(char *out_path,
 const char *dir, const char *path, size_t size);

void fill_pathname_join_delim(char *out_path, const char *dir,
 const char *path, const char delim, size_t size);

void fill_pathname_join_delim_concat(char *out_path, const char *dir,
 const char *path, const char delim, const char *concat,
 size_t size);

void fill_short_pathname_representation(char* out_rep,
 const char *in_path, size_t size);

void fill_short_pathname_representation_noext(char* out_rep,
 const char *in_path, size_t size);

void fill_pathname_expand_special(char *out_path,
 const char *in_path, size_t size);

void fill_pathname_abbreviate_special(char *out_path,
 const char *in_path, size_t size);

void path_basedir_wrapper(char *path);

#ifdef _WIN32
#define path_char_is_slash(c) (((c) == '/') || ((c) == '\\'))
#else
#define path_char_is_slash(c) ((c) == '/')
#endif

#ifdef _WIN32
#define path_default_slash() "\\"
#define path_default_slash_c() '\\'
#else
#define path_default_slash() "/"
#define path_default_slash_c() '/'
#endif

void fill_pathname_slash(char *path, size_t size);

#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
void fill_pathname_application_path(char *buf, size_t size);
void fill_pathname_application_dir(char *buf, size_t size);
void fill_pathname_home_dir(char *buf, size_t size);
#endif

bool path_mkdir(const char *dir);

bool path_is_directory(const char *path);

bool path_is_character_special(const char *path);

bool path_is_valid(const char *path);

int32_t path_get_size(const char *path);

RETRO_END_DECLS

#endif