modules/plugin/base/src/nsPluginNativeWindowGtk2.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:expandtab:shiftwidth=2:tabstop=2:
   3 */
   4 /* ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Sun Microsystems, Inc.
  21  * Portions created by the Initial Developer are Copyright (C) 2003
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   Robin Lu <robin.lu@sun.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either the GNU General Public License Version 2 or later (the "GPL"), or
  29  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 /**
  42  *  This file is the Gtk2 implementation of plugin native window.
  43  */
  44
  45 #include "nsDebug.h"
  46 #include "nsPluginNativeWindow.h"
  47 #include "npapi.h"
  48 #include <gtk/gtk.h>
  49 #include <gdk/gdkx.h>
  50 #include <gdk/gdk.h>
  51 #include "gtk2xtbin.h"
  52 #ifdef OJI
  53 #include "plstr.h"
  54 #include "nsIPlugin.h"
  55 #include "nsIPluginHost.h"
  56
  57 static NS_DEFINE_CID(kPluginManagerCID, NS_PLUGINMANAGER_CID);
  58 #endif
  59
  60 class nsPluginNativeWindowGtk2 : public nsPluginNativeWindow {
  61 public:
  62   nsPluginNativeWindowGtk2();
  63   virtual ~nsPluginNativeWindowGtk2();
  64
  65   virtual nsresult CallSetWindow(nsCOMPtr<nsIPluginInstance> &aPluginInstance);
  66 private:
  67   NPSetWindowCallbackStruct mWsInfo;
  68   /**
  69    * Either a GtkSocket or a special GtkXtBin widget (derived from GtkSocket)
  70    * that encapsulates the Xt toolkit within a Gtk Application.
  71    */
  72   GtkWidget* mSocketWidget;
  73   nsresult  CreateXEmbedWindow();
  74   nsresult  CreateXtWindow();
  75   void      SetAllocation();
  76   PRBool    CanGetValueFromPlugin(nsCOMPtr<nsIPluginInstance> &aPluginInstance);
  77 };
  78
  79 static gboolean plug_removed_cb   (GtkWidget *widget, gpointer data);
  80
  81 nsPluginNativeWindowGtk2::nsPluginNativeWindowGtk2() : nsPluginNativeWindow()
  82 {
  83   // initialize the struct fields
  84   window = nsnull;
  85   x = 0;
  86   y = 0;
  87   width = 0;
  88   height = 0;
  89   memset(&clipRect, 0, sizeof(clipRect));
  90   ws_info = &mWsInfo;
  91   type = nsPluginWindowType_Window;
  92   mSocketWidget = 0;
  93   mWsInfo.type = 0;
  94   mWsInfo.display = nsnull;
  95   mWsInfo.visual = nsnull;
  96   mWsInfo.colormap = 0;
  97   mWsInfo.depth = 0;
  98 }
  99
 100 nsPluginNativeWindowGtk2::~nsPluginNativeWindowGtk2()
 101 {
 102   if(mSocketWidget) {
 103     gtk_widget_destroy(mSocketWidget);
 104   }
 105 }
 106
 107 nsresult PLUG_NewPluginNativeWindow(nsPluginNativeWindow ** aPluginNativeWindow)
 108 {
 109   NS_ENSURE_ARG_POINTER(aPluginNativeWindow);
 110   *aPluginNativeWindow = new nsPluginNativeWindowGtk2();
 111   return *aPluginNativeWindow ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
 112 }
 113
 114 nsresult PLUG_DeletePluginNativeWindow(nsPluginNativeWindow * aPluginNativeWindow)
 115 {
 116   NS_ENSURE_ARG_POINTER(aPluginNativeWindow);
 117   nsPluginNativeWindowGtk2 *p = (nsPluginNativeWindowGtk2 *)aPluginNativeWindow;
 118   delete p;
 119   return NS_OK;
 120 }
 121
 122 nsresult nsPluginNativeWindowGtk2::CallSetWindow(nsCOMPtr<nsIPluginInstance> &aPluginInstance)
 123 {
 124   if(aPluginInstance) {
 125     if (type == nsPluginWindowType_Window) {
 126       nsresult rv;
 127       if(!mSocketWidget) {
 128         PRBool needXEmbed = PR_FALSE;
 129         if (CanGetValueFromPlugin(aPluginInstance)) {
 130           rv = aPluginInstance->GetValue
 131             ((nsPluginInstanceVariable)NPPVpluginNeedsXEmbed, &needXEmbed);
 132 #ifdef DEBUG
 133           printf("nsPluginNativeWindowGtk2: NPPVpluginNeedsXEmbed=%d\n", needXEmbed);
 134 #endif
 135         }
 136         if(needXEmbed) {
 137           CreateXEmbedWindow();
 138         }
 139         else {
 140           CreateXtWindow();
 141         }
 142       }
 143
 144       if(!mSocketWidget)
 145         return NS_ERROR_FAILURE;
 146
 147       // Make sure to resize and re-place the window if required.
 148       // Need to reset "window" each time as nsObjectFrame::DidReflow sets it
 149       // to the ancestor window.
 150       if(GTK_IS_XTBIN(mSocketWidget)) {
 151         gtk_xtbin_resize(mSocketWidget, width, height);
 152         // Point the NPWindow structures window to the actual X window
 153         window = (nsPluginPort *)GTK_XTBIN(mSocketWidget)->xtwindow;
 154       }
 155       else { // XEmbed
 156         SetAllocation();
 157         window = (nsPluginPort *)gtk_socket_get_id(GTK_SOCKET(mSocketWidget));
 158       }
 159 #ifdef DEBUG
 160       printf("nsPluginNativeWindowGtk2: call SetWindow with xid=%p\n", (void *)window);
 161 #endif
 162     } // nsPluginWindowType_Window
 163     aPluginInstance->SetWindow(this);
 164   }
 165   else if (mPluginInstance)
 166     mPluginInstance->SetWindow(nsnull);
 167
 168   SetPluginInstance(aPluginInstance);
 169   return NS_OK;
 170 }
 171
 172 nsresult nsPluginNativeWindowGtk2::CreateXEmbedWindow() {
 173   NS_ASSERTION(!mSocketWidget,"Already created a socket widget!");
 174
 175   GdkWindow *parent_win = gdk_window_lookup((XID)window);
 176   mSocketWidget = gtk_socket_new();
 177
 178   //attach the socket to the container widget
 179   gtk_widget_set_parent_window(mSocketWidget, parent_win);
 180
 181   // Make sure to handle the plug_removed signal.  If we don't the
 182   // socket will automatically be destroyed when the plug is
 183   // removed, which means we're destroying it more than once.
 184   // SYNTAX ERROR.
 185   g_signal_connect(mSocketWidget, "plug_removed",
 186                    G_CALLBACK(plug_removed_cb), NULL);
 187
 188   g_signal_connect(mSocketWidget, "destroy",
 189                    GTK_SIGNAL_FUNC(gtk_widget_destroyed), &mSocketWidget);
 190
 191   gpointer user_data = NULL;
 192   gdk_window_get_user_data(parent_win, &user_data);
 193
 194   GtkContainer *container = GTK_CONTAINER(user_data);
 195   gtk_container_add(container, mSocketWidget);
 196   gtk_widget_realize(mSocketWidget);
 197
 198   // Resize before we show
 199   SetAllocation();
 200
 201   gtk_widget_show(mSocketWidget);
 202
 203   gdk_flush();
 204   window = (nsPluginPort *)gtk_socket_get_id(GTK_SOCKET(mSocketWidget));
 205
 206   // Fill out the ws_info structure.
 207   // (The windowless case is done in nsObjectFrame.cpp.)
 208   GdkWindow *gdkWindow = gdk_window_lookup((XID)window);
 209   mWsInfo.display = GDK_WINDOW_XDISPLAY(gdkWindow);
 210   mWsInfo.colormap = GDK_COLORMAP_XCOLORMAP(gdk_drawable_get_colormap(gdkWindow));
 211   GdkVisual* gdkVisual = gdk_drawable_get_visual(gdkWindow);
 212   mWsInfo.visual = GDK_VISUAL_XVISUAL(gdkVisual);
 213   mWsInfo.depth = gdkVisual->depth;
 214
 215   return NS_OK;
 216 }
 217
 218 void nsPluginNativeWindowGtk2::SetAllocation() {
 219   if (!mSocketWidget)
 220     return;
 221
 222   GtkAllocation new_allocation;
 223   new_allocation.x = 0;
 224   new_allocation.y = 0;
 225   new_allocation.width = width;
 226   new_allocation.height = height;
 227   gtk_widget_size_allocate(mSocketWidget, &new_allocation);
 228 }
 229
 230 nsresult nsPluginNativeWindowGtk2::CreateXtWindow() {
 231   NS_ASSERTION(!mSocketWidget,"Already created a socket widget!");
 232
 233 #ifdef NS_DEBUG
 234   printf("About to create new xtbin of %i X %i from %p...\n",
 235          width, height, (void*)window);
 236 #endif
 237   GdkWindow *gdkWindow = gdk_window_lookup((XID)window);
 238   mSocketWidget = gtk_xtbin_new(gdkWindow, 0);
 239   // Check to see if creating the xtbin failed for some reason.
 240   // if it did, we can't go any further.
 241   if (!mSocketWidget)
 242     return NS_ERROR_FAILURE;
 243
 244   gtk_widget_set_size_request(mSocketWidget, width, height);
 245
 246 #ifdef NS_DEBUG
 247   printf("About to show xtbin(%p)...\n", (void*)mSocketWidget); fflush(NULL);
 248 #endif
 249   gtk_widget_show(mSocketWidget);
 250 #ifdef NS_DEBUG
 251   printf("completed gtk_widget_show(%p)\n", (void*)mSocketWidget); fflush(NULL);
 252 #endif
 253
 254   // Fill out the ws_info structure.
 255   GtkXtBin* xtbin = GTK_XTBIN(mSocketWidget);
 256   // The xtbin has its own Display structure.
 257   mWsInfo.display = xtbin->xtdisplay;
 258   mWsInfo.colormap = xtbin->xtclient.xtcolormap;
 259   mWsInfo.visual = xtbin->xtclient.xtvisual;
 260   mWsInfo.depth = xtbin->xtclient.xtdepth;
 261   // Leave mWsInfo.type = 0 - Who knows what this is meant to be?
 262
 263   XFlush(mWsInfo.display);
 264
 265   return NS_OK;
 266 }
 267
 268 PRBool nsPluginNativeWindowGtk2::CanGetValueFromPlugin(nsCOMPtr<nsIPluginInstance> &aPluginInstance)
 269 {
 270 #ifdef OJI
 271   if(aPluginInstance) {
 272     nsresult rv;
 273     nsCOMPtr<nsIPluginInstancePeer> peer;
 274
 275     rv = aPluginInstance->GetPeer(getter_AddRefs(peer));
 276     if (NS_SUCCEEDED(rv) && peer) {
 277       const char *aMimeType = nsnull;
 278
 279       peer->GetMIMEType((nsMIMEType*)&aMimeType);
 280       if (aMimeType &&
 281           (PL_strncasecmp(aMimeType, "application/x-java-vm", 21) == 0 ||
 282            PL_strncasecmp(aMimeType, "application/x-java-applet", 25) == 0)) {
 283         nsCOMPtr<nsIPluginHost> pluginHost = do_GetService(kPluginManagerCID, &rv);
 284         if (NS_SUCCEEDED(rv) && pluginHost) {
 285           nsIPlugin* pluginFactory = NULL;
 286
 287           rv = pluginHost->GetPluginFactory("application/x-java-vm", &pluginFactory);
 288           if (NS_SUCCEEDED(rv) && pluginFactory) {
 289             const char * jpiDescription = NULL;
 290
 291             pluginFactory->GetValue(nsPluginVariable_DescriptionString, (void*)&jpiDescription);
 292             if (!jpiDescription)
 293               return PR_FALSE;
 294
 295             /**
 296              * "Java(TM) Plug-in" is Sun's Java Plugin Trademark,
 297              * so we are sure that this is Sun 's Java Plugin if
 298              * the description start with "Java(TM) Plug-in"
 299              **/
 300             if (PL_strncasecmp(jpiDescription, "Java(TM) Plug-in", 16) == 0) {
 301               // Java Plugin support Xembed from JRE 1.5
 302               if (PL_strcasecmp(jpiDescription + 17, "1.5") < 0)
 303                 return PR_FALSE;
 304             }
 305             if (PL_strncasecmp(jpiDescription, "<a href=\"http://www.blackdown.org/java-linux.html\">", 51) == 0) {
 306               // Java Plugin support Xembed from JRE 1.5
 307               if (PL_strcasecmp(jpiDescription + 92, "1.5") < 0)
 308                 return PR_FALSE;
 309             }
 310             if (PL_strncasecmp(jpiDescription, "IBM Java(TM) Plug-in", 20) == 0) {
 311               // Java Plugin support Xembed from JRE 1.5
 312               if (PL_strcasecmp(jpiDescription + 27, "1.5") < 0)
 313                 return PR_FALSE;
 314             }
 315           }
 316         }
 317       }
 318     }
 319   }
 320 #endif
 321
 322   return PR_TRUE;
 323 }
 324
 325 /* static */
 326 gboolean
 327 plug_removed_cb (GtkWidget *widget, gpointer data)
 328 {
 329   // Gee, thanks for the info!
 330   return TRUE;
 331 }
 332
 333