3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup Nielsen
7 * \author Jean-Marc Lasgouttes
8 * \author Lars Gullik Bjønnes
9 * \author Jürgen Spitzmüller
11 * Full author contact details are available in file CREDITS.
16 #include "InsetSpace.h"
18 #include "BufferView.h"
20 #include "Dimension.h"
21 #include "FuncRequest.h"
22 #include "FuncStatus.h"
25 #include "MetricsInfo.h"
26 #include "OutputParams.h"
28 #include "support/debug.h"
29 #include "support/docstream.h"
30 #include "support/gettext.h"
31 #include "support/lstrings.h"
33 #include "frontends/Application.h"
34 #include "frontends/FontMetrics.h"
35 #include "frontends/Painter.h"
42 InsetSpace::InsetSpace(InsetSpaceParams const & params)
47 InsetSpaceParams::Kind InsetSpace::kind() const
53 Length InsetSpace::length() const
55 return params_.length;
59 InsetSpace::~InsetSpace()
61 hideDialogs("space", this);
65 docstring InsetSpace::toolTip(BufferView const &, int, int) const
68 switch (params_.kind) {
69 case InsetSpaceParams::NORMAL:
70 message = _("Interword Space");
72 case InsetSpaceParams::PROTECTED:
73 message = _("Protected Space");
75 case InsetSpaceParams::THIN:
76 message = _("Thin Space");
78 case InsetSpaceParams::QUAD:
79 message = _("Quad Space");
81 case InsetSpaceParams::QQUAD:
82 message = _("QQuad Space");
84 case InsetSpaceParams::ENSPACE:
85 message = _("Enspace");
87 case InsetSpaceParams::ENSKIP:
88 message = _("Enskip");
90 case InsetSpaceParams::NEGTHIN:
91 message = _("Negative Thin Space");
93 case InsetSpaceParams::HFILL:
94 message = _("Horizontal Fill");
96 case InsetSpaceParams::HFILL_PROTECTED:
97 message = _("Protected Horizontal Fill");
99 case InsetSpaceParams::DOTFILL:
100 message = _("Horizontal Fill (Dots)");
102 case InsetSpaceParams::HRULEFILL:
103 message = _("Horizontal Fill (Rule)");
105 case InsetSpaceParams::LEFTARROWFILL:
106 message = _("Horizontal Fill (Left Arrow)");
108 case InsetSpaceParams::RIGHTARROWFILL:
109 message = _("Horizontal Fill (Right Arrow)");
111 case InsetSpaceParams::UPBRACEFILL:
112 message = _("Horizontal Fill (Up Brace)");
114 case InsetSpaceParams::DOWNBRACEFILL:
115 message = _("Horizontal Fill (Down Brace)");
117 case InsetSpaceParams::CUSTOM:
118 message = support::bformat(_("Horizontal Space (%1$s)"),
119 params_.length.asDocstring());
121 case InsetSpaceParams::CUSTOM_PROTECTED:
122 message = support::bformat(_("Protected Horizontal Space (%1$s)"),
123 params_.length.asDocstring());
130 void InsetSpace::doDispatch(Cursor & cur, FuncRequest & cmd)
132 switch (cmd.action) {
134 case LFUN_INSET_MODIFY: {
135 string2params(to_utf8(cmd.argument()), params_);
139 case LFUN_MOUSE_RELEASE:
140 if (!cur.selection() && cmd.button() == mouse_button::button1)
141 cur.bv().showDialog("space", params2string(params()), this);
145 Inset::doDispatch(cur, cmd);
151 bool InsetSpace::getStatus(Cursor & cur, FuncRequest const & cmd,
152 FuncStatus & status) const
154 switch (cmd.action) {
156 case LFUN_INSET_MODIFY:
157 if (cmd.getArg(0) == "space") {
158 InsetSpaceParams params;
159 string2params(to_utf8(cmd.argument()), params);
160 status.setOnOff(params_.kind == params.kind);
162 status.setEnabled(true);
165 return Inset::getStatus(cur, cmd, status);
170 void InsetSpace::edit(Cursor & cur, bool, EntryDirection)
172 cur.bv().showDialog("space", params2string(params()), this);
176 void InsetSpace::metrics(MetricsInfo & mi, Dimension & dim) const
178 if (isStretchableSpace()) {
179 // The metrics for this kinds are calculated externally in
180 // \c TextMetrics::computeRowMetrics. Those are dummy value:
181 dim = Dimension(10, 10, 10);
185 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
186 dim.asc = fm.maxAscent();
187 dim.des = fm.maxDescent();
189 switch (params_.kind) {
190 case InsetSpaceParams::THIN:
191 case InsetSpaceParams::NEGTHIN:
192 dim.wid = fm.width(char_type('M')) / 6;
194 case InsetSpaceParams::PROTECTED:
195 case InsetSpaceParams::NORMAL:
196 dim.wid = fm.width(char_type(' '));
198 case InsetSpaceParams::QUAD:
199 dim.wid = fm.width(char_type('M'));
201 case InsetSpaceParams::QQUAD:
202 dim.wid = 2 * fm.width(char_type('M'));
204 case InsetSpaceParams::ENSPACE:
205 case InsetSpaceParams::ENSKIP:
206 dim.wid = int(0.5 * fm.width(char_type('M')));
208 case InsetSpaceParams::CUSTOM:
209 case InsetSpaceParams::CUSTOM_PROTECTED:
210 dim.wid = params_.length.inBP();
212 case InsetSpaceParams::HFILL:
213 case InsetSpaceParams::HFILL_PROTECTED:
214 case InsetSpaceParams::DOTFILL:
215 case InsetSpaceParams::HRULEFILL:
216 case InsetSpaceParams::LEFTARROWFILL:
217 case InsetSpaceParams::RIGHTARROWFILL:
218 case InsetSpaceParams::UPBRACEFILL:
219 case InsetSpaceParams::DOWNBRACEFILL:
223 // Cache the inset dimension.
224 setDimCache(mi, dim);
228 void InsetSpace::draw(PainterInfo & pi, int x, int y) const
230 Dimension const dim = dimension(*pi.base.bv);
232 if (isStretchableSpace()) {
233 int const asc = theFontMetrics(pi.base.font).ascent('M');
234 int const desc = theFontMetrics(pi.base.font).descent('M');
235 //Pixel height divisible by 2 for prettier fill graphics:
236 int const oddheight = (asc ^ desc) & 1;
237 int const x0 = x + 1;
238 int const x1 = x + dim.wid - 2;
239 int const y0 = y + desc - 1;
240 int const y1 = y - asc + oddheight - 1;
241 int const y2 = (y0 + y1) / 2;
242 int const xoffset = (y0 - y1) / 2;
243 int const x2 = x0 + xoffset;
244 int const x3 = x1 - xoffset;
245 int const xm = (x0 + x1) / 2;
246 int const xml = xm - xoffset;
247 int const xmr = xm + xoffset;
249 if (params_.kind == InsetSpaceParams::HFILL) {
250 pi.pain.line(x0, y1, x0, y0, Color_added_space);
251 pi.pain.line(x0, y2 , x1, y2, Color_added_space,
252 frontend::Painter::line_onoffdash);
253 pi.pain.line(x1, y1, x1, y0, Color_added_space);
254 } else if (params_.kind == InsetSpaceParams::HFILL_PROTECTED) {
255 pi.pain.line(x0, y1, x0, y0, Color_latex);
256 pi.pain.line(x0, y2 , x1, y2, Color_latex,
257 frontend::Painter::line_onoffdash);
258 pi.pain.line(x1, y1, x1, y0, Color_latex);
259 } else if (params_.kind == InsetSpaceParams::DOTFILL) {
260 pi.pain.line(x0, y1, x0, y0, Color_special);
261 pi.pain.line(x0, y0, x1, y0, Color_special,
262 frontend::Painter::line_onoffdash);
263 pi.pain.line(x1, y1, x1, y0, Color_special);
264 } else if (params_.kind == InsetSpaceParams::HRULEFILL) {
265 pi.pain.line(x0, y1, x0, y0, Color_special);
266 pi.pain.line(x0, y0, x1, y0, Color_special);
267 pi.pain.line(x1, y1, x1, y0, Color_special);
268 } else if (params_.kind == InsetSpaceParams::LEFTARROWFILL) {
269 pi.pain.line(x2, y1 + 1 , x0 + 1, y2, Color_special);
270 pi.pain.line(x0 + 1, y2 + 1 , x2, y0, Color_special);
271 pi.pain.line(x0, y2 , x1, y2, Color_special);
272 } else if (params_.kind == InsetSpaceParams::RIGHTARROWFILL) {
273 pi.pain.line(x3 + 1, y1 + 1 , x1, y2, Color_special);
274 pi.pain.line(x1, y2 + 1 , x3 + 1, y0, Color_special);
275 pi.pain.line(x0, y2 , x1, y2, Color_special);
276 } else if (params_.kind == InsetSpaceParams::UPBRACEFILL) {
277 pi.pain.line(x0 + 1, y1 + 1 , x2, y2, Color_special);
278 pi.pain.line(x2, y2 , xml, y2, Color_special);
279 pi.pain.line(xml + 1, y2 + 1 , xm, y0, Color_special);
280 pi.pain.line(xm + 1, y0 , xmr, y2 + 1, Color_special);
281 pi.pain.line(xmr, y2 , x3, y2, Color_special);
282 pi.pain.line(x3 + 1, y2 , x1, y1 + 1, Color_special);
283 } else if (params_.kind == InsetSpaceParams::DOWNBRACEFILL) {
284 pi.pain.line(x0 + 1, y0 , x2, y2 + 1, Color_special);
285 pi.pain.line(x2, y2 , xml, y2, Color_special);
286 pi.pain.line(xml + 1, y2 , xm, y1 + 1, Color_special);
287 pi.pain.line(xm + 1, y1 + 1 , xmr, y2, Color_special);
288 pi.pain.line(xmr, y2 , x3, y2, Color_special);
289 pi.pain.line(x3 + 1, y2 + 1 , x1, y0, Color_special);
294 int const w = dim.wid;
295 int const h = theFontMetrics(pi.base.font).ascent('x');
299 yp[0] = y - max(h / 4, 1);
300 if (params_.kind == InsetSpaceParams::NORMAL ||
301 params_.kind == InsetSpaceParams::PROTECTED) {
302 xp[1] = x; yp[1] = y;
303 xp[2] = x + w; yp[2] = y;
305 xp[1] = x; yp[1] = y + max(h / 4, 1);
306 xp[2] = x + w; yp[2] = y + max(h / 4, 1);
309 yp[3] = y - max(h / 4, 1);
311 if (params_.kind == InsetSpaceParams::PROTECTED ||
312 params_.kind == InsetSpaceParams::ENSPACE ||
313 params_.kind == InsetSpaceParams::NEGTHIN ||
314 params_.kind == InsetSpaceParams::CUSTOM_PROTECTED)
315 pi.pain.lines(xp, yp, 4, Color_latex);
317 pi.pain.lines(xp, yp, 4, Color_special);
321 void InsetSpaceParams::write(ostream & os) const
325 case InsetSpaceParams::NORMAL:
328 case InsetSpaceParams::PROTECTED:
331 case InsetSpaceParams::THIN:
332 os << "\\thinspace{}";
334 case InsetSpaceParams::QUAD:
337 case InsetSpaceParams::QQUAD:
340 case InsetSpaceParams::ENSPACE:
343 case InsetSpaceParams::ENSKIP:
346 case InsetSpaceParams::NEGTHIN:
347 os << "\\negthinspace{}";
349 case InsetSpaceParams::HFILL:
352 case InsetSpaceParams::HFILL_PROTECTED:
353 os << "\\hspace*{\\fill}";
355 case InsetSpaceParams::DOTFILL:
358 case InsetSpaceParams::HRULEFILL:
359 os << "\\hrulefill{}";
361 case InsetSpaceParams::LEFTARROWFILL:
362 os << "\\leftarrowfill{}";
364 case InsetSpaceParams::RIGHTARROWFILL:
365 os << "\\rightarrowfill{}";
367 case InsetSpaceParams::UPBRACEFILL:
368 os << "\\upbracefill{}";
370 case InsetSpaceParams::DOWNBRACEFILL:
371 os << "\\downbracefill{}";
373 case InsetSpaceParams::CUSTOM:
376 case InsetSpaceParams::CUSTOM_PROTECTED:
382 os << "\n\\length " << length.asString();
386 void InsetSpaceParams::read(Lexer & lex)
388 lex.setContext("InsetSpaceParams::read");
392 if (command == "\\space{}")
393 kind = InsetSpaceParams::NORMAL;
394 else if (command == "~")
395 kind = InsetSpaceParams::PROTECTED;
396 else if (command == "\\thinspace{}")
397 kind = InsetSpaceParams::THIN;
398 else if (command == "\\quad{}")
399 kind = InsetSpaceParams::QUAD;
400 else if (command == "\\qquad{}")
401 kind = InsetSpaceParams::QQUAD;
402 else if (command == "\\enspace{}")
403 kind = InsetSpaceParams::ENSPACE;
404 else if (command == "\\enskip{}")
405 kind = InsetSpaceParams::ENSKIP;
406 else if (command == "\\negthinspace{}")
407 kind = InsetSpaceParams::NEGTHIN;
408 else if (command == "\\hfill{}")
409 kind = InsetSpaceParams::HFILL;
410 else if (command == "\\hspace*{\\fill}")
411 kind = InsetSpaceParams::HFILL_PROTECTED;
412 else if (command == "\\dotfill{}")
413 kind = InsetSpaceParams::DOTFILL;
414 else if (command == "\\hrulefill{}")
415 kind = InsetSpaceParams::HRULEFILL;
416 else if (command == "\\hspace{}")
417 kind = InsetSpaceParams::CUSTOM;
418 else if (command == "\\leftarrowfill{}")
419 kind = InsetSpaceParams::LEFTARROWFILL;
420 else if (command == "\\rightarrowfill{}")
421 kind = InsetSpaceParams::RIGHTARROWFILL;
422 else if (command == "\\upbracefill{}")
423 kind = InsetSpaceParams::UPBRACEFILL;
424 else if (command == "\\downbracefill{}")
425 kind = InsetSpaceParams::DOWNBRACEFILL;
426 else if (command == "\\hspace*{}")
427 kind = InsetSpaceParams::CUSTOM_PROTECTED;
429 lex.printError("InsetSpace: Unknown kind: `$$Token'");
431 if (lex.checkFor("\\length"))
433 lex >> "\\end_inset";
437 void InsetSpace::write(ostream & os) const
444 void InsetSpace::read(Lexer & lex)
450 int InsetSpace::latex(odocstream & os, OutputParams const & runparams) const
452 switch (params_.kind) {
453 case InsetSpaceParams::NORMAL:
454 os << (runparams.free_spacing ? " " : "\\ ");
456 case InsetSpaceParams::PROTECTED:
457 os << (runparams.free_spacing ? ' ' : '~');
459 case InsetSpaceParams::THIN:
460 os << (runparams.free_spacing ? " " : "\\,");
462 case InsetSpaceParams::QUAD:
463 os << (runparams.free_spacing ? " " : "\\quad{}");
465 case InsetSpaceParams::QQUAD:
466 os << (runparams.free_spacing ? " " : "\\qquad{}");
468 case InsetSpaceParams::ENSPACE:
469 os << (runparams.free_spacing ? " " : "\\enspace{}");
471 case InsetSpaceParams::ENSKIP:
472 os << (runparams.free_spacing ? " " : "\\enskip{}");
474 case InsetSpaceParams::NEGTHIN:
475 os << (runparams.free_spacing ? " " : "\\negthinspace{}");
477 case InsetSpaceParams::HFILL:
478 os << (runparams.free_spacing ? " " : "\\hfill{}");
480 case InsetSpaceParams::HFILL_PROTECTED:
481 os << (runparams.free_spacing ? " " : "\\hspace*{\\fill}");
483 case InsetSpaceParams::DOTFILL:
484 os << (runparams.free_spacing ? " " : "\\dotfill{}");
486 case InsetSpaceParams::HRULEFILL:
487 os << (runparams.free_spacing ? " " : "\\hrulefill{}");
489 case InsetSpaceParams::LEFTARROWFILL:
490 os << (runparams.free_spacing ? " " : "\\leftarrowfill{}");
492 case InsetSpaceParams::RIGHTARROWFILL:
493 os << (runparams.free_spacing ? " " : "\\rightarrowfill{}");
495 case InsetSpaceParams::UPBRACEFILL:
496 os << (runparams.free_spacing ? " " : "\\upbracefill{}");
498 case InsetSpaceParams::DOWNBRACEFILL:
499 os << (runparams.free_spacing ? " " : "\\downbracefill{}");
501 case InsetSpaceParams::CUSTOM:
502 if (runparams.free_spacing)
505 os << "\\hspace{" << from_ascii(params_.length.asLatexString()) << "}";
507 case InsetSpaceParams::CUSTOM_PROTECTED:
508 if (runparams.free_spacing)
511 os << "\\hspace*{" << from_ascii(params_.length.asLatexString()) << "}";
518 int InsetSpace::plaintext(odocstream & os, OutputParams const &) const
520 switch (params_.kind) {
521 case InsetSpaceParams::HFILL:
522 case InsetSpaceParams::HFILL_PROTECTED:
525 case InsetSpaceParams::DOTFILL:
528 case InsetSpaceParams::HRULEFILL:
531 case InsetSpaceParams::LEFTARROWFILL:
534 case InsetSpaceParams::RIGHTARROWFILL:
537 case InsetSpaceParams::UPBRACEFILL:
540 case InsetSpaceParams::DOWNBRACEFILL:
550 int InsetSpace::docbook(odocstream & os, OutputParams const &) const
552 switch (params_.kind) {
553 case InsetSpaceParams::NORMAL:
554 case InsetSpaceParams::QUAD:
555 case InsetSpaceParams::QQUAD:
556 case InsetSpaceParams::ENSKIP:
559 case InsetSpaceParams::PROTECTED:
560 case InsetSpaceParams::ENSPACE:
561 case InsetSpaceParams::THIN:
562 case InsetSpaceParams::NEGTHIN:
565 case InsetSpaceParams::HFILL:
566 case InsetSpaceParams::HFILL_PROTECTED:
568 case InsetSpaceParams::DOTFILL:
571 case InsetSpaceParams::HRULEFILL:
574 case InsetSpaceParams::LEFTARROWFILL:
575 case InsetSpaceParams::RIGHTARROWFILL:
576 case InsetSpaceParams::UPBRACEFILL:
577 case InsetSpaceParams::DOWNBRACEFILL:
578 case InsetSpaceParams::CUSTOM:
579 case InsetSpaceParams::CUSTOM_PROTECTED:
587 void InsetSpace::textString(odocstream & os) const
589 plaintext(os, OutputParams(0));
593 bool InsetSpace::isStretchableSpace() const
595 return params_.kind == InsetSpaceParams::HFILL
596 || params_.kind == InsetSpaceParams::HFILL_PROTECTED
597 || params_.kind == InsetSpaceParams::DOTFILL
598 || params_.kind == InsetSpaceParams::HRULEFILL
599 || params_.kind == InsetSpaceParams::LEFTARROWFILL
600 || params_.kind == InsetSpaceParams::RIGHTARROWFILL
601 || params_.kind == InsetSpaceParams::UPBRACEFILL
602 || params_.kind == InsetSpaceParams::DOWNBRACEFILL;
606 docstring InsetSpace::contextMenu(BufferView const &, int, int) const
608 return from_ascii("context-space");
612 void InsetSpace::string2params(string const & in, InsetSpaceParams & params)
614 params = InsetSpaceParams();
618 istringstream data(in);
621 lex.setContext("InsetSpace::string2params");
628 string InsetSpace::params2string(InsetSpaceParams const & params)
631 data << "space" << ' ';