/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qprinter_p.h"

#include "qprinter.h"

#include "qprintengine.h"

#include "qprinterinfo.h"

#include "qlist.h"

#include <qpagesetupdialog.h>

#include <qapplication.h>

#include <qfileinfo.h>

#if !defined(QT_NO_CUPS) && !defined(QT_NO_LIBRARY)

#include "private/qcups_p.h"

#endif

#ifndef QT_NO_PRINTER

#if defined (Q_WS_WIN)

#include <private/qprintengine_win_p.h>

#elif defined (Q_WS_MAC)

#include <private/qprintengine_mac_p.h>

#elif defined (QTOPIA_PRINTENGINE)

#include <private/qprintengine_qws_p.h>

#endif

#include <private/qprintengine_ps_p.h>

#if defined(Q_WS_X11)

#include <private/qt_x11_p.h>

#endif

#ifndef QT_NO_PDF

#include "qprintengine_pdf_p.h"

#endif

#include <qpicture.h>

#include <private/qpaintengine_preview_p.h>

#if defined(QT3_SUPPORT)

#  include "qprintdialog.h"

#endif // QT3_SUPPORT

QT_BEGIN_NAMESPACE

#define ABORT_IF_ACTIVE(location) \

    if (d->printEngine->printerState() == QPrinter::Active) { \

        qWarning("%s: Cannot be changed while printer is active", location); \

        return; \

    }

// NB! This table needs to be in sync with QPrinter::PaperSize

static const float qt_paperSizes[][2] = {

    {210, 297}, // A4

    {176, 250}, // B5

    {215.9f, 279.4f}, // Letter

    {215.9f, 355.6f}, // Legal

    {190.5f, 254}, // Executive

    {841, 1189}, // A0

    {594, 841}, // A1

    {420, 594}, // A2

    {297, 420}, // A3

    {148, 210}, // A5

    {105, 148}, // A6

    {74, 105}, // A7

    {52, 74}, // A8

    {37, 52}, // A8

    {1000, 1414}, // B0

    {707, 1000}, // B1

    {31, 44}, // B10

    {500, 707}, // B2

    {353, 500}, // B3

    {250, 353}, // B4

    {125, 176}, // B6

    {88, 125}, // B7

    {62, 88}, // B8

    {33, 62}, // B9

    {163, 229}, // C5E

    {105, 241}, // US Common

    {110, 220}, // DLE

    {210, 330}, // Folio

    {431.8f, 279.4f}, // Ledger

    {279.4f, 431.8f} // Tabloid

};

/// return the multiplier of converting from the unit value to postscript-points.

double qt_multiplierForUnit(QPrinter::Unit unit, int resolution)

{

    switch(unit) {

    case QPrinter::Millimeter:

        return 2.83464566929;

    case QPrinter::Point:

        return 1.0;

    case QPrinter::Inch:

        return 72.0;

    case QPrinter::Pica:

        return 12;

    case QPrinter::Didot:

        return 1.065826771;

    case QPrinter::Cicero:

        return 12.789921252;

    case QPrinter::DevicePixel:

        return 72.0/resolution;

    }

    return 1.0;

}

// not static: it's needed in qpagesetupdialog_unix.cpp

QSizeF qt_printerPaperSize(QPrinter::Orientation orientation,

                           QPrinter::PaperSize paperSize,

                           QPrinter::Unit unit,

                           int resolution)

{

    int width_index = 0;

    int height_index = 1;

    if (orientation == QPrinter::Landscape) {

        width_index = 1;

        height_index = 0;

    }

    const qreal multiplier = qt_multiplierForUnit(unit, resolution);

    return QSizeF((qt_paperSizes[paperSize][width_index] * 72 / 25.4) / multiplier,

                  (qt_paperSizes[paperSize][height_index] * 72 / 25.4) / multiplier);

}

// returns the actual num copies set on a printer, not

// the number that is documented in QPrinter::numCopies()

int qt_printerRealNumCopies(QPaintEngine *engine)

{

    int numCopies = 1;

    if (engine->type() == QPaintEngine::PostScript

        || engine->type() == QPaintEngine::Pdf)

    {

        QPdfBaseEngine *base = static_cast<QPdfBaseEngine *>(engine);

        numCopies = base->d_func()->copies;

    }

#ifdef Q_WS_WIN

    else if (engine->type() == QPaintEngine::Windows) {

        QWin32PrintEngine *base = static_cast<QWin32PrintEngine *>(engine);

        numCopies = base->d_func()->num_copies;

    }

#endif

    return numCopies;

}

void QPrinterPrivate::createDefaultEngines()

{

    QPrinter::OutputFormat realOutputFormat = outputFormat;

#if !defined (QTOPIA_PRINTENGINE)

#if defined (Q_OS_UNIX) && ! defined (Q_WS_MAC)

    if(outputFormat == QPrinter::NativeFormat) {

        realOutputFormat = QPrinter::PostScriptFormat;

    }

#endif

#endif

    switch (realOutputFormat) {

    case QPrinter::NativeFormat: {

#if defined (Q_WS_WIN)

        QWin32PrintEngine *winEngine = new QWin32PrintEngine(printerMode);

        paintEngine = winEngine;

        printEngine = winEngine;

#elif defined (Q_WS_MAC)

        QMacPrintEngine *macEngine = new QMacPrintEngine(printerMode);

        paintEngine = macEngine;

        printEngine = macEngine;

#elif defined (QTOPIA_PRINTENGINE)

        QtopiaPrintEngine *qwsEngine = new QtopiaPrintEngine(printerMode);

        paintEngine = qwsEngine;

        printEngine = qwsEngine;

#elif defined (Q_OS_UNIX)

        Q_ASSERT(false);

#endif

        }

        break;

    case QPrinter::PdfFormat: {

        QPdfEngine *pdfEngine = new QPdfEngine(printerMode);

        paintEngine = pdfEngine;

        printEngine = pdfEngine;

    }

        break;

    case QPrinter::PostScriptFormat: {

        QPSPrintEngine *psEngine = new QPSPrintEngine(printerMode);

        paintEngine = psEngine;

        printEngine = psEngine;

    }

        break;

    }

    use_default_engine = true;

    had_default_engines = true;

}

#ifndef QT_NO_PRINTPREVIEWWIDGET

QList<const QPicture *> QPrinterPrivate::previewPages() const

{

    if (previewEngine)

        return previewEngine->pages();

    return QList<const QPicture *>();

}

void QPrinterPrivate::setPreviewMode(bool enable)

{

    Q_Q(QPrinter);

    if (enable) {

        if (!previewEngine)

            previewEngine = new QPreviewPaintEngine;

        had_default_engines = use_default_engine;

        use_default_engine = false;

        realPrintEngine = printEngine;

        realPaintEngine = paintEngine;

        q->setEngines(previewEngine, previewEngine);

        previewEngine->setProxyEngines(realPrintEngine, realPaintEngine);

    } else {

        q->setEngines(realPrintEngine, realPaintEngine);

        use_default_engine = had_default_engines;

    }

}

#endif // QT_NO_PRINTPREVIEWWIDGET

void QPrinterPrivate::addToManualSetList(QPrintEngine::PrintEnginePropertyKey key)

{

    for (int c = 0; c < manualSetList.size(); ++c) {

        if (manualSetList[c] == key) return;

    }

    manualSetList.append(key);

}

/*!

  \class QPrinter

  \reentrant

  \brief The QPrinter class is a paint device that paints on a printer.

  \ingroup printing

  This device represents a series of pages of printed output, and is

  used in almost exactly the same way as other paint devices such as

  QWidget and QPixmap.

  A set of additional functions are provided to manage device-specific

  features, such as orientation and resolution, and to step through

  the pages in a document as it is generated.

  When printing directly to a printer on Windows or Mac OS X, QPrinter uses

  the built-in printer drivers. On X11, QPrinter uses the

  \l{Common Unix Printing System (CUPS)} or the standard Unix \l lpr utility

  to send PostScript or PDF output to the printer. As an alternative,

  the printProgram() function can be used to specify the command or utility

  to use instead of the system default.

  Note that setting parameters like paper size and resolution on an

  invalid printer is undefined. You can use QPrinter::isValid() to

  verify this before changing any parameters.

  QPrinter supports a number of parameters, most of which can be

  changed by the end user through a \l{QPrintDialog}{print dialog}. In

  general, QPrinter passes these functions onto the underlying QPrintEngine.

  The most important parameters are:

  \list

  \i setOrientation() tells QPrinter which page orientation to use.

  \i setPaperSize() tells QPrinter what paper size to expect from the

  printer.

  \i setResolution() tells QPrinter what resolution you wish the

  printer to provide, in dots per inch (DPI).

  \i setFullPage() tells QPrinter whether you want to deal with the

  full page or just with the part the printer can draw on.

  \i setNumCopies() tells QPrinter how many copies of the document

  it should print.

  \endlist

  Many of these functions can only be called before the actual printing

  begins (i.e., before QPainter::begin() is called). This usually makes

  sense because, for example, it's not possible to change the number of

  copies when you are halfway through printing. There are also some

  settings that the user sets (through the printer dialog) and that

  applications are expected to obey. See QAbstractPrintDialog's

  documentation for more details.

  When QPainter::begin() is called, the QPrinter it operates on is prepared for

  a new page, enabling the QPainter to be used immediately to paint the first

  page in a document. Once the first page has been painted, newPage() can be

  called to request a new blank page to paint on, or QPainter::end() can be

  called to finish printing. The second page and all following pages are

  prepared using a call to newPage() before they are painted.

  The first page in a document does not need to be preceded by a call to

  newPage(). You only need to calling newPage() after QPainter::begin() if you

  need to insert a blank page at the beginning of a printed document.

  Similarly, calling newPage() after the last page in a document is painted will

  result in a trailing blank page appended to the end of the printed document.

  If you want to abort the print job, abort() will try its best to

  stop printing. It may cancel the entire job or just part of it.

  Since QPrinter can print to any QPrintEngine subclass, it is possible to

  extend printing support to cover new types of printing subsystem by

  subclassing QPrintEngine and reimplementing its interface.

  \sa QPrintDialog, {Printing with Qt}

*/

/*!

    \enum QPrinter::PrinterState

    \value Idle

    \value Active

    \value Aborted

    \value Error

*/

/*!

    \enum QPrinter::PrinterMode

    This enum describes the mode the printer should work in. It

    basically presets a certain resolution and working mode.

    \value ScreenResolution Sets the resolution of the print device to

    the screen resolution. This has the big advantage that the results

    obtained when painting on the printer will match more or less

    exactly the visible output on the screen. It is the easiest to

    use, as font metrics on the screen and on the printer are the

    same. This is the default value. ScreenResolution will produce a

    lower quality output than HighResolution and should only be used

    for drafts.

    \value PrinterResolution This value is deprecated. Is is

    equivalent to ScreenResolution on Unix and HighResolution on

    Windows and Mac. Due do the difference between ScreenResolution

    and HighResolution, use of this value may lead to non-portable

    printer code.

    \value HighResolution On Windows, sets the printer resolution to that

    defined for the printer in use. For PostScript printing, sets the

    resolution of the PostScript driver to 1200 dpi.

    \note When rendering text on a QPrinter device, it is important

    to realize that the size of text, when specified in points, is

    independent of the resolution specified for the device itself.

    Therefore, it may be useful to specify the font size in pixels

    when combining text with graphics to ensure that their relative

    sizes are what you expect.

*/

/*!

  \enum QPrinter::Orientation

  This enum type (not to be confused with \c Orientation) is used

  to specify each page's orientation.

  \value Portrait the page's height is greater than its width.

  \value Landscape the page's width is greater than its height.

  This type interacts with \l QPrinter::PaperSize and

  QPrinter::setFullPage() to determine the final size of the page

  available to the application.

*/

/*!

    \enum QPrinter::PrintRange

    Used to specify the print range selection option.

    \value AllPages All pages should be printed.

    \value Selection Only the selection should be printed.

    \value PageRange The specified page range should be printed.

    \sa QAbstractPrintDialog::PrintRange

*/

/*!

    \enum QPrinter::PrinterOption

    \compat

    Use QAbstractPrintDialog::PrintDialogOption instead.

    \value PrintToFile

    \value PrintSelection

    \value PrintPageRange

*/

/*!

  \enum QPrinter::PageSize

  \obsolete

  Use QPrinter::PaperSize instead.

  \value A0 841 x 1189 mm

  \value A1 594 x 841 mm

  \value A2 420 x 594 mm

  \value A3 297 x 420 mm

  \value A4 210 x 297 mm, 8.26 x 11.69 inches

  \value A5 148 x 210 mm

  \value A6 105 x 148 mm

  \value A7 74 x 105 mm

  \value A8 52 x 74 mm

  \value A9 37 x 52 mm

  \value B0 1030 x 1456 mm

  \value B1 728 x 1030 mm

  \value B10 32 x 45 mm

  \value B2 515 x 728 mm

  \value B3 364 x 515 mm

  \value B4 257 x 364 mm

  \value B5 182 x 257 mm, 7.17 x 10.13 inches

  \value B6 128 x 182 mm

  \value B7 91 x 128 mm

  \value B8 64 x 91 mm

  \value B9 45 x 64 mm

  \value C5E 163 x 229 mm

  \value Comm10E 105 x 241 mm, U.S. Common 10 Envelope

  \value DLE 110 x 220 mm

  \value Executive 7.5 x 10 inches, 191 x 254 mm

  \value Folio 210 x 330 mm

  \value Ledger 432 x 279 mm

  \value Legal 8.5 x 14 inches, 216 x 356 mm

  \value Letter 8.5 x 11 inches, 216 x 279 mm

  \value Tabloid 279 x 432 mm

  \value Custom Unknown, or a user defined size.

  \omitvalue NPageSize

  */

/*!

  \enum QPrinter::PaperSize

  \since 4.4

  This enum type specifies what paper size QPrinter should use.

  QPrinter does not check that the paper size is available; it just

  uses this information, together with QPrinter::Orientation and

  QPrinter::setFullPage(), to determine the printable area.

  The defined sizes (with setFullPage(true)) are:

  \value A0 841 x 1189 mm

  \value A1 594 x 841 mm

  \value A2 420 x 594 mm

  \value A3 297 x 420 mm

  \value A4 210 x 297 mm, 8.26 x 11.69 inches

  \value A5 148 x 210 mm

  \value A6 105 x 148 mm

  \value A7 74 x 105 mm

  \value A8 52 x 74 mm

  \value A9 37 x 52 mm

  \value B0 1000 x 1414 mm

  \value B1 707 x 1000 mm

  \value B2 500 x 707 mm

  \value B3 353 x 500 mm

  \value B4 250 x 353 mm

  \value B5 176 x 250 mm, 6.93 x 9.84 inches

  \value B6 125 x 176 mm

  \value B7 88 x 125 mm

  \value B8 62 x 88 mm

  \value B9 33 x 62 mm

  \value B10 31 x 44 mm

  \value C5E 163 x 229 mm

  \value Comm10E 105 x 241 mm, U.S. Common 10 Envelope

  \value DLE 110 x 220 mm

  \value Executive 7.5 x 10 inches, 190.5 x 254 mm

  \value Folio 210 x 330 mm

  \value Ledger 431.8 x 279.4 mm

  \value Legal 8.5 x 14 inches, 215.9 x 355.6 mm

  \value Letter 8.5 x 11 inches, 215.9 x 279.4 mm

  \value Tabloid 279.4 x 431.8 mm

  \value Custom Unknown, or a user defined size.

  With setFullPage(false) (the default), the metrics will be a bit

  smaller; how much depends on the printer in use.

  \omitvalue NPageSize

  \omitvalue NPaperSize

*/

/*!

  \enum QPrinter::PageOrder

  This enum type is used by QPrinter to tell the application program

  how to print.

  \value FirstPageFirst  the lowest-numbered page should be printed

  first.

  \value LastPageFirst  the highest-numbered page should be printed

  first.

*/

/*!

  \enum QPrinter::ColorMode