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);
177 int const arrow_size = 8;
181 void InsetSpace::metrics(MetricsInfo & mi, Dimension & dim) const
183 if (isStretchableSpace()) {
184 // The metrics for this kinds are calculated externally in
185 // \c TextMetrics::computeRowMetrics. Those are dummy value:
186 dim = Dimension(10, 10, 10);
190 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
191 dim.asc = fm.maxAscent();
192 dim.des = fm.maxDescent();
194 switch (params_.kind) {
195 case InsetSpaceParams::THIN:
196 case InsetSpaceParams::NEGTHIN:
197 dim.wid = fm.width(char_type('M')) / 6;
199 case InsetSpaceParams::PROTECTED:
200 case InsetSpaceParams::NORMAL:
201 dim.wid = fm.width(char_type(' '));
203 case InsetSpaceParams::QUAD:
204 dim.wid = fm.width(char_type('M'));
206 case InsetSpaceParams::QQUAD:
207 dim.wid = 2 * fm.width(char_type('M'));
209 case InsetSpaceParams::ENSPACE:
210 case InsetSpaceParams::ENSKIP:
211 dim.wid = int(0.5 * fm.width(char_type('M')));
213 case InsetSpaceParams::CUSTOM:
214 case InsetSpaceParams::CUSTOM_PROTECTED: {
216 if (params_.length.inBP() < 0)
217 minwidth = 3 * arrow_size;
218 dim.wid = max(minwidth, abs(params_.length.inBP()));
221 case InsetSpaceParams::HFILL:
222 case InsetSpaceParams::HFILL_PROTECTED:
223 case InsetSpaceParams::DOTFILL:
224 case InsetSpaceParams::HRULEFILL:
225 case InsetSpaceParams::LEFTARROWFILL:
226 case InsetSpaceParams::RIGHTARROWFILL:
227 case InsetSpaceParams::UPBRACEFILL:
228 case InsetSpaceParams::DOWNBRACEFILL:
232 // Cache the inset dimension.
233 setDimCache(mi, dim);
237 void InsetSpace::draw(PainterInfo & pi, int x, int y) const
239 Dimension const dim = dimension(*pi.base.bv);
241 if (isStretchableSpace() || params_.length.inBP() < 0) {
242 int const asc = theFontMetrics(pi.base.font).ascent('M');
243 int const desc = theFontMetrics(pi.base.font).descent('M');
244 // Pixel height divisible by 2 for prettier fill graphics:
245 int const oddheight = (asc ^ desc) & 1;
246 int const x0 = x + 1;
247 int const x1 = x + dim.wid - 2;
248 int const y0 = y + desc - 1;
249 int const y1 = y - asc + oddheight - 1;
250 int const y2 = (y0 + y1) / 2;
251 int xoffset = (y0 - y1) / 2;
253 // Two tests for very narrow insets
254 if (xoffset > x1 - x0
255 && (params_.kind == InsetSpaceParams::LEFTARROWFILL
256 || params_.kind == InsetSpaceParams::RIGHTARROWFILL))
258 if (xoffset * 6 > (x1 - x0)
259 && (params_.kind == InsetSpaceParams::UPBRACEFILL
260 || params_.kind == InsetSpaceParams::DOWNBRACEFILL))
261 xoffset = (x1 - x0) / 6;
263 int const x2 = x0 + xoffset;
264 int const x3 = x1 - xoffset;
265 int const xm = (x0 + x1) / 2;
266 int const xml = xm - xoffset;
267 int const xmr = xm + xoffset;
269 if (params_.kind == InsetSpaceParams::HFILL) {
270 pi.pain.line(x0, y1, x0, y0, Color_added_space);
271 pi.pain.line(x0, y2 , x1, y2, Color_added_space,
272 frontend::Painter::line_onoffdash);
273 pi.pain.line(x1, y1, x1, y0, Color_added_space);
274 } else if (params_.kind == InsetSpaceParams::HFILL_PROTECTED) {
275 pi.pain.line(x0, y1, x0, y0, Color_latex);
276 pi.pain.line(x0, y2 , x1, y2, Color_latex,
277 frontend::Painter::line_onoffdash);
278 pi.pain.line(x1, y1, x1, y0, Color_latex);
279 } else if (params_.kind == InsetSpaceParams::DOTFILL) {
280 pi.pain.line(x0, y1, x0, y0, Color_special);
281 pi.pain.line(x0, y0, x1, y0, Color_special,
282 frontend::Painter::line_onoffdash);
283 pi.pain.line(x1, y1, x1, y0, Color_special);
284 } else if (params_.kind == InsetSpaceParams::HRULEFILL) {
285 pi.pain.line(x0, y1, x0, y0, Color_special);
286 pi.pain.line(x0, y0, x1, y0, Color_special);
287 pi.pain.line(x1, y1, x1, y0, Color_special);
288 } else if (params_.kind == InsetSpaceParams::LEFTARROWFILL) {
289 pi.pain.line(x2, y1 + 1 , x0 + 1, y2, Color_special);
290 pi.pain.line(x0 + 1, y2 + 1 , x2, y0, Color_special);
291 pi.pain.line(x0, y2 , x1, y2, Color_special);
292 } else if (params_.kind == InsetSpaceParams::RIGHTARROWFILL) {
293 pi.pain.line(x3 + 1, y1 + 1 , x1, y2, Color_special);
294 pi.pain.line(x1, y2 + 1 , x3 + 1, y0, Color_special);
295 pi.pain.line(x0, y2 , x1, y2, Color_special);
296 } else if (params_.kind == InsetSpaceParams::UPBRACEFILL) {
297 pi.pain.line(x0 + 1, y1 + 1 , x2, y2, Color_special);
298 pi.pain.line(x2, y2 , xml, y2, Color_special);
299 pi.pain.line(xml + 1, y2 + 1 , xm, y0, Color_special);
300 pi.pain.line(xm + 1, y0 , xmr, y2 + 1, Color_special);
301 pi.pain.line(xmr, y2 , x3, y2, Color_special);
302 pi.pain.line(x3 + 1, y2 , x1, y1 + 1, Color_special);
303 } else if (params_.kind == InsetSpaceParams::DOWNBRACEFILL) {
304 pi.pain.line(x0 + 1, y0 , x2, y2 + 1, Color_special);
305 pi.pain.line(x2, y2 , xml, y2, Color_special);
306 pi.pain.line(xml + 1, y2 , xm, y1 + 1, Color_special);
307 pi.pain.line(xm + 1, y1 + 1 , xmr, y2, Color_special);
308 pi.pain.line(xmr, y2 , x3, y2, Color_special);
309 pi.pain.line(x3 + 1, y2 + 1 , x1, y0, Color_special);
310 } else if (params_.kind == InsetSpaceParams::CUSTOM) {
311 pi.pain.line(x0, y1 + 1 , x2 + 1, y2, Color_special);
312 pi.pain.line(x2 + 1, y2 + 1 , x0, y0, Color_special);
313 pi.pain.line(x1 + 1, y1 + 1 , x3, y2, Color_special);
314 pi.pain.line(x3, y2 + 1 , x1 + 1, y0, Color_special);
315 pi.pain.line(x2, y2 , x3, y2, Color_special);
316 } else if (params_.kind == InsetSpaceParams::CUSTOM_PROTECTED) {
317 pi.pain.line(x0, y1 + 1 , x2 + 1, y2, Color_latex);
318 pi.pain.line(x2 + 1, y2 + 1 , x0, y0, Color_latex);
319 pi.pain.line(x1 + 1, y1 + 1 , x3, y2, Color_latex);
320 pi.pain.line(x3, y2 + 1 , x1 + 1, y0, Color_latex);
321 pi.pain.line(x2, y2 , x3, y2, Color_latex);
326 int const w = dim.wid;
327 int const h = theFontMetrics(pi.base.font).ascent('x');
331 yp[0] = y - max(h / 4, 1);
332 if (params_.kind == InsetSpaceParams::NORMAL ||
333 params_.kind == InsetSpaceParams::PROTECTED) {
334 xp[1] = x; yp[1] = y;
335 xp[2] = x + w; yp[2] = y;
337 xp[1] = x; yp[1] = y + max(h / 4, 1);
338 xp[2] = x + w; yp[2] = y + max(h / 4, 1);
341 yp[3] = y - max(h / 4, 1);
343 if (params_.kind == InsetSpaceParams::PROTECTED ||
344 params_.kind == InsetSpaceParams::ENSPACE ||
345 params_.kind == InsetSpaceParams::NEGTHIN ||
346 params_.kind == InsetSpaceParams::CUSTOM_PROTECTED)
347 pi.pain.lines(xp, yp, 4, Color_latex);
349 pi.pain.lines(xp, yp, 4, Color_special);
353 void InsetSpaceParams::write(ostream & os) const
357 case InsetSpaceParams::NORMAL:
360 case InsetSpaceParams::PROTECTED:
363 case InsetSpaceParams::THIN:
364 os << "\\thinspace{}";
366 case InsetSpaceParams::QUAD:
369 case InsetSpaceParams::QQUAD:
372 case InsetSpaceParams::ENSPACE:
375 case InsetSpaceParams::ENSKIP:
378 case InsetSpaceParams::NEGTHIN:
379 os << "\\negthinspace{}";
381 case InsetSpaceParams::HFILL:
384 case InsetSpaceParams::HFILL_PROTECTED:
385 os << "\\hspace*{\\fill}";
387 case InsetSpaceParams::DOTFILL:
390 case InsetSpaceParams::HRULEFILL:
391 os << "\\hrulefill{}";
393 case InsetSpaceParams::LEFTARROWFILL:
394 os << "\\leftarrowfill{}";
396 case InsetSpaceParams::RIGHTARROWFILL:
397 os << "\\rightarrowfill{}";
399 case InsetSpaceParams::UPBRACEFILL:
400 os << "\\upbracefill{}";
402 case InsetSpaceParams::DOWNBRACEFILL:
403 os << "\\downbracefill{}";
405 case InsetSpaceParams::CUSTOM:
408 case InsetSpaceParams::CUSTOM_PROTECTED:
414 os << "\n\\length " << length.asString();
418 void InsetSpaceParams::read(Lexer & lex)
420 lex.setContext("InsetSpaceParams::read");
424 if (command == "\\space{}")
425 kind = InsetSpaceParams::NORMAL;
426 else if (command == "~")
427 kind = InsetSpaceParams::PROTECTED;
428 else if (command == "\\thinspace{}")
429 kind = InsetSpaceParams::THIN;
430 else if (command == "\\quad{}")
431 kind = InsetSpaceParams::QUAD;
432 else if (command == "\\qquad{}")
433 kind = InsetSpaceParams::QQUAD;
434 else if (command == "\\enspace{}")
435 kind = InsetSpaceParams::ENSPACE;
436 else if (command == "\\enskip{}")
437 kind = InsetSpaceParams::ENSKIP;
438 else if (command == "\\negthinspace{}")
439 kind = InsetSpaceParams::NEGTHIN;
440 else if (command == "\\hfill{}")
441 kind = InsetSpaceParams::HFILL;
442 else if (command == "\\hspace*{\\fill}")
443 kind = InsetSpaceParams::HFILL_PROTECTED;
444 else if (command == "\\dotfill{}")
445 kind = InsetSpaceParams::DOTFILL;
446 else if (command == "\\hrulefill{}")
447 kind = InsetSpaceParams::HRULEFILL;
448 else if (command == "\\hspace{}")
449 kind = InsetSpaceParams::CUSTOM;
450 else if (command == "\\leftarrowfill{}")
451 kind = InsetSpaceParams::LEFTARROWFILL;
452 else if (command == "\\rightarrowfill{}")
453 kind = InsetSpaceParams::RIGHTARROWFILL;
454 else if (command == "\\upbracefill{}")
455 kind = InsetSpaceParams::UPBRACEFILL;
456 else if (command == "\\downbracefill{}")
457 kind = InsetSpaceParams::DOWNBRACEFILL;
458 else if (command == "\\hspace*{}")
459 kind = InsetSpaceParams::CUSTOM_PROTECTED;
461 lex.printError("InsetSpace: Unknown kind: `$$Token'");
463 if (lex.checkFor("\\length"))
468 void InsetSpace::write(ostream & os) const
475 void InsetSpace::read(Lexer & lex)
478 lex >> "\\end_inset";
482 int InsetSpace::latex(odocstream & os, OutputParams const & runparams) const
484 switch (params_.kind) {
485 case InsetSpaceParams::NORMAL:
486 os << (runparams.free_spacing ? " " : "\\ ");
488 case InsetSpaceParams::PROTECTED:
489 os << (runparams.free_spacing ? ' ' : '~');
491 case InsetSpaceParams::THIN:
492 os << (runparams.free_spacing ? " " : "\\,");
494 case InsetSpaceParams::QUAD:
495 os << (runparams.free_spacing ? " " : "\\quad{}");
497 case InsetSpaceParams::QQUAD:
498 os << (runparams.free_spacing ? " " : "\\qquad{}");
500 case InsetSpaceParams::ENSPACE:
501 os << (runparams.free_spacing ? " " : "\\enspace{}");
503 case InsetSpaceParams::ENSKIP:
504 os << (runparams.free_spacing ? " " : "\\enskip{}");
506 case InsetSpaceParams::NEGTHIN:
507 os << (runparams.free_spacing ? " " : "\\negthinspace{}");
509 case InsetSpaceParams::HFILL:
510 os << (runparams.free_spacing ? " " : "\\hfill{}");
512 case InsetSpaceParams::HFILL_PROTECTED:
513 os << (runparams.free_spacing ? " " : "\\hspace*{\\fill}");
515 case InsetSpaceParams::DOTFILL:
516 os << (runparams.free_spacing ? " " : "\\dotfill{}");
518 case InsetSpaceParams::HRULEFILL:
519 os << (runparams.free_spacing ? " " : "\\hrulefill{}");
521 case InsetSpaceParams::LEFTARROWFILL:
522 os << (runparams.free_spacing ? " " : "\\leftarrowfill{}");
524 case InsetSpaceParams::RIGHTARROWFILL:
525 os << (runparams.free_spacing ? " " : "\\rightarrowfill{}");
527 case InsetSpaceParams::UPBRACEFILL:
528 os << (runparams.free_spacing ? " " : "\\upbracefill{}");
530 case InsetSpaceParams::DOWNBRACEFILL:
531 os << (runparams.free_spacing ? " " : "\\downbracefill{}");
533 case InsetSpaceParams::CUSTOM:
534 if (runparams.free_spacing)
537 os << "\\hspace{" << from_ascii(params_.length.asLatexString()) << "}";
539 case InsetSpaceParams::CUSTOM_PROTECTED:
540 if (runparams.free_spacing)
543 os << "\\hspace*{" << from_ascii(params_.length.asLatexString()) << "}";
550 int InsetSpace::plaintext(odocstream & os, OutputParams const &) const
552 switch (params_.kind) {
553 case InsetSpaceParams::HFILL:
554 case InsetSpaceParams::HFILL_PROTECTED:
557 case InsetSpaceParams::DOTFILL:
560 case InsetSpaceParams::HRULEFILL:
563 case InsetSpaceParams::LEFTARROWFILL:
566 case InsetSpaceParams::RIGHTARROWFILL:
569 case InsetSpaceParams::UPBRACEFILL:
572 case InsetSpaceParams::DOWNBRACEFILL:
582 int InsetSpace::docbook(odocstream & os, OutputParams const &) const
584 switch (params_.kind) {
585 case InsetSpaceParams::NORMAL:
586 case InsetSpaceParams::QUAD:
587 case InsetSpaceParams::QQUAD:
588 case InsetSpaceParams::ENSKIP:
591 case InsetSpaceParams::PROTECTED:
592 case InsetSpaceParams::ENSPACE:
593 case InsetSpaceParams::THIN:
594 case InsetSpaceParams::NEGTHIN:
597 case InsetSpaceParams::HFILL:
598 case InsetSpaceParams::HFILL_PROTECTED:
600 case InsetSpaceParams::DOTFILL:
603 case InsetSpaceParams::HRULEFILL:
606 case InsetSpaceParams::LEFTARROWFILL:
607 case InsetSpaceParams::RIGHTARROWFILL:
608 case InsetSpaceParams::UPBRACEFILL:
609 case InsetSpaceParams::DOWNBRACEFILL:
610 case InsetSpaceParams::CUSTOM:
611 case InsetSpaceParams::CUSTOM_PROTECTED:
619 void InsetSpace::textString(odocstream & os) const
621 plaintext(os, OutputParams(0));
625 bool InsetSpace::isStretchableSpace() const
627 return params_.kind == InsetSpaceParams::HFILL
628 || params_.kind == InsetSpaceParams::HFILL_PROTECTED
629 || params_.kind == InsetSpaceParams::DOTFILL
630 || params_.kind == InsetSpaceParams::HRULEFILL
631 || params_.kind == InsetSpaceParams::LEFTARROWFILL
632 || params_.kind == InsetSpaceParams::RIGHTARROWFILL
633 || params_.kind == InsetSpaceParams::UPBRACEFILL
634 || params_.kind == InsetSpaceParams::DOWNBRACEFILL;
638 docstring InsetSpace::contextMenu(BufferView const &, int, int) const
640 return from_ascii("context-space");
644 void InsetSpace::string2params(string const & in, InsetSpaceParams & params)
646 params = InsetSpaceParams();
650 istringstream data(in);
653 lex.setContext("InsetSpace::string2params");
656 // There are cases, such as when we are called via getStatus() from
657 // Dialog::canApply(), where we are just called with "space" rather
658 // than a full "space \type{}\n\\end_inset".
664 string InsetSpace::params2string(InsetSpaceParams const & params)
667 data << "space" << ' ';