3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Matthias Ettrich
8 * Full author contact details are available in file CREDITS.
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "support/gettext.h"
21 #include "TextMetrics.h" // for defaultRowHeight()
23 #include "support/convert.h"
24 #include "support/lstrings.h"
26 #include "support/lassert.h"
31 using namespace lyx::support;
38 /// used to return numeric values in parsing vspace
39 double number[4] = { 0, 0, 0, 0 };
41 /// used to return unit types in parsing vspace
42 Length::UNIT unit[4] = {
49 /// the current position in the number array
51 /// the current position in the unit array
54 /// skip n characters of input
55 inline void lyx_advance(string & data, size_t n)
61 /// return true when the input is at the end
62 inline bool isEndOfData(string const & data)
64 return ltrim(data).empty();
69 * nextToken - return the next token in the input
70 * @param data input string
71 * @return a char representing the type of token returned
73 * The possible return values are :
74 * + stretch indicator for glue length
75 * - shrink indicator for glue length
76 * n a numeric value (stored in number array)
77 * u a unit type (stored in unit array)
80 char nextToken(string & data)
92 if (prefixIs(data, "plus")) {
102 if (prefixIs(data, "minus")) {
103 lyx_advance(data, 5);
107 size_t i = data.find_first_not_of("0123456789.");
110 if (number_index > 3)
115 // we have found some number
116 if (i == string::npos) {
120 buffer = data.substr(0, i);
123 lyx_advance(data, i);
125 if (isStrDbl(buffer)) {
126 number[number_index] = convert<double>(buffer);
133 i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz%");
140 // we have found some alphabetical string
141 if (i == string::npos) {
145 buffer = data.substr(0, i);
148 // possibly we have "mmplus" string or similar
149 if (buffer.size() > 5 &&
150 (buffer.substr(2, 4) == string("plus") ||
151 buffer.substr(2, 5) == string("minus")))
153 lyx_advance(data, 2);
154 unit[unit_index] = unitFromString(buffer.substr(0, 2));
156 lyx_advance(data, i);
157 unit[unit_index] = unitFromString(buffer);
160 if (unit[unit_index] != Length::UNIT_NONE) {
170 /// latex representation of a vspace
172 char const * pattern;
180 /// the possible formats for a vspace string
181 LaTeXLength table[] = {
182 { "nu", 0, 0, 0, 0 },
183 { "nu+nu", 2, 0, 2, 0 },
184 { "nu+nu-nu", 2, 3, 2, 3 },
185 { "nu+-nu", 2, 2, 2, 2 },
186 { "nu-nu", 0, 2, 0, 2 },
187 { "nu-nu+nu", 3, 2, 3, 2 },
188 { "nu-+nu", 2, 2, 2, 2 },
189 { "n+nu", 2, 0, 1, 0 },
190 { "n+n-nu", 2, 3, 1, 1 },
191 { "n+-nu", 2, 2, 1, 1 },
192 { "n-nu", 0, 2, 0, 1 },
193 { "n-n+nu", 3, 2, 1, 1 },
194 { "n-+nu", 2, 2, 1, 1 },
195 { "", 0, 0, 0, 0 } // sentinel, must be empty
201 const char * stringFromUnit(int unit)
203 if (unit < 0 || unit > num_units)
205 return unit_name[unit];
209 bool isValidGlueLength(string const & data, GlueLength * result)
211 // This parser is table-driven. First, it constructs a "pattern"
212 // that describes the sequence of tokens in "data". For example,
213 // "n-nu" means: number, minus sign, number, unit. As we go along,
214 // numbers and units are stored into static arrays. Then, "pattern"
215 // is searched in the "table". If it is found, the associated
216 // table entries tell us which number and unit should go where
217 // in the Length structure. Example: if "data" has the "pattern"
218 // "nu+nu-nu", the associated table entries are "2, 3, 2, 3".
219 // That means, "plus_val" is the second number that was seen
220 // in the input, "minus_val" is the third number, and "plus_uni"
221 // and "minus_uni" are the second and third units, respectively.
222 // ("val" and "uni" are always the first items seen in "data".)
223 // This is the most elegant solution I could find -- a straight-
224 // forward approach leads to very long, tedious code that would be
225 // much harder to understand and maintain. (AS)
229 string buffer = ltrim(data);
231 // To make isValidGlueLength recognize negative values as
232 // the first number this little hack is needed:
233 int val_sign = 1; // positive as default
236 lyx_advance(buffer, 1);
240 lyx_advance(buffer, 1);
247 number_index = unit_index = 1; // entries at index 0 are sentinels
249 // construct "pattern" from "data"
250 size_t const pattern_max_size = 20;
252 while (!isEndOfData(buffer)) {
253 if (pattern.size() > pattern_max_size)
255 char const c = nextToken(buffer);
258 pattern.push_back(c);
261 // search "pattern" in "table"
262 size_t table_index = 0;
263 while (pattern != table[table_index].pattern) {
265 if (!*table[table_index].pattern)
269 // Get the values from the appropriate places. If an index
270 // is zero, the corresponding array value is zero or UNIT_NONE,
271 // so we needn't check this.
273 result->len_.value (number[1] * val_sign);
274 result->len_.unit (unit[1]);
275 result->plus_.value (number[table[table_index].plus_val_index]);
276 result->plus_.unit (unit [table[table_index].plus_uni_index]);
277 result->minus_.value(number[table[table_index].minus_val_index]);
278 result->minus_.unit (unit [table[table_index].minus_uni_index]);
284 bool isValidLength(string const & data, Length * result)
286 // This is a trimmed down version of isValidGlueLength.
287 // The parser may seem overkill for lengths without
288 // glue, but since we already have it, using it is
289 // easier than writing something from scratch.
293 string buffer = data;
294 int pattern_index = 0;
297 // To make isValidLength recognize negative values
298 // this little hack is needed:
299 int val_sign = 1; // positive as default
302 lyx_advance(buffer, 1);
306 lyx_advance(buffer, 1);
314 number_index = unit_index = 1; // entries at index 0 are sentinels
316 // construct "pattern" from "data"
317 while (!isEndOfData(buffer)) {
318 if (pattern_index > 2)
320 pattern[pattern_index] = nextToken(buffer);
321 if (pattern[pattern_index] == 'E')
325 pattern[pattern_index] = '\0';
327 // only the most basic pattern is accepted here
328 if (strcmp(pattern, "nu") != 0)
331 // It _was_ a correct length string.
332 // Store away the values we found.
334 result->val_ = number[1] * val_sign;
335 result->unit_ = unit[1];
346 : kind_(DEFSKIP), len_(), keep_(false)
350 VSpace::VSpace(VSpaceKind k)
351 : kind_(k), len_(), keep_(false)
355 VSpace::VSpace(Length const & l)
356 : kind_(LENGTH), len_(l), keep_(false)
360 VSpace::VSpace(GlueLength const & l)
361 : kind_(LENGTH), len_(l), keep_(false)
365 VSpace::VSpace(string const & data)
366 : kind_(DEFSKIP), len_(), keep_(false)
371 string input = rtrim(data);
373 size_t const length = input.length();
375 if (length > 1 && input[length - 1] == '*') {
377 input.erase(length - 1);
380 if (prefixIs(input, "defskip"))
382 else if (prefixIs(input, "smallskip"))
384 else if (prefixIs(input, "medskip"))
386 else if (prefixIs(input, "bigskip"))
388 else if (prefixIs(input, "vfill"))
390 else if (isValidGlueLength(input, &len_))
392 else if (isStrDbl(input)) {
393 // This last one is for reading old .lyx files
394 // without units in added_space_top/bottom.
395 // Let unit default to centimeters here.
397 len_ = GlueLength(Length(convert<double>(input), Length::CM));
402 bool VSpace::operator==(VSpace const & other) const
404 if (kind_ != other.kind_)
408 return this->keep_ == other.keep_;
410 if (len_ != other.len_)
413 return keep_ == other.keep_;
417 string const VSpace::asLyXCommand() const
421 case DEFSKIP: result = "defskip"; break;
422 case SMALLSKIP: result = "smallskip"; break;
423 case MEDSKIP: result = "medskip"; break;
424 case BIGSKIP: result = "bigskip"; break;
425 case VFILL: result = "vfill"; break;
426 case LENGTH: result = len_.asString(); break;
434 string const VSpace::asLatexCommand(BufferParams const & params) const
438 return params.getDefSkip().asLatexCommand(params);
441 return keep_ ? "\\vspace*{\\smallskipamount}" : "\\smallskip{}";
444 return keep_ ? "\\vspace*{\\medskipamount}" : "\\medskip{}";
447 return keep_ ? "\\vspace*{\\bigskipamount}" : "\\bigskip{}";
450 return keep_ ? "\\vspace*{\\fill}" : "\\vfill{}";
453 return keep_ ? "\\vspace*{" + len_.asLatexString() + '}'
454 : "\\vspace{" + len_.asLatexString() + '}';
457 LASSERT(false, /**/);
463 docstring const VSpace::asGUIName() const
468 result = _("Default skip");
471 result = _("Small skip");
474 result = _("Medium skip");
477 result = _("Big skip");
480 result = _("Vertical fill");
483 result = from_ascii(len_.asString());
487 result += ", " + _("protected");
492 string VSpace::asHTMLLength() const
496 case DEFSKIP: result = "2ex"; break;
497 case SMALLSKIP: result = "1ex"; break;
498 case MEDSKIP: result = "3ex"; break;
499 case BIGSKIP: result = "5ex"; break;
501 Length tmp = len_.len();
503 result = tmp.asHTMLString();
510 int VSpace::inPixels(BufferView const & bv) const
512 // Height of a normal line in pixels (zoom factor considered)
513 int const default_height = defaultRowHeight();
518 return bv.buffer().params().getDefSkip().inPixels(bv);
520 // This is how the skips are normally defined by LateX.
521 // But there should be some way to change this per document.
523 return default_height / 4;
526 return default_height / 2;
529 return default_height;
532 // leave space for the vfill symbol
533 return 3 * default_height;
536 return len_.len().inPixels(bv.workWidth());
539 LASSERT(false, /**/);