lyx_mirror/src/vspace.h

// -*- C++ -*-
/* This file is part of
 * ====================================================== 
 * 
 *           LyX, The Document Processor
 * 	 
 *           Copyright 1995 Matthias Ettrich
 *           Copyright 1995-2001 The LyX Team.
 *
 * ====================================================== */

#ifndef VSPACE_H
#define VSPACE_H

#ifdef __GNUG__
#pragma interface
#endif

#include "LString.h"

class BufferParams;
class BufferView;

///  LyXLength Class
class LyXLength {
public:
	/// length units
	enum UNIT {
		/// Scaled point (65536sp = 1pt) TeX's smallest unit.
		SP,
		/// Point = 1/72.27in = 0.351mm
		PT,
		/// Big point (72bp = 1in), also PostScript point
		BP,
		/// Didot point = 1/72 of a French inch, = 0.376mm
		DD,
		/// Millimeter = 2.845pt
		MM,
		/// Pica = 12pt = 4.218mm
		PC,
		/// Cicero = 12dd = 4.531mm
		CC,
		/// Centimeter = 10mm = 2.371pc
		CM,
		/// Inch = 25.4mm = 72.27pt = 6.022pc
		IN,
		/// Height of a small "x" for the current font.
		EX,
		/// Width of capital "M" in current font.
		EM,
		/// Math unit (18mu = 1em) for positioning in math mode
		MU,
		/// Percent of columnwidth both "%" or "%c"
		PW,
		PE,
		/// Percent of pagewidth
		PP,
		/// Percent of linewidth
		PL,
		/// no unit
		UNIT_NONE
	};

	///
	LyXLength() : val(0), uni(LyXLength::PT) {}
	///
	LyXLength(float v, LyXLength::UNIT u) : val(v), uni(u) {}

	/** "data" must be a decimal number, followed by a unit. */
	explicit
        LyXLength(string const & data);
	
	///
	float value() const         { return val; }
	///
	LyXLength::UNIT unit() const { return uni; }

	/// conversion
	virtual string const asString() const;
	///
	virtual string const asLatexString() const;

	/** If "data" is valid, the length represented by it is
	  stored into "result", if that is not 0. */
	friend bool isValidLength(string const & data, 
				  LyXLength * result = 0);

protected:
	///
	float           val;
	///
	LyXLength::UNIT uni;
};

///
inline
bool operator==(LyXLength const & l1, LyXLength const & l2)
{
	return l1.value() == l2.value()
		&& l1.unit() == l2.unit();
}
	
///
extern LyXLength::UNIT unitFromString (string const & data);
///
extern bool isValidLength(string const & data, LyXLength * result);
///
extern const char * stringFromUnit(int unit);

/// LyXGlueLength class
class LyXGlueLength : public LyXLength {
public:
	///
	LyXGlueLength(float v,
		      LyXLength::UNIT u, 
		      float pv = 0.0,
		      LyXLength::UNIT pu = LyXLength::UNIT_NONE, 
		      float mv = 0.0,
		      LyXLength::UNIT mu = LyXLength::UNIT_NONE) 
		: LyXLength (v, u), 
		  plus_val(pv), minus_val(mv), 
		  plus_uni(pu), minus_uni(mu) {}

	/** "data" must be a decimal number, followed by a unit, and 
	  optional "glue" indicated by "+" and "-".  You may abbreviate
	  reasonably.  Examples:
	  1.2 cm  //  4mm +2pt  //  2cm -4mm +2mm  //  4+0.1-0.2cm
	  The traditional Latex format is also accepted, like  
	  4cm plus 10pt minus 10pt */
	explicit
        LyXGlueLength(string const & data);
	
	///
	float plusValue() const         { return plus_val; }
	///
	LyXLength::UNIT plusUnit() const { return plus_uni; }
	///
	float minusValue() const         { return minus_val; }
	///
	LyXLength::UNIT minusUnit() const { return minus_uni; }

	/// conversion
	virtual string const asString() const;
	///
	virtual string const asLatexString() const;


	/** If "data" is valid, the length represented by it is
	  stored into "result", if that is not 0. */
	friend bool isValidGlueLength(string const & data, 
				      LyXGlueLength* result = 0);

protected:
	///
	float plus_val;
	///
	float minus_val;
	///
	LyXLength::UNIT plus_uni;
	///
	LyXLength::UNIT minus_uni;
};

///
inline
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();
}


///
extern bool isValidGlueLength(string const & data, LyXGlueLength * result);

///  VSpace class
class VSpace {
public:
	/// The different kinds of spaces.
	enum vspace_kind {
		///
		NONE,
		///
		DEFSKIP,
		///
		SMALLSKIP,
		///
		MEDSKIP,
		///
		BIGSKIP,
		///
		VFILL,
		///
		LENGTH
	};
	/// Constructor
	VSpace() : 
		kin (NONE), 
		len(0.0, LyXLength::PT),
                kp (false) {}
	/// Constructor
	explicit
	VSpace(vspace_kind k) :
		kin (k), 
		len (0.0, LyXLength::PT),
	        kp (false) {}
	/// Constructor
	explicit
	VSpace(LyXGlueLength l) :
		kin (LENGTH),
		len (l),
	        kp (false) {}

	/// Constructor
	explicit
	VSpace(float v, LyXLength::UNIT u) : 
		kin (LENGTH), 
		len (v, u),
	        kp (false) {}

	/// Constructor for reading from a .lyx file
	explicit
	VSpace(string const & data);
	
	/// access functions
	vspace_kind kind() const { return  kin; }
	///
	LyXGlueLength   length() const { return len; }

	// a flag that switches between \vspace and \vspace*
        bool keep() const      { return kp; }
	///
	void setKeep(bool val) { kp = val; } 
	///
        bool operator==(VSpace const &) const;

	// conversion
	///
	string const asLyXCommand() const;  // how it goes into the LyX file
	///
	string const asLatexCommand(BufferParams const & params) const;
	///
	int inPixels(BufferView * bv) const;
	///
	int inPixels(int default_height, int default_skip, int default_width=0) const;
private:
	/// This VSpace kind
	vspace_kind kin;
	///
	LyXGlueLength len;
	///
	bool kp;
};

#endif