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