src/insets/InsetBox.cpp

   1 /**
   2  * \file InsetBox.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Martin Vermeer
   8  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "InsetBox.h"
  16
  17 #include "BufferView.h"
  18 #include "Cursor.h"
  19 #include "DispatchResult.h"
  20 #include "debug.h"
  21 #include "FuncStatus.h"
  22 #include "FuncRequest.h"
  23 #include "gettext.h"
  24 #include "LaTeXFeatures.h"
  25 #include "Color.h"
  26 #include "Lexer.h"
  27 #include "MetricsInfo.h"
  28
  29 #include "support/Translator.h"
  30
  31 #include <sstream>
  32
  33
  34 namespace lyx {
  35
  36 using std::string;
  37 using std::istringstream;
  38 using std::ostream;
  39 using std::ostringstream;
  40 using std::endl;
  41
  42
  43 namespace {
  44
  45 typedef Translator<std::string, InsetBox::BoxType> BoxTranslator;
  46 typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
  47
  48 BoxTranslator const init_boxtranslator()
  49 {
  50         BoxTranslator translator("Boxed", InsetBox::Boxed);
  51         translator.addPair("Frameless", InsetBox::Frameless);
  52         translator.addPair("ovalbox", InsetBox::ovalbox);
  53         translator.addPair("Ovalbox", InsetBox::Ovalbox);
  54         translator.addPair("Shadowbox", InsetBox::Shadowbox);
  55         translator.addPair("Doublebox",InsetBox::Doublebox);
  56         return translator;
  57 }
  58
  59
  60 BoxTranslatorLoc const init_boxtranslator_loc()
  61 {
  62         BoxTranslatorLoc translator(_("Boxed"), InsetBox::Boxed);
  63         translator.addPair(_("Frameless"), InsetBox::Frameless);
  64         translator.addPair(_("ovalbox"), InsetBox::ovalbox);
  65         translator.addPair(_("Ovalbox"), InsetBox::Ovalbox);
  66         translator.addPair(_("Shadowbox"), InsetBox::Shadowbox);
  67         translator.addPair(_("Doublebox"), InsetBox::Doublebox);
  68         return translator;
  69 }
  70
  71
  72 BoxTranslator const & boxtranslator()
  73 {
  74         static BoxTranslator translator = init_boxtranslator();
  75         return translator;
  76 }
  77
  78
  79 BoxTranslatorLoc const & boxtranslator_loc()
  80 {
  81         static BoxTranslatorLoc translator = init_boxtranslator_loc();
  82         return translator;
  83 }
  84
  85 } // anon
  86
  87
  88 void InsetBox::init()
  89 {
  90         setButtonLabel();
  91 }
  92
  93
  94 InsetBox::InsetBox(BufferParams const & bp, string const & label)
  95         : InsetCollapsable(bp), params_(label)
  96 {
  97         init();
  98 }
  99
 100
 101 InsetBox::InsetBox(InsetBox const & in)
 102         : InsetCollapsable(in), params_(in.params_)
 103 {
 104         init();
 105 }
 106
 107
 108 InsetBox::~InsetBox()
 109 {
 110         InsetBoxMailer(*this).hideDialog();
 111 }
 112
 113
 114 Inset * InsetBox::clone() const
 115 {
 116         return new InsetBox(*this);
 117 }
 118
 119
 120 docstring const InsetBox::editMessage() const
 121 {
 122         return _("Opened Box Inset");
 123 }
 124
 125
 126 void InsetBox::write(Buffer const & buf, ostream & os) const
 127 {
 128         params_.write(os);
 129         InsetCollapsable::write(buf, os);
 130 }
 131
 132
 133 void InsetBox::read(Buffer const & buf, Lexer & lex)
 134 {
 135         params_.read(lex);
 136         InsetCollapsable::read(buf, lex);
 137         setButtonLabel();
 138 }
 139
 140
 141 void InsetBox::setButtonLabel()
 142 {
 143         Font font(Font::ALL_SANE);
 144         font.decSize();
 145         font.decSize();
 146
 147         BoxType btype = boxtranslator().find(params_.type);
 148
 149         docstring label;
 150         label += _("Box");
 151         label += " (";
 152         if (btype == Frameless) {
 153                 if (params_.use_parbox)
 154                         label += _("Parbox");
 155                 else
 156                         label += _("Minipage");
 157         } else
 158                 label += boxtranslator_loc().find(btype);
 159         label += ")";
 160
 161         setLabel(label);
 162
 163         font.setColor(Color::foreground);
 164         setLabelFont(font);
 165 }
 166
 167
 168 bool InsetBox::hasFixedWidth() const
 169 {
 170       return params_.inner_box || params_.special != "width";
 171 }
 172
 173
 174 void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
 175 {
 176         // back up textwidth.
 177         int textwidth_backup = m.base.textwidth;
 178         if (hasFixedWidth())
 179                 m.base.textwidth = params_.width.inPixels(m.base.textwidth);
 180         InsetCollapsable::metrics(m, dim);
 181         // retore textwidth.
 182         m.base.textwidth = textwidth_backup;
 183 }
 184
 185
 186 bool InsetBox::forceDefaultParagraphs(idx_type) const
 187 {
 188         return !params_.inner_box;
 189 }
 190
 191
 192 bool InsetBox::showInsetDialog(BufferView * bv) const
 193 {
 194         InsetBoxMailer(const_cast<InsetBox &>(*this)).showDialog(bv);
 195         return true;
 196 }
 197
 198
 199 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
 200 {
 201         switch (cmd.action) {
 202
 203         case LFUN_INSET_MODIFY: {
 204                 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
 205                 InsetBoxMailer::string2params(to_utf8(cmd.argument()), params_);
 206                 setButtonLabel();
 207                 break;
 208         }
 209
 210         case LFUN_INSET_DIALOG_UPDATE:
 211                 InsetBoxMailer(*this).updateDialog(&cur.bv());
 212                 break;
 213
 214         case LFUN_MOUSE_RELEASE:
 215                 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
 216                         InsetBoxMailer(*this).showDialog(&cur.bv());
 217                         break;
 218                 }
 219                 InsetCollapsable::doDispatch(cur, cmd);
 220                 break;
 221
 222         default:
 223                 InsetCollapsable::doDispatch(cur, cmd);
 224                 break;
 225         }
 226 }
 227
 228
 229 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
 230                 FuncStatus & flag) const
 231 {
 232         switch (cmd.action) {
 233
 234         case LFUN_INSET_MODIFY:
 235         case LFUN_INSET_DIALOG_UPDATE:
 236                 flag.enabled(true);
 237                 return true;
 238         case LFUN_BREAK_PARAGRAPH:
 239                 if (params_.inner_box) {
 240                         return InsetCollapsable::getStatus(cur, cmd, flag);
 241                 } else {
 242                         flag.enabled(false);
 243                         return true;
 244                 }
 245
 246         default:
 247                 return InsetCollapsable::getStatus(cur, cmd, flag);
 248         }
 249 }
 250
 251
 252 int InsetBox::latex(Buffer const & buf, odocstream & os,
 253                     OutputParams const & runparams) const
 254 {
 255         BoxType btype = boxtranslator().find(params_.type);
 256
 257         string width_string = params_.width.asLatexString();
 258         bool stdwidth(false);
 259         if (params_.inner_box &&
 260                         (width_string.find("1.0\\columnwidth") != string::npos
 261                         || width_string.find("1.0\\textwidth") != string::npos)) {
 262                 stdwidth = true;
 263                 switch (btype) {
 264                 case Frameless:
 265                         break;
 266                 case Boxed:
 267                         width_string += " - 2\\fboxsep - 2\\fboxrule";
 268                         break;
 269                 case ovalbox:
 270                         width_string += " - 2\\fboxsep - 0.8pt";
 271                         break;
 272                 case Ovalbox:
 273                         width_string += " - 2\\fboxsep - 1.6pt";
 274                         break;
 275                 case Shadowbox:
 276                         // Shadow falls outside right margin... opinions?
 277                         width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
 278                         break;
 279                 case Doublebox:
 280                         width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1.0pt";
 281                         break;
 282                 }
 283         }
 284
 285         int i = 0;
 286         os << "%\n";
 287         // Adapt to column/text width correctly also if paragraphs indented:
 288         if (stdwidth)
 289                 os << "\\noindent";
 290
 291         switch (btype) {
 292         case Frameless:
 293                 break;
 294         case Boxed:
 295                 os << "\\framebox";
 296                 if (!params_.inner_box) {
 297                         os << "{\\makebox";
 298                         // Special widths, see usrguide §3.5
 299                         // FIXME UNICODE
 300                         if (params_.special != "none") {
 301                                 os << "[" << params_.width.value()
 302                                    << '\\' << from_utf8(params_.special)
 303                                    << ']';
 304                         } else
 305                                 os << '[' << from_ascii(width_string)
 306                                    << ']';
 307                         if (params_.hor_pos != 'c')
 308                                 os << "[" << params_.hor_pos << "]";
 309                 }
 310
 311                 os << "{";
 312                 break;
 313         case ovalbox:
 314                 os << "\\ovalbox{";
 315                 break;
 316         case Ovalbox:
 317                 os << "\\Ovalbox{";
 318                 break;
 319         case Shadowbox:
 320                 os << "\\shadowbox{";
 321                 break;
 322         case Doublebox:
 323                 os << "\\doublebox{";
 324                 break;
 325         }
 326
 327         if (params_.inner_box) {
 328                 if (params_.use_parbox)
 329                         os << "\\parbox";
 330                 else
 331                         os << "\\begin{minipage}";
 332
 333                 os << "[" << params_.pos << "]";
 334                 if (params_.height_special == "none") {
 335                         // FIXME UNICODE
 336                         os << "[" << from_ascii(params_.height.asLatexString()) << "]";
 337                 } else {
 338                         // Special heights
 339                         // set no optional argument when the value is the default "1\height"
 340                         // (special units like \height are handled as "in")
 341                         // but when the user has chosen a non-default inner_pos, the height
 342                         // must be given: \minipage[pos][height][inner-pos]{width}
 343                         if ((params_.height != Length("1in") ||
 344                                  params_.height_special != "totalheight") ||
 345                                 params_.inner_pos != params_.pos) {
 346                                 // FIXME UNICODE
 347                                 os << "[" << params_.height.value()
 348                                         << "\\" << from_utf8(params_.height_special) << "]";
 349                         }
 350                 }
 351                 if (params_.inner_pos != params_.pos)
 352                         os << "[" << params_.inner_pos << "]";
 353
 354                 // FIXME UNICODE
 355                 os << '{' << from_ascii(width_string) << '}';
 356
 357                 if (params_.use_parbox)
 358                         os << "{";
 359                 os << "%\n";
 360                 i += 1;
 361         }
 362
 363         i += InsetText::latex(buf, os, runparams);
 364
 365         if (params_.inner_box) {
 366                 if (params_.use_parbox)
 367                         os << "%\n}";
 368                 else
 369                         os << "%\n\\end{minipage}";
 370         }
 371
 372         switch (btype) {
 373         case Frameless:
 374                 break;
 375         case Boxed:
 376                 if (!params_.inner_box)
 377                         os << "}"; // for makebox
 378                 os << "}";
 379                 break;
 380         case ovalbox:
 381         case Ovalbox:
 382         case Doublebox:
 383         case Shadowbox:
 384                 os << "}";
 385                 break;
 386         }
 387         os << "%\n";
 388
 389         i += 3;
 390
 391         return i;
 392 }
 393
 394
 395 int InsetBox::plaintext(Buffer const & buf, odocstream & os,
 396                         OutputParams const & runparams) const
 397 {
 398         BoxType const btype = boxtranslator().find(params_.type);
 399
 400         switch (btype) {
 401                 case Frameless: break;
 402                 case Boxed:     os << "[\n";  break;
 403                 case ovalbox:   os << "(\n";  break;
 404                 case Ovalbox:   os << "((\n"; break;
 405                 case Shadowbox: os << "[/\n"; break;
 406                 case Doublebox: os << "[[\n"; break;
 407         }
 408
 409         InsetText::plaintext(buf, os, runparams);
 410
 411         int len = 0;
 412         switch (btype) {
 413                 case Frameless: os << "\n";            break;
 414                 case Boxed:     os << "\n]";  len = 1; break;
 415                 case ovalbox:   os << "\n)";  len = 1; break;
 416                 case Ovalbox:   os << "\n))"; len = 2; break;
 417                 case Shadowbox: os << "\n/]"; len = 2; break;
 418                 case Doublebox: os << "\n]]"; len = 2; break;
 419         }
 420
 421         return PLAINTEXT_NEWLINE + len; // len chars on a separate line
 422 }
 423
 424
 425 int InsetBox::docbook(Buffer const & buf, odocstream & os,
 426                       OutputParams const & runparams) const
 427 {
 428         return InsetText::docbook(buf, os, runparams);
 429 }
 430
 431
 432 void InsetBox::validate(LaTeXFeatures & features) const
 433 {
 434         BoxType btype = boxtranslator().find(params_.type);
 435         switch (btype) {
 436         case Frameless:
 437                 break;
 438         case Boxed:
 439                 features.require("calc");
 440                 break;
 441         case ovalbox:
 442         case Ovalbox:
 443         case Shadowbox:
 444         case Doublebox:
 445                 features.require("calc");
 446                 features.require("fancybox");
 447                 break;
 448         }
 449         InsetText::validate(features);
 450 }
 451
 452
 453 InsetBoxMailer::InsetBoxMailer(InsetBox & inset)
 454         : inset_(inset)
 455 {}
 456
 457
 458 string const InsetBoxMailer::name_ = "box";
 459
 460
 461 string const InsetBoxMailer::inset2string(Buffer const &) const
 462 {
 463         return params2string(inset_.params());
 464 }
 465
 466
 467 string const InsetBoxMailer::params2string(InsetBoxParams const & params)
 468 {
 469         ostringstream data;
 470         data << "box" << ' ';
 471         params.write(data);
 472         return data.str();
 473 }
 474
 475
 476 void InsetBoxMailer::string2params(string const & in,
 477                                    InsetBoxParams & params)
 478 {
 479         params = InsetBoxParams(string());
 480         if (in.empty())
 481                 return;
 482
 483         istringstream data(in);
 484         Lexer lex(0,0);
 485         lex.setStream(data);
 486
 487         string name;
 488         lex >> name;
 489         if (!lex || name != name_)
 490                 return print_mailer_error("InsetBoxMailer", in, 1, name_);
 491
 492         // This is part of the inset proper that is usually swallowed
 493         // by Text::readInset
 494         string id;
 495         lex >> id;
 496         if (!lex || id != "Box")
 497                 return print_mailer_error("InsetBoxMailer", in, 2, "Box");
 498
 499         params.read(lex);
 500 }
 501
 502
 503 InsetBoxParams::InsetBoxParams(string const & label)
 504         : type(label),
 505           use_parbox(false),
 506           inner_box(true),
 507           width(Length("100col%")),
 508           special("none"),
 509           pos('t'),
 510           hor_pos('c'),
 511           inner_pos('t'),
 512           height(Length("1in")),
 513           height_special("totalheight") // default is 1\\totalheight
 514 {}
 515
 516
 517 void InsetBoxParams::write(ostream & os) const
 518 {
 519         os << "Box " << type << "\n";
 520         os << "position \"" << pos << "\"\n";
 521         os << "hor_pos \"" << hor_pos << "\"\n";
 522         os << "has_inner_box " << inner_box << "\n";
 523         os << "inner_pos \"" << inner_pos << "\"\n";
 524         os << "use_parbox " << use_parbox << "\n";
 525         os << "width \"" << width.asString() << "\"\n";
 526         os << "special \"" << special << "\"\n";
 527         os << "height \"" << height.asString() << "\"\n";
 528         os << "height_special \"" << height_special << "\"\n";
 529 }
 530
 531
 532 void InsetBoxParams::read(Lexer & lex)
 533 {
 534         if (!lex.isOK())
 535                 return;
 536
 537         lex.next();
 538         type = lex.getString();
 539
 540         if (!lex)
 541                 return;
 542
 543         lex.next();
 544         string token;
 545         token = lex.getString();
 546         if (!lex)
 547                 return;
 548         if (token == "position") {
 549                 lex.next();
 550                 // The [0] is needed. We need the first and only char in
 551                 // this string -- MV
 552                 pos = lex.getString()[0];
 553         } else {
 554                 lyxerr << "InsetBox::Read: Missing 'position'-tag!" << token << endl;
 555                 lex.pushToken(token);
 556         }
 557
 558         lex.next();
 559         token = lex.getString();
 560         if (!lex)
 561                 return;
 562         if (token == "hor_pos") {
 563                 lex.next();
 564                 hor_pos = lex.getString()[0];
 565         } else {
 566                 lyxerr << "InsetBox::Read: Missing 'hor_pos'-tag!" << token << endl;
 567                 lex.pushToken(token);
 568         }
 569
 570         lex.next();
 571         token = lex.getString();
 572         if (!lex)
 573                 return;
 574         if (token == "has_inner_box") {
 575                 lex.next();
 576                 inner_box = lex.getInteger();
 577         } else {
 578                 lyxerr << "InsetBox::Read: Missing 'has_inner_box'-tag!" << endl;
 579                 lex.pushToken(token);
 580         }
 581
 582         lex.next();
 583         token = lex.getString();
 584         if (!lex)
 585                 return;
 586         if (token == "inner_pos") {
 587                 lex.next();
 588                 inner_pos = lex.getString()[0];
 589         } else {
 590                 lyxerr << "InsetBox::Read: Missing 'inner_pos'-tag!"
 591                         << token << endl;
 592                 lex.pushToken(token);
 593         }
 594
 595         lex.next();
 596         token = lex.getString();
 597         if (!lex)
 598                 return;
 599         if (token == "use_parbox") {
 600                 lex.next();
 601                 use_parbox = lex.getInteger();
 602         } else {
 603                 lyxerr << "InsetBox::Read: Missing 'use_parbox'-tag!" << endl;
 604                 lex.pushToken(token);
 605         }
 606
 607         lex.next();
 608         token = lex.getString();
 609         if (!lex)
 610                 return;
 611         if (token == "width") {
 612                 lex.next();
 613                 width = Length(lex.getString());
 614         } else {
 615                 lyxerr << "InsetBox::Read: Missing 'width'-tag!" << endl;
 616                 lex.pushToken(token);
 617         }
 618
 619         lex.next();
 620         token = lex.getString();
 621         if (!lex)
 622                 return;
 623         if (token == "special") {
 624                 lex.next();
 625                 special = lex.getString();
 626         } else {
 627                 lyxerr << "InsetBox::Read: Missing 'special'-tag!" << endl;
 628                 lex.pushToken(token);
 629         }
 630
 631         lex.next();
 632         token = lex.getString();
 633         if (!lex)
 634                 return;
 635         if (token == "height") {
 636                 lex.next();
 637                 height = Length(lex.getString());
 638         } else {
 639                 lyxerr << "InsetBox::Read: Missing 'height'-tag!" << endl;
 640                 lex.pushToken(token);
 641         }
 642
 643         lex.next();
 644         token = lex.getString();
 645         if (!lex)
 646                 return;
 647         if (token == "height_special") {
 648                 lex.next();
 649                 height_special = lex.getString();
 650         } else {
 651                 lyxerr << "InsetBox::Read: Missing 'height_special'-tag!" << endl;
 652                 lex.pushToken(token);
 653         }
 654 }
 655
 656
 657 } // namespace lyx