Mark printing code as basic printing and/or print preview code.

components/printing/common/print_messages.h

 // Copyright (c) 2012 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.
 
 // IPC messages for printing.
 // Multiply-included message file, hence no include guard.
 
 #include <stdint.h>
 
 #include <string>
@@ skipping 52 matching lines @@
   PrintMsg_PrintPages_Params();
   ~PrintMsg_PrintPages_Params();
 
   // Resets the members of the struct to 0.
   void Reset();
 
   PrintMsg_Print_Params params;
   std::vector<int> pages;
 };
 
+#if defined(ENABLE_PRINT_PREVIEW)
 struct PrintHostMsg_RequestPrintPreview_Params {
   PrintHostMsg_RequestPrintPreview_Params();
   ~PrintHostMsg_RequestPrintPreview_Params();
   bool is_modifiable;
   bool webnode_only;
   bool has_selection;
   bool selection_only;
 };
 
 struct PrintHostMsg_SetOptionsFromDocument_Params {
   PrintHostMsg_SetOptionsFromDocument_Params();
   ~PrintHostMsg_SetOptionsFromDocument_Params();
 
   bool is_scaling_disabled;
   int copies;
   printing::DuplexMode duplex;
   printing::PageRanges page_ranges;
 };
+#endif  // defined(ENABLE_PRINT_PREVIEW)
 
 #endif  // COMPONENTS_PRINTING_COMMON_PRINT_MESSAGES_H_
 
 #define IPC_MESSAGE_START PrintMsgStart
 
 IPC_ENUM_TRAITS_MAX_VALUE(blink::WebPrintScalingOption,
                           blink::WebPrintScalingOptionLast)
 
 // Parameters for a render request.
 IPC_STRUCT_TRAITS_BEGIN(PrintMsg_Print_Params)
@@ skipping 67 matching lines @@
 IPC_STRUCT_BEGIN(PrintMsg_PrintPage_Params)
   // Parameters to render the page as a printed page. It must always be the same
   // value for all the document.
   IPC_STRUCT_MEMBER(PrintMsg_Print_Params, params)
 
   // The page number is the indicator of the square that should be rendered
   // according to the layout specified in PrintMsg_Print_Params.
   IPC_STRUCT_MEMBER(int, page_number)
 IPC_STRUCT_END()
 
+IPC_STRUCT_TRAITS_BEGIN(printing::PageRange)
+  IPC_STRUCT_TRAITS_MEMBER(from)
+  IPC_STRUCT_TRAITS_MEMBER(to)
+IPC_STRUCT_TRAITS_END()
+
+#if defined(ENABLE_PRINT_PREVIEW)
 IPC_STRUCT_TRAITS_BEGIN(PrintHostMsg_RequestPrintPreview_Params)
   IPC_STRUCT_TRAITS_MEMBER(is_modifiable)
   IPC_STRUCT_TRAITS_MEMBER(webnode_only)
   IPC_STRUCT_TRAITS_MEMBER(has_selection)
   IPC_STRUCT_TRAITS_MEMBER(selection_only)
 IPC_STRUCT_TRAITS_END()
 
-IPC_STRUCT_TRAITS_BEGIN(printing::PageRange)
-  IPC_STRUCT_TRAITS_MEMBER(from)
-  IPC_STRUCT_TRAITS_MEMBER(to)
-IPC_STRUCT_TRAITS_END()
-
 IPC_STRUCT_TRAITS_BEGIN(PrintHostMsg_SetOptionsFromDocument_Params)
   // Specifies whether print scaling is enabled or not.
   IPC_STRUCT_TRAITS_MEMBER(is_scaling_disabled)
 
   // Specifies number of copies to be printed.
   IPC_STRUCT_TRAITS_MEMBER(copies)
 
   // Specifies paper handling option.
   IPC_STRUCT_TRAITS_MEMBER(duplex)
 
   // Specifies page range to be printed.
   IPC_STRUCT_TRAITS_MEMBER(page_ranges)
 IPC_STRUCT_TRAITS_END()
+#endif  // defined(ENABLE_PRINT_PREVIEW)
 
 IPC_STRUCT_TRAITS_BEGIN(printing::PageSizeMargins)
   IPC_STRUCT_TRAITS_MEMBER(content_width)
   IPC_STRUCT_TRAITS_MEMBER(content_height)
   IPC_STRUCT_TRAITS_MEMBER(margin_left)
   IPC_STRUCT_TRAITS_MEMBER(margin_right)
   IPC_STRUCT_TRAITS_MEMBER(margin_top)
   IPC_STRUCT_TRAITS_MEMBER(margin_bottom)
 IPC_STRUCT_TRAITS_END()
 
 IPC_STRUCT_TRAITS_BEGIN(PrintMsg_PrintPages_Params)
   // Parameters to render the page as a printed page. It must always be the same
   // value for all the document.
   IPC_STRUCT_TRAITS_MEMBER(params)
 
   // If empty, this means a request to render all the printed pages.
   IPC_STRUCT_TRAITS_MEMBER(pages)
 IPC_STRUCT_TRAITS_END()
 
+#if defined(ENABLE_PRINT_PREVIEW)
 // Parameters to describe a rendered document.
 IPC_STRUCT_BEGIN(PrintHostMsg_DidPreviewDocument_Params)
   // A shared memory handle to metafile data.
   IPC_STRUCT_MEMBER(base::SharedMemoryHandle, metafile_data_handle)
 
   // Size of metafile data.
   IPC_STRUCT_MEMBER(uint32_t, data_size)
 
   // Cookie for the document to ensure correctness.
   IPC_STRUCT_MEMBER(int, document_cookie)
@@ skipping 33 matching lines @@
 
   // Indicates whether the previewed document is modifiable.
   IPC_STRUCT_MEMBER(bool, is_modifiable)
 
   // The id of the preview request.
   IPC_STRUCT_MEMBER(int, preview_request_id)
 
   // Indicates whether the existing preview data needs to be cleared or not.
   IPC_STRUCT_MEMBER(bool, clear_preview_data)
 IPC_STRUCT_END()
+#endif  // defined(ENABLE_PRINT_PREVIEW)
 
 // Parameters to describe a rendered page.
 IPC_STRUCT_BEGIN(PrintHostMsg_DidPrintPage_Params)
   // A shared memory handle to the EMF data. This data can be quite large so a
   // memory map needs to be used.
   IPC_STRUCT_MEMBER(base::SharedMemoryHandle, metafile_data_handle)
 
   // Size of the metafile data.
   IPC_STRUCT_MEMBER(uint32_t, data_size)
 
@@ skipping 17 matching lines @@
   IPC_STRUCT_MEMBER(int, cookie)
   IPC_STRUCT_MEMBER(int, expected_pages_count)
   IPC_STRUCT_MEMBER(bool, has_selection)
   IPC_STRUCT_MEMBER(bool, is_scripted)
   IPC_STRUCT_MEMBER(printing::MarginType, margin_type)
 IPC_STRUCT_END()
 
 
 // Messages sent from the browser to the renderer.
 
+#if defined(ENABLE_PRINT_PREVIEW)
 // Tells the render view to initiate print preview for the entire document.
 IPC_MESSAGE_ROUTED1(PrintMsg_InitiatePrintPreview, bool /* selection_only */)
+#endif  // defined(ENABLE_PRINT_PREVIEW)
 
 // Tells the render frame to initiate printing or print preview for a particular
 // node, depending on which mode the render frame is in.
 IPC_MESSAGE_ROUTED0(PrintMsg_PrintNodeUnderContextMenu)
 
+#if defined(ENABLE_BASIC_PRINTING) && defined(ENABLE_PRINT_PREVIEW)
 // Tells the renderer to print the print preview tab's PDF plugin without
 // showing the print dialog. (This is the final step in the print preview
 // workflow.)
 IPC_MESSAGE_ROUTED1(PrintMsg_PrintForPrintPreview,
                     base::DictionaryValue /* settings */)
+#endif  // defined(ENABLE_BASIC_PRINTING) && defined(ENABLE_PRINT_PREVIEW)
 
 #if defined(ENABLE_BASIC_PRINTING)
 // Tells the render view to switch the CSS to print media type, renders every
 // requested pages and switch back the CSS to display media type.
 IPC_MESSAGE_ROUTED0(PrintMsg_PrintPages)
 
 // Like PrintMsg_PrintPages, but using the print preview document's frame/node.
 IPC_MESSAGE_ROUTED0(PrintMsg_PrintForSystemDialog)
-#endif  // ENABLE_BASIC_PRINTING
+#endif  // defined(ENABLE_BASIC_PRINTING)
 
 // Tells the render view that printing is done so it can clean up.
 IPC_MESSAGE_ROUTED1(PrintMsg_PrintingDone,
                     bool /* success */)
 
 // Tells the render view whether scripted printing is blocked or not.
 IPC_MESSAGE_ROUTED1(PrintMsg_SetScriptedPrintingBlocked,
                     bool /* blocked */)
 
+#if defined(ENABLE_PRINT_PREVIEW)
 // Tells the render view to switch the CSS to print media type, renders every
 // requested pages for print preview using the given |settings|. This gets
 // called multiple times as the user updates settings.
 IPC_MESSAGE_ROUTED1(PrintMsg_PrintPreview,
                     base::DictionaryValue /* settings */)
+#endif  // defined(ENABLE_PRINT_PREVIEW)
 
 // Messages sent from the renderer to the browser.
 
 #if defined(OS_WIN)
 // Duplicates a shared memory handle from the renderer to the browser. Then
 // the renderer can flush the handle.
 IPC_SYNC_MESSAGE_ROUTED1_1(PrintHostMsg_DuplicateSection,
                            base::SharedMemoryHandle /* renderer handle */,
                            base::SharedMemoryHandle /* browser handle */)
 #endif
@@ skipping 45 matching lines @@
 #if defined(OS_ANDROID)
 // Asks the browser to create a temporary file for the renderer to fill
 // in resulting PdfMetafileSkia in printing.
 IPC_SYNC_MESSAGE_CONTROL1_2(PrintHostMsg_AllocateTempFileForPrinting,
                             int /* render_view_id */,
                             base::FileDescriptor /* temp file fd */,
                             int /* fd in browser*/)  // Used only by Chrome OS.
 IPC_MESSAGE_CONTROL2(PrintHostMsg_TempFileForPrintingWritten,
                      int /* render_view_id */,
                      int /* fd in browser */)  // Used only by Chrome OS.
-#endif
+#endif  // defined(OS_ANDROID)
 
+#if defined(ENABLE_PRINT_PREVIEW)
 // Asks the browser to do print preview.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_RequestPrintPreview,
                     PrintHostMsg_RequestPrintPreview_Params /* params */)
 
 // Notify the browser the number of pages in the print preview document.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_DidGetPreviewPageCount,
                     PrintHostMsg_DidGetPreviewPageCount_Params /* params */)
 
 // Notify the browser of the default page layout according to the currently
 // selected printer and page size.
 // |printable_area_in_points| Specifies the printable area in points.
 // |has_custom_page_size_style| is true when the printing frame has a custom
 // page size css otherwise false.
 IPC_MESSAGE_ROUTED3(PrintHostMsg_DidGetDefaultPageLayout,
                     printing::PageSizeMargins /* page layout in points */,
                     gfx::Rect /* printable area in points */,
                     bool /* has custom page size style */)
 
 // Notify the browser a print preview page has been rendered.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_DidPreviewPage,
                     PrintHostMsg_DidPreviewPage_Params /* params */)
 
 // Asks the browser whether the print preview has been cancelled.
 IPC_SYNC_MESSAGE_ROUTED2_1(PrintHostMsg_CheckForCancel,
                            int32_t /* PrintPreviewUI ID */,
                            int /* request id */,
                            bool /* print preview cancelled */)
 
-// This is sent when there are invalid printer settings.
-IPC_MESSAGE_ROUTED0(PrintHostMsg_ShowInvalidPrinterSettingsError)
-
 // Sends back to the browser the complete rendered document (non-draft mode,
 // used for printing) that was requested by a PrintMsg_PrintPreview message.
 // The memory handle in this message is already valid in the browser process.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_MetafileReadyForPrinting,
                     PrintHostMsg_DidPreviewDocument_Params /* params */)
+#endif  // defined(ENABLE_PRINT_PREVIEW)
+
+// This is sent when there are invalid printer settings.
+IPC_MESSAGE_ROUTED0(PrintHostMsg_ShowInvalidPrinterSettingsError)
 
 // Tell the browser printing failed.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintingFailed,
                     int /* document cookie */)
 
+#if defined(ENABLE_PRINT_PREVIEW)
 // Tell the browser print preview failed.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintPreviewFailed,
                     int /* document cookie */)
 
 // Tell the browser print preview was cancelled.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintPreviewCancelled,
                     int /* document cookie */)
 
 // Tell the browser print preview found the selected printer has invalid
 // settings (which typically caused by disconnected network printer or printer
 // driver is bogus).
 IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintPreviewInvalidPrinterSettings,
                     int /* document cookie */)
 
 // Run a nested message loop in the renderer until print preview for
 // window.print() finishes.
 IPC_SYNC_MESSAGE_ROUTED0_0(PrintHostMsg_SetupScriptedPrintPreview)
 
 // Tell the browser to show the print preview, when the document is sufficiently
 // loaded such that the renderer can determine whether it is modifiable or not.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_ShowScriptedPrintPreview,
                     bool /* is_modifiable */)
 
 // Notify the browser to set print presets based on source PDF document.
 IPC_MESSAGE_ROUTED1(PrintHostMsg_SetOptionsFromDocument,
                     PrintHostMsg_SetOptionsFromDocument_Params /* params */)
+#endif  // defined(ENABLE_PRINT_PREVIEW)