]> git.lyx.org Git - lyx.git/blobdiff - src/vspace.C
ws changes only
[lyx.git] / src / vspace.C
index ae5cc6438df2672052a6a2a531bb9367ac072fac..a3b8c5a41a3d314b0c3fb77513252642f2483bf1 100644 (file)
@@ -1,60 +1,78 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file vspace.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *     
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
+ * \author Matthias Ettrich
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "vspace.h"
-#include "lengthcommon.h"
-#include "lyx_main.h"
 #include "buffer.h"
-#include "lyxrc.h"
-#include "lyxtext.h"
+#include "bufferparams.h"
 #include "BufferView.h"
+#include "lengthcommon.h"
+#include "lyxtext.h"
 
 #include "support/lstrings.h"
 
-#include <cstdio>
+using lyx::support::compare;
+using lyx::support::isStrDbl;
+using lyx::support::ltrim;
+using lyx::support::prefixIs;
+using lyx::support::rtrim;
+using lyx::support::strToDbl;
+
+using std::string;
 
 
 namespace {
 
-double           number[4] = { 0, 0, 0, 0 };
-LyXLength::UNIT unit[4]   = { LyXLength::UNIT_NONE,
-                             LyXLength::UNIT_NONE,
-                             LyXLength::UNIT_NONE,
-                             LyXLength::UNIT_NONE };
+/// 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;
 
+/// 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] == '+') {
@@ -76,7 +94,7 @@ char nextToken(string & data)
                        if (number_index > 3) return 'E';
 
                        string buffer;
-               
+
                        // we have found some number
                        if (i == string::npos) {
                                buffer = data;
@@ -92,13 +110,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;
@@ -125,6 +143,7 @@ char nextToken(string & data)
 }
 
 
+/// latex representation of a vspace
 struct LaTeXLength {
        char const * pattern;
        int  plus_val_index;
@@ -134,6 +153,7 @@ struct LaTeXLength {
 };
 
 
+/// the possible formats for a vspace string
 LaTeXLength table[] = {
        { "nu",       0, 0, 0, 0 },
        { "nu+nu",    2, 0, 2, 0 },
@@ -182,7 +202,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:
@@ -200,7 +220,7 @@ bool isValidGlueLength(string const & data, LyXGlueLength * result)
                break;
        }
        // end of hack
-       
+
        int  pattern_index = 0;
        int  table_index = 0;
        char pattern[20];
@@ -224,7 +244,7 @@ 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.
@@ -242,10 +262,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;
 
@@ -269,7 +289,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"
@@ -284,8 +304,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) {
@@ -326,11 +346,11 @@ VSpace::VSpace(string const & data)
        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);
        }
@@ -341,7 +361,8 @@ VSpace::VSpace(string const & data)
        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) {
+       else if (isStrDbl(input)) {
+               value = strToDbl(input);
                // This last one is for reading old .lyx files
                // without units in added_space_top/bottom.
                // Let unit default to centimeters here.
@@ -357,7 +378,7 @@ VSpace::vspace_kind VSpace::kind() const
 }
 
 
-LyXGlueLength VSpace::length() const
+LyXGlueLength const & VSpace::length() const
 {
        return len_;
 }
@@ -410,65 +431,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() + '}';
+               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 + '}';
        }
-       return string();  // should never be reached
-}
+       break;
 
+       }
 
-int VSpace::inPixels(BufferView * bv) const
-{
-       // Height of a normal line in pixels (zoom factor considered)
-       int default_height = bv->text->defaultHeight(); // [pixels]
-       int default_skip   = 0;
-       int default_width  = bv->workWidth();
+       return ret;
+}
 
-       if (kind_ == DEFSKIP)
-               default_skip = bv->buffer()->params.getDefSkip().inPixels(bv);
 
-       // 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]
 
-       // DPI setting for monitor: pixels/inch
-       double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
+int VSpace::inPixels(BufferView const & bv) const
+{
+       // Height of a normal line in pixels (zoom factor considered)
+       int const default_height = defaultRowHeight(); // [pixels]
 
-       // 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:
-               return len_.len().inPixels(bv);
+               retval = len_.len().inPixels(bv.workWidth());
+               break;
+
        }
-       return 0; // never reached
+       return retval;
 }