layout/style/nsStyleCoord.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /* representation of length values in computed style data */
  39
  40 #ifndef nsStyleCoord_h___
  41 #define nsStyleCoord_h___
  42
  43 #include "nscore.h"
  44 #include "nsCoord.h"
  45 #include "nsCRT.h"
  46 #include "nsStyleConsts.h"
  47 class nsString;
  48
  49 enum nsStyleUnit {
  50   eStyleUnit_Null         = 0,      // (no value) value is not specified
  51   eStyleUnit_Normal       = 1,      // (no value)
  52   eStyleUnit_Auto         = 2,      // (no value)
  53   eStyleUnit_None         = 3,      // (no value)
  54   eStyleUnit_Percent      = 10,     // (float) 1.0 == 100%
  55   eStyleUnit_Factor       = 11,     // (float) a multiplier
  56   eStyleUnit_Coord        = 20,     // (nscoord) value is twips
  57   eStyleUnit_Integer      = 30,     // (int) value is simple integer
  58   eStyleUnit_Enumerated   = 32      // (int) value has enumerated meaning
  59 };
  60
  61 typedef union {
  62   PRInt32     mInt;   // nscoord is a PRInt32 for now
  63   float       mFloat;
  64 } nsStyleUnion;
  65
  66 /**
  67  * Class that hold a single size specification used by the style
  68  * system.  The size specification consists of two parts -- a number
  69  * and a unit.  The number is an integer, a floating point value, an
  70  * nscoord, or undefined, and the unit is an nsStyleUnit.  Checking
  71  * the unit is a must before asking for the value in any particular
  72  * form.
  73  */
  74 class nsStyleCoord {
  75 public:
  76   nsStyleCoord(nsStyleUnit aUnit = eStyleUnit_Null);
  77   nsStyleCoord(nscoord aValue);
  78   nsStyleCoord(PRInt32 aValue, nsStyleUnit aUnit);
  79   nsStyleCoord(float aValue, nsStyleUnit aUnit);
  80   inline nsStyleCoord(const nsStyleCoord& aCopy);
  81   inline nsStyleCoord(const nsStyleUnion& aValue, nsStyleUnit aUnit);
  82
  83   nsStyleCoord&  operator=(const nsStyleCoord& aCopy);
  84   PRBool         operator==(const nsStyleCoord& aOther) const;
  85   PRBool         operator!=(const nsStyleCoord& aOther) const;
  86
  87   nsStyleUnit GetUnit(void) const {
  88     NS_ASSERTION(mUnit != eStyleUnit_Null, "reading uninitialized value");
  89     return mUnit;
  90   }
  91   nscoord     GetCoordValue(void) const;
  92   PRInt32     GetIntValue(void) const;
  93   float       GetPercentValue(void) const;
  94   float       GetFactorValue(void) const;
  95   void        GetUnionValue(nsStyleUnion& aValue) const;
  96
  97   void  Reset(void);  // sets to null
  98   void  SetCoordValue(nscoord aValue);
  99   void  SetIntValue(PRInt32 aValue, nsStyleUnit aUnit);
 100   void  SetPercentValue(float aValue);
 101   void  SetFactorValue(float aValue);
 102   void  SetNormalValue(void);
 103   void  SetAutoValue(void);
 104   void  SetNoneValue(void);
 105
 106 #ifdef DEBUG
 107   void  AppendToString(nsString& aBuffer) const;
 108   void  ToString(nsString& aBuffer) const;
 109 #endif
 110
 111 public:
 112   nsStyleUnit   mUnit;
 113   nsStyleUnion  mValue;
 114 };
 115
 116
 117 /**
 118  * Class that represents a set of top/right/bottom/left nsStyleCoords.
 119  * This is commonly used to hold the widths of the borders, margins,
 120  * or paddings of a box.
 121  */
 122 class nsStyleSides {
 123 public:
 124   nsStyleSides(void);
 125
 126 //  nsStyleSides&  operator=(const nsStyleSides& aCopy);  // use compiler's version
 127   PRBool         operator==(const nsStyleSides& aOther) const;
 128   PRBool         operator!=(const nsStyleSides& aOther) const;
 129
 130   // aSide is always one of NS_SIDE_* defined in nsStyleConsts.h
 131
 132   inline nsStyleUnit GetUnit(PRUint8 aSide) const;
 133   inline nsStyleUnit GetLeftUnit(void) const;
 134   inline nsStyleUnit GetTopUnit(void) const;
 135   inline nsStyleUnit GetRightUnit(void) const;
 136   inline nsStyleUnit GetBottomUnit(void) const;
 137
 138   inline nsStyleCoord Get(PRUint8 aSide) const;
 139   inline nsStyleCoord GetLeft() const;
 140   inline nsStyleCoord GetTop() const;
 141   inline nsStyleCoord GetRight() const;
 142   inline nsStyleCoord GetBottom() const;
 143
 144   void  Reset(void);
 145
 146   inline void Set(PRUint8 aSide, const nsStyleCoord& aCoord);
 147   inline void SetLeft(const nsStyleCoord& aCoord);
 148   inline void SetTop(const nsStyleCoord& aCoord);
 149   inline void SetRight(const nsStyleCoord& aCoord);
 150   inline void SetBottom(const nsStyleCoord& aCoord);
 151
 152 #ifdef DEBUG
 153   void  AppendToString(nsString& aBuffer) const;
 154   void  ToString(nsString& aBuffer) const;
 155 #endif
 156
 157 protected:
 158   PRUint8       mUnits[4];
 159   nsStyleUnion  mValues[4];
 160 };
 161
 162 /**
 163  * Class that represents a set of top-left/top-right/bottom-left/bottom-right
 164  * nsStyleCoord pairs.  This is used to hold the dimensions of the
 165  * corners of a box (for, e.g., border-radius and outline-radius).
 166  */
 167 class nsStyleCorners {
 168 public:
 169   nsStyleCorners(void);
 170
 171   // use compiler's version
 172   //nsStyleCorners&  operator=(const nsStyleCorners& aCopy);
 173   PRBool         operator==(const nsStyleCorners& aOther) const;
 174   PRBool         operator!=(const nsStyleCorners& aOther) const;
 175
 176   // aCorner is always one of NS_CORNER_* defined in nsStyleConsts.h
 177   inline nsStyleUnit GetUnit(PRUint8 aHalfCorner) const;
 178
 179   inline nsStyleCoord Get(PRUint8 aHalfCorner) const;
 180
 181   void  Reset(void);
 182
 183   inline void Set(PRUint8 aHalfCorner, const nsStyleCoord& aCoord);
 184
 185 #ifdef DEBUG
 186   void  AppendToString(nsString& aBuffer) const;
 187   void  ToString(nsString& aBuffer) const;
 188 #endif
 189
 190 protected:
 191   PRUint8       mUnits[8];
 192   nsStyleUnion  mValues[8];
 193 };
 194
 195
 196 // -------------------------
 197 // nsStyleCoord inlines
 198 //
 199 inline nsStyleCoord::nsStyleCoord(const nsStyleCoord& aCopy)
 200   : mUnit(aCopy.mUnit)
 201 {
 202   if ((eStyleUnit_Percent <= mUnit) && (mUnit < eStyleUnit_Coord)) {
 203     mValue.mFloat = aCopy.mValue.mFloat;
 204   }
 205   else {
 206     mValue.mInt = aCopy.mValue.mInt;
 207   }
 208 }
 209
 210 inline nsStyleCoord::nsStyleCoord(const nsStyleUnion& aValue, nsStyleUnit aUnit)
 211   : mUnit(aUnit)
 212 {
 213 #if PR_BYTES_PER_INT == PR_BYTES_PER_FLOAT
 214   mValue.mInt = aValue.mInt;
 215 #else
 216   memcpy(&mValue, &aValue, sizeof(nsStyleUnion));
 217 #endif
 218 }
 219
 220 inline PRBool nsStyleCoord::operator!=(const nsStyleCoord& aOther) const
 221 {
 222   return !((*this) == aOther);
 223 }
 224
 225 inline PRInt32 nsStyleCoord::GetCoordValue(void) const
 226 {
 227   NS_ASSERTION((mUnit == eStyleUnit_Coord), "not a coord value");
 228   if (mUnit == eStyleUnit_Coord) {
 229     return mValue.mInt;
 230   }
 231   return 0;
 232 }
 233
 234 inline PRInt32 nsStyleCoord::GetIntValue(void) const
 235 {
 236   NS_ASSERTION((mUnit == eStyleUnit_Enumerated) ||
 237                (mUnit == eStyleUnit_Integer), "not an int value");
 238   if ((mUnit == eStyleUnit_Enumerated) ||
 239       (mUnit == eStyleUnit_Integer)) {
 240     return mValue.mInt;
 241   }
 242   return 0;
 243 }
 244
 245 inline float nsStyleCoord::GetPercentValue(void) const
 246 {
 247   NS_ASSERTION(mUnit == eStyleUnit_Percent, "not a percent value");
 248   if (mUnit == eStyleUnit_Percent) {
 249     return mValue.mFloat;
 250   }
 251   return 0.0f;
 252 }
 253
 254 inline float nsStyleCoord::GetFactorValue(void) const
 255 {
 256   NS_ASSERTION(mUnit == eStyleUnit_Factor, "not a factor value");
 257   if (mUnit == eStyleUnit_Factor) {
 258     return mValue.mFloat;
 259   }
 260   return 0.0f;
 261 }
 262
 263 inline void nsStyleCoord::GetUnionValue(nsStyleUnion& aValue) const
 264 {
 265   memcpy(&aValue, &mValue, sizeof(nsStyleUnion));
 266 }
 267
 268 // -------------------------
 269 // nsStyleSides inlines
 270 //
 271 inline PRBool nsStyleSides::operator!=(const nsStyleSides& aOther) const
 272 {
 273   return !((*this) == aOther);
 274 }
 275
 276 inline nsStyleUnit nsStyleSides::GetUnit(PRUint8 aSide) const
 277 {
 278   return (nsStyleUnit)mUnits[aSide];
 279 }
 280
 281 inline nsStyleUnit nsStyleSides::GetLeftUnit(void) const
 282 {
 283   return GetUnit(NS_SIDE_LEFT);
 284 }
 285
 286 inline nsStyleUnit nsStyleSides::GetTopUnit(void) const
 287 {
 288   return GetUnit(NS_SIDE_TOP);
 289 }
 290
 291 inline nsStyleUnit nsStyleSides::GetRightUnit(void) const
 292 {
 293   return GetUnit(NS_SIDE_RIGHT);
 294 }
 295
 296 inline nsStyleUnit nsStyleSides::GetBottomUnit(void) const
 297 {
 298   return GetUnit(NS_SIDE_BOTTOM);
 299 }
 300
 301 inline nsStyleCoord nsStyleSides::Get(PRUint8 aSide) const
 302 {
 303   return nsStyleCoord(mValues[aSide], nsStyleUnit(mUnits[aSide]));
 304 }
 305
 306 inline nsStyleCoord nsStyleSides::GetLeft() const
 307 {
 308   return Get(NS_SIDE_LEFT);
 309 }
 310
 311 inline nsStyleCoord nsStyleSides::GetTop() const
 312 {
 313   return Get(NS_SIDE_TOP);
 314 }
 315
 316 inline nsStyleCoord nsStyleSides::GetRight() const
 317 {
 318   return Get(NS_SIDE_RIGHT);
 319 }
 320
 321 inline nsStyleCoord nsStyleSides::GetBottom() const
 322 {
 323   return Get(NS_SIDE_BOTTOM);
 324 }
 325
 326 inline void nsStyleSides::Set(PRUint8 aSide, const nsStyleCoord& aCoord)
 327 {
 328   mUnits[aSide] = aCoord.GetUnit();
 329   aCoord.GetUnionValue(mValues[aSide]);
 330 }
 331
 332 inline void nsStyleSides::SetLeft(const nsStyleCoord& aCoord)
 333 {
 334   Set(NS_SIDE_LEFT, aCoord);
 335 }
 336
 337 inline void nsStyleSides::SetTop(const nsStyleCoord& aCoord)
 338 {
 339   Set(NS_SIDE_TOP, aCoord);
 340 }
 341
 342 inline void nsStyleSides::SetRight(const nsStyleCoord& aCoord)
 343 {
 344   Set(NS_SIDE_RIGHT, aCoord);
 345 }
 346
 347 inline void nsStyleSides::SetBottom(const nsStyleCoord& aCoord)
 348 {
 349   Set(NS_SIDE_BOTTOM, aCoord);
 350 }
 351
 352 // -------------------------
 353 // nsStyleCorners inlines
 354 //
 355 inline PRBool nsStyleCorners::operator!=(const nsStyleCorners& aOther) const
 356 {
 357   return !((*this) == aOther);
 358 }
 359
 360 inline nsStyleUnit nsStyleCorners::GetUnit(PRUint8 aCorner) const
 361 {
 362   return (nsStyleUnit)mUnits[aCorner];
 363 }
 364
 365 inline nsStyleCoord nsStyleCorners::Get(PRUint8 aCorner) const
 366 {
 367   return nsStyleCoord(mValues[aCorner], nsStyleUnit(mUnits[aCorner]));
 368 }
 369
 370 inline void nsStyleCorners::Set(PRUint8 aCorner, const nsStyleCoord& aCoord)
 371 {
 372   mUnits[aCorner] = aCoord.GetUnit();
 373   aCoord.GetUnionValue(mValues[aCorner]);
 374 }
 375
 376 #endif /* nsStyleCoord_h___ */