2.50: svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r18677...
[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 = ED_fileselect_get_params(sfile);
187         FileLayout *layout=NULL;
188
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         layout = ED_fileselect_get_layout(sfile, ar);
201
202         if (filelist_empty(sfile->files))
203         {
204                 unsigned int filter = 0;
205                 filelist_hidedot(sfile->files, params->flag & FILE_HIDE_DOT);
206                 if (params->flag & FILE_FILTER) {
207                         filter = params->filter ;
208                 } else {
209                         filter = 0;
210                 }
211
212                 filelist_setfilter(sfile->files, filter);
213                 filelist_readdir(sfile->files);
214                 
215                 if(params->sort!=FILE_SORTALPHA) filelist_sort(sfile->files, params->sort);             
216         }
217
218         /* clear and setup matrix */
219         UI_GetThemeColor3fv(TH_BACK, col);
220         glClearColor(col[0], col[1], col[2], 0.0);
221         glClear(GL_COLOR_BUFFER_BIT);
222         
223         /* Allow dynamically sliders to be set, saves notifiers etc. */
224         if (layout && (layout->flag == FILE_LAYOUT_VER)) {
225                 v2d->scroll = V2D_SCROLL_RIGHT;
226                 v2d->keepofs &= ~V2D_LOCKOFS_Y;
227                 v2d->keepofs |= V2D_LOCKOFS_X;
228         }
229         else {
230                 v2d->scroll = V2D_SCROLL_BOTTOM;
231                 v2d->keepofs &= ~V2D_LOCKOFS_X;
232                 v2d->keepofs |= V2D_LOCKOFS_Y;
233         }
234         /* v2d has initialized flag, so this call will only set the mask correct */
235         UI_view2d_region_reinit(v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
236
237         /* sets tile/border settings in sfile */
238         file_calc_previews(C, ar);
239
240         /* set view */
241         UI_view2d_view_ortho(C, v2d);
242         
243         /* on first read, find active file */
244         if (params->active_file == -1) {
245                 wmEvent *event= CTX_wm_window(C)->eventstate;
246                 file_hilight_set(sfile, ar, event->x - ar->winrct.xmin, event->y - ar->winrct.ymin);
247         }
248         
249         if (params->display == FILE_IMGDISPLAY) {
250                 file_draw_previews(C, ar);
251         } else {
252                 file_draw_list(C, ar);
253         }
254         
255         
256         /* reset view matrix */
257         UI_view2d_view_restore(C);
258         
259         /* scrollers */
260         scrollers= UI_view2d_scrollers_calc(C, v2d, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
261         UI_view2d_scrollers_draw(C, v2d, scrollers);
262         UI_view2d_scrollers_free(scrollers);
263
264 }
265
266 void file_operatortypes(void)
267 {
268         WM_operatortype_append(FILE_OT_select);
269         WM_operatortype_append(FILE_OT_select_all);
270         WM_operatortype_append(FILE_OT_border_select);
271         WM_operatortype_append(FILE_OT_select_bookmark);
272         WM_operatortype_append(FILE_OT_loadimages);
273         WM_operatortype_append(FILE_OT_highlight);
274         WM_operatortype_append(FILE_OT_exec);
275         WM_operatortype_append(FILE_OT_cancel);
276         WM_operatortype_append(FILE_OT_parent);
277         WM_operatortype_append(FILE_OT_refresh);
278         WM_operatortype_append(FILE_OT_bookmark_toggle);
279 }
280
281 /* NOTE: do not add .blend file reading on this level */
282 void file_keymap(struct wmWindowManager *wm)
283 {
284         ListBase *keymap= WM_keymap_listbase(wm, "File", SPACE_FILE, 0);
285         WM_keymap_add_item(keymap, "FILE_OT_select", LEFTMOUSE, KM_PRESS, 0, 0);
286         WM_keymap_add_item(keymap, "FILE_OT_select_all", AKEY, KM_PRESS, 0, 0);
287         WM_keymap_add_item(keymap, "FILE_OT_border_select", BKEY, KM_PRESS, 0, 0);
288         WM_keymap_add_item(keymap, "FILE_OT_highlight", MOUSEMOVE, KM_ANY, 0, 0);
289         WM_keymap_add_item(keymap, "FILE_OT_parent", PKEY, KM_PRESS, 0, 0);
290         
291         WM_keymap_add_item(keymap, "FILE_OT_loadimages", TIMER1, KM_ANY, KM_ANY, 0);
292
293         keymap= WM_keymap_listbase(wm, "FileBookmark", SPACE_FILE, 0);
294         WM_keymap_add_item(keymap, "FILE_OT_select_bookmark", LEFTMOUSE, KM_PRESS, 0, 0);
295 }
296
297
298 static void file_channel_area_init(wmWindowManager *wm, ARegion *ar)
299 {
300         ListBase *keymap;
301
302         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_LIST, ar->winx, ar->winy);
303
304         /* own keymap */
305         keymap= WM_keymap_listbase(wm, "FileBookmark", SPACE_FILE, 0);
306         WM_event_add_keymap_handler_bb(&ar->handlers, keymap, NULL, NULL);
307 }
308
309 static void file_channel_area_draw(const bContext *C, ARegion *ar)
310 {
311         View2D *v2d= &ar->v2d;
312         float col[3];
313
314         UI_GetThemeColor3fv(TH_PANEL, col);
315         glClearColor(col[0], col[1], col[2], 0.0);
316         glClear(GL_COLOR_BUFFER_BIT);
317
318         /* data... */
319         UI_view2d_view_ortho(C, v2d);
320
321         file_draw_fsmenu(C, ar);
322 }
323
324 /* add handlers, stuff you only do once or on area/region changes */
325 static void file_header_area_init(wmWindowManager *wm, ARegion *ar)
326 {
327         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
328 }
329
330 static void file_header_area_draw(const bContext *C, ARegion *ar)
331 {
332         float col[3];
333         
334         /* clear */
335         if(ED_screen_area_active(C))
336                 UI_GetThemeColor3fv(TH_HEADER, col);
337         else
338                 UI_GetThemeColor3fv(TH_HEADERDESEL, col);
339         
340         glClearColor(col[0], col[1], col[2], 0.0);
341         glClear(GL_COLOR_BUFFER_BIT);
342         
343         /* set view2d view matrix for scrolling (without scrollers) */
344         UI_view2d_view_ortho(C, &ar->v2d);
345         
346         file_header_buttons(C, ar);
347         
348         /* restore view matrix? */
349         UI_view2d_view_restore(C);
350 }
351
352 /* add handlers, stuff you only do once or on area/region changes */
353 static void file_ui_area_init(wmWindowManager *wm, ARegion *ar)
354 {
355         UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_HEADER, ar->winx, ar->winy);
356 }
357
358 static void file_ui_area_draw(const bContext *C, ARegion *ar)
359 {
360         float col[3];
361         /* clear */
362         UI_GetThemeColor3fv(TH_PANEL, col);
363         glClearColor(col[0], col[1], col[2], 0.0);
364         glClear(GL_COLOR_BUFFER_BIT);
365
366         /* set view2d view matrix for scrolling (without scrollers) */
367         UI_view2d_view_ortho(C, &ar->v2d);
368
369         file_draw_buttons(C, ar);
370
371         UI_view2d_view_restore(C);
372 }
373
374 //static void file_main_area_listener(ARegion *ar, wmNotifier *wmn)
375 //{
376         /* context changes */
377 //}
378
379 /* only called once, from space/spacetypes.c */
380 void ED_spacetype_file(void)
381 {
382         SpaceType *st= MEM_callocN(sizeof(SpaceType), "spacetype file");
383         ARegionType *art;
384         
385         st->spaceid= SPACE_FILE;
386         
387         st->new= file_new;
388         st->free= file_free;
389         st->init= file_init;
390         st->duplicate= file_duplicate;
391         st->operatortypes= file_operatortypes;
392         st->keymap= file_keymap;
393         
394         /* regions: main window */
395         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
396         art->regionid = RGN_TYPE_WINDOW;
397         art->init= file_main_area_init;
398         art->draw= file_main_area_draw;
399         // art->listener= file_main_area_listener;
400         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
401         BLI_addhead(&st->regiontypes, art);
402         
403         /* regions: header */
404         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
405         art->regionid = RGN_TYPE_HEADER;
406         art->minsizey= HEADERY;
407         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
408         art->init= file_header_area_init;
409         art->draw= file_header_area_draw;
410         BLI_addhead(&st->regiontypes, art);
411         
412         /* regions: ui */
413         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
414         art->regionid = RGN_TYPE_UI;
415         art->minsizey= 60;
416         art->keymapflag= ED_KEYMAP_UI;
417         art->init= file_ui_area_init;
418         art->draw= file_ui_area_draw;
419         BLI_addhead(&st->regiontypes, art);
420
421         /* regions: channels (directories) */
422         art= MEM_callocN(sizeof(ARegionType), "spacetype file region");
423         art->regionid = RGN_TYPE_CHANNELS;
424         art->minsizex= 240;
425         art->keymapflag= ED_KEYMAP_UI|ED_KEYMAP_VIEW2D;
426         art->init= file_channel_area_init;
427         art->draw= file_channel_area_draw;
428         BLI_addhead(&st->regiontypes, art);
429         
430         BKE_spacetype_register(st);
431
432 }
433
434 void ED_file_init(void)
435 {
436         char name[FILE_MAX];
437         BLI_make_file_string("/", name, BLI_gethome(), ".Bfs");
438         fsmenu_read_file(fsmenu_get(), name);
439         filelist_init_icons();
440         IMB_thumb_makedirs();
441 }
442
443 void ED_file_exit(void)
444 {
445         fsmenu_free(fsmenu_get());
446         filelist_free_icons();
447 }