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