src/html/htmlwin.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        htmlwin.cpp
   3 // Purpose:     wxHtmlWindow class for parsing & displaying HTML (implementation)
   4 // Author:      Vaclav Slavik
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999 Vaclav Slavik
   7 // Licence:     wxWindows Licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifdef __GNUG__
  12 #pragma implementation
  13 #endif
  14
  15 #include "wx/wxprec.h"
  16
  17 #include "wx/defs.h"
  18 #if wxUSE_HTML
  19
  20 #ifdef __BORDLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #ifndef WXPRECOMP
  25 #include "wx/wx.h"
  26 #endif
  27
  28 #include "wx/html/htmlwin.h"
  29 #include "wx/html/forcelnk.h"
  30
  31
  32
  33 //-----------------------------------------------------------------------------
  34 // wxHtmlWindow
  35 //-----------------------------------------------------------------------------
  36
  37
  38
  39 #include "wx/arrimpl.cpp"
  40 WX_DEFINE_OBJARRAY(HtmlHistoryArray)
  41
  42
  43 wxHtmlWindow::wxHtmlWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
  44                 long style, const wxString& name) : wxScrolledWindow(parent, id, pos, size, wxVSCROLL | wxHSCROLL, name)
  45 {
  46     m_tmpMouseMoved = FALSE;
  47     m_tmpLastLink = NULL;
  48     m_tmpCanDrawLocks = 0;
  49     m_FS = new wxFileSystem();
  50     m_RelatedStatusBar = -1;
  51     m_RelatedFrame = NULL;
  52     m_TitleFormat = "%s";
  53     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
  54     m_Cell = NULL;
  55     m_Parser = new wxHtmlWinParser(this);
  56     m_Parser -> SetFS(m_FS);
  57     SetBorders(10);
  58     m_HistoryPos = -1;
  59     m_HistoryOn = TRUE;
  60     m_Style = style;
  61     SetPage("<html><body></body></html>");
  62 }
  63
  64
  65
  66 wxHtmlWindow::~wxHtmlWindow()
  67 {
  68     HistoryClear();
  69
  70     if (m_Cell) delete m_Cell;
  71
  72     delete m_Parser;
  73     delete m_FS;
  74 }
  75
  76
  77
  78 void wxHtmlWindow::SetRelatedFrame(wxFrame* frame, const wxString& format)
  79 {
  80     m_RelatedFrame = frame;
  81     m_TitleFormat = format;
  82 }
  83
  84
  85
  86 void wxHtmlWindow::SetRelatedStatusBar(int bar)
  87 {
  88     m_RelatedStatusBar = bar;
  89 }
  90
  91
  92
  93 void wxHtmlWindow::SetFonts(wxString normal_face, wxString fixed_face, const int *sizes)
  94 {
  95     wxString op = m_OpenedPage;
  96
  97     m_Parser -> SetFonts(normal_face, fixed_face, sizes);
  98     SetPage(wxT("<html><body></body></html>")); // fonts changed => contents invalid
  99     if (!op.IsEmpty()) LoadPage(op);
 100 }
 101
 102
 103
 104 bool wxHtmlWindow::SetPage(const wxString& source)
 105 {
 106     wxClientDC *dc = new wxClientDC(this);
 107
 108     dc -> SetMapMode(wxMM_TEXT);
 109     SetBackgroundColour(wxColour(0xFF, 0xFF, 0xFF));
 110     m_OpenedPage = m_OpenedAnchor = m_OpenedPageTitle = wxEmptyString;
 111     m_Parser -> SetDC(dc);
 112     if (m_Cell) {
 113         delete m_Cell;
 114         m_Cell = NULL;
 115     }
 116     m_Cell = (wxHtmlContainerCell*) m_Parser -> Parse(source);
 117     delete dc;
 118     m_Cell -> SetIndent(m_Borders, wxHTML_INDENT_ALL, wxHTML_UNITS_PIXELS);
 119     m_Cell -> SetAlignHor(wxHTML_ALIGN_CENTER);
 120     CreateLayout();
 121     if (m_tmpCanDrawLocks == 0) Refresh();
 122     return TRUE;
 123 }
 124
 125
 126 bool wxHtmlWindow::LoadPage(const wxString& location)
 127 {
 128     wxFSFile *f;
 129     bool rt_val;
 130
 131     SetCursor(*wxHOURGLASS_CURSOR);
 132     wxYield();
 133
 134     m_tmpCanDrawLocks++;
 135     if (m_HistoryOn && (m_HistoryPos != -1)) { // store scroll position into history item
 136         int x, y;
 137         ViewStart(&x, &y);
 138         m_History[m_HistoryPos].SetPos(y);
 139     }
 140
 141     if (location[0] == '#') { // local anchor
 142         wxString anch = location.Mid(1) /*1 to end*/;
 143         m_tmpCanDrawLocks--;
 144         rt_val = ScrollToAnchor(anch);
 145     }
 146
 147     else {
 148         // load&display it:
 149         if (m_RelatedStatusBar != -1) {
 150             m_RelatedFrame -> SetStatusText(_("Connecting..."), m_RelatedStatusBar);
 151             Refresh();
 152         }
 153
 154         f = m_FS -> OpenFile(location);
 155         if (f == NULL) {
 156             wxString err;
 157
 158             err.Printf(_("Unable to open requested location :\n\n%s"), WXSTRINGCAST location);
 159             m_tmpCanDrawLocks--;
 160             Refresh();
 161             wxMessageBox(err, "Error");
 162
 163             SetCursor(*wxSTANDARD_CURSOR);
 164             return FALSE;
 165         }
 166
 167         else {
 168             wxNode *node;
 169             wxString src = wxEmptyString;
 170
 171             if (m_RelatedStatusBar != -1) {
 172                 wxString msg = _("Loading : ") + location;
 173                 m_RelatedFrame -> SetStatusText(msg, m_RelatedStatusBar);
 174                 Refresh();
 175             }
 176
 177             node = m_Filters.GetFirst();
 178             while (node){
 179                 wxHtmlFilter *h = (wxHtmlFilter*) node -> GetData();
 180                 if (h -> CanRead(*f)) {
 181                     src = h -> ReadFile(*f);
 182                     break;
 183                 }
 184                 node = node -> GetNext();
 185             }
 186             if (src == wxEmptyString) {
 187                 if (m_DefaultFilter == NULL) m_DefaultFilter = GetDefaultFilter();
 188                 src = m_DefaultFilter -> ReadFile(*f);
 189             }
 190
 191             m_FS -> ChangePathTo(f -> GetLocation());
 192             rt_val = SetPage(src);
 193             m_OpenedPage = f -> GetLocation();
 194             if (f -> GetAnchor() != wxEmptyString) {
 195 //                m_tmpCanDrawLocks--;
 196                 ScrollToAnchor(f -> GetAnchor());
 197 //                m_tmpCanDrawLocks++;
 198             }
 199
 200             delete f;
 201
 202             if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(_("Done"), m_RelatedStatusBar);
 203         }
 204     }
 205
 206     if (m_HistoryOn) { // add this page to history there:
 207         int c = m_History.GetCount() - (m_HistoryPos + 1);
 208
 209         m_HistoryPos++;
 210         for (int i = 0; i < c; i++)
 211             m_History.Remove(m_HistoryPos);
 212         m_History.Add(new HtmlHistoryItem(m_OpenedPage, m_OpenedAnchor));
 213     }
 214
 215     SetCursor(*wxSTANDARD_CURSOR);
 216
 217     wxYield();
 218     m_tmpCanDrawLocks--;
 219     Refresh();
 220     return rt_val;
 221 }
 222
 223
 224
 225 bool wxHtmlWindow::ScrollToAnchor(const wxString& anchor)
 226 {
 227     const wxHtmlCell *c = m_Cell -> Find(wxHTML_COND_ISANCHOR, &anchor);
 228     if (!c) return FALSE;
 229     else {
 230         int y;
 231
 232         for (y = 0; c != NULL; c = c -> GetParent()) y += c -> GetPosY();
 233         Scroll(-1, y / wxHTML_SCROLL_STEP);
 234         m_OpenedAnchor = anchor;
 235         return TRUE;
 236     }
 237 }
 238
 239
 240 void wxHtmlWindow::OnSetTitle(const wxString& title)
 241 {
 242     if (m_RelatedFrame) {
 243         wxString tit;
 244         tit.Printf(m_TitleFormat, title.c_str());
 245         m_RelatedFrame -> SetTitle(tit);
 246     }
 247     m_OpenedPageTitle = title;
 248 }
 249
 250
 251
 252
 253
 254 void wxHtmlWindow::CreateLayout()
 255 {
 256     int ClientWidth, ClientHeight;
 257
 258     if (!m_Cell) return;
 259
 260     if (m_Style == wxHW_SCROLLBAR_NEVER) {
 261         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // always off
 262         GetClientSize(&ClientWidth, &ClientHeight);
 263         m_Cell -> Layout(ClientWidth);
 264     }
 265
 266     else {
 267         GetClientSize(&ClientWidth, &ClientHeight);
 268 #ifndef __WXMSW__
 269         // VS : this looks extremely ugly under windoze, better fix needed!
 270         SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, ClientHeight * 2); // always on
 271 #endif
 272         GetClientSize(&ClientWidth, &ClientHeight);
 273         m_Cell -> Layout(ClientWidth);
 274         if (ClientHeight < m_Cell -> GetHeight() + GetCharHeight()) {
 275             SetScrollbars(
 276                   wxHTML_SCROLL_STEP, wxHTML_SCROLL_STEP,
 277                   m_Cell -> GetWidth() / wxHTML_SCROLL_STEP,
 278                   (m_Cell -> GetHeight() + GetCharHeight()) / wxHTML_SCROLL_STEP
 279                   /*cheat: top-level frag is always container*/);
 280         }
 281         else { /* we fit into window, no need for scrollbars */
 282             SetScrollbars(wxHTML_SCROLL_STEP, 1, m_Cell -> GetWidth() / wxHTML_SCROLL_STEP, 0); // disable...
 283             GetClientSize(&ClientWidth, &ClientHeight);
 284             m_Cell -> Layout(ClientWidth); // ...and relayout
 285         }
 286     }
 287 }
 288
 289
 290
 291 void wxHtmlWindow::ReadCustomization(wxConfigBase *cfg, wxString path)
 292 {
 293     wxString oldpath;
 294     wxString tmp;
 295     int p_fontsizes[7];
 296     wxString p_fff, p_ffn;
 297
 298     if (path != wxEmptyString) {
 299         oldpath = cfg -> GetPath();
 300         cfg -> SetPath(path);
 301     }
 302
 303     m_Borders = cfg -> Read("wxHtmlWindow/Borders", m_Borders);
 304     p_fff = cfg -> Read("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 305     p_ffn = cfg -> Read("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 306     for (int i = 0; i < 7; i++) {
 307         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 308         p_fontsizes[i] = cfg -> Read(tmp, m_Parser -> m_FontsSizes[i]);
 309     }
 310     SetFonts(p_ffn, p_fff, p_fontsizes);
 311
 312     if (path != wxEmptyString)
 313         cfg -> SetPath(oldpath);
 314 }
 315
 316
 317
 318 void wxHtmlWindow::WriteCustomization(wxConfigBase *cfg, wxString path)
 319 {
 320     wxString oldpath;
 321     wxString tmp;
 322
 323     if (path != wxEmptyString) {
 324         oldpath = cfg -> GetPath();
 325         cfg -> SetPath(path);
 326     }
 327
 328     cfg -> Write("wxHtmlWindow/Borders", (long) m_Borders);
 329     cfg -> Write("wxHtmlWindow/FontFaceFixed", m_Parser -> m_FontFaceFixed);
 330     cfg -> Write("wxHtmlWindow/FontFaceNormal", m_Parser -> m_FontFaceNormal);
 331     for (int i = 0; i < 7; i++) {
 332         tmp.Printf(wxT("wxHtmlWindow/FontsSize%i"), i);
 333         cfg -> Write(tmp, (long) m_Parser -> m_FontsSizes[i]);
 334     }
 335
 336     if (path != wxEmptyString)
 337         cfg -> SetPath(oldpath);
 338 }
 339
 340
 341
 342 bool wxHtmlWindow::HistoryBack()
 343 {
 344     wxString a, l;
 345
 346     if (m_HistoryPos < 1) return FALSE;
 347
 348     m_HistoryPos--;
 349
 350     l = m_History[m_HistoryPos].GetPage();
 351     a = m_History[m_HistoryPos].GetAnchor();
 352     m_HistoryOn = FALSE;
 353     m_tmpCanDrawLocks++;
 354     if (a == wxEmptyString) LoadPage(l);
 355     else LoadPage(l + "#" + a);
 356     m_HistoryOn = TRUE;
 357     wxYield();
 358     m_tmpCanDrawLocks--;
 359     Scroll(0, m_History[m_HistoryPos].GetPos());
 360     Refresh();
 361     return TRUE;
 362 }
 363
 364
 365
 366 bool wxHtmlWindow::HistoryForward()
 367 {
 368     wxString a, l;
 369
 370     if (m_HistoryPos == -1) return FALSE;
 371     if (m_HistoryPos >= (int)m_History.GetCount() - 1)return FALSE;
 372
 373     m_OpenedPage = wxEmptyString; // this will disable adding new entry into history in LoadPage()
 374
 375     m_HistoryPos++;
 376     l = m_History[m_HistoryPos].GetPage();
 377     a = m_History[m_HistoryPos].GetAnchor();
 378     m_HistoryOn = FALSE;
 379     m_tmpCanDrawLocks++;
 380     if (a == wxEmptyString) LoadPage(l);
 381     else LoadPage(l + "#" + a);
 382     m_HistoryOn = TRUE;
 383     wxYield();
 384     m_tmpCanDrawLocks--;
 385     Scroll(0, m_History[m_HistoryPos].GetPos());
 386     Refresh();
 387     return TRUE;
 388 }
 389
 390
 391
 392 void wxHtmlWindow::HistoryClear()
 393 {
 394     m_History.Empty();
 395     m_HistoryPos = -1;
 396 }
 397
 398
 399
 400 wxList wxHtmlWindow::m_Filters;
 401 wxHtmlFilter *wxHtmlWindow::m_DefaultFilter = NULL;
 402
 403 void wxHtmlWindow::CleanUpStatics()
 404 {
 405     if (m_DefaultFilter) delete m_DefaultFilter;
 406     m_DefaultFilter = NULL;
 407     m_Filters.DeleteContents(TRUE);
 408     m_Filters.Clear();
 409
 410 }
 411
 412
 413
 414 void wxHtmlWindow::AddFilter(wxHtmlFilter *filter)
 415 {
 416     m_Filters.Append(filter);
 417 }
 418
 419
 420
 421
 422 void wxHtmlWindow::OnLinkClicked(const wxHtmlLinkInfo& link)
 423 {
 424     LoadPage(link.GetHref());
 425 }
 426
 427
 428
 429 void wxHtmlWindow::OnDraw(wxDC& dc)
 430 {
 431     int x, y;
 432     wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
 433     int v_y, v_h;
 434
 435     if (m_tmpCanDrawLocks > 0) return;
 436     dc.SetMapMode(wxMM_TEXT);
 437 #if defined(_MSC_VER) && (_MSC_VER == 1200)
 438     ::SetMapMode((HDC)dc.GetHDC(), MM_TEXT);
 439 #endif
 440     dc.SetBackgroundMode(wxTRANSPARENT);
 441     ViewStart(&x, &y);
 442
 443     while (upd) {
 444         v_y = upd.GetY();
 445         v_h = upd.GetH();
 446         if (m_Cell) m_Cell -> Draw(dc, 0, 0, y * wxHTML_SCROLL_STEP + v_y, y * wxHTML_SCROLL_STEP + v_h + v_y);
 447         upd++;
 448     }
 449 }
 450
 451
 452
 453
 454 void wxHtmlWindow::OnSize(wxSizeEvent& event)
 455 {
 456     wxScrolledWindow::OnSize(event);
 457     CreateLayout();
 458 }
 459
 460
 461
 462 void wxHtmlWindow::OnKeyDown(wxKeyEvent& event)
 463 {
 464     int dummy;
 465     int sty, szy, cliy;
 466
 467     ViewStart(&dummy, &sty);
 468     GetClientSize(&dummy, &cliy); cliy /= wxHTML_SCROLL_STEP;
 469     GetVirtualSize(&dummy, &szy); szy /= wxHTML_SCROLL_STEP;
 470
 471     switch (event.KeyCode()) {
 472         case WXK_PAGEUP :
 473     case WXK_PRIOR :
 474                 Scroll(-1, sty - cliy);
 475                 break;
 476         case WXK_PAGEDOWN :
 477     case WXK_NEXT :
 478                 Scroll(-1, sty + cliy);
 479                 break;
 480         case WXK_HOME :
 481                 Scroll(-1, 0);
 482                 break;
 483         case WXK_END :
 484                 Scroll(-1, szy - cliy);
 485                 break;
 486         case WXK_UP :
 487                 Scroll(-1, sty - 1);
 488                 break;
 489         case WXK_DOWN :
 490                 Scroll(-1, sty + 1);
 491                 break;
 492     }
 493 }
 494
 495
 496
 497 void wxHtmlWindow::OnMouseEvent(wxMouseEvent& event)
 498 {
 499     m_tmpMouseMoved = TRUE;
 500
 501     if (event.ButtonDown()) {
 502         int sx, sy;
 503         wxPoint pos;
 504         wxString lnk;
 505
 506         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 507         pos = event.GetPosition();
 508
 509         if (m_Cell)
 510             m_Cell -> OnMouseClick(this, sx + pos.x, sy + pos.y, event);
 511     }
 512 }
 513
 514
 515
 516 void wxHtmlWindow::OnIdle(wxIdleEvent& event)
 517 {
 518     static wxCursor cur_hand(wxCURSOR_HAND), cur_arrow(wxCURSOR_ARROW);
 519
 520     if (m_tmpMouseMoved && (m_Cell != NULL)) {
 521         int sx, sy;
 522         int x, y;
 523         wxHtmlLinkInfo *lnk;
 524
 525         ViewStart(&sx, &sy); sx *= wxHTML_SCROLL_STEP; sy *= wxHTML_SCROLL_STEP;
 526         wxGetMousePosition(&x, &y);
 527         ScreenToClient(&x, &y);
 528         lnk = m_Cell -> GetLink(sx + x, sy + y);
 529
 530         if (lnk != m_tmpLastLink) {
 531             if (lnk == NULL) {
 532                 SetCursor(cur_arrow);
 533                 if (m_RelatedStatusBar != -1) m_RelatedFrame -> SetStatusText(wxEmptyString, m_RelatedStatusBar);
 534             }
 535             else {
 536                 SetCursor(cur_hand);
 537                 if (m_RelatedStatusBar != -1)
 538                     m_RelatedFrame -> SetStatusText(lnk -> GetHref(), m_RelatedStatusBar);
 539             }
 540             m_tmpLastLink = lnk;
 541         }
 542         m_tmpMouseMoved = FALSE;
 543     }
 544 }
 545
 546
 547
 548
 549 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindow,wxScrolledWindow)
 550
 551 BEGIN_EVENT_TABLE(wxHtmlWindow, wxScrolledWindow)
 552     EVT_SIZE(wxHtmlWindow::OnSize)
 553     EVT_LEFT_DOWN(wxHtmlWindow::OnMouseEvent)
 554     EVT_MOTION(wxHtmlWindow::OnMouseEvent)
 555     EVT_IDLE(wxHtmlWindow::OnIdle)
 556     EVT_KEY_DOWN(wxHtmlWindow::OnKeyDown)
 557 END_EVENT_TABLE()
 558
 559
 560
 561
 562
 563 // A module to allow initialization/cleanup
 564 // without calling these functions from app.cpp or from
 565 // the user's application.
 566
 567 class wxHtmlWinModule: public wxModule
 568 {
 569 DECLARE_DYNAMIC_CLASS(wxHtmlWinModule)
 570 public:
 571     wxHtmlWinModule() : wxModule() {}
 572     bool OnInit() { return TRUE; }
 573     void OnExit() { wxHtmlWindow::CleanUpStatics(); }
 574 };
 575
 576 IMPLEMENT_DYNAMIC_CLASS(wxHtmlWinModule, wxModule)
 577
 578
 579
 580
 581 ///// default mod handlers are forced there:
 582
 583 FORCE_LINK(m_layout)
 584 FORCE_LINK(m_fonts)
 585 FORCE_LINK(m_image)
 586 FORCE_LINK(m_list)
 587 FORCE_LINK(m_dflist)
 588 FORCE_LINK(m_pre)
 589 FORCE_LINK(m_hline)
 590 FORCE_LINK(m_links)
 591 FORCE_LINK(m_tables)
 592 FORCE_LINK(m_meta)
 593
 594
 595 #endif