760b6af3f4283693adee461498ae34bba1eb9b3b
[WebKit-https.git] / Source / WebCore / page / PrintContext.cpp
1 /*
2  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
3  * Copyright (C) 2007 Apple Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #include "config.h"
22 #include "PrintContext.h"
23
24 #include "GraphicsContext.h"
25 #include "Frame.h"
26 #include "FrameView.h"
27 #include "RenderLayer.h"
28 #include "RenderView.h"
29 #include <wtf/text/StringConcatenate.h>
30
31 namespace WebCore {
32
33 // By imaging to a width a little wider than the available pixels,
34 // thin pages will be scaled down a little, matching the way they
35 // print in IE and Camino. This lets them use fewer sheets than they
36 // would otherwise, which is presumably why other browsers do this.
37 // Wide pages will be scaled down more than this.
38 const float printingMinimumShrinkFactor = 1.25f;
39
40 // This number determines how small we are willing to reduce the page content
41 // in order to accommodate the widest line. If the page would have to be
42 // reduced smaller to make the widest line fit, we just clip instead (this
43 // behavior matches MacIE and Mozilla, at least)
44 const float printingMaximumShrinkFactor = 2;
45
46 PrintContext::PrintContext(Frame* frame)
47     : m_frame(frame)
48     , m_isPrinting(false)
49 {
50 }
51
52 PrintContext::~PrintContext()
53 {
54     if (m_isPrinting)
55         end();
56 }
57
58 size_t PrintContext::pageCount() const
59 {
60     return m_pageRects.size();
61 }
62
63 const IntRect& PrintContext::pageRect(size_t pageNumber) const
64 {
65     return m_pageRects[pageNumber];
66 }
67
68 void PrintContext::computePageRects(const FloatRect& printRect, float headerHeight, float footerHeight, float userScaleFactor, float& outPageHeight, bool allowHorizontalTiling)
69 {
70     m_pageRects.clear();
71     outPageHeight = 0;
72
73     if (!m_frame->document() || !m_frame->view() || !m_frame->document()->renderer())
74         return;
75
76     if (userScaleFactor <= 0) {
77         LOG_ERROR("userScaleFactor has bad value %.2f", userScaleFactor);
78         return;
79     }
80
81     RenderView* view = toRenderView(m_frame->document()->renderer());
82
83     float ratio = printRect.height() / printRect.width();
84
85     float pageWidth  = view->docWidth();
86     float pageHeight = floorf(pageWidth * ratio);
87     outPageHeight = pageHeight; // this is the height of the page adjusted by margins
88     pageHeight -= headerHeight + footerHeight;
89
90     if (pageHeight <= 0) {
91         LOG_ERROR("pageHeight has bad value %.2f", pageHeight);
92         return;
93     }
94
95     computePageRectsWithPageSizeInternal(FloatSize(pageWidth / userScaleFactor, pageHeight / userScaleFactor), allowHorizontalTiling);
96 }
97
98 void PrintContext::computePageRectsWithPageSize(const FloatSize& pageSizeInPixels, bool allowHorizontalTiling)
99 {
100     m_pageRects.clear();
101     computePageRectsWithPageSizeInternal(pageSizeInPixels, allowHorizontalTiling);
102 }
103
104 void PrintContext::computePageRectsWithPageSizeInternal(const FloatSize& pageSizeInPixels, bool allowHorizontalTiling)
105 {
106     if (!m_frame->document() || !m_frame->view() || !m_frame->document()->renderer())
107         return;
108
109     RenderView* view = toRenderView(m_frame->document()->renderer());
110
111     IntRect docRect = view->documentRect();
112
113     int pageWidth = pageSizeInPixels.width();
114     int pageHeight = pageSizeInPixels.height();
115
116     unsigned pageCount = ceilf((float)docRect.height() / pageHeight);
117     for (unsigned i = 0; i < pageCount; ++i) {
118         if (allowHorizontalTiling) {
119             for (int currentX = docRect.x(); currentX < docRect.right(); currentX += pageWidth)
120                 m_pageRects.append(IntRect(currentX, docRect.y() + i * pageHeight, pageWidth, pageHeight));
121         } else
122             m_pageRects.append(IntRect(docRect.x(), docRect.y() + i * pageHeight, pageWidth, pageHeight));
123     }
124 }
125
126 void PrintContext::begin(float width, float height)
127 {
128     // This function can be called multiple times to adjust printing parameters without going back to screen mode.
129     m_isPrinting = true;
130
131     float minLayoutWidth = width * printingMinimumShrinkFactor;
132     float minLayoutHeight = height * printingMinimumShrinkFactor;
133
134     // This changes layout, so callers need to make sure that they don't paint to screen while in printing mode.
135     m_frame->setPrinting(true, FloatSize(minLayoutWidth, minLayoutHeight), printingMaximumShrinkFactor / printingMinimumShrinkFactor, Frame::AdjustViewSize);
136 }
137
138 float PrintContext::computeAutomaticScaleFactor(float availablePaperWidth)
139 {
140     if (!m_frame->view())
141         return 1;
142
143     float viewWidth = m_frame->view()->contentsWidth();
144     if (viewWidth < 1)
145         return 1;
146
147     float maxShrinkToFitScaleFactor = 1 / printingMaximumShrinkFactor;
148     float shrinkToFitScaleFactor = availablePaperWidth / viewWidth;
149     return max(maxShrinkToFitScaleFactor, shrinkToFitScaleFactor);
150 }
151
152 void PrintContext::spoolPage(GraphicsContext& ctx, int pageNumber, float width)
153 {
154     IntRect pageRect = m_pageRects[pageNumber];
155     float scale = width / pageRect.width();
156
157     ctx.save();
158     ctx.scale(FloatSize(scale, scale));
159     ctx.translate(-pageRect.x(), -pageRect.y());
160     ctx.clip(pageRect);
161     m_frame->view()->paintContents(&ctx, pageRect);
162     ctx.restore();
163 }
164
165 void PrintContext::spoolRect(GraphicsContext& ctx, const IntRect& rect)
166 {
167     ctx.save();
168     ctx.translate(-rect.x(), -rect.y());
169     ctx.clip(rect);
170     m_frame->view()->paintContents(&ctx, rect);
171     ctx.restore();
172 }
173
174 void PrintContext::end()
175 {
176     ASSERT(m_isPrinting);
177     m_isPrinting = false;
178     m_frame->setPrinting(false, FloatSize(), 0, Frame::AdjustViewSize);
179 }
180
181 static RenderBoxModelObject* enclosingBoxModelObject(RenderObject* object)
182 {
183
184     while (object && !object->isBoxModelObject())
185         object = object->parent();
186     if (!object)
187         return 0;
188     return toRenderBoxModelObject(object);
189 }
190
191 int PrintContext::pageNumberForElement(Element* element, const FloatSize& pageSizeInPixels)
192 {
193     // Make sure the element is not freed during the layout.
194     RefPtr<Element> elementRef(element);
195     element->document()->updateLayout();
196
197     RenderBoxModelObject* box = enclosingBoxModelObject(element->renderer());
198     if (!box)
199         return -1;
200
201     Frame* frame = element->document()->frame();
202     FloatRect pageRect(FloatPoint(0, 0), pageSizeInPixels);
203     PrintContext printContext(frame);
204     printContext.begin(pageRect.width(), pageRect.height());
205     FloatSize scaledPageSize = pageSizeInPixels;
206     scaledPageSize.scale(frame->view()->contentsSize().width() / pageRect.width());
207     printContext.computePageRectsWithPageSize(scaledPageSize, false);
208
209     int top = box->offsetTop();
210     int left = box->offsetLeft();
211     size_t pageNumber = 0;
212     for (; pageNumber < printContext.pageCount(); pageNumber++) {
213         const IntRect& page = printContext.pageRect(pageNumber);
214         if (page.x() <= left && left < page.right() && page.y() <= top && top < page.bottom())
215             return pageNumber;
216     }
217     return -1;
218 }
219
220 String PrintContext::pageProperty(Frame* frame, const char* propertyName, int pageNumber)
221 {
222     Document* document = frame->document();
223     PrintContext printContext(frame);
224     printContext.begin(800); // Any width is OK here.
225     document->updateLayout();
226     RefPtr<RenderStyle> style = document->styleForPage(pageNumber);
227
228     // Implement formatters for properties we care about.
229     if (!strcmp(propertyName, "margin-left")) {
230         if (style->marginLeft().isAuto())
231             return String("auto");
232         return String::number(style->marginLeft().rawValue());
233     }
234     if (!strcmp(propertyName, "line-height"))
235         return String::number(style->lineHeight().rawValue());
236     if (!strcmp(propertyName, "font-size"))
237         return String::number(style->fontDescription().computedPixelSize());
238     if (!strcmp(propertyName, "font-family"))
239         return style->fontDescription().family().family().string();
240     if (!strcmp(propertyName, "size"))
241         return makeString(String::number(style->pageSize().width().rawValue()), ' ', String::number(style->pageSize().height().rawValue()));
242
243     return makeString("pageProperty() unimplemented for: ", propertyName);
244 }
245
246 bool PrintContext::isPageBoxVisible(Frame* frame, int pageNumber)
247 {
248     return frame->document()->isPageBoxVisible(pageNumber);
249 }
250
251 String PrintContext::pageSizeAndMarginsInPixels(Frame* frame, int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft)
252 {
253     IntSize pageSize(width, height);
254     frame->document()->pageSizeAndMarginsInPixels(pageNumber, pageSize, marginTop, marginRight, marginBottom, marginLeft);
255
256     // We don't have a makeString() function that takes up to 12 arguments, if this is a hot function, we can provide one.
257     return makeString('(', String::number(pageSize.width()), ", ", String::number(pageSize.height()), ") ") +
258            makeString(String::number(marginTop), ' ', String::number(marginRight), ' ', String::number(marginBottom), ' ', String::number(marginLeft));
259 }
260
261 int PrintContext::numberOfPages(Frame* frame, const FloatSize& pageSizeInPixels)
262 {
263     frame->document()->updateLayout();
264
265     FloatRect pageRect(FloatPoint(0, 0), pageSizeInPixels);
266     PrintContext printContext(frame);
267     printContext.begin(pageRect.width(), pageRect.height());
268     // Account for shrink-to-fit.
269     FloatSize scaledPageSize = pageSizeInPixels;
270     scaledPageSize.scale(frame->view()->contentsSize().width() / pageRect.width());
271     printContext.computePageRectsWithPageSize(scaledPageSize, false);
272     return printContext.pageCount();
273 }
274
275 void PrintContext::spoolAllPagesWithBoundaries(Frame* frame, GraphicsContext& graphicsContext, const FloatSize& pageSizeInPixels)
276 {
277     if (!frame->document() || !frame->view() || !frame->document()->renderer())
278         return;
279
280     frame->document()->updateLayout();
281
282     PrintContext printContext(frame);
283     printContext.begin(pageSizeInPixels.width(), pageSizeInPixels.height());
284
285     float pageHeight;
286     printContext.computePageRects(FloatRect(FloatPoint(0, 0), pageSizeInPixels), 0, 0, 1, pageHeight);
287
288     const float pageWidth = pageSizeInPixels.width();
289     const Vector<IntRect>& pageRects = printContext.pageRects();
290     int totalHeight = pageRects.size() * (pageSizeInPixels.height() + 1) - 1;
291
292     // Fill the whole background by white.
293     graphicsContext.setFillColor(Color(255, 255, 255), ColorSpaceDeviceRGB);
294     graphicsContext.fillRect(FloatRect(0, 0, pageWidth, totalHeight));
295
296     graphicsContext.save();
297     graphicsContext.translate(0, totalHeight);
298     graphicsContext.scale(FloatSize(1, -1));
299
300     int currentHeight = 0;
301     for (size_t pageIndex = 0; pageIndex < pageRects.size(); pageIndex++) {
302         // Draw a line for a page boundary if this isn't the first page.
303         if (pageIndex > 0) {
304             graphicsContext.save();
305             graphicsContext.setStrokeColor(Color(0, 0, 255), ColorSpaceDeviceRGB);
306             graphicsContext.setFillColor(Color(0, 0, 255), ColorSpaceDeviceRGB);
307             graphicsContext.drawLine(IntPoint(0, currentHeight),
308                                      IntPoint(pageWidth, currentHeight));
309             graphicsContext.restore();
310         }
311
312         graphicsContext.save();
313         graphicsContext.translate(0, currentHeight);
314         printContext.spoolPage(graphicsContext, pageIndex, pageWidth);
315         graphicsContext.restore();
316
317         currentHeight += pageSizeInPixels.height() + 1;
318     }
319
320     graphicsContext.restore();
321 }
322
323 }