Home | History | Annotate | Download | only in graphics 
      1 /*
      2  * Copyright (C) 2013 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #include "wtf/Vector.h"
     32 #include "wtf/text/WTFString.h"
     33 
     34 #ifndef GraphicsContextAnnotation_h
     35 #define GraphicsContextAnnotation_h
     36 
     37 #define ANNOTATE_GRAPHICS_CONTEXT(paintInfo, renderer) \
     38     GraphicsContextAnnotator scopedGraphicsContextAnnotator; \
     39     if (UNLIKELY(paintInfo.context->annotationMode())) \
     40         scopedGraphicsContextAnnotator.annotate(paintInfo, renderer)
     41 
     42 namespace WebCore {
     43 
     44 class GraphicsContext;
     45 class RenderObject;
     46 struct PaintInfo;
     47 
     48 enum AnnotationMode {
     49     AnnotateRendererName    = 1 << 0,
     50     AnnotatePaintPhase      = 1 << 1,
     51     AnnotateElementId       = 1 << 2,
     52     AnnotateElementClass    = 1 << 3,
     53     AnnotateElementTag      = 1 << 4,
     54 
     55     AnnotateAll             = 0x1f
     56 };
     57 
     58 typedef unsigned AnnotationModeFlags;
     59 typedef Vector<std::pair<const char*, String> > AnnotationList;
     60 
     61 class GraphicsContextAnnotation {
     62 public:
     63     GraphicsContextAnnotation(const PaintInfo&, const RenderObject*);
     64 
     65     String rendererName() const { return m_rendererName; }
     66     String paintPhase() const { return m_paintPhase; }
     67     String elementId() const { return m_elementId; }
     68     String elementClass() const { return m_elementClass; }
     69     String elementTag() const { return m_elementTag; }
     70 
     71     void asAnnotationList(AnnotationList&) const;
     72 
     73 private:
     74     const char* m_rendererName;
     75     const char* m_paintPhase;
     76     String m_elementId;
     77     String m_elementClass;
     78     String m_elementTag;
     79 };
     80 
     81 class GraphicsContextAnnotator {
     82 public:
     83     GraphicsContextAnnotator()
     84         : m_context(0)
     85     { }
     86 
     87     ~GraphicsContextAnnotator()
     88     {
     89         if (UNLIKELY(m_context != 0))
     90             finishAnnotation();
     91     }
     92 
     93     void annotate(const PaintInfo&, const RenderObject*);
     94 
     95 private:
     96     void finishAnnotation();
     97 
     98     GraphicsContext* m_context;
     99 };
    100 
    101 } // namespace WebCore
    102 
    103 #endif // GraphicsContextAnnotation_h
    104