Final 'FileBrowser First Stage' merge.

It basically rewrites most of filelist.c, with some more limited changes in other areas of filebrowser.

From user perspective, it:
* Removes some info in 'long' drawing mode (owner, permissions) - OS-specific data that do not really matter in Blender!
* Makes short/long display 'fixed' size (among four choices, like thumbnails mode).
* Allows to list several layers of dirtree at once, in a flat way (inside .blend files and/or real directories).
* Consequently, adds datablocks types filtering.
* Uses way less RAM when listing big directories, especially in thumbnail mode (we are talking of several hundred of MiB spared).
* Generates thumbnails way faster.

From code perspective, it:
* Is ready for asset engine needs (on data structure level in filebrowser's listing).
* Simplifies and makes 'generic' file listing much lighter.
* Separates file listing in three different aspects:
** 'generic' filelisting (in BLI), which becomes a shallow wrapper around stat struct.
** 'filebrowser drawing' filelisting, which only contains current visible subset of the whole list (sliding window), with extra drawing data (strings for size, date/time, preview, etc.).
** 'asset-ready' filelisting, which is used for operations common to 'basic' filehandling and future asset-related one.
* Uses uuid's to handle file selection/state in the browser, instead of using flags in filelisting items.
* Uses much lighter BLI_task handling for previews, instead of heavy 'job' system (using the new 'notifier' timer to handle UI refresh, in similar way to jobs).
* Moves .blend datablocks preview handling to IMB_thumbnail (necessary to avoid storing all datablock previews at once, and gives better consistency and performances too).

Revision: https://developer.blender.org/D1316

Thanks to Campbell & Sergey for the reviews. :)

1 files changed, 114 insertions, 91 deletions

diff --git a/source/blender/editors/space_file/file_draw.c b/source/blender/editors/space_file/file_draw.c
index 9922290bf6f..c809b79bd61 100644
--- a/source/blender/editors/space_file/file_draw.c
+++ b/source/blender/editors/space_file/file_draw.c
@@ -35,6 +35,7 @@
 #include "BLI_blenlib.h"
 #include "BLI_utildefines.h"
 #include "BLI_fileops_types.h"
+#include "BLI_math.h"
 
 #ifdef WIN32
 #  include "BLI_winstuff.h"
@@ -47,6 +48,8 @@
 #include "BKE_global.h"
 #include "BKE_main.h"
 
+#include "BLO_readfile.h"
+
 #include "BLT_translation.h"
 
 #include "IMB_imbuf_types.h"
@@ -64,12 +67,20 @@
 #include "UI_resources.h"
 #include "UI_view2d.h"
 
+#include "WM_api.h"
 #include "WM_types.h"
 
 #include "filelist.h"
 
 #include "file_intern.h"    // own include
 
+/* Dummy helper - we need dynamic tooltips here. */
+static char *file_draw_tooltip_func(bContext *UNUSED(C), void *argN, const char *UNUSED(tip))
+{
+	char *dyn_tooltip = argN;
+	return BLI_strdup(dyn_tooltip);
+}
+
 /* Note: This function uses pixelspace (0, 0, winx, winy), not view2d. 
  * The controls are laid out as follows:
  *
@@ -157,9 +168,9 @@ void file_draw_buttons(const bContext *C, ARegion *ar)
 
 	/* Text input fields for directory and file. */
 	if (available_w > 0) {
-		const struct direntry *file = sfile->files ? filelist_file(sfile->files, params->active_file) : NULL;
+		const struct FileDirEntry *file = sfile->files ? filelist_file(sfile->files, params->active_file) : NULL;
 		int overwrite_alert = file_draw_check_exists(sfile);
-		const bool is_active_dir = file && file->path && BLI_is_dir(file->path);
+		const bool is_active_dir = file && (file->typeflag & FILE_TYPE_FOLDER);
 
 		/* callbacks for operator check functions */
 		UI_block_func_set(block, file_draw_check_cb, NULL, NULL);
@@ -220,8 +231,8 @@ void file_draw_buttons(const bContext *C, ARegion *ar)
 	
 	/* Execute / cancel buttons. */
 	if (loadbutton) {
-		const struct direntry *file = filelist_file(sfile->files, params->active_file);
-		const char *str_exec = (file && file->path && BLI_is_dir(file->path)) ?
+		const struct FileDirEntry *file = sfile->files ? filelist_file(sfile->files, params->active_file) : NULL;
+		const char *str_exec = (file && (file->typeflag & FILE_TYPE_FOLDER)) ?
 		                        /* params->title is already translated! */
 		                        IFACE_("Open Directory") : params->title;
 
@@ -244,44 +255,6 @@ static void draw_tile(int sx, int sy, int width, int height, int colorid, int sh
 }
 
 
-static int get_file_icon(struct direntry *file)
-{
-	if (file->type & S_IFDIR) {
-		if (FILENAME_IS_PARENT(file->relname)) {
-			return ICON_FILE_PARENT;
-		}
-		if (file->flags & FILE_TYPE_APPLICATIONBUNDLE) {
-			return ICON_UGLYPACKAGE;
-		}
-		if (file->flags & FILE_TYPE_BLENDER) {
-			return ICON_FILE_BLEND;
-		}
-		return ICON_FILE_FOLDER;
-	}
-	else if (file->flags & FILE_TYPE_BLENDER)
-		return ICON_FILE_BLEND;
-	else if (file->flags & FILE_TYPE_BLENDER_BACKUP)
-		return ICON_FILE_BACKUP;
-	else if (file->flags & FILE_TYPE_IMAGE)
-		return ICON_FILE_IMAGE;
-	else if (file->flags & FILE_TYPE_MOVIE)
-		return ICON_FILE_MOVIE;
-	else if (file->flags & FILE_TYPE_PYSCRIPT)
-		return ICON_FILE_SCRIPT;
-	else if (file->flags & FILE_TYPE_SOUND)
-		return ICON_FILE_SOUND;
-	else if (file->flags & FILE_TYPE_FTFONT)
-		return ICON_FILE_FONT;
-	else if (file->flags & FILE_TYPE_BTX)
-		return ICON_FILE_BLANK;
-	else if (file->flags & FILE_TYPE_COLLADA)
-		return ICON_FILE_BLANK;
-	else if (file->flags & FILE_TYPE_TEXT)
-		return ICON_FILE_TEXT;
-	else
-		return ICON_FILE_BLANK;
-}
-
 static void file_draw_icon(uiBlock *block, const char *path, int sx, int sy, int icon, int width, int height, bool drag)
 {
 	uiBut *but;
@@ -293,10 +266,12 @@ static void file_draw_icon(uiBlock *block, const char *path, int sx, int sy, int
 	
 	/*if (icon == ICON_FILE_BLANK) alpha = 0.375f;*/
 
-	but = uiDefIconBut(block, UI_BTYPE_LABEL, 0, icon, x, y, width, height, NULL, 0.0f, 0.0f, 0.0f, 0.0f, "");
+	but = uiDefIconBut(block, UI_BTYPE_LABEL, 0, icon, x, y, width, height, NULL, 0.0f, 0.0f, 0.0f, 0.0f, NULL);
+	UI_but_func_tooltip_set(but, file_draw_tooltip_func, BLI_strdup(path));
 
 	if (drag) {
-		UI_but_drag_set_path(but, path, false);
+		/* path is no more static, cannot give it directly to but... */
+		UI_but_drag_set_path(but, BLI_strdup(path), true);
 	}
 }
 
@@ -338,7 +313,9 @@ void file_calc_previews(const bContext *C, ARegion *ar)
 	UI_view2d_totRect_set(v2d, sfile->layout->width, sfile->layout->height);
 }
 
-static void file_draw_preview(uiBlock *block, struct direntry *file, int sx, int sy, ImBuf *imb, FileLayout *layout, bool is_icon, bool drag)
+static void file_draw_preview(
+        uiBlock *block, const char *path, int sx, int sy, const float icon_aspect,
+        ImBuf *imb, const int icon, FileLayout *layout, const bool is_icon, const int typeflags, const bool drag)
 {
 	uiBut *but;
 	float fx, fy;
@@ -348,7 +325,7 @@ static void file_draw_preview(uiBlock *block, struct direntry *file, int sx, int
 	float scaledx, scaledy;
 	float scale;
 	int ex, ey;
-	bool use_dropshadow = !is_icon && (file->flags & FILE_TYPE_IMAGE);
+	bool use_dropshadow = !is_icon && (typeflags & FILE_TYPE_IMAGE);
 
 	BLI_assert(imb != NULL);
 
@@ -394,7 +371,7 @@ static void file_draw_preview(uiBlock *block, struct direntry *file, int sx, int
 	glEnable(GL_BLEND);
 
 	/* the image */
-	if (!is_icon && file->flags & FILE_TYPE_FTFONT) {
+	if (!is_icon && typeflags & FILE_TYPE_FTFONT) {
 		UI_ThemeColor(TH_TEXT);
 	}
 	else {
@@ -402,16 +379,23 @@ static void file_draw_preview(uiBlock *block, struct direntry *file, int sx, int
 	}
 	glaDrawPixelsTexScaled((float)xco, (float)yco, imb->x, imb->y, GL_RGBA, GL_UNSIGNED_BYTE, GL_NEAREST, imb->rect, scale, scale);
 
+	if (icon) {
+		UI_icon_draw_aspect((float)xco, (float)yco, icon, icon_aspect, 1.0f);
+	}
+
 	/* border */
 	if (use_dropshadow) {
 		glColor4f(0.0f, 0.0f, 0.0f, 0.4f);
 		fdrawbox((float)xco, (float)yco, (float)(xco + ex), (float)(yco + ey));
 	}
 
+	but = uiDefBut(block, UI_BTYPE_LABEL, 0, "", xco, yco, ex, ey, NULL, 0.0, 0.0, 0, 0, NULL);
+	UI_but_func_tooltip_set(but, file_draw_tooltip_func, BLI_strdup(path));
+
 	/* dragregion */
 	if (drag) {
-		but = uiDefBut(block, UI_BTYPE_LABEL, 0, "", xco, yco, ex, ey, NULL, 0.0, 0.0, 0, 0, "");
-		UI_but_drag_set_image(but, file->path, get_file_icon(file), imb, scale, false);
+		/* path is no more static, cannot give it directly to but... */
+		UI_but_drag_set_image(but, BLI_strdup(path), icon, imb, scale, true);
 	}
 
 	glDisable(GL_BLEND);
@@ -424,6 +408,7 @@ static void renamebutton_cb(bContext *C, void *UNUSED(arg1), char *oldname)
 	char filename[FILE_MAX + 12];
 	wmWindowManager *wm = CTX_wm_manager(C);
 	SpaceFile *sfile = (SpaceFile *)CTX_wm_space_data(C);
+	ScrArea *sa = CTX_wm_area(C);
 	ARegion *ar = CTX_wm_region(C);
 
 	BLI_make_file_string(G.main->name, orgname, sfile->params->dir, oldname);
@@ -435,7 +420,7 @@ static void renamebutton_cb(bContext *C, void *UNUSED(arg1), char *oldname)
 		if (!BLI_exists(newname)) {
 			BLI_rename(orgname, newname);
 			/* to make sure we show what is on disk */
-			ED_fileselect_clear(wm, sfile);
+			ED_fileselect_clear(wm, sa, sfile);
 		}
 
 		ED_region_tag_redraw(ar);
@@ -500,7 +485,8 @@ void file_draw_list(const bContext *C, ARegion *ar)
 	FileLayout *layout = ED_fileselect_get_layout(sfile, ar);
 	View2D *v2d = &ar->v2d;
 	struct FileList *files = sfile->files;
-	struct direntry *file;
+	struct FileDirEntry *file;
+	const char *root = filelist_dir(files);
 	ImBuf *imb;
 	uiBlock *block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
 	int numfiles;
@@ -513,8 +499,11 @@ void file_draw_list(const bContext *C, ARegion *ar)
 	short align;
 	bool do_drag;
 	int column_space = 0.6f * UI_UNIT_X;
+	const bool small_size = SMALL_SIZE_CHECK(params->thumbnail_size);
+	const bool update_stat_strings = small_size != SMALL_SIZE_CHECK(layout->curr_size);
+	const float thumb_icon_aspect = sqrtf(64.0f / (float)(params->thumbnail_size));
 
-	numfiles = filelist_numfiles(files);
+	numfiles = filelist_files_ensure(files);
 	
 	if (params->display != FILE_IMGDISPLAY) {
 
@@ -536,27 +525,61 @@ void file_draw_list(const bContext *C, ARegion *ar)
 		numfiles_layout += layout->columns;
 	}
 
+	filelist_file_cache_slidingwindow_set(files, numfiles_layout);
+
 	textwidth = (FILE_IMGDISPLAY == params->display) ? layout->tile_w : (int)layout->column_widths[COLUMN_NAME];
 	textheight = (int)(layout->textheight * 3.0 / 2.0 + 0.5);
 
 	align = (FILE_IMGDISPLAY == params->display) ? UI_STYLE_TEXT_CENTER : UI_STYLE_TEXT_LEFT;
 
+	if (numfiles > 0) {
+		const bool success = filelist_file_cache_block(files, min_ii(offset + (numfiles_layout / 2), numfiles - 1));
+		BLI_assert(success);
+		UNUSED_VARS_NDEBUG(success);
+
+		filelist_cache_previews_update(files);
+
+		/* Handle preview timer here, since it's filelist_file_cache_block() and filelist_cache_previews_update()
+		 * which controlls previews task. */
+		{
+			const bool previews_running = filelist_cache_previews_running(files);
+//			printf("%s: preview task: %d\n", __func__, previews_running);
+			if (previews_running && !sfile->previews_timer) {
+				sfile->previews_timer = WM_event_add_timer_notifier(CTX_wm_manager(C), CTX_wm_window(C),
+																	NC_SPACE | ND_SPACE_FILE_PREVIEW, 0.01);
+			}
+			if (!previews_running && sfile->previews_timer) {
+				/* Preview is not running, no need to keep generating update events! */
+//				printf("%s: Inactive preview task, sleeping!\n", __func__);
+				WM_event_remove_timer_notifier(CTX_wm_manager(C), CTX_wm_window(C), sfile->previews_timer);
+				sfile->previews_timer = NULL;
+			}
+		}
+	}
+
 	for (i = offset; (i < numfiles) && (i < offset + numfiles_layout); i++) {
+		unsigned int file_selflag;
+		char path[FILE_MAX_LIBEXTRA];
 		ED_fileselect_layout_tilepos(layout, i, &sx, &sy);
 		sx += (int)(v2d->tot.xmin + 0.1f * UI_UNIT_X);
 		sy = (int)(v2d->tot.ymax - sy);
 
 		file = filelist_file(files, i);
+		file_selflag = filelist_entry_select_get(sfile->files, file, CHECK_ALL);
+
+		BLI_join_dirfile(path, sizeof(path), root, file->relpath);
 
 		UI_ThemeColor4(TH_TEXT);
 
 
-		if (!(file->selflag & FILE_SEL_EDITING)) {
-			if ((params->highlight_file == i) || (file->selflag & FILE_SEL_HIGHLIGHTED) || (file->selflag & FILE_SEL_SELECTED)) {
-				int colorid = (file->selflag & FILE_SEL_SELECTED) ? TH_HILITE : TH_BACK;
-				int shade = (params->highlight_file == i) || (file->selflag & FILE_SEL_HIGHLIGHTED) ? 35 : 0;
+		if (!(file_selflag & FILE_SEL_EDITING)) {
+			if ((params->highlight_file == i) || (file_selflag & FILE_SEL_HIGHLIGHTED) ||
+			    (file_selflag & FILE_SEL_SELECTED))
+			{
+				int colorid = (file_selflag & FILE_SEL_SELECTED) ? TH_HILITE : TH_BACK;
+				int shade = (params->highlight_file == i) || (file_selflag & FILE_SEL_HIGHLIGHTED) ? 35 : 0;
 
-				BLI_assert(i > 0 || FILENAME_IS_CURRPAR(file->relname));
+				BLI_assert(i > 0 || FILENAME_IS_CURRPAR(file->relpath));
 
 				draw_tile(sx, sy - 1, layout->tile_w + 4, sfile->layout->tile_h + layout->tile_border_y, colorid, shade);
 			}
@@ -564,26 +587,29 @@ void file_draw_list(const bContext *C, ARegion *ar)
 		UI_draw_roundbox_corner_set(UI_CNR_NONE);
 
 		/* don't drag parent or refresh items */
-		do_drag = !(FILENAME_IS_CURRPAR(file->relname));
+		do_drag = !(FILENAME_IS_CURRPAR(file->relpath));
 
 		if (FILE_IMGDISPLAY == params->display) {
+			const int icon = filelist_geticon(files, i, false);
 			is_icon = 0;
 			imb = filelist_getimage(files, i);
 			if (!imb) {
-				imb = filelist_geticon(files, i);
+				imb = filelist_geticon_image(files, i);
 				is_icon = 1;
 			}
 
-			file_draw_preview(block, file, sx, sy, imb, layout, is_icon, do_drag);
+			file_draw_preview(block, path, sx, sy, thumb_icon_aspect,
+			                  imb, icon, layout, is_icon, file->typeflag, do_drag);
 		}
 		else {
-			file_draw_icon(block, file->path, sx, sy - (UI_UNIT_Y / 6), get_file_icon(file), ICON_DEFAULT_WIDTH_SCALE, ICON_DEFAULT_HEIGHT_SCALE, do_drag);
+			file_draw_icon(block, path, sx, sy - (UI_UNIT_Y / 6), filelist_geticon(files, i, true),
+			               ICON_DEFAULT_WIDTH_SCALE, ICON_DEFAULT_HEIGHT_SCALE, do_drag);
 			sx += ICON_DEFAULT_WIDTH_SCALE + 0.2f * UI_UNIT_X;
 		}
 
 		UI_ThemeColor4(TH_TEXT);
 
-		if (file->selflag & FILE_SEL_EDITING) {
+		if (file_selflag & FILE_SEL_EDITING) {
 			uiBut *but;
 			short width;
 
@@ -591,9 +617,7 @@ void file_draw_list(const bContext *C, ARegion *ar)
 				width = layout->tile_w - (ICON_DEFAULT_WIDTH_SCALE + 0.2f * UI_UNIT_X);
 			}
 			else if (params->display == FILE_LONGDISPLAY) {
-				width = layout->column_widths[COLUMN_NAME]  + layout->column_widths[COLUMN_MODE1] +
-				        layout->column_widths[COLUMN_MODE2] + layout->column_widths[COLUMN_MODE3] +
-				        (column_space * 3.5f);
+				width = layout->column_widths[COLUMN_NAME] + (column_space * 3.5f);
 			}
 			else {
 				BLI_assert(params->display == FILE_IMGDISPLAY);
@@ -601,53 +625,51 @@ void file_draw_list(const bContext *C, ARegion *ar)
 			}
 
 			but = uiDefBut(block, UI_BTYPE_TEXT, 1, "", sx, sy - layout->tile_h - 0.15f * UI_UNIT_X,
-			               width, textheight, sfile->params->renameedit, 1.0f, (float)sizeof(sfile->params->renameedit), 0, 0, "");
+			               width, textheight, sfile->params->renameedit, 1.0f,
+			               (float)sizeof(sfile->params->renameedit), 0, 0, "");
 			UI_but_func_rename_set(but, renamebutton_cb, file);
 			UI_but_flag_enable(but, UI_BUT_NO_UTF8); /* allow non utf8 names */
 			UI_but_flag_disable(but, UI_BUT_UNDO);
 			if (false == UI_but_active_only(C, ar, block, but)) {
-				file->selflag &= ~FILE_SEL_EDITING;
+				file_selflag = filelist_entry_select_set(
+				                   sfile->files, file, FILE_SEL_REMOVE, FILE_SEL_EDITING, CHECK_ALL);
 			}
 		}
 
-		if (!(file->selflag & FILE_SEL_EDITING)) {
+		if (!(file_selflag& FILE_SEL_EDITING)) {
 			int tpos = (FILE_IMGDISPLAY == params->display) ? sy - layout->tile_h + layout->textheight : sy;
-			file_draw_string(sx + 1, tpos, file->relname, (float)textwidth, textheight, align);
+			file_draw_string(sx + 1, tpos, file->name, (float)textwidth, textheight, align);
 		}
 
 		if (params->display == FILE_SHORTDISPLAY) {
 			sx += (int)layout->column_widths[COLUMN_NAME] + column_space;
-			if (!(file->type & S_IFDIR)) {
-				file_draw_string(sx, sy, file->size, layout->column_widths[COLUMN_SIZE], layout->tile_h, align);
+			if (!(file->typeflag & FILE_TYPE_DIR)) {
+				if ((file->entry->size_str[0] == '\0') || update_stat_strings) {
+					BLI_filelist_entry_size_to_string(NULL, file->entry->size, small_size, file->entry->size_str);
+				}
+				file_draw_string(
+				            sx, sy, file->entry->size_str, layout->column_widths[COLUMN_SIZE], layout->tile_h, align);
 				sx += (int)layout->column_widths[COLUMN_SIZE] + column_space;
 			}
 		}
 		else if (params->display == FILE_LONGDISPLAY) {
 			sx += (int)layout->column_widths[COLUMN_NAME] + column_space;
 
-#ifndef WIN32
-			/* rwx rwx rwx */
-			file_draw_string(sx, sy, file->mode1, layout->column_widths[COLUMN_MODE1], layout->tile_h, align); 
-			sx += layout->column_widths[COLUMN_MODE1] + column_space;
-
-			file_draw_string(sx, sy, file->mode2, layout->column_widths[COLUMN_MODE2], layout->tile_h, align);
-			sx += layout->column_widths[COLUMN_MODE2] + column_space;
-
-			file_draw_string(sx, sy, file->mode3, layout->column_widths[COLUMN_MODE3], layout->tile_h, align);
-			sx += layout->column_widths[COLUMN_MODE3] + column_space;
-
-			file_draw_string(sx, sy, file->owner, layout->column_widths[COLUMN_OWNER], layout->tile_h, align);
-			sx += layout->column_widths[COLUMN_OWNER] + column_space;
-#endif
-
-			file_draw_string(sx, sy, file->date, layout->column_widths[COLUMN_DATE], layout->tile_h, align);
+			if ((file->entry->date_str[0] == '\0') || update_stat_strings) {
+				BLI_filelist_entry_datetime_to_string(
+				            NULL, file->entry->time, small_size, file->entry->time_str, file->entry->date_str);
+			}
+			file_draw_string(sx, sy, file->entry->date_str, layout->column_widths[COLUMN_DATE], layout->tile_h, align);
 			sx += (int)layout->column_widths[COLUMN_DATE] + column_space;
-
-			file_draw_string(sx, sy, file->time, layout->column_widths[COLUMN_TIME], layout->tile_h, align);
+			file_draw_string(sx, sy, file->entry->time_str, layout->column_widths[COLUMN_TIME], layout->tile_h, align);
 			sx += (int)layout->column_widths[COLUMN_TIME] + column_space;
 
-			if (!(file->type & S_IFDIR)) {
-				file_draw_string(sx, sy, file->size, layout->column_widths[COLUMN_SIZE], layout->tile_h, align);
+			if (!(file->typeflag & FILE_TYPE_DIR)) {
+				if ((file->entry->size_str[0] == '\0') || update_stat_strings) {
+					BLI_filelist_entry_size_to_string(NULL, file->entry->size, small_size, file->entry->size_str);
+				}
+				file_draw_string(
+				            sx, sy, file->entry->size_str, layout->column_widths[COLUMN_SIZE], layout->tile_h, align);
 				sx += (int)layout->column_widths[COLUMN_SIZE] + column_space;
 			}
 		}
@@ -656,4 +678,5 @@ void file_draw_list(const bContext *C, ARegion *ar)
 	UI_block_end(C, block);
 	UI_block_draw(C, block);
 
+	layout->curr_size = params->thumbnail_size;
 }