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 "TextClass.h"
  35 #include "TocBackend.h"
  36
  37 #include "frontends/FontMetrics.h"
  38 #include "frontends/Painter.h"
  39
  40 #include "support/gettext.h"
  41 #include "support/lstrings.h"
  42
  43 #include <sstream>
  44
  45 using namespace std;
  46 using namespace lyx::support;
  47
  48 namespace lyx {
  49
  50
  51 InsetCaption::InsetCaption(Buffer * buf)
  52         : InsetText(buf, InsetText::PlainLayout)
  53 {
  54         setAutoBreakRows(true);
  55         setDrawFrame(true);
  56         setFrameColor(Color_captionframe);
  57 }
  58
  59
  60 void InsetCaption::write(ostream & os) const
  61 {
  62         os << "Caption\n";
  63         text().write(os);
  64 }
  65
  66
  67 void InsetCaption::read(Lexer & lex)
  68 {
  69 #if 0
  70         // We will enably this check again when the compability
  71         // code is removed from Buffer::Read (Lgb)
  72         lex.setContext("InsetCaption::Read: consistency check");
  73         lex >> "Caption";
  74 #endif
  75         InsetText::read(lex);
  76 }
  77
  78
  79 void InsetCaption::cursorPos(BufferView const & bv,
  80                 CursorSlice const & sl, bool boundary, int & x, int & y) const
  81 {
  82         InsetText::cursorPos(bv, sl, boundary, x, y);
  83         x += labelwidth_;
  84 }
  85
  86
  87 void InsetCaption::setCustomLabel(docstring const & label)
  88 {
  89         if (!isAscii(label) || label.empty())
  90                 // This must be a user defined layout. We cannot translate
  91                 // this, since gettext accepts only ascii keys.
  92                 custom_label_ = label;
  93         else
  94                 custom_label_ = _(to_ascii(label));
  95 }
  96
  97
  98 void InsetCaption::addToToc(DocIterator const & cpit)
  99 {
 100         if (type_.empty())
 101                 return;
 102
 103         DocIterator pit = cpit;
 104         pit.push_back(CursorSlice(*this));
 105
 106         Toc & toc = buffer().tocBackend().toc(type_);
 107         docstring const str = full_label_ + ". " + text().getPar(0).asString();
 108         toc.push_back(TocItem(pit, 0, str));
 109
 110         // Proceed with the rest of the inset.
 111         InsetText::addToToc(cpit);
 112 }
 113
 114
 115 void InsetCaption::metrics(MetricsInfo & mi, Dimension & dim) const
 116 {
 117         FontInfo tmpfont = mi.base.font;
 118         mi.base.font = mi.base.bv->buffer().params().getFont().fontInfo();
 119         labelwidth_ = theFontMetrics(mi.base.font).width(full_label_);
 120         // add some space to separate the label from the inset text
 121         labelwidth_ += 2 * TEXT_TO_INSET_OFFSET;
 122         dim.wid = labelwidth_;
 123         Dimension textdim;
 124         // Correct for button and label width
 125         mi.base.textwidth -= dim.wid;
 126         InsetText::metrics(mi, textdim);
 127         mi.base.font = tmpfont;
 128         mi.base.textwidth += dim.wid;
 129         dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
 130         dim.asc = textdim.asc;
 131         dim.wid += textdim.wid;
 132 }
 133
 134
 135 void InsetCaption::draw(PainterInfo & pi, int x, int y) const
 136 {
 137         // We must draw the label, we should get the label string
 138         // from the enclosing float inset.
 139         // The question is: Who should draw the label, the caption inset,
 140         // the text inset or the paragraph?
 141         // We should also draw the float number (Lgb)
 142
 143         // Answer: the text inset (in buffer_funcs.cpp: setCaption).
 144
 145         FontInfo tmpfont = pi.base.font;
 146         pi.base.font = pi.base.bv->buffer().params().getFont().fontInfo();
 147         pi.pain.text(x, y, full_label_, pi.base.font);
 148         InsetText::draw(pi, x + labelwidth_, y);
 149         pi.base.font = tmpfont;
 150 }
 151
 152
 153 void InsetCaption::edit(Cursor & cur, bool front, EntryDirection entry_from)
 154 {
 155         cur.push(*this);
 156         InsetText::edit(cur, front, entry_from);
 157 }
 158
 159
 160 Inset * InsetCaption::editXY(Cursor & cur, int x, int y)
 161 {
 162         cur.push(*this);
 163         return InsetText::editXY(cur, x, y);
 164 }
 165
 166
 167 bool InsetCaption::insetAllowed(InsetCode code) const
 168 {
 169         switch (code) {
 170         // code that is not allowed in a caption
 171         case FLOAT_CODE:
 172         case TABULAR_CODE:
 173         case WRAP_CODE:
 174         case CAPTION_CODE:
 175         case NEWPAGE_CODE:
 176         case MATHMACRO_CODE:
 177                 return false;
 178         default:
 179                 return InsetText::insetAllowed(code);
 180         }
 181 }
 182
 183
 184 bool InsetCaption::getStatus(Cursor & cur, FuncRequest const & cmd,
 185         FuncStatus & status) const
 186 {
 187         switch (cmd.action) {
 188
 189         case LFUN_BREAK_PARAGRAPH:
 190                 status.setEnabled(false);
 191                 return true;
 192
 193         case LFUN_OPTIONAL_INSERT:
 194                 status.setEnabled(cur.paragraph().insetList().find(OPTARG_CODE) == -1);
 195                 return true;
 196
 197         case LFUN_INSET_TOGGLE:
 198                 // pass back to owner
 199                 cur.undispatched();
 200                 return false;
 201
 202         default:
 203                 return InsetText::getStatus(cur, cmd, status);
 204         }
 205 }
 206
 207
 208 int InsetCaption::latex(odocstream & os,
 209                         OutputParams const & runparams_in) const
 210 {
 211         if (runparams_in.inFloat == OutputParams::SUBFLOAT)
 212                 // caption is output as an optional argument
 213                 return 0;
 214         // This is a bit too simplistic to take advantage of
 215         // caption options we must add more later. (Lgb)
 216         // This code is currently only able to handle the simple
 217         // \caption{...}, later we will make it take advantage
 218         // of the one of the caption packages. (Lgb)
 219         OutputParams runparams = runparams_in;
 220         // FIXME: actually, it is moving only when there is no
 221         // optional argument.
 222         runparams.moving_arg = true;
 223         os << "\\caption";
 224         int l = latexOptArgInsets(paragraphs()[0], os, runparams, 1);
 225         os << '{';
 226         l += InsetText::latex(os, runparams);
 227         os << "}\n";
 228         runparams_in.encoding = runparams.encoding;
 229         return l + 1;
 230 }
 231
 232
 233 int InsetCaption::plaintext(odocstream & os,
 234                             OutputParams const & runparams) const
 235 {
 236         os << '[' << full_label_ << "\n";
 237         InsetText::plaintext(os, runparams);
 238         os << "\n]";
 239
 240         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 241 }
 242
 243
 244 int InsetCaption::docbook(odocstream & os,
 245                           OutputParams const & runparams) const
 246 {
 247         int ret;
 248         os << "<title>";
 249         ret = InsetText::docbook(os, runparams);
 250         os << "</title>\n";
 251         return ret;
 252 }
 253
 254
 255 docstring InsetCaption::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 256 {
 257         if (rp.html_disable_captions)
 258                 return docstring();
 259         xs << StartTag("div", "class='float-caption'");
 260         docstring def = getCaptionAsHTML(xs, rp);
 261         xs << EndTag("div");
 262         return def;
 263 }
 264
 265
 266 int InsetCaption::getArgument(odocstream & os,
 267                         OutputParams const & runparams) const
 268 {
 269         return InsetText::latex(os, runparams);
 270 }
 271
 272
 273 int InsetCaption::getOptArg(odocstream & os,
 274                         OutputParams const & runparams) const
 275 {
 276         return latexOptArgInsets(paragraphs()[0], os, runparams, 1);
 277 }
 278
 279
 280 int InsetCaption::getCaptionAsPlaintext(odocstream & os,
 281                         OutputParams const & runparams) const
 282 {
 283         os << full_label_ << ' ';
 284         return InsetText::plaintext(os, runparams);
 285 }
 286
 287
 288 docstring InsetCaption::getCaptionAsHTML(XHTMLStream & xs,
 289                         OutputParams const & runparams) const
 290 {
 291         xs << full_label_ << ' ';
 292         InsetText::XHTMLOptions const opts =
 293                 InsetText::WriteLabel | InsetText::WriteInnerTag;
 294         return InsetText::insetAsXHTML(xs, runparams, opts);
 295 }
 296
 297
 298 void InsetCaption::updateLabels(ParIterator const & it, bool out)
 299 {
 300         Buffer const & master = *buffer().masterBuffer();
 301         DocumentClass const & tclass = master.params().documentClass();
 302         string const & lang = it.paragraph().getParLanguage(master.params())->code();
 303         Counters & cnts = tclass.counters();
 304         string const & type = cnts.current_float();
 305         // Memorize type for addToToc().
 306         type_ = type;
 307         if (type.empty())
 308                 full_label_ = master.B_("Senseless!!! ");
 309         else {
 310                 // FIXME: life would be _much_ simpler if listings was
 311                 // listed in Floating.
 312                 docstring name;
 313                 if (type == "listing")
 314                         name = master.B_("Listing");
 315                 else
 316                         name = master.B_(tclass.floats().getType(type).name());
 317                 docstring counter = from_utf8(type);
 318                 if (cnts.isSubfloat()) {
 319                         counter = "sub-" + from_utf8(type);
 320                         name = bformat(_("Sub-%1$s"),
 321                                        master.B_(tclass.floats().getType(type).name()));
 322                 }
 323                 if (cnts.hasCounter(counter)) {
 324                         cnts.step(counter);
 325                         full_label_ = bformat(from_ascii("%1$s %2$s:"),
 326                                               name,
 327                                               cnts.theCounter(counter, lang));
 328                 } else
 329                         full_label_ = bformat(from_ascii("%1$s #:"), name);
 330         }
 331
 332         // Do the real work now.
 333         InsetText::updateLabels(it, out);
 334 }
 335
 336
 337 } // namespace lyx