Added FontMetrics for regression testing.

Will be wired up later

gfx/src/nsRegressionTestFontMetrics.cpp

@@ -0,0 +1,340 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsRegressionTestFontMetrics.h"
+
+#define MAPPING_FACTOR_FOR_SPACE 0.02f
+#define MAPPING_FACTOR_FOR_LOWER_CASE  0.50f
+#define MAPPING_FACTOR_FOR_OTHERS  0.70f
+
+
+static NS_DEFINE_IID(kIFontMetricsIID, NS_IFONT_METRICS_IID);
+
+nsresult
+NS_NewRegressionTestFontMetrics(nsIFontMetrics** aMetrics)
+{
+  if (aMetrics == nsnull) {
+    return NS_ERROR_NULL_POINTER;
+  }
+
+  nsRegressionTestFontMetrics  *fm = new nsRegressionTestFontMetrics();
+
+  if (nsnull == fm) {
+    return NS_ERROR_OUT_OF_MEMORY;
+  }
+
+  return fm->QueryInterface(kIFontMetricsIID, (void **) aMetrics);
+}
+
+nsRegressionTestFontMetrics:: nsRegressionTestFontMetrics()
+{
+  NS_INIT_REFCNT(); 
+  mFont = nsnull; 
+  mDeviceContext = nsnull;
+  
+  mHeight = 0; 
+  mAscent = 0; 
+  mDescent = 0; 
+  mLeading = 0; 
+  mMaxAscent = 0; 
+  mMaxDescent = 0; 
+  mMaxAdvance = 0; 
+  mXHeight = 0; 
+  mSuperscriptOffset = 0; 
+  mSubscriptOffset = 0; 
+  mStrikeoutSize = 0; 
+  mStrikeoutOffset = 0; 
+  mUnderlineSize = 0; 
+  mUnderlineOffset = 0; 
+}
+  
+NS_IMPL_ISUPPORTS(nsRegressionTestFontMetrics, kIFontMetricsIID);
+
+nsRegressionTestFontMetrics::~nsRegressionTestFontMetrics()
+{
+  if (nsnull != mFont)
+  {
+    delete mFont;
+    mFont = nsnull;
+  }
+  mDeviceContext = nsnull;
+}
+
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::Init(const nsFont& aFont, nsIDeviceContext *aContext)
+{
+  mFont = new nsFont(aFont);
+  mDeviceContext = aContext;
+  RealizeFont();
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::Destroy()
+{
+  mDeviceContext = nsnull;
+  return NS_OK;
+}
+
+void
+nsRegressionTestFontMetrics::RealizeFont()
+{
+  float dev2app;
+  mDeviceContext->GetDevUnitsToAppUnits(dev2app);
+  nscoord onepixel = NSToCoordRound(1 * dev2app);
+  PRUint32 fontsize = mFont->size;
+ 
+  // Most of the numbers are just made up....
+  // feel free to play around.
+
+  mHeight = fontsize;
+  mXHeight = NSToCoordRound((float)mHeight * 0.50f);
+  mSuperscriptOffset = mXHeight;
+  mSubscriptOffset = mXHeight;
+  mStrikeoutSize = onepixel;
+  mStrikeoutOffset = NSToCoordRound(mXHeight / 3.5f);
+
+  
+  mAscent = NSToCoordRound((float)fontsize * 0.60f);
+  mDescent = NSToCoordRound((float)fontsize * 0.20f);
+
+  mLeading = NSToCoordRound((float)fontsize * 0.10f);
+  mMaxAscent = mAscent;
+  mMaxDescent = mDescent;
+  mMaxAdvance = NSToCoordRound((float)fontsize * 0.80f);
+  mUnderlineSize = onepixel;
+  mUnderlineOffset =  NSToCoordRound(fontsize / 100.0f);
+  
+}
+
+
+/**
+  * This routine determines a character width without relying on the
+  * underlying OS.
+  * 
+  * @update  harishd 02/07/1999
+  * @param   aChar  -- A valid character whose width needs to be computed
+  * @param   aWidth -- Holds the computed character width
+  */
+
+NS_METHOD
+nsRegressionTestFontMetrics::GetWidth(const char aChar, nscoord& aWidth)
+{
+  float size = (float)mFont->size;
+  aWidth = 0;
+
+  if(aChar == ' ')
+    size *= MAPPING_FACTOR_FOR_SPACE;
+  else if(aChar >= 'a' && aChar <= 'z')
+    size *= MAPPING_FACTOR_FOR_LOWER_CASE;
+  else
+    size *= MAPPING_FACTOR_FOR_OTHERS;
+    
+  aWidth = NSToCoordRound(size);
+
+  return NS_OK;
+}
+
+/**
+  * This routine determines a character width without relying on the
+  * underlying OS.
+  * 
+  * @update  harishd 02/07/1999
+  * @param   aChar  -- A valid character whose width needs to be computed
+  * @param   aWidth -- Holds the computed character width
+  */
+
+NS_METHOD
+nsRegressionTestFontMetrics::GetWidth(const PRUnichar aChar,nscoord& aWidth)
+{
+  float size = (float)mFont->size;
+  aWidth = 0;
+
+  if(aChar == ' ')
+    size *= MAPPING_FACTOR_FOR_SPACE;
+  else if(aChar >= 'a' && aChar <= 'z')
+    size *= MAPPING_FACTOR_FOR_LOWER_CASE;
+  else 
+    size *= MAPPING_FACTOR_FOR_OTHERS;
+      
+  aWidth = NSToCoordRound(size);
+
+  return NS_OK;
+}
+
+/**
+  * This routine determines width of a string without relying on the
+  * underlying OS.
+  * 
+  * @update  harishd 02/07/1999
+  * @param   aString -- A string whose width needs to be computed
+  * @param   aLength -- Length of the string
+  * @param   aWidth  -- Holds the computed string width
+  *
+  * @return  error code -- 0 if success, non-zero if error
+  */
+
+NS_METHOD
+nsRegressionTestFontMetrics::GetWidth(const PRUnichar* aString, PRUint32 aLength, nscoord& aWidth)
+{
+  aWidth = 0;
+  
+  if(aString == nsnull)
+    return NS_ERROR_NULL_POINTER;
+  
+  float size;
+  float totalsize = 0;
+  
+  for(PRUint32 index = 0; index < aLength; index++){
+    size = (float)mFont->size;
+    if(aString[index] == ' ')
+      size *= MAPPING_FACTOR_FOR_SPACE;
+    else if(aString[index] >= 'a' && aString[index] <= 'z')
+      size *= MAPPING_FACTOR_FOR_LOWER_CASE;
+    else 
+      size *= MAPPING_FACTOR_FOR_OTHERS;
+    totalsize += size;    
+  }
+  aWidth = NSToCoordRound(totalsize);
+  return NS_OK;
+}
+
+/**
+  * This routine determines width of a string without relying on the
+  * underlying OS.
+  * 
+  * @update  harishd 02/07/1999
+  * @param   aString -- A string whose width needs to be computed
+  * @param   aLength -- Length of the string
+  * @param   aWidth  -- Holds the computed string width
+  *
+  * @return  error code -- 0 if success, non-zero if error
+  */
+
+NS_METHOD
+nsRegressionTestFontMetrics::GetWidth(const char* aString, PRUint32 aLength, nscoord& aWidth)
+{
+  aWidth = 0;
+
+  if(aString == nsnull)
+    return NS_ERROR_NULL_POINTER;
+  
+  float size;
+  float totalsize = 0;
+ 
+  for(PRUint32 index=0; index < aLength; index++){
+    size = (float)mFont->size;
+    if(aString[index] == ' ')
+      size *= MAPPING_FACTOR_FOR_SPACE;
+    else if(aString[index] >= 'a' && aString[index] <= 'z')
+      size *= MAPPING_FACTOR_FOR_LOWER_CASE;
+    else
+      size *= MAPPING_FACTOR_FOR_OTHERS;
+    totalsize += size;    
+  }
+  aWidth += NSToCoordRound(totalsize);
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetXHeight(nscoord& aResult)
+{
+  aResult = mXHeight;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetSuperscriptOffset(nscoord& aResult)
+{
+  aResult = mSuperscriptOffset;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetSubscriptOffset(nscoord& aResult)
+{
+  aResult = mSubscriptOffset;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetStrikeout(nscoord& aOffset, nscoord& aSize)
+{
+  aOffset = mStrikeoutOffset;
+  aSize = mStrikeoutSize;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetUnderline(nscoord& aOffset, nscoord& aSize)
+{
+  aOffset = mUnderlineOffset;
+  aSize = mUnderlineSize;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetHeight(nscoord &aHeight)
+{
+  aHeight = mHeight;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetLeading(nscoord &aLeading)
+{
+  aLeading = mLeading;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetMaxAscent(nscoord &aAscent)
+{
+  aAscent = mMaxAscent;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetMaxDescent(nscoord &aDescent)
+{
+  aDescent = mMaxDescent;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetMaxAdvance(nscoord &aAdvance)
+{
+  aAdvance = mMaxAdvance;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetFont(const nsFont *&aFont)
+{
+  aFont = mFont;
+  return NS_OK;
+}
+NS_IMETHODIMP
+nsRegressionTestFontMetrics::GetFontHandle(nsFontHandle &aHandle)
+{
+  //We don't have a font handler
+  aHandle = NULL;
+  return NS_OK;
+}
+

gfx/src/nsRegressionTestFontMetrics.h

@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsRegressionTestFontMetrics_h__
+#define nsRegressionTestFontMetrics_h__
+
+#include "nsIFontMetrics.h"
+#include "nsFont.h"
+#include "nsString.h"
+#include "nsUnitConversion.h"
+#include "nsIDeviceContext.h"
+
+class nsRegressionTestFontMetrics : public nsIFontMetrics
+{
+public:
+   friend nsresult NS_NewRegressionTestFontMetrics(nsIFontMetrics** aMetrics);
+   virtual ~nsRegressionTestFontMetrics();
+
+
+  NS_DECL_ISUPPORTS
+  
+  NS_IMETHOD  Init(const nsFont& aFont, nsIDeviceContext *aContext);
+  NS_IMETHOD  Destroy();
+
+  NS_IMETHOD  GetXHeight(nscoord& aResult);
+  NS_IMETHOD  GetSuperscriptOffset(nscoord& aResult);
+  NS_IMETHOD  GetSubscriptOffset(nscoord& aResult);
+  NS_IMETHOD  GetStrikeout(nscoord& aOffset, nscoord& aSize);
+  NS_IMETHOD  GetUnderline(nscoord& aOffset, nscoord& aSize);
+
+  NS_IMETHOD  GetHeight(nscoord &aHeight);
+  NS_IMETHOD  GetLeading(nscoord &aLeading);
+  NS_IMETHOD  GetMaxAscent(nscoord &aAscent);
+  NS_IMETHOD  GetMaxDescent(nscoord &aDescent);
+  NS_IMETHOD  GetMaxAdvance(nscoord &aAdvance);
+  NS_IMETHOD  GetFont(const nsFont *&aFont);
+  NS_IMETHOD  GetFontHandle(nsFontHandle &aHandle);
+  
+  NS_METHOD GetWidth(const char aChar, nscoord& aWidth);
+  NS_METHOD GetWidth(const PRUnichar aChar, nscoord& aWidth);
+  NS_METHOD GetWidth(const PRUnichar *aString, PRUint32 aLength, nscoord& aWidth);
+  NS_METHOD GetWidth(const char* aString, PRUint32 aLength, nscoord& aWidth);
+
+protected:
+  nsRegressionTestFontMetrics();
+  void RealizeFont();
+
+  nsIDeviceContext    *mDeviceContext;
+  nsFont              *mFont;
+  nscoord             mHeight;
+  nscoord             mAscent;
+  nscoord             mDescent;
+  nscoord             mLeading;
+  nscoord             mMaxAscent;
+  nscoord             mMaxDescent;
+  nscoord             mMaxAdvance;
+  nscoord             mXHeight;
+  nscoord             mSuperscriptOffset;
+  nscoord             mSubscriptOffset;
+  nscoord             mStrikeoutSize;
+  nscoord             mStrikeoutOffset;
+  nscoord             mUnderlineSize;
+  nscoord             mUnderlineOffset;
+};
+
+
+#endif