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 = max(4, abs(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 xoffset = (y0 - y1) / 2;
244 // Two tests for very narrow insets
245 if (xoffset > x1 - x0
246 && (params_.kind == InsetSpaceParams::LEFTARROWFILL
247 || params_.kind == InsetSpaceParams::RIGHTARROWFILL))
249 if (xoffset * 6 > (x1 - x0)
250 && (params_.kind == InsetSpaceParams::UPBRACEFILL
251 || params_.kind == InsetSpaceParams::DOWNBRACEFILL))
252 xoffset = (x1 - x0) / 6;
254 int const x2 = x0 + xoffset;
255 int const x3 = x1 - xoffset;
256 int const xm = (x0 + x1) / 2;
257 int const xml = xm - xoffset;
258 int const xmr = xm + xoffset;
260 if (params_.kind == InsetSpaceParams::HFILL) {
261 pi.pain.line(x0, y1, x0, y0, Color_added_space);
262 pi.pain.line(x0, y2 , x1, y2, Color_added_space,
263 frontend::Painter::line_onoffdash);
264 pi.pain.line(x1, y1, x1, y0, Color_added_space);
265 } else if (params_.kind == InsetSpaceParams::HFILL_PROTECTED) {
266 pi.pain.line(x0, y1, x0, y0, Color_latex);
267 pi.pain.line(x0, y2 , x1, y2, Color_latex,
268 frontend::Painter::line_onoffdash);
269 pi.pain.line(x1, y1, x1, y0, Color_latex);
270 } else if (params_.kind == InsetSpaceParams::DOTFILL) {
271 pi.pain.line(x0, y1, x0, y0, Color_special);
272 pi.pain.line(x0, y0, x1, y0, Color_special,
273 frontend::Painter::line_onoffdash);
274 pi.pain.line(x1, y1, x1, y0, Color_special);
275 } else if (params_.kind == InsetSpaceParams::HRULEFILL) {
276 pi.pain.line(x0, y1, x0, y0, Color_special);
277 pi.pain.line(x0, y0, x1, y0, Color_special);
278 pi.pain.line(x1, y1, x1, y0, Color_special);
279 } else if (params_.kind == InsetSpaceParams::LEFTARROWFILL) {
280 pi.pain.line(x2, y1 + 1 , x0 + 1, y2, Color_special);
281 pi.pain.line(x0 + 1, y2 + 1 , x2, y0, Color_special);
282 pi.pain.line(x0, y2 , x1, y2, Color_special);
283 } else if (params_.kind == InsetSpaceParams::RIGHTARROWFILL) {
284 pi.pain.line(x3 + 1, y1 + 1 , x1, y2, Color_special);
285 pi.pain.line(x1, y2 + 1 , x3 + 1, y0, Color_special);
286 pi.pain.line(x0, y2 , x1, y2, Color_special);
287 } else if (params_.kind == InsetSpaceParams::UPBRACEFILL) {
288 pi.pain.line(x0 + 1, y1 + 1 , x2, y2, Color_special);
289 pi.pain.line(x2, y2 , xml, y2, Color_special);
290 pi.pain.line(xml + 1, y2 + 1 , xm, y0, Color_special);
291 pi.pain.line(xm + 1, y0 , xmr, y2 + 1, Color_special);
292 pi.pain.line(xmr, y2 , x3, y2, Color_special);
293 pi.pain.line(x3 + 1, y2 , x1, y1 + 1, Color_special);
294 } else if (params_.kind == InsetSpaceParams::DOWNBRACEFILL) {
295 pi.pain.line(x0 + 1, y0 , x2, y2 + 1, Color_special);
296 pi.pain.line(x2, y2 , xml, y2, Color_special);
297 pi.pain.line(xml + 1, y2 , xm, y1 + 1, Color_special);
298 pi.pain.line(xm + 1, y1 + 1 , xmr, y2, Color_special);
299 pi.pain.line(xmr, y2 , x3, y2, Color_special);
300 pi.pain.line(x3 + 1, y2 + 1 , x1, y0, Color_special);
305 int const w = dim.wid;
306 int const h = theFontMetrics(pi.base.font).ascent('x');
310 yp[0] = y - max(h / 4, 1);
311 if (params_.kind == InsetSpaceParams::NORMAL ||
312 params_.kind == InsetSpaceParams::PROTECTED) {
313 xp[1] = x; yp[1] = y;
314 xp[2] = x + w; yp[2] = y;
316 xp[1] = x; yp[1] = y + max(h / 4, 1);
317 xp[2] = x + w; yp[2] = y + max(h / 4, 1);
320 yp[3] = y - max(h / 4, 1);
322 if (params_.length.inBP() < 0) {
323 // turn symbol upside down. A prettier solution would use
324 // inverted arrows (like in VSpace).
328 if (params_.kind == InsetSpaceParams::PROTECTED ||
329 params_.kind == InsetSpaceParams::ENSPACE ||
330 params_.kind == InsetSpaceParams::NEGTHIN ||
331 params_.kind == InsetSpaceParams::CUSTOM_PROTECTED)
332 pi.pain.lines(xp, yp, 4, Color_latex);
334 pi.pain.lines(xp, yp, 4, Color_special);
338 void InsetSpaceParams::write(ostream & os) const
342 case InsetSpaceParams::NORMAL:
345 case InsetSpaceParams::PROTECTED:
348 case InsetSpaceParams::THIN:
349 os << "\\thinspace{}";
351 case InsetSpaceParams::QUAD:
354 case InsetSpaceParams::QQUAD:
357 case InsetSpaceParams::ENSPACE:
360 case InsetSpaceParams::ENSKIP:
363 case InsetSpaceParams::NEGTHIN:
364 os << "\\negthinspace{}";
366 case InsetSpaceParams::HFILL:
369 case InsetSpaceParams::HFILL_PROTECTED:
370 os << "\\hspace*{\\fill}";
372 case InsetSpaceParams::DOTFILL:
375 case InsetSpaceParams::HRULEFILL:
376 os << "\\hrulefill{}";
378 case InsetSpaceParams::LEFTARROWFILL:
379 os << "\\leftarrowfill{}";
381 case InsetSpaceParams::RIGHTARROWFILL:
382 os << "\\rightarrowfill{}";
384 case InsetSpaceParams::UPBRACEFILL:
385 os << "\\upbracefill{}";
387 case InsetSpaceParams::DOWNBRACEFILL:
388 os << "\\downbracefill{}";
390 case InsetSpaceParams::CUSTOM:
393 case InsetSpaceParams::CUSTOM_PROTECTED:
399 os << "\n\\length " << length.asString();
403 void InsetSpaceParams::read(Lexer & lex)
405 lex.setContext("InsetSpaceParams::read");
409 if (command == "\\space{}")
410 kind = InsetSpaceParams::NORMAL;
411 else if (command == "~")
412 kind = InsetSpaceParams::PROTECTED;
413 else if (command == "\\thinspace{}")
414 kind = InsetSpaceParams::THIN;
415 else if (command == "\\quad{}")
416 kind = InsetSpaceParams::QUAD;
417 else if (command == "\\qquad{}")
418 kind = InsetSpaceParams::QQUAD;
419 else if (command == "\\enspace{}")
420 kind = InsetSpaceParams::ENSPACE;
421 else if (command == "\\enskip{}")
422 kind = InsetSpaceParams::ENSKIP;
423 else if (command == "\\negthinspace{}")
424 kind = InsetSpaceParams::NEGTHIN;
425 else if (command == "\\hfill{}")
426 kind = InsetSpaceParams::HFILL;
427 else if (command == "\\hspace*{\\fill}")
428 kind = InsetSpaceParams::HFILL_PROTECTED;
429 else if (command == "\\dotfill{}")
430 kind = InsetSpaceParams::DOTFILL;
431 else if (command == "\\hrulefill{}")
432 kind = InsetSpaceParams::HRULEFILL;
433 else if (command == "\\hspace{}")
434 kind = InsetSpaceParams::CUSTOM;
435 else if (command == "\\leftarrowfill{}")
436 kind = InsetSpaceParams::LEFTARROWFILL;
437 else if (command == "\\rightarrowfill{}")
438 kind = InsetSpaceParams::RIGHTARROWFILL;
439 else if (command == "\\upbracefill{}")
440 kind = InsetSpaceParams::UPBRACEFILL;
441 else if (command == "\\downbracefill{}")
442 kind = InsetSpaceParams::DOWNBRACEFILL;
443 else if (command == "\\hspace*{}")
444 kind = InsetSpaceParams::CUSTOM_PROTECTED;
446 lex.printError("InsetSpace: Unknown kind: `$$Token'");
448 if (lex.checkFor("\\length"))
453 void InsetSpace::write(ostream & os) const
460 void InsetSpace::read(Lexer & lex)
463 lex >> "\\end_inset";
467 int InsetSpace::latex(odocstream & os, OutputParams const & runparams) const
469 switch (params_.kind) {
470 case InsetSpaceParams::NORMAL:
471 os << (runparams.free_spacing ? " " : "\\ ");
473 case InsetSpaceParams::PROTECTED:
474 os << (runparams.free_spacing ? ' ' : '~');
476 case InsetSpaceParams::THIN:
477 os << (runparams.free_spacing ? " " : "\\,");
479 case InsetSpaceParams::QUAD:
480 os << (runparams.free_spacing ? " " : "\\quad{}");
482 case InsetSpaceParams::QQUAD:
483 os << (runparams.free_spacing ? " " : "\\qquad{}");
485 case InsetSpaceParams::ENSPACE:
486 os << (runparams.free_spacing ? " " : "\\enspace{}");
488 case InsetSpaceParams::ENSKIP:
489 os << (runparams.free_spacing ? " " : "\\enskip{}");
491 case InsetSpaceParams::NEGTHIN:
492 os << (runparams.free_spacing ? " " : "\\negthinspace{}");
494 case InsetSpaceParams::HFILL:
495 os << (runparams.free_spacing ? " " : "\\hfill{}");
497 case InsetSpaceParams::HFILL_PROTECTED:
498 os << (runparams.free_spacing ? " " : "\\hspace*{\\fill}");
500 case InsetSpaceParams::DOTFILL:
501 os << (runparams.free_spacing ? " " : "\\dotfill{}");
503 case InsetSpaceParams::HRULEFILL:
504 os << (runparams.free_spacing ? " " : "\\hrulefill{}");
506 case InsetSpaceParams::LEFTARROWFILL:
507 os << (runparams.free_spacing ? " " : "\\leftarrowfill{}");
509 case InsetSpaceParams::RIGHTARROWFILL:
510 os << (runparams.free_spacing ? " " : "\\rightarrowfill{}");
512 case InsetSpaceParams::UPBRACEFILL:
513 os << (runparams.free_spacing ? " " : "\\upbracefill{}");
515 case InsetSpaceParams::DOWNBRACEFILL:
516 os << (runparams.free_spacing ? " " : "\\downbracefill{}");
518 case InsetSpaceParams::CUSTOM:
519 if (runparams.free_spacing)
522 os << "\\hspace{" << from_ascii(params_.length.asLatexString()) << "}";
524 case InsetSpaceParams::CUSTOM_PROTECTED:
525 if (runparams.free_spacing)
528 os << "\\hspace*{" << from_ascii(params_.length.asLatexString()) << "}";
535 int InsetSpace::plaintext(odocstream & os, OutputParams const &) const
537 switch (params_.kind) {
538 case InsetSpaceParams::HFILL:
539 case InsetSpaceParams::HFILL_PROTECTED:
542 case InsetSpaceParams::DOTFILL:
545 case InsetSpaceParams::HRULEFILL:
548 case InsetSpaceParams::LEFTARROWFILL:
551 case InsetSpaceParams::RIGHTARROWFILL:
554 case InsetSpaceParams::UPBRACEFILL:
557 case InsetSpaceParams::DOWNBRACEFILL:
567 int InsetSpace::docbook(odocstream & os, OutputParams const &) const
569 switch (params_.kind) {
570 case InsetSpaceParams::NORMAL:
571 case InsetSpaceParams::QUAD:
572 case InsetSpaceParams::QQUAD:
573 case InsetSpaceParams::ENSKIP:
576 case InsetSpaceParams::PROTECTED:
577 case InsetSpaceParams::ENSPACE:
578 case InsetSpaceParams::THIN:
579 case InsetSpaceParams::NEGTHIN:
582 case InsetSpaceParams::HFILL:
583 case InsetSpaceParams::HFILL_PROTECTED:
585 case InsetSpaceParams::DOTFILL:
588 case InsetSpaceParams::HRULEFILL:
591 case InsetSpaceParams::LEFTARROWFILL:
592 case InsetSpaceParams::RIGHTARROWFILL:
593 case InsetSpaceParams::UPBRACEFILL:
594 case InsetSpaceParams::DOWNBRACEFILL:
595 case InsetSpaceParams::CUSTOM:
596 case InsetSpaceParams::CUSTOM_PROTECTED:
604 void InsetSpace::textString(odocstream & os) const
606 plaintext(os, OutputParams(0));
610 bool InsetSpace::isStretchableSpace() const
612 return params_.kind == InsetSpaceParams::HFILL
613 || params_.kind == InsetSpaceParams::HFILL_PROTECTED
614 || params_.kind == InsetSpaceParams::DOTFILL
615 || params_.kind == InsetSpaceParams::HRULEFILL
616 || params_.kind == InsetSpaceParams::LEFTARROWFILL
617 || params_.kind == InsetSpaceParams::RIGHTARROWFILL
618 || params_.kind == InsetSpaceParams::UPBRACEFILL
619 || params_.kind == InsetSpaceParams::DOWNBRACEFILL;
623 docstring InsetSpace::contextMenu(BufferView const &, int, int) const
625 return from_ascii("context-space");
629 void InsetSpace::string2params(string const & in, InsetSpaceParams & params)
631 params = InsetSpaceParams();
635 istringstream data(in);
638 lex.setContext("InsetSpace::string2params");
641 // There are cases, such as when we are called via getStatus() from
642 // Dialog::canApply(), where we are just called with "space" rather
643 // than a full "space \type{}\n\\end_inset".
649 string InsetSpace::params2string(InsetSpaceParams const & params)
652 data << "space" << ' ';