2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 The LyX Team.
10 * ====================================================== */
15 #pragma implementation "vspace.h"
23 #include "BufferView.h"
24 #include "support/lstrings.h"
30 static const int num_units = LyXLength::UNIT_NONE;
32 // I am not sure if "mu" should be possible to select (Lgb)
33 static char const * unit_name[num_units] = { "sp", "pt", "bp", "dd",
34 "mm", "pc", "cc", "cm",
35 "in", "ex", "em", "mu" };
38 LyXLength::UNIT unitFromString (string const & data)
41 while ((i < num_units) && (data != unit_name[i])) ++i;
42 return static_cast<LyXLength::UNIT>(i);
45 /* The following static items form a simple scanner for
46 * length strings, used by isValid[Glue]Length. See comments there.
48 static float number[4] = { 0, 0, 0, 0 };
49 static LyXLength::UNIT unit[4] = { LyXLength::UNIT_NONE,
52 LyXLength::UNIT_NONE };
53 //static int number_index, unit_index;
54 int number_index, unit_index;
58 void lyx_advance(string & data, unsigned int n)
65 bool isEndOfData(string const & data)
67 return frontStrip(data).empty();
72 char nextToken(string & data)
74 data = frontStrip(data);
77 else if (data[0] == '+') {
80 } else if (prefixIs(data, "plus")) {
83 } else if (data[0] == '-') {
86 } else if (prefixIs(data, "minus")) {
90 string::size_type i = data.find_first_not_of("0123456789.");
93 if (number_index > 3) return 'E';
97 // we have found some number
98 if (i == string::npos) {
102 buffer = data.substr(0, i);
104 lyx_advance(data, i);
106 if (isStrDbl(buffer)) {
107 number[number_index] = strToDbl(buffer);
113 i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz");
115 if (unit_index > 3) return 'E';
119 // we have found some alphabetical string
120 if (i == string::npos) {
124 buffer = data.substr(0, i);
126 // possibly we have "mmplus" string or similar
127 if (buffer.size() > 5 && (buffer.substr(2,4) == string("plus") || buffer.substr(2,5) == string("minus"))) {
128 lyx_advance(data, 2);
129 unit[unit_index] = unitFromString(buffer.substr(0, 2));
131 lyx_advance(data, i);
132 unit[unit_index] = unitFromString(buffer);
135 if (unit[unit_index] != LyXLength::UNIT_NONE) {
138 } else return 'E'; // Error
146 char const * pattern;
147 int plus_val_index, minus_val_index,
148 plus_uni_index, minus_uni_index;
153 LaTeXLength table[] = {
154 { "nu", 0, 0, 0, 0 },
155 { "nu+nu", 2, 0, 2, 0 },
156 { "nu+nu-nu", 2, 3, 2, 3 },
157 { "nu+-nu", 2, 2, 2, 2 },
158 { "nu-nu", 0, 2, 0, 2 },
159 { "nu-nu+nu", 3, 2, 3, 2 },
160 { "nu-+nu", 2, 2, 2, 2 },
161 { "n+nu", 2, 0, 1, 0 },
162 { "n+n-nu", 2, 3, 1, 1 },
163 { "n+-nu", 2, 2, 1, 1 },
164 { "n-nu", 0, 2, 0, 1 },
165 { "n-n+nu", 3, 2, 1, 1 },
166 { "n-+nu", 2, 2, 1, 1 },
167 { "", 0, 0, 0, 0 } // sentinel, must be empty
171 bool isValidGlueLength (string const & data, LyXGlueLength * result)
173 // This parser is table-driven. First, it constructs a "pattern"
174 // that describes the sequence of tokens in "data". For example,
175 // "n-nu" means: number, minus sign, number, unit. As we go along,
176 // numbers and units are stored into static arrays. Then, "pattern"
177 // is searched in the "table". If it is found, the associated
178 // table entries tell us which number and unit should go where
179 // in the LyXLength structure. Example: if "data" has the "pattern"
180 // "nu+nu-nu", the associated table entries are "2, 3, 2, 3".
181 // That means, "plus_val" is the second number that was seen
182 // in the input, "minus_val" is the third number, and "plus_uni"
183 // and "minus_uni" are the second and third units, respectively.
184 // ("val" and "uni" are always the first items seen in "data".)
185 // This is the most elegant solution I could find -- a straight-
186 // forward approach leads to very long, tedious code that would be
187 // much harder to understand and maintain. (AS)
191 string buffer = frontStrip(data);
193 // To make isValidGlueLength recognize negative values as
194 // the first number this little hack is needed:
195 short val_sign = 1; // positive as default
198 lyx_advance(buffer, 1);
202 lyx_advance(buffer, 1);
210 int pattern_index = 0, table_index = 0;
213 number_index = unit_index = 1; // entries at index 0 are sentinels
215 // construct "pattern" from "data"
216 while (!isEndOfData (buffer)) {
217 if (pattern_index > 20) return false;
218 pattern[pattern_index] = nextToken (buffer);
219 if (pattern[pattern_index] == 'E') return false;
222 pattern[pattern_index] = '\0';
224 // search "pattern" in "table"
226 while (compare(pattern, table[table_index].pattern)) {
228 if (!*table[table_index].pattern) return false;
231 // Get the values from the appropriate places. If an index
232 // is zero, the corresponding array value is zero or UNIT_NONE,
233 // so we needn't check this.
235 result->val = number[1] * val_sign;
236 result->uni = unit[1];
237 result->plus_val = number[table[table_index].plus_val_index];
238 result->minus_val = number[table[table_index].minus_val_index];
239 result->plus_uni = unit [table[table_index].plus_uni_index];
240 result->minus_uni = unit [table[table_index].minus_uni_index];
246 bool isValidLength(string const & data, LyXLength * result)
248 /// This is a trimmed down version of isValidGlueLength.
249 /// The parser may seem overkill for lengths without
250 /// glue, but since we already have it, using it is
251 /// easier than writing something from scratch.
254 int pattern_index = 0;
257 // To make isValidLength recognize negative values
258 // this little hack is needed:
259 short val_sign = 1; // positive as default
262 lyx_advance(buffer, 1);
266 lyx_advance(buffer, 1);
274 number_index = unit_index = 1; // entries at index 0 are sentinels
276 // construct "pattern" from "data"
277 while (!isEndOfData (buffer)) {
278 if (pattern_index > 2) return false;
279 pattern[pattern_index] = nextToken (buffer);
280 if (pattern[pattern_index] == 'E') return false;
283 pattern[pattern_index] = '\0';
285 // only the most basic pattern is accepted here
286 if (compare(pattern, "nu") != 0) return false;
288 // It _was_ a correct length string.
289 // Store away the values we found.
291 result->val = number[1] * val_sign;
292 result->uni = unit[1];
300 LyXLength::LyXLength(string const & data)
304 if (!isValidLength (data, &tmp))
305 return; // should raise an exception
313 string const LyXLength::asString() const
315 std::ostringstream buffer;
316 buffer << val << unit_name[uni]; // setw?
317 return buffer.str().c_str();
321 /* LyXGlueLength class
324 LyXGlueLength::LyXGlueLength (string const & data)
326 LyXGlueLength tmp(0.0, PT);
328 if (!isValidGlueLength (data, &tmp))
329 return; // should raise an exception
333 plus_val = tmp.plus_val;
334 plus_uni = tmp.plus_uni;
335 minus_val = tmp.minus_val;
336 minus_uni = tmp.minus_uni;
341 string const LyXGlueLength::asString() const
343 std::ostringstream buffer;
346 if (minus_val != 0.0)
347 if ((uni == plus_uni) && (uni == minus_uni))
348 if (plus_val == minus_val)
349 buffer << val << "+-"
350 << plus_val << unit_name[uni];
357 if (plus_uni == minus_uni
358 && plus_val == minus_val)
359 buffer << val << unit_name[uni]
361 << unit_name[plus_uni];
364 buffer << val << unit_name[uni]
366 << unit_name[plus_uni]
368 << unit_name[minus_uni];
371 buffer << val << '+' << plus_val
374 buffer << val << unit_name[uni]
376 << unit_name[plus_uni];
379 if (minus_val != 0.0)
380 if (uni == minus_uni)
381 buffer << val << '-' << minus_val
385 buffer << val << unit_name[uni]
387 << unit_name[minus_uni];
389 buffer << val << unit_name[uni];
391 return buffer.str().c_str();
395 string const LyXGlueLength::asLatexString() const
397 std::ostringstream buffer;
400 if (minus_val != 0.0)
401 buffer << val << unit_name[uni]
403 << plus_val << unit_name[plus_uni]
405 << minus_val << unit_name[minus_uni];
407 buffer << val << unit_name[uni]
409 << plus_val << unit_name[plus_uni];
411 if (minus_val != 0.0)
412 buffer << val << unit_name[uni]
414 << minus_val << unit_name[minus_uni];
416 buffer << val << unit_name[uni];
418 return buffer.str().c_str();
425 VSpace::VSpace (string const & data)
426 : kin (NONE), len (0.0, LyXLength::PT)
432 string input = strip(data);
434 int length = input.length();
436 if (length > 1 && input[length-1] == '*') {
438 input.erase(length - 1);
441 if (prefixIs (input, "defskip")) kin = DEFSKIP;
442 else if (prefixIs (input, "smallskip")) kin = SMALLSKIP;
443 else if (prefixIs (input, "medskip")) kin = MEDSKIP;
444 else if (prefixIs (input, "bigskip")) kin = BIGSKIP;
445 else if (prefixIs (input, "vfill")) kin = VFILL;
446 else if (isValidGlueLength (input, &len))
448 else if (sscanf(input.c_str(), "%f", &value) == 1) {
449 // This last one is for reading old .lyx files
450 // without units in added_space_top/bottom.
451 // Let unit default to centimeters here.
453 len = LyXGlueLength (value, LyXLength::CM);
458 bool VSpace::operator==(VSpace const & other) const
460 if (this->kin == other.kin)
461 if (this->kin == LENGTH)
462 if (this->len == other.len)
463 return this->kp == other.kp;
467 return this->kp == other.kp;
473 string const VSpace::asLyXCommand() const
479 case DEFSKIP: result = "defskip"; break;
480 case SMALLSKIP: result = "smallskip"; break;
481 case MEDSKIP: result = "medskip"; break;
482 case BIGSKIP: result = "bigskip"; break;
483 case VFILL: result = "vfill"; break;
484 case LENGTH: result = len.asString(); break;
486 if (kp && (kin != NONE) && (kin != DEFSKIP))
487 return result += '*';
493 string const VSpace::asLatexCommand(BufferParams const & params) const
496 case NONE: return string();
498 return params.getDefSkip().asLatexCommand(params);
499 case SMALLSKIP: return kp ? "\\vspace*{\\smallskipamount}"
501 case MEDSKIP: return kp ? "\\vspace*{\\medskipamount}"
503 case BIGSKIP: return kp ? "\\vspace*{\\bigskipamount}"
505 case VFILL: return kp ? "\\vspace*{\\fill}"
507 case LENGTH: return kp ? "\\vspace*{" + len.asLatexString() + '}'
508 : "\\vspace{" + len.asLatexString() + '}';
510 return string(); // should never be reached
514 int VSpace::inPixels(BufferView * bv) const
516 // Height of a normal line in pixels (zoom factor considered)
517 int height = bv->text->DefaultHeight(); // [pixels]
520 skip = bv->buffer()->params.getDefSkip().inPixels(bv);
522 return inPixels(height, skip);
525 int VSpace::inPixels(int default_height, int default_skip) const
527 // Height of a normal line in pixels (zoom factor considered)
528 int height = default_height; // [pixels]
530 // Zoom factor specified by user in percent
531 float const zoom = lyxrc.zoom / 100.0; // [percent]
533 // DPI setting for monitor: pixels/inch
534 float const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
536 // We want the result in pixels
545 // This is how the skips are normally defined by
546 // LateX. But there should be some way to change
547 // this per document.
548 case SMALLSKIP: return height / 4;
549 case MEDSKIP: return height / 2;
550 case BIGSKIP: return height;
551 case VFILL: return 3 * height;
552 // leave space for the vfill symbol
554 // Pixel values are scaled so that the ratio
555 // between lengths and font sizes on the screen
556 // is the same as on paper.
558 // we don't care about sign of value, we
559 // can't display negative anyway
562 short val_sign = value < 0.0 ? -1 : 1;
564 switch (len.unit()) {
566 // Scaled point: sp = 1/65536 pt
567 result = zoom * dpi * value
568 / (72.27 * 65536); // 4736286.7
571 // Point: 1 pt = 1/72.27 inch
572 result = zoom * dpi * value
576 // Big point: 1 bp = 1/72 inch
577 result = zoom * dpi * value
581 // Didot: 1157dd = 1238 pt?
582 result = zoom * dpi * value
583 / (72.27 / (0.376 * 2.845)); // 67.559735
586 // Millimeter: 1 mm = 1/25.4 inch
587 result = zoom * dpi * value
591 // Pica: 1 pc = 12 pt
592 result = zoom * dpi * value
593 / (72.27 / 12); // 6.0225
596 // Cicero: 1 cc = 12 dd
597 result = zoom * dpi * value
598 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
601 // Centimeter: 1 cm = 1/2.54 inch
602 result = zoom * dpi * value
607 result = zoom * dpi * value;
610 // Ex: The height of an "x"
611 result = zoom * value * height / 2; // what to / width?
613 case LyXLength::EM: // what to / width?
614 // Em: The width of an "m"
615 result = zoom * value * height / 2; // Why 2?
617 case LyXLength::MU: // This is probably only allowed in
619 result = zoom * value * height;
621 case LyXLength::UNIT_NONE:
622 result = 0; // this cannot happen
625 return int (result * val_sign + 0.5);
627 return 0; // never reached