gecko/layout/style/nsStyleCoord.h

377 lines
10 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* representation of length values in computed style data */
#ifndef nsStyleCoord_h___
#define nsStyleCoord_h___
#include "nscore.h"
#include "nsCoord.h"
#include "nsCRT.h"
#include "nsStyleConsts.h"
class nsString;
enum nsStyleUnit {
eStyleUnit_Null = 0, // (no value) value is not specified
eStyleUnit_Normal = 1, // (no value)
eStyleUnit_Auto = 2, // (no value)
eStyleUnit_None = 3, // (no value)
eStyleUnit_Percent = 10, // (float) 1.0 == 100%
eStyleUnit_Factor = 11, // (float) a multiplier
eStyleUnit_Coord = 20, // (nscoord) value is twips
eStyleUnit_Integer = 30, // (int) value is simple integer
eStyleUnit_Enumerated = 32 // (int) value has enumerated meaning
};
typedef union {
PRInt32 mInt; // nscoord is a PRInt32 for now
float mFloat;
} nsStyleUnion;
/**
* Class that hold a single size specification used by the style
* system. The size specification consists of two parts -- a number
* and a unit. The number is an integer, a floating point value, an
* nscoord, or undefined, and the unit is an nsStyleUnit. Checking
* the unit is a must before asking for the value in any particular
* form.
*/
class nsStyleCoord {
public:
nsStyleCoord(nsStyleUnit aUnit = eStyleUnit_Null);
nsStyleCoord(nscoord aValue);
nsStyleCoord(PRInt32 aValue, nsStyleUnit aUnit);
nsStyleCoord(float aValue, nsStyleUnit aUnit);
inline nsStyleCoord(const nsStyleCoord& aCopy);
inline nsStyleCoord(const nsStyleUnion& aValue, nsStyleUnit aUnit);
nsStyleCoord& operator=(const nsStyleCoord& aCopy);
PRBool operator==(const nsStyleCoord& aOther) const;
PRBool operator!=(const nsStyleCoord& aOther) const;
nsStyleUnit GetUnit(void) const {
NS_ASSERTION(mUnit != eStyleUnit_Null, "reading uninitialized value");
return mUnit;
}
nscoord GetCoordValue(void) const;
PRInt32 GetIntValue(void) const;
float GetPercentValue(void) const;
float GetFactorValue(void) const;
void GetUnionValue(nsStyleUnion& aValue) const;
void Reset(void); // sets to null
void SetCoordValue(nscoord aValue);
void SetIntValue(PRInt32 aValue, nsStyleUnit aUnit);
void SetPercentValue(float aValue);
void SetFactorValue(float aValue);
void SetNormalValue(void);
void SetAutoValue(void);
void SetNoneValue(void);
#ifdef DEBUG
void AppendToString(nsString& aBuffer) const;
void ToString(nsString& aBuffer) const;
#endif
public:
nsStyleUnit mUnit;
nsStyleUnion mValue;
};
/**
* Class that represents a set of top/right/bottom/left nsStyleCoords.
* This is commonly used to hold the widths of the borders, margins,
* or paddings of a box.
*/
class nsStyleSides {
public:
nsStyleSides(void);
// nsStyleSides& operator=(const nsStyleSides& aCopy); // use compiler's version
PRBool operator==(const nsStyleSides& aOther) const;
PRBool operator!=(const nsStyleSides& aOther) const;
// aSide is always one of NS_SIDE_* defined in nsStyleConsts.h
inline nsStyleUnit GetUnit(PRUint8 aSide) const;
inline nsStyleUnit GetLeftUnit(void) const;
inline nsStyleUnit GetTopUnit(void) const;
inline nsStyleUnit GetRightUnit(void) const;
inline nsStyleUnit GetBottomUnit(void) const;
inline nsStyleCoord Get(PRUint8 aSide) const;
inline nsStyleCoord GetLeft() const;
inline nsStyleCoord GetTop() const;
inline nsStyleCoord GetRight() const;
inline nsStyleCoord GetBottom() const;
void Reset(void);
inline void Set(PRUint8 aSide, const nsStyleCoord& aCoord);
inline void SetLeft(const nsStyleCoord& aCoord);
inline void SetTop(const nsStyleCoord& aCoord);
inline void SetRight(const nsStyleCoord& aCoord);
inline void SetBottom(const nsStyleCoord& aCoord);
#ifdef DEBUG
void AppendToString(nsString& aBuffer) const;
void ToString(nsString& aBuffer) const;
#endif
protected:
PRUint8 mUnits[4];
nsStyleUnion mValues[4];
};
/**
* Class that represents a set of top-left/top-right/bottom-left/bottom-right
* nsStyleCoord pairs. This is used to hold the dimensions of the
* corners of a box (for, e.g., border-radius and outline-radius).
*/
class nsStyleCorners {
public:
nsStyleCorners(void);
// use compiler's version
//nsStyleCorners& operator=(const nsStyleCorners& aCopy);
PRBool operator==(const nsStyleCorners& aOther) const;
PRBool operator!=(const nsStyleCorners& aOther) const;
// aCorner is always one of NS_CORNER_* defined in nsStyleConsts.h
inline nsStyleUnit GetUnit(PRUint8 aHalfCorner) const;
inline nsStyleCoord Get(PRUint8 aHalfCorner) const;
void Reset(void);
inline void Set(PRUint8 aHalfCorner, const nsStyleCoord& aCoord);
#ifdef DEBUG
void AppendToString(nsString& aBuffer) const;
void ToString(nsString& aBuffer) const;
#endif
protected:
PRUint8 mUnits[8];
nsStyleUnion mValues[8];
};
// -------------------------
// nsStyleCoord inlines
//
inline nsStyleCoord::nsStyleCoord(const nsStyleCoord& aCopy)
: mUnit(aCopy.mUnit)
{
if ((eStyleUnit_Percent <= mUnit) && (mUnit < eStyleUnit_Coord)) {
mValue.mFloat = aCopy.mValue.mFloat;
}
else {
mValue.mInt = aCopy.mValue.mInt;
}
}
inline nsStyleCoord::nsStyleCoord(const nsStyleUnion& aValue, nsStyleUnit aUnit)
: mUnit(aUnit)
{
#if PR_BYTES_PER_INT == PR_BYTES_PER_FLOAT
mValue.mInt = aValue.mInt;
#else
memcpy(&mValue, &aValue, sizeof(nsStyleUnion));
#endif
}
inline PRBool nsStyleCoord::operator!=(const nsStyleCoord& aOther) const
{
return !((*this) == aOther);
}
inline PRInt32 nsStyleCoord::GetCoordValue(void) const
{
NS_ASSERTION((mUnit == eStyleUnit_Coord), "not a coord value");
if (mUnit == eStyleUnit_Coord) {
return mValue.mInt;
}
return 0;
}
inline PRInt32 nsStyleCoord::GetIntValue(void) const
{
NS_ASSERTION((mUnit == eStyleUnit_Enumerated) ||
(mUnit == eStyleUnit_Integer), "not an int value");
if ((mUnit == eStyleUnit_Enumerated) ||
(mUnit == eStyleUnit_Integer)) {
return mValue.mInt;
}
return 0;
}
inline float nsStyleCoord::GetPercentValue(void) const
{
NS_ASSERTION(mUnit == eStyleUnit_Percent, "not a percent value");
if (mUnit == eStyleUnit_Percent) {
return mValue.mFloat;
}
return 0.0f;
}
inline float nsStyleCoord::GetFactorValue(void) const
{
NS_ASSERTION(mUnit == eStyleUnit_Factor, "not a factor value");
if (mUnit == eStyleUnit_Factor) {
return mValue.mFloat;
}
return 0.0f;
}
inline void nsStyleCoord::GetUnionValue(nsStyleUnion& aValue) const
{
memcpy(&aValue, &mValue, sizeof(nsStyleUnion));
}
// -------------------------
// nsStyleSides inlines
//
inline PRBool nsStyleSides::operator!=(const nsStyleSides& aOther) const
{
return !((*this) == aOther);
}
inline nsStyleUnit nsStyleSides::GetUnit(PRUint8 aSide) const
{
return (nsStyleUnit)mUnits[aSide];
}
inline nsStyleUnit nsStyleSides::GetLeftUnit(void) const
{
return GetUnit(NS_SIDE_LEFT);
}
inline nsStyleUnit nsStyleSides::GetTopUnit(void) const
{
return GetUnit(NS_SIDE_TOP);
}
inline nsStyleUnit nsStyleSides::GetRightUnit(void) const
{
return GetUnit(NS_SIDE_RIGHT);
}
inline nsStyleUnit nsStyleSides::GetBottomUnit(void) const
{
return GetUnit(NS_SIDE_BOTTOM);
}
inline nsStyleCoord nsStyleSides::Get(PRUint8 aSide) const
{
return nsStyleCoord(mValues[aSide], nsStyleUnit(mUnits[aSide]));
}
inline nsStyleCoord nsStyleSides::GetLeft() const
{
return Get(NS_SIDE_LEFT);
}
inline nsStyleCoord nsStyleSides::GetTop() const
{
return Get(NS_SIDE_TOP);
}
inline nsStyleCoord nsStyleSides::GetRight() const
{
return Get(NS_SIDE_RIGHT);
}
inline nsStyleCoord nsStyleSides::GetBottom() const
{
return Get(NS_SIDE_BOTTOM);
}
inline void nsStyleSides::Set(PRUint8 aSide, const nsStyleCoord& aCoord)
{
mUnits[aSide] = aCoord.GetUnit();
aCoord.GetUnionValue(mValues[aSide]);
}
inline void nsStyleSides::SetLeft(const nsStyleCoord& aCoord)
{
Set(NS_SIDE_LEFT, aCoord);
}
inline void nsStyleSides::SetTop(const nsStyleCoord& aCoord)
{
Set(NS_SIDE_TOP, aCoord);
}
inline void nsStyleSides::SetRight(const nsStyleCoord& aCoord)
{
Set(NS_SIDE_RIGHT, aCoord);
}
inline void nsStyleSides::SetBottom(const nsStyleCoord& aCoord)
{
Set(NS_SIDE_BOTTOM, aCoord);
}
// -------------------------
// nsStyleCorners inlines
//
inline PRBool nsStyleCorners::operator!=(const nsStyleCorners& aOther) const
{
return !((*this) == aOther);
}
inline nsStyleUnit nsStyleCorners::GetUnit(PRUint8 aCorner) const
{
return (nsStyleUnit)mUnits[aCorner];
}
inline nsStyleCoord nsStyleCorners::Get(PRUint8 aCorner) const
{
return nsStyleCoord(mValues[aCorner], nsStyleUnit(mUnits[aCorner]));
}
inline void nsStyleCorners::Set(PRUint8 aCorner, const nsStyleCoord& aCoord)
{
mUnits[aCorner] = aCoord.GetUnit();
aCoord.GetUnionValue(mValues[aCorner]);
}
#endif /* nsStyleCoord_h___ */