src/lyx_gui_misc.C

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-1999 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #include <config.h>
  13
  14 #include <cerrno>
  15 #include "lyx_gui_misc.h"
  16 #include "BufferView.h"
  17 #include "bibforms.h"
  18 #include "buffer.h"
  19 #include "bullet_forms.h"
  20 #include "form1.h"
  21 #include "gettext.h"
  22 #include "include_form.h"
  23 #include "latexoptions.h"
  24 #include "layout_forms.h"
  25 #include "lyx.h"
  26 #include "lyx_cb.h"
  27 #include "lyx_main.h"
  28 #include "mathed/math_forms.h"
  29 #include "minibuffer.h"
  30 #include "print_form.h"
  31 #include "sp_form.h"
  32 #include "insets/insetindex.h"
  33 #include "LyXView.h"
  34
  35 using std::make_pair;
  36
  37 extern BufferView * current_view;
  38
  39 extern FD_form_paragraph * fd_form_paragraph;
  40 extern FD_form_paragraph_extra * fd_form_paragraph_extra;
  41 extern FD_form_search * fd_form_search;
  42 extern FD_form_character * fd_form_character;
  43 extern FD_form_document * fd_form_document;
  44 extern FD_form_paper * fd_form_paper;
  45 extern FD_form_table_options * fd_form_table_options;
  46 extern FD_form_quotes * fd_form_quotes;
  47 extern FD_form_preamble * fd_form_preamble;
  48 extern FD_form_table * fd_form_table;
  49 extern FD_form_print * fd_form_print;
  50 extern FD_form_sendto * fd_form_sendto;
  51 extern FD_form_figure * fd_form_figure;
  52 extern FD_form_toc * fd_form_toc;
  53 extern FD_form_ref * fd_form_ref;
  54 extern FD_form_paragraph_extra * fd_form_paragraph_extra;
  55 extern FD_LaTeXLog * fd_latex_log;
  56 extern FD_form_spell_check * fd_form_spell_check;
  57 extern FD_form_bullet * fd_form_bullet;
  58 extern FD_panel  * fd_panel;
  59 extern FD_delim  * fd_delim;
  60 extern FD_deco   * fd_deco;
  61 extern FD_space  * fd_space;
  62 extern FD_matrix * fd_matrix;
  63 extern FD_citation_form * citation_form;
  64 extern FD_bibitem_form * bibitem_form;
  65 extern FD_include * form;
  66 extern FD_index_form * index_form;
  67
  68 extern void TocUpdateCB();
  69 extern void HideFiguresPopups();
  70
  71 // Prevents LyX from being killed when the close box is pressed in a popup.
  72 extern "C" int CancelCloseBoxCB(FL_FORM *, void *)
  73 {
  74         return FL_CANCEL;
  75 }
  76
  77
  78 // Prevents LyX from being killed when the close box is pressed in a popup.
  79 extern "C" int IgnoreCloseBoxCB(FL_FORM *, void *)
  80 {
  81         return FL_IGNORE;
  82 }
  83
  84
  85 // Prevents LyX from crashing when no buffers available
  86 // This is also one of the functions that we _really_ dont want
  87 // we should try to finds way to help us with that.
  88 // The signal/slot mechanism can probably help.
  89 void CloseAllBufferRelatedPopups()
  90 {
  91         // don't forget to check that dynamically created forms
  92         // have been created otherwise hiding one could cause a crash
  93         // need the visible check otherwise XForms prints a warning
  94         // if hiding an invisible form
  95         if (fd_form_paragraph->form_paragraph->visible) {
  96                 fl_hide_form(fd_form_paragraph->form_paragraph);
  97         }
  98         if (fd_form_paragraph_extra->form_paragraph_extra->visible) {
  99                 fl_hide_form(fd_form_paragraph_extra->form_paragraph_extra);
 100         }
 101         if (fd_form_search->form_search->visible) {
 102                 fl_hide_form(fd_form_search->form_search);
 103         }
 104         if (fd_form_character->form_character->visible) {
 105                 fl_hide_form(fd_form_character->form_character);
 106         }
 107         if (fd_form_document->form_document->visible) {
 108                 fl_hide_form(fd_form_document->form_document);
 109         }
 110         if (fd_form_quotes->form_quotes->visible) {
 111                 fl_hide_form(fd_form_quotes->form_quotes);
 112         }
 113         if (fd_form_preamble->form_preamble->visible) {
 114                 fl_hide_form(fd_form_preamble->form_preamble);
 115         }
 116         if (fd_form_table->form_table->visible) {
 117                 fl_hide_form(fd_form_table->form_table);
 118         }
 119         if (fd_form_print->form_print->visible) {
 120                 fl_hide_form(fd_form_print->form_print);
 121         }
 122         if (fd_form_figure->form_figure->visible) {
 123                 fl_hide_form(fd_form_figure->form_figure);
 124         }
 125         if (fd_form_toc->form_toc->visible) {
 126                 fl_hide_form(fd_form_toc->form_toc);
 127         }
 128         if (fd_form_ref->form_ref->visible) {
 129                 fl_hide_form(fd_form_ref->form_ref);
 130         }
 131         if (fd_form_paper->form_paper->visible) {
 132                 fl_hide_form(fd_form_paper->form_paper);
 133         }
 134         if (fd_form_table_options->form_table_options->visible) {
 135                 fl_hide_form(fd_form_table_options->form_table_options);
 136         }
 137         if (fd_form_sendto->form_sendto->visible) {
 138                 fl_hide_form(fd_form_sendto->form_sendto);
 139         }
 140         if (fd_latex_log->LaTeXLog->visible) {
 141                 fl_hide_form(fd_latex_log->LaTeXLog);
 142         }
 143         if (fd_form_spell_check) {
 144                 if (fd_form_spell_check->form_spell_check->visible) {
 145                         fl_trigger_object(fd_form_spell_check->done);
 146                 }
 147         }
 148         if (fd_form_bullet) {
 149                 if (fd_form_bullet->form_bullet->visible) {
 150                         fl_hide_form(fd_form_bullet->form_bullet);
 151                 }
 152         }
 153         if (fd_panel) {
 154                 if (fd_panel->panel->visible) {
 155                         fl_hide_form(fd_panel->panel);
 156                 }
 157         }
 158         if (fd_delim) {
 159                 if (fd_delim->delim->visible) {
 160                         fl_hide_form(fd_delim->delim);
 161                 }
 162         }
 163         if (fd_deco) {
 164                 if (fd_deco->deco->visible) {
 165                         fl_hide_form(fd_deco->deco);
 166                 }
 167         }
 168         if (fd_space) {
 169                 if (fd_space->space->visible) {
 170                         fl_hide_form(fd_space->space);
 171                 }
 172         }
 173         if (fd_matrix) {
 174                 if (fd_matrix->matrix->visible) {
 175                         fl_hide_form(fd_matrix->matrix);
 176                 }
 177         }
 178         if (citation_form) {
 179                 if (citation_form->citation_form->visible) {
 180                         fl_hide_form(citation_form->citation_form);
 181                 }
 182         }
 183         if (bibitem_form) {
 184                 if (bibitem_form->bibitem_form->visible) {
 185                         fl_hide_form(bibitem_form->bibitem_form);
 186                 }
 187         }
 188         if (form) {
 189                 if (form->include->visible) {
 190                         fl_hide_form(form->include);
 191                 }
 192         }
 193         if (index_form) {
 194                 if (index_form->index_form->visible) {
 195                         fl_hide_form(index_form->index_form);
 196                 }
 197         }
 198         HideFiguresPopups();
 199 }
 200
 201 // This is another function we really don't want.
 202 // Again the Signal/Slot mechanism is tailor made for this task.
 203 void updateAllVisibleBufferRelatedPopups()
 204 {
 205         if (fd_form_document->form_document->visible) {
 206                 UpdateLayoutDocument();
 207         }
 208         if (fd_form_preamble->form_preamble->visible) {
 209                 UpdateLayoutPreamble();
 210         }
 211         if (fd_form_quotes->form_quotes->visible) {
 212                 UpdateLayoutQuotes();
 213         }
 214         if (fd_form_paragraph->form_paragraph->visible) {
 215                 UpdateLayoutParagraph();
 216         }
 217         if (fd_form_paragraph_extra->form_paragraph_extra->visible) {
 218                 UpdateParagraphExtra();
 219         }
 220         if (fd_form_paper->form_paper->visible) {
 221                 UpdateLayoutPaper();
 222         }
 223         if (fd_form_table_options->form_table_options->visible) {
 224                 UpdateLayoutTable(1); // just like a right mouse click
 225         }
 226         if (fd_form_bullet) {
 227                 if (fd_form_bullet->form_bullet->visible) {
 228                         updateBulletForm();
 229                 }
 230         }
 231         if (fd_form_toc->browser_toc->visible) {
 232                 TocUpdateCB(0, 0);
 233         }
 234 #ifdef ALWAYS_UPDATE_REF
 235         // Ideally, the RefUpdateCB should be modified so that if the
 236         // current document is a subdocument the reference list should come
 237         // from master document (or even be a merger of references from all
 238         // its sibling documents).  For now this has effectively been
 239         // commented out to ensure that users of multipart documents can
 240         // access the reference list of a different document.  This is
 241         // of course a compromise and an annoyance for users switching
 242         // between separate documents.  ARRae 241198
 243         if (fd_form_ref->form_ref->visible) {
 244                 RefUpdateCB(0, 0);
 245         }
 246 #endif
 247         if (current_view->buffer()->isReadonly()) {
 248                 // a little crude perhaps but it works. ARRae
 249                 if (fd_form_character->form_character->visible) {
 250                         fl_hide_form(fd_form_character->form_character);
 251                 }
 252                 if (fd_form_table->form_table->visible) {
 253                         fl_hide_form(fd_form_table->form_table);
 254                 }
 255         }
 256
 257         // We have either changed buffers or changed the readonly status
 258         // so the safest thing to do is hide all inset popups that
 259         // are editting insets from the previous buffer or aren't
 260         // allowed in readonly docs.
 261         if (fd_panel) {
 262                 if (fd_panel->panel->visible) {
 263                         fl_hide_form(fd_panel->panel);
 264                 }
 265         }
 266         if (fd_delim) {
 267                 if (fd_delim->delim->visible) {
 268                         fl_hide_form(fd_delim->delim);
 269                 }
 270         }
 271         if (fd_deco) {
 272                 if (fd_deco->deco->visible) {
 273                         fl_hide_form(fd_deco->deco);
 274                 }
 275         }
 276         if (fd_space) {
 277                 if (fd_space->space->visible) {
 278                         fl_hide_form(fd_space->space);
 279                 }
 280         }
 281         if (fd_matrix) {
 282                 if (fd_matrix->matrix->visible) {
 283                         fl_hide_form(fd_matrix->matrix);
 284                 }
 285         }
 286         if (citation_form) {
 287                 if (citation_form->citation_form->visible) {
 288                         fl_hide_form(citation_form->citation_form);
 289                 }
 290         }
 291         if (bibitem_form) {
 292                 if (bibitem_form->bibitem_form->visible) {
 293                         fl_hide_form(bibitem_form->bibitem_form);
 294                 }
 295         }
 296         if (form) {
 297                 if (form->include->visible) {
 298                         fl_hide_form(form->include);
 299                 }
 300         }
 301         if (index_form) {
 302                 if (index_form->index_form->visible) {
 303                         fl_hide_form(index_form->index_form);
 304                 }
 305         }
 306         HideFiguresPopups();
 307 }
 308
 309 // Extract shortcut from <ident>|<shortcut> string
 310 char const * flyx_shortcut_extract(char const * sc)
 311 {
 312         // Find '|' in the sc and return the string after that.
 313         register char const * sd = sc;
 314         while(sd[0]!= 0 && sd[0] != '|') ++sd;
 315
 316         if (sd[0] == '|') {
 317                 ++sd;
 318                 //lyxerr << sd << endl;
 319                 return sd;
 320         }
 321         return "";
 322 }
 323
 324
 325 // Extract identifier from <ident>|<shortcut> string
 326 char const * flyx_ident_extract(char const * sc)
 327 {
 328         register char const * se = sc;
 329         while(se[0]!= 0 && se[0] != '|') ++se;
 330
 331         if (se[0] == 0) return sc;
 332
 333         char * sb = new char[se - sc + 1];
 334         int index = 0;
 335         register char const * sd = sc;
 336         while (sd != se) {
 337                 sb[index] = sd[0];
 338                 ++index; ++sd;
 339         }
 340         sb[index] = 0;
 341         return sb;
 342 }
 343
 344
 345 //
 346 void WriteAlert(string const & s1, string const & s2, string const & s3)
 347 {
 348         MiniBuffer * minibuffer = 0;
 349         if (current_view && current_view->owner())
 350                 minibuffer = current_view->owner()->getMiniBuffer();
 351         if (minibuffer) {
 352                 ProhibitInput();
 353                 minibuffer->Set(s1, s2, s3);
 354         }
 355
 356         fl_set_resource("flAlert.dismiss.label", _("Dismiss"));
 357         fl_show_alert(s1.c_str(), s2.c_str(), s3.c_str(), 0);
 358         if (minibuffer) {
 359                 AllowInput();
 360         }
 361 }
 362
 363
 364 // Alarms user of something related to files
 365 void WriteFSAlert(string const & s1, string const & s2)
 366 {
 367         WriteAlert (s1, s2, strerror(errno));
 368 }
 369
 370
 371 bool AskQuestion(string const & s1, string const & s2, string const & s3)
 372 {
 373         fl_set_resource("flQuestion.yes.label", idex(_("Yes|Yy#y")));
 374         fl_set_resource("flQuestion.no.label", idex(_("No|Nn#n")));
 375 #if FL_REVISION > 85
 376         return fl_show_question((s1 + "\n" + s2 + "\n" + s3).c_str(), 0);
 377 #else
 378         return fl_show_question(s1.c_str(), s2.c_str(), s3.c_str());
 379 #endif
 380 }
 381
 382
 383 // Returns 1 for yes, 2 for no, 3 for cancel.
 384 int AskConfirmation(string const & s1, string const & s2, string const & s3)
 385 {
 386         fl_set_choices_shortcut(scex(_("Yes|Yy#y")),
 387                                 scex(_("No|Nn#n")),
 388                                 scex(_("Cancel|^[")));
 389 #if FL_REVISION < 86
 390         return fl_show_choice(s1.c_str(), s2.c_str(), s3.c_str(),
 391                               3, idex(_("Yes|Yy#y")),
 392                               idex(_("No|Nn#n")),
 393                               idex(_("Cancel|^[")));
 394 #endif
 395 #if FL_REVISION > 85
 396         return fl_show_choice(s1.c_str(), s2.c_str(), s3.c_str(),
 397                               3, idex(_("Yes|Yy#y")),
 398                               idex(_("No|Nn#n")),
 399                               idex(_("Cancel|^[")), 3);
 400 #endif
 401 }
 402
 403
 404 // Asks for a text
 405 pair<bool, string> askForText(string const & msg, string const & dflt)
 406 {
 407         char const * tmp;
 408         fl_set_resource("flInput.cancel.label", idex(_("Cancel|^[")));
 409         fl_set_resource("flInput.ok.label", idex(_("OK|#O")));
 410         fl_set_resource("flInput.clear.label", idex(_("Clear|#e")));
 411         tmp = fl_show_input(msg.c_str(), dflt.c_str());
 412         if (tmp != 0)
 413           return make_pair<bool, string>(true, tmp);
 414         else
 415           return make_pair<bool, string>(false, string());
 416 }
 417
 418
 419 // Inform the user that the buffer is read-only, and that changes in the
 420 // dialog box that is to appear will be ignored.
 421 void WarnReadonly(string const & file)
 422 {
 423         WriteAlert(_("Any changes will be ignored"),
 424                    _("The document is read-only:"),
 425                    file);
 426 }