4 * ***** BEGIN GPL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 * The Original Code is Copyright (C) 2008 Blender Foundation.
21 * All rights reserved.
24 * Contributor(s): Blender Foundation
26 * ***** END GPL LICENSE BLOCK *****
32 #include "DNA_object_types.h"
33 #include "DNA_space_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_screen_types.h"
37 #include "RNA_access.h"
39 #include "MEM_guardedalloc.h"
43 #include "BLO_readfile.h"
45 #include "BLI_blenlib.h"
46 #include "BLI_arithb.h"
48 #include "BLI_storage_types.h"
50 #include "BKE_colortools.h"
51 #include "BKE_context.h"
52 #include "BKE_screen.h"
54 #include "ED_space_api.h"
55 #include "ED_screen.h"
56 #include "ED_fileselect.h"
58 #include "IMB_imbuf_types.h"
59 #include "IMB_thumbs.h"
64 #include "UI_interface.h"
65 #include "UI_resources.h"
66 #include "UI_view2d.h"
69 #include "ED_markers.h"
70 #include "ED_fileselect.h"
72 #include "file_intern.h" // own include
76 /* ******************** default callbacks for file space ***************** */
78 static SpaceLink *file_new(const bContext *C)
83 sfile= MEM_callocN(sizeof(SpaceFile), "initfile");
84 sfile->spacetype= SPACE_FILE;
87 ar= MEM_callocN(sizeof(ARegion), "header for file");
88 BLI_addtail(&sfile->regionbase, ar);
89 ar->regiontype= RGN_TYPE_HEADER;
90 ar->alignment= RGN_ALIGN_TOP;
92 /* channel list region */
93 ar= MEM_callocN(sizeof(ARegion), "channel area for file");
94 BLI_addtail(&sfile->regionbase, ar);
95 ar->regiontype= RGN_TYPE_CHANNELS;
96 ar->alignment= RGN_ALIGN_LEFT;
99 ar= MEM_callocN(sizeof(ARegion), "ui area for file");
100 BLI_addtail(&sfile->regionbase, ar);
101 ar->regiontype= RGN_TYPE_UI;
102 ar->alignment= RGN_ALIGN_TOP;
105 ar= MEM_callocN(sizeof(ARegion), "main area for file");
106 BLI_addtail(&sfile->regionbase, ar);
107 ar->regiontype= RGN_TYPE_WINDOW;
108 ar->v2d.scroll = (V2D_SCROLL_RIGHT | V2D_SCROLL_BOTTOM);
109 ar->v2d.align = (V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_POS_Y);
110 ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_LIMITZOOM|V2D_KEEPASPECT);
111 ar->v2d.keeptot= V2D_KEEPTOT_STRICT;
112 ar->v2d.minzoom= ar->v2d.maxzoom= 1.0f;
114 return (SpaceLink *)sfile;
117 /* not spacelink itself */
118 static void file_free(SpaceLink *sl)
120 SpaceFile *sfile= (SpaceFile *) sl;
123 filelist_freelib(sfile->files);
124 filelist_free(sfile->files);
125 MEM_freeN(sfile->files);
129 if(sfile->folders_prev) {
130 folderlist_free(sfile->folders_prev);
131 MEM_freeN(sfile->folders_prev);
132 sfile->folders_prev= NULL;
135 if(sfile->folders_next) {
136 folderlist_free(sfile->folders_next);
137 MEM_freeN(sfile->folders_next);
138 sfile->folders_next= NULL;
142 if(sfile->params->pupmenu)
143 MEM_freeN(sfile->params->pupmenu);
144 MEM_freeN(sfile->params);
149 MEM_freeN(sfile->layout);
150 sfile->layout = NULL;
155 /* spacetype; init callback, area size changes, screen set, etc */
156 static void file_init(struct wmWindowManager *wm, ScrArea *sa)
158 SpaceFile *sfile= (SpaceFile*)sa->spacedata.first;
160 MEM_freeN(sfile->params);
162 ED_fileselect_set_params(sfile);
164 filelist_free(sfile->files);
165 MEM_freeN(sfile->files);
169 printf("file_init\n");
173 static SpaceLink *file_duplicate(SpaceLink *sl)
175 SpaceFile *sfileo= (SpaceFile*)sl;
176 SpaceFile *sfilen= MEM_dupallocN(sl);
178 /* clear or remove stuff from old */
179 sfilen->op = NULL; /* file window doesn't own operators */
182 sfilen->files = filelist_new(sfileo->params->type);
183 if(sfileo->folders_prev)
184 sfilen->folders_prev = MEM_dupallocN(sfileo->folders_prev);
186 if(sfileo->folders_next)
187 sfilen->folders_next = MEM_dupallocN(sfileo->folders_next);
190 sfilen->params= MEM_dupallocN(sfileo->params);
191 file_change_dir(sfilen);
193 if (sfileo->layout) {
194 sfilen->layout= MEM_dupallocN(sfileo->layout);
196 return (SpaceLink *)sfilen;
199 static void file_refresh(const bContext *C, ScrArea *sa)
201 SpaceFile *sfile= CTX_wm_space_file(C);
202 FileSelectParams *params = ED_fileselect_get_params(sfile);
204 if (!sfile->folders_prev)
205 sfile->folders_prev = folderlist_new();
207 sfile->files = filelist_new(params->type);
208 file_change_dir(sfile);
209 params->active_file = -1; // added this so it opens nicer (ton)
211 filelist_hidedot(sfile->files, params->flag & FILE_HIDE_DOT);
212 filelist_setfilter(sfile->files, params->flag & FILE_FILTER ? params->filter : 0);
213 if (filelist_empty(sfile->files))
215 filelist_readdir(sfile->files);
217 if(params->sort!=FILE_SORT_NONE) filelist_sort(sfile->files, params->sort);
219 if (params->renamefile[0] != '\0') {
220 int idx = filelist_find(sfile->files, params->renamefile);
222 struct direntry *file= filelist_file(sfile->files, idx);
224 file->flags |= EDITING;
227 params->renamefile[0] = '\0';
229 if (sfile->layout) sfile->layout->dirty= 1;
233 static void file_listener(ScrArea *sa, wmNotifier *wmn)
235 SpaceFile* sfile = (SpaceFile*)sa->spacedata.first;
237 /* context changes */
238 switch(wmn->category) {
241 case ND_SPACE_FILE_LIST:
242 if (sfile->files) filelist_free(sfile->files);
243 ED_area_tag_refresh(sa);
244 ED_area_tag_redraw(sa);
246 case ND_SPACE_FILE_PARAMS:
247 ED_area_tag_refresh(sa);
248 ED_area_tag_redraw(sa);
255 /* add handlers, stuff you only do once or on area/region changes */
256 static void file_main_area_init(wmWindowManager *wm, ARegion *ar)
260 UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
263 keymap= WM_keymap_find(wm, "File", SPACE_FILE, 0);
264 WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
266 keymap= WM_keymap_find(wm, "FileMain", SPACE_FILE, 0);
267 WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
272 static void file_main_area_listener(ARegion *ar, wmNotifier *wmn)
274 /* context changes */
275 switch(wmn->category) {
278 case ND_SPACE_FILE_LIST:
279 ED_region_tag_redraw(ar);
281 case ND_SPACE_FILE_PARAMS:
282 ED_region_tag_redraw(ar);
289 static void file_main_area_draw(const bContext *C, ARegion *ar)
291 /* draw entirely, view changes should be handled here */
292 SpaceFile *sfile= CTX_wm_space_file(C);
293 FileSelectParams *params = ED_fileselect_get_params(sfile);
294 FileLayout *layout=NULL;
296 View2D *v2d= &ar->v2d;
297 View2DScrollers *scrollers;
300 /* Needed, because filelist is not initialized on loading */
301 if (!sfile->files || filelist_empty(sfile->files))
302 file_refresh(C, NULL);
304 layout = ED_fileselect_get_layout(sfile, ar);
306 /* clear and setup matrix */
307 UI_GetThemeColor3fv(TH_BACK, col);
308 glClearColor(col[0], col[1], col[2], 0.0);
309 glClear(GL_COLOR_BUFFER_BIT);
311 /* Allow dynamically sliders to be set, saves notifiers etc. */
312 if (layout && (layout->flag == FILE_LAYOUT_VER)) {
313 v2d->scroll = V2D_SCROLL_RIGHT;
314 v2d->keepofs &= ~V2D_LOCKOFS_Y;
315 v2d->keepofs |= V2D_LOCKOFS_X;
318 v2d->scroll = V2D_SCROLL_BOTTOM;
319 v2d->keepofs &= ~V2D_LOCKOFS_X;
320 v2d->keepofs |= V2D_LOCKOFS_Y;
322 /* v2d has initialized flag, so this call will only set the mask correct */
323 UI_view2d_region_reinit(v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
325 /* sets tile/border settings in sfile */
326 file_calc_previews(C, ar);
329 UI_view2d_view_ortho(C, v2d);
331 /* on first read, find active file */
332 if (params->active_file == -1) {
333 wmEvent *event= CTX_wm_window(C)->eventstate;
334 file_hilight_set(sfile, ar, event->x, event->y);
337 file_draw_list(C, ar);
339 /* reset view matrix */
340 UI_view2d_view_restore(C);
343 scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
344 UI_view2d_scrollers_draw(C, v2d, scrollers);
345 UI_view2d_scrollers_free(scrollers);
349 void file_operatortypes(void)
351 WM_operatortype_append(FILE_OT_select);
352 WM_operatortype_append(FILE_OT_select_all_toggle);
353 WM_operatortype_append(FILE_OT_select_border);
354 WM_operatortype_append(FILE_OT_select_bookmark);
355 WM_operatortype_append(FILE_OT_loadimages);
356 WM_operatortype_append(FILE_OT_highlight);
357 WM_operatortype_append(FILE_OT_execute);
358 WM_operatortype_append(FILE_OT_cancel);
359 WM_operatortype_append(FILE_OT_parent);
360 WM_operatortype_append(FILE_OT_previous);
361 WM_operatortype_append(FILE_OT_next);
362 WM_operatortype_append(FILE_OT_refresh);
363 WM_operatortype_append(FILE_OT_bookmark_toggle);
364 WM_operatortype_append(FILE_OT_add_bookmark);
365 WM_operatortype_append(FILE_OT_delete_bookmark);
366 WM_operatortype_append(FILE_OT_hidedot);
367 WM_operatortype_append(FILE_OT_filenum);
368 WM_operatortype_append(FILE_OT_directory_new);
369 WM_operatortype_append(FILE_OT_delete);
370 WM_operatortype_append(FILE_OT_rename);
373 /* NOTE: do not add .blend file reading on this level */
374 void file_keymap(struct wmWindowManager *wm)
377 /* keys for all areas */
378 wmKeyMap *keymap= WM_keymap_find(wm, "File", SPACE_FILE, 0);
379 WM_keymap_add_item(keymap, "FILE_OT_bookmark_toggle", NKEY, KM_PRESS, 0, 0);
380 WM_keymap_add_item(keymap, "FILE_OT_parent", PKEY, KM_PRESS, 0, 0);
381 WM_keymap_add_item(keymap, "FILE_OT_add_bookmark", BKEY, KM_PRESS, KM_CTRL, 0);
382 WM_keymap_add_item(keymap, "FILE_OT_hidedot", HKEY, KM_PRESS, 0, 0);
383 WM_keymap_add_item(keymap, "FILE_OT_previous", BACKSPACEKEY, KM_PRESS, 0, 0);
384 WM_keymap_add_item(keymap, "FILE_OT_next", BACKSPACEKEY, KM_PRESS, KM_SHIFT, 0);
385 WM_keymap_add_item(keymap, "FILE_OT_directory_new", IKEY, KM_PRESS, 0, 0); /* XXX needs button */
386 WM_keymap_add_item(keymap, "FILE_OT_delete", XKEY, KM_PRESS, 0, 0);
388 /* keys for main area */
389 keymap= WM_keymap_find(wm, "FileMain", SPACE_FILE, 0);
390 WM_keymap_add_item(keymap, "FILE_OT_select", LEFTMOUSE, KM_PRESS, 0, 0);
391 WM_keymap_add_item(keymap, "FILE_OT_select_all_toggle", AKEY, KM_PRESS, 0, 0);
392 WM_keymap_add_item(keymap, "FILE_OT_select_border", BKEY, KM_PRESS, 0, 0);
393 WM_keymap_add_item(keymap, "FILE_OT_rename", LEFTMOUSE, KM_PRESS, KM_CTRL, 0);
394 WM_keymap_add_item(keymap, "FILE_OT_highlight", MOUSEMOVE, KM_ANY, 0, 0);
395 WM_keymap_add_item(keymap, "FILE_OT_loadimages", TIMER1, KM_ANY, KM_ANY, 0);
396 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, 0, 0);
397 RNA_int_set(kmi->ptr, "increment", 1);
398 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, KM_SHIFT, 0);
399 RNA_int_set(kmi->ptr, "increment", 10);
400 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, KM_CTRL, 0);
401 RNA_int_set(kmi->ptr, "increment", 100);
402 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, 0,0);
403 RNA_int_set(kmi->ptr, "increment", -1);
404 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, KM_SHIFT, 0);
405 RNA_int_set(kmi->ptr, "increment", -10);
406 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, KM_CTRL, 0);
407 RNA_int_set(kmi->ptr, "increment",-100);
409 /* keys for button area (top) */
410 keymap= WM_keymap_find(wm, "FileButtons", SPACE_FILE, 0);
411 WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, 0, 0);
412 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, 0, 0);
413 RNA_int_set(kmi->ptr, "increment", 1);
414 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, KM_SHIFT, 0);
415 RNA_int_set(kmi->ptr, "increment", 10);
416 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADPLUSKEY, KM_PRESS, KM_CTRL, 0);
417 RNA_int_set(kmi->ptr, "increment", 100);
418 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, 0, 0);
419 RNA_int_set(kmi->ptr, "increment", -1);
420 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, KM_SHIFT,0);
421 RNA_int_set(kmi->ptr, "increment", -10);
422 kmi = WM_keymap_add_item(keymap, "FILE_OT_filenum", PADMINUS, KM_PRESS, KM_CTRL,0);
423 RNA_int_set(kmi->ptr, "increment",-100);
427 static void file_channel_area_init(wmWindowManager *wm, ARegion *ar)
431 ED_region_panels_init(wm, ar);
434 keymap= WM_keymap_find(wm, "File", SPACE_FILE, 0);
435 WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
438 static void file_channel_area_draw(const bContext *C, ARegion *ar)
440 ED_region_panels(C, ar, 1, NULL, -1);
443 static void file_channel_area_listener(ARegion *ar, wmNotifier *wmn)
445 /* context changes */
446 switch(wmn->category) {
451 /* add handlers, stuff you only do once or on area/region changes */
452 static void file_header_area_init(wmWindowManager *wm, ARegion *ar)
454 ED_region_header_init(ar);
457 static void file_header_area_draw(const bContext *C, ARegion *ar)
459 ED_region_header(C, ar);
462 /* add handlers, stuff you only do once or on area/region changes */
463 static void file_ui_area_init(wmWindowManager *wm, ARegion *ar)
467 UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
470 keymap= WM_keymap_find(wm, "File", SPACE_FILE, 0);
471 WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
473 keymap= WM_keymap_find(wm, "FileButtons", SPACE_FILE, 0);
474 WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
477 static void file_ui_area_draw(const bContext *C, ARegion *ar)
481 UI_GetThemeColor3fv(TH_PANEL, col);
482 glClearColor(col[0], col[1], col[2], 0.0);
483 glClear(GL_COLOR_BUFFER_BIT);
485 /* set view2d view matrix for scrolling (without scrollers) */
486 UI_view2d_view_ortho(C, &ar->v2d);
488 file_draw_buttons(C, ar);
490 UI_view2d_view_restore(C);
493 static void file_ui_area_listener(ARegion *ar, wmNotifier *wmn)
495 /* context changes */
496 switch(wmn->category) {
499 case ND_SPACE_FILE_LIST:
500 ED_region_tag_redraw(ar);
507 /* only called once, from space/spacetypes.c */
508 void ED_spacetype_file(void)
510 SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype file");
513 st->spaceid= SPACE_FILE;
518 st->duplicate= file_duplicate;
519 st->refresh= file_refresh;
520 st->listener= file_listener;
521 st->operatortypes= file_operatortypes;
522 st->keymap= file_keymap;
524 /* regions: main window */
525 art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
526 art->regionid = RGN_TYPE_WINDOW;
527 art->init= file_main_area_init;
528 art->draw= file_main_area_draw;
529 art->listener= file_main_area_listener;
530 art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
531 BLI_addhead(&st->regiontypes, art);
533 /* regions: header */
534 art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
535 art->regionid = RGN_TYPE_HEADER;
536 art->minsizey= HEADERY;
537 art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
538 art->init= file_header_area_init;
539 art->draw= file_header_area_draw;
540 // art->listener= file_header_area_listener;
541 BLI_addhead(&st->regiontypes, art);
544 art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
545 art->regionid = RGN_TYPE_UI;
547 art->keymapflag= ED_KEYMAP_UI;
548 art->listener= file_ui_area_listener;
549 art->init= file_ui_area_init;
550 art->draw= file_ui_area_draw;
551 BLI_addhead(&st->regiontypes, art);
553 /* regions: channels (directories) */
554 art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
555 art->regionid = RGN_TYPE_CHANNELS;
557 art->keymapflag= ED_KEYMAP_UI;
558 art->listener= file_channel_area_listener;
559 art->init= file_channel_area_init;
560 art->draw= file_channel_area_draw;
561 BLI_addhead(&st->regiontypes, art);
562 file_panels_register(art);
564 BKE_spacetype_register(st);
568 void ED_file_init(void)
571 BLI_make_file_string("/", name, BLI_gethome(), ".Bfs");
572 fsmenu_read_file(fsmenu_get(), name);
573 filelist_init_icons();
574 IMB_thumb_makedirs();
577 void ED_file_exit(void)
579 fsmenu_free(fsmenu_get());
580 filelist_free_icons();