include/OffscreenGecko/embedding.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is OffscreenGecko code.
 *
 * The Initial Developer of the Original Code is
 * Frank Richter <frank.richter@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef __OFFSCREENGECKO_EMBEDDING_H__
#define __OFFSCREENGECKO_EMBEDDING_H__

#include "baseobj.h"
#include "componentmgr.h"
#include "geckomem.h"
#include "string.h"

OSGK_DERIVEDTYPE(OSGK_EmbeddingOptions);

OSGK_EXTERN_C OSGK_API OSGK_EmbeddingOptions* osgk_embedding_options_create (void);

OSGK_EXTERN_C OSGK_API void osgk_embedding_options_add_search_path (
  OSGK_EmbeddingOptions* options, const char* path);

OSGK_EXTERN_C OSGK_API void osgk_embedding_options_add_components_path (
  OSGK_EmbeddingOptions* options, const char* path);

OSGK_EXTERN_C OSGK_API void osgk_embedding_options_set_profile_dir (
  OSGK_EmbeddingOptions* options, const char* profileDir,
  const char* localProfileDir OSGK_DEFAULT_ARG(0) );

#ifdef __cplusplus

namespace OSGK
{
  struct EmbeddingOptions : public CXXAPI::Wrap<OSGK_EmbeddingOptions>
  {
    EmbeddingOptions() : WrapperType (osgk_embedding_options_create()) { }

    explicit EmbeddingOptions (WrappedType* obj) : WrapperType (obj) {}
    EmbeddingOptions& operator=(const EmbeddingOptions& other)
    {
      WrapperType::operator=(other);
      return *this;
    }

    void AddSearchPath (const char* path)
    {
      osgk_embedding_options_add_search_path (GetObject(), path);
    }

    void AddComponentsPath (const char* path)
    {
      osgk_embedding_options_add_components_path (GetObject(), path);
    }

    void SetProfileDir (const char* profileDir,
      const char* localProfileDir = 0)
    {
      osgk_embedding_options_set_profile_dir (GetObject(), profileDir,
        localProfileDir);
    }
  };
  
} // namespace OSGK
#endif

OSGK_DERIVEDTYPE(OSGK_Embedding);

#define OSGK_API_VERSION    1

#ifndef OSGK___DOXYRUN__

OSGK_EXTERN_C OSGK_API OSGK_Embedding* osgk_embedding_create2 (
  unsigned int apiVer, OSGK_EmbeddingOptions* options, 
  OSGK_GeckoResult* geckoResult);
#endif

static OSGK_INLINE OSGK_Embedding* osgk_embedding_create (
  OSGK_GeckoResult* geckoResult OSGK_DEFAULT_ARG(0))
{
  return osgk_embedding_create2 (OSGK_API_VERSION, 0, geckoResult);
}

static OSGK_INLINE OSGK_Embedding* osgk_embedding_create_with_options (
  OSGK_EmbeddingOptions* options, OSGK_GeckoResult* geckoResult OSGK_DEFAULT_ARG(0))
{
  return osgk_embedding_create2 (OSGK_API_VERSION, options, geckoResult);
}

OSGK_EXTERN_C OSGK_API OSGK_GeckoMem* osgk_embedding_get_gecko_mem (
  OSGK_Embedding* embedding);

OSGK_EXTERN_C OSGK_API OSGK_ComponentMgr* osgk_embedding_get_component_mgr (
  OSGK_Embedding* embedding);

OSGK_CLASSTYPE_DEF nsIComponentManager;
OSGK_CLASSTYPE_DEF nsIComponentRegistrar;
OSGK_CLASSTYPE_DEF nsIServiceManager;

OSGK_EXTERN_C OSGK_API OSGK_CLASSTYPE_REF nsIComponentManager* 
osgk_embedding_get_gecko_component_manager (OSGK_Embedding* embedding);
OSGK_EXTERN_C OSGK_API OSGK_CLASSTYPE_REF nsIComponentRegistrar* 
osgk_embedding_get_gecko_component_registrar (OSGK_Embedding* embedding);
OSGK_EXTERN_C OSGK_API OSGK_CLASSTYPE_REF nsIServiceManager* 
osgk_embedding_get_gecko_service_manager (OSGK_Embedding* embedding);

// @@@ Right place?
enum
{
  jsgPrivileged = 1
};
OSGK_EXTERN_C OSGK_API int osgk_embedding_register_js_global (
  OSGK_Embedding* embedding, const char* name, const char* contractID,
  unsigned int flags, OSGK_String** previousContract OSGK_DEFAULT_ARG(0),
  OSGK_GeckoResult* geckoResult OSGK_DEFAULT_ARG(0));

OSGK_EXTERN_C OSGK_API void osgk_embedding_clear_focus (
  OSGK_Embedding* embedding);
  
OSGK_EXTERN_C OSGK_API void osgk_embedding_set_auto_focus (
  OSGK_Embedding* embedding, int autoFocus);
  
OSGK_EXTERN_C OSGK_API int osgk_embedding_get_auto_focus (
  OSGK_Embedding* embedding);
#ifdef __cplusplus

namespace OSGK
{
  struct Embedding : public CXXAPI::Wrap<OSGK_Embedding>
  {
    Embedding() : WrapperType (osgk_embedding_create()) { }
    Embedding (OSGK_GeckoResult& result) : 
      WrapperType (osgk_embedding_create (&result)) { }
    Embedding(EmbeddingOptions& opt) : WrapperType (
      osgk_embedding_create_with_options (opt.GetObject())) { }
    Embedding (EmbeddingOptions& opt, OSGK_GeckoResult& result) : 
      WrapperType (osgk_embedding_create_with_options (
        opt.GetObject(), &result)) { }

    explicit Embedding (WrappedType* obj) : WrapperType (obj) {}
    Embedding& operator=(const Embedding& other)
    {
      WrapperType::operator=(other);
      return *this;
    }

    GeckoMem GetGeckoMem ()
    {
      OSGK_GeckoMem* geckoMem = 
        osgk_embedding_get_gecko_mem (GetObject ());
      /* A reference to geckoMem was *not* implicitly added. Add one so the 
         wrapper works right */
      osgk_addref (geckoMem);
      return GeckoMem (geckoMem);
    }
    
    ComponentMgr GetComponentMgr()
    {
      OSGK_ComponentMgr* compMgr = 
        osgk_embedding_get_component_mgr (GetObject ());
      /* A reference to compMgr was *not* implicitly added. Add one so the 
         wrapper works right */
      osgk_addref (compMgr);
      return ComponentMgr (compMgr);
    }
    
    nsIComponentManager* GetGeckoComponentManager ()
    {
      return osgk_embedding_get_gecko_component_manager (GetObject());
    }
    nsIComponentRegistrar*  GetGeckoComponentRegistrar ()
    {
      return osgk_embedding_get_gecko_component_registrar (GetObject ());
    }
    nsIServiceManager* GetGeckoServiceManager ()
    {
      return osgk_embedding_get_gecko_service_manager (GetObject ());
    }

    bool RegisterJSGlobal (const char* name, const char* contractID,
      unsigned int flags)
    {
      return osgk_embedding_register_js_global (GetObject(), name,
        contractID, flags) != 0;
    }
    bool RegisterJSGlobal (const char* name, const char* contractID,
      unsigned int flags, String& previous)
    {
      OSGK_String* str;
      bool ret = osgk_embedding_register_js_global (GetObject(), name,
        contractID, flags, &str) != 0;
      previous = String (str);
      return ret;
    }
    bool RegisterJSGlobal (const char* name, const char* contractID,
      unsigned int flags, OSGK_GeckoResult& geckoResult)
    {
      return osgk_embedding_register_js_global (GetObject(), name,
        contractID, flags, 0, &geckoResult) != 0;
    }
    bool RegisterJSGlobal (const char* name, const char* contractID,
      unsigned int flags, String& previous, OSGK_GeckoResult& geckoResult)
    {
      OSGK_String* str;
      bool ret = osgk_embedding_register_js_global (GetObject(), name,
        contractID, flags, &str, &geckoResult) != 0;
      previous = String (str);
      return ret;
    }
    
    void ClearFocus ()
    {
      osgk_embedding_clear_focus (GetObject ());
    }
    
    void SetAutoFocus (bool autoFocus)
    {
      osgk_embedding_set_auto_focus (GetObject(), autoFocus);
    }
    
    bool GetAutoFocus ()
    {
      return osgk_embedding_get_auto_focus (GetObject()) != 0;
    }
  };
  
} // namespace OSGK
#endif

#endif // __OFFSCREENGECKO_EMBEDDING_H__

---