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