ED_file_indexer.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLO_readfile.hh"
 
struct LinkNode;
 
enum eFileIndexerResult {
  FILE_INDEXER_ENTRIES_LOADED,
 
  FILE_INDEXER_NEEDS_UPDATE,
};
 
struct FileIndexerEntry {
  BLODataBlockInfo datablock_info;
  short idcode;
};
 
struct FileIndexerEntries {
  LinkNode /*FileIndexerEntry*/ *entries;
};
 
using FileIndexerInitUserDataFunc = void *(*)(const char *root_directory,
                                              size_t root_directory_maxlen);
using FileIndexerFreeUserDataFunc = void (*)(void *);
using FileIndexerFinishedFunc = void (*)(void *);
using FileIndexerReadIndexFunc = eFileIndexerResult (*)(const char *file_name,
                                                        FileIndexerEntries *entries,
                                                        int *r_read_entries_len,
                                                        void *user_data);
using FileIndexerUpdateIndexFunc = void (*)(const char *file_name,
                                            FileIndexerEntries *entries,
                                            void *user_data);
 
struct FileIndexerType {
  FileIndexerInitUserDataFunc init_user_data;
 
  FileIndexerFreeUserDataFunc free_user_data;
 
  FileIndexerFinishedFunc filelist_finished;
 
  FileIndexerReadIndexFunc read_index;
 
  FileIndexerUpdateIndexFunc update_index;
};
 
/* `file_indexer.cc` */
 
void ED_file_indexer_entries_clear(FileIndexerEntries *indexer_entries);
 
void ED_file_indexer_entries_extend_from_datablock_infos(
    FileIndexerEntries *indexer_entries,
    LinkNode * /*BLODataBlockInfo*/ datablock_infos,
    int idcode);