src/html/htmlctrl/webkit/webkit.mm

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        webkit.mm
   3 // Purpose:     wxWebKitCtrl - embeddable web kit control
   4 // Author:      Jethro Grassie / Kevin Ollivier
   5 // Modified by:
   6 // Created:     2004-4-16
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Jethro Grassie / Kevin Ollivier
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13     #pragma implementation "webkit.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18 #include "wx/splitter.h"
  19
  20 #ifndef WX_PRECOMP
  21     #include "wx/wx.h"
  22 #endif
  23
  24 #if wxUSE_WEBKIT
  25
  26 #ifdef __WXCOCOA__
  27 #include "wx/cocoa/autorelease.h"
  28 #else
  29 #include "wx/mac/uma.h"
  30 #include <Carbon/Carbon.h>
  31 #include <WebKit/HIWebView.h>
  32 #include <WebKit/CarbonUtils.h>
  33 #include <WebKit/WebKit.h>
  34 #endif
  35
  36 #include "wx/html/webkit.h"
  37 #include "wx/notebook.h"
  38
  39
  40 // ----------------------------------------------------------------------------
  41 // macros
  42 // ----------------------------------------------------------------------------
  43
  44 #if !USE_SHARED_LIBRARY
  45 IMPLEMENT_DYNAMIC_CLASS(wxWebKitCtrl, wxControl)
  46 #endif
  47
  48 BEGIN_EVENT_TABLE(wxWebKitCtrl, wxControl)
  49     EVT_SIZE(wxWebKitCtrl::OnSize)
  50 END_EVENT_TABLE()
  51
  52 // ----------------------------------------------------------------------------
  53 // wxWebKit Events
  54 // ----------------------------------------------------------------------------
  55
  56 IMPLEMENT_DYNAMIC_CLASS( wxWebKitStateChangedEvent, wxCommandEvent )
  57
  58 DEFINE_EVENT_TYPE( wxEVT_WEBKIT_STATE_CHANGED )
  59
  60 wxWebKitStateChangedEvent::wxWebKitStateChangedEvent( wxWindow* win )
  61 {
  62     SetEventType( wxEVT_WEBKIT_STATE_CHANGED);
  63     SetEventObject( win );
  64     SetId(win->GetId());
  65 }
  66
  67 //---------------------------------------------------------
  68 // helper functions for NSString<->wxString conversion
  69 //---------------------------------------------------------
  70
  71 inline wxString wxStringWithNSString(NSString *nsstring)
  72 {
  73 #if wxUSE_UNICODE
  74     return wxString([nsstring UTF8String], wxConvUTF8);
  75 #else
  76     return wxString([nsstring lossyCString]);
  77 #endif // wxUSE_UNICODE
  78 }
  79
  80 inline NSString* wxNSStringWithWxString(const wxString &wxstring)
  81 {
  82 #if wxUSE_UNICODE
  83     return [NSString stringWithUTF8String: wxstring.mb_str(wxConvUTF8)];
  84 #else
  85     return [NSString stringWithCString: wxstring.c_str() length:wxstring.Len()];
  86 #endif // wxUSE_UNICODE
  87 }
  88
  89 @interface MyFrameLoadMonitor : NSObject
  90 {
  91     wxWindow* webKitWindow;
  92 }
  93
  94 - initWithWxWindow: (wxWindow*)inWindow;
  95
  96 @end
  97
  98 // ----------------------------------------------------------------------------
  99 // creation/destruction
 100 // ----------------------------------------------------------------------------
 101
 102 bool wxWebKitCtrl::Create(wxWindow *parent,
 103                                  wxWindowID winID,
 104                                  const wxString& strURL,
 105                                  const wxPoint& pos,
 106                                  const wxSize& size, long style,
 107                                  const wxValidator& validator,
 108                                  const wxString& name)
 109 {
 110
 111     m_currentURL = strURL;
 112     //m_pageTitle = _("Untitled Page");
 113
 114  //still needed for wxCocoa??
 115 /*
 116     int width, height;
 117     wxSize sizeInstance;
 118     if (size.x == wxDefaultCoord || size.y == wxDefaultCoord)
 119     {
 120         m_parent->GetClientSize(&width, &height);
 121         sizeInstance.x = width;
 122         sizeInstance.y = height;
 123     }
 124     else
 125     {
 126         sizeInstance.x = size.x;
 127         sizeInstance.y = size.y;
 128     }
 129 */
 130     // now create and attach WebKit view...
 131 #ifdef __WXCOCOA__
 132     wxControl::Create(parent, m_windowID, pos, sizeInstance, style , validator , name);
 133     SetSize(pos.x, pos.y, sizeInstance.x, sizeInstance.y);
 134
 135     wxTopLevelWindowCocoa *topWin = wxDynamicCast(this, wxTopLevelWindowCocoa);
 136     NSWindow* nsWin = topWin->GetNSWindow();
 137     NSRect rect;
 138     rect.origin.x = pos.x;
 139     rect.origin.y = pos.y;
 140     rect.size.width = sizeInstance.x;
 141     rect.size.height = sizeInstance.y;
 142     m_webView = (WebView*)[[WebView alloc] initWithFrame:rect frameName:@"webkitFrame" groupName:@"webkitGroup"];
 143     SetNSView(m_webView);
 144     [m_cocoaNSView release];
 145
 146     if(m_parent) m_parent->CocoaAddChild(this);
 147     SetInitialFrameRect(pos,sizeInstance);
 148 #else
 149     m_macIsUserPane = false;
 150         wxControl::Create(parent, winID, pos, size, style , validator , name);
 151     m_peer = new wxMacControl(this);
 152     WebInitForCarbon();
 153     HIWebViewCreate( m_peer->GetControlRefAddr() );
 154
 155     m_webView = (WebView*) HIWebViewGetWebView( m_peer->GetControlRef() );
 156     MacPostControlCreate(pos, size);
 157     HIViewSetVisible( m_peer->GetControlRef(), true );
 158     [m_webView setHidden:false];
 159 #endif
 160
 161     // Register event listener interfaces
 162     MyFrameLoadMonitor* myFrameLoadMonitor = [[MyFrameLoadMonitor alloc] initWithWxWindow: (wxWindow*)this];
 163     [m_webView setFrameLoadDelegate:myFrameLoadMonitor];
 164
 165     LoadURL(m_currentURL);
 166     return true;
 167 }
 168
 169 wxWebKitCtrl::~wxWebKitCtrl()
 170 {
 171
 172 }
 173
 174 // ----------------------------------------------------------------------------
 175 // public methods
 176 // ----------------------------------------------------------------------------
 177
 178 void wxWebKitCtrl::LoadURL(const wxString &url)
 179 {
 180     if( !m_webView )
 181         return;
 182
 183     [[m_webView mainFrame] loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:wxNSStringWithWxString(url)]]];
 184
 185     m_currentURL = url;
 186 }
 187
 188 bool wxWebKitCtrl::CanGoBack(){
 189     if ( !m_webView )
 190         return false;
 191
 192     return [m_webView canGoBack];
 193 }
 194
 195 bool wxWebKitCtrl::CanGoForward(){
 196     if ( !m_webView )
 197         return false;
 198
 199     return [m_webView canGoForward];
 200 }
 201
 202 bool wxWebKitCtrl::GoBack(){
 203     if ( !m_webView )
 204         return false;
 205
 206     bool result = [(WebView*)m_webView goBack];
 207     return result;
 208 }
 209
 210 bool wxWebKitCtrl::GoForward(){
 211     if ( !m_webView )
 212         return false;
 213
 214     bool result = [(WebView*)m_webView goForward];
 215     return result;
 216 }
 217
 218 void wxWebKitCtrl::Reload(){
 219     if ( !m_webView )
 220         return;
 221
 222     [[m_webView mainFrame] reload];
 223 }
 224
 225 void wxWebKitCtrl::Stop(){
 226     if ( !m_webView )
 227         return;
 228
 229     [[m_webView mainFrame] stopLoading];
 230 }
 231
 232 bool wxWebKitCtrl::CanGetPageSource(){
 233     if ( !m_webView )
 234         return false;
 235
 236     WebDataSource* dataSource = [[m_webView mainFrame] dataSource];
 237     return ( [[dataSource representation] canProvideDocumentSource] );
 238 }
 239
 240 wxString wxWebKitCtrl::GetPageSource(){
 241
 242     if (CanGetPageSource()){
 243         WebDataSource* dataSource = [[m_webView mainFrame] dataSource];
 244         return wxStringWithNSString( [[dataSource representation] documentSource] );
 245     }
 246
 247     return wxEmptyString;
 248 }
 249
 250 void wxWebKitCtrl::SetPageSource(wxString& source, const wxString& baseUrl){
 251     if ( !m_webView )
 252         return;
 253
 254     if (CanGetPageSource()){
 255         [[m_webView mainFrame] loadHTMLString:(NSString*)wxNSStringWithWxString( source ) baseURL:[NSURL URLWithString:wxNSStringWithWxString( baseUrl )]];
 256     }
 257
 258 }
 259
 260 void wxWebKitCtrl::OnSize(wxSizeEvent &event){
 261     // This is a nasty hack because WebKit seems to lose its position when it is embedded
 262     // in a control that is not itself the content view for a TLW.
 263         // I put it in OnSize because these calcs are not perfect, and in fact are basically
 264         // guesses based on reverse engineering, so it's best to give people the option of
 265         // overriding OnSize with their own calcs if need be.
 266         // I also left some test debugging print statements as a convenience if a(nother)
 267         // problem crops up.
 268
 269         // Let's hope that Tiger fixes this mess...
 270
 271         int x, y;
 272         x = 0;
 273         y = 0;
 274
 275         bool isParentTopLevel = true;
 276
 277         wxWindow* parent = GetParent();
 278
 279         wxWindow* tlw = MacGetTopLevelWindow();
 280
 281         // This must be the case that Apple tested with, because well, in this one case
 282         // we don't need to do anything! It just works. ;)
 283         if (parent == tlw){
 284                 return;
 285         }
 286
 287         while(parent != NULL)
 288         {
 289                 if ( parent->IsKindOf( CLASSINFO( wxSplitterWindow ) ) && GetParent()->IsKindOf( CLASSINFO( wxSplitterWindow ) ) ){
 290                                 // When parent is not a wxSplitterWindow, we can rely on it's GetPosition() to give us the correct
 291                                 // coordinates, but when the parent is a wxSplitterWindow, we need to manually calculate
 292                                 // the sash position of it and any parent wxSplitterWindows into the webkit's position.
 293                                 wxSplitterWindow* splitter;
 294                                 splitter = dynamic_cast<wxSplitterWindow*>(parent);
 295                                 if (splitter->GetSplitMode() == wxSPLIT_HORIZONTAL){
 296                                         if (splitter->GetPosition().y > 0)
 297                                                 y += splitter->GetPosition().y;
 298
 299                                         if (splitter->GetSashSize() > 0)
 300                                                 y += splitter->GetSashSize();
 301
 302                                         if (splitter->GetSashPosition() > 0)
 303                                                 y += splitter->GetSashPosition();
 304                                 }
 305                                 else{
 306                                         if (splitter->GetPosition().x > 0)
 307                                                 x += splitter->GetPosition().x;
 308
 309                                         if (splitter->GetSashSize() > 0)
 310                                                 x += splitter->GetSashSize();
 311
 312                                         if (splitter->GetSashPosition() > 0)
 313                                                 x += splitter->GetSashPosition();
 314                                 }
 315                 }
 316                 else{
 317                         if (!parent->IsTopLevel()) {
 318                                 //printf("Parent: %s\n", parent->GetClassInfo()->GetClassName());
 319                                 int plusx = 0;
 320                                 plusx = parent->GetClientAreaOrigin().x + parent->GetPosition().x;
 321                                 if (plusx > 0){
 322                                         x += plusx;
 323                                         //printf("Parent: %s Added x: %d\n", parent->GetClassInfo()->GetClassName(), parent->GetClientAreaOrigin().x + parent->GetPosition().x);
 324                                 }
 325
 326                                 int plusy = 0;
 327                                 plusy = parent->GetClientAreaOrigin().y + parent->GetPosition().y;
 328                                 if (plusy > 0){
 329                                         y += plusy;
 330                                         //printf("Parent: %s Added y: %d\n", parent->GetClassInfo()->GetClassName(), parent->GetClientAreaOrigin().y + parent->GetPosition().y);
 331                                 }
 332                                 else{
 333                                         //printf("Parent: %s Origin: %d Position:%d\n", parent->GetClassInfo()->GetClassName(), parent->GetClientAreaOrigin().y, parent->GetPosition().y);
 334                                 }
 335
 336                         }
 337                         else{
 338                                 //
 339                                 x += parent->GetClientAreaOrigin().x;
 340                                 // calculate the title bar height (26 pixels) into the top offset.
 341                                 // This becomes important later when we must flip the y coordinate
 342                                 // to convert to Cocoa's coordinate system.
 343                                 y += parent->GetClientAreaOrigin().y += 26;
 344                                 //printf("x: %d, y:%d\n", x, y);
 345                         }
 346                         //we still need to add the y, because we have to convert/flip coordinates for Cocoa
 347
 348                         if ( parent->IsKindOf( CLASSINFO( wxNotebook ) )  ){
 349                                 //Not sure why calcs are off in this one scenario...
 350                                 y -= 4;
 351                                 //printf("x: %d, y:%d\n", x, y);
 352                         }
 353
 354                         if (parent->IsKindOf( CLASSINFO( wxPanel ) ) ){
 355                                 // Another strange case. Adding a wxPanel to the parent heirarchy
 356                                 // causes wxWebKitCtrl's Cocoa y origin to be 4 pixels off
 357                                 // for some reason, even if the panel has a position and origin of 0.
 358                                 // This corrects that. Man, I wish I could debug Carbon/HIWebView!! ;)
 359                                 y -= 4;
 360                         }
 361                 }
 362
 363                 parent = parent->GetParent();
 364         }
 365
 366         // Tried using MacWindowToRootWindow both for wxWebKitCtrl and its parent,
 367         // but coordinates were off by a significant amount.
 368         // Am leaving the code here if anyone wants to play with it.
 369
 370         //int x2, y2 = 0;
 371         //if (GetParent())
 372         //      GetParent()->MacWindowToRootWindow(&x2, &y2);
 373         //printf("x = %d, y = %d\n", x, y);
 374         //printf("x2 = %d, y2 = %d\n", x2, y2);
 375         //x = x2;
 376         //y = y2;
 377
 378         if (tlw){
 379                 //flip the y coordinate to convert to Cocoa coordinates
 380                 //printf("tlw y: %d, y: %d\n", tlw->GetSize().y, (GetSize().y + y));
 381                 y = tlw->GetSize().y - ((GetSize().y) + y);
 382         }
 383
 384         //printf("Added to bounds x=%d, y=%d\n", x, y);
 385         NSRect bounds = [m_webView frame];
 386         bounds.origin.x = x;
 387         bounds.origin.y = y;
 388         [m_webView setFrame:bounds];
 389
 390     //printf("Carbon position x=%d, y=%d\n", GetPosition().x, GetPosition().y);
 391     if (IsShown())
 392         [(WebView*)m_webView display];
 393     event.Skip();
 394 }
 395
 396 void wxWebKitCtrl::MacVisibilityChanged(){
 397     bool isHidden = !IsControlVisible( m_peer->GetControlRef());
 398     if (!isHidden)
 399         [(WebView*)m_webView display];
 400
 401     [m_webView setHidden:isHidden];
 402 }
 403
 404 //------------------------------------------------------------
 405 // Listener interfaces
 406 //------------------------------------------------------------
 407
 408 @implementation MyFrameLoadMonitor
 409
 410 - initWithWxWindow: (wxWindow*)inWindow
 411 {
 412     [super init];
 413     webKitWindow = inWindow;    // non retained
 414     return self;
 415 }
 416
 417 - (void)webView:(WebView *)sender didStartProvisionalLoadForFrame:(WebFrame *)frame
 418 {
 419     if (frame == [sender mainFrame]){
 420         NSString *url = [[[[frame provisionalDataSource] request] URL] absoluteString];
 421         wxWebKitStateChangedEvent thisEvent(webKitWindow);
 422         thisEvent.SetState(wxWEBKIT_STATE_NEGOTIATING);
 423         thisEvent.SetURL( wxStringWithNSString( url ) );
 424         webKitWindow->GetEventHandler()->ProcessEvent( thisEvent );
 425     }
 426 }
 427
 428 - (void)webView:(WebView *)sender didCommitLoadForFrame:(WebFrame *)frame
 429 {
 430     if (frame == [sender mainFrame]){
 431         NSString *url = [[[[frame dataSource] request] URL] absoluteString];
 432         wxWebKitStateChangedEvent thisEvent(webKitWindow);
 433         thisEvent.SetState(wxWEBKIT_STATE_TRANSFERRING);
 434         thisEvent.SetURL( wxStringWithNSString( url ) );
 435         webKitWindow->GetEventHandler()->ProcessEvent( thisEvent );
 436     }
 437 }
 438
 439 - (void)webView:(WebView *)sender didFinishLoadForFrame:(WebFrame *)frame
 440 {
 441     if (frame == [sender mainFrame]){
 442         NSString *url = [[[[frame dataSource] request] URL] absoluteString];
 443         wxWebKitStateChangedEvent thisEvent(webKitWindow);
 444         thisEvent.SetState(wxWEBKIT_STATE_STOP);
 445         thisEvent.SetURL( wxStringWithNSString( url ) );
 446         webKitWindow->GetEventHandler()->ProcessEvent( thisEvent );
 447     }
 448 }
 449
 450 - (void)webView:(WebView *)sender didFailLoadWithError:(NSError*) error forFrame:(WebFrame *)frame
 451 {
 452     if (frame == [sender mainFrame]){
 453         NSString *url = [[[[frame dataSource] request] URL] absoluteString];
 454         wxWebKitStateChangedEvent thisEvent(webKitWindow);
 455         thisEvent.SetState(wxWEBKIT_STATE_FAILED);
 456         thisEvent.SetURL( wxStringWithNSString( url ) );
 457         webKitWindow->GetEventHandler()->ProcessEvent( thisEvent );
 458     }
 459 }
 460
 461 - (void)webView:(WebView *)sender didFailProvisionalLoadWithError:(NSError*) error forFrame:(WebFrame *)frame
 462 {
 463     if (frame == [sender mainFrame]){
 464         NSString *url = [[[[frame provisionalDataSource] request] URL] absoluteString];
 465         wxWebKitStateChangedEvent thisEvent(webKitWindow);
 466         thisEvent.SetState(wxWEBKIT_STATE_FAILED);
 467         thisEvent.SetURL( wxStringWithNSString( url ) );
 468         webKitWindow->GetEventHandler()->ProcessEvent( thisEvent );
 469     }
 470 }
 471
 472 - (void)webView:(WebView *)sender didReceiveTitle:(NSString *)title forFrame:(WebFrame *)frame
 473 {
 474     if (frame == [sender mainFrame]){
 475         webKitWindow->SetTitle(wxStringWithNSString( title ));
 476     }
 477 }
 478 @end
 479
 480 #endif //wxUSE_WEBKIT