BKE_appdir.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once

 
#include <cstddef>
 
#include <optional>
#include <string>
 
#include "BLI_compiler_attrs.h"
 
struct ListBase;

void BKE_appdir_init();
void BKE_appdir_exit();

const char *BKE_appdir_folder_default() ATTR_WARN_UNUSED_RESULT;
const char *BKE_appdir_folder_root() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
const char *BKE_appdir_folder_default_or_root() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
bool BKE_appdir_folder_documents(char *dir) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
bool BKE_appdir_folder_caches(char *path, size_t path_maxncpy) ATTR_NONNULL(1);
bool BKE_appdir_folder_id_ex(int folder_id,
                             const char *subfolder,
                             char *path,
                             size_t path_maxncpy);
std::optional<std::string> BKE_appdir_folder_id(int folder_id,
                                                const char *subfolder) ATTR_WARN_UNUSED_RESULT;
std::optional<std::string> BKE_appdir_folder_id_create(int folder_id, const char *subfolder)
    ATTR_WARN_UNUSED_RESULT;
std::optional<std::string> BKE_appdir_folder_id_user_notest(int folder_id, const char *subfolder)
    ATTR_WARN_UNUSED_RESULT;
std::optional<std::string> BKE_appdir_resource_path_id_with_version(int folder_id,
                                                                    bool check_is_dir,
                                                                    int version);
std::optional<std::string> BKE_appdir_resource_path_id(int folder_id, bool check_is_dir);

bool BKE_appdir_app_template_any();
bool BKE_appdir_app_template_id_search(const char *app_template, char *path, size_t path_maxncpy)
    ATTR_NONNULL(1);
bool BKE_appdir_app_template_has_userpref(const char *app_template) ATTR_NONNULL(1);
void BKE_appdir_app_templates(ListBase *templates) ATTR_NONNULL(1);

void BKE_appdir_program_path_init(const char *argv0) ATTR_NONNULL(1);

const char *BKE_appdir_program_path() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
const char *BKE_appdir_program_dir() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;

bool BKE_appdir_font_folder_default(char *dir, size_t dir_maxncpy);

bool BKE_appdir_program_python_search(char *program_filepath,
                                      size_t program_filepath_maxncpy,
                                      int version_major,
                                      int version_minor) ATTR_NONNULL(1);

void BKE_tempdir_init(const char *userdir);

const char *BKE_tempdir_base() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
const char *BKE_tempdir_session() ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
void BKE_tempdir_session_purge();

enum {
  /* general, will find based on user/local/system priority */
  BLENDER_DATAFILES = 2,
 
  /* user-specific */
  BLENDER_USER_CONFIG = 31,
  BLENDER_USER_DATAFILES = 32,
  BLENDER_USER_SCRIPTS = 33,
  BLENDER_USER_EXTENSIONS = 34,
 
  /* system */
  BLENDER_SYSTEM_DATAFILES = 52,
  BLENDER_SYSTEM_SCRIPTS = 53,
  BLENDER_SYSTEM_EXTENSIONS = 54,
  BLENDER_SYSTEM_PYTHON = 55,
};

enum {
  BLENDER_RESOURCE_PATH_USER = 0,
  BLENDER_RESOURCE_PATH_LOCAL = 1,
  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"
#define BLENDER_RECENT_SEARCHES_FILE "recent-searches.txt"
#define BLENDER_PLATFORM_SUPPORT_FILE "platform_support.txt"