This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/intern/cycles/util/path.h
Brecht Van Lommel 9cfc7967dd Cycles: use SPDX license headers
* Replace license text in headers with SPDX identifiers.
* Remove specific license info from outdated readme.txt, instead leave details
  to the source files.
* Add list of SPDX license identifiers used, and corresponding license texts.
* Update copyright dates while we're at it.

Ref D14069, T95597
2022-02-11 17:47:34 +01:00

64 lines
1.9 KiB
C++

/* SPDX-License-Identifier: Apache-2.0
* Copyright 2011-2022 Blender Foundation */
#ifndef __UTIL_PATH_H__
#define __UTIL_PATH_H__
/* Utility functions to get paths to files distributed with the program. For
* the standalone apps, paths are relative to the executable, for dynamically
* linked libraries, the path to the library may be set with path_init, which
* then makes all paths relative to that. */
#include <stdio.h>
#include "util/set.h"
#include "util/string.h"
#include "util/types.h"
#include "util/vector.h"
CCL_NAMESPACE_BEGIN
/* program paths */
void path_init(const string &path = "", const string &user_path = "");
string path_get(const string &sub = "");
string path_user_get(const string &sub = "");
string path_cache_get(const string &sub = "");
/* path string manipulation */
string path_filename(const string &path);
string path_dirname(const string &path);
string path_join(const string &dir, const string &file);
string path_escape(const string &path);
bool path_is_relative(const string &path);
/* file info */
size_t path_file_size(const string &path);
bool path_exists(const string &path);
bool path_is_directory(const string &path);
string path_files_md5_hash(const string &dir);
uint64_t path_modified_time(const string &path);
/* directory utility */
void path_create_directories(const string &path);
/* file read/write utilities */
FILE *path_fopen(const string &path, const string &mode);
bool path_write_binary(const string &path, const vector<uint8_t> &binary);
bool path_write_text(const string &path, string &text);
bool path_read_binary(const string &path, vector<uint8_t> &binary);
bool path_read_text(const string &path, string &text);
/* File manipulation. */
bool path_remove(const string &path);
/* source code utility */
string path_source_replace_includes(const string &source, const string &path);
/* cache utility */
void path_cache_clear_except(const string &name, const set<string> &except);
CCL_NAMESPACE_END
#endif