Convert NavigationEntry title to string16. TabContents::GetTitle no longer ne...

chrome/browser/tab_contents/navigation_entry.h

 // Copyright (c) 2006-2008 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.
 
 #ifndef CHROME_BROWSER_NAVIGATION_ENTRY_H_
 #define CHROME_BROWSER_NAVIGATION_ENTRY_H_
 
 #include "base/basictypes.h"
 #include "base/scoped_ptr.h"
 #include "base/string_util.h"
 #include "chrome/browser/tab_contents/security_style.h"
 #include "chrome/browser/tab_contents/site_instance.h"
 #include "chrome/browser/tab_contents/tab_contents_type.h"
 #include "chrome/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "grit/theme_resources.h"
 #include "skia/include/SkBitmap.h"
 
+class NavigationController;
+
 ////////////////////////////////////////////////////////////////////////////////
 //
 // NavigationEntry class
 //
 // A NavigationEntry is a data structure that captures all the information
 // required to recreate a browsing state. This includes some opaque binary
 // state as provided by the TabContents as well as some clear text title and
 // URL which is used for our user interface.
 //
 ////////////////////////////////////////////////////////////////////////////////
@@ skipping 133 matching lines @@
   };
 
   // ---------------------------------------------------------------------------
 
   explicit NavigationEntry(TabContentsType type);
   NavigationEntry(TabContentsType type,
                   SiteInstance* instance,
                   int page_id,
                   const GURL& url,
                   const GURL& referrer,
-                  const std::wstring& title,
+                  const string16& title,
                   PageTransition::Type transition_type);
   ~NavigationEntry() {
   }
 
   // Page-related stuff --------------------------------------------------------
 
   // A unique ID is preserved across commits and redirects, which means that
   // sometimes a NavigationEntry's unique ID needs to be set (e.g. when
   // creating a committed entry to correspond to a to-be-deleted pending entry,
   // the pending entry's ID must be copied).
@@ skipping 31 matching lines @@
   }
   PageType page_type() const {
     return page_type_;
   }
 
   // The actual URL of the page. For some about pages, this may be a scary
   // data: URL or something like that. Use display_url() below for showing to
   // the user.
   void set_url(const GURL& url) {
     url_ = url;
-    if (display_url_.is_empty()) {
-      // If there is no explicit display URL, then we'll display this URL.
-      display_url_as_string_ = UTF8ToWide(url_.spec());
-    }
+    cached_display_title_.clear();
   }
   const GURL& url() const {
     return url_;
   }
 
   // The referring URL. Can be empty.
   void set_referrer(const GURL& referrer) {
     referrer_ = referrer;
   }
   const GURL& referrer() const {
     return referrer_;
   }
 
   // The display URL, when nonempty, will override the actual URL of the page
   // when we display it to the user. This allows us to have nice and friendly
   // URLs that the user sees for things like about: URLs, but actually feed
   // the renderer a data URL that results in the content loading.
   //
   // display_url() will return the URL to display to the user in all cases, so
   // if there is no overridden display URL, it will return the actual one.
   void set_display_url(const GURL& url) {
     display_url_ = (url == url_) ? GURL() : url;
-    display_url_as_string_ = UTF8ToWide(url.spec());
+    cached_display_title_.clear();
   }
   bool has_display_url() const {
     return !display_url_.is_empty();
   }
   const GURL& display_url() const {
     return display_url_.is_empty() ? url_ : display_url_;
   }
 
   // The title as set by the page. This will be empty if there is no title set.
   // The caller is responsible for detecting when there is no title and
   // displaying the appropriate "Untitled" label if this is being displayed to
   // the user.
-  void set_title(const std::wstring& title) {
+  void set_title(const string16& title) {
     title_ = title;
+    cached_display_title_.clear();
   }
-  const std::wstring& title() const {
+  const string16& title() const {
     return title_;
   }
 
   // The favicon data and tracking information. See FaviconStatus above.
   const FaviconStatus& favicon() const {
     return favicon_;
   }
   FaviconStatus& favicon() {
     return favicon_;
   }
@@ skipping 29 matching lines @@
     return ssl_;
   }
   SSLStatus& ssl() {
     return ssl_;
   }
 
   // Page-related helpers ------------------------------------------------------
 
   // Returns the title to be displayed on the tab. This could be the title of
   // the page if it is available or the URL.
-  const std::wstring& GetTitleForDisplay();
+  //
+  // The NavigationController corresponding to this entry must be given so we
+  // can get the preferences so we can optionally format a URL for display. It
+  // may be NULL if you don't need proper URL formatting (e.g. unit tests).
+  const string16& GetTitleForDisplay(const NavigationController* controller);
 
   // Returns true if the current tab is in view source mode. This will be false
   // if there is no navigation.
   bool IsViewSourceMode() const;
 
   // Tracking stuff ------------------------------------------------------------
 
   // The transition type indicates what the user did to move to this page from
   // the previous page.
   void set_transition_type(PageTransition::Type transition_type) {
@@ skipping 49 matching lines @@
   // update SessionService/TabRestoreService appropriately.
   // WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 
   // See the accessors above for descriptions.
   int unique_id_;
   TabContentsType tab_type_;
   scoped_refptr<SiteInstance> site_instance_;
   PageType page_type_;
   GURL url_;
   GURL referrer_;
-
   GURL display_url_;
-
-  // We cache a copy of the display URL as a string so we don't have to
-  // convert the display URL to a wide string every time we paint.
-  std::wstring display_url_as_string_;
-
-  std::wstring title_;
+  string16 title_;
   FaviconStatus favicon_;
   std::string content_state_;
   int32 page_id_;
   SSLStatus ssl_;
   PageTransition::Type transition_type_;
   GURL user_typed_url_;
   bool has_post_data_;
   bool restored_;
 
+  // This is a cached version of the result of GetTitleForDisplay. It prevents
+  // us from having to do URL formatting on the URL evey time the title is
+  // displayed. When the URL, display URL, or title is set, this should be
+  // cleared to force a refresh.
+  string16 cached_display_title_;
+
   // Copy and assignment is explicitly allowed for this class.
 };
 
 #endif  // CHROME_BROWSER_NAVIGATION_ENTRY_H_