* First commit merging 2.4-based sim_physics in to volume25 branch.
[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->idname= "CONSOLE_OT_move";
284         
285         /* api callbacks */
286         ot->exec= move_exec;
287         ot->poll= console_edit_poll;
288
289         /* flags */
290         ot->flag= OPTYPE_REGISTER;
291
292         /* properties */
293         RNA_def_enum(ot->srna, "type", move_type_items, LINE_BEGIN, "Type", "Where to move cursor to.");
294 }
295
296
297 static int insert_exec(bContext *C, wmOperator *op)
298 {
299         ConsoleLine *ci= console_history_verify(C);
300         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0);
301         
302         int len= console_line_insert(ci, str);
303         
304         MEM_freeN(str);
305         
306         if(len==0)
307                 return OPERATOR_CANCELLED;
308                 
309         ED_area_tag_redraw(CTX_wm_area(C));
310         
311         return OPERATOR_FINISHED;
312 }
313
314 static int insert_invoke(bContext *C, wmOperator *op, wmEvent *event)
315 {
316         if(!RNA_property_is_set(op->ptr, "text")) {
317                 char str[2] = {event->ascii, '\0'};
318                 RNA_string_set(op->ptr, "text", str);
319         }
320         return insert_exec(C, op);
321 }
322
323 void CONSOLE_OT_insert(wmOperatorType *ot)
324 {
325         /* identifiers */
326         ot->name= "Insert";
327         ot->idname= "CONSOLE_OT_insert";
328         
329         /* api callbacks */
330         ot->exec= insert_exec;
331         ot->invoke= insert_invoke;
332         ot->poll= console_edit_poll;
333
334         /* flags */
335         ot->flag= OPTYPE_REGISTER;
336
337         /* properties */
338         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");
339 }
340
341
342 static EnumPropertyItem delete_type_items[]= {
343         {DEL_NEXT_CHAR, "NEXT_CHARACTER", 0, "Next Character", ""},
344         {DEL_PREV_CHAR, "PREVIOUS_CHARACTER", 0, "Previous Character", ""},
345 //      {DEL_NEXT_WORD, "NEXT_WORD", 0, "Next Word", ""},
346 //      {DEL_PREV_WORD, "PREVIOUS_WORD", 0, "Previous Word", ""},
347         {0, NULL, 0, NULL, NULL}};
348
349 static int delete_exec(bContext *C, wmOperator *op)
350 {
351         
352         ConsoleLine *ci= console_history_verify(C);
353         
354         
355         int done = 0;
356
357         int type= RNA_enum_get(op->ptr, "type");
358         
359         if(ci->len==0) {
360                 return OPERATOR_CANCELLED;
361         }
362         
363         switch(type) {
364         case DEL_NEXT_CHAR:
365                 if(ci->cursor < ci->len) {
366                         memmove(ci->line + ci->cursor, ci->line + ci->cursor+1, (ci->len - ci->cursor)+1);
367                         ci->len--;
368                         done= 1;
369                 }
370                 break;
371         case DEL_PREV_CHAR:
372                 if(ci->cursor > 0) {
373                         ci->cursor--; /* same as above */
374                         memmove(ci->line + ci->cursor, ci->line + ci->cursor+1, (ci->len - ci->cursor)+1);
375                         ci->len--;
376                         done= 1;
377                 }
378                 break;
379         }
380         
381         if(!done)
382                 return OPERATOR_CANCELLED;
383         
384         ED_area_tag_redraw(CTX_wm_area(C));
385         
386         return OPERATOR_FINISHED;
387 }
388
389
390 void CONSOLE_OT_delete(wmOperatorType *ot)
391 {
392         /* identifiers */
393         ot->name= "Delete";
394         ot->idname= "CONSOLE_OT_delete";
395         
396         /* api callbacks */
397         ot->exec= delete_exec;
398         ot->poll= console_edit_poll;
399
400         /* flags */
401         ot->flag= OPTYPE_REGISTER;
402
403         /* properties */
404         RNA_def_enum(ot->srna, "type", delete_type_items, DEL_NEXT_CHAR, "Type", "Which part of the text to delete.");
405 }
406
407
408 /* the python exec operator uses this */
409 static int clear_exec(bContext *C, wmOperator *op)
410 {
411         SpaceConsole *sc= CTX_wm_space_console(C);
412         
413         short scrollback= RNA_boolean_get(op->ptr, "scrollback");
414         short history= RNA_boolean_get(op->ptr, "history");
415         
416         /*ConsoleLine *ci= */ console_history_verify(C);
417         
418         if(scrollback) { /* last item in mistory */
419                 while(sc->scrollback.first)
420                         console_scrollback_free(sc, sc->scrollback.first);
421         }
422         
423         if(history) {
424                 while(sc->history.first)
425                         console_history_free(sc, sc->history.first);
426         }
427         
428         ED_area_tag_redraw(CTX_wm_area(C));
429         
430         return OPERATOR_FINISHED;
431 }
432
433 void CONSOLE_OT_clear(wmOperatorType *ot)
434 {
435         /* identifiers */
436         ot->name= "Clear";
437         ot->idname= "CONSOLE_OT_clear";
438         
439         /* api callbacks */
440         ot->exec= clear_exec;
441         ot->poll= console_edit_poll;
442
443         /* flags */
444         ot->flag= OPTYPE_REGISTER;
445         
446         /* properties */
447         RNA_def_boolean(ot->srna, "scrollback", 1, "Scrollback", "Clear the scrollback history");
448         RNA_def_boolean(ot->srna, "history", 0, "History", "Clear the command history");
449 }
450
451
452
453 /* the python exec operator uses this */
454 static int history_cycle_exec(bContext *C, wmOperator *op)
455 {
456         SpaceConsole *sc= CTX_wm_space_console(C);
457         ConsoleLine *ci= console_history_verify(C); /* TODO - stupid, just prevernts crashes when no command line */
458         
459         short reverse= RNA_boolean_get(op->ptr, "reverse"); /* assumes down, reverse is up */
460         
461         if(reverse) { /* last item in mistory */
462                 ci= sc->history.last;
463                 BLI_remlink(&sc->history, ci);
464                 BLI_addhead(&sc->history, ci);
465         }
466         else {
467                 ci= sc->history.first;
468                 BLI_remlink(&sc->history, ci);
469                 BLI_addtail(&sc->history, ci);
470         }
471         
472         ED_area_tag_redraw(CTX_wm_area(C));
473         
474         return OPERATOR_FINISHED;
475 }
476
477 void CONSOLE_OT_history_cycle(wmOperatorType *ot)
478 {
479         /* identifiers */
480         ot->name= "History Cycle";
481         ot->idname= "CONSOLE_OT_history_cycle";
482         
483         /* api callbacks */
484         ot->exec= history_cycle_exec;
485         ot->poll= console_edit_poll;
486
487         /* flags */
488         ot->flag= OPTYPE_REGISTER;
489         
490         /* properties */
491         RNA_def_boolean(ot->srna, "reverse", 0, "Reverse", "reverse cycle history");
492 }
493
494
495 /* the python exec operator uses this */
496 static int history_append_exec(bContext *C, wmOperator *op)
497 {
498         ConsoleLine *ci= console_history_verify(C);
499         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
500         int cursor= RNA_int_get(op->ptr, "current_character");
501         short rem_dupes= RNA_boolean_get(op->ptr, "remove_duplicates");
502
503         if(rem_dupes) {
504                 SpaceConsole *sc= CTX_wm_space_console(C);
505                 ConsoleLine *cl;
506
507                 while((cl= console_history_find(sc, ci->line, ci)))
508                         console_history_free(sc, cl);
509
510                 if(strcmp(str, ci->line)==0) {
511                         MEM_freeN(str);
512                         return OPERATOR_FINISHED;
513                 }
514         }
515
516         ci= console_history_add_str(C, str, 1); /* own the string */
517         console_line_cursor_set(ci, cursor);
518         
519         ED_area_tag_redraw(CTX_wm_area(C));
520         
521         return OPERATOR_FINISHED;
522 }
523
524 void CONSOLE_OT_history_append(wmOperatorType *ot)
525 {
526         /* identifiers */
527         ot->name= "History Append";
528         ot->idname= "CONSOLE_OT_history_append";
529         
530         /* api callbacks */
531         ot->exec= history_append_exec;
532         ot->poll= console_edit_poll;
533
534         /* flags */
535         ot->flag= OPTYPE_REGISTER;
536         
537         /* properties */
538         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
539         RNA_def_int(ot->srna, "current_character", 0, 0, INT_MAX, "Cursor", "The index of the cursor.", 0, 10000);
540         RNA_def_boolean(ot->srna, "remove_duplicates", 0, "Remove Duplicates", "Remove duplicate items in the history");
541 }
542
543
544 /* the python exec operator uses this */
545 static int scrollback_append_exec(bContext *C, wmOperator *op)
546 {
547         SpaceConsole *sc= CTX_wm_space_console(C);
548         ConsoleLine *ci= console_history_verify(C);
549         
550         char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
551         int type= RNA_enum_get(op->ptr, "type");
552         
553         ci= console_scrollback_add_str(C, str, 1); /* own the string */
554         ci->type= type;
555         
556         console_scrollback_limit(sc);
557         
558         ED_area_tag_redraw(CTX_wm_area(C));
559         
560         return OPERATOR_FINISHED;
561 }
562
563 void CONSOLE_OT_scrollback_append(wmOperatorType *ot)
564 {
565         /* defined in DNA_space_types.h */
566         static EnumPropertyItem console_line_type_items[] = {
567                 {CONSOLE_LINE_OUTPUT,   "OUTPUT", 0, "Output", ""},
568                 {CONSOLE_LINE_INPUT,    "INPUT", 0, "Input", ""},
569                 {CONSOLE_LINE_INFO,             "INFO", 0, "Information", ""},
570                 {CONSOLE_LINE_ERROR,    "ERROR", 0, "Error", ""},
571                 {0, NULL, 0, NULL, NULL}};
572
573         /* identifiers */
574         ot->name= "Scrollback Append";
575         ot->idname= "CONSOLE_OT_scrollback_append";
576         
577         /* api callbacks */
578         ot->exec= scrollback_append_exec;
579         ot->poll= console_edit_poll;
580
581         /* flags */
582         ot->flag= OPTYPE_REGISTER;
583         
584         /* properties */
585         RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
586         RNA_def_enum(ot->srna, "type", console_line_type_items, CONSOLE_LINE_OUTPUT, "Type", "Console output type.");
587 }
588
589
590 static int copy_exec(bContext *C, wmOperator *op)
591 {
592         SpaceConsole *sc= CTX_wm_space_console(C);
593
594         DynStr *buf_dyn= BLI_dynstr_new();
595         char *buf_str;
596         
597         ConsoleLine *cl;
598         
599         for(cl= sc->scrollback.first; cl; cl= cl->next) {
600                 BLI_dynstr_append(buf_dyn, cl->line);
601                 BLI_dynstr_append(buf_dyn, "\n");
602         }
603
604         buf_str= BLI_dynstr_get_cstring(buf_dyn);
605         BLI_dynstr_free(buf_dyn);
606
607         WM_clipboard_text_set(buf_str, 0);
608
609         MEM_freeN(buf_str);
610         return OPERATOR_FINISHED;
611 }
612
613 void CONSOLE_OT_copy(wmOperatorType *ot)
614 {
615         /* identifiers */
616         ot->name= "Copy to Clipboard";
617         ot->idname= "CONSOLE_OT_copy";
618
619         /* api callbacks */
620         ot->poll= console_edit_poll;
621         ot->exec= copy_exec;
622
623         /* flags */
624         ot->flag= OPTYPE_REGISTER;
625
626         /* properties */
627 }
628
629 static int paste_exec(bContext *C, wmOperator *op)
630 {
631         ConsoleLine *ci= console_history_verify(C);
632
633         char *buf_str= WM_clipboard_text_get(0);
634
635         if(buf_str==NULL)
636                 return OPERATOR_CANCELLED;
637
638         console_line_insert(ci, buf_str); /* TODO - Multiline copy?? */
639
640         MEM_freeN(buf_str);
641
642         ED_area_tag_redraw(CTX_wm_area(C));
643
644         return OPERATOR_FINISHED;
645 }
646
647 void CONSOLE_OT_paste(wmOperatorType *ot)
648 {
649         /* identifiers */
650         ot->name= "Paste from Clipboard";
651         ot->idname= "CONSOLE_OT_paste";
652
653         /* api callbacks */
654         ot->poll= console_edit_poll;
655         ot->exec= paste_exec;
656
657         /* flags */
658         ot->flag= OPTYPE_REGISTER;
659
660         /* properties */
661 }
662
663 static int zoom_exec(bContext *C, wmOperator *op)
664 {
665         SpaceConsole *sc= CTX_wm_space_console(C);
666         
667         int delta= RNA_int_get(op->ptr, "delta");
668         
669         sc->lheight += delta;
670         CLAMP(sc->lheight, 8, 32);
671         
672         ED_area_tag_redraw(CTX_wm_area(C));
673         
674         return OPERATOR_FINISHED;
675 }
676
677
678 void CONSOLE_OT_zoom(wmOperatorType *ot)
679 {
680         /* identifiers */
681         ot->name= "Console Zoom";
682         ot->idname= "CONSOLE_OT_zoom";
683         
684         /* api callbacks */
685         ot->exec= zoom_exec;
686
687         /* flags */
688         /* ot->flag= OPTYPE_REGISTER; */ /* super annoying */
689         
690         /* properties */
691         RNA_def_int(ot->srna, "delta", 0, 0, INT_MAX, "Delta", "Scale the view font.", 0, 1000);
692 }