Clarify/fix fullscreen semantics, and add GetScreenSize

webkit/plugins/ppapi/ppapi_plugin_instance.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 #define WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 
 #include <map>
 #include <set>
 #include <string>
@@ skipping 168 matching lines @@
   void StopFind();
 
   bool SupportsPrintInterface();
   int PrintBegin(const gfx::Rect& printable_area, int printer_dpi);
   bool PrintPage(int page_number, WebKit::WebCanvas* canvas);
   void PrintEnd();
 
   void Graphics3DContextLost();
 
   // Implementation of PPB_Fullscreen_Dev.
+
+  // Because going to fullscreen is asynchronous (but going out is not), there
+  // are 3 states:
+  // - normal (fullscreen_container_ == NULL)

[viettrungluu, 2011/03/08 00:06:01]

I wonder if it'd be nicer to just have a state variable with explicit states.

[piman, 2011/03/08 00:55:30]

Now I would have 2 problems instead of 1 :)

+  // - fullscreen pending (fullscreen_container_ != NULL, fullscreen_ == false)
+  // - fullscreen (fullscreen_container_ != NULL, fullscreen_ = true)
+  //
+  // In normal state, events come from webkit and painting goes back to it.
+  // In fullscreen state, events come from the fullscreen container, and
+  // painting goes back to it
+  // In pending state, events from webkit are ignored, and as soon as we receive
+  // events from the fullscreen container, we go to the fullscreen state.
   bool IsFullscreen();
-  bool SetFullscreen(bool fullscreen);
+  bool IsFullscreenOrPending();
+
+  // Switches between fullscreen and normal mode. If |delay_report| is set to
+  // false, it may report the new state through DidChangeView immediately. If
+  // true, it will delay it. When called from the plugin, delay_report should be
+  // true to avoid re-entrancy.
+  void SetFullscreen(bool fullscreen, bool delay_report);
 
   // Implementation of PPB_Flash.
   bool NavigateToURL(const char* url, const char* target);
 
   PluginDelegate::PlatformContext3D* CreateContext3D();
 
   // Tracks all live ObjectVar. This is so we can map between PluginModule +
   // NPObject and get the ObjectVar corresponding to it. This Add/Remove
   // function should be called by the ObjectVar when it is created and
   // destroyed.
@@ skipping 12 matching lines @@
  private:
   bool LoadFindInterface();
   bool LoadPdfInterface();
   bool LoadSelectionInterface();
   bool LoadZoomInterface();
 
   // Determines if we think the plugin has focus, both content area and webkit
   // (see has_webkit_focus_ below).
   bool PluginHasFocus() const;
 
+  // Reports the current plugin geometry to the plugin.

[viettrungluu, 2011/03/08 00:06:01]

How does it report the geometry?

[piman, 2011/03/08 00:55:30]

Done.

+  void ReportGeometry();
+
   // Queries the plugin for supported print formats and sets |format| to the
   // best format to use. Returns false if the plugin does not support any
   // print format that we can handle (we can handle raster and PDF).
   bool GetPreferredPrintOutputFormat(PP_PrintOutputFormat_Dev* format);
   bool PrintPDFOutput(PP_Resource print_output, WebKit::WebCanvas* canvas);
   bool PrintRasterOutput(PP_Resource print_output, WebKit::WebCanvas* canvas);
 #if defined(OS_WIN)
   bool DrawJPEGToPlatformDC(const SkBitmap& bitmap,
                             const gfx::Rect& printable_area,
                             WebKit::WebCanvas* canvas);
@@ skipping 88 matching lines @@
   // The plugin 3D interface.
   const PPP_Graphics3D_Dev* plugin_graphics_3d_interface_;
 
   // Contains the cursor if it's set by the plugin.
   scoped_ptr<WebKit::WebCursorInfo> cursor_;
 
   // Set to true if this plugin thinks it will always be on top. This allows us
   // to use a more optimized painting path in some cases.
   bool always_on_top_;
 
-  // Plugin container for fullscreen mode. NULL if not in fullscreen mode.
+  // Plugin container for fullscreen mode. NULL if not in fullscreen mode. Note:
+  // there is a transition state where fullscreen_container_ is non-NULL but
+  // fullscreen_ is true (see above).

[viettrungluu, 2011/03/08 00:06:01]

is false?

   FullscreenContainer* fullscreen_container_;
 
+  // True if we are in fullscreen mode. Note: it is false during the transition.
+  bool fullscreen_;
+
   typedef std::set<PluginObject*> PluginObjectSet;
   PluginObjectSet live_plugin_objects_;
 
   // Tracks all live ObjectVars used by this module so we can map NPObjects to
   // the corresponding object. These are non-owning references.
   typedef std::map<NPObject*, ObjectVar*> NPObjectToObjectVarMap;
   NPObjectToObjectVarMap np_object_to_object_var_;
 
   DISALLOW_COPY_AND_ASSIGN(PluginInstance);
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_