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