X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fvspace.C;h=5966cb66af53b48fbedd7295f72ef55ea65b6812;hb=29f01faa17495e3d80c08f234c8f049c7d699ac1;hp=69fb9006b72fd8be7889ad42ce334841db13c3ef;hpb=2028cf65896b32368142b14da279ec774c97a711;p=lyx.git diff --git a/src/vspace.C b/src/vspace.C index 69fb9006b7..5966cb66af 100644 --- a/src/vspace.C +++ b/src/vspace.C @@ -1,73 +1,76 @@ -/* This file is part of - * ====================================================== +/** + * \file vspace.C + * Copyright 1995-2002 the LyX Team + * Read the file COPYING * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. - * - * ====================================================== */ + * \author Matthias Ettrich + */ #include #ifdef __GNUG__ -#pragma implementation "vspace.h" +#pragma implementation #endif -#include - -#include "lyx_main.h" -#include "buffer.h" #include "vspace.h" +#include "lengthcommon.h" +#include "buffer.h" #include "lyxrc.h" -#include "lyxtext.h" #include "BufferView.h" -#include "support/lstrings.h" - +#include "support/LAssert.h" -namespace { +#include "support/lstrings.h" -/* length units - */ +#include -int const num_units = LyXLength::UNIT_NONE; +#ifndef CXX_GLOBAL_CSTD +using std::sscanf; +#endif -// I am not sure if "mu" should be possible to select (Lgb) -char const * unit_name[num_units] = { "sp", "pt", "bp", "dd", - "mm", "pc", "cc", "cm", - "in", "ex", "em", "mu", - "%", "c%", "p%", "l%" }; +namespace { +/// 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 following static items form a simple scanner for - * length strings, used by isValid[Glue]Length. See comments there. - */ -double number[4] = { 0, 0, 0, 0 }; -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; - +/// skip n characters of input inline void lyx_advance(string & data, string::size_type n) { data.erase(0, n); } - +/// return true when the input is at the end inline bool isEndOfData(string const & data) { - return frontStrip(data).empty(); + return ltrim(data).empty(); } - +/** + * 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] == '+') { @@ -89,7 +92,7 @@ char nextToken(string & data) if (number_index > 3) return 'E'; string buffer; - + // we have found some number if (i == string::npos) { buffer = data; @@ -105,13 +108,13 @@ char nextToken(string & data) return 'n'; } else return 'E'; } - + 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; @@ -138,6 +141,7 @@ char nextToken(string & data) } +/// latex representation of a vspace struct LaTeXLength { char const * pattern; int plus_val_index; @@ -147,6 +151,7 @@ struct LaTeXLength { }; +/// the possible formats for a vspace string LaTeXLength table[] = { { "nu", 0, 0, 0, 0 }, { "nu+nu", 2, 0, 2, 0 }, @@ -164,6 +169,7 @@ LaTeXLength table[] = { { "", 0, 0, 0, 0 } // sentinel, must be empty }; + } // namespace anon const char * stringFromUnit(int unit) @@ -194,7 +200,7 @@ bool isValidGlueLength(string const & data, LyXGlueLength * result) 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: @@ -212,7 +218,7 @@ bool isValidGlueLength(string const & data, LyXGlueLength * result) break; } // end of hack - + int pattern_index = 0; int table_index = 0; char pattern[20]; @@ -236,17 +242,17 @@ bool isValidGlueLength(string const & data, LyXGlueLength * result) 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->unit_ = unit[1]; - result->plus_val_ = number[table[table_index].plus_val_index]; - result->minus_val_ = number[table[table_index].minus_val_index]; - result->plus_unit_ = unit [table[table_index].plus_uni_index]; - result->minus_unit_ = 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; } @@ -254,10 +260,10 @@ bool isValidGlueLength(string const & data, LyXGlueLength * result) 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; @@ -281,7 +287,7 @@ bool isValidLength(string const & data, LyXLength * result) break; } // end of hack - + number_index = unit_index = 1; // entries at index 0 are sentinels // construct "pattern" from "data" @@ -296,8 +302,8 @@ bool isValidLength(string const & data, LyXLength * result) pattern[pattern_index] = '\0'; // only the most basic pattern is accepted here - if (compare(pattern, "nu") != 0) return false; - + if (compare(pattern, "nu") != 0) return false; + // It _was_ a correct length string. // Store away the values we found. if (result) { @@ -308,280 +314,41 @@ bool isValidLength(string const & data, LyXLength * result) } - - -// -// LyXLength -// - -LyXLength::LyXLength() - : val_(0), unit_(LyXLength::PT) -{} - - -LyXLength::LyXLength(double v, LyXLength::UNIT u) - : val_(v), unit_(u) -{} - - -LyXLength::LyXLength(string const & data) -{ - LyXLength tmp; - - if (!isValidLength (data, &tmp)) - return; // should raise an exception - - val_ = tmp.val_; - unit_ = tmp.unit_; -} - - -string const LyXLength::asString() const -{ - ostringstream buffer; - buffer << val_ << unit_name[unit_]; // setw? - return buffer.str().c_str(); -} - - -string const LyXLength::asLatexString() const -{ - ostringstream buffer; - switch(unit_) { - case PW: - case PE: - buffer << abs(static_cast(val_/100)) << "." - << abs(static_cast(val_)%100) << "\\columnwidth"; - break; - case PP: - buffer << abs(static_cast(val_/100)) << "." - << abs(static_cast(val_)%100) << "\\pagewidth"; - break; - case PL: - buffer << abs(static_cast(val_/100)) << "." - << abs(static_cast(val_)%100) << "\\linewidth"; - break; - default: - buffer << val_ << unit_name[unit_]; // setw? - break; - } - return buffer.str().c_str(); -} - - -double LyXLength::value() const -{ - return val_; -} - - -LyXLength::UNIT LyXLength::unit() const -{ - return unit_; -} - - -bool operator==(LyXLength const & l1, LyXLength const & l2) -{ - return l1.value() == l2.value() && l1.unit() == l2.unit(); -} - - -LyXLength::UNIT unitFromString (string const & data) -{ - int i = 0; - while (i < num_units && data != unit_name[i]) - ++i; - return static_cast(i); -} - - - -// -// LyXGlueLength -// - - -LyXGlueLength::LyXGlueLength( - double v, LyXLength::UNIT u, - double pv, LyXLength::UNIT pu, - double mv, LyXLength::UNIT mu) - : LyXLength(v, u), - plus_val_(pv), minus_val_(mv), - plus_unit_(pu), minus_unit_(mu) -{} - - -LyXGlueLength::LyXGlueLength(string const & data) -{ - LyXGlueLength tmp(0.0, PT); - - // we should really raise exception here - if (!isValidGlueLength(data, &tmp)) - ; - - val_ = tmp.val_; - unit_ = tmp.unit_; - plus_val_ = tmp.plus_val_; - plus_unit_ = tmp.plus_unit_; - minus_val_ = tmp.minus_val_; - minus_unit_ = tmp.minus_unit_; -} - - -string const LyXGlueLength::asString() const -{ - ostringstream buffer; - - if (plus_val_ != 0.0) - if (minus_val_ != 0.0) - if (unit_ == plus_unit_ && unit_ == minus_unit_) - if (plus_val_ == minus_val_) - buffer << val_ << "+-" - << plus_val_ << unit_name[unit_]; - else - buffer << val_ - << '+' << plus_val_ - << '-' << minus_val_ - << unit_name[unit_]; - else - if (plus_unit_ == minus_unit_ - && plus_val_ == minus_val_) - buffer << val_ << unit_name[unit_] - << "+-" << plus_val_ - << unit_name[plus_unit_]; - - else - buffer << val_ << unit_name[unit_] - << '+' << plus_val_ - << unit_name[plus_unit_] - << '-' << minus_val_ - << unit_name[minus_unit_]; - else - if (unit_ == plus_unit_) - buffer << val_ << '+' << plus_val_ - << unit_name[unit_]; - else - buffer << val_ << unit_name[unit_] - << '+' << plus_val_ - << unit_name[plus_unit_]; - - else - if (minus_val_ != 0.0) - if (unit_ == minus_unit_) - buffer << val_ << '-' << minus_val_ - << unit_name[unit_]; - - else - buffer << val_ << unit_name[unit_] - << '-' << minus_val_ - << unit_name[minus_unit_]; - else - buffer << val_ << unit_name[unit_]; - - return buffer.str().c_str(); -} - - -string const LyXGlueLength::asLatexString() const -{ - ostringstream buffer; - - if (plus_val_ != 0.0) - if (minus_val_ != 0.0) - buffer << val_ << unit_name[unit_] - << " plus " - << plus_val_ << unit_name[plus_unit_] - << " minus " - << minus_val_ << unit_name[minus_unit_]; - else - buffer << val_ << unit_name[unit_] - << " plus " - << plus_val_ << unit_name[plus_unit_]; - else - if (minus_val_ != 0.0) - buffer << val_ << unit_name[unit_] - << " minus " - << minus_val_ << unit_name[minus_unit_]; - else - buffer << val_ << unit_name[unit_]; - - return buffer.str().c_str(); -} - - -double LyXGlueLength::plusValue() const -{ - return plus_val_; -} - - -LyXLength::UNIT LyXGlueLength::plusUnit() const -{ - return plus_unit_; -} - - -double LyXGlueLength::minusValue() const -{ - return minus_val_; -} - - -LyXLength::UNIT LyXGlueLength::minusUnit() const -{ - return minus_unit_; -} - - -bool operator==(LyXGlueLength const & l1, LyXGlueLength const & l2) -{ - return l1.value() == l2.value() - && l1.unit() == l2.unit() - && l1.plusValue() == l2.plusValue() - && l1.plusUnit() == l2.plusUnit() - && l1.minusValue() == l2.minusValue() - && l1.minusUnit() == l2.minusUnit(); -} - - - - // // VSpace class // VSpace::VSpace() - : kind_(NONE), len_(0.0, LyXLength::PT), keep_(false) + : kind_(NONE), len_(), keep_(false) {} VSpace::VSpace(vspace_kind k) - : kind_(k), len_(0.0, LyXLength::PT), keep_(false) + : kind_(k), len_(), keep_(false) {} -VSpace::VSpace(LyXGlueLength l) +VSpace::VSpace(LyXLength const & l) : kind_(LENGTH), len_(l), keep_(false) {} -VSpace::VSpace(double v, LyXLength::UNIT u) - : kind_(LENGTH), len_(v, u), keep_(false) +VSpace::VSpace(LyXGlueLength const & l) + : kind_(LENGTH), len_(l), keep_(false) {} VSpace::VSpace(string const & data) - : kind_(NONE), len_(0.0, LyXLength::PT), keep_(false) + : kind_(NONE), len_(), keep_(false) { if (data.empty()) return; double value; - string input = strip(data); + string input = rtrim(data); string::size_type const length = input.length(); - if (length > 1 && input[length-1] == '*') { + if (length > 1 && input[length - 1] == '*') { keep_ = true; input.erase(length - 1); } @@ -597,7 +364,7 @@ VSpace::VSpace(string const & data) // without units in added_space_top/bottom. // Let unit default to centimeters here. kind_ = LENGTH; - len_ = LyXGlueLength(value, LyXLength::CM); + len_ = LyXGlueLength(LyXLength(value, LyXLength::CM)); } } @@ -661,149 +428,86 @@ string const VSpace::asLyXCommand() const string const VSpace::asLatexCommand(BufferParams const & params) const { + string ret; + switch (kind_) { - case NONE: return string(); + case NONE: + break; case DEFSKIP: - return params.getDefSkip().asLatexCommand(params); - case SMALLSKIP: return keep_ ? "\\vspace*{\\smallskipamount}" - : "\\smallskip{}"; - case MEDSKIP: return keep_ ? "\\vspace*{\\medskipamount}" - : "\\medskip{}"; - case BIGSKIP: return keep_ ? "\\vspace*{\\bigskipamount}" - : "\\bigskip{}"; - case VFILL: return keep_ ? "\\vspace*{\\fill}" - : "\\vfill{}"; - case LENGTH: return keep_ ? "\\vspace*{" + len_.asLatexString() + '}' - : "\\vspace{" + len_.asLatexString() + '}'; - } - return string(); // should never be reached -} - + 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(); -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; - int width = bv->workWidth(); + ret = keep_ ? "\\vspace*{" + lenstr + '}' + : "\\vspace{" + lenstr + '}'; + } + break; - if (kind_ == DEFSKIP) - skip = bv->buffer()->params.getDefSkip().inPixels(bv); + } - return inPixels(height, skip, width); + return ret; } -int VSpace::inPixels(int default_height, int default_skip, int default_width) - const + +int VSpace::inPixels(BufferView const * bv) const { // Height of a normal line in pixels (zoom factor considered) - int height = default_height; // [pixels] - - // Zoom factor specified by user in percent - double const zoom = lyxrc.zoom / 100.0; // [percent] + int const default_height = bv->defaultHeight(); // [pixels] - // DPI setting for monitor: pixels/inch - double const dpi = lyxrc.dpi; // screen resolution [pixels/inch] - - // We want the result in pixels - double result; - double value; + int retval = 0; switch (kind_) { + case NONE: - return 0; + // value for this is already set + break; case DEFSKIP: - return default_skip; - - // 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; + 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: + 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 + retval = 3 * default_height; + break; + 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 - // display negative space with text too - result = 0.0; - value = len_.value(); - int 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::PW: // Always % of workarea - case LyXLength::PE: - case LyXLength::PP: - case LyXLength::PL: - result = value * default_width / 100; - break; - case LyXLength::UNIT_NONE: - result = 0; // this cannot happen - break; - } - return static_cast(result * val_sign + 0.5); + retval = len_.len().inPixels(bv->workWidth(), default_height); + break; + } - return 0; // never reached + return retval; }