Consistent content placement method for dom-distiller

components/dom_distiller/core/viewer.h

 // 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.
 
 #ifndef COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_
 #define COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
 #include "components/dom_distiller/core/distilled_page_prefs.h"
 #include "ui/gfx/geometry/size.h"
 
 namespace dom_distiller {
 
 class DistilledArticleProto;
 class DistilledPageProto;
 class DomDistillerServiceInterface;
 class ViewerHandle;
 class ViewRequestDelegate;
 
 namespace viewer {
 
-// Returns a full HTML page based on the given |article_proto|. This is supposed
-// to be displayed to the end user. The returned HTML should be considered
-// unsafe, so callers must ensure rendering it does not compromise Chrome.
-const std::string GetUnsafeArticleHtml(
-    const DistilledArticleProto* article_proto,
-    const DistilledPagePrefs::Theme theme,
-    const DistilledPagePrefs::FontFamily font_family);
-
-// Returns the base Viewer HTML page based on the given |page_proto|. This is
+// Returns an HTML template page based on the given |page_proto| which provides
+// basic information about the page (i.e. title, text direction, etc.). This is
 // supposed to be displayed to the end user. The returned HTML should be
 // considered unsafe, so callers must ensure rendering it does not compromise
-// Chrome. The difference from |GetUnsafeArticleHtml| is that this can be used
-// for displaying an in-flight distillation instead of waiting for the full
-// article.
-const std::string GetUnsafePartialArticleHtml(
+// Chrome.
+const std::string GetUnsafeArticleTemplateHtml(
     const DistilledPageProto* page_proto,
     const DistilledPagePrefs::Theme theme,
     const DistilledPagePrefs::FontFamily font_family);
 
+// Returns the JavaScript to place a full article's HTML on the page. The
+// returned HTML should be considered unsafe, so callers must ensure
+// rendering it does not compromise Chrome.
+const std::string GetUnsafeArticleContentJs(
+    const DistilledArticleProto* article_proto);
+
 // Returns a JavaScript blob for updating a partial view request with additional
 // distilled content. Meant for use when viewing a slow or long multi-page
 // article. |is_last_page| indicates whether this is the last page of the
 // article.
 const std::string GetUnsafeIncrementalDistilledPageJs(
     const DistilledPageProto* page_proto,
     const bool is_last_page);
 
+// Returns a JavaScript blob for updating a view request with error page
+// contents.
+const std::string GetErrorPageJs();
+
 // Returns a JavaScript blob for controlling the "in-progress" indicator when
 // viewing a partially-distilled page. |is_last_page| indicates whether this is
 // the last page of the article (i.e. loading indicator should be removed).
 const std::string GetToggleLoadingIndicatorJs(const bool is_last_page);
 
 // Returns a full HTML page which displays a generic error.
 const std::string GetErrorPageHtml(
     const DistilledPagePrefs::Theme theme,
     const DistilledPagePrefs::FontFamily font_family);
 
@@ skipping 16 matching lines @@
     DistilledPagePrefs::FontFamily font);
 
 // Returns JavaScript corresponding to setting a specific theme.
 const std::string GetDistilledPageThemeJs(DistilledPagePrefs::Theme theme);
 
 }  // namespace viewer
 
 }  // namespace dom_distiller
 
 #endif  // COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_