Added Header and Footer support using Skia

chrome/renderer/print_web_view_helper.cc

 // Copyright (c) 2011 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.
 
 #include "chrome/renderer/print_web_view_helper.h"
 
+#if defined(USE_SKIA)
+#include <algorithm>
+#include <cmath>
+#endif
 #include <string>
 
 #include "base/command_line.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/process_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/print_messages.h"
 #include "chrome/common/render_messages.h"
@@ skipping 12 matching lines @@
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebSize.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLRequest.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLResponse.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_POSIX)
 #include "content/common/view_messages.h"
 #endif
 
+#if defined(USE_SKIA)
+#include "base/string_number_conversions.h"
+#include "skia/ext/vector_canvas.h"
+#include "skia/ext/vector_platform_device_skia.h"
+#include "third_party/skia/include/core/SkTypeface.h"
+#endif  // USE_SKIA
+
+using base::Time;
 using printing::ConvertPixelsToPoint;
 using printing::ConvertPixelsToPointDouble;
 using printing::ConvertUnit;
 using printing::ConvertUnitDouble;
+using printing::GetDPI;
+using printing::GetSegmentWidth;
 using WebKit::WebConsoleMessage;
 using WebKit::WebDocument;
 using WebKit::WebElement;
 using WebKit::WebFrame;
 using WebKit::WebNode;
 using WebKit::WebSize;
 using WebKit::WebString;
 using WebKit::WebURLRequest;
 using WebKit::WebView;
 
 namespace {
 
 const double kMinDpi = 1.0;
 
-int GetDPI(const PrintMsg_Print_Params* print_params) {
-#if defined(OS_MACOSX)
-  // On the Mac, the printable area is in points, don't do any scaling based
-  // on dpi.
-  return printing::kPointsPerInch;
-#else
-  return static_cast<int>(print_params->dpi);
-#endif  // defined(OS_MACOSX)
-}
-
 bool PrintMsg_Print_Params_IsEmpty(const PrintMsg_Print_Params& params) {
   return !params.document_cookie && !params.desired_dpi && !params.max_shrink &&
          !params.min_shrink && !params.dpi && params.printable_size.IsEmpty() &&
          !params.selection_only && params.page_size.IsEmpty() &&
          !params.margin_top && !params.margin_left &&
          !params.supports_alpha_blend;
 }
 
 bool PrintMsg_Print_Params_IsEqual(
     const PrintMsg_PrintPages_Params& oldParams,
     const PrintMsg_PrintPages_Params& newParams) {
   return oldParams.params.desired_dpi == newParams.params.desired_dpi &&
          oldParams.params.max_shrink == newParams.params.max_shrink &&
          oldParams.params.min_shrink == newParams.params.min_shrink &&
          oldParams.params.dpi == newParams.params.dpi &&
          oldParams.params.printable_size == newParams.params.printable_size &&
          oldParams.params.selection_only == newParams.params.selection_only &&
          oldParams.params.page_size == newParams.params.page_size &&
          oldParams.params.margin_top == newParams.params.margin_top &&
          oldParams.params.margin_left == newParams.params.margin_left &&
          oldParams.params.supports_alpha_blend ==
              newParams.params.supports_alpha_blend &&
          oldParams.pages.size() == newParams.pages.size() &&
+         oldParams.params.display_header_footer ==
+             newParams.params.display_header_footer &&
          std::equal(oldParams.pages.begin(), oldParams.pages.end(),
              newParams.pages.begin());
 }
 
 void CalculatePrintCanvasSize(const PrintMsg_Print_Params& print_params,
                               gfx::Size* result) {
   int dpi = GetDPI(&print_params);
   result->set_width(ConvertUnit(print_params.printable_size.width(), dpi,
                                 print_params.desired_dpi));
 
   result->set_height(ConvertUnit(print_params.printable_size.height(), dpi,
                                  print_params.desired_dpi));
 }
 
+#if defined(USE_SKIA)
+// Given a text, the positions, and the paint object, this method gets the
+// coordinates and prints the text at those coordinates on the canvas.
+void PrintHeaderFooterText(
+    string16 text,
+    skia::VectorCanvas* canvas,
+    SkPaint paint,
+    float webkit_scale_factor,
+    const PageSizeMargins& page_layout,
+    printing::HorizontalHeaderFooterPosition horizontal_position,
+    printing::VerticalHeaderFooterPosition vertical_position,
+    SkScalar offset_to_baseline) {
+  size_t text_byte_length = text.length() * sizeof(char16);
+  // Get the (x, y) coordinate from where printing of the current text should
+  // start depending on the horizontal alignment (LEFT, RIGHT, CENTER) and
+  // vertical alignment (TOP, BOTTOM).
+  SkScalar text_width_in_points = paint.measureText(text.c_str(),
+                                                    text_byte_length);
+  SkScalar x = 0;
+  switch (horizontal_position) {
+    case printing::LEFT:
+      x = printing::kSettingHeaderFooterInterstice - page_layout.margin_left;
+      break;
+    case printing::RIGHT:
+      x = page_layout.content_width + page_layout.margin_right -
+          printing::kSettingHeaderFooterInterstice - text_width_in_points;
+      break;
+    case printing::CENTER: {
+      SkScalar available_width = GetSegmentWidth(
+          page_layout.margin_left + page_layout.margin_right +
+              page_layout.content_width);
+      x = available_width - page_layout.margin_left +
+          (available_width - text_width_in_points) / 2;
+      break;
+    }
+    default:
+      NOTREACHED();
+  }
+
+  SkScalar y = 0;
+  switch (vertical_position) {
+    case printing::TOP:
+      y = printing::kSettingHeaderFooterInterstice -
+          page_layout.margin_top - offset_to_baseline;
+      break;
+    case printing::BOTTOM:
+      y = page_layout.margin_bottom + page_layout.content_height -
+          printing::kSettingHeaderFooterInterstice - offset_to_baseline;
+      break;
+    default:
+      NOTREACHED();
+  }
+
+  x = x / webkit_scale_factor;
+  y = y / webkit_scale_factor;
+  paint.setTextSize(paint.getTextSize() / webkit_scale_factor);
+  canvas->drawText(text.c_str(), text_byte_length, x, y, paint);
+}
+
+// Prints the headers onto the |canvas| if there is enough space to print them.
+void PrintHeaders(skia::VectorCanvas* canvas,
+                  SkPaint paint,
+                  float webkit_scale_factor,
+                  const PageSizeMargins& page_layout,
+                  const DictionaryValue& header_footer_info) {
+  string16 date;
+  string16 title;
+  if (!header_footer_info.GetString(printing::kSettingHeaderFooterTitle,
+                                    &title) ||
+     !header_footer_info.GetString(printing::kSettingHeaderFooterDate,
+                                    &date)) {
+    NOTREACHED();
+  }
+  string16 header_text = date + title;
+
+  SkRect header_bounds;
+  paint.measureText(header_text.c_str(), header_text.length() * sizeof(char16),
+                    &header_bounds, 0);
+  SkScalar text_height =
+      printing::kSettingHeaderFooterInterstice + header_bounds.height();
+  if (text_height > page_layout.margin_top)
+    return;
+
+  PrintHeaderFooterText(date, canvas, paint, webkit_scale_factor, page_layout,
+                        printing::LEFT, printing::TOP, header_bounds.top());
+  PrintHeaderFooterText(title, canvas, paint, webkit_scale_factor, page_layout,
+                        printing::CENTER, printing::TOP, header_bounds.top());
+}
+
+// Prints the footers onto the |canvas| if there is enough space to print them.
+void PrintFooters(skia::VectorCanvas* canvas,

[vandebo (ex-Chrome), 2011/08/11 23:32:13]

PrintHeaders and PrintFooters don't do much.  I think you can push the content
of these two functions into PrintHeaderAndFooter with the actual calls to
PrintHeaderFooterText in if blocks.

[Aayush Kumar, 2011/08/12 08:35:40]

Done.

+                  SkPaint paint,
+                  int page_number,
+                  int total_pages,
+                  float webkit_scale_factor,
+                  const PageSizeMargins& page_layout,
+                  const DictionaryValue& header_footer_info) {
+  string16 page_of_total_pages = base::IntToString16(page_number) +
+                                 UTF8ToUTF16("/") +
+                                 base::IntToString16(total_pages);
+  string16 url;
+  if (!header_footer_info.GetString(printing::kSettingHeaderFooterURL,
+                                    &url)) {
+    NOTREACHED();
+  }
+  string16 footer_text = page_of_total_pages + url;
+
+  SkRect footer_bounds;
+  paint.measureText(footer_text.c_str(), footer_text.length() * sizeof(char16),
+                    &footer_bounds, 0);
+  SkScalar text_height =
+      printing::kSettingHeaderFooterInterstice + footer_bounds.height();
+  if (text_height > page_layout.margin_bottom)
+    return;
+
+  PrintHeaderFooterText(page_of_total_pages, canvas, paint,
+                        webkit_scale_factor, page_layout, printing::RIGHT,
+                        printing::BOTTOM, footer_bounds.bottom());
+  PrintHeaderFooterText(url, canvas, paint, webkit_scale_factor, page_layout,
+                        printing::LEFT, printing::BOTTOM, footer_bounds.bottom());
+}
+#endif  // USE_SKIA
+
 }  // namespace
 
+#if defined(USE_SKIA)
+// static - Not anonymous so that platform implementations can use it.
+void PrintWebViewHelper::PrintHeaderAndFooter(
+    SkDevice* device,
+    skia::VectorCanvas* canvas,
+    int page_number,
+    int total_pages,
+    float webkit_scale_factor,
+    const PageSizeMargins& page_layout,
+    const DictionaryValue& header_footer_info) {
+  static_cast<skia::VectorPlatformDeviceSkia*>(device)->setDrawingArea(
+      SkPDFDevice::kMargin_DrawingArea);
+
+  SkPaint paint;
+  paint.setColor(SK_ColorBLACK);
+  paint.setTextEncoding(SkPaint::kUTF16_TextEncoding);
+  paint.setTextSize(printing::kSettingHeaderFooterFontSize);
+  paint.setTypeface(SkTypeface::CreateFromName(
+      printing::kSettingHeaderFooterFontName, SkTypeface::kNormal));
+
+  PrintHeaders(canvas, paint, webkit_scale_factor, page_layout,
+               header_footer_info);
+  PrintFooters(canvas, paint, page_number, total_pages, webkit_scale_factor,
+               page_layout, header_footer_info);
+
+  static_cast<skia::VectorPlatformDeviceSkia*>(device)->setDrawingArea(
+      SkPDFDevice::kContent_DrawingArea);
+}
+#endif  // USE_SKIA
+
 PrepareFrameAndViewForPrint::PrepareFrameAndViewForPrint(
     const PrintMsg_Print_Params& print_params,
     WebFrame* frame,
     WebNode* node)
         : frame_(frame),
           web_view_(frame->view()),
           dpi_(static_cast<int>(print_params.dpi)),
           expected_pages_count_(0),
           use_browser_overlays_(true),
           finished_(false) {
@@ skipping 642 matching lines @@
     return false;
   }
   return true;
 }
 
 bool PrintWebViewHelper::UpdatePrintSettings(
     const DictionaryValue& job_settings) {
   PrintMsg_PrintPages_Params settings;
 
   Send(new PrintHostMsg_UpdatePrintSettings(routing_id(),
-      print_pages_params_->params.document_cookie, job_settings, &settings));
+       print_pages_params_->params.document_cookie, job_settings, &settings));
 
   if (settings.params.dpi < kMinDpi || !settings.params.document_cookie)
     return false;
 
   if (!UpdatePrintSettingsRequestId(job_settings, &(settings.params)))
     return false;
 
   print_pages_params_.reset(new PrintMsg_PrintPages_Params(settings));
+
+  // Getting Header and Footer settings.
+  bool display_header_footer = false;
+  if (!job_settings.GetBoolean(printing::kSettingHeaderFooterEnabled,
+                               &display_header_footer)) {
+    NOTREACHED();
+  }
+  print_pages_params_->params.display_header_footer = display_header_footer;
+  if (display_header_footer) {
+    header_footer_info_.reset(new DictionaryValue());
+    header_footer_info_->SetString(printing::kSettingHeaderFooterDate,
+                                   print_pages_params_->params.date);
+    header_footer_info_->SetString(printing::kSettingHeaderFooterURL,
+                                   print_pages_params_->params.url);
+    header_footer_info_->SetString(printing::kSettingHeaderFooterTitle,
+                                   print_pages_params_->params.title);
+  }
+
   Send(new PrintHostMsg_DidGetDocumentCookie(routing_id(),
                                              settings.params.document_cookie));
   return true;
 }
 
 bool PrintWebViewHelper::GetPrintSettingsFromUser(WebKit::WebFrame* frame,
                                                   int expected_pages_count,
                                                   bool use_browser_overlays) {
   PrintHostMsg_ScriptedPrint_Params params;
   PrintMsg_PrintPages_Params print_settings;
@@ skipping 336 matching lines @@
 const gfx::Size&
 PrintWebViewHelper::PrintPreviewContext::GetPrintCanvasSize() const {
   return prep_frame_view_->GetPrintCanvasSize();
 }
 
 void PrintWebViewHelper::PrintPreviewContext::ClearContext() {
   prep_frame_view_.reset();
   metafile_.reset();
   rendered_pages_.clear();
 }