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