Fix: Fullscreen File Browser showing override warning on file open
[blender.git] / source / blender / editors / space_text / space_text.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup sptext
22  */
23
24 #include <string.h>
25
26 #include "DNA_text_types.h"
27
28 #include "MEM_guardedalloc.h"
29
30 #include "BLI_blenlib.h"
31
32 #include "BKE_global.h"
33 #include "BKE_context.h"
34 #include "BKE_library.h"
35 #include "BKE_screen.h"
36 #include "BKE_text.h"
37
38 #include "ED_space_api.h"
39 #include "ED_screen.h"
40
41 #include "WM_api.h"
42 #include "WM_types.h"
43
44 #include "UI_interface.h"
45 #include "UI_resources.h"
46 #include "UI_view2d.h"
47
48 #include "RNA_access.h"
49
50 #include "text_format.h"
51 #include "text_intern.h" /* own include */
52 #include "GPU_framebuffer.h"
53
54 /* ******************** default callbacks for text space ***************** */
55
56 static SpaceLink *text_new(const ScrArea *UNUSED(area), const Scene *UNUSED(scene))
57 {
58   ARegion *ar;
59   SpaceText *stext;
60
61   stext = MEM_callocN(sizeof(SpaceText), "inittext");
62   stext->spacetype = SPACE_TEXT;
63
64   stext->lheight = 12;
65   stext->tabnumber = 4;
66   stext->margin_column = 80;
67   stext->showsyntax = true;
68   stext->showlinenrs = true;
69
70   /* header */
71   ar = MEM_callocN(sizeof(ARegion), "header for text");
72
73   BLI_addtail(&stext->regionbase, ar);
74   ar->regiontype = RGN_TYPE_HEADER;
75   ar->alignment = (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_BOTTOM : RGN_ALIGN_TOP;
76
77   /* footer */
78   ar = MEM_callocN(sizeof(ARegion), "footer for text");
79   BLI_addtail(&stext->regionbase, ar);
80   ar->regiontype = RGN_TYPE_FOOTER;
81   ar->alignment = (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_TOP : RGN_ALIGN_BOTTOM;
82
83   /* properties region */
84   ar = MEM_callocN(sizeof(ARegion), "properties region for text");
85
86   BLI_addtail(&stext->regionbase, ar);
87   ar->regiontype = RGN_TYPE_UI;
88   ar->alignment = RGN_ALIGN_RIGHT;
89   ar->flag = RGN_FLAG_HIDDEN;
90
91   /* main region */
92   ar = MEM_callocN(sizeof(ARegion), "main region for text");
93
94   BLI_addtail(&stext->regionbase, ar);
95   ar->regiontype = RGN_TYPE_WINDOW;
96
97   return (SpaceLink *)stext;
98 }
99
100 /* not spacelink itself */
101 static void text_free(SpaceLink *sl)
102 {
103   SpaceText *stext = (SpaceText *)sl;
104
105   stext->text = NULL;
106   text_free_caches(stext);
107 }
108
109 /* spacetype; init callback */
110 static void text_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(sa))
111 {
112 }
113
114 static SpaceLink *text_duplicate(SpaceLink *sl)
115 {
116   SpaceText *stextn = MEM_dupallocN(sl);
117
118   /* clear or remove stuff from old */
119
120   stextn->runtime.drawcache = NULL; /* space need it's own cache */
121
122   return (SpaceLink *)stextn;
123 }
124
125 static void text_listener(wmWindow *UNUSED(win),
126                           ScrArea *sa,
127                           wmNotifier *wmn,
128                           Scene *UNUSED(scene))
129 {
130   SpaceText *st = sa->spacedata.first;
131
132   /* context changes */
133   switch (wmn->category) {
134     case NC_TEXT:
135       /* check if active text was changed, no need to redraw if text isn't active
136        * (reference == NULL) means text was unlinked, should update anyway for this
137        * case -- no way to know was text active before unlinking or not */
138       if (wmn->reference && wmn->reference != st->text) {
139         break;
140       }
141
142       switch (wmn->data) {
143         case ND_DISPLAY:
144           ED_area_tag_redraw(sa);
145           break;
146         case ND_CURSOR:
147           if (st->text && st->text == wmn->reference) {
148             text_scroll_to_cursor__area(st, sa, true);
149           }
150
151           ED_area_tag_redraw(sa);
152           break;
153       }
154
155       switch (wmn->action) {
156         case NA_EDITED:
157           if (st->text) {
158             text_drawcache_tag_update(st, 1);
159             text_update_edited(st->text);
160           }
161
162           ED_area_tag_redraw(sa);
163           ATTR_FALLTHROUGH; /* fall down to tag redraw */
164         case NA_ADDED:
165         case NA_REMOVED:
166           ED_area_tag_redraw(sa);
167           break;
168         case NA_SELECTED:
169           if (st->text && st->text == wmn->reference) {
170             text_scroll_to_cursor__area(st, sa, true);
171           }
172
173           break;
174       }
175
176       break;
177     case NC_SPACE:
178       if (wmn->data == ND_SPACE_TEXT) {
179         ED_area_tag_redraw(sa);
180       }
181       break;
182   }
183 }
184
185 static void text_operatortypes(void)
186 {
187   WM_operatortype_append(TEXT_OT_new);
188   WM_operatortype_append(TEXT_OT_open);
189   WM_operatortype_append(TEXT_OT_reload);
190   WM_operatortype_append(TEXT_OT_unlink);
191   WM_operatortype_append(TEXT_OT_save);
192   WM_operatortype_append(TEXT_OT_save_as);
193   WM_operatortype_append(TEXT_OT_make_internal);
194   WM_operatortype_append(TEXT_OT_run_script);
195   WM_operatortype_append(TEXT_OT_refresh_pyconstraints);
196
197   WM_operatortype_append(TEXT_OT_paste);
198   WM_operatortype_append(TEXT_OT_copy);
199   WM_operatortype_append(TEXT_OT_cut);
200   WM_operatortype_append(TEXT_OT_duplicate_line);
201
202   WM_operatortype_append(TEXT_OT_convert_whitespace);
203   WM_operatortype_append(TEXT_OT_comment_toggle);
204   WM_operatortype_append(TEXT_OT_unindent);
205   WM_operatortype_append(TEXT_OT_indent);
206   WM_operatortype_append(TEXT_OT_indent_or_autocomplete);
207
208   WM_operatortype_append(TEXT_OT_select_line);
209   WM_operatortype_append(TEXT_OT_select_all);
210   WM_operatortype_append(TEXT_OT_select_word);
211
212   WM_operatortype_append(TEXT_OT_move_lines);
213
214   WM_operatortype_append(TEXT_OT_jump);
215   WM_operatortype_append(TEXT_OT_move);
216   WM_operatortype_append(TEXT_OT_move_select);
217   WM_operatortype_append(TEXT_OT_delete);
218   WM_operatortype_append(TEXT_OT_overwrite_toggle);
219
220   WM_operatortype_append(TEXT_OT_selection_set);
221   WM_operatortype_append(TEXT_OT_cursor_set);
222   WM_operatortype_append(TEXT_OT_scroll);
223   WM_operatortype_append(TEXT_OT_scroll_bar);
224   WM_operatortype_append(TEXT_OT_line_number);
225
226   WM_operatortype_append(TEXT_OT_line_break);
227   WM_operatortype_append(TEXT_OT_insert);
228
229   WM_operatortype_append(TEXT_OT_find);
230   WM_operatortype_append(TEXT_OT_find_set_selected);
231   WM_operatortype_append(TEXT_OT_replace);
232   WM_operatortype_append(TEXT_OT_replace_set_selected);
233
234   WM_operatortype_append(TEXT_OT_start_find);
235
236   WM_operatortype_append(TEXT_OT_to_3d_object);
237
238   WM_operatortype_append(TEXT_OT_resolve_conflict);
239
240   WM_operatortype_append(TEXT_OT_autocomplete);
241 }
242
243 static void text_keymap(struct wmKeyConfig *keyconf)
244 {
245   WM_keymap_ensure(keyconf, "Text Generic", SPACE_TEXT, 0);
246   WM_keymap_ensure(keyconf, "Text", SPACE_TEXT, 0);
247 }
248
249 const char *text_context_dir[] = {"edit_text", NULL};
250
251 static int text_context(const bContext *C, const char *member, bContextDataResult *result)
252 {
253   SpaceText *st = CTX_wm_space_text(C);
254
255   if (CTX_data_dir(member)) {
256     CTX_data_dir_set(result, text_context_dir);
257     return 1;
258   }
259   else if (CTX_data_equals(member, "edit_text")) {
260     if (st->text != NULL) {
261       CTX_data_id_pointer_set(result, &st->text->id);
262     }
263     return 1;
264   }
265
266   return 0;
267 }
268
269 /********************* main region ********************/
270
271 /* add handlers, stuff you only do once or on area/region changes */
272 static void text_main_region_init(wmWindowManager *wm, ARegion *ar)
273 {
274   wmKeyMap *keymap;
275   ListBase *lb;
276
277   UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_STANDARD, ar->winx, ar->winy);
278
279   /* own keymap */
280   keymap = WM_keymap_ensure(wm->defaultconf, "Text Generic", SPACE_TEXT, 0);
281   WM_event_add_keymap_handler_v2d_mask(&ar->handlers, keymap);
282   keymap = WM_keymap_ensure(wm->defaultconf, "Text", SPACE_TEXT, 0);
283   WM_event_add_keymap_handler_v2d_mask(&ar->handlers, keymap);
284
285   /* add drop boxes */
286   lb = WM_dropboxmap_find("Text", SPACE_TEXT, RGN_TYPE_WINDOW);
287
288   WM_event_add_dropbox_handler(&ar->handlers, lb);
289 }
290
291 static void text_main_region_draw(const bContext *C, ARegion *ar)
292 {
293   /* draw entirely, view changes should be handled here */
294   SpaceText *st = CTX_wm_space_text(C);
295   // View2D *v2d = &ar->v2d;
296
297   /* clear and setup matrix */
298   UI_ThemeClearColor(TH_BACK);
299   GPU_clear(GPU_COLOR_BIT);
300
301   // UI_view2d_view_ortho(v2d);
302
303   /* data... */
304   draw_text_main(st, ar);
305
306   /* reset view matrix */
307   // UI_view2d_view_restore(C);
308
309   /* scrollers? */
310 }
311
312 static void text_cursor(wmWindow *win, ScrArea *sa, ARegion *ar)
313 {
314   SpaceText *st = sa->spacedata.first;
315   int wmcursor = WM_CURSOR_TEXT_EDIT;
316
317   if (st->text && BLI_rcti_isect_pt(&st->runtime.scroll_region_handle,
318                                     win->eventstate->x - ar->winrct.xmin,
319                                     st->runtime.scroll_region_handle.ymin)) {
320     wmcursor = WM_CURSOR_DEFAULT;
321   }
322
323   WM_cursor_set(win, wmcursor);
324 }
325
326 /* ************* dropboxes ************* */
327
328 static bool text_drop_poll(bContext *UNUSED(C),
329                            wmDrag *drag,
330                            const wmEvent *UNUSED(event),
331                            const char **UNUSED(tooltip))
332 {
333   if (drag->type == WM_DRAG_PATH) {
334     /* rule might not work? */
335     if (ELEM(drag->icon, ICON_FILE_SCRIPT, ICON_FILE_TEXT, ICON_FILE_BLANK)) {
336       return true;
337     }
338   }
339   return false;
340 }
341
342 static void text_drop_copy(wmDrag *drag, wmDropBox *drop)
343 {
344   /* copy drag path to properties */
345   RNA_string_set(drop->ptr, "filepath", drag->path);
346 }
347
348 static bool text_drop_paste_poll(bContext *UNUSED(C),
349                                  wmDrag *drag,
350                                  const wmEvent *UNUSED(event),
351                                  const char **UNUSED(tooltip))
352 {
353   return (drag->type == WM_DRAG_ID);
354 }
355
356 static void text_drop_paste(wmDrag *drag, wmDropBox *drop)
357 {
358   char *text;
359   ID *id = WM_drag_ID(drag, 0);
360
361   /* copy drag path to properties */
362   text = RNA_path_full_ID_py(G_MAIN, id);
363   RNA_string_set(drop->ptr, "text", text);
364   MEM_freeN(text);
365 }
366
367 /* this region dropbox definition */
368 static void text_dropboxes(void)
369 {
370   ListBase *lb = WM_dropboxmap_find("Text", SPACE_TEXT, RGN_TYPE_WINDOW);
371
372   WM_dropbox_add(lb, "TEXT_OT_open", text_drop_poll, text_drop_copy);
373   WM_dropbox_add(lb, "TEXT_OT_insert", text_drop_paste_poll, text_drop_paste);
374 }
375
376 /* ************* end drop *********** */
377
378 /****************** header region ******************/
379
380 /* add handlers, stuff you only do once or on area/region changes */
381 static void text_header_region_init(wmWindowManager *UNUSED(wm), ARegion *ar)
382 {
383   ED_region_header_init(ar);
384 }
385
386 static void text_header_region_draw(const bContext *C, ARegion *ar)
387 {
388   ED_region_header(C, ar);
389 }
390
391 /****************** properties region ******************/
392
393 /* add handlers, stuff you only do once or on area/region changes */
394 static void text_properties_region_init(wmWindowManager *wm, ARegion *ar)
395 {
396   wmKeyMap *keymap;
397
398   ar->v2d.scroll = V2D_SCROLL_RIGHT | V2D_SCROLL_VERTICAL_HIDE;
399   ED_region_panels_init(wm, ar);
400
401   /* own keymaps */
402   keymap = WM_keymap_ensure(wm->defaultconf, "Text Generic", SPACE_TEXT, 0);
403   WM_event_add_keymap_handler_v2d_mask(&ar->handlers, keymap);
404 }
405
406 static void text_properties_region_draw(const bContext *C, ARegion *ar)
407 {
408   SpaceText *st = CTX_wm_space_text(C);
409
410   ED_region_panels(C, ar);
411
412   /* this flag trick is make sure buttons have been added already */
413   if (st->flags & ST_FIND_ACTIVATE) {
414     if (UI_textbutton_activate_rna(C, ar, st, "find_text")) {
415       /* if the panel was already open we need to do another redraw */
416       ScrArea *sa = CTX_wm_area(C);
417       WM_event_add_notifier(C, NC_SPACE | ND_SPACE_TEXT, sa);
418     }
419     st->flags &= ~ST_FIND_ACTIVATE;
420   }
421 }
422
423 static void text_id_remap(ScrArea *UNUSED(sa), SpaceLink *slink, ID *old_id, ID *new_id)
424 {
425   SpaceText *stext = (SpaceText *)slink;
426
427   if (!ELEM(GS(old_id->name), ID_TXT)) {
428     return;
429   }
430
431   if ((ID *)stext->text == old_id) {
432     stext->text = (Text *)new_id;
433     id_us_ensure_real(new_id);
434   }
435 }
436
437 /********************* registration ********************/
438
439 /* only called once, from space/spacetypes.c */
440 void ED_spacetype_text(void)
441 {
442   SpaceType *st = MEM_callocN(sizeof(SpaceType), "spacetype text");
443   ARegionType *art;
444
445   st->spaceid = SPACE_TEXT;
446   strncpy(st->name, "Text", BKE_ST_MAXNAME);
447
448   st->new = text_new;
449   st->free = text_free;
450   st->init = text_init;
451   st->duplicate = text_duplicate;
452   st->operatortypes = text_operatortypes;
453   st->keymap = text_keymap;
454   st->listener = text_listener;
455   st->context = text_context;
456   st->dropboxes = text_dropboxes;
457   st->id_remap = text_id_remap;
458
459   /* regions: main window */
460   art = MEM_callocN(sizeof(ARegionType), "spacetype text region");
461   art->regionid = RGN_TYPE_WINDOW;
462   art->init = text_main_region_init;
463   art->draw = text_main_region_draw;
464   art->cursor = text_cursor;
465   art->event_cursor = true;
466
467   BLI_addhead(&st->regiontypes, art);
468
469   /* regions: properties */
470   art = MEM_callocN(sizeof(ARegionType), "spacetype text region");
471   art->regionid = RGN_TYPE_UI;
472   art->prefsizex = UI_COMPACT_PANEL_WIDTH;
473   art->keymapflag = ED_KEYMAP_UI;
474
475   art->init = text_properties_region_init;
476   art->draw = text_properties_region_draw;
477   BLI_addhead(&st->regiontypes, art);
478
479   /* regions: header */
480   art = MEM_callocN(sizeof(ARegionType), "spacetype text region");
481   art->regionid = RGN_TYPE_HEADER;
482   art->prefsizey = HEADERY;
483   art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D | ED_KEYMAP_HEADER;
484
485   art->init = text_header_region_init;
486   art->draw = text_header_region_draw;
487   BLI_addhead(&st->regiontypes, art);
488
489   /* regions: footer */
490   art = MEM_callocN(sizeof(ARegionType), "spacetype text region");
491   art->regionid = RGN_TYPE_FOOTER;
492   art->prefsizey = HEADERY;
493   art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D | ED_KEYMAP_FOOTER;
494   art->init = text_header_region_init;
495   art->draw = text_header_region_draw;
496   BLI_addhead(&st->regiontypes, art);
497
498   BKE_spacetype_register(st);
499
500   /* register formatters */
501   ED_text_format_register_py();
502   ED_text_format_register_osl();
503   ED_text_format_register_lua();
504   ED_text_format_register_pov();
505   ED_text_format_register_pov_ini();
506 }