doxygen: blender/editors tagged.
[blender-staging.git] / source / blender / editors / space_console / console_ops.c
index ec3c600beabb70f7d3c3ce01c6e5d5cb44a2e2e7..5636c40cef227bafe3d96667bf3733dcd007b459 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * along with this program; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
- * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
- * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
  * Contributor(s): Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/editors/space_console/console_ops.c
+ *  \ingroup spconsole
+ */
+
+
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h> /* ispunct */
@@ -38,6 +38,7 @@
 
 #include "BLI_blenlib.h"
 #include "BLI_dynstr.h"
+#include "BLI_utildefines.h"
 
 #include "BKE_context.h"
 #include "BKE_text.h" /* only for character utility funcs */
@@ -45,6 +46,7 @@
 #include "WM_api.h"
 #include "WM_types.h"
 
+#include "UI_view2d.h"
 #include "ED_screen.h"
 
 #include "RNA_access.h"
 
 #include "console_intern.h"
 
+static void console_textview_update_rect(SpaceConsole *sc, ARegion *ar)
+{
+       View2D *v2d= &ar->v2d;
+
+       UI_view2d_totRect_set(v2d, ar->winx-1, console_textview_height(sc, ar));
+}
+
+static void console_select_offset(SpaceConsole *sc, const int offset)
+{
+       sc->sel_start += offset;
+       sc->sel_end += offset;
+}
+
 void console_history_free(SpaceConsole *sc, ConsoleLine *cl)
 {
        BLI_remlink(&sc->history, cl);
@@ -65,7 +80,7 @@ void console_scrollback_free(SpaceConsole *sc, ConsoleLine *cl)
        MEM_freeN(cl);
 }
 
-void console_scrollback_limit(SpaceConsole *sc)
+static void console_scrollback_limit(SpaceConsole *sc)
 {
        int tot;
        
@@ -188,7 +203,7 @@ static ConsoleLine *console_scrollback_add(const bContext *C, ConsoleLine *from)
 }
 #endif
 
-static ConsoleLine *console_lb_add_str__internal(ListBase *lb, const bContext *C, char *str, int own)
+static ConsoleLine *console_lb_add_str__internal(ListBase *lb, char *str, int own)
 {
        ConsoleLine *ci= MEM_callocN(sizeof(ConsoleLine), "ConsoleLine Add");
        if(own)         ci->line= str;
@@ -199,16 +214,14 @@ static ConsoleLine *console_lb_add_str__internal(ListBase *lb, const bContext *C
        BLI_addtail(lb, ci);
        return ci;
 }
-ConsoleLine *console_history_add_str(const bContext *C, char *str, int own)
+ConsoleLine *console_history_add_str(SpaceConsole *sc, char *str, int own)
 {
-       return console_lb_add_str__internal(&CTX_wm_space_console(C)->history, C, str, own);
+       return console_lb_add_str__internal(&sc->history, str, own);
 }
-ConsoleLine *console_scrollback_add_str(const bContext *C, char *str, int own)
+ConsoleLine *console_scrollback_add_str(SpaceConsole *sc, char *str, int own)
 {
-       SpaceConsole *sc= CTX_wm_space_console(C);
-       ConsoleLine *ci= console_lb_add_str__internal(&sc->scrollback, C, str, own);
-       sc->sel_start += ci->len + 1;
-       sc->sel_end   += ci->len + 1;
+       ConsoleLine *ci= console_lb_add_str__internal(&sc->scrollback, str, own);
+       console_select_offset(sc, ci->len + 1);
        return ci;
 }
 
@@ -260,22 +273,6 @@ static int console_line_insert(ConsoleLine *ci, char *str)
        return len;
 }
 
-static int console_edit_poll(bContext *C)
-{
-       SpaceConsole *sc= CTX_wm_space_console(C);
-
-       if(!sc || sc->type != CONSOLE_TYPE_PYTHON)
-               return 0;
-
-       return 1;
-}
-#if 0
-static int console_poll(bContext *C)
-{
-       return (CTX_wm_space_console(C) != NULL);
-}
-#endif
-
 /* static funcs for text editing */
 
 /* similar to the text editor, with some not used. keep compatible */
@@ -357,7 +354,7 @@ void CONSOLE_OT_move(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= move_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
 
        /* properties */
        RNA_def_enum(ot->srna, "type", move_type_items, LINE_BEGIN, "Type", "Where to move cursor to.");
@@ -366,13 +363,15 @@ void CONSOLE_OT_move(wmOperatorType *ot)
 #define TAB_LENGTH 4
 static int insert_exec(bContext *C, wmOperator *op)
 {
+       SpaceConsole *sc= CTX_wm_space_console(C);
+       ARegion *ar= CTX_wm_region(C);
        ConsoleLine *ci= console_history_verify(C);
        char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0);
        int len;
 
        // XXX, alligned tab key hack
        if(str[0]=='\t' && str[1]=='\0') {
-               int len= TAB_LENGTH - (ci->cursor % TAB_LENGTH);
+               len= TAB_LENGTH - (ci->cursor % TAB_LENGTH);
                MEM_freeN(str);
                str= MEM_mallocN(len + 1, "insert_exec");
                memset(str, ' ', len);
@@ -383,9 +382,14 @@ static int insert_exec(bContext *C, wmOperator *op)
        
        MEM_freeN(str);
        
-       if(len==0)
+       if(len==0) {
                return OPERATOR_CANCELLED;
-               
+       }
+       else {
+               console_select_offset(sc, len);
+       }
+
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
        
        return OPERATOR_FINISHED;
@@ -393,9 +397,19 @@ static int insert_exec(bContext *C, wmOperator *op)
 
 static int insert_invoke(bContext *C, wmOperator *op, wmEvent *event)
 {
-       if(!RNA_property_is_set(op->ptr, "text")) {
-               char str[2] = {event->ascii, '\0'};
-               RNA_string_set(op->ptr, "text", str);
+       // if(!RNA_property_is_set(op->ptr, "text")) { /* always set from keymap XXX */
+       if(!RNA_string_length(op->ptr, "text")) {
+               /* if alt/ctrl/super are pressed pass through */
+               if(event->ctrl || event->oskey) {
+                       return OPERATOR_PASS_THROUGH;
+               }
+               else {
+                       char str[2];
+                       str[0]= event->ascii;
+                       str[1]= '\0';
+
+                       RNA_string_set(op->ptr, "text", str);
+               }
        }
        return insert_exec(C, op);
 }
@@ -410,7 +424,7 @@ void CONSOLE_OT_insert(wmOperatorType *ot)
        /* api callbacks */
        ot->exec= insert_exec;
        ot->invoke= insert_invoke;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
 
        /* properties */
        RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");
@@ -426,13 +440,12 @@ static EnumPropertyItem delete_type_items[]= {
 
 static int delete_exec(bContext *C, wmOperator *op)
 {
-       
+       SpaceConsole *sc= CTX_wm_space_console(C);
+       ARegion *ar= CTX_wm_region(C);
        ConsoleLine *ci= console_history_verify(C);
-       
-       
-       int done = 0;
 
-       int type= RNA_enum_get(op->ptr, "type");
+       const short type= RNA_enum_get(op->ptr, "type");
+       int done = 0;
        
        if(ci->len==0) {
                return OPERATOR_CANCELLED;
@@ -456,9 +469,14 @@ static int delete_exec(bContext *C, wmOperator *op)
                break;
        }
        
-       if(!done)
+       if(!done) {
                return OPERATOR_CANCELLED;
-       
+       }
+       else {
+               console_select_offset(sc, -1);
+       }
+
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
        
        return OPERATOR_FINISHED;
@@ -474,7 +492,7 @@ void CONSOLE_OT_delete(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= delete_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
 
        /* properties */
        RNA_def_enum(ot->srna, "type", delete_type_items, DEL_NEXT_CHAR, "Type", "Which part of the text to delete.");
@@ -485,6 +503,7 @@ void CONSOLE_OT_delete(wmOperatorType *ot)
 static int clear_exec(bContext *C, wmOperator *op)
 {
        SpaceConsole *sc= CTX_wm_space_console(C);
+       ARegion *ar= CTX_wm_region(C);
        
        short scrollback= RNA_boolean_get(op->ptr, "scrollback");
        short history= RNA_boolean_get(op->ptr, "history");
@@ -500,9 +519,10 @@ static int clear_exec(bContext *C, wmOperator *op)
                while(sc->history.first)
                        console_history_free(sc, sc->history.first);
        }
-       
+
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
-       
+
        return OPERATOR_FINISHED;
 }
 
@@ -515,7 +535,7 @@ void CONSOLE_OT_clear(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= clear_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        
        /* properties */
        RNA_def_boolean(ot->srna, "scrollback", 1, "Scrollback", "Clear the scrollback history");
@@ -528,9 +548,11 @@ void CONSOLE_OT_clear(wmOperatorType *ot)
 static int history_cycle_exec(bContext *C, wmOperator *op)
 {
        SpaceConsole *sc= CTX_wm_space_console(C);
+       ARegion *ar= CTX_wm_region(C);
+
        ConsoleLine *ci= console_history_verify(C); /* TODO - stupid, just prevernts crashes when no command line */
-       
        short reverse= RNA_boolean_get(op->ptr, "reverse"); /* assumes down, reverse is up */
+       int prev_len= ci->len;
 
        /* keep a copy of the line above so when history is cycled
         * this is the only function that needs to know about the double-up */
@@ -559,7 +581,12 @@ static int history_cycle_exec(bContext *C, wmOperator *op)
 
                console_history_add(C, (ConsoleLine *)sc->history.last);
        }
+       
+       ci= sc->history.last;
+       console_select_offset(sc, ci->len - prev_len);
 
+       /* could be wrapped so update scroll rect */
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
 
        return OPERATOR_FINISHED;
@@ -574,7 +601,7 @@ void CONSOLE_OT_history_cycle(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= history_cycle_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        
        /* properties */
        RNA_def_boolean(ot->srna, "reverse", 0, "Reverse", "reverse cycle history");
@@ -584,13 +611,15 @@ void CONSOLE_OT_history_cycle(wmOperatorType *ot)
 /* the python exec operator uses this */
 static int history_append_exec(bContext *C, wmOperator *op)
 {
+       SpaceConsole *sc= CTX_wm_space_console(C);
+       ScrArea *sa= CTX_wm_area(C);
        ConsoleLine *ci= console_history_verify(C);
        char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
        int cursor= RNA_int_get(op->ptr, "current_character");
        short rem_dupes= RNA_boolean_get(op->ptr, "remove_duplicates");
+       int prev_len= ci->len;
 
        if(rem_dupes) {
-               SpaceConsole *sc= CTX_wm_space_console(C);
                ConsoleLine *cl;
 
                while((cl= console_history_find(sc, ci->line, ci)))
@@ -602,11 +631,12 @@ static int history_append_exec(bContext *C, wmOperator *op)
                }
        }
 
-       ci= console_history_add_str(C, str, 1); /* own the string */
+       ci= console_history_add_str(sc, str, 1); /* own the string */
+       console_select_offset(sc, ci->len - prev_len);
        console_line_cursor_set(ci, cursor);
-       
-       ED_area_tag_redraw(CTX_wm_area(C));
-       
+
+       ED_area_tag_redraw(sa);
+
        return OPERATOR_FINISHED;
 }
 
@@ -619,7 +649,7 @@ void CONSOLE_OT_history_append(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= history_append_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        
        /* properties */
        RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
@@ -632,16 +662,20 @@ void CONSOLE_OT_history_append(wmOperatorType *ot)
 static int scrollback_append_exec(bContext *C, wmOperator *op)
 {
        SpaceConsole *sc= CTX_wm_space_console(C);
-       ConsoleLine *ci= console_history_verify(C);
+       ARegion *ar= CTX_wm_region(C);
+       ConsoleLine *ci;
        
        char *str= RNA_string_get_alloc(op->ptr, "text", NULL, 0); /* own this text in the new line, dont free */
        int type= RNA_enum_get(op->ptr, "type");
+
+       console_history_verify(C);
        
-       ci= console_scrollback_add_str(C, str, 1); /* own the string */
+       ci= console_scrollback_add_str(sc, str, 1); /* own the string */
        ci->type= type;
        
        console_scrollback_limit(sc);
-       
+
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
        
        return OPERATOR_FINISHED;
@@ -664,7 +698,7 @@ void CONSOLE_OT_scrollback_append(wmOperatorType *ot)
        
        /* api callbacks */
        ot->exec= scrollback_append_exec;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        
        /* properties */
        RNA_def_string(ot->srna, "text", "", 0, "Text", "Text to insert at the cursor position.");      
@@ -672,10 +706,9 @@ void CONSOLE_OT_scrollback_append(wmOperatorType *ot)
 }
 
 
-static int copy_exec(bContext *C, wmOperator *op)
+static int copy_exec(bContext *C, wmOperator *UNUSED(op))
 {
        SpaceConsole *sc= CTX_wm_space_console(C);
-       int buf_len;
 
        DynStr *buf_dyn= BLI_dynstr_new();
        char *buf_str;
@@ -684,6 +717,8 @@ static int copy_exec(bContext *C, wmOperator *op)
        int sel[2];
        int offset= 0;
 
+       ConsoleLine cl_dummy= {0};
+
 #if 0
        /* copy whole file */
        for(cl= sc->scrollback.first; cl; cl= cl->next) {
@@ -695,14 +730,16 @@ static int copy_exec(bContext *C, wmOperator *op)
        if(sc->sel_start == sc->sel_end)
                return OPERATOR_CANCELLED;
 
+       console_scrollback_prompt_begin(sc, &cl_dummy);
 
        for(cl= sc->scrollback.first; cl; cl= cl->next) {
                offset += cl->len + 1;
        }
 
-       if(offset==0)
+       if(offset==0) {
+               console_scrollback_prompt_end(sc, &cl_dummy);
                return OPERATOR_CANCELLED;
-
+       }
 
        offset -= 1;
        sel[0]= offset - sc->sel_end;
@@ -724,11 +761,14 @@ static int copy_exec(bContext *C, wmOperator *op)
        }
 
        buf_str= BLI_dynstr_get_cstring(buf_dyn);
-       buf_len= BLI_dynstr_get_len(buf_dyn);
+
        BLI_dynstr_free(buf_dyn);
        WM_clipboard_text_set(buf_str, 0);
 
        MEM_freeN(buf_str);
+
+       console_scrollback_prompt_end(sc, &cl_dummy);
+
        return OPERATOR_FINISHED;
 }
 
@@ -740,14 +780,16 @@ void CONSOLE_OT_copy(wmOperatorType *ot)
        ot->idname= "CONSOLE_OT_copy";
 
        /* api callbacks */
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        ot->exec= copy_exec;
 
        /* properties */
 }
 
-static int paste_exec(bContext *C, wmOperator *op)
+static int paste_exec(bContext *C, wmOperator *UNUSED(op))
 {
+       SpaceConsole *sc= CTX_wm_space_console(C);
+       ARegion *ar= CTX_wm_region(C);
        ConsoleLine *ci= console_history_verify(C);
 
        char *buf_str= WM_clipboard_text_get(0);
@@ -756,7 +798,6 @@ static int paste_exec(bContext *C, wmOperator *op)
        if(buf_str==NULL)
                return OPERATOR_CANCELLED;
 
-       buf_next= buf_str;
        buf_step= buf_str;
 
        while((buf_next=buf_step) && buf_next[0] != '\0') {
@@ -771,11 +812,12 @@ static int paste_exec(bContext *C, wmOperator *op)
                        ci= console_history_verify(C);
                }
 
-               console_line_insert(ci, buf_next);
+               console_select_offset(sc, console_line_insert(ci, buf_next));
        }
 
        MEM_freeN(buf_str);
 
+       console_textview_update_rect(sc, ar);
        ED_area_tag_redraw(CTX_wm_area(C));
 
        return OPERATOR_FINISHED;
@@ -789,7 +831,7 @@ void CONSOLE_OT_paste(wmOperatorType *ot)
        ot->idname= "CONSOLE_OT_paste";
 
        /* api callbacks */
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
        ot->exec= paste_exec;
 
        /* properties */
@@ -800,10 +842,11 @@ typedef struct SetConsoleCursor {
        int sel_init;
 } SetConsoleCursor;
 
-static void set_cursor_to_pos(SpaceConsole *sc, ARegion *ar, SetConsoleCursor *scu, int mval[2], int sel)
+// TODO, cursor placement without selection
+static void set_cursor_to_pos(SpaceConsole *sc, ARegion *ar, SetConsoleCursor *scu, int mval[2], int UNUSED(sel))
 {
        int pos;
-       pos= console_char_pick(sc, ar, NULL, mval);
+       pos= console_char_pick(sc, ar, mval);
 
        if(scu->sel_init == INT_MAX) {
                scu->sel_init= pos;
@@ -829,13 +872,24 @@ static void console_modal_select_apply(bContext *C, wmOperator *op, wmEvent *eve
        SpaceConsole *sc= CTX_wm_space_console(C);
        ARegion *ar= CTX_wm_region(C);
        SetConsoleCursor *scu= op->customdata;
-       int mval[2] = {event->mval[0], event->mval[1]};
+       int mval[2];
+       int sel_prev[2];
+
+       mval[0]= event->mval[0];
+       mval[1]= event->mval[1];
 
+       sel_prev[0]= sc->sel_start;
+       sel_prev[1]= sc->sel_end;
+       
        set_cursor_to_pos(sc, ar, scu, mval, TRUE);
-       ED_area_tag_redraw(CTX_wm_area(C));
+
+       /* only redraw if the selection changed */
+       if(sel_prev[0] != sc->sel_start || sel_prev[1] != sc->sel_end) {
+               ED_area_tag_redraw(CTX_wm_area(C));
+       }
 }
 
-static void set_cursor_exit(bContext *C, wmOperator *op)
+static void set_cursor_exit(bContext *UNUSED(C), wmOperator *op)
 {
 //     SpaceConsole *sc= CTX_wm_space_console(C);
        SetConsoleCursor *scu= op->customdata;
@@ -904,5 +958,5 @@ void CONSOLE_OT_select_set(wmOperatorType *ot)
        ot->invoke= console_modal_select_invoke;
        ot->modal= console_modal_select;
        ot->cancel= console_modal_select_cancel;
-       ot->poll= console_edit_poll;
+       ot->poll= ED_operator_console_active;
 }