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 <boost/assert.hpp>
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 int pattern_index
= 0;
252 unit_index
= 1; // entries at index 0 are sentinels
254 // construct "pattern" from "data"
255 while (!isEndOfData(buffer
)) {
256 if (pattern_index
> 20)
258 pattern
[pattern_index
] = nextToken(buffer
);
259 if (pattern
[pattern_index
] == 'E')
263 pattern
[pattern_index
] = '\0';
265 // search "pattern" in "table"
267 while (strcmp(pattern
, table
[table_index
].pattern
)) {
269 if (!*table
[table_index
].pattern
)
273 // Get the values from the appropriate places. If an index
274 // is zero, the corresponding array value is zero or UNIT_NONE,
275 // so we needn't check this.
277 result
->len_
.value (number
[1] * val_sign
);
278 result
->len_
.unit (unit
[1]);
279 result
->plus_
.value (number
[table
[table_index
].plus_val_index
]);
280 result
->plus_
.unit (unit
[table
[table_index
].plus_uni_index
]);
281 result
->minus_
.value(number
[table
[table_index
].minus_val_index
]);
282 result
->minus_
.unit (unit
[table
[table_index
].minus_uni_index
]);
288 bool isValidLength(string
const & data
, Length
* result
)
290 // This is a trimmed down version of isValidGlueLength.
291 // The parser may seem overkill for lengths without
292 // glue, but since we already have it, using it is
293 // easier than writing something from scratch.
297 string buffer
= data
;
298 int pattern_index
= 0;
301 // To make isValidLength recognize negative values
302 // this little hack is needed:
303 int val_sign
= 1; // positive as default
306 lyx_advance(buffer
, 1);
310 lyx_advance(buffer
, 1);
318 number_index
= unit_index
= 1; // entries at index 0 are sentinels
320 // construct "pattern" from "data"
321 while (!isEndOfData(buffer
)) {
322 if (pattern_index
> 2)
324 pattern
[pattern_index
] = nextToken(buffer
);
325 if (pattern
[pattern_index
] == 'E')
329 pattern
[pattern_index
] = '\0';
331 // only the most basic pattern is accepted here
332 if (strcmp(pattern
, "nu") != 0)
335 // It _was_ a correct length string.
336 // Store away the values we found.
338 result
->val_
= number
[1] * val_sign
;
339 result
->unit_
= unit
[1];
350 : kind_(DEFSKIP
), len_(), keep_(false)
354 VSpace::VSpace(VSpaceKind k
)
355 : kind_(k
), len_(), keep_(false)
359 VSpace::VSpace(Length
const & l
)
360 : kind_(LENGTH
), len_(l
), keep_(false)
364 VSpace::VSpace(GlueLength
const & l
)
365 : kind_(LENGTH
), len_(l
), keep_(false)
369 VSpace::VSpace(string
const & data
)
370 : kind_(DEFSKIP
), len_(), keep_(false)
375 string input
= rtrim(data
);
377 size_t const length
= input
.length();
379 if (length
> 1 && input
[length
- 1] == '*') {
381 input
.erase(length
- 1);
384 if (prefixIs(input
, "defskip"))
386 else if (prefixIs(input
, "smallskip"))
388 else if (prefixIs(input
, "medskip"))
390 else if (prefixIs(input
, "bigskip"))
392 else if (prefixIs(input
, "vfill"))
394 else if (isValidGlueLength(input
, &len_
))
396 else if (isStrDbl(input
)) {
397 // This last one is for reading old .lyx files
398 // without units in added_space_top/bottom.
399 // Let unit default to centimeters here.
401 len_
= GlueLength(Length(convert
<double>(input
), Length::CM
));
406 bool VSpace::operator==(VSpace
const & other
) const
408 if (kind_
!= other
.kind_
)
412 return this->keep_
== other
.keep_
;
414 if (len_
!= other
.len_
)
417 return keep_
== other
.keep_
;
421 string
const VSpace::asLyXCommand() const
425 case DEFSKIP
: result
= "defskip"; break;
426 case SMALLSKIP
: result
= "smallskip"; break;
427 case MEDSKIP
: result
= "medskip"; break;
428 case BIGSKIP
: result
= "bigskip"; break;
429 case VFILL
: result
= "vfill"; break;
430 case LENGTH
: result
= len_
.asString(); break;
438 string
const VSpace::asLatexCommand(BufferParams
const & params
) const
442 return params
.getDefSkip().asLatexCommand(params
);
445 return keep_
? "\\vspace*{\\smallskipamount}" : "\\smallskip{}";
448 return keep_
? "\\vspace*{\\medskipamount}" : "\\medskip{}";
451 return keep_
? "\\vspace*{\\bigskipamount}" : "\\bigskip{}";
454 return keep_
? "\\vspace*{\\fill}" : "\\vfill{}";
457 return keep_
? "\\vspace*{" + len_
.asLatexString() + '}'
458 : "\\vspace{" + len_
.asLatexString() + '}';
467 docstring
const VSpace::asGUIName() const
472 result
= _("Default skip");
475 result
= _("Small skip");
478 result
= _("Medium skip");
481 result
= _("Big skip");
484 result
= _("Vertical fill");
487 result
= from_ascii(len_
.asString());
491 result
+= ", " + _("protected");
496 int VSpace::inPixels(BufferView
const & bv
) const
498 // Height of a normal line in pixels (zoom factor considered)
499 int const default_height
= defaultRowHeight();
504 return bv
.buffer().params().getDefSkip().inPixels(bv
);
506 // This is how the skips are normally defined by LateX.
507 // But there should be some way to change this per document.
509 return default_height
/ 4;
512 return default_height
/ 2;
515 return default_height
;
518 // leave space for the vfill symbol
519 return 3 * default_height
;
522 return len_
.len().inPixels(bv
.workWidth());