ui/views/debug_utils.cc

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

#include "ui/views/debug_utils.h"

#include <ostream>

#include "base/logging.h"
#include "base/strings/stringprintf.h"
#include "ui/compositor/layer.h"
#include "ui/views/view.h"
#include "ui/views/widget/widget.h"

#if !defined(NDEBUG)
#include "base/numerics/angle_conversions.h"
#include "ui/gfx/geometry/decomposed_transform.h"
#include "ui/gfx/geometry/transform.h"
#endif

namespace views {
namespace {
void PrintFocusHierarchyImp(const View* view,
                            size_t indent,
                            std::ostringstream* out) {
  *out << std::string(indent, ' ');
  *out << view->GetClassName();
  *out << ' ';
  *out << view->GetID();
  *out << ' ';
  *out << view->GetClassName();
  *out << ' ';
  *out << view;
  *out << '\n';

  if (!view->children().empty()) {
    PrintFocusHierarchyImp(view->children().front(), indent + 2, out);
  }

  const View* next_focusable = view->GetNextFocusableView();
  if (next_focusable) {
    PrintFocusHierarchyImp(next_focusable, indent, out);
  }
}

#if !defined(NDEBUG)
std::string PrintViewGraphImpl(const View* view) {
  std::string result;

  const std::string_view class_name = view->GetClassName();
  size_t base_name_index = class_name.find_last_of('/');
  if (base_name_index == std::string::npos) {
    base_name_index = 0;
  } else {
    base_name_index++;
  }

  // Information about current node.
  result.append("  N");
  result.append(base::StringPrintf("%p", view));
  result.append(" [label=\"");

  result.append(class_name.substr(base_name_index));

  result.append(base::StringPrintf(
      "\\n bounds: (%d, %d), (%dx%d)", view->bounds().x(), view->bounds().y(),
      view->bounds().width(), view->bounds().height()));

  if (!view->GetTransform().IsIdentity()) {
    gfx::Vector2dF translation = view->GetTransform().To2dTranslation();
    gfx::Vector2dF scale = view->GetTransform().To2dScale();
    result.append(base::StringPrintf("\\n translation: (%f, %f)",
                                     translation.x(), translation.y()));
    result.append(
        base::StringPrintf("\\n scale: (%2.4f, %2.4f)", scale.x(), scale.y()));
  }

  result.append("\"");
  if (!view->parent()) {
    result.append(", shape=box");
  }
  if (view->layer()) {
    if (view->layer()->has_external_content()) {
      result.append(", color=green");
    } else {
      result.append(", color=red");
    }

    if (view->layer()->fills_bounds_opaquely()) {
      result.append(", style=filled");
    }
  }
  result.append("]\n");

  // Link to parent.
  if (view->parent()) {
    result.append(base::StringPrintf(" N%p -> N%p\n", view->parent(), view));
  }

  for (const View* child : view->children()) {
    result.append(PrintViewGraphImpl(child));
  }

  return result;
}
#endif

}  // namespace

void PrintWidgetInformation(const Widget& widget,
                            bool detailed,
                            std::ostringstream* out) {
  *out << " name=" << widget.GetName();
  *out << " (" << &widget << ")";

  if (widget.parent()) {
    *out << " parent=" << widget.parent();
  } else {
    *out << " parent=none";
  }

  const ui::Layer* layer = widget.GetLayer();
  if (layer) {
    *out << " layer=" << layer;
  } else {
    *out << " layer=none";
  }

  *out << (widget.is_top_level() ? " [top_level]" : " [!top_level]");

  if (detailed) {
    *out << (widget.IsActive() ? " [active]" : " [!active]");
    *out << (widget.IsVisible() ? " [visible]" : " [!visible]");
  }

  *out << (widget.IsClosed() ? " [closed]" : "");
  *out << (widget.IsMaximized() ? " [maximized]" : "");
  *out << (widget.IsMinimized() ? " [minimized]" : "");
  *out << (widget.IsFullscreen() ? " [fullscreen]" : "");

  if (detailed) {
    *out << " " << widget.GetWindowBoundsInScreen().ToString();
  }

  *out << '\n';
}

void PrintFocusHierarchy(const View* view) {
  std::ostringstream out;
  out << "Focus hierarchy:\n";
  PrintFocusHierarchyImp(view, 0, &out);
  // Error so users in the field can generate and upload logs.
  LOG(ERROR) << out.str();
}

#if !defined(NDEBUG)
std::string PrintViewGraph(const View* view) {
  return "digraph {\n" + PrintViewGraphImpl(view) + "}\n";
}
#endif

}  // namespace views