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 "KeyMap.h"
  44 #include "Language.h"
  45 #include "Lexer.h"
  46 #include "LyXAction.h"
  47 #include "lyxfind.h"
  48 #include "LyX.h"
  49 #include "LyXRC.h"
  50 #include "LyXVC.h"
  51 #include "Paragraph.h"
  52 #include "ParagraphParameters.h"
  53 #include "ParIterator.h"
  54 #include "Row.h"
  55 #include "Session.h"
  56 #include "SpellChecker.h"
  57
  58 #include "frontends/alert.h"
  59 #include "frontends/Application.h"
  60 #include "frontends/KeySymbol.h"
  61 #include "frontends/LyXView.h"
  62 #include "frontends/Selection.h"
  63
  64 #include "support/debug.h"
  65 #include "support/environment.h"
  66 #include "support/FileName.h"
  67 #include "support/filetools.h"
  68 #include "support/gettext.h"
  69 #include "support/lassert.h"
  70 #include "support/lstrings.h"
  71 #include "support/Package.h"
  72 #include "support/convert.h"
  73 #include "support/os.h"
  74
  75 #include <sstream>
  76 #include <vector>
  77
  78 using namespace std;
  79 using namespace lyx::support;
  80
  81 namespace lyx {
  82
  83 using frontend::LyXView;
  84
  85 namespace Alert = frontend::Alert;
  86
  87 LyXFunc::LyXFunc()
  88 {
  89 }
  90
  91
  92 //FIXME: bookmark handling is a frontend issue. This code should be transferred
  93 // to GuiView and be GuiView and be window dependent.
  94 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
  95 {
  96         LyXView * lv = theApp()->currentWindow();
  97         LASSERT(lv, /**/);
  98         if (!theSession().bookmarks().isValid(idx))
  99                 return;
 100         BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
 101         LASSERT(!bm.filename.empty(), /**/);
 102         string const file = bm.filename.absFilename();
 103         // if the file is not opened, open it.
 104         if (!theBufferList().exists(bm.filename)) {
 105                 if (openFile)
 106                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
 107                 else
 108                         return;
 109         }
 110         // open may fail, so we need to test it again
 111         if (!theBufferList().exists(bm.filename))
 112                 return;
 113
 114         // bm can be changed when saving
 115         BookmarksSection::Bookmark tmp = bm;
 116
 117         // Special case idx == 0 used for back-from-back jump navigation
 118         if (idx == 0)
 119                 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
 120
 121         // if the current buffer is not that one, switch to it.
 122         if (!lv->documentBufferView()
 123                 || lv->documentBufferView()->buffer().fileName() != tmp.filename) {
 124                 if (!switchToBuffer)
 125                         return;
 126                 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
 127         }
 128
 129         // moveToPosition try paragraph id first and then paragraph (pit, pos).
 130         if (!lv->documentBufferView()->moveToPosition(
 131                 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
 132                 return;
 133
 134         // bm changed
 135         if (idx == 0)
 136                 return;
 137
 138         // Cursor jump succeeded!
 139         Cursor const & cur = lv->documentBufferView()->cursor();
 140         pit_type new_pit = cur.pit();
 141         pos_type new_pos = cur.pos();
 142         int new_id = cur.paragraph().id();
 143
 144         // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
 145         // see http://www.lyx.org/trac/ticket/3092
 146         if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
 147                 || bm.top_id != new_id) {
 148                 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
 149                         new_pit, new_pos, new_id);
 150         }
 151 }
 152
 153
 154 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
 155 {
 156         //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
 157         FuncStatus flag;
 158
 159         if (cmd.action == LFUN_NOACTION) {
 160                 flag.message(from_utf8(N_("Nothing to do")));
 161                 flag.setEnabled(false);
 162                 return flag;
 163         }
 164
 165         if (cmd.action == LFUN_UNKNOWN_ACTION) {
 166                 flag.unknown(true);
 167                 flag.setEnabled(false);
 168                 flag.message(from_utf8(N_("Unknown action")));
 169                 return flag;
 170         }
 171
 172         // I would really like to avoid having this switch and rather try to
 173         // encode this in the function itself.
 174         // -- And I'd rather let an inset decide which LFUNs it is willing
 175         // to handle (Andre')
 176         bool enable = true;
 177         switch (cmd.action) {
 178
 179         // This could be used for the no-GUI version. The GUI version is handled in
 180         // LyXView::getStatus(). See above.
 181         /*
 182         case LFUN_BUFFER_WRITE:
 183         case LFUN_BUFFER_WRITE_AS: {
 184                 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
 185                 enable = b && (b->isUnnamed() || !b->isClean());
 186                 break;
 187         }
 188         */
 189
 190         case LFUN_BOOKMARK_GOTO: {
 191                 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
 192                 enable = theSession().bookmarks().isValid(num);
 193                 break;
 194         }
 195
 196         case LFUN_BOOKMARK_CLEAR:
 197                 enable = theSession().bookmarks().hasValid();
 198                 break;
 199
 200         // this one is difficult to get right. As a half-baked
 201         // solution, we consider only the first action of the sequence
 202         case LFUN_COMMAND_SEQUENCE: {
 203                 // argument contains ';'-terminated commands
 204                 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
 205                 FuncRequest func(lyxaction.lookupFunc(firstcmd));
 206                 func.origin = cmd.origin;
 207                 flag = getStatus(func);
 208                 break;
 209         }
 210
 211         // we want to check if at least one of these is enabled
 212         case LFUN_COMMAND_ALTERNATIVES: {
 213                 // argument contains ';'-terminated commands
 214                 string arg = to_utf8(cmd.argument());
 215                 while (!arg.empty()) {
 216                         string first;
 217                         arg = split(arg, first, ';');
 218                         FuncRequest func(lyxaction.lookupFunc(first));
 219                         func.origin = cmd.origin;
 220                         flag = getStatus(func);
 221                         // if this one is enabled, the whole thing is
 222                         if (flag.enabled())
 223                                 break;
 224                 }
 225                 break;
 226         }
 227
 228         case LFUN_CALL: {
 229                 FuncRequest func;
 230                 string name = to_utf8(cmd.argument());
 231                 if (theTopLevelCmdDef().lock(name, func)) {
 232                         func.origin = cmd.origin;
 233                         flag = getStatus(func);
 234                         theTopLevelCmdDef().release(name);
 235                 } else {
 236                         // catch recursion or unknown command
 237                         // definition. all operations until the
 238                         // recursion or unknown command definition
 239                         // occurs are performed, so set the state to
 240                         // enabled
 241                         enable = true;
 242                 }
 243                 break;
 244         }
 245
 246         case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
 247         case LFUN_REPEAT:
 248         case LFUN_PREFERENCES_SAVE:
 249         case LFUN_BUFFER_SAVE_AS_DEFAULT:
 250         case LFUN_DEBUG_LEVEL_SET:
 251                 // these are handled in our dispatch()
 252                 break;
 253
 254         default:
 255                 if (!theApp()) {
 256                         enable = false;
 257                         break;
 258                 }
 259                 if (theApp()->getStatus(cmd, flag))
 260                         break;
 261
 262                 // Does the view know something?
 263                 LyXView * lv = theApp()->currentWindow();
 264                 if (!lv) {
 265                         enable = false;
 266                         break;
 267                 }
 268                 if (lv->getStatus(cmd, flag))
 269                         break;
 270
 271                 BufferView * bv = lv->currentBufferView();
 272                 BufferView * doc_bv = lv->documentBufferView();
 273                 // If we do not have a BufferView, then other functions are disabled
 274                 if (!bv) {
 275                         enable = false;
 276                         break;
 277                 }
 278                 // try the BufferView
 279                 bool decided = bv->getStatus(cmd, flag);
 280                 if (!decided)
 281                         // try the Buffer
 282                         decided = bv->buffer().getStatus(cmd, flag);
 283                 if (!decided && doc_bv)
 284                         // try the Document Buffer
 285                         decided = doc_bv->buffer().getStatus(cmd, flag);
 286         }
 287
 288         if (!enable)
 289                 flag.setEnabled(false);
 290
 291         // the default error message if we disable the command
 292         if (!flag.enabled() && flag.message().empty())
 293                 flag.message(from_utf8(N_("Command disabled")));
 294
 295         return flag;
 296 }
 297
 298 /// send a post-dispatch status message
 299 static docstring sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
 300 {
 301         const bool verbose = (cmd.origin == FuncRequest::MENU
 302                               || cmd.origin == FuncRequest::TOOLBAR
 303                               || cmd.origin == FuncRequest::COMMANDBUFFER);
 304
 305         if (cmd.action == LFUN_SELF_INSERT || !verbose) {
 306                 LYXERR(Debug::ACTION, "dispatch msg is " << msg);
 307                 return msg;
 308         }
 309
 310         docstring dispatch_msg = msg;
 311         if (!dispatch_msg.empty())
 312                 dispatch_msg += ' ';
 313
 314         docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
 315
 316         bool argsadded = false;
 317
 318         if (!cmd.argument().empty()) {
 319                 if (cmd.action != LFUN_UNKNOWN_ACTION) {
 320                         comname += ' ' + cmd.argument();
 321                         argsadded = true;
 322                 }
 323         }
 324         docstring const shortcuts = theTopLevelKeymap().
 325                 printBindings(cmd, KeySequence::ForGui);
 326
 327         if (!shortcuts.empty())
 328                 comname += ": " + shortcuts;
 329         else if (!argsadded && !cmd.argument().empty())
 330                 comname += ' ' + cmd.argument();
 331
 332         if (!comname.empty()) {
 333                 comname = rtrim(comname);
 334                 dispatch_msg += '(' + rtrim(comname) + ')';
 335         }
 336         LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
 337         return dispatch_msg;
 338 }
 339
 340
 341 void LyXFunc::dispatch(FuncRequest const & cmd)
 342 {
 343         string const argument = to_utf8(cmd.argument());
 344         FuncCode const action = cmd.action;
 345
 346         LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
 347         //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
 348
 349         // we have not done anything wrong yet.
 350         errorstat = false;
 351         dispatch_buffer.erase();
 352
 353         // redraw the screen at the end (first of the two drawing steps).
 354         //This is done unless explicitely requested otherwise
 355         Update::flags updateFlags = Update::FitCursor;
 356
 357         LyXView * lv = theApp()->currentWindow();
 358
 359         FuncStatus const flag = getStatus(cmd);
 360         if (!flag.enabled()) {
 361                 // We cannot use this function here
 362                 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
 363                        << lyxaction.getActionName(action)
 364                        << " [" << action << "] is disabled at this location");
 365                 setErrorMessage(flag.message());
 366                 if (lv)
 367                         lv->restartCursor();
 368         } else {
 369                 switch (action) {
 370
 371                 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
 372                         lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
 373                         break;
 374
 375                 case LFUN_REPEAT: {
 376                         // repeat command
 377                         string countstr;
 378                         string rest = split(argument, countstr, ' ');
 379                         istringstream is(countstr);
 380                         int count = 0;
 381                         is >> count;
 382                         //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
 383                         for (int i = 0; i < count; ++i)
 384                                 dispatch(lyxaction.lookupFunc(rest));
 385                         break;
 386                 }
 387
 388                 case LFUN_COMMAND_SEQUENCE: {
 389                         // argument contains ';'-terminated commands
 390                         string arg = argument;
 391                         // FIXME: this LFUN should also work without any view.
 392                         Buffer * buffer = (lv && lv->documentBufferView())
 393                                 ? &(lv->documentBufferView()->buffer()) : 0;
 394                         if (buffer)
 395                                 buffer->undo().beginUndoGroup();
 396                         while (!arg.empty()) {
 397                                 string first;
 398                                 arg = split(arg, first, ';');
 399                                 FuncRequest func(lyxaction.lookupFunc(first));
 400                                 func.origin = cmd.origin;
 401                                 dispatch(func);
 402                         }
 403                         // the buffer may have been closed by one action
 404                         if (theBufferList().isLoaded(buffer))
 405                                 buffer->undo().endUndoGroup();
 406                         break;
 407                 }
 408
 409                 case LFUN_COMMAND_ALTERNATIVES: {
 410                         // argument contains ';'-terminated commands
 411                         string arg = argument;
 412                         while (!arg.empty()) {
 413                                 string first;
 414                                 arg = split(arg, first, ';');
 415                                 FuncRequest func(lyxaction.lookupFunc(first));
 416                                 func.origin = cmd.origin;
 417                                 FuncStatus stat = getStatus(func);
 418                                 if (stat.enabled()) {
 419                                         dispatch(func);
 420                                         break;
 421                                 }
 422                         }
 423                         break;
 424                 }
 425
 426                 case LFUN_CALL: {
 427                         FuncRequest func;
 428                         if (theTopLevelCmdDef().lock(argument, func)) {
 429                                 func.origin = cmd.origin;
 430                                 dispatch(func);
 431                                 theTopLevelCmdDef().release(argument);
 432                         } else {
 433                                 if (func.action == LFUN_UNKNOWN_ACTION) {
 434                                         // unknown command definition
 435                                         lyxerr << "Warning: unknown command definition `"
 436                                                    << argument << "'"
 437                                                    << endl;
 438                                 } else {
 439                                         // recursion detected
 440                                         lyxerr << "Warning: Recursion in the command definition `"
 441                                                    << argument << "' detected"
 442                                                    << endl;
 443                                 }
 444                         }
 445                         break;
 446                 }
 447
 448                 case LFUN_PREFERENCES_SAVE: {
 449                         lyxrc.write(makeAbsPath("preferences",
 450                                                 package().user_support().absFilename()),
 451                                     false);
 452                         break;
 453                 }
 454
 455                 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
 456                         string const fname =
 457                                 addName(addPath(package().user_support().absFilename(), "templates/"),
 458                                         "defaults.lyx");
 459                         Buffer defaults(fname);
 460
 461                         istringstream ss(argument);
 462                         Lexer lex;
 463                         lex.setStream(ss);
 464                         int const unknown_tokens = defaults.readHeader(lex);
 465
 466                         if (unknown_tokens != 0) {
 467                                 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
 468                                        << unknown_tokens << " unknown token"
 469                                        << (unknown_tokens == 1 ? "" : "s")
 470                                        << endl;
 471                         }
 472
 473                         if (defaults.writeFile(FileName(defaults.absFileName())))
 474                                 setMessage(bformat(_("Document defaults saved in %1$s"),
 475                                                    makeDisplayPath(fname)));
 476                         else
 477                                 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
 478                         break;
 479                 }
 480
 481                 case LFUN_BOOKMARK_GOTO:
 482                         // go to bookmark, open unopened file and switch to buffer if necessary
 483                         gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
 484                         updateFlags = Update::FitCursor;
 485                         break;
 486
 487                 case LFUN_BOOKMARK_CLEAR:
 488                         theSession().bookmarks().clear();
 489                         break;
 490
 491                 case LFUN_DEBUG_LEVEL_SET:
 492                         lyxerr.setLevel(Debug::value(to_utf8(cmd.argument())));
 493                         break;
 494
 495                 default:
 496                         DispatchResult dr;
 497
 498                         LASSERT(theApp(), /**/);
 499                         // Let the frontend dispatch its own actions.
 500                         theApp()->dispatch(cmd, dr);
 501                         if (dr.dispatched())
 502                                 // Nothing more to do.
 503                                 break;
 504
 505                         // Everything below is only for active window
 506                         if (lv == 0)
 507                                 break;
 508
 509                         // Let the current LyXView dispatch its own actions.
 510                         if (lv->dispatch(cmd)) {
 511                                 BufferView * bv = lv->currentBufferView();
 512                                 if (bv)
 513                                         updateFlags = bv->cursor().result().update();
 514                                 break;
 515                         }
 516
 517                         BufferView * bv = lv->currentBufferView();
 518                         LASSERT(bv, /**/);
 519
 520                         // Let the current BufferView dispatch its own actions.
 521                         if (bv->dispatch(cmd)) {
 522                                 // The BufferView took care of its own updates if needed.
 523                                 updateFlags = Update::None;
 524                                 break;
 525                         }
 526
 527                         BufferView * doc_bv = lv->documentBufferView();
 528                         // Try with the document BufferView dispatch if any.
 529                         if (doc_bv && doc_bv->dispatch(cmd)) {
 530                                 updateFlags = Update::None;
 531                                 break;
 532                         }
 533
 534                         // OK, so try the current Buffer itself...
 535                         bv->buffer().dispatch(cmd, dr);
 536                         if (dr.dispatched()) {
 537                                 updateFlags = dr.update();
 538                                 break;
 539                         }
 540                         // and with the document Buffer.
 541                         if (doc_bv) {
 542                                 doc_bv->buffer().dispatch(cmd, dr);
 543                                 if (dr.dispatched()) {
 544                                         updateFlags = dr.update();
 545                                         break;
 546                                 }
 547                         }
 548
 549                         // Let the current Cursor dispatch its own actions.
 550                         Cursor old = bv->cursor();
 551                         bv->cursor().getPos(cursorPosBeforeDispatchX_,
 552                                                 cursorPosBeforeDispatchY_);
 553                         bv->cursor().dispatch(cmd);
 554
 555                         // notify insets we just left
 556                         if (bv->cursor() != old) {
 557                                 old.fixIfBroken();
 558                                 bool badcursor = notifyCursorLeavesOrEnters(old, bv->cursor());
 559                                 if (badcursor)
 560                                         bv->cursor().fixIfBroken();
 561                         }
 562
 563                         // update completion. We do it here and not in
 564                         // processKeySym to avoid another redraw just for a
 565                         // changed inline completion
 566                         if (cmd.origin == FuncRequest::KEYBOARD) {
 567                                 if (cmd.action == LFUN_SELF_INSERT
 568                                     || (cmd.action == LFUN_ERT_INSERT && bv->cursor().inMathed()))
 569                                         lv->updateCompletion(bv->cursor(), true, true);
 570                                 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
 571                                         lv->updateCompletion(bv->cursor(), false, true);
 572                                 else
 573                                         lv->updateCompletion(bv->cursor(), false, false);
 574                         }
 575
 576                         updateFlags = bv->cursor().result().update();
 577                 }
 578
 579                 // if we executed a mutating lfun, mark the buffer as dirty
 580                 Buffer * doc_buffer = (lv && lv->documentBufferView())
 581                         ? &(lv->documentBufferView()->buffer()) : 0;
 582                 if (doc_buffer && theBufferList().isLoaded(doc_buffer)
 583                         && flag.enabled()
 584                     && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
 585                     && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
 586                         lv->currentBufferView()->buffer().markDirty();
 587
 588                 if (lv && lv->currentBufferView()) {
 589                         // BufferView::update() updates the ViewMetricsInfo and
 590                         // also initializes the position cache for all insets in
 591                         // (at least partially) visible top-level paragraphs.
 592                         // We will redraw the screen only if needed.
 593                         lv->currentBufferView()->processUpdateFlags(updateFlags);
 594
 595                         // Do we have a selection?
 596                         theSelection().haveSelection(
 597                                 lv->currentBufferView()->cursor().selection());
 598
 599                         // update gui
 600                         lv->restartCursor();
 601                 }
 602         }
 603         if (lv) {
 604                 // Some messages may already be translated, so we cannot use _()
 605                 lv->message(sendDispatchMessage(
 606                         translateIfPossible(getMessage()), cmd));
 607         }
 608 }
 609
 610
 611 // Each LyXView should have it's own message method. lyxview and
 612 // the minibuffer would use the minibuffer, but lyxserver would
 613 // send an ERROR signal to its client.  Alejandro 970603
 614 // This function is bit problematic when it comes to NLS, to make the
 615 // lyx servers client be language indepenent we must not translate
 616 // strings sent to this func.
 617 void LyXFunc::setErrorMessage(docstring const & m) const
 618 {
 619         dispatch_buffer = m;
 620         errorstat = true;
 621 }
 622
 623
 624 void LyXFunc::setMessage(docstring const & m) const
 625 {
 626         dispatch_buffer = m;
 627 }
 628
 629
 630 } // namespace lyx