src/insets/InsetCaption.cpp

   1 /**
   2  * \file InsetCaption.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetCaption.h"
  14 #include "InsetFloat.h"
  15 #include "InsetWrap.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "BufferView.h"
  20 #include "Cursor.h"
  21 #include "Dimension.h"
  22 #include "Floating.h"
  23 #include "FloatList.h"
  24 #include "FuncRequest.h"
  25 #include "FuncStatus.h"
  26 #include "InsetList.h"
  27 #include "Language.h"
  28 #include "MetricsInfo.h"
  29 #include "output_latex.h"
  30 #include "output_xhtml.h"
  31 #include "OutputParams.h"
  32 #include "Paragraph.h"
  33 #include "ParIterator.h"
  34 #include "TexRow.h"
  35 #include "texstream.h"
  36 #include "TextClass.h"
  37 #include "TextMetrics.h"
  38 #include "TocBackend.h"
  39
  40 #include "frontends/FontMetrics.h"
  41 #include "frontends/Painter.h"
  42
  43 #include "support/gettext.h"
  44 #include "support/lstrings.h"
  45
  46 #include <sstream>
  47
  48 using namespace std;
  49 using namespace lyx::support;
  50
  51 namespace lyx {
  52
  53
  54 InsetCaption::InsetCaption(Buffer * buf, string const & type)
  55     : InsetText(buf, InsetText::PlainLayout),
  56       labelwidth_(0), is_subfloat_(false), is_deleted_(false), type_(type)
  57 {
  58         setDrawFrame(true);
  59         setFrameColor(Color_collapsibleframe);
  60 }
  61
  62
  63 void InsetCaption::write(ostream & os) const
  64 {
  65         os << "Caption";
  66         if (!type_.empty())
  67                 os << ' ' << type_;
  68         os << '\n';
  69         text().write(os);
  70 }
  71
  72
  73 docstring InsetCaption::layoutName() const
  74 {
  75         if (type_.empty())
  76                 return from_ascii("Caption");
  77         return from_utf8("Caption:" + type_);
  78 }
  79
  80
  81 void InsetCaption::cursorPos(BufferView const & bv,
  82                 CursorSlice const & sl, bool boundary, int & x, int & y) const
  83 {
  84         InsetText::cursorPos(bv, sl, boundary, x, y);
  85         x += labelwidth_;
  86 }
  87
  88
  89 void InsetCaption::addToToc(DocIterator const & cpit, bool output_active,
  90                                                         UpdateType utype, TocBackend & backend) const
  91 {
  92         string const & type = floattype_.empty() ? "senseless" : floattype_;
  93         DocIterator pit = cpit;
  94         pit.push_back(CursorSlice(const_cast<InsetCaption &>(*this)));
  95         int length = (utype == OutputUpdate) ?
  96                 // For output (e.g. xhtml) all (bug #8603) or nothing
  97                 (output_active ? INT_MAX : 0) :
  98                 // TOC for LyX interface
  99                 TOC_ENTRY_LENGTH;
 100         docstring str;
 101         if (length > 0) {
 102                 str = full_label_;
 103                 text().forOutliner(str, length);
 104         }
 105         backend.builder(type).captionItem(pit, str, output_active);
 106         // Proceed with the rest of the inset.
 107         InsetText::addToToc(cpit, output_active, utype, backend);
 108 }
 109
 110
 111 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
 112 {
 113         FontInfo tmpfont = mi.base.font;
 114         mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
 115         labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
 116         // add some space to separate the label from the inset text
 117         labelwidth_ += leftOffset(mi.base.bv) + rightOffset(mi.base.bv);
 118         dim.wid = labelwidth_;
 119         Dimension textdim;
 120         // Correct for button and label width
 121         mi.base.textwidth -= dim.wid;
 122         InsetText::metrics(mi, textdim);
 123         mi.base.font = tmpfont;
 124         mi.base.textwidth += dim.wid;
 125         dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
 126         dim.asc = textdim.asc;
 127         dim.wid += textdim.wid;
 128 }
 129
 130
 131 void InsetCaption::drawBackground(PainterInfo & pi, int x, int y) const
 132 {
 133         TextMetrics & tm = pi.base.bv->textMetrics(&text());
 134         int const h = tm.height() + topOffset(pi.base.bv) + bottomOffset(pi.base.bv);
 135         int const yy = y - topOffset(pi.base.bv) - tm.ascent();
 136         pi.pain.fillRectangle(x, yy, labelwidth_, h, pi.backgroundColor(this));
 137 }
 138
 139
 140 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
 141 {
 142         // We must draw the label, we should get the label string
 143         // from the enclosing float inset.
 144         // The question is: Who should draw the label, the caption inset,
 145         // the text inset or the paragraph?
 146         // We should also draw the float number (Lgb)
 147
 148         // Answer: the text inset (in buffer_funcs.cpp: setCaption).
 149
 150         FontInfo tmpfont = pi.base.font;
 151         pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
 152         pi.base.font.setColor(pi.textColor(pi.base.font.color()).baseColor);
 153         if (is_deleted_)
 154                 pi.base.font.setStrikeout(FONT_ON);
 155         else if (isChanged())
 156                 pi.base.font.setUnderbar(FONT_ON);
 157         int const xx = x + leftOffset(pi.base.bv);
 158         pi.pain.text(xx, y, full_label_, pi.base.font);
 159         InsetText::draw(pi, x + labelwidth_, y);
 160         pi.base.font = tmpfont;
 161 }
 162
 163
 164 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
 165 {
 166         cur.push(*this);
 167         InsetText::edit(cur, front, entry_from);
 168 }
 169
 170
 171 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
 172 {
 173         cur.push(*this);
 174         return InsetText::editXY(cur, x, y);
 175 }
 176
 177
 178 bool InsetCaption::insetAllowed(InsetCode code) const
 179 {
 180         switch (code) {
 181         // code that is not allowed in a caption
 182         case CAPTION_CODE:
 183         case FLOAT_CODE:
 184         case FOOT_CODE:
 185         case NEWPAGE_CODE:
 186         case MARGIN_CODE:
 187         case MATHMACRO_CODE:
 188         case TABULAR_CODE:
 189         case WRAP_CODE:
 190                 return false;
 191         default:
 192                 return InsetText::insetAllowed(code);
 193         }
 194 }
 195
 196
 197 void InsetCaption::doDispatch(Cursor & cur, FuncRequest & cmd)
 198 {
 199         switch (cmd.action()) {
 200
 201         case LFUN_INSET_MODIFY: {
 202                 if (cmd.getArg(0) == "changetype") {
 203                         cur.recordUndoInset(this);
 204                         type_ = cmd.getArg(1);
 205                         cur.forceBufferUpdate();
 206                         break;
 207                 }
 208         }
 209         // no "changetype":
 210         // fall through
 211
 212         default:
 213                 InsetText::doDispatch(cur, cmd);
 214                 break;
 215         }
 216 }
 217
 218
 219 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
 220         FuncStatus & status) const
 221 {
 222         switch (cmd.action()) {
 223
 224         case LFUN_INSET_MODIFY: {
 225                 string const first_arg = cmd.getArg(0);
 226                 if (first_arg == "changetype") {
 227                         string const type = cmd.getArg(1);
 228                         status.setOnOff(type == type_);
 229                         bool varia = type != "Unnumbered";
 230                         // check if the immediate parent inset allows caption variation
 231                         if (cur.depth() > 1) {
 232                                 varia = cur[cur.depth() - 2].inset().allowsCaptionVariation(type);
 233                         }
 234                         status.setEnabled(varia
 235                                           && buffer().params().documentClass().hasInsetLayout(
 236                                                 from_ascii("Caption:" + type)));
 237                         return true;
 238                 }
 239                 return InsetText::getStatus(cur, cmd, status);
 240         }
 241
 242         case LFUN_INSET_TOGGLE:
 243                 // pass back to owner
 244                 cur.undispatched();
 245                 return false;
 246
 247         default:
 248                 return InsetText::getStatus(cur, cmd, status);
 249         }
 250 }
 251
 252
 253 void InsetCaption::latex(otexstream & os,
 254                          OutputParams const & runparams_in) const
 255 {
 256         if (runparams_in.inFloat == OutputParams::SUBFLOAT)
 257                 // caption is output as an optional argument
 258                 return;
 259         // This is a bit too simplistic to take advantage of
 260         // caption options we must add more later. (Lgb)
 261         // This code is currently only able to handle the simple
 262         // \caption{...}, later we will make it take advantage
 263         // of the one of the caption packages. (Lgb)
 264         OutputParams runparams = runparams_in;
 265         // Some fragile commands (labels, index entries)
 266         // are output after the caption (#2154)
 267         runparams.postpone_fragile_stuff = buffer().masterParams().postpone_fragile_content;
 268         InsetText::latex(os, runparams);
 269         if (!runparams.post_macro.empty()) {
 270                 // Output the stored fragile commands (labels, indices etc.)
 271                 // that need to be output after the caption.
 272                 os << runparams.post_macro;
 273                 runparams.post_macro.clear();
 274         }
 275         // Backwards compatibility: We always had a linebreak after
 276         // the caption (see #8514)
 277         os << breakln;
 278         runparams_in.encoding = runparams.encoding;
 279 }
 280
 281
 282 int InsetCaption::plaintext(odocstringstream & os,
 283                             OutputParams const & runparams, size_t max_length) const
 284 {
 285         os << '[' << full_label_ << "\n";
 286         InsetText::plaintext(os, runparams, max_length);
 287         os << "\n]";
 288
 289         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 290 }
 291
 292
 293 int InsetCaption::docbook(odocstream & os,
 294                           OutputParams const & runparams) const
 295 {
 296         int ret;
 297         os << "<title>";
 298         ret = InsetText::docbook(os, runparams);
 299         os << "</title>\n";
 300         return ret;
 301 }
 302
 303
 304 docstring InsetCaption::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 305 {
 306         if (rp.html_disable_captions)
 307                 return docstring();
 308         InsetLayout const & il = getLayout();
 309         string const & tag = il.htmltag();
 310         string attr = il.htmlattr();
 311         if (!type_.empty()) {
 312                 string const our_class = "float-caption-" + type_;
 313                 size_t const loc = attr.find("class='");
 314                 if (loc != string::npos)
 315                         attr.insert(loc + 7, our_class + " ");
 316                 else
 317                         attr = attr + " class='" + our_class + "'";
 318         }
 319         xs << html::StartTag(tag, attr);
 320         docstring def = getCaptionAsHTML(xs, rp);
 321         xs << html::EndTag(tag);
 322         return def;
 323 }
 324
 325
 326 void InsetCaption::getArgument(otexstream & os,
 327                         OutputParams const & runparams) const
 328 {
 329         InsetLayout const & il = getLayout();
 330
 331         if (!il.leftdelim().empty())
 332                 os << il.leftdelim();
 333
 334         OutputParams rp = runparams;
 335         if (isPassThru())
 336                 rp.pass_thru = true;
 337         if (il.isNeedProtect())
 338                 rp.moving_arg = true;
 339         if (il.isNeedMBoxProtect())
 340                 ++rp.inulemcmd;
 341         rp.par_begin = 0;
 342         rp.par_end = paragraphs().size();
 343
 344         // Output the contents of the inset
 345         if (!paragraphs().empty())
 346                 os.texrow().forceStart(paragraphs()[0].id(), 0);
 347         latexParagraphs(buffer(), text(), os, rp);
 348         runparams.encoding = rp.encoding;
 349
 350         if (!il.rightdelim().empty())
 351                 os << il.rightdelim();
 352 }
 353
 354
 355 int InsetCaption::getCaptionAsPlaintext(odocstream & os,
 356                         OutputParams const & runparams) const
 357 {
 358         os << full_label_ << ' ';
 359         odocstringstream ods;
 360         int const retval = InsetText::plaintext(ods, runparams);
 361         os << ods.str();
 362         return retval;
 363 }
 364
 365
 366 docstring InsetCaption::getCaptionAsHTML(XHTMLStream & xs,
 367                         OutputParams const & runparams) const
 368 {
 369         xs << full_label_ << ' ';
 370         InsetText::XHTMLOptions const opts =
 371                 InsetText::WriteLabel | InsetText::WriteInnerTag;
 372         return InsetText::insetAsXHTML(xs, runparams, opts);
 373 }
 374
 375
 376 void InsetCaption::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 377 {
 378         Buffer const & master = *buffer().masterBuffer();
 379         DocumentClass const & tclass = master.params().documentClass();
 380         string const & lang = it.paragraph().getParLanguage(master.params())->code();
 381         Counters & cnts = tclass.counters();
 382         string const & type = cnts.current_float();
 383         if (utype == OutputUpdate) {
 384                 // counters are local to the caption
 385                 cnts.saveLastCounter();
 386         }
 387         is_deleted_ = deleted;
 388         // Memorize type for addToToc().
 389         floattype_ = type;
 390         if (type.empty() || type == "senseless")
 391                 full_label_ = master.B_("Senseless!!! ");
 392         else {
 393                 // FIXME: life would be _much_ simpler if listings was
 394                 // listed in Floating.
 395                 docstring name;
 396                 if (type == "listing")
 397                         name = master.B_("Listing");
 398                 else
 399                         name = master.B_(tclass.floats().getType(type).name());
 400                 docstring counter = from_utf8(type);
 401                 is_subfloat_ = cnts.isSubfloat();
 402                 if (is_subfloat_) {
 403                         // only standard captions allowed in subfloats
 404                         type_ = "Standard";
 405                         counter = "sub-" + from_utf8(type);
 406                         name = bformat(_("Sub-%1$s"),
 407                                        master.B_(tclass.floats().getType(type).name()));
 408                 }
 409                 docstring sec;
 410                 docstring const lstring = getLayout().labelstring();
 411                 docstring const labelstring = isAscii(lstring) ?
 412                                 master.B_(to_ascii(lstring)) : lstring;
 413                 if (cnts.hasCounter(counter)) {
 414                         int val = cnts.value(counter);
 415                         // for longtables, we step the counter upstream
 416                         if (!cnts.isLongtable())
 417                                 cnts.step(counter, utype);
 418                         sec = cnts.theCounter(counter, lang);
 419                         if (deleted && !cnts.isLongtable())
 420                                 // un-step after deleted counter
 421                                 cnts.set(counter, val);
 422                 }
 423                 if (labelstring != master.B_("standard")) {
 424                         if (!sec.empty())
 425                                 sec += from_ascii(" ");
 426                         sec += bformat(from_ascii("(%1$s)"), labelstring);
 427                 }
 428                 if (!sec.empty())
 429                         full_label_ = bformat(from_ascii("%1$s %2$s: "), name, sec);
 430                 else
 431                         full_label_ = bformat(from_ascii("%1$s #: "), name);
 432         }
 433
 434         // Do the real work now.
 435         InsetText::updateBuffer(it, utype, deleted);
 436         if (utype == OutputUpdate)
 437                 cnts.restoreLastCounter();
 438 }
 439
 440
 441 string InsetCaption::contextMenuName() const
 442 {
 443         return "context-caption";
 444 }
 445
 446
 447 } // namespace lyx