sbBaseDeviceMarshall.h

Go to the documentation of this file.

#ifndef SBBASEDEVICEMARSHALL_H_
#define SBBASEDEVICEMARSHALL_H_

/*
 //
 // BEGIN SONGBIRD GPL
 //
 // This file is part of the Songbird web player.
 //
 // Copyright(c) 2005-2008 POTI, Inc.
 // http://songbirdnest.com
 //
 // This file may be licensed under the terms of of the
 // GNU General Public License Version 2 (the "GPL").
 //
 // Software distributed under the License is distributed
 // on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
 // express or implied. See the GPL for the specific language
 // governing rights and limitations.
 //
 // You should have received a copy of the GPL along with this
 // program. If not, go to http://www.gnu.org/licenses/gpl.html
 // or write to the Free Software Foundation, Inc.,
 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 //
 // END SONGBIRD GPL
 //
 */

#include <sbIDeviceMarshall.h>
#include <nsCOMPtr.h>
#include <sbIDeviceCompatibility.h>
#include <nsID.h>
#include <nsIArray.h>

class nsISimpleEnumerator;
class sbIDeviceControllerRegistrar;
class nsIPropertyBag;
class sbIDeviceController;

class sbBaseDeviceMarshall : public sbIDeviceMarshall
{
public:
  class CompatibilityComparer
  {
  public:
    CompatibilityComparer() :
      mBestMatch(nsnull)
    {
    }
    virtual PRBool Compare(sbIDeviceController* controller,
                         nsIPropertyBag* deviceParams);
    sbIDeviceController *GetBestMatch() const
    {
      return mBestMatch;
    }
  protected:
    void SetBestMatch(sbIDeviceController* deviceController, sbIDeviceCompatibility * compatibility)
    {
      mBestMatch = deviceController;
      mCompatibility = compatibility;
    }
  private:
    sbIDeviceController* mBestMatch;
    nsCOMPtr<sbIDeviceCompatibility> mCompatibility;
  };
  sbIDeviceController* FindCompatibleControllers(nsIPropertyBag* deviceParams)
  {
    CompatibilityComparer comparer;
    return FindCompatibleControllers(deviceParams, comparer);
  }
  sbIDeviceController* FindCompatibleControllers(nsIPropertyBag* deviceParams,
                                                 CompatibilityComparer & deviceComparer);
protected:
  virtual ~sbBaseDeviceMarshall();
  sbBaseDeviceMarshall(nsACString const & categoryName);
  void RegisterControllers(sbIDeviceControllerRegistrar * registrar);
  nsIArray* GetControllers() const
  {
    if (!mControllers) {
      // Logically const
      if (!const_cast<sbBaseDeviceMarshall*>(this)->RefreshControllers()) {
        NS_ASSERTION(PR_FALSE, "Something bad happened while refreshing the controllers");
        return nsnull;
      }
    }
    return mControllers.get();
  }
  nsIArray* RefreshControllers();
  void ClearMonitoringFlag()
  {
    mIsMonitoring = PR_FALSE;
  }
  PRBool IsMonitoring() const
  {
    return mIsMonitoring;
  }
private:
  nsCOMPtr<nsIArray> mControllers;
  nsCString mCategoryName;
  PRBool mIsMonitoring;
  nsresult GetCategoryManagerEnumerator(nsCOMPtr<nsISimpleEnumerator> & enumerator);
};

#endif