src/VSpace.cpp

   1 /**
   2  * \file VSpace.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Matthias Ettrich
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "VSpace.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.h"
  18 #include "support/gettext.h"
  19 #include "Length.h"
  20 #include "Text.h"
  21 #include "TextMetrics.h" // for defaultRowHeight()
  22
  23 #include "support/convert.h"
  24 #include "support/lstrings.h"
  25
  26 #include "support/lassert.h"
  27
  28 #include <cstring>
  29
  30 using namespace std;
  31 using namespace lyx::support;
  32
  33
  34 namespace lyx {
  35
  36 namespace {
  37
  38 /// used to return numeric values in parsing vspace
  39 double number[4] = { 0, 0, 0, 0 };
  40
  41 /// used to return unit types in parsing vspace
  42 Length::UNIT unit[4] = {
  43         Length::UNIT_NONE,
  44         Length::UNIT_NONE,
  45         Length::UNIT_NONE,
  46         Length::UNIT_NONE
  47 };
  48
  49 /// the current position in the number array
  50 int number_index;
  51 /// the current position in the unit array
  52 int unit_index;
  53
  54 /// skip n characters of input
  55 inline void lyx_advance(string & data, size_t n)
  56 {
  57         data.erase(0, n);
  58 }
  59
  60
  61 /// return true when the input is at the end
  62 inline bool isEndOfData(string const & data)
  63 {
  64         return ltrim(data).empty();
  65 }
  66
  67
  68 /**
  69  * nextToken -  return the next token in the input
  70  * @param data input string
  71  * @return a char representing the type of token returned
  72  *
  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)
  78  *      E       parse error
  79  */
  80 char nextToken(string & data)
  81 {
  82         data = ltrim(data);
  83
  84         if (data.empty())
  85                 return '\0';
  86
  87         if (data[0] == '+') {
  88                 lyx_advance(data, 1);
  89                 return '+';
  90         }
  91
  92         if (prefixIs(data, "plus")) {
  93                 lyx_advance(data, 4);
  94                 return '+';
  95         }
  96
  97         if (data[0] == '-') {
  98                 lyx_advance(data, 1);
  99                 return '-';
 100         }
 101
 102         if (prefixIs(data, "minus")) {
 103                 lyx_advance(data, 5);
 104                 return '-';
 105         }
 106
 107         size_t i = data.find_first_not_of("0123456789.");
 108
 109         if (i != 0) {
 110                 if (number_index > 3)
 111                         return 'E';
 112
 113                 string buffer;
 114
 115                 // we have found some number
 116                 if (i == string::npos) {
 117                         buffer = data;
 118                         i = data.size() + 1;
 119                 } else {
 120                         buffer = data.substr(0, i);
 121                 }
 122
 123                 lyx_advance(data, i);
 124
 125                 if (isStrDbl(buffer)) {
 126                         number[number_index] = convert<double>(buffer);
 127                         ++number_index;
 128                         return 'n';
 129                 }
 130                 return 'E';
 131         }
 132
 133         i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz%");
 134         if (i != 0) {
 135                 if (unit_index > 3)
 136                         return 'E';
 137
 138                 string buffer;
 139
 140                 // we have found some alphabetical string
 141                 if (i == string::npos) {
 142                         buffer = data;
 143                         i = data.size() + 1;
 144                 } else {
 145                         buffer = data.substr(0, i);
 146                 }
 147
 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")))
 152                 {
 153                         lyx_advance(data, 2);
 154                         unit[unit_index] = unitFromString(buffer.substr(0, 2));
 155                 } else {
 156                         lyx_advance(data, i);
 157                         unit[unit_index] = unitFromString(buffer);
 158                 }
 159
 160                 if (unit[unit_index] != Length::UNIT_NONE) {
 161                         ++unit_index;
 162                         return 'u';
 163                 }
 164                 return 'E';  // Error
 165         }
 166         return 'E';  // Error
 167 }
 168
 169
 170 /// latex representation of a vspace
 171 struct LaTeXLength {
 172         char const * pattern;
 173         int  plus_val_index;
 174         int  minus_val_index;
 175         int  plus_uni_index;
 176         int  minus_uni_index;
 177 };
 178
 179
 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
 196 };
 197
 198
 199 } // namespace anon
 200
 201 const char * stringFromUnit(int unit)
 202 {
 203         if (unit < 0 || unit > num_units)
 204                 return 0;
 205         return unit_name[unit];
 206 }
 207
 208
 209 bool isValidGlueLength(string const & data, GlueLength * result)
 210 {
 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)
 226
 227         if (data.empty())
 228                 return true;
 229         string buffer = ltrim(data);
 230
 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
 234         switch (buffer[0]) {
 235         case '-':
 236                 lyx_advance(buffer, 1);
 237                 val_sign = -1;
 238                 break;
 239         case '+':
 240                 lyx_advance(buffer, 1);
 241                 break;
 242         default:
 243                 break;
 244         }
 245         // end of hack
 246
 247         // construct "pattern" from "data"
 248         size_t const pattern_max_size = 20;
 249         string pattern;
 250         while (!isEndOfData(buffer)) {
 251                 if (pattern.size() > pattern_max_size)
 252                         return false;
 253                 char const c = nextToken(buffer);
 254                 if (c == 'E')
 255                         return false;
 256                 pattern.push_back(c);
 257         }
 258
 259         // search "pattern" in "table"
 260         size_t table_index = 0;
 261         while (pattern != table[table_index].pattern) {
 262                 ++table_index;
 263                 if (!*table[table_index].pattern)
 264                         return false;
 265         }
 266
 267         // Get the values from the appropriate places.  If an index
 268         // is zero, the corresponding array value is zero or UNIT_NONE,
 269         // so we needn't check this.
 270         if (result) {
 271                 result->len_.value  (number[1] * val_sign);
 272                 result->len_.unit   (unit[1]);
 273                 result->plus_.value (number[table[table_index].plus_val_index]);
 274                 result->plus_.unit  (unit  [table[table_index].plus_uni_index]);
 275                 result->minus_.value(number[table[table_index].minus_val_index]);
 276                 result->minus_.unit (unit  [table[table_index].minus_uni_index]);
 277         }
 278         return true;
 279 }
 280
 281
 282 bool isValidLength(string const & data, Length * result)
 283 {
 284         // This is a trimmed down version of isValidGlueLength.
 285         // The parser may seem overkill for lengths without
 286         // glue, but since we already have it, using it is
 287         // easier than writing something from scratch.
 288         if (data.empty())
 289                 return true;
 290
 291         string   buffer = data;
 292         int      pattern_index = 0;
 293         char     pattern[3];
 294
 295         // To make isValidLength recognize negative values
 296         // this little hack is needed:
 297         int val_sign = 1; // positive as default
 298         switch (buffer[0]) {
 299         case '-':
 300                 lyx_advance(buffer, 1);
 301                 val_sign = -1;
 302                 break;
 303         case '+':
 304                 lyx_advance(buffer, 1);
 305                 // fall through
 306         default:
 307                 // no action
 308                 break;
 309         }
 310         // end of hack
 311
 312         number_index = unit_index = 1;  // entries at index 0 are sentinels
 313
 314         // construct "pattern" from "data"
 315         while (!isEndOfData(buffer)) {
 316                 if (pattern_index > 2)
 317                         return false;
 318                 pattern[pattern_index] = nextToken(buffer);
 319                 if (pattern[pattern_index] == 'E')
 320                         return false;
 321                 ++pattern_index;
 322         }
 323         pattern[pattern_index] = '\0';
 324
 325         // only the most basic pattern is accepted here
 326         if (strcmp(pattern, "nu") != 0)
 327                 return false;
 328
 329         // It _was_ a correct length string.
 330         // Store away the values we found.
 331         if (result) {
 332                 result->val_  = number[1] * val_sign;
 333                 result->unit_ = unit[1];
 334         }
 335         return true;
 336 }
 337
 338
 339 //
 340 //  VSpace class
 341 //
 342
 343 VSpace::VSpace()
 344         : kind_(DEFSKIP), len_(), keep_(false)
 345 {}
 346
 347
 348 VSpace::VSpace(VSpaceKind k)
 349         : kind_(k), len_(), keep_(false)
 350 {}
 351
 352
 353 VSpace::VSpace(Length const & l)
 354         : kind_(LENGTH), len_(l), keep_(false)
 355 {}
 356
 357
 358 VSpace::VSpace(GlueLength const & l)
 359         : kind_(LENGTH), len_(l), keep_(false)
 360 {}
 361
 362
 363 VSpace::VSpace(string const & data)
 364         : kind_(DEFSKIP), len_(), keep_(false)
 365 {
 366         if (data.empty())
 367                 return;
 368
 369         string input = rtrim(data);
 370
 371         size_t const length = input.length();
 372
 373         if (length > 1 && input[length - 1] == '*') {
 374                 keep_ = true;
 375                 input.erase(length - 1);
 376         }
 377
 378         if (prefixIs(input, "defskip"))
 379                 kind_ = DEFSKIP;
 380         else if (prefixIs(input, "smallskip"))
 381                 kind_ = SMALLSKIP;
 382         else if (prefixIs(input, "medskip"))
 383                 kind_ = MEDSKIP;
 384         else if (prefixIs(input, "bigskip"))
 385                 kind_ = BIGSKIP;
 386         else if (prefixIs(input, "vfill"))
 387                 kind_ = VFILL;
 388         else if (isValidGlueLength(input, &len_))
 389                 kind_ = LENGTH;
 390         else if (isStrDbl(input)) {
 391                 // This last one is for reading old .lyx files
 392                 // without units in added_space_top/bottom.
 393                 // Let unit default to centimeters here.
 394                 kind_ = LENGTH;
 395                 len_  = GlueLength(Length(convert<double>(input), Length::CM));
 396         }
 397 }
 398
 399
 400 bool VSpace::operator==(VSpace const & other) const
 401 {
 402         if (kind_ != other.kind_)
 403                 return false;
 404
 405         if (kind_ != LENGTH)
 406                 return this->keep_ == other.keep_;
 407
 408         if (len_ != other.len_)
 409                 return false;
 410
 411         return keep_ == other.keep_;
 412 }
 413
 414
 415 string const VSpace::asLyXCommand() const
 416 {
 417         string result;
 418         switch (kind_) {
 419         case DEFSKIP:   result = "defskip";      break;
 420         case SMALLSKIP: result = "smallskip";    break;
 421         case MEDSKIP:   result = "medskip";      break;
 422         case BIGSKIP:   result = "bigskip";      break;
 423         case VFILL:     result = "vfill";        break;
 424         case LENGTH:    result = len_.asString(); break;
 425         }
 426         if (keep_)
 427                 result += '*';
 428         return result;
 429 }
 430
 431
 432 string const VSpace::asLatexCommand(BufferParams const & params) const
 433 {
 434         switch (kind_) {
 435         case DEFSKIP:
 436                 return params.getDefSkip().asLatexCommand(params);
 437
 438         case SMALLSKIP:
 439                 return keep_ ? "\\vspace*{\\smallskipamount}" : "\\smallskip{}";
 440
 441         case MEDSKIP:
 442                 return keep_ ? "\\vspace*{\\medskipamount}" : "\\medskip{}";
 443
 444         case BIGSKIP:
 445                 return keep_ ? "\\vspace*{\\bigskipamount}" : "\\bigskip{}";
 446
 447         case VFILL:
 448                 return keep_ ? "\\vspace*{\\fill}" : "\\vfill{}";
 449
 450         case LENGTH:
 451                 return keep_ ? "\\vspace*{" + len_.asLatexString() + '}'
 452                         : "\\vspace{" + len_.asLatexString() + '}';
 453
 454         default:
 455                 LASSERT(false, /**/);
 456                 return string();
 457         }
 458 }
 459
 460
 461 docstring const VSpace::asGUIName() const
 462 {
 463         docstring result;
 464         switch (kind_) {
 465         case DEFSKIP:
 466                 result = _("Default skip");
 467                 break;
 468         case SMALLSKIP:
 469                 result = _("Small skip");
 470                 break;
 471         case MEDSKIP:
 472                 result = _("Medium skip");
 473                 break;
 474         case BIGSKIP:
 475                 result = _("Big skip");
 476                 break;
 477         case VFILL:
 478                 result = _("Vertical fill");
 479                 break;
 480         case LENGTH:
 481                 result = from_ascii(len_.asString());
 482                 break;
 483         }
 484         if (keep_)
 485                 result += ", " + _("protected");
 486         return result;
 487 }
 488
 489
 490 string VSpace::asHTMLLength() const
 491 {
 492         string result;
 493         switch (kind_) {
 494                 case DEFSKIP:   result = "2ex"; break;
 495                 case SMALLSKIP: result = "1ex"; break;
 496                 case MEDSKIP:   result = "3ex"; break;
 497                 case BIGSKIP:   result = "5ex"; break;
 498                 case LENGTH: {
 499                         Length tmp = len_.len();
 500                         if (tmp.value() > 0)
 501                                 result = tmp.asHTMLString();
 502                 }
 503                 case VFILL:     break;
 504         }
 505         return result;
 506 }
 507
 508 int VSpace::inPixels(BufferView const & bv) const
 509 {
 510         // Height of a normal line in pixels (zoom factor considered)
 511         int const default_height = defaultRowHeight();
 512
 513         switch (kind_) {
 514
 515         case DEFSKIP:
 516                 return bv.buffer().params().getDefSkip().inPixels(bv);
 517
 518         // This is how the skips are normally defined by LateX.
 519         // But there should be some way to change this per document.
 520         case SMALLSKIP:
 521                 return default_height / 4;
 522
 523         case MEDSKIP:
 524                 return default_height / 2;
 525
 526         case BIGSKIP:
 527                 return default_height;
 528
 529         case VFILL:
 530                 // leave space for the vfill symbol
 531                 return 3 * default_height;
 532
 533         case LENGTH:
 534                 return len_.len().inPixels(bv.workWidth());
 535
 536         default:
 537                 LASSERT(false, /**/);
 538                 return 0;
 539         }
 540 }
 541
 542
 543 } // namespace lyx