src/minibuffer.C

   1 /* ###########################################################################
   2  *
   3  *                 The MiniBuffer Class
   4  *                 read minibuffer.h for more
   5  *                 information.
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-1999 The LyX Team.
   9  *
  10  * ###########################################################################
  11  */
  12
  13 #include <config.h>
  14
  15 #ifdef __GNUG__
  16 #pragma implementation "minibuffer.h"
  17 #endif
  18
  19 #include "support/filetools.h"
  20 #include "lyx_main.h"
  21 #include "lyxfunc.h"
  22 #include FORMS_H_LOCATION
  23 #include "minibuffer.h"
  24 #include "LyXView.h"
  25 #include "debug.h"
  26 #include "gettext.h"
  27
  28 extern bool keyseqUncomplete();
  29 extern string keyseqOptions(int l=190);
  30 extern string keyseqStr(int l=190);
  31 extern LyXAction lyxaction;
  32
  33 void MiniBuffer::TimerCB(FL_OBJECT * ob, long)
  34 {
  35         MiniBuffer * obj = static_cast<MiniBuffer*>(ob->u_vdata);
  36         obj->Init();
  37 }
  38
  39 extern "C" void C_MiniBuffer_TimerCB(FL_OBJECT * ob, long data)
  40 {
  41         MiniBuffer::TimerCB(ob, data);
  42 }
  43
  44 void MiniBuffer::ExecutingCB(FL_OBJECT * ob, long)
  45 {
  46         MiniBuffer * obj = static_cast<MiniBuffer*>(ob->u_vdata);
  47         lyxerr.debug() << "Getting ready to execute: " << obj->cur_cmd << endl;
  48         fl_set_focus_object(obj->owner->getForm(),
  49                             obj->owner->currentView()->getWorkArea());
  50         if (obj->cur_cmd.empty()) {
  51                 obj->Init();
  52                 return ;
  53         }
  54         obj->Set(_("Executing:"), obj->cur_cmd);
  55         obj->addHistory(obj->cur_cmd);
  56
  57         // Split command into function and argument
  58         string arg = obj->cur_cmd;
  59         string function;
  60         if (contains(arg, " ")) {
  61                 arg = split(arg, function, ' ');
  62                 function = strip(function);
  63         } else {
  64                 function = arg;
  65                 arg.clear();
  66         }
  67         lyxerr.debug() << "Function: " << function
  68                        << "\nArg     : " << arg << endl;
  69
  70         // Dispatch only returns requested data for a few commands (ale)
  71         string res = obj->owner->getLyXFunc()->Dispatch(function.c_str(),
  72                                                        arg.c_str());
  73         lyxerr.debug() << "Minibuffer Res: " << res << endl;
  74         obj->shows_no_match = false;
  75
  76         return ;
  77 }
  78
  79 extern "C" void C_MiniBuffer_ExecutingCB(FL_OBJECT * ob, long data)
  80 {
  81         MiniBuffer::TimerCB(ob, data);
  82 }
  83
  84 // This is not as dirty as it seems, the hidden buttons removed by this
  85 // function were just kludges for an uncomplete keyboard callback (ale)
  86 int MiniBuffer::peek_event(FL_OBJECT * ob, int event, FL_Coord, FL_Coord,
  87                            int key, void */*xev*/)
  88 {
  89         MiniBuffer * mini = static_cast<MiniBuffer*>(ob->u_vdata);
  90
  91         if (event == FL_KEYBOARD){
  92                 switch (key) {
  93                 case XK_Down:
  94                         mini->history_idx++;
  95                         if (!mini->getHistory().empty()) {
  96                                 fl_set_input(ob, mini->getHistory().c_str());
  97                         } else
  98                                 mini->history_idx--;
  99                         return 1;
 100                 case XK_Up:
 101                         if (mini->history_idx > 0) mini->history_idx--;
 102                         fl_set_input(ob, mini->getHistory().c_str());
 103                         return 1;
 104                 case 9:
 105                 case XK_Tab:
 106                 {
 107                         // complete or increment the command
 108                         char const * s = lyxaction.getApproxFuncName(fl_get_input(ob));
 109                         if (s && s[0])
 110                                 fl_set_input(ob, s);
 111                         return 1;
 112                 }
 113                 case 27:
 114                 case XK_Escape:
 115                         // Abort
 116                         fl_set_focus_object(mini->owner->getForm(),
 117                                             mini->owner->currentView()->getWorkArea());
 118                         mini->Init();
 119                         return 1;
 120                 case 13:
 121                 case XK_Return:
 122                         // Execute a command.
 123                         mini->cur_cmd = string(fl_get_input(ob));
 124                         ExecutingCB(ob, 0);
 125                         return 1;
 126                 default:
 127                         return 0;
 128                 }
 129         }
 130         return 0;
 131 }
 132
 133 extern "C" int C_MiniBuffer_peek_event(FL_OBJECT * ob, int event,
 134                                        FL_Coord, FL_Coord,
 135                                        int key, void * xev)
 136 {
 137         return MiniBuffer::peek_event(ob,event,0,0,key,xev);
 138 }
 139
 140
 141 void MiniBuffer::ExecCommand()
 142 {
 143         text.clear();
 144         fl_set_input(the_buffer, "");
 145         fl_set_focus_object(owner->getForm(),the_buffer);
 146 }
 147
 148
 149 FL_OBJECT * MiniBuffer::add(int type, FL_Coord x, FL_Coord y,
 150                            FL_Coord w, FL_Coord h)
 151 {
 152         FL_OBJECT * obj;
 153
 154         the_buffer = obj = fl_add_input(type,x,y,w,h,text.c_str());
 155         fl_set_object_boxtype(obj,FL_DOWN_BOX);
 156         fl_set_object_resize(obj, FL_RESIZE_ALL);
 157         fl_set_object_gravity(obj, SouthWestGravity, SouthEastGravity);
 158         fl_set_object_color(obj,FL_MCOL,FL_MCOL);
 159         fl_set_object_lsize(obj,FL_NORMAL_SIZE);
 160         fl_set_object_callback(obj,C_MiniBuffer_ExecutingCB, 0);
 161
 162         // To intercept Up, Down, Table for history
 163         fl_set_object_prehandler(obj, C_MiniBuffer_peek_event);
 164         obj->u_vdata = this;
 165         obj->wantkey = FL_KEY_TAB;
 166
 167         // timer
 168         timer = fl_add_timer(FL_HIDDEN_TIMER, 0,0,0,0, "Timer");
 169         fl_set_object_callback(timer, C_MiniBuffer_TimerCB, 0);
 170         timer->u_vdata = this;
 171         fl_set_input(the_buffer, text.c_str());
 172
 173         return obj;
 174 }
 175
 176
 177 // Added optional arg `delay_secs', defaults to 4.
 178 //When 0, no timeout is done. RVDK_PATCH_5
 179 void MiniBuffer::Set(string const& s1, string const& s2,
 180                      string const& s3, int delay_secs)
 181 {
 182         setTimer(delay_secs);
 183
 184         string ntext = strip(s1 + ' ' + s2 + ' ' + s3);
 185
 186         if (!the_buffer->focus) {
 187                 fl_set_input(the_buffer, ntext.c_str());
 188                 XFlush(fl_display);
 189                 text = ntext;
 190         }
 191 }
 192
 193
 194 void MiniBuffer::Init()
 195 {
 196         // If we have focus, we don't want to change anything.
 197         if (the_buffer->focus)
 198                 return;
 199
 200         // When meta-fake key is pressed, show the key sequence so far + "M-".
 201         if (owner->getLyXFunc()->wasMetaKey()) {
 202                 text = owner->getLyXFunc()->keyseqStr();
 203                 text += " M-";
 204         }
 205
 206         // Else, when a non-complete key sequence is pressed,
 207         // show the available options.
 208         else if (owner->getLyXFunc()->keyseqUncomplete())
 209                 text = owner->getLyXFunc()->keyseqOptions();
 210
 211         // Else, show the buffer state.
 212         else if (owner->currentView()->available()) {
 213                         string nicename =
 214                                 MakeDisplayPath(owner->buffer()->
 215                                                 getFileName());
 216                         // Should we do this instead? (kindo like emacs)
 217                         // leaves more room for other information
 218                         text = "LyX: ";
 219                         text += nicename;
 220                         if (owner->buffer()->lyxvc.inUse()) {
 221                                 text += " [";
 222                                 text += owner->buffer()->lyxvc.version();
 223                                 text += ' ';
 224                                 text += owner->buffer()->lyxvc.locker();
 225                                 if (owner->buffer()->isReadonly())
 226                                         text += " (RO)";
 227                                 text += ']';
 228                         } else if (owner->buffer()->isReadonly())
 229                                 text += " [RO]";
 230                         if (!owner->buffer()->isLyxClean())
 231                                 text += _(" (Changed)");
 232         } else {
 233                 if (text != _("Welcome to LyX!")) // this is a hack
 234                         text = _("* No document open *");
 235         }
 236
 237
 238         fl_set_input(the_buffer, text.c_str());
 239         setTimer(0);
 240         XFlush(fl_display);
 241 }
 242
 243
 244 // allows to store and reset the contents one time. Usefull for
 245 // status messages like "load font" (Matthias)
 246 void MiniBuffer::Store()
 247 {
 248         text_stored = fl_get_input(the_buffer);
 249 }
 250
 251
 252 void MiniBuffer::Reset()
 253 {
 254         if (!text_stored.empty()){
 255                 Set(text_stored);
 256                 text_stored.clear();
 257         }
 258 }
 259
 260 void MiniBuffer::Activate()
 261 {
 262         fl_activate_object(the_buffer);
 263         fl_redraw_object(the_buffer);
 264 }
 265
 266 void MiniBuffer::Deactivate()
 267 {
 268         fl_deactivate_object(the_buffer);
 269 }
 270
 271