author ffxbld
Mon, 12 Jan 2015 23:08:57 -0500
changeset 242829 ca663986b6c337584a90a64ac0348cb42b10e184
parent 236314 41c37790896e424e2743811d3d19be00068ce941
child 251694 a5c9550c4e4ff746fbd83399057f8fadf92de459
permissions -rw-r--r--
Added FIREFOX_36_0b1_RELEASE FIREFOX_36_0b1_BUILD1 tag(s) for changeset 1b26127c3323. DONTBUILD CLOSED TREE a=release

/* vim: se cin sw=2 ts=2 et : */
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef __mozilla_widget_GfxInfoCollector_h__
#define __mozilla_widget_GfxInfoCollector_h__

#include "mozilla/Attributes.h"
#include "nsStringFwd.h"
#include "js/RootingAPI.h"

namespace mozilla {
namespace widget {

/* this is handy wrapper around JSAPI to make it more pleasant to use.
 * We collect the JSAPI errors and so that callers don't need to */
class MOZ_STACK_CLASS InfoObject
  friend class GfxInfoBase;

  void DefineProperty(const char *name, int value);
  void DefineProperty(const char *name, nsAString &value);
  void DefineProperty(const char *name, const char *value);

  // We need to ensure that this object lives on the stack so that GC sees it properly
  explicit InfoObject(JSContext *aCx);

  JSContext *mCx;
  JS::Rooted<JSObject*> mObj;
  bool mOk;


   Here's an example usage:

   class Foo {
   Foo::Foo() : mInfoCollector(this, &Foo::GetAweseomeness) {}

   void GetAwesomeness(InfoObject &obj) {
     obj.DefineProperty("awesome", mAwesome);

   int mAwesome;

   GfxInfoCollector<Foo> mInfoCollector;

   This will define a property on the object
   returned from calling getInfo() on a
   GfxInfo object. e.g.

       gfxInfo = Cc["@mozilla.org/gfx/info;1"].getService(Ci.nsIGfxInfo);
       info = gfxInfo.getInfo();
       if (info.awesome)


class GfxInfoCollectorBase
  virtual void GetInfo(InfoObject &obj) = 0;
  virtual ~GfxInfoCollectorBase();

template<class T>
class GfxInfoCollector : public GfxInfoCollectorBase
  GfxInfoCollector(T* aPointer, void (T::*aFunc)(InfoObject &obj)) : mPointer(aPointer), mFunc(aFunc) {
  virtual void GetInfo(InfoObject &obj) {

  T* mPointer;
  void (T::*mFunc)(InfoObject &obj);