sbDefaultBaseDeviceInfoRegistrar.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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
 */

#ifndef SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_
#define SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_

// Mozilla includes
#include <nsAutoLock.h>
#include <nsAutoPtr.h>
#include <nsCOMArray.h>

// Songibrd includes
#include <sbDeviceXMLInfo.h>
#include <sbIDeviceInfoRegistrar.h>

class sbIDevice;

class sbDefaultBaseDeviceInfoRegistrar:
        public sbIDeviceInfoRegistrar
{
public:
  NS_DECL_SBIDEVICEINFOREGISTRAR

  sbDefaultBaseDeviceInfoRegistrar();

protected:
  //
  // mDevice                    Device info device.
  // mDeviceXMLInfo             Device XML info data record.
  // mDeviceXMLInfoPresent      If true, device info is present in the device
  //                            XML info data record.
  //

  sbIDevice*                 mDevice;
  nsAutoPtr<sbDeviceXMLInfo> mDeviceXMLInfo;
  PRBool                     mDeviceXMLInfoPresent;

  nsresult GetDeviceXMLInfo(sbIDevice*        aDevice,
                            sbDeviceXMLInfo** aDeviceXMLInfo);

  nsresult GetDeviceXMLInfo(const nsACString& aDeviceXMLInfoSpec,
                            sbIDevice*        aDevice);

  virtual nsresult GetDeviceXMLInfoSpec(nsACString& aDeviceXMLInfoSpec);

  virtual nsresult GetDeviceXMLInfoExtensions(
                     nsACString& aDeviceXMLInfoExtensions);

  virtual nsresult GetDefaultDeviceXMLInfoSpec(nsACString& aDeviceXMLInfoSpec);

  virtual ~sbDefaultBaseDeviceInfoRegistrar();
};

#endif /* SBIDEFAULTBASEDEVICEINFOREGISTRAR_H_ */