src/insets/insetbib.C

   1 #include <config.h>
   2
   3 #include <fstream>
   4 using std::ifstream;
   5
   6 #include <cstdlib>
   7
   8 #ifdef __GNUG__
   9 #pragma implementation
  10 #endif
  11
  12 #include FORMS_H_LOCATION
  13 #include "insetbib.h"
  14 #include "combox.h"
  15 #include "buffer.h"
  16 #include "debug.h"
  17 #include "lyx_gui_misc.h"
  18 #include "BufferView.h"
  19 #include "gettext.h"
  20 #include "bibforms.h"
  21 #include "lyxtext.h"
  22 #include "support/filetools.h"
  23
  24 extern BufferView * current_view;
  25
  26 FD_citation_form * citation_form = 0;
  27 FD_bibitem_form * bibitem_form = 0;
  28 static Combox * bibcombox = 0;
  29
  30 void BibitemUpdate(Combox *);
  31 FD_citation_form * create_form_citation_form(void);
  32 FD_bibitem_form * create_form_bibitem_form(void);
  33
  34
  35 extern "C" void bibitem_cb(FL_OBJECT *, long data)
  36 {
  37         switch (data) {
  38         case 1: // OK, citation
  39         {
  40                 InsetCitation::Holder * holder =
  41                         static_cast<InsetCitation::Holder*>
  42                         (citation_form->citation_form->u_vdata);
  43                 if(!holder->view->buffer()->isReadonly()) {
  44
  45                         InsetCitation * inset = holder->inset;
  46                         inset->setContents(bibcombox->getline());
  47                         inset->setOptions(fl_get_input(citation_form->label));
  48                         fl_hide_form(citation_form->citation_form);
  49                         // shouldn't mark the buffer dirty unless something
  50                         // was actually altered
  51                         holder->view->updateInset(inset, true);
  52                         break;
  53                 }
  54                 // fall through to Cancel on RO-mode
  55         }
  56         case 0: fl_hide_form(citation_form->citation_form);
  57                 break;
  58         case 3: // OK, bibitem
  59         {
  60                 InsetBibKey::Holder * holder =
  61                         static_cast<InsetBibKey::Holder*>
  62                         (bibitem_form->bibitem_form->u_vdata);
  63
  64                 if(!holder->view->buffer()->isReadonly()) {
  65                         InsetBibKey * inset = holder->inset;
  66                         inset->setContents(fl_get_input(bibitem_form->key));
  67                         inset->setOptions(fl_get_input(bibitem_form->label));
  68                         fl_hide_form(bibitem_form->bibitem_form);
  69                         // Does look like a hack? It is! (but will change at 0.13)
  70                         holder->view->text->RedoParagraph();
  71                         holder->view->update(1);
  72                         break;
  73                 } // fall through to Cancel on RO-mode
  74         }
  75         case 2: // Cancel, bibitem
  76                 fl_hide_form(bibitem_form->bibitem_form); // Cancel, bibitem
  77                 break;
  78         }
  79 }
  80
  81
  82 FD_citation_form * create_form_citation_form(void)
  83 {
  84         FL_OBJECT * obj;
  85         FD_citation_form * fdui = (FD_citation_form *) fl_calloc(1, sizeof(FD_citation_form));
  86
  87         fdui->citation_form = fl_bgn_form(FL_NO_BOX, 220, 130);
  88         obj = fl_add_box(FL_UP_BOX, 0, 0, 220, 130, "");
  89         fdui->key = obj = fl_add_text(FL_NORMAL_TEXT, 20, 10, 60, 30, _("Key:"));
  90         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
  91         fl_set_object_lalign(obj, FL_ALIGN_RIGHT);
  92
  93         bibcombox = new Combox(FL_COMBOX_INPUT);
  94         bibcombox->add(80, 10, 130, 30, 300);
  95
  96         obj = fl_add_button(FL_RETURN_BUTTON, 20, 90, 90, 30, _("OK"));
  97         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
  98         fl_set_object_callback(obj, bibitem_cb, 1);
  99         obj = fl_add_button(FL_NORMAL_BUTTON, 120, 90, 90, 30, idex(_("Cancel|^[")));
 100         fl_set_button_shortcut(obj, scex(_("Cancel|^[")), 1);
 101         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 102         fl_set_object_callback(obj, bibitem_cb, 0);
 103         fdui->label = obj = fl_add_input(FL_NORMAL_INPUT, 80, 50, 130, 30, idex(_("Remark:|#R")));
 104         fl_set_input_shortcut(obj, scex(_("Remark:|#R")), 1);
 105         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 106         fl_end_form();
 107
 108         //fdui->citation_form->fdui = fdui;
 109
 110         return fdui;
 111 }
 112 /*---------------------------------------*/
 113
 114 FD_bibitem_form * create_form_bibitem_form(void)
 115 {
 116         FL_OBJECT * obj;
 117         FD_bibitem_form * fdui = (FD_bibitem_form *) fl_calloc(1, sizeof(FD_bibitem_form));
 118
 119         fdui->bibitem_form = fl_bgn_form(FL_NO_BOX, 220, 130);
 120         obj = fl_add_box(FL_UP_BOX, 0, 0, 220, 130, "");
 121         fdui->key = obj = fl_add_input(FL_NORMAL_INPUT, 80, 10, 130, 30, idex(_("Key:|#K")));
 122         fl_set_input_shortcut(obj, scex(_("Key:|#K")), 1);
 123         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 124         obj = fl_add_button(FL_RETURN_BUTTON, 20, 90, 90, 30, _("OK"));
 125         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 126         fl_set_object_callback(obj, bibitem_cb, 3);
 127         obj = fl_add_button(FL_NORMAL_BUTTON, 120, 90, 90, 30, idex(_("Cancel|^[")));
 128         fl_set_button_shortcut(obj, scex(_("Cancel|^[")), 1);
 129         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 130         fl_set_object_callback(obj, bibitem_cb, 2);
 131         fdui->label = obj = fl_add_input(FL_NORMAL_INPUT, 80, 50, 130, 30, idex(_("Label:|#L")));
 132         fl_set_input_shortcut(obj, scex(_("Label:|#L")), 1);
 133         fl_set_object_lsize(obj, FL_NORMAL_SIZE);
 134         fl_end_form();
 135
 136         //fdui->bibitem_form->fdui = fdui;
 137
 138         return fdui;
 139 }
 140 /*---------------------------------------*/
 141
 142
 143 InsetCitation::InsetCitation(string const & key, string const & note)
 144         : InsetCommand("cite", key, note)
 145 {
 146
 147 }
 148
 149
 150 InsetCitation::~InsetCitation()
 151 {
 152         if(citation_form && citation_form->citation_form
 153            && citation_form->citation_form->visible
 154            && citation_form->citation_form->u_vdata == &holder)
 155                 fl_hide_form(citation_form->citation_form);
 156 }
 157
 158
 159 void InsetCitation::Edit(BufferView * bv, int, int, unsigned int)
 160 {
 161         if(bv->buffer()->isReadonly())
 162                 WarnReadonly(bv->buffer()->fileName());
 163
 164         if (!citation_form) {
 165                 citation_form = create_form_citation_form();
 166                 fl_set_form_atclose(citation_form->citation_form,
 167                                     CancelCloseBoxCB, 0);
 168         }
 169
 170         holder.inset = this;
 171         holder.view = bv;
 172
 173         citation_form->citation_form->u_vdata = &holder;
 174
 175         BibitemUpdate(bibcombox);
 176         if (!bibcombox->select_text(getContents().c_str()))
 177                 bibcombox->addline(getContents().c_str());
 178
 179         fl_set_input(citation_form->label, getOptions().c_str());
 180         if (citation_form->citation_form->visible) {
 181                 fl_raise_form(citation_form->citation_form);
 182         } else {
 183                 fl_show_form(citation_form->citation_form,
 184                              FL_PLACE_MOUSE, FL_FULLBORDER,
 185                              _("Citation"));
 186         }
 187 }
 188
 189
 190 string InsetCitation::getScreenLabel() const
 191 {
 192         string temp("[");
 193
 194         temp += contents;
 195
 196         if (!options.empty()) {
 197                 temp += ", " + options;
 198         }
 199
 200         return temp + ']';
 201 }
 202
 203
 204 InsetBibKey::InsetBibKey(string const & key, string const & label):
 205         InsetCommand("bibitem", key, label)
 206 {
 207         counter = 1;
 208         if (key.empty())
 209                 contents = ' ';
 210 }
 211
 212
 213 InsetBibKey::InsetBibKey(InsetBibKey const * b):
 214         InsetCommand("bibitem", b->contents, b->options)
 215 {
 216         counter = b->counter;
 217 }
 218
 219
 220 InsetBibKey::~InsetBibKey()
 221 {
 222         if(bibitem_form && bibitem_form->bibitem_form
 223            && bibitem_form->bibitem_form->visible
 224            && bibitem_form->bibitem_form->u_vdata == &holder)
 225                 fl_hide_form(bibitem_form->bibitem_form);
 226 }
 227
 228 void InsetBibKey::setCounter(int c)
 229 {
 230         counter = c;
 231
 232         if (contents.empty())
 233                 contents += tostr(counter);
 234 }
 235
 236
 237 // I'm sorry but this is still necessary because \bibitem is used also
 238 // as a LyX 2.x command, and lyxlex is not enough smart to understand
 239 // real LaTeX commands. Yes, that could be fixed, but would be a waste
 240 // of time cause LyX3 won't use lyxlex anyway.  (ale)
 241 void InsetBibKey::Write(ostream & os) const
 242 {
 243         os << "\\bibitem ";
 244         if (!options.empty()) {
 245                 os << '['
 246                    << options << ']';
 247         }
 248         os << '{'
 249            << contents << "}\n";
 250 }
 251
 252
 253 string InsetBibKey::getScreenLabel() const
 254 {
 255         if (!options.empty())
 256                 return options;
 257
 258         return tostr(counter);
 259 }
 260
 261
 262 /*
 263   The value in "Key:" isn't allways set right after a few bibkey insets have
 264   been added/removed.  Perhaps the wrong object is deleted/used somewhere
 265   upwards?
 266   (Joacim 1998-03-04)
 267 */
 268 void InsetBibKey::Edit(BufferView * bv, int, int, unsigned int)
 269 {
 270         if(bv->buffer()->isReadonly())
 271                 WarnReadonly(bv->buffer()->fileName());
 272
 273         if (!bibitem_form) {
 274                 bibitem_form = create_form_bibitem_form();
 275                 fl_set_form_atclose(bibitem_form->bibitem_form,
 276                                     CancelCloseBoxCB, 0);
 277         }
 278
 279         holder.inset = this;
 280         holder.view = bv;
 281
 282         bibitem_form->bibitem_form->u_vdata = &holder;
 283         // InsetBibtex uses the same form, with different labels
 284         fl_set_object_label(bibitem_form->key, idex(_("Key:|#K")));
 285         fl_set_button_shortcut(bibitem_form->key, scex(_("Key:|#K")), 1);
 286         fl_set_object_label(bibitem_form->label, idex(_("Label:|#L")));
 287         fl_set_button_shortcut(bibitem_form->label, scex(_("Label:|#L")), 1);
 288         fl_set_input(bibitem_form->key, getContents().c_str());
 289         fl_set_input(bibitem_form->label, getOptions().c_str());
 290         if (bibitem_form->bibitem_form->visible) {
 291                 fl_raise_form(bibitem_form->bibitem_form);
 292         } else {
 293                 fl_show_form(bibitem_form->bibitem_form, FL_PLACE_MOUSE,
 294                              FL_FULLBORDER,
 295                              _("Bibliography item"));
 296         }
 297 }
 298
 299
 300
 301 InsetBibtex::InsetBibtex(string const & dbase, string const & style,
 302                          Buffer * o)
 303         : InsetCommand("BibTeX", dbase, style), owner(o)
 304 {
 305 }
 306
 307 InsetBibtex::~InsetBibtex()
 308 {
 309         if(bibitem_form && bibitem_form->bibitem_form
 310            && bibitem_form->bibitem_form->visible
 311            && bibitem_form->bibitem_form->u_vdata == &holder)
 312                 fl_hide_form(bibitem_form->bibitem_form);
 313 }
 314
 315
 316 string InsetBibtex::getScreenLabel() const
 317 {
 318         return _("BibTeX Generated References");
 319 }
 320
 321
 322 int InsetBibtex::Latex(ostream & os, signed char /*fragile*/, bool/*fs*/) const
 323 {
 324         // this looks like an horrible hack and it is :) The problem
 325         // is that owner is not initialized correctly when the bib
 326         // inset is cut and pasted. Such hacks will not be needed
 327         // later (JMarc)
 328         if (!owner) {
 329                 owner = current_view->buffer();
 330         }
 331         // If we generate in a temp dir, we might need to give an
 332         // absolute path there. This is a bit complicated since we can
 333         // have a comma-separated list of bibliographies
 334         string adb, db_out;
 335         string db_in = getContents();
 336         db_in = split(db_in, adb, ',');
 337         while(!adb.empty()) {
 338                 if (!owner->niceFile &&
 339                     IsFileReadable(MakeAbsPath(adb, owner->filepath)+".bib"))
 340                         adb = MakeAbsPath(adb, owner->filepath);
 341                 db_out += adb;
 342                 db_out += ',';
 343                 db_in= split(db_in, adb,',');
 344         }
 345         db_out = strip(db_out, ',');
 346         // Idem, but simpler
 347         string style;
 348         if (!owner->niceFile
 349             && IsFileReadable(MakeAbsPath(getOptions(), owner->filepath)
 350                               + ".bst"))
 351                 style = MakeAbsPath(getOptions(), owner->filepath);
 352         else
 353                 style = getOptions();
 354
 355         os << "\\bibliographystyle{" << style << "}\n"
 356            << "\\bibliography{" << db_out << "}\n";
 357         return 2;
 358 }
 359
 360
 361 // This method returns a comma separated list of Bibtex entries
 362 string InsetBibtex::getKeys(char delim)
 363 {
 364         // This hack is copied from InsetBibtex::Latex.
 365         // Is it still needed? Probably yes.
 366         // Why is this needed here when it already is in Latex?
 367         // Anyway we need a different way to get to the
 368         // buffer the inset is in. (Lgb)
 369
 370         //if (!owner) {
 371         //      owner = current_view->buffer();
 372         //}
 373
 374         string tmp, keys;
 375         string bibfiles = getContents();
 376         bibfiles = split(bibfiles, tmp, ',');
 377         while(!tmp.empty()) {
 378                 string fil = findtexfile(ChangeExtension(tmp, "bib", false),
 379                                          "bib");
 380                 lyxerr[Debug::LATEX] << "Bibfile: " << fil << endl;
 381                 // If we didn't find a matching file name just fail silently
 382                 if (!fil.empty()) {
 383                         // This is a _very_ simple parser for Bibtex database
 384                         // files. All it does is to look for lines starting
 385                         // in @ and not being @preamble and @string entries.
 386                         // It does NOT do any syntax checking!
 387                         ifstream ifs(fil.c_str());
 388                         string linebuf;
 389                         while (getline(ifs, linebuf)) {
 390                                 linebuf = frontStrip(linebuf);
 391                                 if (prefixIs(linebuf, "@")) {
 392                                         linebuf = subst(linebuf, '{', '(');
 393                                         linebuf = split(linebuf, tmp, '(');
 394                                         tmp = lowercase(tmp);
 395                                         if (!prefixIs(tmp, "@string")
 396                                             && !prefixIs(tmp, "@preamble")) {
 397                                                 linebuf = split(linebuf,
 398                                                                 tmp, ',');
 399                                                 tmp = frontStrip(strip(tmp));
 400                                                 if (!tmp.empty()) {
 401                                                         keys += tmp;
 402                                                         keys += delim;
 403                                                 }
 404                                         }
 405                                 }
 406                         }
 407                 }
 408                 // Get next file name
 409                 bibfiles = split(bibfiles, tmp, ',');
 410         }
 411         return keys;
 412 }
 413
 414
 415 // BibTeX should have its own dialog. This is provisional.
 416 void InsetBibtex::Edit(BufferView * bv, int, int, unsigned int)
 417 {
 418         if (!bibitem_form) {
 419                 bibitem_form = create_form_bibitem_form();
 420                 fl_set_form_atclose(bibitem_form->bibitem_form,
 421                                     CancelCloseBoxCB, 0);
 422         }
 423
 424         holder.inset = this;
 425         holder.view = bv;
 426         bibitem_form->bibitem_form->u_vdata = &holder;
 427
 428         fl_set_object_label(bibitem_form->key, _("Database:"));
 429         fl_set_object_label(bibitem_form->label, _("Style:  "));
 430         fl_set_input(bibitem_form->key, getContents().c_str());
 431         fl_set_input(bibitem_form->label, getOptions().c_str());
 432         if (bibitem_form->bibitem_form->visible) {
 433                 fl_raise_form(bibitem_form->bibitem_form);
 434         } else {
 435                 fl_show_form(bibitem_form->bibitem_form,
 436                              FL_PLACE_MOUSE, FL_FULLBORDER,
 437                              _("BibTeX"));
 438         }
 439 }
 440
 441
 442 bool InsetBibtex::addDatabase(string const & db)
 443 {
 444         if (!contains(contents, db.c_str())) {
 445                 if (!contents.empty())
 446                         contents += ',';
 447                 contents += db;
 448                 return true;
 449         }
 450         return false;
 451 }
 452
 453
 454 bool InsetBibtex::delDatabase(string const & db)
 455 {
 456         if (contains(contents, db.c_str())) {
 457                 string bd = db;
 458                 int n = tokenPos(contents, ',', bd);
 459                 if (n > 0) {
 460                         // Weird code, would someone care to explain this?(Lgb)
 461                         string tmp(", ");
 462                         tmp += bd;
 463                         contents = subst(contents, tmp.c_str(), ", ");
 464                 } else if (n == 0)
 465                         contents = split(contents, bd, ',');
 466                 else
 467                         return false;
 468         }
 469         return true;
 470 }
 471
 472
 473 // This function should be in LyXView when multiframe works ale970302
 474 void BibitemUpdate(Combox * combox)
 475 {
 476         combox->clear();
 477
 478         if (!current_view->available()) return;
 479
 480         string tmp, bibkeys = current_view->buffer()->getBibkeyList(',');
 481         bibkeys = split(bibkeys, tmp,',');
 482         while (!tmp.empty()) {
 483                 combox->addto(tmp.c_str());
 484                 bibkeys = split(bibkeys, tmp,',');
 485         }
 486 }
 487
 488
 489
 490 // ale070405 This function maybe shouldn't be here. We'll fix this at 0.13.
 491 int bibitemMaxWidth(Painter & pain, LyXFont const & font)
 492 {
 493         int w = 0;
 494         // Does look like a hack? It is! (but will change at 0.13)
 495         LyXParagraph * par = current_view->buffer()->paragraph;
 496
 497         while (par) {
 498                 if (par->bibkey) {
 499                         int wx = par->bibkey->width(pain, font);
 500                         if (wx > w) w = wx;
 501                 }
 502                 par = par->next;
 503         }
 504         return w;
 505 }
 506
 507
 508 // ale070405
 509 string bibitemWidthest(Painter & pain)
 510 {
 511         int w = 0;
 512         // Does look like a hack? It is! (but will change at 0.13)
 513         LyXParagraph * par = current_view->buffer()->paragraph;
 514         InsetBibKey * bkey = 0;
 515         LyXFont font;
 516
 517         while (par) {
 518                 if (par->bibkey) {
 519                         int wx = par->bibkey->width(pain, font);
 520                         if (wx > w) {
 521                                 w = wx;
 522                                 bkey = par->bibkey;
 523                         }
 524                 }
 525                 par = par->next;
 526         }
 527
 528         if (bkey && !bkey->getScreenLabel().empty())
 529                 return bkey->getScreenLabel();
 530
 531         return "99";
 532 }