print_settings.cc 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428
  1. // Copyright (c) 2012 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. #include "printing/print_settings.h"
  5. #include "base/atomic_sequence_num.h"
  6. #include "base/notreached.h"
  7. #include "build/build_config.h"
  8. #include "printing/units.h"
  9. #if defined(USE_CUPS) && (BUILDFLAG(IS_MAC) || BUILDFLAG(IS_CHROMEOS))
  10. #include <cups/cups.h>
  11. #endif
  12. #if BUILDFLAG(IS_WIN)
  13. #include "printing/mojom/print.mojom.h"
  14. #endif
  15. namespace printing {
  16. mojom::ColorModel ColorModeToColorModel(int color_mode) {
  17. if (color_mode < static_cast<int>(mojom::ColorModel::kUnknownColorModel) ||
  18. color_mode > static_cast<int>(mojom::ColorModel::kColorModelLast))
  19. return mojom::ColorModel::kUnknownColorModel;
  20. return static_cast<mojom::ColorModel>(color_mode);
  21. }
  22. #if defined(USE_CUPS)
  23. void GetColorModelForModel(mojom::ColorModel color_model,
  24. std::string* color_setting_name,
  25. std::string* color_value) {
  26. #if BUILDFLAG(IS_MAC)
  27. constexpr char kCUPSColorMode[] = "ColorMode";
  28. constexpr char kCUPSColorModel[] = "ColorModel";
  29. constexpr char kCUPSPrintoutMode[] = "PrintoutMode";
  30. constexpr char kCUPSProcessColorModel[] = "ProcessColorModel";
  31. constexpr char kCUPSBrotherMonoColor[] = "BRMonoColor";
  32. constexpr char kCUPSBrotherPrintQuality[] = "BRPrintQuality";
  33. constexpr char kCUPSEpsonInk[] = "Ink";
  34. constexpr char kCUPSSharpARCMode[] = "ARCMode";
  35. constexpr char kCUPSXeroxXRXColor[] = "XRXColor";
  36. #else
  37. constexpr char kCUPSColorMode[] = "cups-ColorMode";
  38. constexpr char kCUPSColorModel[] = "cups-ColorModel";
  39. constexpr char kCUPSPrintoutMode[] = "cups-PrintoutMode";
  40. constexpr char kCUPSProcessColorModel[] = "cups-ProcessColorModel";
  41. constexpr char kCUPSBrotherMonoColor[] = "cups-BRMonoColor";
  42. constexpr char kCUPSBrotherPrintQuality[] = "cups-BRPrintQuality";
  43. constexpr char kCUPSEpsonInk[] = "cups-Ink";
  44. constexpr char kCUPSSharpARCMode[] = "cups-ARCMode";
  45. constexpr char kCUPSXeroxXRXColor[] = "cups-XRXColor";
  46. #endif // BUILDFLAG(IS_MAC)
  47. *color_setting_name = kCUPSColorModel;
  48. switch (color_model) {
  49. case mojom::ColorModel::kUnknownColorModel:
  50. *color_value = kGrayscale;
  51. break;
  52. case mojom::ColorModel::kGray:
  53. *color_value = kGray;
  54. break;
  55. case mojom::ColorModel::kColor:
  56. *color_value = kColor;
  57. break;
  58. case mojom::ColorModel::kCMYK:
  59. *color_value = kCMYK;
  60. break;
  61. case mojom::ColorModel::kCMY:
  62. *color_value = kCMY;
  63. break;
  64. case mojom::ColorModel::kKCMY:
  65. *color_value = kKCMY;
  66. break;
  67. case mojom::ColorModel::kCMYPlusK:
  68. *color_value = kCMY_K;
  69. break;
  70. case mojom::ColorModel::kBlack:
  71. *color_value = kBlack;
  72. break;
  73. case mojom::ColorModel::kGrayscale:
  74. *color_value = kGrayscale;
  75. break;
  76. case mojom::ColorModel::kRGB:
  77. *color_value = kRGB;
  78. break;
  79. case mojom::ColorModel::kRGB16:
  80. *color_value = kRGB16;
  81. break;
  82. case mojom::ColorModel::kRGBA:
  83. *color_value = kRGBA;
  84. break;
  85. case mojom::ColorModel::kColorModeColor:
  86. *color_setting_name = kCUPSColorMode;
  87. *color_value = kColor;
  88. break;
  89. case mojom::ColorModel::kColorModeMonochrome:
  90. *color_setting_name = kCUPSColorMode;
  91. *color_value = kMonochrome;
  92. break;
  93. case mojom::ColorModel::kHPColorColor:
  94. *color_setting_name = kColor;
  95. *color_value = kColor;
  96. break;
  97. case mojom::ColorModel::kHPColorBlack:
  98. *color_setting_name = kColor;
  99. *color_value = kBlack;
  100. break;
  101. case mojom::ColorModel::kPrintoutModeNormal:
  102. *color_setting_name = kCUPSPrintoutMode;
  103. *color_value = kNormal;
  104. break;
  105. case mojom::ColorModel::kPrintoutModeNormalGray:
  106. *color_setting_name = kCUPSPrintoutMode;
  107. *color_value = kNormalGray;
  108. break;
  109. case mojom::ColorModel::kProcessColorModelCMYK:
  110. *color_setting_name = kCUPSProcessColorModel;
  111. *color_value = kCMYK;
  112. break;
  113. case mojom::ColorModel::kProcessColorModelGreyscale:
  114. *color_setting_name = kCUPSProcessColorModel;
  115. *color_value = kGreyscale;
  116. break;
  117. case mojom::ColorModel::kProcessColorModelRGB:
  118. *color_setting_name = kCUPSProcessColorModel;
  119. *color_value = kRGB;
  120. break;
  121. case mojom::ColorModel::kBrotherCUPSColor:
  122. *color_setting_name = kCUPSBrotherMonoColor;
  123. *color_value = kFullColor;
  124. break;
  125. case mojom::ColorModel::kBrotherCUPSMono:
  126. *color_setting_name = kCUPSBrotherMonoColor;
  127. *color_value = kMono;
  128. break;
  129. case mojom::ColorModel::kBrotherBRScript3Color:
  130. *color_setting_name = kCUPSBrotherPrintQuality;
  131. *color_value = kColor;
  132. break;
  133. case mojom::ColorModel::kBrotherBRScript3Black:
  134. *color_setting_name = kCUPSBrotherPrintQuality;
  135. *color_value = kBlack;
  136. break;
  137. case mojom::ColorModel::kEpsonInkColor:
  138. *color_setting_name = kCUPSEpsonInk;
  139. *color_value = kEpsonColor;
  140. break;
  141. case mojom::ColorModel::kEpsonInkMono:
  142. *color_setting_name = kCUPSEpsonInk;
  143. *color_value = kEpsonMono;
  144. break;
  145. case mojom::ColorModel::kSharpARCModeCMColor:
  146. *color_setting_name = kCUPSSharpARCMode;
  147. *color_value = kSharpCMColor;
  148. break;
  149. case mojom::ColorModel::kSharpARCModeCMBW:
  150. *color_setting_name = kCUPSSharpARCMode;
  151. *color_value = kSharpCMBW;
  152. break;
  153. case mojom::ColorModel::kXeroxXRXColorAutomatic:
  154. *color_setting_name = kCUPSXeroxXRXColor;
  155. *color_value = kXeroxAutomatic;
  156. break;
  157. case mojom::ColorModel::kXeroxXRXColorBW:
  158. *color_setting_name = kCUPSXeroxXRXColor;
  159. *color_value = kXeroxBW;
  160. break;
  161. }
  162. // The default case is excluded from the above switch statement to ensure that
  163. // all ColorModel values are determinantly handled.
  164. }
  165. #if BUILDFLAG(IS_MAC) || BUILDFLAG(IS_CHROMEOS)
  166. std::string GetIppColorModelForModel(mojom::ColorModel color_model) {
  167. // Accept `kUnknownColorModel` for consistency with GetColorModelForModel().
  168. if (color_model == mojom::ColorModel::kUnknownColorModel)
  169. return CUPS_PRINT_COLOR_MODE_MONOCHROME;
  170. absl::optional<bool> is_color = IsColorModelSelected(color_model);
  171. if (!is_color.has_value()) {
  172. NOTREACHED();
  173. return std::string();
  174. }
  175. return is_color.value() ? CUPS_PRINT_COLOR_MODE_COLOR
  176. : CUPS_PRINT_COLOR_MODE_MONOCHROME;
  177. }
  178. #endif // BUILDFLAG(IS_MAC) || BUILDFLAG(IS_CHROMEOS)
  179. #endif // defined(USE_CUPS)
  180. absl::optional<bool> IsColorModelSelected(mojom::ColorModel color_model) {
  181. switch (color_model) {
  182. case mojom::ColorModel::kColor:
  183. case mojom::ColorModel::kCMYK:
  184. case mojom::ColorModel::kCMY:
  185. case mojom::ColorModel::kKCMY:
  186. case mojom::ColorModel::kCMYPlusK:
  187. case mojom::ColorModel::kRGB:
  188. case mojom::ColorModel::kRGB16:
  189. case mojom::ColorModel::kRGBA:
  190. case mojom::ColorModel::kColorModeColor:
  191. case mojom::ColorModel::kHPColorColor:
  192. case mojom::ColorModel::kPrintoutModeNormal:
  193. case mojom::ColorModel::kProcessColorModelCMYK:
  194. case mojom::ColorModel::kProcessColorModelRGB:
  195. case mojom::ColorModel::kBrotherCUPSColor:
  196. case mojom::ColorModel::kBrotherBRScript3Color:
  197. case mojom::ColorModel::kEpsonInkColor:
  198. case mojom::ColorModel::kSharpARCModeCMColor:
  199. case mojom::ColorModel::kXeroxXRXColorAutomatic:
  200. return true;
  201. case mojom::ColorModel::kGray:
  202. case mojom::ColorModel::kBlack:
  203. case mojom::ColorModel::kGrayscale:
  204. case mojom::ColorModel::kColorModeMonochrome:
  205. case mojom::ColorModel::kHPColorBlack:
  206. case mojom::ColorModel::kPrintoutModeNormalGray:
  207. case mojom::ColorModel::kProcessColorModelGreyscale:
  208. case mojom::ColorModel::kBrotherCUPSMono:
  209. case mojom::ColorModel::kBrotherBRScript3Black:
  210. case mojom::ColorModel::kEpsonInkMono:
  211. case mojom::ColorModel::kSharpARCModeCMBW:
  212. case mojom::ColorModel::kXeroxXRXColorBW:
  213. return false;
  214. case mojom::ColorModel::kUnknownColorModel:
  215. NOTREACHED();
  216. return absl::nullopt;
  217. }
  218. // The default case is excluded from the above switch statement to ensure that
  219. // all ColorModel values are determinantly handled.
  220. }
  221. // Global SequenceNumber used for generating unique cookie values.
  222. static base::AtomicSequenceNumber cookie_seq;
  223. PrintSettings::PrintSettings() {
  224. Clear();
  225. }
  226. PrintSettings::PrintSettings(const PrintSettings& settings) {
  227. *this = settings;
  228. }
  229. PrintSettings& PrintSettings::operator=(const PrintSettings& settings) {
  230. if (this == &settings)
  231. return *this;
  232. ranges_ = settings.ranges_;
  233. selection_only_ = settings.selection_only_;
  234. margin_type_ = settings.margin_type_;
  235. title_ = settings.title_;
  236. url_ = settings.url_;
  237. display_header_footer_ = settings.display_header_footer_;
  238. should_print_backgrounds_ = settings.should_print_backgrounds_;
  239. collate_ = settings.collate_;
  240. color_ = settings.color_;
  241. copies_ = settings.copies_;
  242. duplex_mode_ = settings.duplex_mode_;
  243. device_name_ = settings.device_name_;
  244. requested_media_ = settings.requested_media_;
  245. page_setup_device_units_ = settings.page_setup_device_units_;
  246. dpi_ = settings.dpi_;
  247. scale_factor_ = settings.scale_factor_;
  248. rasterize_pdf_ = settings.rasterize_pdf_;
  249. rasterize_pdf_dpi_ = settings.rasterize_pdf_dpi_;
  250. landscape_ = settings.landscape_;
  251. supports_alpha_blend_ = settings.supports_alpha_blend_;
  252. #if BUILDFLAG(IS_WIN)
  253. printer_language_type_ = settings.printer_language_type_;
  254. #endif
  255. is_modifiable_ = settings.is_modifiable_;
  256. pages_per_sheet_ = settings.pages_per_sheet_;
  257. #if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
  258. for (const auto& item : settings.advanced_settings_)
  259. advanced_settings_.emplace(item.first, item.second.Clone());
  260. #endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
  261. #if BUILDFLAG(IS_CHROMEOS)
  262. send_user_info_ = settings.send_user_info_;
  263. username_ = settings.username_;
  264. pin_value_ = settings.pin_value_;
  265. #endif // BUILDFLAG(IS_CHROMEOS)
  266. return *this;
  267. }
  268. PrintSettings::~PrintSettings() = default;
  269. void PrintSettings::Clear() {
  270. ranges_.clear();
  271. selection_only_ = false;
  272. margin_type_ = mojom::MarginType::kDefaultMargins;
  273. title_.clear();
  274. url_.clear();
  275. display_header_footer_ = false;
  276. should_print_backgrounds_ = false;
  277. collate_ = false;
  278. color_ = mojom::ColorModel::kUnknownColorModel;
  279. copies_ = 0;
  280. duplex_mode_ = mojom::DuplexMode::kUnknownDuplexMode;
  281. device_name_.clear();
  282. requested_media_ = RequestedMedia();
  283. page_setup_device_units_.Clear();
  284. dpi_ = gfx::Size();
  285. scale_factor_ = 1.0f;
  286. rasterize_pdf_ = false;
  287. rasterize_pdf_dpi_ = 0;
  288. landscape_ = false;
  289. supports_alpha_blend_ = true;
  290. #if BUILDFLAG(IS_WIN)
  291. printer_language_type_ = mojom::PrinterLanguageType::kNone;
  292. #endif
  293. is_modifiable_ = true;
  294. pages_per_sheet_ = 1;
  295. #if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
  296. advanced_settings_.clear();
  297. #endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
  298. #if BUILDFLAG(IS_CHROMEOS)
  299. send_user_info_ = false;
  300. username_.clear();
  301. pin_value_.clear();
  302. #endif // BUILDFLAG(IS_CHROMEOS)
  303. }
  304. void PrintSettings::SetPrinterPrintableArea(
  305. const gfx::Size& physical_size_device_units,
  306. const gfx::Rect& printable_area_device_units,
  307. bool landscape_needs_flip) {
  308. int units_per_inch = device_units_per_inch();
  309. int header_footer_text_height = 0;
  310. if (display_header_footer_) {
  311. // Hard-code text_height = 0.5cm = ~1/5 of inch.
  312. header_footer_text_height = ConvertUnit(kSettingHeaderFooterInterstice,
  313. kPointsPerInch, units_per_inch);
  314. }
  315. PageMargins margins;
  316. bool small_paper_size = false;
  317. switch (margin_type_) {
  318. case mojom::MarginType::kDefaultMargins: {
  319. // Default margins 1.0cm = ~2/5 of an inch, unless a page dimension is
  320. // less than 2.54 cm = ~1 inch, in which case set the margins in that
  321. // dimension to 0.
  322. static constexpr double kCmInMicrons = 10000;
  323. int margin_printer_units =
  324. ConvertUnit(kCmInMicrons, kMicronsPerInch, units_per_inch);
  325. int min_size_printer_units = units_per_inch;
  326. margins.header = header_footer_text_height;
  327. margins.footer = header_footer_text_height;
  328. if (physical_size_device_units.height() > min_size_printer_units) {
  329. margins.top = margin_printer_units;
  330. margins.bottom = margin_printer_units;
  331. } else {
  332. margins.top = 0;
  333. margins.bottom = 0;
  334. small_paper_size = true;
  335. }
  336. if (physical_size_device_units.width() > min_size_printer_units) {
  337. margins.left = margin_printer_units;
  338. margins.right = margin_printer_units;
  339. } else {
  340. margins.left = 0;
  341. margins.right = 0;
  342. small_paper_size = true;
  343. }
  344. break;
  345. }
  346. case mojom::MarginType::kNoMargins:
  347. case mojom::MarginType::kPrintableAreaMargins: {
  348. margins.header = 0;
  349. margins.footer = 0;
  350. margins.top = 0;
  351. margins.bottom = 0;
  352. margins.left = 0;
  353. margins.right = 0;
  354. break;
  355. }
  356. case mojom::MarginType::kCustomMargins: {
  357. margins.header = 0;
  358. margins.footer = 0;
  359. margins.top = ConvertUnit(requested_custom_margins_in_points_.top,
  360. kPointsPerInch, units_per_inch);
  361. margins.bottom = ConvertUnit(requested_custom_margins_in_points_.bottom,
  362. kPointsPerInch, units_per_inch);
  363. margins.left = ConvertUnit(requested_custom_margins_in_points_.left,
  364. kPointsPerInch, units_per_inch);
  365. margins.right = ConvertUnit(requested_custom_margins_in_points_.right,
  366. kPointsPerInch, units_per_inch);
  367. break;
  368. }
  369. default: {
  370. NOTREACHED();
  371. }
  372. }
  373. if ((margin_type_ == mojom::MarginType::kDefaultMargins ||
  374. margin_type_ == mojom::MarginType::kPrintableAreaMargins) &&
  375. !small_paper_size) {
  376. page_setup_device_units_.SetRequestedMargins(margins);
  377. } else {
  378. page_setup_device_units_.ForceRequestedMargins(margins);
  379. }
  380. page_setup_device_units_.Init(physical_size_device_units,
  381. printable_area_device_units,
  382. header_footer_text_height);
  383. if (landscape_ && landscape_needs_flip)
  384. page_setup_device_units_.FlipOrientation();
  385. }
  386. void PrintSettings::SetCustomMargins(
  387. const PageMargins& requested_margins_in_points) {
  388. requested_custom_margins_in_points_ = requested_margins_in_points;
  389. margin_type_ = mojom::MarginType::kCustomMargins;
  390. }
  391. int PrintSettings::NewCookie() {
  392. // A cookie of 0 is used to mark a document as unassigned, count from 1.
  393. return cookie_seq.GetNext() + 1;
  394. }
  395. void PrintSettings::SetOrientation(bool landscape) {
  396. if (landscape_ != landscape) {
  397. landscape_ = landscape;
  398. page_setup_device_units_.FlipOrientation();
  399. }
  400. }
  401. } // namespace printing