View API/implementation cleanup:...

ui/views/view.cc

Index: ui/views/view.cc
===================================================================
--- ui/views/view.cc	(revision 75141)
+++ ui/views/view.cc	(working copy)
@@ -64,23 +64,30 @@
 
 View::~View() {
   if (parent_)
-    parent_->RemoveChildView(this);
+    parent_->RemoveChildView(this, false);
 
-  ViewVector::const_iterator it = children_.begin();
-  for (; it != children_.end(); ++it) {
-    (*it)->parent_ = NULL;
-    if ((*it)->parent_owned())
-      delete *it;
+  for (Views::const_iterator i(children_begin()); i != children_.end(); ++i) {
+    (*i)->parent_ = NULL;
+    if ((*i)->parent_owned())
+      delete *i;
   }
 }
 
 // Size and disposition --------------------------------------------------------
 
-void View::SetBounds(int x, int y, int width, int height) {
-  SetBoundsRect(gfx::Rect(x, y, std::max(0, width), std::max(0, height)));
+gfx::Rect View::GetVisibleBounds() const {
+  // TODO(beng):
+  return bounds();
 }
 
-void View::SetBoundsRect(const gfx::Rect& bounds) {
+gfx::Rect View::GetContentsBounds() const {
+  gfx::Rect rect(gfx::Point(), size());
+  if (border_.get())
+    rect.Inset(border_->insets());
+  return rect;
+}
+
+void View::SetBounds(const gfx::Rect& bounds) {
   gfx::Rect old_bounds = bounds_;
   bounds_ = bounds;
   // TODO(beng): investigate usage of needs_layout_ in old View code.
@@ -90,33 +97,18 @@
   }
 }
 
-gfx::Rect View::GetVisibleBounds() const {
-  // TODO(beng):
-  return bounds();
+void View::SetOrigin(const gfx::Point& origin) {
+  SetBounds(gfx::Rect(origin, size()));
 }
 
 void View::SetSize(const gfx::Size& size) {
-  SetBounds(x(), y(), size.width(), size.height());
+  SetBounds(gfx::Rect(origin(), size));
 }
 
-void View::SetPosition(const gfx::Point& position) {
-  SetBounds(position.x(), position.y(), width(), height());
-}
-
 void View::SetBorder(Border* border) {
   border_.reset(border);
 }
 
-gfx::Rect View::GetContentsBounds() const {
-  if (border_.get()) {
-    return gfx::Rect(
-        border_->insets().left(), border_->insets().top(),
-        width() - border_->insets().right() - border_->insets().left(),
-        height() - border_->insets().bottom() - border_->insets().top());
-  }
-  return gfx::Rect(0, 0, width(), height());
-}
-
 void View::OnBoundsChanged() {
 }
 
@@ -133,14 +125,12 @@
 }
 
 void View::Layout() {
+  // The layout manager handles all child layout if present.
   if (layout_manager_.get()) {
-    // Layout Manager handles laying out children.
     layout_manager_->Layout(this);
   } else {
-    // We handle laying out our own children.
-    ViewVector::iterator it = children_.begin();
-    for (; it != children_.end(); ++it)
-      (*it)->Layout();
+    std::for_each(children_begin(), children_end(),
+                  std::mem_fun(&View::Layout));
   }
   // TODO(beng): needs_layout_? SchedulePaint()?
 }
@@ -148,7 +138,6 @@
 void View::SetVisible(bool visible) {
   if (visible != visible_) {
     visible_ = visible;
-
     // InvaldateRect() checks for view visibility before proceeding, so we need
     // to ask the parent to invalidate our bounds.
     if (parent_)
@@ -165,24 +154,22 @@
 
 // Attributes ------------------------------------------------------------------
 
-View* View::GetViewById(int id) const {
+View* View::GetViewByID(int id) {
   if (id_ == id)
-    return const_cast<View*>(this);
-  ViewVector::const_iterator it = children_.begin();
-  for (; it != children_.end(); ++it) {
-    View* view = (*it)->GetViewById(id);
+    return this;
+  for (Views::const_iterator i(children_begin()); i != children_end(); ++i) {
+    View* view = (*i)->GetViewByID(id);
     if (view)
       return view;
   }
   return NULL;
 }
 
-void View::GetViewsWithGroup(int group, ViewVector* vec) const {
+void View::GetViewsInGroup(int group, Views* vec) {
   if (group_ == group)
     vec->push_back(const_cast<View*>(this));
-  ViewVector::const_iterator it = children_.begin();
-  for (; it != children_.end(); ++it)
-    (*it)->GetViewsWithGroup(group, vec);
+  for (Views::const_iterator i(children_begin()); i != children_end(); ++i)
+    (*i)->GetViewsInGroup(group, vec);
 }
 
 View* View::GetSelectedViewForGroup(int group_id) {
@@ -193,64 +180,63 @@
 // Coordinate conversion -------------------------------------------------------
 
 // static
-void View::ConvertPointToView(View* source, View* target, gfx::Point* point) {
-  View* inner = NULL;
-  View* outer = NULL;
-  if (source->Contains(target)) {
-    inner = target;
-    outer = source;
-  } else if (target->Contains(source)) {
-    inner = source;
-    outer = target;
-  } // Note that we cannot do a plain "else" here since |source| and |target|
-    // may be in different hierarchies with no relation.
+void View::ConvertPointToView(const View& source,
+                              const View& target,
+                              gfx::Point* point) {
+  const View* inner = NULL;
+  const View* outer = NULL;
+  if (source.Contains(target)) {
+    inner = &target;
+    outer = &source;
+  } else if (target.Contains(source)) {
+    inner = &source;
+    outer = &target;
+  }  // Note that we cannot do a plain "else" here since |source| and |target|
+     // may be in different hierarchies with no relation.
+  if (!inner)
+    return;
 
-  if (inner && outer) {
-    gfx::Point offset;
-    View* temp = inner;
-    while (temp != outer) {
-      offset.Offset(temp->x(), temp->y());
-      temp = temp->parent();
-    }
-    // When target is contained by source, we need to subtract the offset.
-    // When source is contained by target, we need to add the fofset.
-    int multiplier = inner == target ? -1 : 1;
-    point->Offset(multiplier * offset.x(), multiplier * offset.y());
-  }
+  gfx::Point offset;
+  for (const View* v = inner; v != outer; v = v->parent())
+    offset.Offset(v->x(), v->y());
+  // When target is contained by source, we need to subtract the offset.
+  // When source is contained by target, we need to add the offset.
+  int multiplier = (inner == &target) ? -1 : 1;
+  point->Offset(multiplier * offset.x(), multiplier * offset.y());
 }
 
 // static
-void View::ConvertPointToScreen(View* source, gfx::Point* point) {
-  Widget* widget = source->GetWidget();
+void View::ConvertPointToScreen(const View& source, gfx::Point* point) {
+  const Widget* widget = source.GetWidget();
   if (widget) {
     ConvertPointToWidget(source, point);
-    gfx::Rect r = widget->GetClientAreaScreenBounds();
-    point->Offset(r.x(), r.y());
+    gfx::Point client_origin(widget->GetClientAreaScreenBounds().origin());
+    point->Offset(client_origin.x(), client_origin.y());
   }
 }
 
 // static
-void View::ConvertPointToWidget(View* source, gfx::Point* point) {
-  for (View* v = source; v; v = v->parent())
+void View::ConvertPointToWidget(const View& source, gfx::Point* point) {
+  for (const View* v = &source; v; v = v->parent())
     point->Offset(v->x(), v->y());
 }
 
 // Tree operations -------------------------------------------------------------
 
-Widget* View::GetWidget() const {
-  return parent_ ? parent_->GetWidget() : NULL;
+const Widget* View::GetWidget() const {
+  return parent() ? parent()->GetWidget() : NULL;
 }
 
 void View::AddChildView(View* view) {
-  AddChildViewAt(view, children_.size());
+  AddChildViewAt(view, children_size());
 }
 
 void View::AddChildViewAt(View* view, size_t index) {
-  CHECK(view != this) << "A view cannot be its own child.";
+  CHECK_NE(this, view) << "A view cannot be its own child.";
 
   // Remove the child from its current parent if any.
   if (view->parent())
-    view->parent()->RemoveChildView(view);
+    view->parent()->RemoveChildView(view, false);
 
   // TODO(beng): Move focus initialization to FocusManager.
   InitFocusSiblings(view, index);
@@ -259,48 +245,36 @@
   view->parent_ = this;
 
   // Notify the hierarchy.
-  NotifyHierarchyChanged(this, view, true);
+  NotifyHierarchyChanged(view, true);
 
   // TODO(beng): Notify other objects like tooltip, layout manager, etc.
   //             Figure out RegisterChildrenForVisibleBoundsNotification.
 }
 
-View* View::RemoveChildView(View* view) {
-  ViewVector::iterator it = find(children_.begin(), children_.end(), view);
-  if (it != children_.end()) {
-    View* old_parent = view->parent_;
-    view->parent_ = NULL;
-    children_.erase(it);
-    NotifyHierarchyChanged(old_parent, view, false);
-  }
-
+void View::RemoveChildView(View* view, bool delete_child) {
+  Views::const_iterator i(std::find(children_begin(), children_end(), view));
+  DCHECK(i != children_end());
+  view->parent_ = NULL;
+  children_.erase(i);
+  NotifyHierarchyChanged(view, false);
   // TODO(beng): Notify other objects like tooltip, layout manager, etc.
-  return view;
+  if (delete_child)
+    delete view;
 }
 
 void View::RemoveAllChildViews(bool delete_children) {
-  // TODO(beng): use for_each.
-  ViewVector::iterator it = children_.begin();
-  while (it != children_.end()) {
-    View* v = RemoveChildView(*it);
-    if (delete_children)
-      delete v;
+  while (!children_.empty()) {
+    RemoveChildView(children_.front(), delete_children);
     // TODO(beng): view deletion is actually more complicated in the old view.cc
     //             figure out why. (it uses a ScopedVector to accumulate a list
     //             of views to delete).
   }
 }
 
-View* View::GetChildViewAt(size_t index) {
-  CHECK(index < child_count());
-  return children_[index];
-}
-
-bool View::Contains(View* child) {
-  while (child) {
-    if (child == this)
+bool View::Contains(const View& child) const {
+  for (const View* v = &child; v; v = v->parent()) {
+    if (v == this)
       return true;
-    child = child->parent();
   }
   return false;
 }
@@ -308,15 +282,12 @@
 // Painting --------------------------------------------------------------------
 
 void View::Invalidate() {
-  InvalidateRect(gfx::Rect(0, 0, width(), height()));
+  InvalidateRect(gfx::Rect(gfx::Point(), size()));
 }
 
 void View::InvalidateRect(const gfx::Rect& invalid_rect) {
-  if (!visible_)
-    return;
-
-  if (parent_) {
-    gfx::Rect r = invalid_rect;
+  if (visible_ && parent_) {
+    gfx::Rect r(invalid_rect);
     r.Offset(bounds_.origin());
     parent_->InvalidateRect(r);
   }
@@ -326,7 +297,7 @@
 
 bool View::HitTest(const gfx::Point& point) const {
   // TODO(beng): Hit test mask support.
-  return gfx::Rect(0, 0, width(), height()).Contains(point);
+  return gfx::Rect(gfx::Point(), size()).Contains(point);
 }
 
 // Accelerators ----------------------------------------------------------------
@@ -342,41 +313,42 @@
 
 // Focus -----------------------------------------------------------------------
 
-FocusManager* View::GetFocusManager() const {
-  Widget* widget = GetWidget();
+FocusManager* View::GetFocusManager() {
+  return const_cast<FocusManager*>(static_cast<const View*>(this)->
+      GetFocusManager());

[Ben Goodger (Google), 2011/02/18 19:02:28]

Why do you define this here but the GetWidget one you inline in the header?

[Peter Kasting, 2011/02/18 19:09:43]

See the comments about "GetWidget()" in my change description.

+}
+
+const FocusManager* View::GetFocusManager() const {
+  const Widget* widget = GetWidget();
   return widget ? widget->GetFocusManager() : NULL;
 }
 
-FocusTraversable* View::GetFocusTraversable() const {
+FocusTraversable* View::GetFocusTraversable() {
   return NULL;
 }
 
-View* View::GetNextFocusableView() const {
+View* View::GetNextFocusableView() {
   return NULL;
 }
 
-View* View::GetPreviousFocusableView() const {
+View* View::GetPreviousFocusableView() {
   return NULL;
 }
 
-bool View::IsFocusable() const {
-  return focusable_ && enabled_ && visible_;
-}
-
 bool View::HasFocus() const {
-  FocusManager* focus_manager = GetFocusManager();
-  return focus_manager ? focus_manager->focused_view() == this : false;
+  const FocusManager* focus_manager = GetFocusManager();
+  return focus_manager ? (focus_manager->focused_view() == this) : false;
 }
 
 void View::RequestFocus() {
   FocusManager* focus_manager = GetFocusManager();
-  if (focus_manager && focus_manager->focused_view() != this)
+  if (focus_manager && (focus_manager->focused_view() != this))
     focus_manager->SetFocusedView(this);
 }
 
 // Resources -------------------------------------------------------------------
 
-ThemeProvider* View::GetThemeProvider() const {
+ThemeProvider* View::GetThemeProvider() {
   Widget* widget = GetWidget();
   return widget ? widget->GetThemeProvider() : NULL;
 }
@@ -386,10 +358,10 @@
 
 // Tree operations -------------------------------------------------------------
 
-void View::OnViewAdded(View* parent, View* child) {
+void View::OnViewAdded(const View& parent, const View& child) {
 }
 
-void View::OnViewRemoved(View* parent, View* child) {
+void View::OnViewRemoved(const View& parent, const View& child) {
 }
 
 void View::OnViewAddedToWidget() {
@@ -401,12 +373,8 @@
 // Painting --------------------------------------------------------------------
 
 void View::PaintChildren(gfx::Canvas* canvas) {
-  // TODO(beng): use for_each.
-  // std::for_each(children_.begin(), children_.end(),
-  //              std::bind2nd(std::mem_fun_ref(&View::Paint), canvas));
-  ViewVector::iterator it = children_.begin();
-  for (; it != children_.end(); ++it)
-    (*it)->Paint(canvas);
+  std::for_each(children_begin(), children_end(),
+                std::bind2nd(std::mem_fun(&View::Paint), canvas));
 }
 
 void View::OnPaint(gfx::Canvas* canvas) {
@@ -421,7 +389,7 @@
 
 void View::OnPaintBorder(gfx::Canvas* canvas) {
   if (border_.get())
-    border_->Paint(const_cast<const View*>(this), canvas);
+    border_->Paint(this, canvas);
 }
 
 void View::OnPaintFocusBorder(gfx::Canvas* canvas) {
@@ -429,23 +397,21 @@
 
 // Input -----------------------------------------------------------------------
 
-View* View::GetEventHandlerForPoint(const gfx::Point& point) const {
-  ViewVector::const_reverse_iterator it = children_.rbegin();
-  for (; it != children_.rend(); ++it) {
-    View* child = *it;
-    if (!child->visible())
-      continue;
-
-    gfx::Point point_in_child_coords(point);
-    View::ConvertPointToView(const_cast<View*>(this), child,
-                             &point_in_child_coords);
-    if (child->HitTest(point_in_child_coords))
-      return child->GetEventHandlerForPoint(point_in_child_coords);
+View* View::GetEventHandlerForPoint(const gfx::Point& point) {
+  for (Views::const_reverse_iterator i(children_rbegin()); i != children_rend();
+       ++i) {
+    View* child = *i;
+    if (child->visible()) {
+      gfx::Point point_in_child_coords(point);
+      View::ConvertPointToView(*this, *child, &point_in_child_coords);
+      if (child->HitTest(point_in_child_coords))
+        return child->GetEventHandlerForPoint(point_in_child_coords);
+    }
   }
-  return const_cast<View*>(this);
+  return this;
 }
 
-gfx::NativeCursor View::GetCursorForPoint(const gfx::Point& point) {
+gfx::NativeCursor View::GetCursorForPoint(const gfx::Point& point) const {
   return NULL;
 }
 
@@ -507,7 +473,7 @@
 
 bool View::IsFocusableInRootView() const {
   // TODO(beng): kill this, replace with direct check in focus manager.
-  return IsFocusable();
+  return is_focusable();
 }
 
 bool View::IsAccessibilityFocusableInRootView() const {
@@ -515,7 +481,7 @@
   return false;
 }
 
-FocusTraversable* View::GetPaneFocusTraversable() const {
+FocusTraversable* View::GetPaneFocusTraversable() {
   // TODO(beng): figure out what to do about this.
   return NULL;
 }
@@ -541,55 +507,39 @@
 
 // Tree operations -------------------------------------------------------------
 
-void View::NotifyHierarchyChanged(View* parent, View* child, bool is_add) {
-  // Notify the child. Note that we call GetWidget() on the parent, not the
-  // child, since this method is called after the child is already removed from
-  // the hierarchy when |is_add| is false and so child->GetWidget() will always
-  // return NULL.
-  bool has_widget = parent->GetWidget() != NULL;
-  CallViewNotification(child, parent, child, is_add, has_widget);
-
+void View::NotifyHierarchyChanged(View* child, bool is_add) {
   // Notify the hierarchy up.
-  NotifyHierarchyChangedUp(parent, child, is_add);
+  for (View* v = parent(); v; v = v->parent())
+    CallViewNotification(v, *child, is_add, false);
 
   // Notify the hierarchy down.
+  bool has_widget = GetWidget() != NULL;
   if (!is_add) {
     // Because |child| has already been removed from |parent|'s child list, we
     // need to notify its hierarchy manually.
-    child->NotifyHierarchyChangedDown(parent, child, is_add, has_widget);
+    child->NotifyHierarchyChangedDown(*child, is_add, has_widget);
   }
-  NotifyHierarchyChangedDown(parent, child, is_add, has_widget);
+  NotifyHierarchyChangedDown(*child, is_add, has_widget);
 }
 
-void View::NotifyHierarchyChangedUp(View* parent, View* child, bool is_add) {
-  for (View* v = parent; v; v = v->parent()) {
-    if (is_add)
-      v->OnViewAdded(parent, child);
-    else
-      v->OnViewRemoved(parent, child);
-  }
+void View::NotifyHierarchyChangedDown(const View& child,
+                                      bool is_add,
+                                      bool has_widget) {
+  CallViewNotification(this, child, is_add, has_widget);
+  for (Views::const_iterator i(children_begin()); i != children_end(); ++i)
+    (*i)->NotifyHierarchyChangedDown(child, is_add, has_widget);
 }
 
-void View::NotifyHierarchyChangedDown(View* parent, View* child, bool is_add,
-                                       bool has_widget) {
-  ViewVector::iterator it = children_.begin();
-  for (; it != children_.end(); ++it) {
-    CallViewNotification(*it, parent, child, is_add, has_widget);
-    (*it)->NotifyHierarchyChangedDown(parent, child, is_add, has_widget);
-  }
-}
-
 void View::CallViewNotification(View* target,
-                                View* parent,
-                                View* child,
+                                const View& child,
                                 bool is_add,
                                 bool has_widget) {
   if (is_add) {
-    target->OnViewAdded(parent, child);
+    target->OnViewAdded(*this, child);
     if (has_widget)
       target->OnViewAddedToWidget();
   } else {
-    target->OnViewRemoved(parent, child);
+    target->OnViewRemoved(*this, child);
     if (has_widget)
       target->OnViewRemovedFromWidget();
   }
@@ -620,16 +570,12 @@
   if (!enabled_)
     return handled;
 
-  int drag_operations =
-      enabled_ && event.IsOnlyLeftMouseButton() && HitTest(event.location()) ?
-      GetDragOperations(event.location()) : DragDropTypes::DRAG_NONE;
-  if (drag_operations != DragDropTypes::DRAG_NONE) {
-    drag_info->PossibleDrag(event.location());
-    return true;
-  }
-  bool has_context_menu = event.IsRightMouseButton() ?
-      !!context_menu_controller_ : NULL;
-  return has_context_menu || handled;
+  if (!event.IsOnlyLeftMouseButton() || !HitTest(event.location()) ||
+      (GetDragOperations(event.location()) == DragDropTypes::DRAG_NONE))
+    return handled || (event.IsRightMouseButton() && context_menu_controller_);
+
+  drag_info->PossibleDrag(event.location());
+  return true;
 }
 
 bool View::MouseDragged(const MouseEvent& event, DragInfo* drag_info) {
@@ -637,15 +583,13 @@
       ExceededDragThreshold(drag_info->press_point, event.location())) {
     if (!drag_controller_ ||
         drag_controller_->CanStartDrag(this, drag_info->press_point,
-                                       event.location())) {
+                                       event.location()))
       StartShellDrag(event, drag_info->press_point);
-    }
-  } else {
-    if (OnMouseDragged(event))
-      return true;
+  } else if (OnMouseDragged(event)) {
+    return true;
   }
   // TODO(beng): Handle view deletion from OnMouseDragged().
-  return !!context_menu_controller_ || drag_info->possible_drag;
+  return context_menu_controller_ || drag_info->possible_drag;
 }
 
 void View::MouseReleased(const MouseEvent& event) {
@@ -654,7 +598,7 @@
   if (context_menu_controller_ && event.IsOnlyRightMouseButton()) {
     gfx::Point location(event.location());
     if (HitTest(location)) {
-      ConvertPointToScreen(this, &location);
+      ConvertPointToScreen(*this, &location);
       context_menu_controller_->ShowContextMenu(this, location, true);
     }
   }
@@ -664,51 +608,48 @@
 
 // TODO(beng): Move to FocusManager.
 void View::InitFocusSiblings(View* view, size_t index) {
-  if (child_count() == 0) {
+  if (children_empty()) {
     view->next_focusable_view_ = NULL;
     view->prev_focusable_view_ = NULL;
-  } else {
-    if (index == child_count()) {
-      // We are inserting at the end, but the end of the child list may not be
-      // the last focusable element. Let's try to find an element with no next
-      // focusable element to link to.
-      View* last_focusable_view = NULL;
-      for (std::vector<View*>::iterator iter = children_.begin();
-           iter != children_.end(); ++iter) {
-          if (!(*iter)->next_focusable_view_) {
-            last_focusable_view = *iter;
-            break;
-          }
-      }
-      if (last_focusable_view == NULL) {
-        // Hum... there is a cycle in the focus list. Let's just insert ourself
-        // after the last child.
-        View* prev = children_[index - 1];
-        view->prev_focusable_view_ = prev;
-        view->next_focusable_view_ = prev->next_focusable_view_;
-        prev->next_focusable_view_->prev_focusable_view_ = view;
-        prev->next_focusable_view_ = view;
-      } else {
-        last_focusable_view->next_focusable_view_ = view;
-        view->next_focusable_view_ = NULL;
-        view->prev_focusable_view_ = last_focusable_view;
-      }
-    } else {
-      View* prev = children_[index]->GetPreviousFocusableView();
-      view->prev_focusable_view_ = prev;
-      view->next_focusable_view_ = children_[index];
-      if (prev)
-        prev->next_focusable_view_ = view;
-      children_[index]->prev_focusable_view_ = view;
+    return;
+  }
+
+  if (index != children_size()) {
+    View* prev = children_[index]->GetPreviousFocusableView();
+    view->prev_focusable_view_ = prev;
+    view->next_focusable_view_ = children_[index];
+    if (prev)
+      prev->next_focusable_view_ = view;
+    children_[index]->prev_focusable_view_ = view;
+    return;
+  }
+
+  // We are inserting at the end, but the end of the child list may not be
+  // the last focusable element. Let's try to find an element with no next
+  // focusable element to link to.
+  for (Views::const_iterator i(children_begin()); i != children_end(); ++i) {
+    if (!(*i)->next_focusable_view_) {
+      (*i)->next_focusable_view_ = view;
+      view->next_focusable_view_ = NULL;
+      view->prev_focusable_view_ = *i;
+      return;
     }
   }
+
+  // Hum... there is a cycle in the focus list. Let's just insert ourself
+  // after the last child.
+  View* prev = children_[index - 1];
+  view->prev_focusable_view_ = prev;
+  view->next_focusable_view_ = prev->next_focusable_view_;
+  prev->next_focusable_view_->prev_focusable_view_ = view;
+  prev->next_focusable_view_ = view;
 }
 
 // Drag & Drop -----------------------------------------------------------------
 
 int View::GetDragOperations(const gfx::Point& point) {
   return drag_controller_ ?
-      drag_controller_->GetDragOperations(const_cast<View*>(this), point) :
+      drag_controller_->GetDragOperations(this, point) :
       DragDropTypes::DRAG_NONE;
 }