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