layout/svg/base/src/nsSVGMaskFrame.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 the Mozilla SVG project.
  16  *
  17  * The Initial Developer of the Original Code is IBM Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #ifndef __NS_SVGMASKFRAME_H__
  38 #define __NS_SVGMASKFRAME_H__
  39
  40 #include "nsSVGContainerFrame.h"
  41 #include "gfxPattern.h"
  42
  43 class gfxContext;
  44
  45 typedef nsSVGContainerFrame nsSVGMaskFrameBase;
  46
  47 class nsSVGMaskFrame : public nsSVGMaskFrameBase
  48 {
  49   friend nsIFrame*
  50   NS_NewSVGMaskFrame(nsIPresShell* aPresShell, nsIContent* aContent, nsStyleContext* aContext);
  51 protected:
  52   nsSVGMaskFrame(nsStyleContext* aContext) :
  53     nsSVGMaskFrameBase(aContext),
  54     mMaskParentMatrix(nsnull),
  55     mInUse(PR_FALSE) {}
  56
  57 public:
  58   // nsSVGMaskFrame method:
  59   already_AddRefed<gfxPattern> ComputeMaskAlpha(nsSVGRenderState *aContext,
  60                                                 nsIFrame* aParent,
  61                                                 nsIDOMSVGMatrix* aMatrix,
  62                                                 float aOpacity = 1.0f);
  63
  64   /**
  65    * Get the "type" of the frame
  66    *
  67    * @see nsGkAtoms::svgMaskFrame
  68    */
  69   virtual nsIAtom* GetType() const;
  70
  71 #ifdef DEBUG
  72   NS_IMETHOD GetFrameName(nsAString& aResult) const
  73   {
  74     return MakeFrameName(NS_LITERAL_STRING("SVGMask"), aResult);
  75   }
  76 #endif
  77
  78 private:
  79   // A helper class to allow us to paint masks safely. The helper
  80   // automatically sets and clears the mInUse flag on the mask frame
  81   // (to prevent nasty reference loops). It's easy to mess this up
  82   // and break things, so this helper makes the code far more robust.
  83   class AutoMaskReferencer
  84   {
  85   public:
  86     AutoMaskReferencer(nsSVGMaskFrame *aFrame)
  87        : mFrame(aFrame) {
  88       NS_ASSERTION(mFrame->mInUse == PR_FALSE, "reference loop!");
  89       mFrame->mInUse = PR_TRUE;
  90     }
  91     ~AutoMaskReferencer() {
  92       mFrame->mInUse = PR_FALSE;
  93     }
  94   private:
  95     nsSVGMaskFrame *mFrame;
  96   };
  97
  98   nsIFrame *mMaskParent;
  99   nsCOMPtr<nsIDOMSVGMatrix> mMaskParentMatrix;
 100   // recursion prevention flag
 101   PRPackedBool mInUse;
 102
 103   // nsSVGContainerFrame methods:
 104   virtual already_AddRefed<nsIDOMSVGMatrix> GetCanvasTM();
 105 };
 106
 107 #endif