Cleanup: Add API comment on side-effect of file browser query function
`filelist_file()` is an easy way to do a bunch of unnecessary work and fill the file browser caching for little reason. Unfortunately the caching affects too many things to be a mere API implementation detail, so rather be clear about this and point out alternatives.
This commit is contained in:
@@ -113,6 +113,16 @@ void filelist_setdir(struct FileList *filelist, char *r_dir);
|
||||
*/
|
||||
int filelist_files_ensure(struct FileList *filelist);
|
||||
int filelist_needs_reading(struct FileList *filelist);
|
||||
/**
|
||||
* Request a file from the file browser cache, adding it to the cache if necessary.
|
||||
*
|
||||
* As a rule of thumb, this can be used for operations on individual files (e.g. selection, active,
|
||||
* renaming, etc.). But avoid calling this on many files (like when iterating the entire list), to
|
||||
* not create a bunch of cache entries for a single operation. While a bit against the point of
|
||||
* "intern" entries, in this case it's probably better to have queries like
|
||||
* #filelist_entry_get_id(), that take a file index and return data directly from the
|
||||
* #FileListInternEntry.
|
||||
*/
|
||||
FileDirEntry *filelist_file(struct FileList *filelist, int index);
|
||||
FileDirEntry *filelist_file_ex(struct FileList *filelist, int index, bool use_request);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user