-// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \file vspace.C
+ * Copyright 1995-2002 the LyX Team
+ * Read the file COPYING
*
- * ====================================================== */
+ * \author Matthias Ettrich
+ */
#include <config.h>
#ifdef __GNUG__
-#pragma implementation "vspace.h"
+#pragma implementation
#endif
+#include "vspace.h"
+#include "lengthcommon.h"
#include "lyx_main.h"
#include "buffer.h"
-#include "vspace.h"
#include "lyxrc.h"
#include "lyxtext.h"
#include "BufferView.h"
-#include "support/lstrings.h"
-
-
-/* length units
- */
+#include "support/LAssert.h"
-static const int num_units = LyXLength::UNIT_NONE;
+#include "support/lstrings.h"
-// I am not sure if "mu" should be possible to select (Lgb)
-static char const * unit_name[num_units] = { "sp", "pt", "bp", "dd",
- "mm", "pc", "cc", "cm",
- "in", "ex", "em", "mu" };
+#include <cstdio>
+#ifndef CXX_GLOBAL_CSTD
+using std::sscanf;
+#endif
-LyXLength::UNIT unitFromString (string const & data)
-{
- int i = 0;
- while ((i < num_units) && (data != unit_name[i])) ++i;
- return static_cast<LyXLength::UNIT>(i);
-}
+namespace {
-/* The following static items form a simple scanner for
- * length strings, used by isValid[Glue]Length. See comments there.
- */
-static float number[4] = { 0, 0, 0, 0 };
-static LyXLength::UNIT unit[4] = { LyXLength::UNIT_NONE,
- LyXLength::UNIT_NONE,
- LyXLength::UNIT_NONE,
- LyXLength::UNIT_NONE };
-static int number_index, unit_index;
+/// used to return numeric values in parsing vspace
+double number[4] = { 0, 0, 0, 0 };
+/// used to return unit types in parsing vspace
+LyXLength::UNIT unit[4] = { LyXLength::UNIT_NONE,
+ LyXLength::UNIT_NONE,
+ LyXLength::UNIT_NONE,
+ LyXLength::UNIT_NONE };
+/// the current position in the number array
+int number_index;
+/// the current position in the unit array
+int unit_index;
-static inline
-void lyx_advance(string & data, unsigned int n)
+/// skip n characters of input
+inline
+void lyx_advance(string & data, string::size_type n)
{
data.erase(0, n);
}
-
-static inline
+/// return true when the input is at the end
+inline
bool isEndOfData(string const & data)
{
- return frontStrip(data).empty();
+ return ltrim(data).empty();
}
-
-static
+/**
+ * nextToken - return the next token in the input
+ * @param data input string
+ * @return a char representing the type of token returned
+ *
+ * The possible return values are :
+ * + stretch indicator for glue length
+ * - shrink indicator for glue length
+ * n a numeric value (stored in number array)
+ * u a unit type (stored in unit array)
+ * E parse error
+ */
char nextToken(string & data)
{
- data = frontStrip(data);
+ data = ltrim(data);
if (data.empty())
return '\0';
else if (data[0] == '+') {
if (number_index > 3) return 'E';
string buffer;
-
+
// we have found some number
if (i == string::npos) {
buffer = data;
return 'n';
} else return 'E';
}
-
- i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz");
+
+ i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz%");
if (i != 0) {
if (unit_index > 3) return 'E';
string buffer;
-
+
// we have found some alphabetical string
if (i == string::npos) {
buffer = data;
}
+/// latex representation of a vspace
struct LaTeXLength {
char const * pattern;
- int plus_val_index, minus_val_index,
- plus_uni_index, minus_uni_index;
+ int plus_val_index;
+ int minus_val_index;
+ int plus_uni_index;
+ int minus_uni_index;
};
-static
+/// the possible formats for a vspace string
LaTeXLength table[] = {
{ "nu", 0, 0, 0, 0 },
{ "nu+nu", 2, 0, 2, 0 },
};
-bool isValidGlueLength (string const & data, LyXGlueLength * result)
+} // namespace anon
+
+const char * stringFromUnit(int unit)
+{
+ if (unit < 0 || unit >= num_units)
+ return 0;
+ return unit_name[unit];
+}
+
+
+bool isValidGlueLength(string const & data, LyXGlueLength * result)
{
// This parser is table-driven. First, it constructs a "pattern"
- // that describes the sequence of tokens in "data". For example,
+ // that describes the sequence of tokens in "data". For example,
// "n-nu" means: number, minus sign, number, unit. As we go along,
- // numbers and units are stored into static arrays. Then, "pattern"
- // is searched in the "table". If it is found, the associated
- // table entries tell us which number and unit should go where
- // in the LyXLength structure. Example: if "data" has the "pattern"
- // "nu+nu-nu", the associated table entries are "2, 3, 2, 3".
+ // numbers and units are stored into static arrays. Then, "pattern"
+ // is searched in the "table". If it is found, the associated
+ // table entries tell us which number and unit should go where
+ // in the LyXLength structure. Example: if "data" has the "pattern"
+ // "nu+nu-nu", the associated table entries are "2, 3, 2, 3".
// That means, "plus_val" is the second number that was seen
// in the input, "minus_val" is the third number, and "plus_uni"
// and "minus_uni" are the second and third units, respectively.
// ("val" and "uni" are always the first items seen in "data".)
- // This is the most elegant solution I could find -- a straight-
- // forward approach leads to very long, tedious code that would be
- // much harder to understand and maintain. (AS)
+ // This is the most elegant solution I could find -- a straight-
+ // forward approach leads to very long, tedious code that would be
+ // much harder to understand and maintain. (AS)
if (data.empty())
return true;
- string buffer = frontStrip(data);
+ string buffer = ltrim(data);
// To make isValidGlueLength recognize negative values as
// the first number this little hack is needed:
- short val_sign = 1; // positive as default
+ int val_sign = 1; // positive as default
switch (buffer[0]) {
case '-':
lyx_advance(buffer, 1);
break;
}
// end of hack
-
- int pattern_index = 0, table_index = 0;
- char pattern[20];
- number_index = unit_index = 1; // entries at index 0 are sentinels
+ int pattern_index = 0;
+ int table_index = 0;
+ char pattern[20];
+
+ number_index = 1;
+ unit_index = 1; // entries at index 0 are sentinels
// construct "pattern" from "data"
while (!isEndOfData (buffer)) {
table_index = 0;
while (compare(pattern, table[table_index].pattern)) {
++table_index;
- if (!*table[table_index].pattern) return false;
+ if (!*table[table_index].pattern)
+ return false;
}
-
+
// Get the values from the appropriate places. If an index
// is zero, the corresponding array value is zero or UNIT_NONE,
// so we needn't check this.
if (result) {
- result->val = number[1] * val_sign;
- result->uni = unit[1];
- result->plus_val = number[table[table_index].plus_val_index];
- result->minus_val = number[table[table_index].minus_val_index];
- result->plus_uni = unit [table[table_index].plus_uni_index];
- result->minus_uni = unit [table[table_index].minus_uni_index];
+ result->len_.value (number[1] * val_sign);
+ result->len_.unit (unit[1]);
+ result->plus_.value (number[table[table_index].plus_val_index]);
+ result->plus_.unit (unit [table[table_index].plus_uni_index]);
+ result->minus_.value(number[table[table_index].minus_val_index]);
+ result->minus_.unit (unit [table[table_index].minus_uni_index]);
}
return true;
}
bool isValidLength(string const & data, LyXLength * result)
{
- /// This is a trimmed down version of isValidGlueLength.
- /// The parser may seem overkill for lengths without
- /// glue, but since we already have it, using it is
- /// easier than writing something from scratch.
+ // This is a trimmed down version of isValidGlueLength.
+ // The parser may seem overkill for lengths without
+ // glue, but since we already have it, using it is
+ // easier than writing something from scratch.
if (data.empty())
return true;
- string buffer(data);
- int pattern_index = 0;
- char pattern[3];
+ string buffer = data;
+ int pattern_index = 0;
+ char pattern[3];
// To make isValidLength recognize negative values
// this little hack is needed:
- short val_sign = 1; // positive as default
+ int val_sign = 1; // positive as default
switch (buffer[0]) {
case '-':
lyx_advance(buffer, 1);
break;
}
// end of hack
-
+
number_index = unit_index = 1; // entries at index 0 are sentinels
// construct "pattern" from "data"
while (!isEndOfData (buffer)) {
- if (pattern_index > 2) return false;
+ if (pattern_index > 2)
+ return false;
pattern[pattern_index] = nextToken (buffer);
- if (pattern[pattern_index] == 'E') return false;
+ if (pattern[pattern_index] == 'E')
+ return false;
++pattern_index;
}
pattern[pattern_index] = '\0';
// only the most basic pattern is accepted here
- if (compare(pattern, "nu") != 0) return false;
-
- // It _was_ a correct length string.
+ if (compare(pattern, "nu") != 0) return false;
+
+ // It _was_ a correct length string.
// Store away the values we found.
if (result) {
- result->val = number[1] * val_sign;
- result->uni = unit[1];
+ result->val_ = number[1] * val_sign;
+ result->unit_ = unit[1];
}
return true;
}
-/// LyXLength class
-
-LyXLength::LyXLength(string const & data)
-{
- LyXLength tmp;
-
- if (!isValidLength (data, &tmp))
- return; // should raise an exception
- else {
- val = tmp.val;
- uni = tmp.uni;
- }
-}
-
-
-string const LyXLength::asString() const
-{
- std::ostringstream buffer;
- buffer << val << unit_name[uni]; // setw?
- return buffer.str().c_str();
-}
-
+//
+// VSpace class
+//
-/* LyXGlueLength class
- */
+VSpace::VSpace()
+ : kind_(NONE), len_(), keep_(false)
+{}
-LyXGlueLength::LyXGlueLength (string const & data)
-{
- LyXGlueLength tmp(0.0, PT);
-
- if (!isValidGlueLength (data, &tmp))
- return; // should raise an exception
- else {
- val = tmp.val;
- uni = tmp.uni;
- plus_val = tmp.plus_val;
- plus_uni = tmp.plus_uni;
- minus_val = tmp.minus_val;
- minus_uni = tmp.minus_uni;
- }
-}
+VSpace::VSpace(vspace_kind k)
+ : kind_(k), len_(), keep_(false)
+{}
-string const LyXGlueLength::asString() const
-{
- std::ostringstream buffer;
-
- if (plus_val != 0.0)
- if (minus_val != 0.0)
- if ((uni == plus_uni) && (uni == minus_uni))
- if (plus_val == minus_val)
- buffer << val << "+-"
- << plus_val << unit_name[uni];
- else
- buffer << val
- << '+' << plus_val
- << '-' << minus_val
- << unit_name[uni];
- else
- if (plus_uni == minus_uni
- && plus_val == minus_val)
- buffer << val << unit_name[uni]
- << "+-" << plus_val
- << unit_name[plus_uni];
-
- else
- buffer << val << unit_name[uni]
- << '+' << plus_val
- << unit_name[plus_uni]
- << '-' << minus_val
- << unit_name[minus_uni];
- else
- if (uni == plus_uni)
- buffer << val << '+' << plus_val
- << unit_name[uni];
- else
- buffer << val << unit_name[uni]
- << '+' << plus_val
- << unit_name[plus_uni];
-
- else
- if (minus_val != 0.0)
- if (uni == minus_uni)
- buffer << val << '-' << minus_val
- << unit_name[uni];
-
- else
- buffer << val << unit_name[uni]
- << '-' << minus_val
- << unit_name[minus_uni];
- else
- buffer << val << unit_name[uni];
-
- return buffer.str().c_str();
-}
+VSpace::VSpace(LyXLength const & l)
+ : kind_(LENGTH), len_(l), keep_(false)
+{}
-string const LyXGlueLength::asLatexString() const
-{
- std::ostringstream buffer;
-
- if (plus_val != 0.0)
- if (minus_val != 0.0)
- buffer << val << unit_name[uni]
- << " plus "
- << plus_val << unit_name[plus_uni]
- << " minus "
- << minus_val << unit_name[minus_uni];
- else
- buffer << val << unit_name[uni]
- << " plus "
- << plus_val << unit_name[plus_uni];
- else
- if (minus_val != 0.0)
- buffer << val << unit_name[uni]
- << " minus "
- << minus_val << unit_name[minus_uni];
- else
- buffer << val << unit_name[uni];
-
- return buffer.str().c_str();
-}
+VSpace::VSpace(LyXGlueLength const & l)
+ : kind_(LENGTH), len_(l), keep_(false)
+{}
-/* VSpace class
- */
-VSpace::VSpace (string const & data)
- : kin (NONE), len (0.0, LyXLength::PT)
+VSpace::VSpace(string const & data)
+ : kind_(NONE), len_(), keep_(false)
{
- kp = false;
if (data.empty())
return;
- float value;
- string input = strip(data);
+ double value;
+ string input = rtrim(data);
- int length = input.length();
+ string::size_type const length = input.length();
if (length > 1 && input[length-1] == '*') {
- kp = true;
+ keep_ = true;
input.erase(length - 1);
}
- if (prefixIs (input, "defskip")) kin = DEFSKIP;
- else if (prefixIs (input, "smallskip")) kin = SMALLSKIP;
- else if (prefixIs (input, "medskip")) kin = MEDSKIP;
- else if (prefixIs (input, "bigskip")) kin = BIGSKIP;
- else if (prefixIs (input, "vfill")) kin = VFILL;
- else if (isValidGlueLength (input, &len))
- kin = LENGTH;
- else if (sscanf(input.c_str(), "%f", &value) == 1) {
+ if (prefixIs (input, "defskip")) kind_ = DEFSKIP;
+ else if (prefixIs (input, "smallskip")) kind_ = SMALLSKIP;
+ else if (prefixIs (input, "medskip")) kind_ = MEDSKIP;
+ else if (prefixIs (input, "bigskip")) kind_ = BIGSKIP;
+ else if (prefixIs (input, "vfill")) kind_ = VFILL;
+ else if (isValidGlueLength(input, &len_)) kind_ = LENGTH;
+ else if (sscanf(input.c_str(), "%lf", &value) == 1) {
// This last one is for reading old .lyx files
// without units in added_space_top/bottom.
// Let unit default to centimeters here.
- kin = LENGTH;
- len = LyXGlueLength (value, LyXLength::CM);
+ kind_ = LENGTH;
+ len_ = LyXGlueLength(LyXLength(value, LyXLength::CM));
}
}
+VSpace::vspace_kind VSpace::kind() const
+{
+ return kind_;
+}
+
+
+LyXGlueLength VSpace::length() const
+{
+ return len_;
+}
+
+
+bool VSpace::keep() const
+{
+ return keep_;
+}
+
+
+void VSpace::setKeep(bool val)
+{
+ keep_ = val;
+}
+
+
bool VSpace::operator==(VSpace const & other) const
{
- if (this->kin != other.kin)
+ if (kind_ != other.kind_)
return false;
-
- if (this->kin != LENGTH)
- return this->kp == other.kp;
-
- if (!(this->len == other.len))
+
+ if (kind_ != LENGTH)
+ return this->keep_ == other.keep_;
+
+ if (len_ != other.len_)
return false;
-
- return this->kp == other.kp;
+
+ return keep_ == other.keep_;
}
string const VSpace::asLyXCommand() const
{
- string result;
-
- switch (kin) {
+ string result;
+ switch (kind_) {
case NONE: break;
case DEFSKIP: result = "defskip"; break;
case SMALLSKIP: result = "smallskip"; break;
case MEDSKIP: result = "medskip"; break;
case BIGSKIP: result = "bigskip"; break;
case VFILL: result = "vfill"; break;
- case LENGTH: result = len.asString(); break;
+ case LENGTH: result = len_.asString(); break;
}
- if (kp && (kin != NONE) && (kin != DEFSKIP))
- return result += '*';
- else
- return result;
+ if (keep_ && kind_ != NONE && kind_ != DEFSKIP)
+ result += '*';
+ return result;
}
string const VSpace::asLatexCommand(BufferParams const & params) const
{
- switch (kin) {
- case NONE: return string();
- case DEFSKIP:
- return params.getDefSkip().asLatexCommand(params);
- case SMALLSKIP: return kp ? "\\vspace*{\\smallskipamount}"
- : "\\smallskip{}";
- case MEDSKIP: return kp ? "\\vspace*{\\medskipamount}"
- : "\\medskip{}";
- case BIGSKIP: return kp ? "\\vspace*{\\bigskipamount}"
- : "\\bigskip{}";
- case VFILL: return kp ? "\\vspace*{\\fill}"
- : "\\vfill{}";
- case LENGTH: return kp ? "\\vspace*{" + len.asLatexString() + '}'
- : "\\vspace{" + len.asLatexString() + '}';
- }
- return string(); // should never be reached
-}
+ string ret;
+
+ switch (kind_) {
+ case NONE:
+ break;
+ case DEFSKIP:
+ ret = params.getDefSkip().asLatexCommand(params);
+ break;
+ case SMALLSKIP:
+ ret = keep_ ? "\\vspace*{\\smallskipamount}"
+ : "\\smallskip{}";
+ break;
+ case MEDSKIP:
+ ret = keep_ ? "\\vspace*{\\medskipamount}"
+ : "\\medskip{}";
+ break;
+ case BIGSKIP:
+ ret = keep_ ? "\\vspace*{\\bigskipamount}"
+ : "\\bigskip{}";
+ break;
+ case VFILL:
+ ret = keep_ ? "\\vspace*{\\fill}"
+ : "\\vfill{}";
+ break;
+ case LENGTH:
+ {
+ string const lenstr = len_.asLatexString();
+ ret = keep_ ? "\\vspace*{" + lenstr + '}'
+ : "\\vspace{" + lenstr + '}';
+ }
+ break;
-int VSpace::inPixels(BufferView * bv) const
-{
- // Height of a normal line in pixels (zoom factor considered)
- int height = bv->text->DefaultHeight(); // [pixels]
- int skip = 0;
- if (kin == DEFSKIP)
- skip = bv->buffer()->params.getDefSkip().inPixels(bv);
+ }
- return inPixels(height, skip);
+ return ret;
}
-int VSpace::inPixels(int default_height, int default_skip) const
-{
- // Height of a normal line in pixels (zoom factor considered)
- int height = default_height; // [pixels]
-
- // Zoom factor specified by user in percent
- float const zoom = lyxrc.zoom / 100.0; // [percent]
- // DPI setting for monitor: pixels/inch
- float const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
- // We want the result in pixels
- float result, value;
+int VSpace::inPixels(BufferView * bv) const
+{
+ // Height of a normal line in pixels (zoom factor considered)
+ int const default_height = bv->text->defaultHeight(); // [pixels]
- switch (kin) {
- case NONE: return 0;
+ int retval = 0;
+ switch (kind_) {
+ case NONE:
+ // Value for this is already set
+ break;
case DEFSKIP:
- return default_skip;
+ retval = bv->buffer()->params.getDefSkip().inPixels(bv);
+ break;
// This is how the skips are normally defined by
// LateX. But there should be some way to change
// this per document.
- case SMALLSKIP: return height / 4;
- case MEDSKIP: return height / 2;
- case BIGSKIP: return height;
- case VFILL: return 3 * height;
+ case SMALLSKIP:
+ retval = default_height / 4;
+ break;
+
+ case MEDSKIP:
+ retval = default_height / 2;
+ break;
+
+ case BIGSKIP:
+ retval = default_height;
+ break;
+
+ case VFILL:
// leave space for the vfill symbol
- case LENGTH:
- // Pixel values are scaled so that the ratio
- // between lengths and font sizes on the screen
- // is the same as on paper.
-
- // we don't care about sign of value, we
- // can't display negative anyway
- result = 0.0;
- value = len.value();
- short val_sign = value < 0.0 ? -1 : 1;
-
- switch (len.unit()) {
- case LyXLength::SP:
- // Scaled point: sp = 1/65536 pt
- result = zoom * dpi * value
- / (72.27 * 65536); // 4736286.7
- break;
- case LyXLength::PT:
- // Point: 1 pt = 1/72.27 inch
- result = zoom * dpi * value
- / 72.27; // 72.27
- break;
- case LyXLength::BP:
- // Big point: 1 bp = 1/72 inch
- result = zoom * dpi * value
- / 72; // 72
- break;
- case LyXLength::DD:
- // Didot: 1157dd = 1238 pt?
- result = zoom * dpi * value
- / (72.27 / (0.376 * 2.845)); // 67.559735
- break;
- case LyXLength::MM:
- // Millimeter: 1 mm = 1/25.4 inch
- result = zoom * dpi * value
- / 25.4; // 25.4
- break;
- case LyXLength::PC:
- // Pica: 1 pc = 12 pt
- result = zoom * dpi * value
- / (72.27 / 12); // 6.0225
- break;
- case LyXLength::CC:
- // Cicero: 1 cc = 12 dd
- result = zoom * dpi * value
- / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
- break;
- case LyXLength::CM:
- // Centimeter: 1 cm = 1/2.54 inch
- result = zoom * dpi * value
- / 2.54; // 2.54
- break;
- case LyXLength::IN:
- // Inch
- result = zoom * dpi * value;
- break;
- case LyXLength::EX:
- // Ex: The height of an "x"
- result = zoom * value * height / 2; // what to / width?
- break;
- case LyXLength::EM: // what to / width?
- // Em: The width of an "m"
- result = zoom * value * height / 2; // Why 2?
- break;
- case LyXLength::MU: // This is probably only allowed in
- // math mode
- result = zoom * value * height;
- break;
- case LyXLength::UNIT_NONE:
- result = 0; // this cannot happen
- break;
- }
- return int (result * val_sign + 0.5);
+ retval = 3 * default_height;
+ break;
+
+ case LENGTH: {
+ int const default_width = bv->workWidth();
+ retval = len_.len().inPixels(default_width, default_height);
+ break;
+ }
+
}
- return 0; // never reached
+ return retval;
}
projects / lyx.git / blobdiff