Added Header and Footer support using Skia

chrome/renderer/print_web_view_helper.h

 // 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.
 
 #ifndef CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 #define CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
 #pragma once
 
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
 #include "base/shared_memory.h"
 #include "base/time.h"
 #include "content/renderer/render_view_observer.h"
 #include "content/renderer/render_view_observer_tracker.h"
 #include "printing/metafile.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrameClient.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebViewClient.h"
 #include "ui/gfx/size.h"
 
 struct PrintMsg_Print_Params;
 struct PrintMsg_PrintPage_Params;
 struct PrintMsg_PrintPages_Params;
 
 namespace base {
 class DictionaryValue;
 }
+namespace skia {
+class VectorCanvas;
+class VectorPlatformDeviceSkia;
+}
+template <typename t> class SkRefPtr;
 
 // Class that calls the Begin and End print functions on the frame and changes
 // the size of the view temporarily to support full page printing..
 // Do not serve any events in the time between construction and destruction of
 // this class because it will cause flicker.
 class PrepareFrameAndViewForPrint {
  public:
   // Prints |frame|.  If |node| is not NULL, then only that node will be
   // printed.
   PrepareFrameAndViewForPrint(const PrintMsg_Print_Params& print_params,
@@ skipping 31 matching lines @@
 // Struct that holds margin and content area information of a page.
 typedef struct PageSizeMargins {
   double content_width;
   double content_height;
   double margin_top;
   double margin_right;
   double margin_bottom;
   double margin_left;
 } PageSizeMargins;
 
+// Given the |device| and |canvas| to draw on, prints the appropriate headers
+// and footers using strings from |header_footer_info| on to the canvas.
+void PrintHeaderAndFooter(skia::VectorPlatformDeviceSkia* device,

[Chris Guillory, 2011/07/26 00:10:45]

Optional: PrintHeaderAndFooterForPage?

[Aayush Kumar, 2011/07/26 01:55:41]

I feel that the function name becomes really long, and, since it's called from
PrintPageInternal, it's somewhat obvious it's printing the headers and footers
for that page.
On 2011/07/26 00:10:45, Chris Guillory wrote:

+                          const SkRefPtr<skia::VectorCanvas>& canvas,

[Chris Guillory, 2011/07/26 00:10:45]

Can we remove the SkRefPtr usage here.

[Aayush Kumar, 2011/07/26 01:55:41]

Done.

+                          int page_number, int total_pages,

[Chris Guillory, 2011/07/26 00:10:45]

Can you place these arguments on separate lines. 

[Aayush Kumar, 2011/07/26 01:55:41]

Done.

+                          float webkit_scale_factor,
+                          PageSizeMargins& page_layout_in_points,

[Chris Guillory, 2011/07/26 00:10:45]

Can this be const.

[Aayush Kumar, 2011/07/26 01:55:41]

Done.

+                          const base::DictionaryValue* header_footer_info);
+
 // PrintWebViewHelper handles most of the printing grunt work for RenderView.
 // We plan on making print asynchronous and that will require copying the DOM
 // of the document and creating a new WebView with the contents.
 class PrintWebViewHelper : public RenderViewObserver,
                            public RenderViewObserverTracker<PrintWebViewHelper>,
                            public WebKit::WebViewClient,
                            public WebKit::WebFrameClient {
  public:
   explicit PrintWebViewHelper(RenderView* render_view);
   virtual ~PrintWebViewHelper();
@@ skipping 110 matching lines @@
   // It will implicitly revert the document to display CSS media type.
   bool PrintPages(const PrintMsg_PrintPages_Params& params,
                   WebKit::WebFrame* frame,
                   WebKit::WebNode* node);
 
   // Prints the page listed in |params|.
 #if defined(USE_X11)
   void PrintPageInternal(const PrintMsg_PrintPage_Params& params,
                          const gfx::Size& canvas_size,
                          WebKit::WebFrame* frame,
-                         printing::Metafile* metafile);
+                         printing::Metafile* metafile,
+                         bool is_preview);
 #else
   void PrintPageInternal(const PrintMsg_PrintPage_Params& params,
                          const gfx::Size& canvas_size,
                          WebKit::WebFrame* frame);
 #endif
 
   // Render the frame for printing.
   bool RenderPagesForPrint(WebKit::WebFrame* frame, WebKit::WebNode* node);
 
   // Platform specific helper function for rendering page(s) to |metafile|.
 #if defined(OS_WIN)
   void RenderPage(const PrintMsg_Print_Params& params, float* scale_factor,
                   int page_number, bool is_preview, WebKit::WebFrame* frame,
                   scoped_ptr<printing::Metafile>* metafile);
 #elif defined(OS_MACOSX)
   void RenderPage(const gfx::Size& page_size, const gfx::Rect& content_area,
                   const float& scale_factor, int page_number,
-                  WebKit::WebFrame* frame, printing::Metafile* metafile);
+                  WebKit::WebFrame* frame, printing::Metafile* metafile,
+                  bool is_preview);
 #elif defined(OS_POSIX)
   bool RenderPages(const PrintMsg_PrintPages_Params& params,
                    WebKit::WebFrame* frame, WebKit::WebNode* node,
                    int* page_count, printing::Metafile* metafile);
 #endif  // defined(OS_WIN)
 
   // Helper methods -----------------------------------------------------------
 
   bool CopyAndPrint(WebKit::WebFrame* web_frame);
 
@@ skipping 45 matching lines @@
   // Used for scripted initiated printing blocking.
   base::Time last_cancelled_script_print_;
   int user_cancelled_scripted_print_count_;
 
   // Let the browser process know of a printing failure. Only set to false when
   // the failure came from the browser in the first place.
   bool notify_browser_of_print_failure_;
 
   scoped_ptr<PrintMsg_PrintPages_Params> old_print_pages_params_;
 
+  // Contains strings generated by the browser process to be printed as headers
+  // and footers if requested by the user.
+  base::DictionaryValue* header_footer_info_;
+
   // Keeps track of the state of print preview between messages.
   class PrintPreviewContext {
    public:
     PrintPreviewContext();
     ~PrintPreviewContext();
 
     // Initializes the print preview context. Need to be called to set
     // the |web_frame| / |web_node| to generate the print preview for.
     void InitWithFrame(WebKit::WebFrame* web_frame);
     void InitWithNode(const WebKit::WebNode& web_node);
@@ skipping 68 matching lines @@
 
     State state_;
   };
 
   PrintPreviewContext print_preview_context_;
 
   DISALLOW_COPY_AND_ASSIGN(PrintWebViewHelper);
 };
 
 #endif  // CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_