svn merge -r 22628:22753 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[blender-staging.git] / source / blender / editors / space_console / console_ops.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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #include <stdlib.h>
31 #include <string.h>
32 #include <ctype.h> /* ispunct */
33 #include <sys/stat.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "DNA_scene_types.h"
38 #include "DNA_screen_types.h"
39 #include "DNA_space_types.h"
40 #include "DNA_userdef_types.h"
41 #include "DNA_windowmanager_types.h"
42
43 #include "BLI_blenlib.h"
44 #include "BLI_dynstr.h"
45 #include "PIL_time.h"
46
47 #include "BKE_utildefines.h"
48 #include "BKE_context.h"
49 #include "BKE_depsgraph.h"
50 #include "BKE_global.h"
51 #include "BKE_library.h"
52 #include "BKE_main.h"
53 #include "BKE_report.h"
54
55 #include "WM_api.h"
56 #include "WM_types.h"
57
58 #include "ED_screen.h"
59 #include "ED_types.h"
60 #include "UI_interface.h"
61 #include "UI_resources.h"
62
63 #include "RNA_access.h"
64 #include "RNA_define.h"
65
66 #include "console_intern.h"
67
68 void console_history_free(SpaceConsole *sc, ConsoleLine *cl)
69 {
70         BLI_remlink(&sc->history, cl);
71         MEM_freeN(cl->line);
72         MEM_freeN(cl);
73 }
74 void console_scrollback_free(SpaceConsole *sc, ConsoleLine *cl)
75 {
76         BLI_remlink(&sc->scrollback, cl);
77         MEM_freeN(cl->line);
78         MEM_freeN(cl);
79 }
80
81 void console_scrollback_limit(SpaceConsole *sc)
82 {
83         int tot;
84         
85         if (U.scrollback < 32) U.scrollback= 128; // XXX - save in user defaults
86         
87         for(tot= BLI_countlist(&sc->scrollback); tot > U.scrollback; tot--)
88                 console_scrollback_free(sc, sc->scrollback.first);
89 }
90
91 static ConsoleLine * console_history_find(SpaceConsole *sc, const char *str, ConsoleLine *cl_ignore)
92 {
93         ConsoleLine *cl;
94
95         for(cl= sc->history.last; cl; cl= cl->prev) {
96                 if (cl==cl_ignore)
97                         continue;
98
99                 if(strcmp(str, cl->line)==0)
100                         return cl;
101         }
102
103         return NULL;
104 }
105
106 /* return 0 if no change made, clamps the range */
107 static int console_line_cursor_set(ConsoleLine *cl, int cursor)
108 {
109         int cursor_new;
110         
111         if(cursor < 0)                          cursor_new= 0;
112         else if(cursor > cl->len)       cursor_new= cl->len;
113         else                                            cursor_new= cursor;
114         
115         if(cursor_new == cl->cursor)
116                 return 0;
117         
118         cl->cursor= cursor_new;
119         return 1;
120 }
121
122 static ConsoleLine *console_lb_add__internal(ListBase *lb, ConsoleLine *from)
123 {
124         ConsoleLine *ci= MEM_callocN(sizeof(ConsoleLine), "ConsoleLine Add");
125         
126         if(from) {
127                 ci->line= BLI_strdup(from->line);
128                 ci->len= strlen(ci->line);
129                 ci->len_alloc= ci->len;
130                 
131                 ci->cursor= from->cursor;
132                 ci->type= from->type;
133         } else {
134                 ci->line= MEM_callocN(64, "console-in-line");
135                 ci->len_alloc= 64;
136                 ci->len= 0;
137         }
138         
139         BLI_addtail(lb, ci);
140         return ci;
141 }
142
143 static ConsoleLine *console_history_add(const bContext *C, ConsoleLine *from)
144 {
145         SpaceConsole *sc= CTX_wm_space_console(C);
146         
147         return console_lb_add__internal(&sc->history, from);
148 }
149
150 #if 0 /* may use later ? */
151 static ConsoleLine *console_scrollback_add(const bContext *C, ConsoleLine *from)
152 {
153         SpaceConsole *sc= CTX_wm_space_console(C);
154         
155         return console_lb_add__internal(&sc->scrollback, from);
156 }
157 #endif
158
159 static ConsoleLine *console_lb_add_str__internal(ListBase *lb, const bContext *C, char *str, int own)
160 {
161         ConsoleLine *ci= MEM_callocN(sizeof(ConsoleLine), "ConsoleLine Add");
162         if(own)         ci->line= str;
163         else            ci->line= BLI_strdup(str);
164         
165         ci->len = ci->len_alloc = strlen(str);
166         
167         BLI_addtail(lb, ci);
168         return ci;
169 }
170 ConsoleLine *console_history_add_str(const bContext *C, char *str, int own)
171 {
172         return console_lb_add_str__internal(&CTX_wm_space_console(C)->history, C, str, own);
173 }
174 ConsoleLine *console_scrollback_add_str(const bContext *C, char *str, int own)
175 {
176         return console_lb_add_str__internal(&CTX_wm_space_console(C)->scrollback, C, str, own);
177 }
178
179 ConsoleLine *console_history_verify(const bContext *C)
180 {
181         SpaceConsole *sc= CTX_wm_space_console(C);
182         ConsoleLine *ci= sc->history.last;
183         if(ci==NULL)
184                 ci= console_history_add(C, NULL);
185         
186         return ci;
187 }
188
189
190 static void console_line_verify_length(ConsoleLine *ci, int len)
191 {
192         /* resize the buffer if needed */
193         if(len > ci->len_alloc) {
194                 int new_len= len * 2; /* new length */
195                 char *new_line= MEM_callocN(new_len, "console line");
196                 memcpy(new_line, ci->line, ci->len);
197                 MEM_freeN(ci->line);
198                 
199                 ci->line= new_line;
200                 ci->len_alloc= new_len;
201         }
202 }
203
204 static int console_line_insert(ConsoleLine *ci, char *str)
205 {
206         int len = strlen(str);
207         
208         if(len>0 && str[len-1]=='\n') {/* stop new lines being pasted at the end of lines */
209                 str[len-1]= '\0';
210                 len--;
211         }
212
213         if(len==0)
214                 return 0;
215         
216         console_line_verify_length(ci, len + ci->len);
217         
218         memmove(ci->line+ci->cursor+len, ci->line+ci->cursor, (ci->len - ci->cursor)+1);
219         memcpy(ci->line+ci->cursor, str, len);
220         
221         ci->len += len;
222         ci->cursor += len;
223         
224         return len;
225 }
226
227 static int console_edit_poll(bContext *C)
228 {
229         SpaceConsole *sc= CTX_wm_space_console(C);
230
231         if(!sc || sc->type != CONSOLE_TYPE_PYTHON)
232                 return 0;
233
234         return 1;
235 }
236
237
238 /* static funcs for text editing */
239
240 /* similar to the text editor, with some not used. keep compatible */
241 static EnumPropertyItem move_type_items[]= {
242         {LINE_BEGIN, "LINE_BEGIN", 0, "Line Begin", ""},
243         {LINE_END, "LINE_END", 0, "Line End", ""},
244         {PREV_CHAR, "PREVIOUS_CHARACTER", 0, "Previous Character", ""},
245         {NEXT_CHAR, "NEXT_CHARACTER", 0, "Next Character", ""},
246         {PREV_WORD, "PREVIOUS_WORD", 0, "Previous Word", ""},
247         {NEXT_WORD, "NEXT_WORD", 0, "Next Word", ""},
248         {0, NULL, 0, NULL, NULL}};
249         
250 static int move_exec(bContext *C, wmOperator *op)
251 {
252         ConsoleLine *ci= console_history_verify(C);
253         
254         int type= RNA_enum_get(op->ptr, "type");
255         int done= 0;
256         
257         switch(type) {
258         case LINE_BEGIN:
259                 done= console_line_cursor_set(ci, 0);
260                 break;
261         case LINE_END:
262                 done= console_line_cursor_set(ci, INT_MAX);
263                 break;
264         case PREV_CHAR:
265                 done= console_line_cursor_set(ci, ci->cursor-1);
266                 break;
267         case NEXT_CHAR:
268                 done= console_line_cursor_set(ci, ci->cursor+1);
269                 break;
270         }
271         
272         if(done) {
273                 ED_area_tag_redraw(CTX_wm_area(C));
274         }
275         
276         return OPERATOR_FINISHED;
277 }
278
279 void CONSOLE_OT_move(wmOperatorType *ot)
280 {
281         /* identifiers */
282         ot->name= "Move Cursor";
283     ot->description= "Move cursor position.";
284         ot->idname= "CONSOLE_OT_move";
285         
286         /* api callbacks */
287         ot->exec= move_exec;
288         ot->poll= console_edit_poll;
289
290         /* flags */
291         ot->flag= OPTYPE_REGISTER;
292
293         /* properties */
294         RNA_def_enum(ot->srna, "type", move_type_items, LINE_BEGIN, "Type", "Where to move cursor to.");
295 }
296
297
298 static int insert_exec(bContext *C, wmOperator *op)
299 {
300         ConsoleLine *ci= console_history_verify(C);
301         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0);
302         
303         int len= console_line_insert(ci, str);
304         
305         MEM_freeN(str);
306         
307         if(len==0)
308                 return OPERATOR_CANCELLED;
309                 
310         ED_area_tag_redraw(CTX_wm_area(C));
311         
312         return OPERATOR_FINISHED;
313 }
314
315 static int insert_invoke(bContext *C, wmOperator *op, wmEvent *event)
316 {
317         if(!RNA_property_is_set(op->ptr, "text")) {
318                 char str[2] = {event->ascii, '\0'};
319                 RNA_string_set(op->ptr, "text", str);
320         }
321         return insert_exec(C, op);
322 }
323
324 void CONSOLE_OT_insert(wmOperatorType *ot)
325 {
326         /* identifiers */
327         ot->name= "Insert";
328     ot->description= "Insert text at cursor position.";
329         ot->idname= "CONSOLE_OT_insert";
330         
331         /* api callbacks */
332         ot->exec= insert_exec;
333         ot->invoke= insert_invoke;
334         ot->poll= console_edit_poll;
335
336         /* flags */
337         ot->flag= OPTYPE_REGISTER;
338
339         /* properties */
340         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");
341 }
342
343
344 static EnumPropertyItem delete_type_items[]= {
345         {DEL_NEXT_CHAR, "NEXT_CHARACTER", 0, "Next Character", ""},
346         {DEL_PREV_CHAR, "PREVIOUS_CHARACTER", 0, "Previous Character", ""},
347 //      {DEL_NEXT_WORD, "NEXT_WORD", 0, "Next Word", ""},
348 //      {DEL_PREV_WORD, "PREVIOUS_WORD", 0, "Previous Word", ""},
349         {0, NULL, 0, NULL, NULL}};
350
351 static int delete_exec(bContext *C, wmOperator *op)
352 {
353         
354         ConsoleLine *ci= console_history_verify(C);
355         
356         
357         int done = 0;
358
359         int type= RNA_enum_get(op->ptr, "type");
360         
361         if(ci->len==0) {
362                 return OPERATOR_CANCELLED;
363         }
364         
365         switch(type) {
366         case DEL_NEXT_CHAR:
367                 if(ci->cursor < ci->len) {
368                         memmove(ci->line + ci->cursor, ci->line + ci->cursor+1, (ci->len - ci->cursor)+1);
369                         ci->len--;
370                         done= 1;
371                 }
372                 break;
373         case DEL_PREV_CHAR:
374                 if(ci->cursor > 0) {
375                         ci->cursor--; /* same as above */
376                         memmove(ci->line + ci->cursor, ci->line + ci->cursor+1, (ci->len - ci->cursor)+1);
377                         ci->len--;
378                         done= 1;
379                 }
380                 break;
381         }
382         
383         if(!done)
384                 return OPERATOR_CANCELLED;
385         
386         ED_area_tag_redraw(CTX_wm_area(C));
387         
388         return OPERATOR_FINISHED;
389 }
390
391
392 void CONSOLE_OT_delete(wmOperatorType *ot)
393 {
394         /* identifiers */
395         ot->name= "Delete";
396     ot->description= "Delete text by cursor position.";
397         ot->idname= "CONSOLE_OT_delete";
398         
399         /* api callbacks */
400         ot->exec= delete_exec;
401         ot->poll= console_edit_poll;
402
403         /* flags */
404         ot->flag= OPTYPE_REGISTER;
405
406         /* properties */
407         RNA_def_enum(ot->srna, "type", delete_type_items, DEL_NEXT_CHAR, "Type", "Which part of the text to delete.");
408 }
409
410
411 /* the python exec operator uses this */
412 static int clear_exec(bContext *C, wmOperator *op)
413 {
414         SpaceConsole *sc= CTX_wm_space_console(C);
415         
416         short scrollback= RNA_boolean_get(op->ptr, "scrollback");
417         short history= RNA_boolean_get(op->ptr, "history");
418         
419         /*ConsoleLine *ci= */ console_history_verify(C);
420         
421         if(scrollback) { /* last item in mistory */
422                 while(sc->scrollback.first)
423                         console_scrollback_free(sc, sc->scrollback.first);
424         }
425         
426         if(history) {
427                 while(sc->history.first)
428                         console_history_free(sc, sc->history.first);
429         }
430         
431         ED_area_tag_redraw(CTX_wm_area(C));
432         
433         return OPERATOR_FINISHED;
434 }
435
436 void CONSOLE_OT_clear(wmOperatorType *ot)
437 {
438         /* identifiers */
439         ot->name= "Clear";
440     ot->description= "Clear text by type.";
441         ot->idname= "CONSOLE_OT_clear";
442         
443         /* api callbacks */
444         ot->exec= clear_exec;
445         ot->poll= console_edit_poll;
446
447         /* flags */
448         ot->flag= OPTYPE_REGISTER;
449         
450         /* properties */
451         RNA_def_boolean(ot->srna, "scrollback", 1, "Scrollback", "Clear the scrollback history");
452         RNA_def_boolean(ot->srna, "history", 0, "History", "Clear the command history");
453 }
454
455
456
457 /* the python exec operator uses this */
458 static int history_cycle_exec(bContext *C, wmOperator *op)
459 {
460         SpaceConsole *sc= CTX_wm_space_console(C);
461         ConsoleLine *ci= console_history_verify(C); /* TODO - stupid, just prevernts crashes when no command line */
462         
463         short reverse= RNA_boolean_get(op->ptr, "reverse"); /* assumes down, reverse is up */
464         
465         if(reverse) { /* last item in mistory */
466                 ci= sc->history.last;
467                 BLI_remlink(&sc->history, ci);
468                 BLI_addhead(&sc->history, ci);
469         }
470         else {
471                 ci= sc->history.first;
472                 BLI_remlink(&sc->history, ci);
473                 BLI_addtail(&sc->history, ci);
474         }
475         
476         ED_area_tag_redraw(CTX_wm_area(C));
477         
478         return OPERATOR_FINISHED;
479 }
480
481 void CONSOLE_OT_history_cycle(wmOperatorType *ot)
482 {
483         /* identifiers */
484         ot->name= "History Cycle";
485     ot->description= "Cycle through history.";
486         ot->idname= "CONSOLE_OT_history_cycle";
487         
488         /* api callbacks */
489         ot->exec= history_cycle_exec;
490         ot->poll= console_edit_poll;
491
492         /* flags */
493         ot->flag= OPTYPE_REGISTER;
494         
495         /* properties */
496         RNA_def_boolean(ot->srna, "reverse", 0, "Reverse", "reverse cycle history");
497 }
498
499
500 /* the python exec operator uses this */
501 static int history_append_exec(bContext *C, wmOperator *op)
502 {
503         ConsoleLine *ci= console_history_verify(C);
504         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
505         int cursor= RNA_int_get(op->ptr, "current_character");
506         short rem_dupes= RNA_boolean_get(op->ptr, "remove_duplicates");
507
508         if(rem_dupes) {
509                 SpaceConsole *sc= CTX_wm_space_console(C);
510                 ConsoleLine *cl;
511
512                 while((cl= console_history_find(sc, ci->line, ci)))
513                         console_history_free(sc, cl);
514
515                 if(strcmp(str, ci->line)==0) {
516                         MEM_freeN(str);
517                         return OPERATOR_FINISHED;
518                 }
519         }
520
521         ci= console_history_add_str(C, str, 1); /* own the string */
522         console_line_cursor_set(ci, cursor);
523         
524         ED_area_tag_redraw(CTX_wm_area(C));
525         
526         return OPERATOR_FINISHED;
527 }
528
529 void CONSOLE_OT_history_append(wmOperatorType *ot)
530 {
531         /* identifiers */
532         ot->name= "History Append";
533     ot->description= "Append history at cursor position.";
534         ot->idname= "CONSOLE_OT_history_append";
535         
536         /* api callbacks */
537         ot->exec= history_append_exec;
538         ot->poll= console_edit_poll;
539
540         /* flags */
541         ot->flag= OPTYPE_REGISTER;
542         
543         /* properties */
544         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
545         RNA_def_int(ot->srna, "current_character", 0, 0, INT_MAX, "Cursor", "The index of the cursor.", 0, 10000);
546         RNA_def_boolean(ot->srna, "remove_duplicates", 0, "Remove Duplicates", "Remove duplicate items in the history");
547 }
548
549
550 /* the python exec operator uses this */
551 static int scrollback_append_exec(bContext *C, wmOperator *op)
552 {
553         SpaceConsole *sc= CTX_wm_space_console(C);
554         ConsoleLine *ci= console_history_verify(C);
555         
556         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
557         int type= RNA_enum_get(op->ptr, "type");
558         
559         ci= console_scrollback_add_str(C, str, 1); /* own the string */
560         ci->type= type;
561         
562         console_scrollback_limit(sc);
563         
564         ED_area_tag_redraw(CTX_wm_area(C));
565         
566         return OPERATOR_FINISHED;
567 }
568
569 void CONSOLE_OT_scrollback_append(wmOperatorType *ot)
570 {
571         /* defined in DNA_space_types.h */
572         static EnumPropertyItem console_line_type_items[] = {
573                 {CONSOLE_LINE_OUTPUT,   "OUTPUT", 0, "Output", ""},
574                 {CONSOLE_LINE_INPUT,    "INPUT", 0, "Input", ""},
575                 {CONSOLE_LINE_INFO,             "INFO", 0, "Information", ""},
576                 {CONSOLE_LINE_ERROR,    "ERROR", 0, "Error", ""},
577                 {0, NULL, 0, NULL, NULL}};
578
579         /* identifiers */
580         ot->name= "Scrollback Append";
581     ot->description= "Append scrollback text by type.";
582         ot->idname= "CONSOLE_OT_scrollback_append";
583         
584         /* api callbacks */
585         ot->exec= scrollback_append_exec;
586         ot->poll= console_edit_poll;
587
588         /* flags */
589         ot->flag= OPTYPE_REGISTER;
590         
591         /* properties */
592         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
593         RNA_def_enum(ot->srna, "type", console_line_type_items, CONSOLE_LINE_OUTPUT, "Type", "Console output type.");
594 }
595
596
597 static int copy_exec(bContext *C, wmOperator *op)
598 {
599         SpaceConsole *sc= CTX_wm_space_console(C);
600
601         DynStr *buf_dyn= BLI_dynstr_new();
602         char *buf_str;
603         
604         ConsoleLine *cl;
605         
606         for(cl= sc->scrollback.first; cl; cl= cl->next) {
607                 BLI_dynstr_append(buf_dyn, cl->line);
608                 BLI_dynstr_append(buf_dyn, "\n");
609         }
610
611         buf_str= BLI_dynstr_get_cstring(buf_dyn);
612         BLI_dynstr_free(buf_dyn);
613
614         WM_clipboard_text_set(buf_str, 0);
615
616         MEM_freeN(buf_str);
617         return OPERATOR_FINISHED;
618 }
619
620 void CONSOLE_OT_copy(wmOperatorType *ot)
621 {
622         /* identifiers */
623         ot->name= "Copy to Clipboard";
624     ot->description= "Copy selected text to clipboard.";
625         ot->idname= "CONSOLE_OT_copy";
626
627         /* api callbacks */
628         ot->poll= console_edit_poll;
629         ot->exec= copy_exec;
630
631         /* flags */
632         ot->flag= OPTYPE_REGISTER;
633
634         /* properties */
635 }
636
637 static int paste_exec(bContext *C, wmOperator *op)
638 {
639         ConsoleLine *ci= console_history_verify(C);
640
641         char *buf_str= WM_clipboard_text_get(0);
642
643         if(buf_str==NULL)
644                 return OPERATOR_CANCELLED;
645
646         console_line_insert(ci, buf_str); /* TODO - Multiline copy?? */
647
648         MEM_freeN(buf_str);
649
650         ED_area_tag_redraw(CTX_wm_area(C));
651
652         return OPERATOR_FINISHED;
653 }
654
655 void CONSOLE_OT_paste(wmOperatorType *ot)
656 {
657         /* identifiers */
658         ot->name= "Paste from Clipboard";
659     ot->description= "Paste text from clipboard.";
660         ot->idname= "CONSOLE_OT_paste";
661
662         /* api callbacks */
663         ot->poll= console_edit_poll;
664         ot->exec= paste_exec;
665
666         /* flags */
667         ot->flag= OPTYPE_REGISTER;
668
669         /* properties */
670 }
671
672 static int zoom_exec(bContext *C, wmOperator *op)
673 {
674         SpaceConsole *sc= CTX_wm_space_console(C);
675         
676         int delta= RNA_int_get(op->ptr, "delta");
677         
678         sc->lheight += delta;
679         CLAMP(sc->lheight, 8, 32);
680         
681         ED_area_tag_redraw(CTX_wm_area(C));
682         
683         return OPERATOR_FINISHED;
684 }
685
686
687 void CONSOLE_OT_zoom(wmOperatorType *ot)
688 {
689         /* identifiers */
690         ot->name= "Console Zoom";
691     /*optionals - 
692       "Zoom view font." */
693     ot->description= "Zoom screen area.";
694         ot->idname= "CONSOLE_OT_zoom";
695         
696         /* api callbacks */
697         ot->exec= zoom_exec;
698
699         /* flags */
700         /* ot->flag= OPTYPE_REGISTER; */ /* super annoying */
701         
702         /* properties */
703         RNA_def_int(ot->srna, "delta", 0, 0, INT_MAX, "Delta", "Scale the view font.", 0, 1000);
704 }