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.enabled(true);
166 return Inset::getStatus(cur, cmd, status);
171 void InsetSpace::edit(Cursor & cur, bool, EntryDirection)
173 cur.bv().showDialog("space", params2string(params()), this);
177 void InsetSpace::metrics(MetricsInfo & mi, Dimension & dim) const
179 if (isStretchableSpace()) {
180 // The metrics for this kinds are calculated externally in
181 // \c TextMetrics::computeRowMetrics. Those are dummy value:
182 dim = Dimension(10, 10, 10);
186 frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
187 dim.asc = fm.maxAscent();
188 dim.des = fm.maxDescent();
190 switch (params_.kind) {
191 case InsetSpaceParams::THIN:
192 case InsetSpaceParams::NEGTHIN:
193 dim.wid = fm.width(char_type('M')) / 6;
195 case InsetSpaceParams::PROTECTED:
196 case InsetSpaceParams::NORMAL:
197 dim.wid = fm.width(char_type(' '));
199 case InsetSpaceParams::QUAD:
200 dim.wid = fm.width(char_type('M'));
202 case InsetSpaceParams::QQUAD:
203 dim.wid = 2 * fm.width(char_type('M'));
205 case InsetSpaceParams::ENSPACE:
206 case InsetSpaceParams::ENSKIP:
207 dim.wid = int(0.5 * fm.width(char_type('M')));
209 case InsetSpaceParams::CUSTOM:
210 case InsetSpaceParams::CUSTOM_PROTECTED:
211 dim.wid = params_.length.inBP();
213 case InsetSpaceParams::HFILL:
214 case InsetSpaceParams::HFILL_PROTECTED:
215 case InsetSpaceParams::DOTFILL:
216 case InsetSpaceParams::HRULEFILL:
217 case InsetSpaceParams::LEFTARROWFILL:
218 case InsetSpaceParams::RIGHTARROWFILL:
219 case InsetSpaceParams::UPBRACEFILL:
220 case InsetSpaceParams::DOWNBRACEFILL:
224 // Cache the inset dimension.
225 setDimCache(mi, dim);
229 void InsetSpace::draw(PainterInfo & pi, int x, int y) const
231 Dimension const dim = dimension(*pi.base.bv);
233 if (isStretchableSpace()) {
234 int const asc = theFontMetrics(pi.base.font).ascent('M');
235 int const desc = theFontMetrics(pi.base.font).descent('M');
236 //Pixel height divisible by 2 for prettier fill graphics:
237 int const oddheight = (asc ^ desc) & 1;
238 int const x0 = x + 1;
239 int const x1 = x + dim.wid - 2;
240 int const y0 = y + desc - 1;
241 int const y1 = y - asc + oddheight - 1;
242 int const y2 = (y0 + y1) / 2;
243 int const xoffset = (y0 - y1) / 2;
244 int const x2 = x0 + xoffset;
245 int const x3 = x1 - xoffset;
246 int const xm = (x0 + x1) / 2;
247 int const xml = xm - xoffset;
248 int const xmr = xm + xoffset;
250 if (params_.kind == InsetSpaceParams::HFILL) {
251 pi.pain.line(x0, y1, x0, y0, Color_added_space);
252 pi.pain.line(x0, y2 , x1, y2, Color_added_space,
253 frontend::Painter::line_onoffdash);
254 pi.pain.line(x1, y1, x1, y0, Color_added_space);
255 } else if (params_.kind == InsetSpaceParams::HFILL_PROTECTED) {
256 pi.pain.line(x0, y1, x0, y0, Color_latex);
257 pi.pain.line(x0, y2 , x1, y2, Color_latex,
258 frontend::Painter::line_onoffdash);
259 pi.pain.line(x1, y1, x1, y0, Color_latex);
260 } else if (params_.kind == InsetSpaceParams::DOTFILL) {
261 pi.pain.line(x0, y1, x0, y0, Color_special);
262 pi.pain.line(x0, y0, x1, y0, Color_special,
263 frontend::Painter::line_onoffdash);
264 pi.pain.line(x1, y1, x1, y0, Color_special);
265 } else if (params_.kind == InsetSpaceParams::HRULEFILL) {
266 pi.pain.line(x0, y1, x0, y0, Color_special);
267 pi.pain.line(x0, y0, x1, y0, Color_special);
268 pi.pain.line(x1, y1, x1, y0, Color_special);
269 } else if (params_.kind == InsetSpaceParams::LEFTARROWFILL) {
270 pi.pain.line(x2, y1 + 1 , x0 + 1, y2, Color_special);
271 pi.pain.line(x0 + 1, y2 + 1 , x2, y0, Color_special);
272 pi.pain.line(x0, y2 , x1, y2, Color_special);
273 } else if (params_.kind == InsetSpaceParams::RIGHTARROWFILL) {
274 pi.pain.line(x3 + 1, y1 + 1 , x1, y2, Color_special);
275 pi.pain.line(x1, y2 + 1 , x3 + 1, y0, Color_special);
276 pi.pain.line(x0, y2 , x1, y2, Color_special);
277 } else if (params_.kind == InsetSpaceParams::UPBRACEFILL) {
278 pi.pain.line(x0 + 1, y1 + 1 , x2, y2, Color_special);
279 pi.pain.line(x2, y2 , xml, y2, Color_special);
280 pi.pain.line(xml + 1, y2 + 1 , xm, y0, Color_special);
281 pi.pain.line(xm + 1, y0 , xmr, y2 + 1, Color_special);
282 pi.pain.line(xmr, y2 , x3, y2, Color_special);
283 pi.pain.line(x3 + 1, y2 , x1, y1 + 1, Color_special);
284 } else if (params_.kind == InsetSpaceParams::DOWNBRACEFILL) {
285 pi.pain.line(x0 + 1, y0 , x2, y2 + 1, Color_special);
286 pi.pain.line(x2, y2 , xml, y2, Color_special);
287 pi.pain.line(xml + 1, y2 , xm, y1 + 1, Color_special);
288 pi.pain.line(xm + 1, y1 + 1 , xmr, y2, Color_special);
289 pi.pain.line(xmr, y2 , x3, y2, Color_special);
290 pi.pain.line(x3 + 1, y2 + 1 , x1, y0, Color_special);
295 int const w = dim.wid;
296 int const h = theFontMetrics(pi.base.font).ascent('x');
300 yp[0] = y - max(h / 4, 1);
301 if (params_.kind == InsetSpaceParams::NORMAL ||
302 params_.kind == InsetSpaceParams::PROTECTED) {
303 xp[1] = x; yp[1] = y;
304 xp[2] = x + w; yp[2] = y;
306 xp[1] = x; yp[1] = y + max(h / 4, 1);
307 xp[2] = x + w; yp[2] = y + max(h / 4, 1);
310 yp[3] = y - max(h / 4, 1);
312 if (params_.kind == InsetSpaceParams::PROTECTED ||
313 params_.kind == InsetSpaceParams::ENSPACE ||
314 params_.kind == InsetSpaceParams::NEGTHIN ||
315 params_.kind == InsetSpaceParams::CUSTOM_PROTECTED)
316 pi.pain.lines(xp, yp, 4, Color_latex);
318 pi.pain.lines(xp, yp, 4, Color_special);
322 void InsetSpaceParams::write(ostream & os) const
326 case InsetSpaceParams::NORMAL:
329 case InsetSpaceParams::PROTECTED:
332 case InsetSpaceParams::THIN:
333 os << "\\thinspace{}";
335 case InsetSpaceParams::QUAD:
338 case InsetSpaceParams::QQUAD:
341 case InsetSpaceParams::ENSPACE:
344 case InsetSpaceParams::ENSKIP:
347 case InsetSpaceParams::NEGTHIN:
348 os << "\\negthinspace{}";
350 case InsetSpaceParams::HFILL:
353 case InsetSpaceParams::HFILL_PROTECTED:
354 os << "\\hspace*{\\fill}";
356 case InsetSpaceParams::DOTFILL:
359 case InsetSpaceParams::HRULEFILL:
360 os << "\\hrulefill{}";
362 case InsetSpaceParams::LEFTARROWFILL:
363 os << "\\leftarrowfill{}";
365 case InsetSpaceParams::RIGHTARROWFILL:
366 os << "\\rightarrowfill{}";
368 case InsetSpaceParams::UPBRACEFILL:
369 os << "\\upbracefill{}";
371 case InsetSpaceParams::DOWNBRACEFILL:
372 os << "\\downbracefill{}";
374 case InsetSpaceParams::CUSTOM:
377 case InsetSpaceParams::CUSTOM_PROTECTED:
383 os << "\n\\length " << length.asString();
387 void InsetSpaceParams::read(Lexer & lex)
389 lex.setContext("InsetSpaceParams::read");
393 if (command == "\\space{}")
394 kind = InsetSpaceParams::NORMAL;
395 else if (command == "~")
396 kind = InsetSpaceParams::PROTECTED;
397 else if (command == "\\thinspace{}")
398 kind = InsetSpaceParams::THIN;
399 else if (command == "\\quad{}")
400 kind = InsetSpaceParams::QUAD;
401 else if (command == "\\qquad{}")
402 kind = InsetSpaceParams::QQUAD;
403 else if (command == "\\enspace{}")
404 kind = InsetSpaceParams::ENSPACE;
405 else if (command == "\\enskip{}")
406 kind = InsetSpaceParams::ENSKIP;
407 else if (command == "\\negthinspace{}")
408 kind = InsetSpaceParams::NEGTHIN;
409 else if (command == "\\hfill{}")
410 kind = InsetSpaceParams::HFILL;
411 else if (command == "\\hspace*{\\fill}")
412 kind = InsetSpaceParams::HFILL_PROTECTED;
413 else if (command == "\\dotfill{}")
414 kind = InsetSpaceParams::DOTFILL;
415 else if (command == "\\hrulefill{}")
416 kind = InsetSpaceParams::HRULEFILL;
417 else if (command == "\\hspace{}")
418 kind = InsetSpaceParams::CUSTOM;
419 else if (command == "\\leftarrowfill{}")
420 kind = InsetSpaceParams::LEFTARROWFILL;
421 else if (command == "\\rightarrowfill{}")
422 kind = InsetSpaceParams::RIGHTARROWFILL;
423 else if (command == "\\upbracefill{}")
424 kind = InsetSpaceParams::UPBRACEFILL;
425 else if (command == "\\downbracefill{}")
426 kind = InsetSpaceParams::DOWNBRACEFILL;
427 else if (command == "\\hspace*{}")
428 kind = InsetSpaceParams::CUSTOM_PROTECTED;
430 lex.printError("InsetSpace: Unknown kind: `$$Token'");
432 if (lex.checkFor("\\length"))
434 lex >> "\\end_inset";
438 void InsetSpace::write(ostream & os) const
445 void InsetSpace::read(Lexer & lex)
451 int InsetSpace::latex(odocstream & os, OutputParams const & runparams) const
453 switch (params_.kind) {
454 case InsetSpaceParams::NORMAL:
455 os << (runparams.free_spacing ? " " : "\\ ");
457 case InsetSpaceParams::PROTECTED:
458 os << (runparams.free_spacing ? ' ' : '~');
460 case InsetSpaceParams::THIN:
461 os << (runparams.free_spacing ? " " : "\\,");
463 case InsetSpaceParams::QUAD:
464 os << (runparams.free_spacing ? " " : "\\quad{}");
466 case InsetSpaceParams::QQUAD:
467 os << (runparams.free_spacing ? " " : "\\qquad{}");
469 case InsetSpaceParams::ENSPACE:
470 os << (runparams.free_spacing ? " " : "\\enspace{}");
472 case InsetSpaceParams::ENSKIP:
473 os << (runparams.free_spacing ? " " : "\\enskip{}");
475 case InsetSpaceParams::NEGTHIN:
476 os << (runparams.free_spacing ? " " : "\\negthinspace{}");
478 case InsetSpaceParams::HFILL:
479 os << (runparams.free_spacing ? " " : "\\hfill{}");
481 case InsetSpaceParams::HFILL_PROTECTED:
482 os << (runparams.free_spacing ? " " : "\\hspace*{\\fill}");
484 case InsetSpaceParams::DOTFILL:
485 os << (runparams.free_spacing ? " " : "\\dotfill{}");
487 case InsetSpaceParams::HRULEFILL:
488 os << (runparams.free_spacing ? " " : "\\hrulefill{}");
490 case InsetSpaceParams::LEFTARROWFILL:
491 os << (runparams.free_spacing ? " " : "\\leftarrowfill{}");
493 case InsetSpaceParams::RIGHTARROWFILL:
494 os << (runparams.free_spacing ? " " : "\\rightarrowfill{}");
496 case InsetSpaceParams::UPBRACEFILL:
497 os << (runparams.free_spacing ? " " : "\\upbracefill{}");
499 case InsetSpaceParams::DOWNBRACEFILL:
500 os << (runparams.free_spacing ? " " : "\\downbracefill{}");
502 case InsetSpaceParams::CUSTOM:
503 if (runparams.free_spacing)
506 os << "\\hspace{" << from_ascii(params_.length.asLatexString()) << "}";
508 case InsetSpaceParams::CUSTOM_PROTECTED:
509 if (runparams.free_spacing)
512 os << "\\hspace*{" << from_ascii(params_.length.asLatexString()) << "}";
519 int InsetSpace::plaintext(odocstream & os, OutputParams const &) const
521 switch (params_.kind) {
522 case InsetSpaceParams::HFILL:
523 case InsetSpaceParams::HFILL_PROTECTED:
526 case InsetSpaceParams::DOTFILL:
529 case InsetSpaceParams::HRULEFILL:
532 case InsetSpaceParams::LEFTARROWFILL:
535 case InsetSpaceParams::RIGHTARROWFILL:
538 case InsetSpaceParams::UPBRACEFILL:
541 case InsetSpaceParams::DOWNBRACEFILL:
551 int InsetSpace::docbook(odocstream & os, OutputParams const &) const
553 switch (params_.kind) {
554 case InsetSpaceParams::NORMAL:
555 case InsetSpaceParams::QUAD:
556 case InsetSpaceParams::QQUAD:
557 case InsetSpaceParams::ENSKIP:
560 case InsetSpaceParams::PROTECTED:
561 case InsetSpaceParams::ENSPACE:
562 case InsetSpaceParams::THIN:
563 case InsetSpaceParams::NEGTHIN:
566 case InsetSpaceParams::HFILL:
567 case InsetSpaceParams::HFILL_PROTECTED:
569 case InsetSpaceParams::DOTFILL:
572 case InsetSpaceParams::HRULEFILL:
575 case InsetSpaceParams::LEFTARROWFILL:
576 case InsetSpaceParams::RIGHTARROWFILL:
577 case InsetSpaceParams::UPBRACEFILL:
578 case InsetSpaceParams::DOWNBRACEFILL:
579 case InsetSpaceParams::CUSTOM:
580 case InsetSpaceParams::CUSTOM_PROTECTED:
588 void InsetSpace::textString(odocstream & os) const
590 plaintext(os, OutputParams(0));
594 bool InsetSpace::isStretchableSpace() const
596 return params_.kind == InsetSpaceParams::HFILL
597 || params_.kind == InsetSpaceParams::HFILL_PROTECTED
598 || params_.kind == InsetSpaceParams::DOTFILL
599 || params_.kind == InsetSpaceParams::HRULEFILL
600 || params_.kind == InsetSpaceParams::LEFTARROWFILL
601 || params_.kind == InsetSpaceParams::RIGHTARROWFILL
602 || params_.kind == InsetSpaceParams::UPBRACEFILL
603 || params_.kind == InsetSpaceParams::DOWNBRACEFILL;
607 docstring InsetSpace::contextMenu(BufferView const &, int, int) const
609 return from_ascii("context-space");
613 void InsetSpace::string2params(string const & in, InsetSpaceParams & params)
615 params = InsetSpaceParams();
619 istringstream data(in);
622 lex.setContext("InsetSpace::string2params");
629 string InsetSpace::params2string(InsetSpaceParams const & params)
632 data << "space" << ' ';