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