DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Untracked file

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/* -*- 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 ***** */
 
#ifndef nsGfxUtils_h_
#define nsGfxUtils_h_

#ifndef CarbonHelpers_h__
#include "nsCarbonHelpers.h"
#endif // CarbonHelpers_h__

#if DEBUG && !defined(XP_MACOSX)
#include "macstdlibextras.h"
#endif

#include <LowMem.h>


/** ------------------------------------------------------------
 *	Used to assert that we're not clobbering a bad port
 */
inline PRBool CurrentPortIsWMPort()
{
  return PR_FALSE;
}


//------------------------------------------------------------------------
// ValidateDrawingState
// 
// Test that the current drawing environment is good, which means that
// we have a valid port (as far as we can tell)
//------------------------------------------------------------------------
inline PRBool ValidateDrawingState()
{
  CGrafPtr    curPort;
  GDHandle    curDevice;
  
  GetGWorld(&curPort, &curDevice);
  
  // if we have a window, but we're set to the WM port, things are bad
  if (CurrentPortIsWMPort() && (FrontWindow() != nil))
    return false;


  // see if the device is in the device list. If not, it probably means that
  // it's the device for an offscreen GWorld. In that case, the current port
  // should be set to that GWorld too.
  {
    GDHandle    thisDevice = GetDeviceList();
    while (thisDevice)
    {
      if (thisDevice == curDevice)
         break;
    
      thisDevice = GetNextDevice(thisDevice);
    }

    if ((thisDevice == nil) && !IsPortOffscreen(curPort))    // nil device is OK only with GWorld
      return false;
  }

  return true;
}


//------------------------------------------------------------------------
// static graphics utility methods
//------------------------------------------------------------------------
class nsGraphicsUtils
{
public:

  //------------------------------------------------------------------------
  // SafeSetPort
  //
  // Set the port, being sure to set the GDevice to a valid device, since
  // the current GDevice may belong to a GWorld.
  //------------------------------------------------------------------------
  static void SafeSetPort(CGrafPtr newPort)
  {
    ::SetGWorld(newPort, ::IsPortOffscreen(newPort) ? nsnull : ::GetMainDevice());
  }
  
  //------------------------------------------------------------------------
  // SafeSetPortWindowPort
  //
  // Set the port, being sure to set the GDevice to a valid device, since
  // the current GDevice may belong to a GWorld.
  //------------------------------------------------------------------------
  static void SafeSetPortWindowPort(WindowPtr window)
  {
    SafeSetPort(::GetWindowPort(window));
  }

  //------------------------------------------------------------------------
  // SetPortToKnownGoodPort
  //
  // Set the port to a known good port, if possible.
  //------------------------------------------------------------------------
  static void SetPortToKnownGoodPort()
  {
    WindowPtr firstWindow = GetTheWindowList();
    if (firstWindow)
      ::SetGWorld(::GetWindowPort(firstWindow), ::GetMainDevice());
  }

};


//------------------------------------------------------------------------
// utility port setting class
//
// This code has to deal with the situation where the current port
// is a GWorld, and the current devices that GWorld's device. So
// when setting the port to an onscreen part, we always reset the
// current device to the main device.
//------------------------------------------------------------------------
class StPortSetter
{
public:
	StPortSetter(CGrafPtr newPort)
	{
		InitSetter(newPort);
	}

	StPortSetter(WindowPtr window)
	{
		InitSetter(GetWindowPort(window));
	}
	
	~StPortSetter()
	{
	  if (mPortChanged)
  		::SetGWorld(mOldPort, mOldDevice);
	  NS_ASSERTION(ValidateDrawingState(), "Bad drawing state");
	}

protected:
  void InitSetter(CGrafPtr newPort)
	{
	  NS_ASSERTION(ValidateDrawingState(), "Bad drawing state");
	  // we assume that if the port has been set, then the port/GDevice are
	  // valid, and do nothing (for speed)
	  mPortChanged = (newPort != CGrafPtr(GetQDGlobalsThePort()));
	  if (mPortChanged)
	  {
  		::GetGWorld(&mOldPort, &mOldDevice);
  		::SetGWorld(newPort, ::IsPortOffscreen(newPort) ? nsnull : ::GetMainDevice());
		}
	}

protected:
  Boolean     mPortChanged;
	CGrafPtr		mOldPort;
	GDHandle    mOldDevice;
};


//------------------------------------------------------------------------
// utility class to temporarily set and restore the origin.
// Assumes that the port has already been set up.
//------------------------------------------------------------------------
class StOriginSetter
{
public:

  StOriginSetter(WindowRef wind, const Point* newOrigin = nsnull)
  {
    ::GetWindowPortBounds(wind, &mSavePortRect);
    if (newOrigin)
      ::SetOrigin(newOrigin->h, newOrigin->v);
    else
      ::SetOrigin(0, 0);
  }
  
  StOriginSetter(CGrafPtr grafPort, const Point* newOrigin = nsnull)
  {
    ::GetPortBounds(grafPort, &mSavePortRect);
    if (newOrigin)
      ::SetOrigin(newOrigin->h, newOrigin->v);
    else
      ::SetOrigin(0, 0);
  }
  
  ~StOriginSetter()
  {
    ::SetOrigin(mSavePortRect.left, mSavePortRect.top);
  }

protected:
  
  Rect    mSavePortRect;

};

//------------------------------------------------------------------------
// utility GWorld port setting class
//
// This should *only* be used to set the port temporarily to the
// GWorld, and then restore it.
//------------------------------------------------------------------------

class StGWorldPortSetter
{
public:
	StGWorldPortSetter(GWorldPtr destGWorld)
	{
	  NS_ASSERTION(::IsPortOffscreen(destGWorld), "StGWorldPortSetter should only be used for GWorlds");
	  ::GetGWorld(&mOldPort, &mOldDevice);
		::SetGWorld(destGWorld, nsnull);
	}
	
	~StGWorldPortSetter()
	{
    ::SetGWorld(mOldPort, mOldDevice);
	  NS_ASSERTION(ValidateDrawingState(), "Bad drawing state");
	}

protected:
	GWorldPtr		mOldPort;
  GDHandle    mOldDevice;
};

//------------------------------------------------------------------------
// utility text state save/restore class
//------------------------------------------------------------------------

class StTextStyleSetter
{
public:
	StTextStyleSetter(SInt16 fontID, SInt16 fontSize, SInt16 fontFace)
	{
	  SetPortFontStyle(fontID, fontSize, fontFace);
	}
	
	StTextStyleSetter(TextStyle& theStyle)
	{
	  SetPortFontStyle(theStyle.tsFont, theStyle.tsSize, theStyle.tsFace);
	}
	
	~StTextStyleSetter()
	{
  	::TextFont(mFontID);
  	::TextSize(mFontSize);
  	::TextFace(mFontFace);
	}

protected:

  void SetPortFontStyle(SInt16 fontID, SInt16 fontSize, SInt16 fontFace)
	{
	  CGrafPtr curPort;
	  ::GetPort((GrafPtr*)&curPort);
	  
	  NS_ASSERTION(ValidateDrawingState(), "Bad drawing state");

    mFontID = ::GetPortTextFont(curPort);
    mFontSize = ::GetPortTextSize(curPort);
    mFontFace = ::GetPortTextFace(curPort);
	  
  	::TextFont(fontID);
  	::TextSize(fontSize);
  	::TextFace(fontFace);

	}

protected:
	SInt16		mFontID;
	SInt16		mFontSize;
	SInt16    mFontFace;
};





/** ------------------------------------------------------------
 *	Utility class for saving, locking, and restoring pixel state
 */

class StPixelLocker
{
public:
				
										StPixelLocker(PixMapHandle thePixMap)
										:	mPixMap(thePixMap)
										,	mPixelState(0)
										{
											if (mPixMap) {
											mPixelState = ::GetPixelsState(mPixMap);
											::LockPixels(mPixMap);
										}
										}
										
										~StPixelLocker()
										{
											if (mPixMap)
											::SetPixelsState(mPixMap, mPixelState);
										}

protected:


		PixMapHandle		mPixMap;
		GWorldFlags			mPixelState;

};



/** ------------------------------------------------------------
 *	Utility class stack-based handle ownership
 */

class StHandleOwner
{
public:
                    StHandleOwner(Handle inHandle)
                    : mHandle(inHandle)
                    {
                    }

                    ~StHandleOwner()
                    {
                      if (mHandle)
                        ::DisposeHandle(mHandle);
                    }

  Handle            GetHandle() { return mHandle; }

  void              ClearHandle(Boolean disposeIt = false)
                    {
                      if (disposeIt)
                        ::DisposeHandle(mHandle);
                      
                      mHandle = nsnull;
                    }

protected:

  Handle            mHandle;

};

/** ------------------------------------------------------------
 *	Utility class for saving, locking, and restoring handle state
 *  Ok with null handle
 */

class StHandleLocker
{
public:

                    StHandleLocker(Handle theHandle)
                    :	mHandle(theHandle)
                    {
                      if (mHandle)
                      {
                    	  mOldHandleState = ::HGetState(mHandle);
                    	  ::HLock(mHandle);
                      }										  
                    }

                    ~StHandleLocker()
                    {
                      if (mHandle)
                        ::HSetState(mHandle, mOldHandleState);
                    }

protected:

    Handle          mHandle;
    SInt8           mOldHandleState;
};


/**
 * Stack based utility class for releasing a Quartz color space.
 * Use as follows:
 *    CGColorSpaceRef rgbSpace = ::CGColorSpaceCreateDeviceRGB();
 *    StColorSpaceReleaser csReleaser(rgbSpace);
 */
class StColorSpaceReleaser
{
public:
  StColorSpaceReleaser(CGColorSpaceRef inColorSpace)
  : mColorSpace(inColorSpace)
  {
  }

  ~StColorSpaceReleaser()
  {
    // No need to check for NULL, since CGColorSpaceCreateDeviceRGB(NULL)
    // is a noop.
    ::CGColorSpaceRelease(mColorSpace);
  }

private:
  CGColorSpaceRef mColorSpace;
};

#endif // nsGfxUtils_h_