components/dom_distiller/core/viewer.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_
   6 #define COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/compiler_specific.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/strings/string16.h"
  14 #include "components/dom_distiller/core/distilled_page_prefs.h"
  15 #include "ui/gfx/geometry/size.h"
  16
  17 namespace dom_distiller {
  18
  19 class DistilledArticleProto;
  20 class DistilledPageProto;
  21 class DomDistillerServiceInterface;
  22 class ViewerHandle;
  23 class ViewRequestDelegate;
  24
  25 namespace viewer {
  26
  27 // Returns the JavaScript to show the feedback footer for a distilled page.
  28 const std::string GetShowFeedbackFormJs();
  29
  30 // Returns a full HTML page based on the given |article_proto|. This is supposed
  31 // to be displayed to the end user. The returned HTML should be considered
  32 // unsafe, so callers must ensure rendering it does not compromise Chrome.
  33 const std::string GetUnsafeArticleHtml(
  34     const DistilledArticleProto* article_proto,
  35     const DistilledPagePrefs::Theme theme,
  36     const DistilledPagePrefs::FontFamily font_family);
  37
  38 // Returns an HTML template page based on the given |page_proto| which provides
  39 // basic information about the page (i.e. title, text direction, etc.). This is
  40 // supposed to be displayed to the end user. The returned HTML should be
  41 // considered unsafe, so callers must ensure rendering it does not compromise
  42 // Chrome.
  43 const std::string GetUnsafeArticleTemplateHtml(
  44     const DistilledPageProto* page_proto,
  45     const DistilledPagePrefs::Theme theme,
  46     const DistilledPagePrefs::FontFamily font_family);
  47
  48 // Returns the JavaScript to place a full article's HTML on the page. The
  49 // returned HTML should be considered unsafe, so callers must ensure
  50 // rendering it does not compromise Chrome.
  51 const std::string GetUnsafeArticleContentJs(
  52     const DistilledArticleProto* article_proto);
  53
  54 // Returns a JavaScript blob for updating a partial view request with additional
  55 // distilled content. Meant for use when viewing a slow or long multi-page
  56 // article. |is_last_page| indicates whether this is the last page of the
  57 // article.
  58 const std::string GetUnsafeIncrementalDistilledPageJs(
  59     const DistilledPageProto* page_proto,
  60     const bool is_last_page);
  61
  62 // Returns a JavaScript blob for updating a view request with error page
  63 // contents.
  64 const std::string GetErrorPageJs();
  65
  66 // Returns a JavaScript blob for controlling the "in-progress" indicator when
  67 // viewing a partially-distilled page. |is_last_page| indicates whether this is
  68 // the last page of the article (i.e. loading indicator should be removed).
  69 const std::string GetToggleLoadingIndicatorJs(const bool is_last_page);
  70
  71 // Returns a full HTML page which displays a generic error.
  72 const std::string GetErrorPageHtml(
  73     const DistilledPagePrefs::Theme theme,
  74     const DistilledPagePrefs::FontFamily font_family);
  75
  76 // Returns the default CSS to be used for a viewer.
  77 const std::string GetCss();
  78
  79 // Returns the default JS to be used for a viewer.
  80 const std::string GetJavaScript();
  81
  82 // Based on the given path, calls into the DomDistillerServiceInterface for
  83 // viewing distilled content based on the |path|.
  84 scoped_ptr<ViewerHandle> CreateViewRequest(
  85     DomDistillerServiceInterface* dom_distiller_service,
  86     const std::string& path,
  87     ViewRequestDelegate* view_request_delegate,
  88     const gfx::Size& render_view_size);
  89
  90 // Returns JavaScript coresponding to setting the font family.
  91 const std::string GetDistilledPageFontFamilyJs(
  92     DistilledPagePrefs::FontFamily font);
  93
  94 // Returns JavaScript corresponding to setting a specific theme.
  95 const std::string GetDistilledPageThemeJs(DistilledPagePrefs::Theme theme);
  96
  97 }  // namespace viewer
  98
  99 }  // namespace dom_distiller
 100
 101 #endif  // COMPONENTS_DOM_DISTILLER_CORE_VIEWER_H_