third_party/WebKit/Source/platform/graphics/paint/DisplayItem.cpp

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "platform/graphics/paint/DisplayItem.h"

namespace blink {

struct SameSizeAsDisplayItem {
  virtual ~SameSizeAsDisplayItem() {}  // Allocate vtable pointer.
  void* pointer;
  int i;
#ifndef NDEBUG
  WTF::String m_debugString;
#endif
};
static_assert(sizeof(DisplayItem) == sizeof(SameSizeAsDisplayItem),
              "DisplayItem should stay small");

#ifndef NDEBUG

static WTF::String paintPhaseAsDebugString(int paintPhase) {
  // Must be kept in sync with PaintPhase.
  switch (paintPhase) {
    case 0:
      return "PaintPhaseBlockBackground";
    case 1:
      return "PaintPhaseSelfBlockBackground";
    case 2:
      return "PaintPhaseChildBlockBackgrounds";
    case 3:
      return "PaintPhaseFloat";
    case 4:
      return "PaintPhaseForeground";
    case 5:
      return "PaintPhaseOutline";
    case 6:
      return "PaintPhaseSelfOutline";
    case 7:
      return "PaintPhaseChildOutlines";
    case 8:
      return "PaintPhaseSelection";
    case 9:
      return "PaintPhaseTextClip";
    case 10:
      return "PaintPhaseMask";
    case DisplayItem::kPaintPhaseMax:
      return "PaintPhaseClippingMask";
    default:
      ASSERT_NOT_REACHED();
      return "Unknown";
  }
}

#define PAINT_PHASE_BASED_DEBUG_STRINGS(Category)          \
  if (type >= DisplayItem::k##Category##PaintPhaseFirst && \
      type <= DisplayItem::k##Category##PaintPhaseLast)    \
    return #Category + paintPhaseAsDebugString(            \
                           type - DisplayItem::k##Category##PaintPhaseFirst);

#define DEBUG_STRING_CASE(DisplayItemName) \
  case DisplayItem::k##DisplayItemName:    \
    return #DisplayItemName

#define DEFAULT_CASE      \
  default:                \
    ASSERT_NOT_REACHED(); \
    return "Unknown"

static WTF::String specialDrawingTypeAsDebugString(DisplayItem::Type type) {
  if (type >= DisplayItem::kTableCollapsedBorderUnalignedBase) {
    if (type <= DisplayItem::kTableCollapsedBorderBase)
      return "TableCollapsedBorderAlignment";
    if (type <= DisplayItem::kTableCollapsedBorderLast) {
      StringBuilder sb;
      sb.append("TableCollapsedBorder");
      if (type & DisplayItem::TableCollapsedBorderTop)
        sb.append("Top");
      if (type & DisplayItem::TableCollapsedBorderRight)
        sb.append("Right");
      if (type & DisplayItem::TableCollapsedBorderBottom)
        sb.append("Bottom");
      if (type & DisplayItem::TableCollapsedBorderLeft)
        sb.append("Left");
      return sb.toString();
    }
  }
  switch (type) {
    DEBUG_STRING_CASE(BoxDecorationBackground);
    DEBUG_STRING_CASE(Caret);
    DEBUG_STRING_CASE(ColumnRules);
    DEBUG_STRING_CASE(DebugDrawing);
    DEBUG_STRING_CASE(DocumentBackground);
    DEBUG_STRING_CASE(DragImage);
    DEBUG_STRING_CASE(DragCaret);
    DEBUG_STRING_CASE(SVGImage);
    DEBUG_STRING_CASE(LinkHighlight);
    DEBUG_STRING_CASE(ImageAreaFocusRing);
    DEBUG_STRING_CASE(PageOverlay);
    DEBUG_STRING_CASE(PageWidgetDelegateBackgroundFallback);
    DEBUG_STRING_CASE(PopupContainerBorder);
    DEBUG_STRING_CASE(PopupListBoxBackground);
    DEBUG_STRING_CASE(PopupListBoxRow);
    DEBUG_STRING_CASE(PrintedContentBackground);
    DEBUG_STRING_CASE(PrintedContentDestinationLocations);
    DEBUG_STRING_CASE(PrintedContentLineBoundary);
    DEBUG_STRING_CASE(PrintedContentPDFURLRect);
    DEBUG_STRING_CASE(Resizer);
    DEBUG_STRING_CASE(SVGClip);
    DEBUG_STRING_CASE(SVGFilter);
    DEBUG_STRING_CASE(SVGMask);
    DEBUG_STRING_CASE(ScrollbarBackButtonEnd);
    DEBUG_STRING_CASE(ScrollbarBackButtonStart);
    DEBUG_STRING_CASE(ScrollbarBackground);
    DEBUG_STRING_CASE(ScrollbarBackTrack);
    DEBUG_STRING_CASE(ScrollbarCorner);
    DEBUG_STRING_CASE(ScrollbarForwardButtonEnd);
    DEBUG_STRING_CASE(ScrollbarForwardButtonStart);
    DEBUG_STRING_CASE(ScrollbarForwardTrack);
    DEBUG_STRING_CASE(ScrollbarThumb);
    DEBUG_STRING_CASE(ScrollbarTickmarks);
    DEBUG_STRING_CASE(ScrollbarTrackBackground);
    DEBUG_STRING_CASE(ScrollbarCompositedScrollbar);
    DEBUG_STRING_CASE(SelectionTint);
    DEBUG_STRING_CASE(TableCellBackgroundFromColumnGroup);
    DEBUG_STRING_CASE(TableCellBackgroundFromColumn);
    DEBUG_STRING_CASE(TableCellBackgroundFromSection);
    DEBUG_STRING_CASE(TableCellBackgroundFromRow);
    DEBUG_STRING_CASE(TableSectionBoxShadowInset);
    DEBUG_STRING_CASE(TableSectionBoxShadowNormal);
    DEBUG_STRING_CASE(TableRowBoxShadowInset);
    DEBUG_STRING_CASE(TableRowBoxShadowNormal);
    DEBUG_STRING_CASE(VideoBitmap);
    DEBUG_STRING_CASE(WebPlugin);
    DEBUG_STRING_CASE(WebFont);
    DEBUG_STRING_CASE(ReflectionMask);

    DEFAULT_CASE;
  }
}

static WTF::String drawingTypeAsDebugString(DisplayItem::Type type) {
  PAINT_PHASE_BASED_DEBUG_STRINGS(Drawing);
  return "Drawing" + specialDrawingTypeAsDebugString(type);
}

static String foreignLayerTypeAsDebugString(DisplayItem::Type type) {
  switch (type) {
    DEBUG_STRING_CASE(ForeignLayerCanvas);
    DEBUG_STRING_CASE(ForeignLayerPlugin);
    DEBUG_STRING_CASE(ForeignLayerVideo);
    DEFAULT_CASE;
  }
}

static WTF::String clipTypeAsDebugString(DisplayItem::Type type) {
  PAINT_PHASE_BASED_DEBUG_STRINGS(ClipBox);
  PAINT_PHASE_BASED_DEBUG_STRINGS(ClipColumnBounds);
  PAINT_PHASE_BASED_DEBUG_STRINGS(ClipLayerFragment);

  switch (type) {
    DEBUG_STRING_CASE(ClipFileUploadControlRect);
    DEBUG_STRING_CASE(ClipFrameToVisibleContentRect);
    DEBUG_STRING_CASE(ClipFrameScrollbars);
    DEBUG_STRING_CASE(ClipLayerBackground);
    DEBUG_STRING_CASE(ClipLayerColumnBounds);
    DEBUG_STRING_CASE(ClipLayerFilter);
    DEBUG_STRING_CASE(ClipLayerForeground);
    DEBUG_STRING_CASE(ClipLayerParent);
    DEBUG_STRING_CASE(ClipLayerOverflowControls);
    DEBUG_STRING_CASE(ClipNodeImage);
    DEBUG_STRING_CASE(ClipPopupListBoxFrame);
    DEBUG_STRING_CASE(ClipScrollbarsToBoxBounds);
    DEBUG_STRING_CASE(ClipSelectionImage);
    DEBUG_STRING_CASE(PageWidgetDelegateClip);
    DEBUG_STRING_CASE(ClipPrintedPage);
    DEFAULT_CASE;
  }
}

static String scrollTypeAsDebugString(DisplayItem::Type type) {
  PAINT_PHASE_BASED_DEBUG_STRINGS(Scroll);
  switch (type) {
    DEBUG_STRING_CASE(ScrollOverflowControls);
    DEFAULT_CASE;
  }
}

static String transform3DTypeAsDebugString(DisplayItem::Type type) {
  switch (type) {
    DEBUG_STRING_CASE(Transform3DElementTransform);
    DEFAULT_CASE;
  }
}

WTF::String DisplayItem::typeAsDebugString(Type type) {
  if (isDrawingType(type))
    return drawingTypeAsDebugString(type);

  if (isForeignLayerType(type))
    return foreignLayerTypeAsDebugString(type);

  if (isClipType(type))
    return clipTypeAsDebugString(type);
  if (isEndClipType(type))
    return "End" + clipTypeAsDebugString(endClipTypeToClipType(type));

  PAINT_PHASE_BASED_DEBUG_STRINGS(FloatClip);
  if (isEndFloatClipType(type))
    return "End" + typeAsDebugString(endFloatClipTypeToFloatClipType(type));

  if (isScrollType(type))
    return scrollTypeAsDebugString(type);
  if (isEndScrollType(type))
    return "End" + scrollTypeAsDebugString(endScrollTypeToScrollType(type));

  if (isTransform3DType(type))
    return transform3DTypeAsDebugString(type);
  if (isEndTransform3DType(type))
    return "End" + transform3DTypeAsDebugString(
                       endTransform3DTypeToTransform3DType(type));

  switch (type) {
    DEBUG_STRING_CASE(BeginFilter);
    DEBUG_STRING_CASE(EndFilter);
    DEBUG_STRING_CASE(BeginCompositing);
    DEBUG_STRING_CASE(EndCompositing);
    DEBUG_STRING_CASE(BeginTransform);
    DEBUG_STRING_CASE(EndTransform);
    DEBUG_STRING_CASE(BeginClipPath);
    DEBUG_STRING_CASE(EndClipPath);
    DEBUG_STRING_CASE(Subsequence);
    DEBUG_STRING_CASE(EndSubsequence);
    DEBUG_STRING_CASE(UninitializedType);
    DEFAULT_CASE;
  }
}

WTF::String DisplayItem::asDebugString() const {
  WTF::StringBuilder stringBuilder;
  stringBuilder.append('{');
  dumpPropertiesAsDebugString(stringBuilder);
  stringBuilder.append('}');
  return stringBuilder.toString();
}

void DisplayItem::dumpPropertiesAsDebugString(
    WTF::StringBuilder& stringBuilder) const {
  if (!hasValidClient()) {
    stringBuilder.append("validClient: false, originalDebugString: ");
    // This is the original debug string which is in json format.
    stringBuilder.append(clientDebugString());
    return;
  }

  stringBuilder.append(String::format("client: \"%p", &client()));
  if (!clientDebugString().isEmpty()) {
    stringBuilder.append(' ');
    stringBuilder.append(clientDebugString());
  }
  stringBuilder.append("\", type: \"");
  stringBuilder.append(typeAsDebugString(getType()));
  stringBuilder.append('"');
  if (m_skippedCache)
    stringBuilder.append(", skippedCache: true");
}

#endif

}  // namespace blink