get rid of LYX_LIBS

[lyx.git] / src / vspace.C

diff --git a/src/vspace.C b/src/vspace.C
index c93722d99e19f6b16a92b52e4ef62654ecded2b6..e4e01550f4a22f23ca25911eeabe099a0164cd6d 100644 (file)
--- a/src/vspace.C
+++ b/src/vspace.C
@@ -1,12 +1,10 @@
-/* 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 <config.h>
 
@@ -21,6 +19,7 @@
 #include "lyxrc.h"
 #include "lyxtext.h"
 #include "BufferView.h"
+#include "support/LAssert.h"
 
 #include "support/lstrings.h"
 
@@ -29,29 +28,45 @@
 
 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();
 }
 
-
+/**
+ * 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);
@@ -125,6 +140,7 @@ char nextToken(string & data)
 }
 
 
+/// latex representation of a vspace
 struct LaTeXLength {
        char const * pattern;
        int  plus_val_index;
@@ -134,6 +150,7 @@ struct LaTeXLength {
 };
 
 
+/// the possible formats for a vspace string
 LaTeXLength table[] = {
        { "nu",       0, 0, 0, 0 },
        { "nu+nu",    2, 0, 2, 0 },
@@ -242,10 +259,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;
 
@@ -410,25 +427,46 @@ 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;
+
+       }
+       
+       return ret;
 }
 
 
+
 int VSpace::inPixels(BufferView * bv) const
 {
        // Height of a normal line in pixels (zoom factor considered)
@@ -464,14 +502,12 @@ int VSpace::inPixels(BufferView * bv) const
                retval = 3 * default_height;
                break;
                
-       case LENGTH:
-       {
+       case LENGTH: {
                int const default_width  = bv->workWidth();
                retval = len_.len().inPixels(default_width, default_height);
                break;
        }
                
        }
-
        return retval;
 }