ppapi_simple

native_client_sdk/src/libraries/ppapi_simple/ppapi_simple_instance.h

+// Copyright (c) 2013 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 PPAPI_SIMPLE_PPAPI_SIMPLE_INSTANCE_H_
+#define PPAPI_SIMPLE_PPAPI_SIMPLE_INSTANCE_H_
+
+#include <map>
+
+#include "ppapi/c/pp_instance.h"
+#include "ppapi/c/pp_stdint.h"
+#include "ppapi/c/ppb_core.h"
+#include "ppapi/c/ppb_var.h"
+#include "ppapi/c/ppb_view.h"
+
+#include "ppapi/cpp/fullscreen.h"
+#include "ppapi/cpp/instance.h"
+#include "ppapi/cpp/message_loop.h"
+#include "ppapi/cpp/mouse_lock.h"
+
+#include "ppapi/utility/completion_callback_factory.h"
+
+#include "ppapi_simple/ppapi_event.h"
+#include "ppapi_simple/ppapi_simple_main.h"
+
+#include "utils/thread_safe_queue.h"
+
+
+typedef std::map<std::string, std::string> PropertyMap_t;
+
+class PSInstance : public pp::Instance {
+ public:
+  enum Verbosity {
+    PS_SILENT_VERBOSITY,
+    PS_ERROR_VERBOSITY,
+    PS_WARN_VERBOSITY,
+    PS_LOG_VERBOSITY,
+  };
+
+  // Returns a pointer to the global instance
+  static PSInstance* GetInstance();
+
+  PSInstance(PP_Instance inst, const char *argv[]);
+  virtual ~PSInstance();
+
+  // Set a function which will be called on a new thread once initialized.
+  // NOTE:  This must be called by the Factory, once Init is called, this
+  // function will have no effect.
+  void SetMain(PSMainFunc_t func);
+
+  // Returns value based on KEY or default.
+  const char* GetProperty(const char* key, const char* def = NULL);
+
+  // Started on Init, a thread which can be safely blocked.
+  virtual int MainThread(int argc, const char* argv[]);
+
+  // Logging F
+  void SetVerbosity(Verbosity verbosity);
+  void Log(const char *fmt, ...);

[Sam Clegg, 2013/05/29 04:48:25]

IIRC you can mark these functions with GCC attributes which will allow the
compiler to warn you about bad augments: __attribute__ ((format (printf, 2,
3)));

http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html

[noelallen_use_chromium, 2013/05/30 00:25:07]

Unfortunately __attribute__ is not available on windows.  So we typically avoid
things that will fail to compile for host.

+  void Warn(const char *fmt, ...);
+  void Error(const char *fmt, ...);
+
+  // Event Functions
+  void SetEnabledEvents(uint32_t mask);
+  void PostEvent(PSEventType type);
+  void PostEvent(PSEventType type, PP_Bool bool_value);
+  void PostEvent(PSEventType type, PP_Resource resource);
+  void PostEvent(PSEventType type, const PP_Var& var);
+
+  PSEvent* TryAcquireEvent();
+  PSEvent* WaitAcquireEvent();
+  void ReleaseEvent(PSEvent* event);
+//
+ protected:
+  //
+  // Callback functions triggered by Pepepr
+  //
+  // These functions are called on the main pepper thread, so they must
+  // not block.
+  //
+  // Called by the browser when the NaCl module is loaded and all ready to go.
+  // This function will create a new thread which will run the pseudo main.
+  virtual bool Init(uint32_t argc, const char* argn[], const char* argv[]);
+
+  // Called whenever the in-browser window changes size, it will pass a
+  // context change request to whichever thread is handling rendering.
+  virtual void DidChangeView(const pp::View& view);
+
+  // Called by the browser when the NaCl canvas gets or loses focus.
+  virtual void DidChangeFocus(bool has_focus);
+
+  // Called by the browser to handle the postMessage() call in Javascript.
+  virtual void HandleMessage(const pp::Var& message);
+
+  // Called by the browser to handle incoming input events.  Events are Q'd
+  // and can later be processed on a sperate processing thread.
+  virtual bool HandleInputEvent(const pp::InputEvent& event);
+
+  // Called by Init to processes default and embed tag arguments prior to
+  // launching the 'ppapi_main' thread.
+  virtual bool ProcessProperties();
+
+  static void* MainThreadThunk(void *start_info);
+
+
+ protected:
+  pp::MessageLoop* main_loop_;
+
+  PropertyMap_t properties_;
+  ThreadSafeQueue<PSEvent> event_queue_;
+  uint32_t events_enabled_;
+  uint32_t verbosity_;
+
+  PSMainFunc_t main_cb_;
+
+  const PPB_Core* ppb_core_;
+  const PPB_Var* ppb_var_;
+  const PPB_View* ppb_view_;
+};
+
+#endif  // PPAPI_MAIN_PPAPI_INSTANCE_H_
+