layout/base/nsLayoutDebugger.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /*
   7  * implementation of interface that allows layout-debug extension access
   8  * to some internals of layout
   9  */
  10
  11 #include "nsILayoutDebugger.h"
  12 #include "nsFrame.h"
  13 #include "nsDisplayList.h"
  14 #include "FrameLayerBuilder.h"
  15 #include "nsPrintfCString.h"
  16
  17 #include <stdio.h>
  18
  19 using namespace mozilla;
  20 using namespace mozilla::layers;
  21
  22 #ifdef DEBUG
  23 class nsLayoutDebugger : public nsILayoutDebugger {
  24 public:
  25   nsLayoutDebugger();
  26
  27   NS_DECL_ISUPPORTS
  28
  29   NS_IMETHOD SetShowFrameBorders(bool aEnable) MOZ_OVERRIDE;
  30
  31   NS_IMETHOD GetShowFrameBorders(bool* aResult) MOZ_OVERRIDE;
  32
  33   NS_IMETHOD SetShowEventTargetFrameBorder(bool aEnable) MOZ_OVERRIDE;
  34
  35   NS_IMETHOD GetShowEventTargetFrameBorder(bool* aResult) MOZ_OVERRIDE;
  36
  37   NS_IMETHOD GetContentSize(nsIDocument* aDocument,
  38                             int32_t* aSizeInBytesResult) MOZ_OVERRIDE;
  39
  40   NS_IMETHOD GetFrameSize(nsIPresShell* aPresentation,
  41                           int32_t* aSizeInBytesResult) MOZ_OVERRIDE;
  42
  43   NS_IMETHOD GetStyleSize(nsIPresShell* aPresentation,
  44                           int32_t* aSizeInBytesResult) MOZ_OVERRIDE;
  45
  46 protected:
  47   virtual ~nsLayoutDebugger();
  48 };
  49
  50 nsresult
  51 NS_NewLayoutDebugger(nsILayoutDebugger** aResult)
  52 {
  53   NS_PRECONDITION(aResult, "null OUT ptr");
  54   if (!aResult) {
  55     return NS_ERROR_NULL_POINTER;
  56   }
  57   nsLayoutDebugger* it = new nsLayoutDebugger();
  58   return it->QueryInterface(NS_GET_IID(nsILayoutDebugger), (void**)aResult);
  59 }
  60
  61 nsLayoutDebugger::nsLayoutDebugger()
  62 {
  63 }
  64
  65 nsLayoutDebugger::~nsLayoutDebugger()
  66 {
  67 }
  68
  69 NS_IMPL_ISUPPORTS(nsLayoutDebugger, nsILayoutDebugger)
  70
  71 NS_IMETHODIMP
  72 nsLayoutDebugger::SetShowFrameBorders(bool aEnable)
  73 {
  74   nsFrame::ShowFrameBorders(aEnable);
  75   return NS_OK;
  76 }
  77
  78 NS_IMETHODIMP
  79 nsLayoutDebugger::GetShowFrameBorders(bool* aResult)
  80 {
  81   *aResult = nsFrame::GetShowFrameBorders();
  82   return NS_OK;
  83 }
  84
  85 NS_IMETHODIMP
  86 nsLayoutDebugger::SetShowEventTargetFrameBorder(bool aEnable)
  87 {
  88   nsFrame::ShowEventTargetFrameBorder(aEnable);
  89   return NS_OK;
  90 }
  91
  92 NS_IMETHODIMP
  93 nsLayoutDebugger::GetShowEventTargetFrameBorder(bool* aResult)
  94 {
  95   *aResult = nsFrame::GetShowEventTargetFrameBorder();
  96   return NS_OK;
  97 }
  98
  99 NS_IMETHODIMP
 100 nsLayoutDebugger::GetContentSize(nsIDocument* aDocument,
 101                                  int32_t* aSizeInBytesResult)
 102 {
 103   *aSizeInBytesResult = 0;
 104   return NS_ERROR_FAILURE;
 105 }
 106
 107 NS_IMETHODIMP
 108 nsLayoutDebugger::GetFrameSize(nsIPresShell* aPresentation,
 109                                int32_t* aSizeInBytesResult)
 110 {
 111   *aSizeInBytesResult = 0;
 112   return NS_ERROR_FAILURE;
 113 }
 114
 115 NS_IMETHODIMP
 116 nsLayoutDebugger::GetStyleSize(nsIPresShell* aPresentation,
 117                                int32_t* aSizeInBytesResult)
 118 {
 119   *aSizeInBytesResult = 0;
 120   return NS_ERROR_FAILURE;
 121 }
 122 #endif
 123
 124 #ifdef MOZ_DUMP_PAINTING
 125 std::ostream& operator<<(std::ostream& os, const nsPrintfCString& rhs) {
 126   os << rhs.get();
 127   return os;
 128 }
 129
 130 static void
 131 PrintDisplayListTo(nsDisplayListBuilder* aBuilder, const nsDisplayList& aList,
 132                    std::stringstream& aStream, uint32_t aIndent, bool aDumpHtml);
 133
 134 static void
 135 PrintDisplayItemTo(nsDisplayListBuilder* aBuilder, nsDisplayItem* aItem,
 136                    std::stringstream& aStream, uint32_t aIndent, bool aDumpSublist, bool aDumpHtml)
 137 {
 138   std::stringstream ss;
 139
 140   if (!aDumpHtml) {
 141     for (uint32_t indent = 0; indent < aIndent; indent++) {
 142       aStream << "  ";
 143     }
 144   }
 145   nsIFrame* f = aItem->Frame();
 146   nsAutoString fName;
 147 #ifdef DEBUG_FRAME_DUMP
 148   f->GetFrameName(fName);
 149 #endif
 150   bool snap;
 151   nsRect rect = aItem->GetBounds(aBuilder, &snap);
 152   nscolor color;
 153   nsRect vis = aItem->GetVisibleRect();
 154   nsRect component = aItem->GetComponentAlphaBounds(aBuilder);
 155   nsDisplayList* list = aItem->GetChildren();
 156   const DisplayItemClip& clip = aItem->GetClip();
 157   nsRegion opaque = aItem->GetOpaqueRegion(aBuilder, &snap);
 158   if (aDumpHtml && aItem->Painted()) {
 159     nsCString string(aItem->Name());
 160     string.Append('-');
 161     string.AppendInt((uint64_t)aItem);
 162     aStream << nsPrintfCString("<a href=\"javascript:ViewImage('%s')\">", string.BeginReading());
 163   }
 164   aStream << nsPrintfCString("%s p=0x%p f=0x%p(%s) %sbounds(%d,%d,%d,%d) visible(%d,%d,%d,%d) componentAlpha(%d,%d,%d,%d) clip(%s) %s",
 165           aItem->Name(), aItem, (void*)f, NS_ConvertUTF16toUTF8(fName).get(),
 166           (aItem->ZIndex() ? nsPrintfCString("z=%d ", aItem->ZIndex()).get() : ""),
 167           rect.x, rect.y, rect.width, rect.height,
 168           vis.x, vis.y, vis.width, vis.height,
 169           component.x, component.y, component.width, component.height,
 170           clip.ToString().get(),
 171           aItem->IsUniform(aBuilder, &color) ? " uniform" : "");
 172
 173   nsRegionRectIterator iter(opaque);
 174   for (const nsRect* r = iter.Next(); r; r = iter.Next()) {
 175     aStream << nsPrintfCString(" (opaque %d,%d,%d,%d)", r->x, r->y, r->width, r->height);
 176   }
 177
 178   if (aItem->ShouldFixToViewport(nullptr)) {
 179     aStream << " fixed";
 180   }
 181
 182   if (aItem->Frame()->StyleDisplay()->mWillChange.Length() > 0) {
 183     aStream << " (will-change=";
 184     for (size_t i = 0; i < aItem->Frame()->StyleDisplay()->mWillChange.Length(); i++) {
 185       if (i > 0) {
 186         aStream << ",";
 187       }
 188       aStream << NS_LossyConvertUTF16toASCII(aItem->Frame()->StyleDisplay()->mWillChange[i]).get();
 189     }
 190     aStream << ")";
 191   }
 192
 193   // Display item specific debug info
 194   nsCString itemStr;
 195   aItem->WriteDebugInfo(itemStr);
 196   aStream << itemStr.get();
 197
 198   if (aDumpHtml && aItem->Painted()) {
 199     aStream << "</a>";
 200   }
 201   uint32_t key = aItem->GetPerFrameKey();
 202   Layer* layer = mozilla::FrameLayerBuilder::GetDebugOldLayerFor(f, key);
 203   if (layer) {
 204     if (aDumpHtml) {
 205       aStream << nsPrintfCString(" <a href=\"#%p\">layer=%p</a>", layer, layer);
 206     } else {
 207       aStream << nsPrintfCString(" layer=0x%p", layer);
 208     }
 209   }
 210   if (aItem->GetType() == nsDisplayItem::TYPE_SVG_EFFECTS) {
 211     nsCString str;
 212     (static_cast<nsDisplaySVGEffects*>(aItem))->PrintEffects(str);
 213     aStream << str.get();
 214   }
 215   aStream << "\n";
 216
 217   if (aDumpSublist && list) {
 218     PrintDisplayListTo(aBuilder, *list, aStream, aIndent+1, aDumpHtml);
 219   }
 220 }
 221
 222 static void
 223 PrintDisplayListTo(nsDisplayListBuilder* aBuilder, const nsDisplayList& aList,
 224                    std::stringstream& aStream, uint32_t aIndent, bool aDumpHtml)
 225 {
 226   if (aDumpHtml) {
 227     aStream << "<ul>";
 228   }
 229
 230   for (nsDisplayItem* i = aList.GetBottom(); i != nullptr; i = i->GetAbove()) {
 231     if (aDumpHtml) {
 232       aStream << "<li>";
 233     }
 234     PrintDisplayItemTo(aBuilder, i, aStream, aIndent, true, aDumpHtml);
 235     if (aDumpHtml) {
 236       aStream << "</li>";
 237     }
 238   }
 239
 240   if (aDumpHtml) {
 241     aStream << "</ul>";
 242   }
 243 }
 244
 245 void
 246 nsFrame::PrintDisplayItem(nsDisplayListBuilder* aBuilder,
 247                           nsDisplayItem* aItem,
 248                           std::stringstream& aStream,
 249                           bool aDumpSublist,
 250                           bool aDumpHtml)
 251 {
 252   PrintDisplayItemTo(aBuilder, aItem, aStream, 0, aDumpSublist, aDumpHtml);
 253 }
 254
 255 void
 256 nsFrame::PrintDisplayList(nsDisplayListBuilder* aBuilder,
 257                           const nsDisplayList& aList,
 258                           std::stringstream& aStream,
 259                           bool aDumpHtml)
 260 {
 261   PrintDisplayListTo(aBuilder, aList, aStream, 0, aDumpHtml);
 262 }
 263
 264 static void
 265 PrintDisplayListSetItem(nsDisplayListBuilder* aBuilder,
 266                         const char* aItemName,
 267                         const nsDisplayList& aList,
 268                         std::stringstream& aStream,
 269                         bool aDumpHtml)
 270 {
 271   if (aDumpHtml) {
 272     aStream << "<li>";
 273   }
 274   aStream << aItemName << "\n";
 275   PrintDisplayListTo(aBuilder, aList, aStream, 0, aDumpHtml);
 276   if (aDumpHtml) {
 277     aStream << "</li>";
 278   }
 279 }
 280
 281 void
 282 nsFrame::PrintDisplayListSet(nsDisplayListBuilder* aBuilder,
 283                              const nsDisplayListSet& aSet,
 284                              std::stringstream& aStream,
 285                              bool aDumpHtml)
 286 {
 287   if (aDumpHtml) {
 288     aStream << "<ul>";
 289   }
 290   PrintDisplayListSetItem(aBuilder, "[BorderBackground]", *(aSet.BorderBackground()), aStream, aDumpHtml);
 291   PrintDisplayListSetItem(aBuilder, "[BlockBorderBackgrounds]", *(aSet.BlockBorderBackgrounds()), aStream, aDumpHtml);
 292   PrintDisplayListSetItem(aBuilder, "[Floats]", *(aSet.Floats()), aStream, aDumpHtml);
 293   PrintDisplayListSetItem(aBuilder, "[PositionedDescendants]", *(aSet.PositionedDescendants()), aStream, aDumpHtml);
 294   PrintDisplayListSetItem(aBuilder, "[Outlines]", *(aSet.Outlines()), aStream, aDumpHtml);
 295   PrintDisplayListSetItem(aBuilder, "[Content]", *(aSet.Content()), aStream, aDumpHtml);
 296   if (aDumpHtml) {
 297     aStream << "</ul>";
 298   }
 299 }
 300
 301 #endif