src/LyXFunc.cpp

   1 /**
   2  * \file LyXFunc.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Allan Rae
  13  * \author Dekel Tsur
  14  * \author Martin Vermeer
  15  * \author Jürgen Vigna
  16  *
  17  * Full author contact details are available in file CREDITS.
  18  */
  19
  20 #include <config.h>
  21
  22 #include "LyXFunc.h"
  23
  24 #include "LayoutFile.h"
  25 #include "BranchList.h"
  26 #include "buffer_funcs.h"
  27 #include "Buffer.h"
  28 #include "BufferList.h"
  29 #include "BufferParams.h"
  30 #include "BufferView.h"
  31 #include "CmdDef.h"
  32 #include "Color.h"
  33 #include "Converter.h"
  34 #include "Cursor.h"
  35 #include "CutAndPaste.h"
  36 #include "DispatchResult.h"
  37 #include "Encoding.h"
  38 #include "ErrorList.h"
  39 #include "Format.h"
  40 #include "FuncRequest.h"
  41 #include "FuncStatus.h"
  42 #include "InsetIterator.h"
  43 #include "Intl.h"
  44 #include "KeyMap.h"
  45 #include "Language.h"
  46 #include "LaTeXFeatures.h"
  47 #include "Lexer.h"
  48 #include "LyXAction.h"
  49 #include "lyxfind.h"
  50 #include "LyX.h"
  51 #include "LyXRC.h"
  52 #include "LyXVC.h"
  53 #include "Paragraph.h"
  54 #include "ParagraphParameters.h"
  55 #include "ParIterator.h"
  56 #include "Row.h"
  57 #include "Server.h"
  58 #include "Session.h"
  59 #include "SpellChecker.h"
  60
  61 #include "frontends/alert.h"
  62 #include "frontends/Application.h"
  63 #include "frontends/KeySymbol.h"
  64 #include "frontends/LyXView.h"
  65 #include "frontends/Selection.h"
  66
  67 #include "support/debug.h"
  68 #include "support/environment.h"
  69 #include "support/FileName.h"
  70 #include "support/filetools.h"
  71 #include "support/gettext.h"
  72 #include "support/lassert.h"
  73 #include "support/lstrings.h"
  74 #include "support/Path.h"
  75 #include "support/Package.h"
  76 #include "support/Systemcall.h"
  77 #include "support/convert.h"
  78 #include "support/os.h"
  79
  80 #include <sstream>
  81 #include <vector>
  82
  83 using namespace std;
  84 using namespace lyx::support;
  85
  86 namespace lyx {
  87
  88 using frontend::LyXView;
  89
  90 namespace Alert = frontend::Alert;
  91
  92 namespace {
  93
  94
  95 // This function runs "configure" and then rereads lyx.defaults to
  96 // reconfigure the automatic settings.
  97 void reconfigure(LyXView * lv, string const & option)
  98 {
  99         // emit message signal.
 100         if (lv)
 101                 lv->message(_("Running configure..."));
 102
 103         // Run configure in user lyx directory
 104         PathChanger p(package().user_support());
 105         string configure_command = package().configure_command();
 106         configure_command += option;
 107         Systemcall one;
 108         int ret = one.startscript(Systemcall::Wait, configure_command);
 109         p.pop();
 110         // emit message signal.
 111         if (lv)
 112                 lv->message(_("Reloading configuration..."));
 113         lyxrc.read(libFileSearch(string(), "lyxrc.defaults"));
 114         // Re-read packages.lst
 115         LaTeXFeatures::getAvailable();
 116
 117         if (ret)
 118                 Alert::information(_("System reconfiguration failed"),
 119                            _("The system reconfiguration has failed.\n"
 120                                   "Default textclass is used but LyX may "
 121                                   "not be able to work properly.\n"
 122                                   "Please reconfigure again if needed."));
 123         else
 124
 125                 Alert::information(_("System reconfigured"),
 126                            _("The system has been reconfigured.\n"
 127                              "You need to restart LyX to make use of any\n"
 128                              "updated document class specifications."));
 129 }
 130
 131 }
 132
 133
 134 LyXFunc::LyXFunc()
 135         : encoded_last_key(0), meta_fake_bit(NoModifier)
 136 {
 137 }
 138
 139
 140 void LyXFunc::initKeySequences(KeyMap * kb)
 141 {
 142         keyseq = KeySequence(kb, kb);
 143         cancel_meta_seq = KeySequence(kb, kb);
 144 }
 145
 146
 147 void LyXFunc::handleKeyFunc(FuncCode action)
 148 {
 149         char_type c = encoded_last_key;
 150
 151         if (keyseq.length())
 152                 c = 0;
 153         LyXView * lv = theApp()->currentWindow();
 154         LASSERT(lv && lv->currentBufferView(), /**/);
 155         BufferView * bv = lv->currentBufferView();
 156         bv->getIntl().getTransManager().deadkey(
 157                 c, get_accent(action).accent, bv->cursor().innerText(),
 158                 bv->cursor());
 159         // Need to clear, in case the minibuffer calls these
 160         // actions
 161         keyseq.clear();
 162         // copied verbatim from do_accent_char
 163         bv->cursor().resetAnchor();
 164         bv->processUpdateFlags(Update::FitCursor);
 165 }
 166
 167 //FIXME: bookmark handling is a frontend issue. This code should be transferred
 168 // to GuiView and be GuiView and be window dependent.
 169 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
 170 {
 171         LyXView * lv = theApp()->currentWindow();
 172         LASSERT(lv, /**/);
 173         if (!theSession().bookmarks().isValid(idx))
 174                 return;
 175         BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
 176         LASSERT(!bm.filename.empty(), /**/);
 177         string const file = bm.filename.absFilename();
 178         // if the file is not opened, open it.
 179         if (!theBufferList().exists(bm.filename)) {
 180                 if (openFile)
 181                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
 182                 else
 183                         return;
 184         }
 185         // open may fail, so we need to test it again
 186         if (!theBufferList().exists(bm.filename))
 187                 return;
 188
 189         // bm can be changed when saving
 190         BookmarksSection::Bookmark tmp = bm;
 191
 192         // Special case idx == 0 used for back-from-back jump navigation
 193         if (idx == 0)
 194                 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
 195
 196         // if the current buffer is not that one, switch to it.
 197         if (!lv->documentBufferView()
 198                 || lv->documentBufferView()->buffer().fileName() != tmp.filename) {
 199                 if (!switchToBuffer)
 200                         return;
 201                 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
 202         }
 203
 204         // moveToPosition try paragraph id first and then paragraph (pit, pos).
 205         if (!lv->documentBufferView()->moveToPosition(
 206                 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
 207                 return;
 208
 209         // bm changed
 210         if (idx == 0)
 211                 return;
 212
 213         // Cursor jump succeeded!
 214         Cursor const & cur = lv->documentBufferView()->cursor();
 215         pit_type new_pit = cur.pit();
 216         pos_type new_pos = cur.pos();
 217         int new_id = cur.paragraph().id();
 218
 219         // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
 220         // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
 221         if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
 222                 || bm.top_id != new_id) {
 223                 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
 224                         new_pit, new_pos, new_id);
 225         }
 226 }
 227
 228
 229 void LyXFunc::processKeySym(KeySymbol const & keysym, KeyModifier state)
 230 {
 231         LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
 232
 233         LyXView * lv = theApp()->currentWindow();
 234
 235         // Do nothing if we have nothing (JMarc)
 236         if (!keysym.isOK()) {
 237                 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
 238                 lv->restartCursor();
 239                 return;
 240         }
 241
 242         if (keysym.isModifier()) {
 243                 LYXERR(Debug::KEY, "isModifier true");
 244                 if (lv)
 245                         lv->restartCursor();
 246                 return;
 247         }
 248
 249         //Encoding const * encoding = lv->documentBufferView()->cursor().getEncoding();
 250         //encoded_last_key = keysym.getISOEncoded(encoding ? encoding->name() : "");
 251         // FIXME: encoded_last_key shadows the member variable of the same
 252         // name. Is that intended?
 253         char_type encoded_last_key = keysym.getUCSEncoded();
 254
 255         // Do a one-deep top-level lookup for
 256         // cancel and meta-fake keys. RVDK_PATCH_5
 257         cancel_meta_seq.reset();
 258
 259         FuncRequest func = cancel_meta_seq.addkey(keysym, state);
 260         LYXERR(Debug::KEY, "action first set to [" << func.action << ']');
 261
 262         // When not cancel or meta-fake, do the normal lookup.
 263         // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
 264         // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
 265         if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
 266                 // remove Caps Lock and Mod2 as a modifiers
 267                 func = keyseq.addkey(keysym, (state | meta_fake_bit));
 268                 LYXERR(Debug::KEY, "action now set to [" << func.action << ']');
 269         }
 270
 271         // Dont remove this unless you know what you are doing.
 272         meta_fake_bit = NoModifier;
 273
 274         // Can this happen now ?
 275         if (func.action == LFUN_NOACTION)
 276                 func = FuncRequest(LFUN_COMMAND_PREFIX);
 277
 278         LYXERR(Debug::KEY, " Key [action=" << func.action << "]["
 279                 << keyseq.print(KeySequence::Portable) << ']');
 280
 281         // already here we know if it any point in going further
 282         // why not return already here if action == -1 and
 283         // num_bytes == 0? (Lgb)
 284
 285         if (keyseq.length() > 1)
 286                 lv->message(keyseq.print(KeySequence::ForGui));
 287
 288
 289         // Maybe user can only reach the key via holding down shift.
 290         // Let's see. But only if shift is the only modifier
 291         if (func.action == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
 292                 LYXERR(Debug::KEY, "Trying without shift");
 293                 func = keyseq.addkey(keysym, NoModifier);
 294                 LYXERR(Debug::KEY, "Action now " << func.action);
 295         }
 296
 297         if (func.action == LFUN_UNKNOWN_ACTION) {
 298                 // Hmm, we didn't match any of the keysequences. See
 299                 // if it's normal insertable text not already covered
 300                 // by a binding
 301                 if (keysym.isText() && keyseq.length() == 1) {
 302                         LYXERR(Debug::KEY, "isText() is true, inserting.");
 303                         func = FuncRequest(LFUN_SELF_INSERT,
 304                                            FuncRequest::KEYBOARD);
 305                 } else {
 306                         LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
 307                         lv->message(_("Unknown function."));
 308                         lv->restartCursor();
 309                         return;
 310                 }
 311         }
 312
 313         if (func.action == LFUN_SELF_INSERT) {
 314                 if (encoded_last_key != 0) {
 315                         docstring const arg(1, encoded_last_key);
 316                         dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
 317                                              FuncRequest::KEYBOARD));
 318                         LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
 319                 }
 320         } else {
 321                 dispatch(func);
 322                 if (!lv)
 323                         return;
 324         }
 325 }
 326
 327
 328 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
 329 {
 330         //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
 331         FuncStatus flag;
 332
 333         if (cmd.action == LFUN_NOACTION) {
 334                 flag.message(from_utf8(N_("Nothing to do")));
 335                 flag.setEnabled(false);
 336                 return flag;
 337         }
 338
 339         switch (cmd.action) {
 340         case LFUN_UNKNOWN_ACTION:
 341                 flag.unknown(true);
 342                 flag.setEnabled(false);
 343                 break;
 344
 345         default:
 346                 break;
 347         }
 348
 349         if (flag.unknown()) {
 350                 flag.message(from_utf8(N_("Unknown action")));
 351                 return flag;
 352         }
 353
 354         if (!flag.enabled()) {
 355                 if (flag.message().empty())
 356                         flag.message(from_utf8(N_("Command disabled")));
 357                 return flag;
 358         }
 359
 360         // I would really like to avoid having this switch and rather try to
 361         // encode this in the function itself.
 362         // -- And I'd rather let an inset decide which LFUNs it is willing
 363         // to handle (Andre')
 364         bool enable = true;
 365         switch (cmd.action) {
 366
 367         // This could be used for the no-GUI version. The GUI version is handled in
 368         // LyXView::getStatus(). See above.
 369         /*
 370         case LFUN_BUFFER_WRITE:
 371         case LFUN_BUFFER_WRITE_AS: {
 372                 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
 373                 enable = b && (b->isUnnamed() || !b->isClean());
 374                 break;
 375         }
 376         */
 377
 378         case LFUN_BOOKMARK_GOTO: {
 379                 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
 380                 enable = theSession().bookmarks().isValid(num);
 381                 break;
 382         }
 383
 384         case LFUN_BOOKMARK_CLEAR:
 385                 enable = theSession().bookmarks().hasValid();
 386                 break;
 387
 388         // this one is difficult to get right. As a half-baked
 389         // solution, we consider only the first action of the sequence
 390         case LFUN_COMMAND_SEQUENCE: {
 391                 // argument contains ';'-terminated commands
 392                 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
 393                 FuncRequest func(lyxaction.lookupFunc(firstcmd));
 394                 func.origin = cmd.origin;
 395                 flag = getStatus(func);
 396                 break;
 397         }
 398
 399         // we want to check if at least one of these is enabled
 400         case LFUN_COMMAND_ALTERNATIVES: {
 401                 // argument contains ';'-terminated commands
 402                 string arg = to_utf8(cmd.argument());
 403                 while (!arg.empty()) {
 404                         string first;
 405                         arg = split(arg, first, ';');
 406                         FuncRequest func(lyxaction.lookupFunc(first));
 407                         func.origin = cmd.origin;
 408                         flag = getStatus(func);
 409                         // if this one is enabled, the whole thing is
 410                         if (flag.enabled())
 411                                 break;
 412                 }
 413                 break;
 414         }
 415
 416         case LFUN_CALL: {
 417                 FuncRequest func;
 418                 string name = to_utf8(cmd.argument());
 419                 if (theTopLevelCmdDef().lock(name, func)) {
 420                         func.origin = cmd.origin;
 421                         flag = getStatus(func);
 422                         theTopLevelCmdDef().release(name);
 423                 } else {
 424                         // catch recursion or unknown command
 425                         // definition. all operations until the
 426                         // recursion or unknown command definition
 427                         // occurs are performed, so set the state to
 428                         // enabled
 429                         enable = true;
 430                 }
 431                 break;
 432         }
 433
 434         case LFUN_COMMAND_PREFIX:
 435         case LFUN_CANCEL:
 436         case LFUN_META_PREFIX:
 437         case LFUN_RECONFIGURE:
 438         case LFUN_DROP_LAYOUTS_CHOICE:
 439         case LFUN_SERVER_GET_FILENAME:
 440         case LFUN_SERVER_NOTIFY:
 441         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
 442         case LFUN_REPEAT:
 443         case LFUN_PREFERENCES_SAVE:
 444         case LFUN_INSET_EDIT:
 445         case LFUN_BUFFER_SAVE_AS_DEFAULT:
 446         case LFUN_LYXRC_APPLY:
 447                 // these are handled in our dispatch()
 448                 break;
 449
 450         default:
 451                 if (!theApp()) {
 452                         enable = false;
 453                         break;
 454                 }
 455                 if (theApp()->getStatus(cmd, flag))
 456                         break;
 457
 458                 // Does the view know something?
 459                 LyXView * lv = theApp()->currentWindow();
 460                 if (!lv) {
 461                         enable = false;
 462                         break;
 463                 }
 464                 if (lv->getStatus(cmd, flag))
 465                         break;
 466
 467                 BufferView * bv = lv->currentBufferView();
 468                 BufferView * doc_bv = lv->documentBufferView();
 469                 // If we do not have a BufferView, then other functions are disabled
 470                 if (!bv) {
 471                         enable = false;
 472                         break;
 473                 }
 474                 // try the BufferView
 475                 bool decided = bv->getStatus(cmd, flag);
 476                 if (!decided)
 477                         // try the Buffer
 478                         decided = bv->buffer().getStatus(cmd, flag);
 479                 if (!decided && doc_bv)
 480                         // try the Document Buffer
 481                         decided = doc_bv->buffer().getStatus(cmd, flag);
 482         }
 483
 484         if (!enable)
 485                 flag.setEnabled(false);
 486
 487         // the default error message if we disable the command
 488         if (!flag.enabled() && flag.message().empty())
 489                 flag.message(from_utf8(N_("Command disabled")));
 490
 491         return flag;
 492 }
 493
 494 /// send a post-dispatch status message
 495 static docstring sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
 496 {
 497         const bool verbose = (cmd.origin == FuncRequest::MENU
 498                               || cmd.origin == FuncRequest::TOOLBAR
 499                               || cmd.origin == FuncRequest::COMMANDBUFFER);
 500
 501         if (cmd.action == LFUN_SELF_INSERT || !verbose) {
 502                 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
 503                 return msg;
 504         }
 505
 506         docstring dispatch_msg = msg;
 507         if (!dispatch_msg.empty())
 508                 dispatch_msg += ' ';
 509
 510         docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
 511
 512         bool argsadded = false;
 513
 514         if (!cmd.argument().empty()) {
 515                 if (cmd.action != LFUN_UNKNOWN_ACTION) {
 516                         comname += ' ' + cmd.argument();
 517                         argsadded = true;
 518                 }
 519         }
 520         docstring const shortcuts = theTopLevelKeymap().
 521                 printBindings(cmd, KeySequence::ForGui);
 522
 523         if (!shortcuts.empty())
 524                 comname += ": " + shortcuts;
 525         else if (!argsadded && !cmd.argument().empty())
 526                 comname += ' ' + cmd.argument();
 527
 528         if (!comname.empty()) {
 529                 comname = rtrim(comname);
 530                 dispatch_msg += '(' + rtrim(comname) + ')';
 531         }
 532         LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
 533         return dispatch_msg;
 534 }
 535
 536
 537 void LyXFunc::dispatch(FuncRequest const & cmd)
 538 {
 539         string const argument = to_utf8(cmd.argument());
 540         FuncCode const action = cmd.action;
 541
 542         LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
 543         //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
 544
 545         // we have not done anything wrong yet.
 546         errorstat = false;
 547         dispatch_buffer.erase();
 548
 549         // redraw the screen at the end (first of the two drawing steps).
 550         //This is done unless explicitely requested otherwise
 551         Update::flags updateFlags = Update::FitCursor;
 552
 553         LyXView * lv = theApp()->currentWindow();
 554
 555         FuncStatus const flag = getStatus(cmd);
 556         if (!flag.enabled()) {
 557                 // We cannot use this function here
 558                 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
 559                        << lyxaction.getActionName(action)
 560                        << " [" << action << "] is disabled at this location");
 561                 setErrorMessage(flag.message());
 562                 if (lv)
 563                         lv->restartCursor();
 564         } else {
 565                 switch (action) {
 566
 567                 case LFUN_COMMAND_PREFIX:
 568                         dispatch(FuncRequest(LFUN_MESSAGE, keyseq.printOptions(true)));
 569                         break;
 570
 571                 case LFUN_CANCEL:
 572                         keyseq.reset();
 573                         meta_fake_bit = NoModifier;
 574                         if (lv && lv->currentBufferView())
 575                                 // cancel any selection
 576                                 dispatch(FuncRequest(LFUN_MARK_OFF));
 577                         setMessage(from_ascii(N_("Cancel")));
 578                         break;
 579
 580                 case LFUN_META_PREFIX:
 581                         meta_fake_bit = AltModifier;
 582                         setMessage(keyseq.print(KeySequence::ForGui));
 583                         break;
 584
 585                 // --- Menus -----------------------------------------------
 586                 case LFUN_RECONFIGURE:
 587                         // argument is any additional parameter to the configure.py command
 588                         reconfigure(lv, argument);
 589                         break;
 590
 591                 // --- lyxserver commands ----------------------------
 592                 case LFUN_SERVER_GET_FILENAME: {
 593                         LASSERT(lv && lv->documentBufferView(), return);
 594                         docstring const fname = from_utf8(
 595                                 lv->documentBufferView()->buffer().absFileName());
 596                         setMessage(fname);
 597                         LYXERR(Debug::INFO, "FNAME[" << fname << ']');
 598                         break;
 599                 }
 600                 case LFUN_SERVER_NOTIFY:
 601                         dispatch_buffer = keyseq.print(KeySequence::Portable);
 602                         theServer().notifyClient(to_utf8(dispatch_buffer));
 603                         break;
 604
 605                 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
 606                         lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
 607                         break;
 608
 609                 case LFUN_REPEAT: {
 610                         // repeat command
 611                         string countstr;
 612                         string rest = split(argument, countstr, ' ');
 613                         istringstream is(countstr);
 614                         int count = 0;
 615                         is >> count;
 616                         //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
 617                         for (int i = 0; i < count; ++i)
 618                                 dispatch(lyxaction.lookupFunc(rest));
 619                         break;
 620                 }
 621
 622                 case LFUN_COMMAND_SEQUENCE: {
 623                         // argument contains ';'-terminated commands
 624                         string arg = argument;
 625                         // FIXME: this LFUN should also work without any view.
 626                         Buffer * buffer = (lv && lv->documentBufferView())
 627                                 ? &(lv->documentBufferView()->buffer()) : 0;
 628                         buffer = &lv->currentBufferView()->buffer();
 629                         if (buffer && !theBufferList().isLoaded(buffer))
 630                                 buffer = 0;
 631                         if (buffer)
 632                                 buffer->undo().beginUndoGroup();
 633                         while (!arg.empty()) {
 634                                 string first;
 635                                 arg = split(arg, first, ';');
 636                                 FuncRequest func(lyxaction.lookupFunc(first));
 637                                 func.origin = cmd.origin;
 638                                 dispatch(func);
 639                         }
 640                         if (buffer)
 641                                 buffer->undo().endUndoGroup();
 642                         break;
 643                 }
 644
 645                 case LFUN_COMMAND_ALTERNATIVES: {
 646                         // argument contains ';'-terminated commands
 647                         string arg = argument;
 648                         while (!arg.empty()) {
 649                                 string first;
 650                                 arg = split(arg, first, ';');
 651                                 FuncRequest func(lyxaction.lookupFunc(first));
 652                                 func.origin = cmd.origin;
 653                                 FuncStatus stat = getStatus(func);
 654                                 if (stat.enabled()) {
 655                                         dispatch(func);
 656                                         break;
 657                                 }
 658                         }
 659                         break;
 660                 }
 661
 662                 case LFUN_CALL: {
 663                         FuncRequest func;
 664                         if (theTopLevelCmdDef().lock(argument, func)) {
 665                                 func.origin = cmd.origin;
 666                                 dispatch(func);
 667                                 theTopLevelCmdDef().release(argument);
 668                         } else {
 669                                 if (func.action == LFUN_UNKNOWN_ACTION) {
 670                                         // unknown command definition
 671                                         lyxerr << "Warning: unknown command definition `"
 672                                                    << argument << "'"
 673                                                    << endl;
 674                                 } else {
 675                                         // recursion detected
 676                                         lyxerr << "Warning: Recursion in the command definition `"
 677                                                    << argument << "' detected"
 678                                                    << endl;
 679                                 }
 680                         }
 681                         break;
 682                 }
 683
 684                 case LFUN_PREFERENCES_SAVE: {
 685                         lyxrc.write(makeAbsPath("preferences",
 686                                                 package().user_support().absFilename()),
 687                                     false);
 688                         break;
 689                 }
 690
 691                 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
 692                         string const fname =
 693                                 addName(addPath(package().user_support().absFilename(), "templates/"),
 694                                         "defaults.lyx");
 695                         Buffer defaults(fname);
 696
 697                         istringstream ss(argument);
 698                         Lexer lex;
 699                         lex.setStream(ss);
 700                         int const unknown_tokens = defaults.readHeader(lex);
 701
 702                         if (unknown_tokens != 0) {
 703                                 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
 704                                        << unknown_tokens << " unknown token"
 705                                        << (unknown_tokens == 1 ? "" : "s")
 706                                        << endl;
 707                         }
 708
 709                         if (defaults.writeFile(FileName(defaults.absFileName())))
 710                                 setMessage(bformat(_("Document defaults saved in %1$s"),
 711                                                    makeDisplayPath(fname)));
 712                         else
 713                                 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
 714                         break;
 715                 }
 716
 717                 case LFUN_LYXRC_APPLY: {
 718                         // reset active key sequences, since the bindings
 719                         // are updated (bug 6064)
 720                         keyseq.reset();
 721                         LyXRC const lyxrc_orig = lyxrc;
 722
 723                         istringstream ss(argument);
 724                         bool const success = lyxrc.read(ss) == 0;
 725
 726                         if (!success) {
 727                                 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
 728                                        << "Unable to read lyxrc data"
 729                                        << endl;
 730                                 break;
 731                         }
 732
 733                         actOnUpdatedPrefs(lyxrc_orig, lyxrc);
 734
 735                         setSpellChecker();
 736
 737                         theApp()->resetGui();
 738
 739                         /// We force the redraw in any case because there might be
 740                         /// some screen font changes.
 741                         /// FIXME: only the current view will be updated. the Gui
 742                         /// class is able to furnish the list of views.
 743                         updateFlags = Update::Force;
 744                         break;
 745                 }
 746
 747                 case LFUN_BOOKMARK_GOTO:
 748                         // go to bookmark, open unopened file and switch to buffer if necessary
 749                         gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
 750                         updateFlags = Update::FitCursor;
 751                         break;
 752
 753                 case LFUN_BOOKMARK_CLEAR:
 754                         theSession().bookmarks().clear();
 755                         break;
 756
 757                 default:
 758                         LASSERT(theApp(), /**/);
 759                         // Let the frontend dispatch its own actions.
 760                         if (theApp()->dispatch(cmd))
 761                                 // Nothing more to do.
 762                                 return;
 763
 764                         // Everything below is only for active window
 765                         if (lv == 0)
 766                                 break;
 767
 768                         // Let the current LyXView dispatch its own actions.
 769                         if (lv->dispatch(cmd)) {
 770                                 BufferView * bv = lv->currentBufferView();
 771                                 if (bv)
 772                                         updateFlags = bv->cursor().result().update();
 773                                 break;
 774                         }
 775
 776                         BufferView * bv = lv->currentBufferView();
 777                         LASSERT(bv, /**/);
 778
 779                         // Let the current BufferView dispatch its own actions.
 780                         if (bv->dispatch(cmd)) {
 781                                 // The BufferView took care of its own updates if needed.
 782                                 updateFlags = Update::None;
 783                                 break;
 784                         }
 785
 786                         BufferView * doc_bv = lv->documentBufferView();
 787                         // Try with the document BufferView dispatch if any.
 788                         if (doc_bv && doc_bv->dispatch(cmd)) {
 789                                 updateFlags = Update::None;
 790                                 break;
 791                         }
 792
 793                         // OK, so try the current Buffer itself...
 794                         DispatchResult dr;
 795                         bv->buffer().dispatch(cmd, dr);
 796                         if (dr.dispatched()) {
 797                                 updateFlags = dr.update();
 798                                 break;
 799                         }
 800                         // and with the document Buffer.
 801                         if (doc_bv) {
 802                                 doc_bv->buffer().dispatch(cmd, dr);
 803                                 if (dr.dispatched()) {
 804                                         updateFlags = dr.update();
 805                                         break;
 806                                 }
 807                         }
 808
 809                         // Is this a function that acts on inset at point?
 810                         Inset * inset = bv->cursor().nextInset();
 811                         if (lyxaction.funcHasFlag(action, LyXAction::AtPoint)
 812                             && inset) {
 813                                 bv->cursor().result().dispatched(true);
 814                                 bv->cursor().result().update(Update::FitCursor | Update::Force);
 815                                 FuncRequest tmpcmd = cmd;
 816                                 inset->dispatch(bv->cursor(), tmpcmd);
 817                                 if (bv->cursor().result().dispatched()) {
 818                                         updateFlags = bv->cursor().result().update();
 819                                         break;
 820                                 }
 821                         }
 822
 823                         // Let the current Cursor dispatch its own actions.
 824                         Cursor old = bv->cursor();
 825                         bv->cursor().getPos(cursorPosBeforeDispatchX_,
 826                                                 cursorPosBeforeDispatchY_);
 827                         bv->cursor().dispatch(cmd);
 828
 829                         // notify insets we just left
 830                         if (bv->cursor() != old) {
 831                                 old.fixIfBroken();
 832                                 bool badcursor = notifyCursorLeavesOrEnters(old, bv->cursor());
 833                                 if (badcursor)
 834                                         bv->cursor().fixIfBroken();
 835                         }
 836
 837                         // update completion. We do it here and not in
 838                         // processKeySym to avoid another redraw just for a
 839                         // changed inline completion
 840                         if (cmd.origin == FuncRequest::KEYBOARD) {
 841                                 if (cmd.action == LFUN_SELF_INSERT
 842                                     || (cmd.action == LFUN_ERT_INSERT && bv->cursor().inMathed()))
 843                                         lv->updateCompletion(bv->cursor(), true, true);
 844                                 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
 845                                         lv->updateCompletion(bv->cursor(), false, true);
 846                                 else
 847                                         lv->updateCompletion(bv->cursor(), false, false);
 848                         }
 849
 850                         updateFlags = bv->cursor().result().update();
 851                 }
 852
 853                 // if we executed a mutating lfun, mark the buffer as dirty
 854                 Buffer * doc_buffer = (lv && lv->documentBufferView())
 855                         ? &(lv->documentBufferView()->buffer()) : 0;
 856                 if (doc_buffer && theBufferList().isLoaded(doc_buffer)
 857                         && flag.enabled()
 858                     && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
 859                     && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
 860                         doc_buffer->markDirty();
 861
 862                 if (lv && lv->currentBufferView()) {
 863                         // BufferView::update() updates the ViewMetricsInfo and
 864                         // also initializes the position cache for all insets in
 865                         // (at least partially) visible top-level paragraphs.
 866                         // We will redraw the screen only if needed.
 867                         lv->currentBufferView()->processUpdateFlags(updateFlags);
 868
 869                         // Do we have a selection?
 870                         theSelection().haveSelection(
 871                                 lv->currentBufferView()->cursor().selection());
 872
 873                         // update gui
 874                         lv->restartCursor();
 875                 }
 876         }
 877         if (lv) {
 878                 // Some messages may already be translated, so we cannot use _()
 879                 lv->message(sendDispatchMessage(
 880                         translateIfPossible(getMessage()), cmd));
 881         }
 882 }
 883
 884
 885 // Each LyXView should have it's own message method. lyxview and
 886 // the minibuffer would use the minibuffer, but lyxserver would
 887 // send an ERROR signal to its client.  Alejandro 970603
 888 // This function is bit problematic when it comes to NLS, to make the
 889 // lyx servers client be language indepenent we must not translate
 890 // strings sent to this func.
 891 void LyXFunc::setErrorMessage(docstring const & m) const
 892 {
 893         dispatch_buffer = m;
 894         errorstat = true;
 895 }
 896
 897
 898 void LyXFunc::setMessage(docstring const & m) const
 899 {
 900         dispatch_buffer = m;
 901 }
 902
 903
 904 docstring LyXFunc::viewStatusMessage()
 905 {
 906         // When meta-fake key is pressed, show the key sequence so far + "M-".
 907         if (wasMetaKey())
 908                 return keyseq.print(KeySequence::ForGui) + "M-";
 909
 910         // Else, when a non-complete key sequence is pressed,
 911         // show the available options.
 912         if (keyseq.length() > 0 && !keyseq.deleted())
 913                 return keyseq.printOptions(true);
 914
 915         return docstring();
 916 }
 917
 918
 919 bool LyXFunc::wasMetaKey() const
 920 {
 921         return (meta_fake_bit != NoModifier);
 922 }
 923
 924
 925 namespace {
 926
 927 } // namespace anon
 928 } // namespace lyx