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