src/html/htmprint.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmprint.cpp
   3 // Purpose:     html printing classes
   4 // Author:      Vaclav Slavik
   5 // Created:     25/09/99
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Vaclav Slavik, 1999
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "htmprint.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx/wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #include "wx/defs.h"
  20
  21 #ifdef __BORLANDC__
  22 #pragma hdrstop
  23 #endif
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/log.h"
  27     #include "wx/intl.h"
  28     #include "wx/dc.h"
  29 #endif
  30
  31 #if wxUSE_HTML && wxUSE_PRINTING_ARCHITECTURE && wxUSE_STREAMS
  32
  33 #include "wx/dc.h"
  34 #include "wx/print.h"
  35 #include "wx/printdlg.h"
  36 #include "wx/html/htmprint.h"
  37 #include "wx/wxhtml.h"
  38 #include "wx/wfstream.h"
  39
  40
  41 //--------------------------------------------------------------------------------
  42 // wxHtmlDCRenderer
  43 //--------------------------------------------------------------------------------
  44
  45
  46 wxHtmlDCRenderer::wxHtmlDCRenderer() : wxObject()
  47 {
  48     m_DC = NULL;
  49     m_Width = m_Height = 0;
  50     m_Cells = NULL;
  51     m_Parser = new wxHtmlWinParser(NULL);
  52     m_FS = new wxFileSystem();
  53     m_Parser->SetFS(m_FS);
  54 }
  55
  56
  57
  58 wxHtmlDCRenderer::~wxHtmlDCRenderer()
  59 {
  60     if (m_Cells) delete m_Cells;
  61     if (m_Parser) delete m_Parser;
  62     if (m_FS) delete m_FS;
  63 }
  64
  65
  66
  67 void wxHtmlDCRenderer::SetDC(wxDC *dc, double pixel_scale)
  68 {
  69     m_DC = dc;
  70     m_Parser->SetDC(m_DC, pixel_scale);
  71 }
  72
  73
  74
  75 void wxHtmlDCRenderer::SetSize(int width, int height)
  76 {
  77     m_Width = width;
  78     m_Height = height;
  79 }
  80
  81
  82
  83 void wxHtmlDCRenderer::SetHtmlText(const wxString& html, const wxString& basepath, bool isdir)
  84 {
  85     if (m_DC == NULL) return;
  86
  87     if (m_Cells != NULL) delete m_Cells;
  88
  89     m_FS->ChangePathTo(basepath, isdir);
  90     m_Cells = (wxHtmlContainerCell*) m_Parser->Parse(html);
  91     m_Cells->SetIndent(0, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS);
  92     m_Cells->Layout(m_Width);
  93 }
  94
  95
  96
  97 int wxHtmlDCRenderer::Render(int x, int y, int from, int dont_render)
  98 {
  99     int pbreak, hght;
 100
 101     if (m_Cells == NULL || m_DC == NULL) return 0;
 102
 103     pbreak = (int)(from + m_Height);
 104     while (m_Cells->AdjustPagebreak(&pbreak)) {}
 105     hght = pbreak - from;
 106
 107     if (!dont_render)
 108     {
 109         m_DC->SetBrush(*wxWHITE_BRUSH);
 110
 111         m_DC->SetClippingRegion(x, y, m_Width, hght);
 112         m_Cells->Draw(*m_DC,
 113                         x, (y - from),
 114                         y, pbreak + (y /*- from*/));
 115         m_DC->DestroyClippingRegion();
 116     }
 117
 118     if (pbreak < m_Cells->GetHeight()) return pbreak;
 119     else return GetTotalHeight();
 120 }
 121
 122
 123
 124 int wxHtmlDCRenderer::GetTotalHeight()
 125 {
 126     if (m_Cells) return m_Cells->GetHeight();
 127     else return 0;
 128 }
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145 //--------------------------------------------------------------------------------
 146 // wxHtmlPrintout
 147 //--------------------------------------------------------------------------------
 148
 149
 150
 151 wxHtmlPrintout::wxHtmlPrintout(const wxString& title) : wxPrintout(title)
 152 {
 153     m_Renderer = new wxHtmlDCRenderer;
 154     m_RendererHdr = new wxHtmlDCRenderer;
 155     m_NumPages = wxHTML_PRINT_MAX_PAGES;
 156     m_Document = m_BasePath = wxEmptyString; m_BasePathIsDir = TRUE;
 157     m_Headers[0] = m_Headers[1] = wxEmptyString;
 158     m_Footers[0] = m_Footers[1] = wxEmptyString;
 159     m_HeaderHeight = m_FooterHeight = 0;
 160     SetMargins(); // to default values
 161 }
 162
 163
 164
 165 wxHtmlPrintout::~wxHtmlPrintout()
 166 {
 167     delete m_Renderer;
 168     delete m_RendererHdr;
 169 }
 170
 171
 172
 173 bool wxHtmlPrintout::OnBeginDocument(int startPage, int endPage)
 174 {
 175     int pageWidth, pageHeight, mm_w, mm_h, scr_w, scr_h, dc_w, dc_h;
 176     float ppmm_h, ppmm_v;
 177
 178     if (!wxPrintout::OnBeginDocument(startPage, endPage)) return FALSE;
 179
 180     GetPageSizePixels(&pageWidth, &pageHeight);
 181     GetPageSizeMM(&mm_w, &mm_h);
 182     ppmm_h = (float)pageWidth / mm_w;
 183     ppmm_v = (float)pageHeight / mm_h;
 184
 185     int ppiPrinterX, ppiPrinterY;
 186     GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
 187     int ppiScreenX, ppiScreenY;
 188     GetPPIScreen(&ppiScreenX, &ppiScreenY);
 189
 190     wxDisplaySize(&scr_w, &scr_h);
 191     GetDC()->GetSize(&dc_w, &dc_h);
 192
 193     GetDC()->SetUserScale((double)dc_w / (double)pageWidth, (double)dc_w / (double)pageWidth);
 194
 195     /* prepare headers/footers renderer: */
 196
 197     m_RendererHdr->SetDC(GetDC(), (double)ppiPrinterY / (double)ppiScreenY);
 198     m_RendererHdr->SetSize((int) (ppmm_h * (mm_w - m_MarginLeft - m_MarginRight)),
 199                           (int) (ppmm_v * (mm_h - m_MarginTop - m_MarginBottom)));
 200     if (m_Headers[0] != wxEmptyString)
 201     {
 202         m_RendererHdr->SetHtmlText(TranslateHeader(m_Headers[0], 1));
 203         m_HeaderHeight = m_RendererHdr->GetTotalHeight();
 204     }
 205     else if (m_Headers[1] != wxEmptyString)
 206     {
 207         m_RendererHdr->SetHtmlText(TranslateHeader(m_Headers[1], 1));
 208         m_HeaderHeight = m_RendererHdr->GetTotalHeight();
 209     }
 210     if (m_Footers[0] != wxEmptyString)
 211     {
 212         m_RendererHdr->SetHtmlText(TranslateHeader(m_Footers[0], 1));
 213         m_FooterHeight = m_RendererHdr->GetTotalHeight();
 214     }
 215     else if (m_Footers[1] != wxEmptyString)
 216     {
 217         m_RendererHdr->SetHtmlText(TranslateHeader(m_Footers[1], 1));
 218         m_FooterHeight = m_RendererHdr->GetTotalHeight();
 219     }
 220
 221     /* prepare main renderer: */
 222     m_Renderer->SetDC(GetDC(), (double)ppiPrinterY / (double)ppiScreenY);
 223     m_Renderer->SetSize((int) (ppmm_h * (mm_w - m_MarginLeft - m_MarginRight)),
 224                           (int) (ppmm_v * (mm_h - m_MarginTop - m_MarginBottom) -
 225                           m_FooterHeight - m_HeaderHeight -
 226                           ((m_HeaderHeight == 0) ? 0 : m_MarginSpace * ppmm_v) -
 227                           ((m_FooterHeight == 0) ? 0 : m_MarginSpace * ppmm_v)
 228                           ));
 229     m_Renderer->SetHtmlText(m_Document, m_BasePath, m_BasePathIsDir);
 230     CountPages();
 231     return TRUE;
 232 }
 233
 234
 235 bool wxHtmlPrintout::OnPrintPage(int page)
 236 {
 237     wxDC *dc = GetDC();
 238     if (dc)
 239     {
 240         if (HasPage(page))
 241             RenderPage(dc, page);
 242         return TRUE;
 243     }
 244     else return FALSE;
 245 }
 246
 247
 248 void wxHtmlPrintout::GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo)
 249 {
 250     *minPage = 1;
 251     *maxPage = wxHTML_PRINT_MAX_PAGES;
 252     *selPageFrom = 1;
 253     *selPageTo = wxHTML_PRINT_MAX_PAGES;
 254 }
 255
 256
 257
 258 bool wxHtmlPrintout::HasPage(int pageNum)
 259 {
 260     return (pageNum >= 1 && pageNum <= m_NumPages);
 261 }
 262
 263
 264
 265 void wxHtmlPrintout::SetHtmlText(const wxString& html, const wxString &basepath, bool isdir)
 266 {
 267     m_Document = html;
 268     m_BasePath = basepath;
 269     m_BasePathIsDir = isdir;
 270 }
 271
 272 // defined in htmlfilt.cpp
 273 void wxPrivate_ReadString(wxString& str, wxInputStream* s);
 274
 275 void wxHtmlPrintout::SetHtmlFile(const wxString& htmlfile)
 276 {
 277     wxFileSystem fs;
 278     wxFSFile *ff = fs.OpenFile(htmlfile);
 279
 280     if (ff == NULL)
 281     {
 282         wxLogError(htmlfile + _(": file does not exist!"));
 283         return;
 284     }
 285
 286     wxInputStream *st = ff->GetStream();
 287     wxString doc;
 288     wxPrivate_ReadString(doc, st);
 289
 290     delete ff;
 291
 292     SetHtmlText(doc, htmlfile, FALSE);
 293 }
 294
 295
 296
 297 void wxHtmlPrintout::SetHeader(const wxString& header, int pg)
 298 {
 299     if (pg == wxPAGE_ALL || pg == wxPAGE_EVEN)
 300         m_Headers[0] = header;
 301     if (pg == wxPAGE_ALL || pg == wxPAGE_ODD)
 302         m_Headers[1] = header;
 303 }
 304
 305
 306
 307 void wxHtmlPrintout::SetFooter(const wxString& footer, int pg)
 308 {
 309     if (pg == wxPAGE_ALL || pg == wxPAGE_EVEN)
 310         m_Footers[0] = footer;
 311     if (pg == wxPAGE_ALL || pg == wxPAGE_ODD)
 312         m_Footers[1] = footer;
 313 }
 314
 315
 316
 317 void wxHtmlPrintout::CountPages()
 318 {
 319     wxBusyCursor wait;
 320     int pageWidth, pageHeight, mm_w, mm_h;
 321     float ppmm_h, ppmm_v;
 322
 323     GetPageSizePixels(&pageWidth, &pageHeight);
 324     GetPageSizeMM(&mm_w, &mm_h);
 325     ppmm_h = (float)pageWidth / mm_w;
 326     ppmm_v = (float)pageHeight / mm_h;
 327
 328     int pos = 0;
 329
 330     m_NumPages = 0;
 331
 332     m_PageBreaks[0] = 0;
 333     do
 334     {
 335         pos = m_Renderer->Render((int)( ppmm_h * m_MarginLeft),
 336                                    (int) (ppmm_v * (m_MarginTop + (m_HeaderHeight == 0 ? 0 : m_MarginSpace)) + m_HeaderHeight),
 337                                    pos, TRUE);
 338         m_PageBreaks[++m_NumPages] = pos;
 339     } while (pos < m_Renderer->GetTotalHeight());
 340 }
 341
 342
 343
 344 void wxHtmlPrintout::RenderPage(wxDC *dc, int page)
 345 {
 346     wxBusyCursor wait;
 347
 348     int pageWidth, pageHeight, mm_w, mm_h, scr_w, scr_h, dc_w, dc_h;
 349     float ppmm_h, ppmm_v;
 350
 351     GetPageSizePixels(&pageWidth, &pageHeight);
 352     GetPageSizeMM(&mm_w, &mm_h);
 353     ppmm_h = (float)pageWidth / mm_w;
 354     ppmm_v = (float)pageHeight / mm_h;
 355     wxDisplaySize(&scr_w, &scr_h);
 356     dc->GetSize(&dc_w, &dc_h);
 357
 358     int ppiPrinterX, ppiPrinterY;
 359     GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
 360     int ppiScreenX, ppiScreenY;
 361     GetPPIScreen(&ppiScreenX, &ppiScreenY);
 362
 363     dc->SetUserScale((double)dc_w / (double)pageWidth, (double)dc_w / (double)pageWidth);
 364
 365     m_Renderer->SetDC(dc, (double)ppiPrinterY / (double)ppiScreenY);
 366
 367     dc->SetBackgroundMode(wxTRANSPARENT);
 368
 369     m_Renderer->Render((int) (ppmm_h * m_MarginLeft),
 370                          (int) (ppmm_v * (m_MarginTop + (m_HeaderHeight == 0 ? 0 : m_MarginSpace)) + m_HeaderHeight),
 371                          m_PageBreaks[page-1]);
 372
 373     m_RendererHdr->SetDC(dc, (double)ppiPrinterY / (double)ppiScreenY);
 374     if (m_Headers[page % 2] != wxEmptyString)
 375     {
 376         m_RendererHdr->SetHtmlText(TranslateHeader(m_Headers[page % 2], page));
 377         m_RendererHdr->Render((int) (ppmm_h * m_MarginLeft), (int) (ppmm_v * m_MarginTop));
 378     }
 379     if (m_Footers[page % 2] != wxEmptyString)
 380     {
 381         m_RendererHdr->SetHtmlText(TranslateHeader(m_Footers[page % 2], page));
 382         m_RendererHdr->Render((int) (ppmm_h * m_MarginLeft), (int) (pageHeight - ppmm_v * m_MarginBottom - m_FooterHeight));
 383     }
 384 }
 385
 386
 387
 388 wxString wxHtmlPrintout::TranslateHeader(const wxString& instr, int page)
 389 {
 390     wxString r = instr;
 391     wxString num;
 392
 393     num.Printf(wxT("%i"), page);
 394     r.Replace(wxT("@PAGENUM@"), num);
 395
 396     num.Printf(wxT("%i"), m_NumPages);
 397     r.Replace(wxT("@PAGESCNT@"), num);
 398
 399     return r;
 400 }
 401
 402
 403
 404 void wxHtmlPrintout::SetMargins(float top, float bottom, float left, float right, float spaces)
 405 {
 406     m_MarginTop = top;
 407     m_MarginBottom = bottom;
 408     m_MarginLeft = left;
 409     m_MarginRight = right;
 410     m_MarginSpace = spaces;
 411 }
 412
 413
 414
 415
 416
 417
 418 //--------------------------------------------------------------------------------
 419 // wxHtmlEasyPrinting
 420 //--------------------------------------------------------------------------------
 421
 422
 423 wxHtmlEasyPrinting::wxHtmlEasyPrinting(const wxString& name, wxFrame *parent_frame)
 424 {
 425     m_Frame = parent_frame;
 426     m_Name = name;
 427     m_PrintData = new wxPrintData;
 428 #if (defined __WXGTK__) || (defined __WXMOTIF__)
 429     (*m_PrintData) = (*wxThePrintSetupData);
 430 #endif
 431     m_PageSetupData = new wxPageSetupDialogData;
 432     m_Headers[0] = m_Headers[1] = m_Footers[0] = m_Footers[1] = wxEmptyString;
 433
 434     m_PageSetupData->EnableMargins(TRUE);
 435     m_PageSetupData->SetMarginTopLeft(wxPoint(25, 25));
 436     m_PageSetupData->SetMarginBottomRight(wxPoint(25, 25));
 437 }
 438
 439
 440
 441 wxHtmlEasyPrinting::~wxHtmlEasyPrinting()
 442 {
 443     delete m_PrintData;
 444     delete m_PageSetupData;
 445 }
 446
 447
 448
 449 bool wxHtmlEasyPrinting::PreviewFile(const wxString &htmlfile)
 450 {
 451     wxHtmlPrintout *p1 = CreatePrintout();
 452     p1->SetHtmlFile(htmlfile);
 453     wxHtmlPrintout *p2 = CreatePrintout();
 454     p2->SetHtmlFile(htmlfile);
 455     return DoPreview(p1, p2);
 456 }
 457
 458
 459
 460 bool wxHtmlEasyPrinting::PreviewText(const wxString &htmltext, const wxString &basepath)
 461 {
 462     wxHtmlPrintout *p1 = CreatePrintout();
 463     p1->SetHtmlText(htmltext, basepath, TRUE);
 464     wxHtmlPrintout *p2 = CreatePrintout();
 465     p2->SetHtmlText(htmltext, basepath, TRUE);
 466     return DoPreview(p1, p2);
 467 }
 468
 469
 470
 471 bool wxHtmlEasyPrinting::PrintFile(const wxString &htmlfile)
 472 {
 473     wxHtmlPrintout *p = CreatePrintout();
 474     p->SetHtmlFile(htmlfile);
 475     bool ret = DoPrint(p);
 476     delete p;
 477     return ret;
 478 }
 479
 480
 481
 482 bool wxHtmlEasyPrinting::PrintText(const wxString &htmltext, const wxString &basepath)
 483 {
 484     wxHtmlPrintout *p = CreatePrintout();
 485     p->SetHtmlText(htmltext, basepath, TRUE);
 486     bool ret = DoPrint(p);
 487     delete p;
 488     return ret;
 489 }
 490
 491
 492
 493 bool wxHtmlEasyPrinting::DoPreview(wxHtmlPrintout *printout1, wxHtmlPrintout *printout2)
 494 {
 495     // Pass two printout objects: for preview, and possible printing.
 496     wxPrintDialogData printDialogData(*m_PrintData);
 497     wxPrintPreview *preview = new wxPrintPreview(printout1, printout2, &printDialogData);
 498     if (!preview->Ok())
 499     {
 500         delete preview;
 501         return FALSE;
 502     }
 503
 504     wxPreviewFrame *frame = new wxPreviewFrame(preview, m_Frame,
 505                                                m_Name + _(" Preview"),
 506                                                wxPoint(100, 100), wxSize(650, 500));
 507     frame->Centre(wxBOTH);
 508     frame->Initialize();
 509     frame->Show(TRUE);
 510     return TRUE;
 511 }
 512
 513
 514
 515 bool wxHtmlEasyPrinting::DoPrint(wxHtmlPrintout *printout)
 516 {
 517     wxPrintDialogData printDialogData(*m_PrintData);
 518     wxPrinter printer(&printDialogData);
 519
 520     if (!printer.Print(m_Frame, printout, TRUE))
 521     {
 522         return FALSE;
 523     }
 524
 525     (*m_PrintData) = printer.GetPrintDialogData().GetPrintData();
 526     return TRUE;
 527 }
 528
 529
 530
 531 void wxHtmlEasyPrinting::PrinterSetup()
 532 {
 533     wxPrintDialogData printDialogData(*m_PrintData);
 534     wxPrintDialog printerDialog(m_Frame, &printDialogData);
 535
 536     printerDialog.GetPrintDialogData().SetSetupDialog(TRUE);
 537
 538     if (printerDialog.ShowModal() == wxID_OK)
 539         (*m_PrintData) = printerDialog.GetPrintDialogData().GetPrintData();
 540 }
 541
 542
 543
 544 void wxHtmlEasyPrinting::PageSetup()
 545 {
 546     if (!m_PrintData->Ok())
 547     {
 548         wxLogError(_("There was a problem during page setup: you may need to set a default printer."));
 549         return;
 550     }
 551
 552     m_PageSetupData->SetPrintData(*m_PrintData);
 553     wxPageSetupDialog pageSetupDialog(m_Frame, m_PageSetupData);
 554
 555     if (pageSetupDialog.ShowModal() == wxID_OK)
 556     {
 557         (*m_PrintData) = pageSetupDialog.GetPageSetupData().GetPrintData();
 558         (*m_PageSetupData) = pageSetupDialog.GetPageSetupData();
 559     }
 560 }
 561
 562
 563
 564 void wxHtmlEasyPrinting::SetHeader(const wxString& header, int pg)
 565 {
 566     if (pg == wxPAGE_ALL || pg == wxPAGE_EVEN)
 567         m_Headers[0] = header;
 568     if (pg == wxPAGE_ALL || pg == wxPAGE_ODD)
 569         m_Headers[1] = header;
 570 }
 571
 572
 573
 574 void wxHtmlEasyPrinting::SetFooter(const wxString& footer, int pg)
 575 {
 576     if (pg == wxPAGE_ALL || pg == wxPAGE_EVEN)
 577         m_Footers[0] = footer;
 578     if (pg == wxPAGE_ALL || pg == wxPAGE_ODD)
 579         m_Footers[1] = footer;
 580 }
 581
 582
 583
 584 wxHtmlPrintout *wxHtmlEasyPrinting::CreatePrintout()
 585 {
 586     wxHtmlPrintout *p = new wxHtmlPrintout(m_Name);
 587
 588     p->SetHeader(m_Headers[0], wxPAGE_EVEN);
 589     p->SetHeader(m_Headers[1], wxPAGE_ODD);
 590     p->SetFooter(m_Footers[0], wxPAGE_EVEN);
 591     p->SetFooter(m_Footers[1], wxPAGE_ODD);
 592
 593     p->SetMargins(m_PageSetupData->GetMarginTopLeft().y,
 594                     m_PageSetupData->GetMarginBottomRight().y,
 595                     m_PageSetupData->GetMarginTopLeft().x,
 596                     m_PageSetupData->GetMarginBottomRight().x);
 597
 598     return p;
 599 }
 600
 601
 602 // This hack forces the linker to always link in m_* files
 603 // (wxHTML doesn't work without handlers from these files)
 604 #include "wx/html/forcelnk.h"
 605 FORCE_WXHTML_MODULES()
 606
 607 #endif // wxUSE_HTML & wxUSE_PRINTING_ARCHITECTURE