2.5 filebrowser
[blender-staging.git] / source / blender / editors / space_file / space_file.c
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
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. 
10  *
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.
15  *
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.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "DNA_object_types.h"
33 #include "DNA_space_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_screen_types.h"
36
37 #include "MEM_guardedalloc.h"
38
39 #include "BIF_gl.h"
40
41 #include "BLO_readfile.h"
42
43 #include "BLI_blenlib.h"
44 #include "BLI_arithb.h"
45 #include "BLI_rand.h"
46
47 #include "BKE_colortools.h"
48 #include "BKE_context.h"
49 #include "BKE_screen.h"
50
51 #include "ED_space_api.h"
52 #include "ED_screen.h"
53 #include "ED_fileselect.h"
54
55 #include "IMB_imbuf_types.h"
56 #include "IMB_thumbs.h"
57
58 #include "WM_api.h"
59 #include "WM_types.h"
60
61 #include "UI_interface.h"
62 #include "UI_resources.h"
63 #include "UI_view2d.h"
64
65
66 #include "ED_markers.h"
67 #include "ED_fileselect.h"
68
69 #include "file_intern.h"        // own include
70 #include "fsmenu.h"
71 #include "filelist.h"
72
73 /* ******************** default callbacks for file space ***************** */
74
75 static SpaceLink *file_new(const bContext *C)
76 {
77         ARegion *ar;
78         SpaceFile *sfile;
79         
80         sfile= MEM_callocN(sizeof(SpaceFile), "initfile");
81         sfile->spacetype= SPACE_FILE;
82
83         /* header */
84         ar= MEM_callocN(sizeof(ARegion), "header for file");
85         BLI_addtail(&sfile->regionbase, ar);
86         ar->regiontype= RGN_TYPE_HEADER;
87         ar->alignment= RGN_ALIGN_TOP;
88
89         /* channel list region */
90         ar= MEM_callocN(sizeof(ARegion), "channel area for file");
91         BLI_addtail(&sfile->regionbase, ar);
92         ar->regiontype= RGN_TYPE_CHANNELS;
93         ar->alignment= RGN_ALIGN_LEFT;  
94
95         /* ui list region */
96         ar= MEM_callocN(sizeof(ARegion), "ui area for file");
97         BLI_addtail(&sfile->regionbase, ar);
98         ar->regiontype= RGN_TYPE_UI;
99         ar->alignment= RGN_ALIGN_TOP;
100
101         /* main area */
102         ar= MEM_callocN(sizeof(ARegion), "main area for file");
103         BLI_addtail(&sfile->regionbase, ar);
104         ar->regiontype= RGN_TYPE_WINDOW;
105         ar->v2d.scroll = (V2D_SCROLL_RIGHT | V2D_SCROLL_BOTTOM);
106         ar->v2d.align = (V2D_ALIGN_NO_NEG_X|V2D_ALIGN_NO_POS_Y);
107         ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_KEEPZOOM|V2D_KEEPASPECT);
108         ar->v2d.keeptot= V2D_KEEPTOT_STRICT;
109         ar->v2d.minzoom= ar->v2d.maxzoom= 1.0f;
110
111         return (SpaceLink *)sfile;
112 }
113
114 /* not spacelink itself */
115 static void file_free(SpaceLink *sl)
116 {       
117         SpaceFile *sfile= (SpaceFile *) sl;
118         
119         if(sfile->files) {
120                 filelist_free(sfile->files);
121                 MEM_freeN(sfile->files);
122                 sfile->files= NULL;
123         }
124
125         if (sfile->params) {
126                 if(sfile->params->pupmenu)
127                         MEM_freeN(sfile->params->pupmenu);
128                 MEM_freeN(sfile->params);
129                 sfile->params= NULL;
130         }
131
132         if (sfile->layout) {
133                 MEM_freeN(sfile->layout);
134                 sfile->layout = NULL;
135         }
136 }
137
138
139 /* spacetype; init callback, area size changes, screen set, etc */
140 static void file_init(struct wmWindowManager *wm, ScrArea *sa)
141 {
142 }
143
144
145 static SpaceLink *file_duplicate(SpaceLink *sl)
146 {
147         SpaceFile *sfileo= (SpaceFile*)sl;
148         SpaceFile *sfilen= MEM_dupallocN(sl);
149         
150         /* clear or remove stuff from old */
151         sfilen->op = NULL; /* file window doesn't own operators */
152
153         sfilen->files = filelist_new();
154         
155         if(sfileo->params) {
156                 sfilen->params= MEM_dupallocN(sfileo->params);
157         
158                 filelist_setdir(sfilen->files, sfilen->params->dir);
159                 filelist_settype(sfilen->files, sfilen->params->type);
160         }
161         if (sfileo->layout) {
162                 sfilen->layout= MEM_dupallocN(sfileo->layout);
163         }
164         return (SpaceLink *)sfilen;
165 }
166
167
168 /* add handlers, stuff you only do once or on area/region changes */
169 static void file_main_area_init(wmWindowManager *wm, ARegion *ar)
170 {
171         ListBase *keymap;
172         
173         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
174         
175         /* own keymap */
176         keymap= WM_keymap_listbase(wm, "File", SPACE_FILE, 0);  /* XXX weak? */
177         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
178                                                            
179
180 }
181
182 static void file_main_area_draw(const bContext *C, ARegion *ar)
183 {
184         /* draw entirely, view changes should be handled here */
185         SpaceFile *sfile= (SpaceFile*)CTX_wm_space_data(C);
186         FileSelectParams* params = sfile->params;
187         View2D *v2d= &ar->v2d;
188         View2DScrollers *scrollers;
189         float col[3];
190         
191         if (!sfile->files) {
192                 sfile->files = filelist_new();
193                 filelist_setdir(sfile->files, params->dir);
194                 filelist_settype(sfile->files, params->type);
195                 params->active_file = -1; // added this so it opens nicer (ton)
196         }
197
198         if (filelist_empty(sfile->files))
199         {
200                 unsigned int filter = 0;
201                 filelist_hidedot(sfile->files, params->flag & FILE_HIDE_DOT);
202                 if (params->flag & FILE_FILTER) {
203                         filter = params->filter ;
204                 } else {
205                         filter = 0;
206                 }
207
208                 filelist_setfilter(sfile->files, filter);
209                 filelist_readdir(sfile->files);
210                 
211                 if(params->sort!=FILE_SORTALPHA) filelist_sort(sfile->files, params->sort);             
212         }
213
214         /* clear and setup matrix */
215         UI_GetThemeColor3fv(TH_BACK, col);
216         glClearColor(col[0], col[1], col[2], 0.0);
217         glClear(GL_COLOR_BUFFER_BIT);
218         
219         /* Allow dynamically sliders to be set, saves notifiers etc. */
220         if (sfile->params && ( (sfile->params->display == FILE_IMGDISPLAY) || (sfile->params->display == FILE_LONGDISPLAY)) ) {
221                 v2d->scroll = V2D_SCROLL_RIGHT;
222                 v2d->keepofs &= ~V2D_LOCKOFS_Y;
223                 v2d->keepofs |= V2D_LOCKOFS_X;
224         }
225         else {
226                 v2d->scroll = V2D_SCROLL_BOTTOM;
227                 v2d->keepofs &= ~V2D_LOCKOFS_X;
228                 v2d->keepofs |= V2D_LOCKOFS_Y;
229         }
230         /* v2d has initialized flag, so this call will only set the mask correct */
231         UI_view2d_region_reinit(v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
232
233         /* sets tile/border settings in sfile */
234         file_calc_previews(C, ar);
235
236         /* set view */
237         UI_view2d_view_ortho(C, v2d);
238         
239         /* on first read, find active file */
240         if (params->active_file == -1) {
241                 wmEvent *event= CTX_wm_window(C)->eventstate;
242                 file_hilight_set(sfile, ar, event->x - ar->winrct.xmin, event->y - ar->winrct.ymin);
243         }
244         
245         if (params->display == FILE_IMGDISPLAY) {
246                 file_draw_previews(C, ar);
247         } else {
248                 file_draw_list(C, ar);
249         }
250         
251         
252         /* reset view matrix */
253         UI_view2d_view_restore(C);
254         
255         /* scrollers */
256         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
257         UI_view2d_scrollers_draw(C, v2d, scrollers);
258         UI_view2d_scrollers_free(scrollers);
259
260 }
261
262 void file_operatortypes(void)
263 {
264         WM_operatortype_append(FILE_OT_select);
265         WM_operatortype_append(FILE_OT_select_all);
266         WM_operatortype_append(FILE_OT_border_select);
267         WM_operatortype_append(FILE_OT_select_bookmark);
268         WM_operatortype_append(FILE_OT_loadimages);
269         WM_operatortype_append(FILE_OT_highlight);
270         WM_operatortype_append(FILE_OT_exec);
271         WM_operatortype_append(FILE_OT_cancel);
272         WM_operatortype_append(FILE_OT_parent);
273         WM_operatortype_append(FILE_OT_refresh);
274         WM_operatortype_append(FILE_OT_bookmark_toggle);
275 }
276
277 /* NOTE: do not add .blend file reading on this level */
278 void file_keymap(struct wmWindowManager *wm)
279 {
280         ListBase *keymap= WM_keymap_listbase(wm, "File", SPACE_FILE, 0);
281         WM_keymap_add_item(keymap, "FILE_OT_select", LEFTMOUSE, KM_PRESS, 0, 0);
282         WM_keymap_add_item(keymap, "FILE_OT_select_all", AKEY, KM_PRESS, 0, 0);
283         WM_keymap_add_item(keymap, "FILE_OT_border_select", BKEY, KM_PRESS, 0, 0);
284         WM_keymap_add_item(keymap, "FILE_OT_highlight", MOUSEMOVE, KM_ANY, 0, 0);
285         WM_keymap_add_item(keymap, "FILE_OT_parent", PKEY, KM_PRESS, 0, 0);
286         
287         WM_keymap_add_item(keymap, "FILE_OT_loadimages", TIMER1, KM_ANY, KM_ANY, 0);
288
289         keymap= WM_keymap_listbase(wm, "FileBookmark", SPACE_FILE, 0);
290         WM_keymap_add_item(keymap, "FILE_OT_select_bookmark", LEFTMOUSE, KM_PRESS, 0, 0);
291 }
292
293
294 static void file_channel_area_init(wmWindowManager *wm, ARegion *ar)
295 {
296         ListBase *keymap;
297
298         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
299
300         /* own keymap */
301         keymap= WM_keymap_listbase(wm, "FileBookmark", SPACE_FILE, 0);
302         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, NULL, NULL);
303 }
304
305 static void file_channel_area_draw(const bContext *C, ARegion *ar)
306 {
307         View2D *v2d= &ar->v2d;
308         float col[3];
309
310         UI_GetThemeColor3fv(TH_PANEL, col);
311         glClearColor(col[0], col[1], col[2], 0.0);
312         glClear(GL_COLOR_BUFFER_BIT);
313
314         /* data... */
315         UI_view2d_view_ortho(C, v2d);
316
317         file_draw_fsmenu(C, ar);
318 }
319
320 /* add handlers, stuff you only do once or on area/region changes */
321 static void file_header_area_init(wmWindowManager *wm, ARegion *ar)
322 {
323         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
324 }
325
326 static void file_header_area_draw(const bContext *C, ARegion *ar)
327 {
328         float col[3];
329         
330         /* clear */
331         if(ED_screen_area_active(C))
332                 UI_GetThemeColor3fv(TH_HEADER, col);
333         else
334                 UI_GetThemeColor3fv(TH_HEADERDESEL, col);
335         
336         glClearColor(col[0], col[1], col[2], 0.0);
337         glClear(GL_COLOR_BUFFER_BIT);
338         
339         /* set view2d view matrix for scrolling (without scrollers) */
340         UI_view2d_view_ortho(C, &ar->v2d);
341         
342         file_header_buttons(C, ar);
343         
344         /* restore view matrix? */
345         UI_view2d_view_restore(C);
346 }
347
348 /* add handlers, stuff you only do once or on area/region changes */
349 static void file_ui_area_init(wmWindowManager *wm, ARegion *ar)
350 {
351         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
352 }
353
354 static void file_ui_area_draw(const bContext *C, ARegion *ar)
355 {
356         float col[3];
357         /* clear */
358         UI_GetThemeColor3fv(TH_PANEL, col);
359         glClearColor(col[0], col[1], col[2], 0.0);
360         glClear(GL_COLOR_BUFFER_BIT);
361
362         /* set view2d view matrix for scrolling (without scrollers) */
363         UI_view2d_view_ortho(C, &ar->v2d);
364
365         file_draw_buttons(C, ar);
366
367         UI_view2d_view_restore(C);
368 }
369
370 //static void file_main_area_listener(ARegion *ar, wmNotifier *wmn)
371 //{
372         /* context changes */
373 //}
374
375 /* only called once, from space/spacetypes.c */
376 void ED_spacetype_file(void)
377 {
378         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype file");
379         ARegionType *art;
380         
381         st->spaceid= SPACE_FILE;
382         
383         st->new= file_new;
384         st->free= file_free;
385         st->init= file_init;
386         st->duplicate= file_duplicate;
387         st->operatortypes= file_operatortypes;
388         st->keymap= file_keymap;
389         
390         /* regions: main window */
391         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
392         art->regionid = RGN_TYPE_WINDOW;
393         art->init= file_main_area_init;
394         art->draw= file_main_area_draw;
395         // art->listener= file_main_area_listener;
396         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
397         BLI_addhead(&st->regiontypes, art);
398         
399         /* regions: header */
400         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
401         art->regionid = RGN_TYPE_HEADER;
402         art->minsizey= HEADERY;
403         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
404         art->init= file_header_area_init;
405         art->draw= file_header_area_draw;
406         BLI_addhead(&st->regiontypes, art);
407         
408         /* regions: ui */
409         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
410         art->regionid = RGN_TYPE_UI;
411         art->minsizey= 60;
412         art->keymapflag= ED_KEYMAP_UI;
413         art->init= file_ui_area_init;
414         art->draw= file_ui_area_draw;
415         BLI_addhead(&st->regiontypes, art);
416
417         /* regions: channels (directories) */
418         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
419         art->regionid = RGN_TYPE_CHANNELS;
420         art->minsizex= 240;
421         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
422         art->init= file_channel_area_init;
423         art->draw= file_channel_area_draw;
424         BLI_addhead(&st->regiontypes, art);
425         
426         BKE_spacetype_register(st);
427
428 }
429
430 void ED_file_init(void)
431 {
432         char name[FILE_MAX];
433         BLI_make_file_string("/", name, BLI_gethome(), ".Bfs");
434         fsmenu_read_file(fsmenu_get(), name);
435         filelist_init_icons();
436         IMB_thumb_makedirs();
437 }
438
439 void ED_file_exit(void)
440 {
441         fsmenu_free(fsmenu_get());
442         filelist_free_icons();
443 }