src/lyxfunc.C

   1 /**
   2  * \file lyxfunc.C
   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 "BranchList.h"
  25 #include "buffer.h"
  26 #include "buffer_funcs.h"
  27 #include "bufferlist.h"
  28 #include "bufferparams.h"
  29 #include "BufferView.h"
  30 #include "bufferview_funcs.h"
  31 #include "cursor.h"
  32 #include "CutAndPaste.h"
  33 #include "debug.h"
  34 #include "dispatchresult.h"
  35 #include "encoding.h"
  36 #include "errorlist.h"
  37 #include "exporter.h"
  38 #include "format.h"
  39 #include "funcrequest.h"
  40 #include "FuncStatus.h"
  41 #include "gettext.h"
  42 #include "importer.h"
  43 #include "insetiterator.h"
  44 #include "intl.h"
  45 #include "kbmap.h"
  46 #include "language.h"
  47 #include "LColor.h"
  48 #include "session.h"
  49 #include "lyx_main.h"
  50 #include "lyx_cb.h"
  51 #include "LyXAction.h"
  52 #include "lyxfind.h"
  53 #include "lyxlex.h"
  54 #include "lyxrc.h"
  55 #include "lyxrow.h"
  56 #include "lyxserver.h"
  57 #include "lyxtextclasslist.h"
  58 #include "lyxvc.h"
  59 #include "paragraph.h"
  60 #include "pariterator.h"
  61 #include "ParagraphParameters.h"
  62 #include "undo.h"
  63
  64 #include "insets/insetbox.h"
  65 #include "insets/insetbranch.h"
  66 #include "insets/insetcommand.h"
  67 #include "insets/insetert.h"
  68 #include "insets/insetexternal.h"
  69 #include "insets/insetfloat.h"
  70 #include "insets/insetgraphics.h"
  71 #include "insets/insetinclude.h"
  72 #include "insets/insetnote.h"
  73 #include "insets/insettabular.h"
  74 #include "insets/insetvspace.h"
  75 #include "insets/insetwrap.h"
  76
  77 #include "frontends/Application.h"
  78 #include "frontends/Alert.h"
  79 #include "frontends/Dialogs.h"
  80 #include "frontends/FileDialog.h"
  81 #include "frontends/FontLoader.h"
  82 #include "frontends/Gui.h"
  83 #include "frontends/LyXKeySym.h"
  84 #include "frontends/LyXView.h"
  85 #include "frontends/Menubar.h"
  86 #include "frontends/Toolbars.h"
  87
  88 #include "support/environment.h"
  89 #include "support/filefilterlist.h"
  90 #include "support/filetools.h"
  91 #include "support/forkedcontr.h"
  92 #include "support/fs_extras.h"
  93 #include "support/lstrings.h"
  94 #include "support/path.h"
  95 #include "support/package.h"
  96 #include "support/systemcall.h"
  97 #include "support/convert.h"
  98 #include "support/os.h"
  99
 100 #include <boost/current_function.hpp>
 101 #include <boost/filesystem/operations.hpp>
 102
 103 #include <sstream>
 104
 105
 106 namespace lyx {
 107
 108 using bv_funcs::freefont2string;
 109
 110 using support::absolutePath;
 111 using support::addName;
 112 using support::addPath;
 113 using support::bformat;
 114 using support::changeExtension;
 115 using support::contains;
 116 using support::FileFilterList;
 117 using support::FileName;
 118 using support::fileSearch;
 119 using support::ForkedcallsController;
 120 using support::i18nLibFileSearch;
 121 using support::isDirWriteable;
 122 using support::isFileReadable;
 123 using support::isStrInt;
 124 using support::makeAbsPath;
 125 using support::makeDisplayPath;
 126 using support::package;
 127 using support::quoteName;
 128 using support::rtrim;
 129 using support::split;
 130 using support::subst;
 131 using support::Systemcall;
 132 using support::token;
 133 using support::trim;
 134 using support::prefixIs;
 135
 136 using std::endl;
 137 using std::make_pair;
 138 using std::pair;
 139 using std::string;
 140 using std::istringstream;
 141 using std::ostringstream;
 142
 143 namespace Alert = frontend::Alert;
 144 namespace fs = boost::filesystem;
 145
 146
 147 // (alkis)
 148 extern tex_accent_struct get_accent(kb_action action);
 149
 150
 151 namespace {
 152
 153 bool getLocalStatus(LCursor cursor,
 154                FuncRequest const & cmd, FuncStatus & status)
 155 {
 156         // Try to fix cursor in case it is broken.
 157         cursor.fixIfBroken();
 158
 159         // This is, of course, a mess. Better create a new doc iterator and use
 160         // this in Inset::getStatus. This might require an additional
 161         // BufferView * arg, though (which should be avoided)
 162         //LCursor safe = *this;
 163         bool res = false;
 164         for ( ; cursor.depth(); cursor.pop()) {
 165                 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
 166                 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
 167                 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
 168                 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
 169
 170                 // The inset's getStatus() will return 'true' if it made
 171                 // a definitive decision on whether it want to handle the
 172                 // request or not. The result of this decision is put into
 173                 // the 'status' parameter.
 174                 if (cursor.inset().getStatus(cursor, cmd, status)) {
 175                         res = true;
 176                         break;
 177                 }
 178         }
 179         return res;
 180 }
 181
 182
 183 /** Return the change status at cursor position, taking in account the
 184  * status at each level of the document iterator (a table in a deleted
 185  * footnote is deleted).
 186  * When \param outer is true, the top slice is not looked at.
 187  */
 188 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
 189 {
 190         size_t const depth = dit.depth() - (outer ? 1 : 0);
 191
 192         for (size_t i = 0 ; i < depth ; ++i) {
 193                 CursorSlice const & slice = dit[i];
 194                 if (!slice.inset().inMathed()
 195                     && slice.pos() < slice.paragraph().size()) {
 196                         Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
 197                         if (ch != Change::UNCHANGED)
 198                                 return ch;
 199                 }
 200         }
 201         return Change::UNCHANGED;
 202 }
 203
 204 }
 205
 206 LyXFunc::LyXFunc()
 207         : lyx_view_(0),
 208         encoded_last_key(0),
 209         meta_fake_bit(key_modifier::none)
 210 {
 211 }
 212
 213
 214 void LyXFunc::initKeySequences(kb_keymap * kb)
 215 {
 216         keyseq.reset(new kb_sequence(kb, kb));
 217         cancel_meta_seq.reset(new kb_sequence(kb, kb));
 218 }
 219
 220
 221 void LyXFunc::setLyXView(LyXView * lv)
 222 {
 223         lyx_view_ = lv;
 224 }
 225
 226
 227 void LyXFunc::handleKeyFunc(kb_action action)
 228 {
 229         char_type c = encoded_last_key;
 230
 231         if (keyseq->length())
 232                 c = 0;
 233
 234         lyx_view_->view()->getIntl().getTransManager().deadkey(
 235                 c, get_accent(action).accent, view()->getLyXText(), view()->cursor());
 236         // Need to clear, in case the minibuffer calls these
 237         // actions
 238         keyseq->clear();
 239         // copied verbatim from do_accent_char
 240         view()->cursor().resetAnchor();
 241         view()->update();
 242 }
 243
 244
 245 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
 246 {
 247         BOOST_ASSERT(lyx_view_);
 248         if (!LyX::ref().session().bookmarks().isValid(idx))
 249                 return;
 250         BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(idx);
 251         BOOST_ASSERT(!bm.filename.empty());
 252         string const file = bm.filename.absFilename();
 253         // if the file is not opened, open it.
 254         if (!theBufferList().exists(file)) {
 255                 if (openFile)
 256                         dispatch(FuncRequest(LFUN_FILE_OPEN, file));
 257                 else
 258                         return;
 259         }
 260         // open may fail, so we need to test it again
 261         if (theBufferList().exists(file)) {
 262                 // if the current buffer is not that one, switch to it.
 263                 if (lyx_view_->buffer()->fileName() != file) {
 264                         if (switchToBuffer)
 265                                 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
 266                         else
 267                                 return;
 268                 }
 269                 // moveToPosition use par_id, and par_pit and return new par_id.
 270                 pit_type new_pit;
 271                 int new_id;
 272                 boost::tie(new_pit, new_id) = view()->moveToPosition(bm.par_pit, bm.par_id, bm.par_pos);
 273                 // if par_id or pit has been changed, reset par_pit and par_id
 274                 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
 275                 if (bm.par_pit != new_pit || bm.par_id != new_id)
 276                         const_cast<BookmarksSection::Bookmark &>(bm).setPos(new_pit, new_id);
 277         }
 278 }
 279
 280
 281 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
 282 {
 283         lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
 284
 285         // Do nothing if we have nothing (JMarc)
 286         if (!keysym->isOK()) {
 287                 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
 288                                    << endl;
 289                 return;
 290         }
 291
 292         if (keysym->isModifier()) {
 293                 lyxerr[Debug::KEY] << "isModifier true" << endl;
 294                 return;
 295         }
 296
 297         //Encoding const * encoding = view()->cursor().getEncoding();
 298         //encoded_last_key = keysym->getISOEncoded(encoding ? encoding->name() : "");
 299         // FIXME: encoded_last_key shadows the member variable of the same
 300         // name. Is that intended?
 301         char_type encoded_last_key = keysym->getUCSEncoded();
 302
 303         // Do a one-deep top-level lookup for
 304         // cancel and meta-fake keys. RVDK_PATCH_5
 305         cancel_meta_seq->reset();
 306
 307         FuncRequest func = cancel_meta_seq->addkey(keysym, state);
 308         lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 309                            << " action first set to [" << func.action << ']'
 310                            << endl;
 311
 312         // When not cancel or meta-fake, do the normal lookup.
 313         // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
 314         // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
 315         if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
 316                 // remove Caps Lock and Mod2 as a modifiers
 317                 func = keyseq->addkey(keysym, (state | meta_fake_bit));
 318                 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
 319                                    << "action now set to ["
 320                                    << func.action << ']' << endl;
 321         }
 322
 323         // Dont remove this unless you know what you are doing.
 324         meta_fake_bit = key_modifier::none;
 325
 326         // Can this happen now ?
 327         if (func.action == LFUN_NOACTION) {
 328                 func = FuncRequest(LFUN_COMMAND_PREFIX);
 329         }
 330
 331         if (lyxerr.debugging(Debug::KEY)) {
 332                 lyxerr << BOOST_CURRENT_FUNCTION
 333                        << " Key [action="
 334                        << func.action << "]["
 335                        << to_utf8(keyseq->print(false)) << ']'
 336                        << endl;
 337         }
 338
 339         // already here we know if it any point in going further
 340         // why not return already here if action == -1 and
 341         // num_bytes == 0? (Lgb)
 342
 343         if (keyseq->length() > 1) {
 344                 lyx_view_->message(keyseq->print(true));
 345         }
 346
 347
 348         // Maybe user can only reach the key via holding down shift.
 349         // Let's see. But only if shift is the only modifier
 350         if (func.action == LFUN_UNKNOWN_ACTION &&
 351             state == key_modifier::shift) {
 352                 lyxerr[Debug::KEY] << "Trying without shift" << endl;
 353                 func = keyseq->addkey(keysym, key_modifier::none);
 354                 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
 355         }
 356
 357         if (func.action == LFUN_UNKNOWN_ACTION) {
 358                 // Hmm, we didn't match any of the keysequences. See
 359                 // if it's normal insertable text not already covered
 360                 // by a binding
 361                 if (keysym->isText() && keyseq->length() == 1) {
 362                         lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
 363                         func = FuncRequest(LFUN_SELF_INSERT,
 364                                            FuncRequest::KEYBOARD);
 365                 } else {
 366                         lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
 367                         lyx_view_->message(_("Unknown function."));
 368                         return;
 369                 }
 370         }
 371
 372         if (func.action == LFUN_SELF_INSERT) {
 373                 if (encoded_last_key != 0) {
 374                         docstring const arg(1, encoded_last_key);
 375                         dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
 376                                              FuncRequest::KEYBOARD));
 377                         lyxerr[Debug::KEY]
 378                                 << "SelfInsert arg[`" << to_utf8(arg) << "']" << endl;
 379                 }
 380         } else {
 381                 dispatch(func);
 382         }
 383 }
 384
 385
 386 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
 387 {
 388         //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
 389         FuncStatus flag;
 390
 391         LCursor & cur = view()->cursor();
 392
 393         /* In LyX/Mac, when a dialog is open, the menus of the
 394            application can still be accessed without giving focus to
 395            the main window. In this case, we want to disable the menu
 396            entries that are buffer-related.
 397
 398            Note that this code is not perfect, as bug 1941 attests:
 399            http://bugzilla.lyx.org/show_bug.cgi?id=1941#c4
 400         */
 401         Buffer * buf = lyx_view_? lyx_view_->buffer() : 0;
 402         if (lyx_view_ && cmd.origin == FuncRequest::MENU && !lyx_view_->hasFocus())
 403                 buf = 0;
 404
 405         if (cmd.action == LFUN_NOACTION) {
 406                 flag.message(from_utf8(N_("Nothing to do")));
 407                 flag.enabled(false);
 408                 return flag;
 409         }
 410
 411         switch (cmd.action) {
 412         case LFUN_UNKNOWN_ACTION:
 413 #ifndef HAVE_LIBAIKSAURUS
 414         case LFUN_THESAURUS_ENTRY:
 415 #endif
 416                 flag.unknown(true);
 417                 flag.enabled(false);
 418                 break;
 419
 420         default:
 421                 break;
 422         }
 423
 424         if (flag.unknown()) {
 425                 flag.message(from_utf8(N_("Unknown action")));
 426                 return flag;
 427         }
 428
 429         if (!flag.enabled()) {
 430                 if (flag.message().empty())
 431                         flag.message(from_utf8(N_("Command disabled")));
 432                 return flag;
 433         }
 434
 435         // Check whether we need a buffer
 436         if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
 437                 // no, exit directly
 438                 flag.message(from_utf8(N_("Command not allowed with"
 439                                     "out any document open")));
 440                 flag.enabled(false);
 441                 return flag;
 442         }
 443
 444         // I would really like to avoid having this switch and rather try to
 445         // encode this in the function itself.
 446         // -- And I'd rather let an inset decide which LFUNs it is willing
 447         // to handle (Andre')
 448         bool enable = true;
 449         switch (cmd.action) {
 450         case LFUN_BUFFER_TOGGLE_READ_ONLY:
 451                 flag.setOnOff(buf->isReadonly());
 452                 break;
 453
 454         case LFUN_BUFFER_SWITCH:
 455                 // toggle on the current buffer, but do not toggle off
 456                 // the other ones (is that a good idea?)
 457                 if (to_utf8(cmd.argument()) == buf->fileName())
 458                         flag.setOnOff(true);
 459                 break;
 460
 461         case LFUN_BUFFER_EXPORT:
 462                 enable = cmd.argument() == "custom"
 463                         || Exporter::isExportable(*buf, to_utf8(cmd.argument()));
 464                 break;
 465
 466         case LFUN_BUFFER_CHKTEX:
 467                 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
 468                 break;
 469
 470         case LFUN_BUILD_PROGRAM:
 471                 enable = Exporter::isExportable(*buf, "program");
 472                 break;
 473
 474         case LFUN_LAYOUT_TABULAR:
 475                 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
 476                 break;
 477
 478         case LFUN_LAYOUT:
 479         case LFUN_LAYOUT_PARAGRAPH:
 480                 enable = !cur.inset().forceDefaultParagraphs(cur.idx());
 481                 break;
 482
 483         case LFUN_VC_REGISTER:
 484                 enable = !buf->lyxvc().inUse();
 485                 break;
 486         case LFUN_VC_CHECK_IN:
 487                 enable = buf->lyxvc().inUse() && !buf->isReadonly();
 488                 break;
 489         case LFUN_VC_CHECK_OUT:
 490                 enable = buf->lyxvc().inUse() && buf->isReadonly();
 491                 break;
 492         case LFUN_VC_REVERT:
 493         case LFUN_VC_UNDO_LAST:
 494                 enable = buf->lyxvc().inUse();
 495                 break;
 496         case LFUN_BUFFER_RELOAD:
 497                 enable = !buf->isUnnamed() && !buf->isClean();
 498                 break;
 499
 500         case LFUN_INSET_SETTINGS: {
 501                 enable = false;
 502                 if (!cur)
 503                         break;
 504                 InsetBase::Code code = cur.inset().lyxCode();
 505                 switch (code) {
 506                         case InsetBase::TABULAR_CODE:
 507                                 enable = cmd.argument() == "tabular";
 508                                 break;
 509                         case InsetBase::ERT_CODE:
 510                                 enable = cmd.argument() == "ert";
 511                                 break;
 512                         case InsetBase::FLOAT_CODE:
 513                                 enable = cmd.argument() == "float";
 514                                 break;
 515                         case InsetBase::WRAP_CODE:
 516                                 enable = cmd.argument() == "wrap";
 517                                 break;
 518                         case InsetBase::NOTE_CODE:
 519                                 enable = cmd.argument() == "note";
 520                                 break;
 521                         case InsetBase::BRANCH_CODE:
 522                                 enable = cmd.argument() == "branch";
 523                                 break;
 524                         case InsetBase::BOX_CODE:
 525                                 enable = cmd.argument() == "box";
 526                                 break;
 527                         default:
 528                                 break;
 529                 }
 530                 break;
 531         }
 532
 533         case LFUN_INSET_APPLY: {
 534                 string const name = cmd.getArg(0);
 535                 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
 536                 if (inset) {
 537                         FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
 538                         FuncStatus fs;
 539                         if (!inset->getStatus(cur, fr, fs)) {
 540                                 // Every inset is supposed to handle this
 541                                 BOOST_ASSERT(false);
 542                         }
 543                         flag |= fs;
 544                 } else {
 545                         FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
 546                         flag |= getStatus(fr);
 547                 }
 548                 enable = flag.enabled();
 549                 break;
 550         }
 551
 552         case LFUN_DIALOG_SHOW: {
 553                 string const name = cmd.getArg(0);
 554                 if (!buf)
 555                         enable = name == "aboutlyx"
 556                                 || name == "file"
 557                                 || name == "forks"
 558                                 || name == "prefs"
 559                                 || name == "texinfo";
 560                 else if (name == "print")
 561                         enable = Exporter::isExportable(*buf, "dvi")
 562                                 && lyxrc.print_command != "none";
 563                 else if (name == "character" || name == "mathpanel")
 564                         enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
 565                 else if (name == "latexlog")
 566                         enable = isFileReadable(FileName(buf->getLogName().second));
 567 #if !defined (USE_ASPELL) && !defined (USE_ISPELL) && !defined (USE_PSPELL)
 568                 else if (name == "spellchecker")
 569                         enable = false;
 570 #endif
 571                 else if (name == "vclog")
 572                         enable = buf->lyxvc().inUse();
 573                 else if (name == "view-source")
 574                         enable = buf;
 575                 break;
 576         }
 577
 578         case LFUN_DIALOG_SHOW_NEW_INSET:
 579                 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
 580                 break;
 581
 582         case LFUN_DIALOG_UPDATE: {
 583                 string const name = cmd.getArg(0);
 584                 if (!buf)
 585                         enable = name == "prefs";
 586                 break;
 587         }
 588
 589         case LFUN_CITATION_INSERT: {
 590                 FuncRequest fr(LFUN_INSET_INSERT, "citation");
 591                 enable = getStatus(fr).enabled();
 592                 break;
 593         }
 594
 595         case LFUN_BUFFER_WRITE: {
 596                 enable = view()->buffer()->isUnnamed()
 597                         || !view()->buffer()->isClean();
 598                 break;
 599         }
 600
 601         case LFUN_BOOKMARK_GOTO: {
 602                 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
 603                 enable = LyX::ref().session().bookmarks().isValid(num);
 604                 break;
 605         }
 606
 607         case LFUN_BOOKMARK_CLEAR:
 608                 enable = LyX::ref().session().bookmarks().size() > 0;
 609                 break;
 610
 611         case LFUN_TOOLBAR_TOGGLE_STATE: {
 612                 ToolbarBackend::Flags flags = lyx_view_->getToolbarState(to_utf8(cmd.argument()));
 613                 if (!(flags & ToolbarBackend::AUTO))
 614                         flag.setOnOff(flags & ToolbarBackend::ON);
 615                 break;
 616         }
 617
 618         // this one is difficult to get right. As a half-baked
 619         // solution, we consider only the first action of the sequence
 620         case LFUN_COMMAND_SEQUENCE: {
 621                 // argument contains ';'-terminated commands
 622                 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
 623                 FuncRequest func(lyxaction.lookupFunc(firstcmd));
 624                 func.origin = cmd.origin;
 625                 flag = getStatus(func);
 626         }
 627
 628         case LFUN_BUFFER_NEW:
 629         case LFUN_BUFFER_NEW_TEMPLATE:
 630         case LFUN_WORD_FIND_FORWARD:
 631         case LFUN_WORD_FIND_BACKWARD:
 632         case LFUN_COMMAND_PREFIX:
 633         case LFUN_COMMAND_EXECUTE:
 634         case LFUN_CANCEL:
 635         case LFUN_META_PREFIX:
 636         case LFUN_BUFFER_CLOSE:
 637         case LFUN_BUFFER_WRITE_AS:
 638         case LFUN_BUFFER_UPDATE:
 639         case LFUN_BUFFER_VIEW:
 640         case LFUN_BUFFER_IMPORT:
 641         case LFUN_TOC_VIEW:
 642         case LFUN_BUFFER_AUTO_SAVE:
 643         case LFUN_RECONFIGURE:
 644         case LFUN_HELP_OPEN:
 645         case LFUN_FILE_NEW:
 646         case LFUN_FILE_OPEN:
 647         case LFUN_DROP_LAYOUTS_CHOICE:
 648         case LFUN_MENU_OPEN:
 649         case LFUN_SERVER_GET_NAME:
 650         case LFUN_SERVER_NOTIFY:
 651         case LFUN_SERVER_GOTO_FILE_ROW:
 652         case LFUN_DIALOG_HIDE:
 653         case LFUN_DIALOG_DISCONNECT_INSET:
 654         case LFUN_BUFFER_CHILD_OPEN:
 655         case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
 656         case LFUN_KEYMAP_OFF:
 657         case LFUN_KEYMAP_PRIMARY:
 658         case LFUN_KEYMAP_SECONDARY:
 659         case LFUN_KEYMAP_TOGGLE:
 660         case LFUN_REPEAT:
 661         case LFUN_BUFFER_EXPORT_CUSTOM:
 662         case LFUN_BUFFER_PRINT:
 663         case LFUN_PREFERENCES_SAVE:
 664         case LFUN_SCREEN_FONT_UPDATE:
 665         case LFUN_SET_COLOR:
 666         case LFUN_MESSAGE:
 667         case LFUN_EXTERNAL_EDIT:
 668         case LFUN_GRAPHICS_EDIT:
 669         case LFUN_ALL_INSETS_TOGGLE:
 670         case LFUN_BUFFER_LANGUAGE:
 671         case LFUN_TEXTCLASS_APPLY:
 672         case LFUN_TEXTCLASS_LOAD:
 673         case LFUN_BUFFER_SAVE_AS_DEFAULT:
 674         case LFUN_BUFFER_PARAMS_APPLY:
 675         case LFUN_LYXRC_APPLY:
 676         case LFUN_BUFFER_NEXT:
 677         case LFUN_BUFFER_PREVIOUS:
 678         case LFUN_WINDOW_NEW:
 679         case LFUN_WINDOW_CLOSE:
 680         case LFUN_LYX_QUIT:
 681                 // these are handled in our dispatch()
 682                 break;
 683
 684         default:
 685                 if (!getLocalStatus(cur, cmd, flag))
 686                         flag = view()->getStatus(cmd);
 687         }
 688
 689         if (!enable)
 690                 flag.enabled(false);
 691
 692         // Can we use a readonly buffer?
 693         if (buf && buf->isReadonly()
 694             && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
 695             && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
 696                 flag.message(from_utf8(N_("Document is read-only")));
 697                 flag.enabled(false);
 698         }
 699
 700         // Are we in a DELETED change-tracking region?
 701         if (buf && lookupChangeType(cur, true) == Change::DELETED
 702             && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
 703             && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
 704                 flag.message(from_utf8(N_("This portion of the document is deleted.")));
 705                 flag.enabled(false);
 706         }
 707
 708         // the default error message if we disable the command
 709         if (!flag.enabled() && flag.message().empty())
 710                 flag.message(from_utf8(N_("Command disabled")));
 711
 712         return flag;
 713 }
 714
 715
 716 bool LyXFunc::ensureBufferClean(BufferView * bv)
 717 {
 718         Buffer & buf = *bv->buffer();
 719         if (buf.isClean())
 720                 return true;
 721
 722         docstring const file = makeDisplayPath(buf.fileName(), 30);
 723         docstring text = bformat(_("The document %1$s has unsaved "
 724                                              "changes.\n\nDo you want to save "
 725                                              "the document?"), file);
 726         int const ret = Alert::prompt(_("Save changed document?"),
 727                                       text, 0, 1, _("&Save"),
 728                                       _("&Cancel"));
 729
 730         if (ret == 0)
 731                 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
 732
 733         return buf.isClean();
 734 }
 735
 736
 737 namespace {
 738
 739 void showPrintError(string const & name)
 740 {
 741         docstring str = bformat(_("Could not print the document %1$s.\n"
 742                                             "Check that your printer is set up correctly."),
 743                              makeDisplayPath(name, 50));
 744         Alert::error(_("Print document failed"), str);
 745 }
 746
 747
 748 void loadTextclass(string const & name)
 749 {
 750         std::pair<bool, textclass_type> const tc_pair =
 751                 textclasslist.numberOfClass(name);
 752
 753         if (!tc_pair.first) {
 754                 lyxerr << "Document class \"" << name
 755                        << "\" does not exist."
 756                        << std::endl;
 757                 return;
 758         }
 759
 760         textclass_type const tc = tc_pair.second;
 761
 762         if (!textclasslist[tc].load()) {
 763                 docstring s = bformat(_("The document could not be converted\n"
 764                                                   "into the document class %1$s."),
 765                                    from_utf8(textclasslist[tc].name()));
 766                 Alert::error(_("Could not change class"), s);
 767         }
 768 }
 769
 770
 771 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
 772
 773 } //namespace anon
 774
 775
 776 void LyXFunc::dispatch(FuncRequest const & cmd)
 777 {
 778         string const argument = to_utf8(cmd.argument());
 779         kb_action const action = cmd.action;
 780
 781         lyxerr[Debug::ACTION] << endl << "LyXFunc::dispatch: cmd: " << cmd << endl;
 782         //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
 783
 784         // we have not done anything wrong yet.
 785         errorstat = false;
 786         dispatch_buffer.erase();
 787
 788         // redraw the screen at the end (first of the two drawing steps).
 789         //This is done unless explicitely requested otherwise
 790         Update::flags updateFlags = Update::FitCursor;
 791
 792         FuncStatus const flag = getStatus(cmd);
 793         if (!flag.enabled()) {
 794                 // We cannot use this function here
 795                 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
 796                        << lyxaction.getActionName(action)
 797                        << " [" << action << "] is disabled at this location"
 798                        << endl;
 799                 setErrorMessage(flag.message());
 800         } else {
 801                 switch (action) {
 802
 803                 case LFUN_WORD_FIND_FORWARD:
 804                 case LFUN_WORD_FIND_BACKWARD: {
 805                         BOOST_ASSERT(lyx_view_ && lyx_view_->view());
 806                         static docstring last_search;
 807                         docstring searched_string;
 808
 809                         if (!cmd.argument().empty()) {
 810                                 last_search = cmd.argument();
 811                                 searched_string = cmd.argument();
 812                         } else {
 813                                 searched_string = last_search;
 814                         }
 815
 816                         if (searched_string.empty())
 817                                 break;
 818
 819                         bool const fw = action == LFUN_WORD_FIND_FORWARD;
 820                         docstring const data =
 821                                 find2string(searched_string, true, false, fw);
 822                         find(view(), FuncRequest(LFUN_WORD_FIND, data));
 823                         break;
 824                 }
 825
 826                 case LFUN_COMMAND_PREFIX:
 827                         BOOST_ASSERT(lyx_view_);
 828                         lyx_view_->message(keyseq->printOptions(true));
 829                         break;
 830
 831                 case LFUN_COMMAND_EXECUTE:
 832                         BOOST_ASSERT(lyx_view_);
 833                         lyx_view_->getToolbars().display("minibuffer", true);
 834                         lyx_view_->focus_command_buffer();
 835                         break;
 836
 837                 case LFUN_CANCEL:
 838                         BOOST_ASSERT(lyx_view_ && lyx_view_->view());
 839                         keyseq->reset();
 840                         meta_fake_bit = key_modifier::none;
 841                         if (view()->buffer())
 842                                 // cancel any selection
 843                                 dispatch(FuncRequest(LFUN_MARK_OFF));
 844                         setMessage(_("Cancel"));
 845                         break;
 846
 847                 case LFUN_META_PREFIX:
 848                         meta_fake_bit = key_modifier::alt;
 849                         setMessage(keyseq->print(true));
 850                         break;
 851
 852                 case LFUN_BUFFER_TOGGLE_READ_ONLY:
 853                         BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
 854                         if (lyx_view_->buffer()->lyxvc().inUse())
 855                                 lyx_view_->buffer()->lyxvc().toggleReadOnly();
 856                         else
 857                                 lyx_view_->buffer()->setReadonly(
 858                                         !lyx_view_->buffer()->isReadonly());
 859                         break;
 860
 861                 // --- Menus -----------------------------------------------
 862                 case LFUN_BUFFER_NEW:
 863                         menuNew(argument, false);
 864                         break;
 865
 866                 case LFUN_BUFFER_NEW_TEMPLATE:
 867                         menuNew(argument, true);
 868                         break;
 869
 870                 case LFUN_BUFFER_CLOSE:
 871                         closeBuffer();
 872                         view()->update();
 873                         break;
 874
 875                 case LFUN_BUFFER_WRITE:
 876                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 877                         if (!lyx_view_->buffer()->isUnnamed()) {
 878                                 docstring const str = bformat(_("Saving document %1$s..."),
 879                                          makeDisplayPath(lyx_view_->buffer()->fileName()));
 880                                 lyx_view_->message(str);
 881                                 menuWrite(lyx_view_->buffer());
 882                                 lyx_view_->message(str + _(" done."));
 883                         } else
 884                                 writeAs(lyx_view_->buffer());
 885                         updateFlags = Update::None;
 886                         break;
 887
 888                 case LFUN_BUFFER_WRITE_AS:
 889                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 890                         writeAs(lyx_view_->buffer(), argument);
 891                         updateFlags = Update::None;
 892                         break;
 893
 894                 case LFUN_BUFFER_RELOAD: {
 895                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 896                         docstring const file = makeDisplayPath(view()->buffer()->fileName(), 20);
 897                         docstring text = bformat(_("Any changes will be lost. Are you sure "
 898                                                              "you want to revert to the saved version of the document %1$s?"), file);
 899                         int const ret = Alert::prompt(_("Revert to saved document?"),
 900                                 text, 0, 1, _("&Revert"), _("&Cancel"));
 901
 902                         if (ret == 0)
 903                                 reloadBuffer();
 904                         break;
 905                 }
 906
 907                 case LFUN_BUFFER_UPDATE:
 908                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 909                         Exporter::Export(lyx_view_->buffer(), argument, true);
 910                         break;
 911
 912                 case LFUN_BUFFER_VIEW:
 913                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 914                         Exporter::preview(lyx_view_->buffer(), argument);
 915                         break;
 916
 917                 case LFUN_BUILD_PROGRAM:
 918                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 919                         Exporter::Export(lyx_view_->buffer(), "program", true);
 920                         break;
 921
 922                 case LFUN_BUFFER_CHKTEX:
 923                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 924                         lyx_view_->buffer()->runChktex();
 925                         break;
 926
 927                 case LFUN_BUFFER_EXPORT:
 928                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 929                         if (argument == "custom")
 930                                 lyx_view_->getDialogs().show("sendto");
 931                         else {
 932                                 Exporter::Export(lyx_view_->buffer(), argument, false);
 933                         }
 934                         break;
 935
 936                 case LFUN_BUFFER_EXPORT_CUSTOM: {
 937                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 938                         string format_name;
 939                         string command = split(argument, format_name, ' ');
 940                         Format const * format = formats.getFormat(format_name);
 941                         if (!format) {
 942                                 lyxerr << "Format \"" << format_name
 943                                        << "\" not recognized!"
 944                                        << std::endl;
 945                                 break;
 946                         }
 947
 948                         Buffer * buffer = lyx_view_->buffer();
 949
 950                         // The name of the file created by the conversion process
 951                         string filename;
 952
 953                         // Output to filename
 954                         if (format->name() == "lyx") {
 955                                 string const latexname =
 956                                         buffer->getLatexName(false);
 957                                 filename = changeExtension(latexname,
 958                                                            format->extension());
 959                                 filename = addName(buffer->temppath(), filename);
 960
 961                                 if (!buffer->writeFile(FileName(filename)))
 962                                         break;
 963
 964                         } else {
 965                                 Exporter::Export(buffer, format_name, true, filename);
 966                         }
 967
 968                         // Substitute $$FName for filename
 969                         if (!contains(command, "$$FName"))
 970                                 command = "( " + command + " ) < $$FName";
 971                         command = subst(command, "$$FName", filename);
 972
 973                         // Execute the command in the background
 974                         Systemcall call;
 975                         call.startscript(Systemcall::DontWait, command);
 976                         break;
 977                 }
 978
 979                 case LFUN_BUFFER_PRINT: {
 980                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
 981                         string target;
 982                         string target_name;
 983                         string command = split(split(argument, target, ' '),
 984                                                target_name, ' ');
 985
 986                         if (target.empty()
 987                             || target_name.empty()
 988                             || command.empty()) {
 989                                 lyxerr << "Unable to parse \""
 990                                        << argument << '"' << std::endl;
 991                                 break;
 992                         }
 993                         if (target != "printer" && target != "file") {
 994                                 lyxerr << "Unrecognized target \""
 995                                        << target << '"' << std::endl;
 996                                 break;
 997                         }
 998
 999                         Buffer * buffer = lyx_view_->buffer();
1000
1001                         if (!Exporter::Export(buffer, "dvi", true)) {
1002                                 showPrintError(buffer->fileName());
1003                                 break;
1004                         }
1005
1006                         // Push directory path.
1007                         string const path = buffer->temppath();
1008                         support::Path p(path);
1009
1010                         // there are three cases here:
1011                         // 1. we print to a file
1012                         // 2. we print directly to a printer
1013                         // 3. we print using a spool command (print to file first)
1014                         Systemcall one;
1015                         int res = 0;
1016                         string const dviname =
1017                                 changeExtension(buffer->getLatexName(true),
1018                                                 "dvi");
1019
1020                         if (target == "printer") {
1021                                 if (!lyxrc.print_spool_command.empty()) {
1022                                         // case 3: print using a spool
1023                                         string const psname =
1024                                                 changeExtension(dviname,".ps");
1025                                         command += lyxrc.print_to_file
1026                                                 + quoteName(psname)
1027                                                 + ' '
1028                                                 + quoteName(dviname);
1029
1030                                         string command2 =
1031                                                 lyxrc.print_spool_command +' ';
1032                                         if (target_name != "default") {
1033                                                 command2 += lyxrc.print_spool_printerprefix
1034                                                         + target_name
1035                                                         + ' ';
1036                                         }
1037                                         command2 += quoteName(psname);
1038                                         // First run dvips.
1039                                         // If successful, then spool command
1040                                         res = one.startscript(
1041                                                 Systemcall::Wait,
1042                                                 command);
1043
1044                                         if (res == 0)
1045                                                 res = one.startscript(
1046                                                         Systemcall::DontWait,
1047                                                         command2);
1048                                 } else {
1049                                         // case 2: print directly to a printer
1050                                         res = one.startscript(
1051                                                 Systemcall::DontWait,
1052                                                 command + quoteName(dviname));
1053                                 }
1054
1055                         } else {
1056                                 // case 1: print to a file
1057                                 command += lyxrc.print_to_file
1058                                         + quoteName(makeAbsPath(target_name,
1059                                                                 path).toFilesystemEncoding())
1060                                         + ' '
1061                                         + quoteName(dviname);
1062                                 res = one.startscript(Systemcall::DontWait,
1063                                                       command);
1064                         }
1065
1066                         if (res != 0)
1067                                 showPrintError(buffer->fileName());
1068                         break;
1069                 }
1070
1071                 case LFUN_BUFFER_IMPORT:
1072                         doImport(argument);
1073                         break;
1074
1075                 case LFUN_LYX_QUIT:
1076                         // quitting is triggered by the gui code
1077                         // (leaving the event loop).
1078                         lyx_view_->message(from_utf8(N_("Exiting.")));
1079                         if (theBufferList().quitWriteAll())
1080                                 theApp()->gui().closeAllViews();
1081                         break;
1082
1083                 case LFUN_TOC_VIEW: {
1084                         BOOST_ASSERT(lyx_view_);
1085                         InsetCommandParams p("tableofcontents");
1086                         string const data = InsetCommandMailer::params2string("toc", p);
1087                         lyx_view_->getDialogs().show("toc", data, 0);
1088                         break;
1089                 }
1090
1091                 case LFUN_BUFFER_AUTO_SAVE:
1092                         autoSave(view());
1093                         break;
1094
1095                 case LFUN_RECONFIGURE:
1096                         BOOST_ASSERT(lyx_view_);
1097                         reconfigure(*lyx_view_);
1098                         break;
1099
1100                 case LFUN_HELP_OPEN: {
1101                         BOOST_ASSERT(lyx_view_);
1102                         string const arg = argument;
1103                         if (arg.empty()) {
1104                                 setErrorMessage(_("Missing argument"));
1105                                 break;
1106                         }
1107                         FileName const fname = i18nLibFileSearch("doc", arg, "lyx");
1108                         if (fname.empty()) {
1109                                 lyxerr << "LyX: unable to find documentation file `"
1110                                                          << arg << "'. Bad installation?" << endl;
1111                                 break;
1112                         }
1113                         lyx_view_->message(bformat(_("Opening help file %1$s..."),
1114                                 makeDisplayPath(fname.absFilename())));
1115                         lyx_view_->loadLyXFile(fname, false);
1116                         break;
1117                 }
1118
1119                 // --- version control -------------------------------
1120                 case LFUN_VC_REGISTER:
1121                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1122                         if (!ensureBufferClean(view()))
1123                                 break;
1124                         if (!lyx_view_->buffer()->lyxvc().inUse()) {
1125                                 lyx_view_->buffer()->lyxvc().registrer();
1126                                 reloadBuffer();
1127                         }
1128                         updateFlags = Update::Force;
1129                         break;
1130
1131                 case LFUN_VC_CHECK_IN:
1132                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1133                         if (!ensureBufferClean(view()))
1134                                 break;
1135                         if (lyx_view_->buffer()->lyxvc().inUse()
1136                                         && !lyx_view_->buffer()->isReadonly()) {
1137                                 lyx_view_->buffer()->lyxvc().checkIn();
1138                                 reloadBuffer();
1139                         }
1140                         break;
1141
1142                 case LFUN_VC_CHECK_OUT:
1143                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1144                         if (!ensureBufferClean(view()))
1145                                 break;
1146                         if (lyx_view_->buffer()->lyxvc().inUse()
1147                                         && lyx_view_->buffer()->isReadonly()) {
1148                                 lyx_view_->buffer()->lyxvc().checkOut();
1149                                 reloadBuffer();
1150                         }
1151                         break;
1152
1153                 case LFUN_VC_REVERT:
1154                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1155                         lyx_view_->buffer()->lyxvc().revert();
1156                         reloadBuffer();
1157                         break;
1158
1159                 case LFUN_VC_UNDO_LAST:
1160                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1161                         lyx_view_->buffer()->lyxvc().undoLast();
1162                         reloadBuffer();
1163                         break;
1164
1165                 // --- buffers ----------------------------------------
1166                 case LFUN_BUFFER_SWITCH:
1167                         BOOST_ASSERT(lyx_view_);
1168                         lyx_view_->setBuffer(theBufferList().getBuffer(argument));
1169                         break;
1170
1171                 case LFUN_BUFFER_NEXT:
1172                         BOOST_ASSERT(lyx_view_);
1173                         lyx_view_->setBuffer(theBufferList().next(view()->buffer()));
1174                         break;
1175
1176                 case LFUN_BUFFER_PREVIOUS:
1177                         BOOST_ASSERT(lyx_view_);
1178                         lyx_view_->setBuffer(theBufferList().previous(view()->buffer()));
1179                         break;
1180
1181                 case LFUN_FILE_NEW:
1182                         BOOST_ASSERT(lyx_view_);
1183                         newFile(view(), argument);
1184                         break;
1185
1186                 case LFUN_FILE_OPEN:
1187                         BOOST_ASSERT(lyx_view_);
1188                         open(argument);
1189                         break;
1190
1191                 case LFUN_DROP_LAYOUTS_CHOICE:
1192                         BOOST_ASSERT(lyx_view_);
1193                         lyx_view_->getToolbars().openLayoutList();
1194                         break;
1195
1196                 case LFUN_MENU_OPEN:
1197                         BOOST_ASSERT(lyx_view_);
1198                         lyx_view_->getMenubar().openByName(from_utf8(argument));
1199                         break;
1200
1201                 // --- lyxserver commands ----------------------------
1202                 case LFUN_SERVER_GET_NAME:
1203                         BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1204                         setMessage(from_utf8(lyx_view_->buffer()->fileName()));
1205                         lyxerr[Debug::INFO] << "FNAME["
1206                                                          << lyx_view_->buffer()->fileName()
1207                                                          << "] " << endl;
1208                         break;
1209
1210                 case LFUN_SERVER_NOTIFY:
1211                         dispatch_buffer = keyseq->print(false);
1212                         theLyXServer().notifyClient(to_utf8(dispatch_buffer));
1213                         break;
1214
1215                 case LFUN_SERVER_GOTO_FILE_ROW: {
1216                         BOOST_ASSERT(lyx_view_);
1217                         string file_name;
1218                         int row;
1219                         istringstream is(argument);
1220                         is >> file_name >> row;
1221                         if (prefixIs(file_name, package().temp_dir())) {
1222                                 // Needed by inverse dvi search. If it is a file
1223                                 // in tmpdir, call the apropriated function
1224                                 lyx_view_->setBuffer(theBufferList().getBufferFromTmp(file_name));
1225                         } else {
1226                                 // Must replace extension of the file to be .lyx
1227                                 // and get full path
1228                                 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1229                                 // Either change buffer or load the file
1230                                 if (theBufferList().exists(s.absFilename())) {
1231                                         lyx_view_->setBuffer(theBufferList().getBuffer(s.absFilename()));
1232                                 } else {
1233                                         lyx_view_->loadLyXFile(s);
1234                                 }
1235                         }
1236
1237                         view()->setCursorFromRow(row);
1238
1239                         updateFlags = Update::FitCursor;
1240                         break;
1241                 }
1242
1243                 case LFUN_DIALOG_SHOW: {
1244                         BOOST_ASSERT(lyx_view_);
1245                         string const name = cmd.getArg(0);
1246                         string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1247
1248                         if (name == "character") {
1249                                 data = freefont2string();
1250                                 if (!data.empty())
1251                                         lyx_view_->getDialogs().show("character", data);
1252                         } else if (name == "latexlog") {
1253                                 pair<Buffer::LogType, string> const logfile =
1254                                         lyx_view_->buffer()->getLogName();
1255                                 switch (logfile.first) {
1256                                 case Buffer::latexlog:
1257                                         data = "latex ";
1258                                         break;
1259                                 case Buffer::buildlog:
1260                                         data = "literate ";
1261                                         break;
1262                                 }
1263                                 data += LyXLex::quoteString(logfile.second);
1264                                 lyx_view_->getDialogs().show("log", data);
1265                         } else if (name == "vclog") {
1266                                 string const data = "vc " +
1267                                         LyXLex::quoteString(lyx_view_->buffer()->lyxvc().getLogFile());
1268                                 lyx_view_->getDialogs().show("log", data);
1269                         } else
1270                                 lyx_view_->getDialogs().show(name, data);
1271                         break;
1272                 }
1273
1274                 case LFUN_DIALOG_SHOW_NEW_INSET: {
1275                         BOOST_ASSERT(lyx_view_);
1276                         string const name = cmd.getArg(0);
1277                         string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1278                         if (name == "bibitem" ||
1279                             name == "bibtex" ||
1280                             name == "index" ||
1281                             name == "label" ||
1282                             name == "nomenclature" ||
1283                             name == "ref" ||
1284                             name == "toc" ||
1285                             name == "url") {
1286                                 InsetCommandParams p(name);
1287                                 data = InsetCommandMailer::params2string(name, p);
1288                         } else if (name == "include") {
1289                                 // data is the include type: one of "include",
1290                                 // "input", "verbatiminput" or "verbatiminput*"
1291                                 if (data.empty())
1292                                         // default type is requested
1293                                         data = "include";
1294                                 InsetCommandParams p(data);
1295                                 data = InsetIncludeMailer::params2string(p);
1296                         } else if (name == "box") {
1297                                 // \c data == "Boxed" || "Frameless" etc
1298                                 InsetBoxParams p(data);
1299                                 data = InsetBoxMailer::params2string(p);
1300                         } else if (name == "branch") {
1301                                 InsetBranchParams p;
1302                                 data = InsetBranchMailer::params2string(p);
1303                         } else if (name == "citation") {
1304                                 InsetCommandParams p("cite");
1305                                 data = InsetCommandMailer::params2string(name, p);
1306                         } else if (name == "ert") {
1307                                 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1308                         } else if (name == "external") {
1309                                 InsetExternalParams p;
1310                                 Buffer const & buffer = *lyx_view_->buffer();
1311                                 data = InsetExternalMailer::params2string(p, buffer);
1312                         } else if (name == "float") {
1313                                 InsetFloatParams p;
1314                                 data = InsetFloatMailer::params2string(p);
1315                         } else if (name == "graphics") {
1316                                 InsetGraphicsParams p;
1317                                 Buffer const & buffer = *lyx_view_->buffer();
1318                                 data = InsetGraphicsMailer::params2string(p, buffer);
1319                         } else if (name == "note") {
1320                                 InsetNoteParams p;
1321                                 data = InsetNoteMailer::params2string(p);
1322                         } else if (name == "vspace") {
1323                                 VSpace space;
1324                                 data = InsetVSpaceMailer::params2string(space);
1325                         } else if (name == "wrap") {
1326                                 InsetWrapParams p;
1327                                 data = InsetWrapMailer::params2string(p);
1328                         }
1329                         lyx_view_->getDialogs().show(name, data, 0);
1330                         break;
1331                 }
1332
1333                 case LFUN_DIALOG_UPDATE: {
1334                         BOOST_ASSERT(lyx_view_);
1335                         string const & name = argument;
1336                         // Can only update a dialog connected to an existing inset
1337                         InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1338                         if (inset) {
1339                                 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument());
1340                                 inset->dispatch(view()->cursor(), fr);
1341                         } else if (name == "paragraph") {
1342                                 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1343                         } else if (name == "prefs") {
1344                                 lyx_view_->getDialogs().update(name, string());
1345                         }
1346                         break;
1347                 }
1348
1349                 case LFUN_DIALOG_HIDE:
1350                         Dialogs::hide(argument, 0);
1351                         break;
1352
1353                 case LFUN_DIALOG_DISCONNECT_INSET:
1354                         BOOST_ASSERT(lyx_view_);
1355                         lyx_view_->getDialogs().disconnect(argument);
1356                         break;
1357
1358
1359                 case LFUN_CITATION_INSERT: {
1360                         BOOST_ASSERT(lyx_view_);
1361                         if (!argument.empty()) {
1362                                 // we can have one optional argument, delimited by '|'
1363                                 // citation-insert <key>|<text_before>
1364                                 // this should be enhanced to also support text_after
1365                                 // and citation style
1366                                 string arg = argument;
1367                                 string opt1;
1368                                 if (contains(argument, "|")) {
1369                                         arg = token(argument, '|', 0);
1370                                         opt1 = '[' + token(argument, '|', 1) + ']';
1371                                 }
1372                                 std::ostringstream os;
1373                                 os << "citation LatexCommand\n"
1374                                    << "\\cite" << opt1 << "{" << arg << "}\n"
1375                                    << "\\end_inset";
1376                                 FuncRequest fr(LFUN_INSET_INSERT, os.str());
1377                                 dispatch(fr);
1378                         } else
1379                                 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "citation"));
1380                         break;
1381                 }
1382
1383                 case LFUN_BUFFER_CHILD_OPEN: {
1384                         BOOST_ASSERT(lyx_view_);
1385                         FileName const filename =
1386                                 makeAbsPath(argument, lyx_view_->buffer()->filePath());
1387                         // FIXME Should use bformat
1388                         setMessage(_("Opening child document ") +
1389                                          makeDisplayPath(filename.absFilename()) + "...");
1390                         view()->saveBookmark(false);
1391                         string const parentfilename = lyx_view_->buffer()->fileName();
1392                         if (theBufferList().exists(filename.absFilename()))
1393                                 lyx_view_->setBuffer(theBufferList().getBuffer(filename.absFilename()));
1394                         else
1395                                 lyx_view_->loadLyXFile(filename);
1396                         // Set the parent name of the child document.
1397                         // This makes insertion of citations and references in the child work,
1398                         // when the target is in the parent or another child document.
1399                         lyx_view_->buffer()->setParentName(parentfilename);
1400                         break;
1401                 }
1402
1403                 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
1404                         BOOST_ASSERT(lyx_view_);
1405                         lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1406                         break;
1407
1408                 case LFUN_KEYMAP_OFF:
1409                         BOOST_ASSERT(lyx_view_);
1410                         lyx_view_->view()->getIntl().keyMapOn(false);
1411                         break;
1412
1413                 case LFUN_KEYMAP_PRIMARY:
1414                         BOOST_ASSERT(lyx_view_);
1415                         lyx_view_->view()->getIntl().keyMapPrim();
1416                         break;
1417
1418                 case LFUN_KEYMAP_SECONDARY:
1419                         BOOST_ASSERT(lyx_view_);
1420                         lyx_view_->view()->getIntl().keyMapSec();
1421                         break;
1422
1423                 case LFUN_KEYMAP_TOGGLE:
1424                         BOOST_ASSERT(lyx_view_);
1425                         lyx_view_->view()->getIntl().toggleKeyMap();
1426                         break;
1427
1428                 case LFUN_REPEAT: {
1429                         // repeat command
1430                         string countstr;
1431                         string rest = split(argument, countstr, ' ');
1432                         istringstream is(countstr);
1433                         int count = 0;
1434                         is >> count;
1435                         lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1436                         for (int i = 0; i < count; ++i)
1437                                 dispatch(lyxaction.lookupFunc(rest));
1438                         break;
1439                 }
1440
1441                 case LFUN_COMMAND_SEQUENCE: {
1442                         // argument contains ';'-terminated commands
1443                         string arg = argument;
1444                         while (!arg.empty()) {
1445                                 string first;
1446                                 arg = split(arg, first, ';');
1447                                 FuncRequest func(lyxaction.lookupFunc(first));
1448                                 func.origin = cmd.origin;
1449                                 dispatch(func);
1450                         }
1451                         break;
1452                 }
1453
1454                 case LFUN_PREFERENCES_SAVE: {
1455                         lyxrc.write(makeAbsPath("preferences",
1456                                                 package().user_support()),
1457                                     false);
1458                         break;
1459                 }
1460
1461                 case LFUN_SCREEN_FONT_UPDATE:
1462                         BOOST_ASSERT(lyx_view_);
1463                         // handle the screen font changes.
1464                         lyxrc.set_font_norm_type();
1465                         theFontLoader().update();
1466                         /// FIXME: only the current view will be updated. the Gui
1467                         /// class is able to furnish the list of views.
1468                         updateFlags = Update::Force;
1469                         break;
1470
1471                 case LFUN_SET_COLOR: {
1472                         string lyx_name;
1473                         string const x11_name = split(argument, lyx_name, ' ');
1474                         if (lyx_name.empty() || x11_name.empty()) {
1475                                 setErrorMessage(_("Syntax: set-color <lyx_name>"
1476                                                         " <x11_name>"));
1477                                 break;
1478                         }
1479
1480                         bool const graphicsbg_changed =
1481                                 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1482                                  x11_name != lcolor.getX11Name(LColor::graphicsbg));
1483
1484                         if (!lcolor.setColor(lyx_name, x11_name)) {
1485                                 setErrorMessage(
1486                                                 bformat(_("Set-color \"%1$s\" failed "
1487                                                                        "- color is undefined or "
1488                                                                        "may not be redefined"),
1489                                                                            from_utf8(lyx_name)));
1490                                 break;
1491                         }
1492
1493                         theApp()->updateColor(lcolor.getFromLyXName(lyx_name));
1494
1495                         if (graphicsbg_changed) {
1496 #ifdef WITH_WARNINGS
1497 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1498 #endif
1499 #if 0
1500                                 graphics::GCache::get().changeDisplay(true);
1501 #endif
1502                         }
1503                         break;
1504                 }
1505
1506                 case LFUN_MESSAGE:
1507                         BOOST_ASSERT(lyx_view_);
1508                         lyx_view_->message(from_utf8(argument));
1509                         break;
1510
1511                 case LFUN_EXTERNAL_EDIT: {
1512                         BOOST_ASSERT(lyx_view_);
1513                         FuncRequest fr(action, argument);
1514                         InsetExternal().dispatch(view()->cursor(), fr);
1515                         break;
1516                 }
1517
1518                 case LFUN_GRAPHICS_EDIT: {
1519                         FuncRequest fr(action, argument);
1520                         InsetGraphics().dispatch(view()->cursor(), fr);
1521                         break;
1522                 }
1523
1524                 case LFUN_INSET_APPLY: {
1525                         BOOST_ASSERT(lyx_view_);
1526                         string const name = cmd.getArg(0);
1527                         InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1528                         if (inset) {
1529                                 FuncRequest fr(LFUN_INSET_MODIFY, argument);
1530                                 inset->dispatch(view()->cursor(), fr);
1531                         } else {
1532                                 FuncRequest fr(LFUN_INSET_INSERT, argument);
1533                                 dispatch(fr);
1534                         }
1535                         // ideally, the update flag should be set by the insets,
1536                         // but this is not possible currently
1537                         updateFlags = Update::Force | Update::FitCursor;
1538                         break;
1539                 }
1540
1541                 case LFUN_ALL_INSETS_TOGGLE: {
1542                         BOOST_ASSERT(lyx_view_);
1543                         string action;
1544                         string const name = split(argument, action, ' ');
1545                         InsetBase::Code const inset_code =
1546                                 InsetBase::translate(name);
1547
1548                         LCursor & cur = view()->cursor();
1549                         FuncRequest fr(LFUN_INSET_TOGGLE, action);
1550
1551                         InsetBase & inset = lyx_view_->buffer()->inset();
1552                         InsetIterator it  = inset_iterator_begin(inset);
1553                         InsetIterator const end = inset_iterator_end(inset);
1554                         for (; it != end; ++it) {
1555                                 if (inset_code == InsetBase::NO_CODE
1556                                     || inset_code == it->lyxCode()) {
1557                                         LCursor tmpcur = cur;
1558                                         tmpcur.pushLeft(*it);
1559                                         it->dispatch(tmpcur, fr);
1560                                 }
1561                         }
1562                         updateFlags = Update::Force | Update::FitCursor;
1563                         break;
1564                 }
1565
1566                 case LFUN_BUFFER_LANGUAGE: {
1567                         BOOST_ASSERT(lyx_view_);
1568                         Buffer & buffer = *lyx_view_->buffer();
1569                         Language const * oldL = buffer.params().language;
1570                         Language const * newL = languages.getLanguage(argument);
1571                         if (!newL || oldL == newL)
1572                                 break;
1573
1574                         if (oldL->rightToLeft() == newL->rightToLeft()
1575                             && !buffer.isMultiLingual())
1576                                 buffer.changeLanguage(oldL, newL);
1577                         else
1578                                 buffer.updateDocLang(newL);
1579                         break;
1580                 }
1581
1582                 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1583                         string const fname =
1584                                 addName(addPath(package().user_support(), "templates/"),
1585                                         "defaults.lyx");
1586                         Buffer defaults(fname);
1587
1588                         istringstream ss(argument);
1589                         LyXLex lex(0,0);
1590                         lex.setStream(ss);
1591                         int const unknown_tokens = defaults.readHeader(lex);
1592
1593                         if (unknown_tokens != 0) {
1594                                 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1595                                        << unknown_tokens << " unknown token"
1596                                        << (unknown_tokens == 1 ? "" : "s")
1597                                        << endl;
1598                         }
1599
1600                         if (defaults.writeFile(FileName(defaults.fileName())))
1601                                 // FIXME Should use bformat
1602                                 setMessage(_("Document defaults saved in ")
1603                                            + makeDisplayPath(fname));
1604                         else
1605                                 setErrorMessage(_("Unable to save document defaults"));
1606                         break;
1607                 }
1608
1609                 case LFUN_BUFFER_PARAMS_APPLY: {
1610                         BOOST_ASSERT(lyx_view_);
1611                         biblio::CiteEngine const engine =
1612                                 lyx_view_->buffer()->params().cite_engine;
1613
1614                         istringstream ss(argument);
1615                         LyXLex lex(0,0);
1616                         lex.setStream(ss);
1617                         int const unknown_tokens =
1618                                 lyx_view_->buffer()->readHeader(lex);
1619
1620                         if (unknown_tokens != 0) {
1621                                 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1622                                        << unknown_tokens << " unknown token"
1623                                        << (unknown_tokens == 1 ? "" : "s")
1624                                        << endl;
1625                         }
1626                         if (engine == lyx_view_->buffer()->params().cite_engine)
1627                                 break;
1628
1629                         LCursor & cur = view()->cursor();
1630                         FuncRequest fr(LFUN_INSET_REFRESH);
1631
1632                         InsetBase & inset = lyx_view_->buffer()->inset();
1633                         InsetIterator it  = inset_iterator_begin(inset);
1634                         InsetIterator const end = inset_iterator_end(inset);
1635                         for (; it != end; ++it)
1636                                 if (it->lyxCode() == InsetBase::CITE_CODE)
1637                                         it->dispatch(cur, fr);
1638                         break;
1639                 }
1640
1641                 case LFUN_TEXTCLASS_APPLY: {
1642                         BOOST_ASSERT(lyx_view_);
1643                         Buffer * buffer = lyx_view_->buffer();
1644
1645                         textclass_type const old_class =
1646                                 buffer->params().textclass;
1647
1648                         loadTextclass(argument);
1649
1650                         std::pair<bool, textclass_type> const tc_pair =
1651                                 textclasslist.numberOfClass(argument);
1652
1653                         if (!tc_pair.first)
1654                                 break;
1655
1656                         textclass_type const new_class = tc_pair.second;
1657                         if (old_class == new_class)
1658                                 // nothing to do
1659                                 break;
1660
1661                         lyx_view_->message(_("Converting document to new document class..."));
1662                         recordUndoFullDocument(view());
1663                         buffer->params().textclass = new_class;
1664                         StableDocIterator backcur(view()->cursor());
1665                         ErrorList & el = buffer->errorList("Class Switch");
1666                         cap::switchBetweenClasses(
1667                                 old_class, new_class,
1668                                 static_cast<InsetText &>(buffer->inset()), el);
1669
1670                         view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1671
1672                         buffer->errors("Class Switch");
1673                         updateLabels(*buffer);
1674                         updateFlags = Update::Force | Update::FitCursor;
1675                         break;
1676                 }
1677
1678                 case LFUN_TEXTCLASS_LOAD:
1679                         loadTextclass(argument);
1680                         break;
1681
1682                 case LFUN_LYXRC_APPLY: {
1683                         LyXRC const lyxrc_orig = lyxrc;
1684
1685                         istringstream ss(argument);
1686                         bool const success = lyxrc.read(ss) == 0;
1687
1688                         if (!success) {
1689                                 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1690                                        << "Unable to read lyxrc data"
1691                                        << endl;
1692                                 break;
1693                         }
1694
1695                         actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1696
1697                         /// We force the redraw in any case because there might be
1698                         /// some screen font changes.
1699                         /// FIXME: only the current view will be updated. the Gui
1700                         /// class is able to furnish the list of views.
1701                         updateFlags = Update::Force;
1702                         break;
1703                 }
1704
1705                 case LFUN_WINDOW_NEW:
1706                         LyX::ref().newLyXView();
1707                         break;
1708
1709                 case LFUN_WINDOW_CLOSE:
1710                         BOOST_ASSERT(lyx_view_);
1711                         BOOST_ASSERT(theApp());
1712                         // update bookmark pit of the current buffer before window close
1713                         for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
1714                                 gotoBookmark(i+1, false, false);
1715                         // ask the user for saving changes or cancel quit
1716                         if (!theBufferList().quitWriteAll())
1717                                 break;
1718                         lyx_view_->close();
1719                         return;
1720
1721                 case LFUN_BOOKMARK_GOTO:
1722                         // go to bookmark, open unopened file and switch to buffer if necessary
1723                         gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1724                         break;
1725
1726                 case LFUN_BOOKMARK_CLEAR:
1727                         LyX::ref().session().bookmarks().clear();
1728                         break;
1729
1730                 case LFUN_TOOLBAR_TOGGLE_STATE:
1731                         lyx_view_->toggleToolbarState(argument);
1732                         break;
1733
1734                 default: {
1735                         BOOST_ASSERT(lyx_view_);
1736                         view()->cursor().dispatch(cmd);
1737                         updateFlags = view()->cursor().result().update();
1738                         if (!view()->cursor().result().dispatched())
1739                                 updateFlags = view()->dispatch(cmd);
1740                         break;
1741                 }
1742                 }
1743
1744                 if (lyx_view_ && view()->buffer()) {
1745                         // BufferView::update() updates the ViewMetricsInfo and
1746                         // also initializes the position cache for all insets in
1747                         // (at least partially) visible top-level paragraphs.
1748                         // We will redraw the screen only if needed.
1749                         if (view()->update(updateFlags)) {
1750                                 // Buffer::changed() signals that a repaint is needed.
1751                                 // The frontend (WorkArea) knows which area to repaint
1752                                 // thanks to the ViewMetricsInfo updated above.
1753                                 view()->buffer()->changed();
1754                         }
1755
1756                         lyx_view_->updateStatusBar();
1757
1758                         // if we executed a mutating lfun, mark the buffer as dirty
1759                         if (flag.enabled()
1760                             && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1761                             && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1762                                 view()->buffer()->markDirty();
1763
1764                         if (view()->cursor().inTexted()) {
1765                                 lyx_view_->updateLayoutChoice();
1766                         }
1767                 }
1768         }
1769         if (!quitting) {
1770                 lyx_view_->updateMenubar();
1771                 lyx_view_->updateToolbars();
1772                 sendDispatchMessage(getMessage(), cmd);
1773         }
1774 }
1775
1776
1777 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1778 {
1779         const bool verbose = (cmd.origin == FuncRequest::MENU
1780                               || cmd.origin == FuncRequest::TOOLBAR
1781                               || cmd.origin == FuncRequest::COMMANDBUFFER);
1782
1783         if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1784                 lyxerr[Debug::ACTION] << "dispatch msg is " << to_utf8(msg) << endl;
1785                 if (!msg.empty())
1786                         lyx_view_->message(msg);
1787                 return;
1788         }
1789
1790         docstring dispatch_msg = msg;
1791         if (!dispatch_msg.empty())
1792                 dispatch_msg += ' ';
1793
1794         docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1795
1796         bool argsadded = false;
1797
1798         if (!cmd.argument().empty()) {
1799                 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1800                         comname += ' ' + cmd.argument();
1801                         argsadded = true;
1802                 }
1803         }
1804
1805         docstring const shortcuts = theTopLevelKeymap().printbindings(cmd);
1806
1807         if (!shortcuts.empty())
1808                 comname += ": " + shortcuts;
1809         else if (!argsadded && !cmd.argument().empty())
1810                 comname += ' ' + cmd.argument();
1811
1812         if (!comname.empty()) {
1813                 comname = rtrim(comname);
1814                 dispatch_msg += '(' + rtrim(comname) + ')';
1815         }
1816
1817         lyxerr[Debug::ACTION] << "verbose dispatch msg "
1818                 << to_utf8(dispatch_msg) << endl;
1819         if (!dispatch_msg.empty())
1820                 lyx_view_->message(dispatch_msg);
1821 }
1822
1823
1824 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1825 {
1826         // FIXME: initpath is not used. What to do?
1827         string initpath = lyxrc.document_path;
1828         string filename(name);
1829
1830         if (view()->buffer()) {
1831                 string const trypath = lyx_view_->buffer()->filePath();
1832                 // If directory is writeable, use this as default.
1833                 if (isDirWriteable(FileName(trypath)))
1834                         initpath = trypath;
1835         }
1836
1837         static int newfile_number;
1838
1839         if (filename.empty()) {
1840                 filename = addName(lyxrc.document_path,
1841                             "newfile" + convert<string>(++newfile_number) + ".lyx");
1842                 while (theBufferList().exists(filename) ||
1843                        fs::is_readable(FileName(filename).toFilesystemEncoding())) {
1844                         ++newfile_number;
1845                         filename = addName(lyxrc.document_path,
1846                                            "newfile" +  convert<string>(newfile_number) +
1847                                     ".lyx");
1848                 }
1849         }
1850
1851         // The template stuff
1852         string templname;
1853         if (fromTemplate) {
1854                 FileDialog fileDlg(_("Select template file"),
1855                         LFUN_SELECT_FILE_SYNC,
1856                         make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1857                         make_pair(_("Templates|#T#t"), from_utf8(lyxrc.template_path)));
1858
1859                 FileDialog::Result result =
1860                         fileDlg.open(from_utf8(lyxrc.template_path),
1861                                      FileFilterList(_("LyX Documents (*.lyx)")),
1862                                      docstring());
1863
1864                 if (result.first == FileDialog::Later)
1865                         return;
1866                 if (result.second.empty())
1867                         return;
1868                 templname = to_utf8(result.second);
1869         }
1870
1871         Buffer * const b = newFile(filename, templname, !name.empty());
1872         if (b)
1873                 lyx_view_->setBuffer(b);
1874 }
1875
1876
1877 void LyXFunc::open(string const & fname)
1878 {
1879         string initpath = lyxrc.document_path;
1880
1881         if (view()->buffer()) {
1882                 string const trypath = lyx_view_->buffer()->filePath();
1883                 // If directory is writeable, use this as default.
1884                 if (isDirWriteable(FileName(trypath)))
1885                         initpath = trypath;
1886         }
1887
1888         string filename;
1889
1890         if (fname.empty()) {
1891                 FileDialog fileDlg(_("Select document to open"),
1892                         LFUN_FILE_OPEN,
1893                         make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1894                         make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1895
1896                 FileDialog::Result result =
1897                         fileDlg.open(from_utf8(initpath),
1898                                      FileFilterList(_("LyX Documents (*.lyx)")),
1899                                      docstring());
1900
1901                 if (result.first == FileDialog::Later)
1902                         return;
1903
1904                 filename = to_utf8(result.second);
1905
1906                 // check selected filename
1907                 if (filename.empty()) {
1908                         lyx_view_->message(_("Canceled."));
1909                         return;
1910                 }
1911         } else
1912                 filename = fname;
1913
1914         // get absolute path of file and add ".lyx" to the filename if
1915         // necessary
1916         FileName const fullname = fileSearch(string(), filename, "lyx");
1917         if (!fullname.empty())
1918                 filename = fullname.absFilename();
1919
1920         // if the file doesn't exist, let the user create one
1921         if (!fs::exists(fullname.toFilesystemEncoding())) {
1922                 // the user specifically chose this name. Believe him.
1923                 Buffer * const b = newFile(filename, string(), true);
1924                 if (b)
1925                         lyx_view_->setBuffer(b);
1926                 return;
1927         }
1928
1929         docstring const disp_fn = makeDisplayPath(filename);
1930         lyx_view_->message(bformat(_("Opening document %1$s..."), disp_fn));
1931
1932         docstring str2;
1933         if (lyx_view_->loadLyXFile(fullname)) {
1934                 str2 = bformat(_("Document %1$s opened."), disp_fn);
1935         } else {
1936                 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1937         }
1938         lyx_view_->message(str2);
1939 }
1940
1941
1942 void LyXFunc::doImport(string const & argument)
1943 {
1944         string format;
1945         string filename = split(argument, format, ' ');
1946
1947         lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1948                             << " file: " << filename << endl;
1949
1950         // need user interaction
1951         if (filename.empty()) {
1952                 string initpath = lyxrc.document_path;
1953
1954                 if (view()->buffer()) {
1955                         string const trypath = lyx_view_->buffer()->filePath();
1956                         // If directory is writeable, use this as default.
1957                         if (isDirWriteable(FileName(trypath)))
1958                                 initpath = trypath;
1959                 }
1960
1961                 docstring const text = bformat(_("Select %1$s file to import"),
1962                         formats.prettyName(format));
1963
1964                 FileDialog fileDlg(text,
1965                         LFUN_BUFFER_IMPORT,
1966                         make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1967                         make_pair(_("Examples|#E#e"),
1968                                   from_utf8(addPath(package().system_support(), "examples"))));
1969
1970                 docstring filter = formats.prettyName(format);
1971                 filter += " (*.";
1972                 // FIXME UNICODE
1973                 filter += from_utf8(formats.extension(format));
1974                 filter += ')';
1975
1976                 FileDialog::Result result =
1977                         fileDlg.open(from_utf8(initpath),
1978                                      FileFilterList(filter),
1979                                      docstring());
1980
1981                 if (result.first == FileDialog::Later)
1982                         return;
1983
1984                 filename = to_utf8(result.second);
1985
1986                 // check selected filename
1987                 if (filename.empty())
1988                         lyx_view_->message(_("Canceled."));
1989         }
1990
1991         if (filename.empty())
1992                 return;
1993
1994         // get absolute path of file
1995         FileName const fullname(makeAbsPath(filename));
1996
1997         FileName const lyxfile(changeExtension(fullname.absFilename(), ".lyx"));
1998
1999         // Check if the document already is open
2000         if (use_gui && theBufferList().exists(lyxfile.absFilename())) {
2001                 if (!theBufferList().close(theBufferList().getBuffer(lyxfile.absFilename()), true)) {
2002                         lyx_view_->message(_("Canceled."));
2003                         return;
2004                 }
2005         }
2006
2007         // if the file exists already, and we didn't do
2008         // -i lyx thefile.lyx, warn
2009         if (fs::exists(lyxfile.toFilesystemEncoding()) && fullname != lyxfile) {
2010                 docstring const file = makeDisplayPath(lyxfile.absFilename(), 30);
2011
2012                 docstring text = bformat(_("The document %1$s already exists.\n\n"
2013                                                      "Do you want to over-write that document?"), file);
2014                 int const ret = Alert::prompt(_("Over-write document?"),
2015                         text, 0, 1, _("&Over-write"), _("&Cancel"));
2016
2017                 if (ret == 1) {
2018                         lyx_view_->message(_("Canceled."));
2019                         return;
2020                 }
2021         }
2022
2023         ErrorList errorList;
2024         Importer::Import(lyx_view_, fullname, format, errorList);
2025         // FIXME (Abdel 12/08/06): Is there a need to display the error list here?
2026 }
2027
2028
2029 void LyXFunc::closeBuffer()
2030 {
2031         // save current cursor position
2032         LyX::ref().session().lastFilePos().save(FileName(lyx_view_->buffer()->fileName()),
2033                 boost::tie(view()->cursor().pit(), view()->cursor().pos()) );
2034         // goto bookmark to update bookmark pit.
2035         for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
2036                 gotoBookmark(i+1, false, false);
2037         if (theBufferList().close(lyx_view_->buffer(), true) && !quitting) {
2038                 if (theBufferList().empty()) {
2039                         // need this otherwise SEGV may occur while
2040                         // trying to set variables that don't exist
2041                         // since there's no current buffer
2042                         lyx_view_->getDialogs().hideBufferDependent();
2043                 } else {
2044                         lyx_view_->setBuffer(theBufferList().first());
2045                 }
2046         }
2047 }
2048
2049
2050 void LyXFunc::reloadBuffer()
2051 {
2052         FileName filename(lyx_view_->buffer()->fileName());
2053         closeBuffer();
2054         lyx_view_->loadLyXFile(filename);
2055 }
2056
2057 // Each "lyx_view_" should have it's own message method. lyxview and
2058 // the minibuffer would use the minibuffer, but lyxserver would
2059 // send an ERROR signal to its client.  Alejandro 970603
2060 // This function is bit problematic when it comes to NLS, to make the
2061 // lyx servers client be language indepenent we must not translate
2062 // strings sent to this func.
2063 void LyXFunc::setErrorMessage(docstring const & m) const
2064 {
2065         dispatch_buffer = m;
2066         errorstat = true;
2067 }
2068
2069
2070 void LyXFunc::setMessage(docstring const & m) const
2071 {
2072         dispatch_buffer = m;
2073 }
2074
2075
2076 docstring const LyXFunc::viewStatusMessage()
2077 {
2078         // When meta-fake key is pressed, show the key sequence so far + "M-".
2079         if (wasMetaKey())
2080                 return keyseq->print(true) + "M-";
2081
2082         // Else, when a non-complete key sequence is pressed,
2083         // show the available options.
2084         if (keyseq->length() > 0 && !keyseq->deleted())
2085                 return keyseq->printOptions(true);
2086
2087         if (!view()->buffer())
2088                 return _("Welcome to LyX!");
2089
2090         return view()->cursor().currentState();
2091 }
2092
2093
2094 BufferView * LyXFunc::view() const
2095 {
2096         BOOST_ASSERT(lyx_view_);
2097         return lyx_view_->view();
2098 }
2099
2100
2101 bool LyXFunc::wasMetaKey() const
2102 {
2103         return (meta_fake_bit != key_modifier::none);
2104 }
2105
2106
2107 namespace {
2108
2109 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
2110 {
2111         // Why the switch you might ask. It is a trick to ensure that all
2112         // the elements in the LyXRCTags enum is handled. As you can see
2113         // there are no breaks at all. So it is just a huge fall-through.
2114         // The nice thing is that we will get a warning from the compiler
2115         // if we forget an element.
2116         LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
2117         switch (tag) {
2118         case LyXRC::RC_ACCEPT_COMPOUND:
2119         case LyXRC::RC_ALT_LANG:
2120         case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
2121         case LyXRC::RC_PLAINTEXT_LINELEN:
2122         case LyXRC::RC_AUTOREGIONDELETE:
2123         case LyXRC::RC_AUTORESET_OPTIONS:
2124         case LyXRC::RC_AUTOSAVE:
2125         case LyXRC::RC_AUTO_NUMBER:
2126         case LyXRC::RC_BACKUPDIR_PATH:
2127         case LyXRC::RC_BIBTEX_COMMAND:
2128         case LyXRC::RC_BINDFILE:
2129         case LyXRC::RC_CHECKLASTFILES:
2130         case LyXRC::RC_USELASTFILEPOS:
2131         case LyXRC::RC_LOADSESSION:
2132         case LyXRC::RC_CHKTEX_COMMAND:
2133         case LyXRC::RC_CONVERTER:
2134         case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
2135         case LyXRC::RC_COPIER:
2136         case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
2137         case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
2138         case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
2139         case LyXRC::RC_DATE_INSERT_FORMAT:
2140         case LyXRC::RC_DEFAULT_LANGUAGE:
2141         case LyXRC::RC_DEFAULT_PAPERSIZE:
2142         case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
2143         case LyXRC::RC_DISPLAY_GRAPHICS:
2144         case LyXRC::RC_DOCUMENTPATH:
2145                 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
2146                         string const encoded = FileName(
2147                                 lyxrc_new.document_path).toFilesystemEncoding();
2148                         if (fs::exists(encoded) && fs::is_directory(encoded))
2149                                 support::package().document_dir() = lyxrc.document_path;
2150                 }
2151         case LyXRC::RC_ESC_CHARS:
2152         case LyXRC::RC_FONT_ENCODING:
2153         case LyXRC::RC_FORMAT:
2154         case LyXRC::RC_INDEX_COMMAND:
2155         case LyXRC::RC_INPUT:
2156         case LyXRC::RC_KBMAP:
2157         case LyXRC::RC_KBMAP_PRIMARY:
2158         case LyXRC::RC_KBMAP_SECONDARY:
2159         case LyXRC::RC_LABEL_INIT_LENGTH:
2160         case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
2161         case LyXRC::RC_LANGUAGE_AUTO_END:
2162         case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
2163         case LyXRC::RC_LANGUAGE_COMMAND_END:
2164         case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
2165         case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
2166         case LyXRC::RC_LANGUAGE_PACKAGE:
2167         case LyXRC::RC_LANGUAGE_USE_BABEL:
2168         case LyXRC::RC_MAKE_BACKUP:
2169         case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
2170         case LyXRC::RC_NUMLASTFILES:
2171         case LyXRC::RC_PATH_PREFIX:
2172                 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
2173                         support::prependEnvPath("PATH", lyxrc.path_prefix);
2174                 }
2175         case LyXRC::RC_PERS_DICT:
2176         case LyXRC::RC_POPUP_BOLD_FONT:
2177         case LyXRC::RC_POPUP_FONT_ENCODING:
2178         case LyXRC::RC_POPUP_NORMAL_FONT:
2179         case LyXRC::RC_PREVIEW:
2180         case LyXRC::RC_PREVIEW_HASHED_LABELS:
2181         case LyXRC::RC_PREVIEW_SCALE_FACTOR:
2182         case LyXRC::RC_PRINTCOLLCOPIESFLAG:
2183         case LyXRC::RC_PRINTCOPIESFLAG:
2184         case LyXRC::RC_PRINTER:
2185         case LyXRC::RC_PRINTEVENPAGEFLAG:
2186         case LyXRC::RC_PRINTEXSTRAOPTIONS:
2187         case LyXRC::RC_PRINTFILEEXTENSION:
2188         case LyXRC::RC_PRINTLANDSCAPEFLAG:
2189         case LyXRC::RC_PRINTODDPAGEFLAG:
2190         case LyXRC::RC_PRINTPAGERANGEFLAG:
2191         case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
2192         case LyXRC::RC_PRINTPAPERFLAG:
2193         case LyXRC::RC_PRINTREVERSEFLAG:
2194         case LyXRC::RC_PRINTSPOOL_COMMAND:
2195         case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
2196         case LyXRC::RC_PRINTTOFILE:
2197         case LyXRC::RC_PRINTTOPRINTER:
2198         case LyXRC::RC_PRINT_ADAPTOUTPUT:
2199         case LyXRC::RC_PRINT_COMMAND:
2200         case LyXRC::RC_RTL_SUPPORT:
2201         case LyXRC::RC_SCREEN_DPI:
2202         case LyXRC::RC_SCREEN_FONT_ENCODING:
2203         case LyXRC::RC_SCREEN_FONT_ROMAN:
2204         case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
2205         case LyXRC::RC_SCREEN_FONT_SANS:
2206         case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2207         case LyXRC::RC_SCREEN_FONT_SCALABLE:
2208         case LyXRC::RC_SCREEN_FONT_SIZES:
2209         case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2210         case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2211         case LyXRC::RC_SCREEN_GEOMETRY_HEIGHT:
2212         case LyXRC::RC_SCREEN_GEOMETRY_WIDTH:
2213         case LyXRC::RC_SCREEN_GEOMETRY_XYSAVED:
2214         case LyXRC::RC_SCREEN_ZOOM:
2215         case LyXRC::RC_SERVERPIPE:
2216         case LyXRC::RC_SET_COLOR:
2217         case LyXRC::RC_SHOW_BANNER:
2218         case LyXRC::RC_SPELL_COMMAND:
2219         case LyXRC::RC_TEMPDIRPATH:
2220         case LyXRC::RC_TEMPLATEPATH:
2221         case LyXRC::RC_TEX_ALLOWS_SPACES:
2222         case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2223                 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2224                         support::os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2225                 }
2226         case LyXRC::RC_UIFILE:
2227         case LyXRC::RC_USER_EMAIL:
2228         case LyXRC::RC_USER_NAME:
2229         case LyXRC::RC_USETEMPDIR:
2230         case LyXRC::RC_USE_ALT_LANG:
2231         case LyXRC::RC_USE_CONVERTER_CACHE:
2232         case LyXRC::RC_USE_ESC_CHARS:
2233         case LyXRC::RC_USE_INP_ENC:
2234         case LyXRC::RC_USE_PERS_DICT:
2235         case LyXRC::RC_USE_SPELL_LIB:
2236         case LyXRC::RC_VIEWDVI_PAPEROPTION:
2237         case LyXRC::RC_VIEWER:
2238         case LyXRC::RC_LAST:
2239                 break;
2240         }
2241 }
2242
2243 } // namespace anon
2244
2245
2246 } // namespace lyx