sbDeviceXMLInfo.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 _SB_DEVICE_XML_INFO_H_
#define _SB_DEVICE_XML_INFO_H_

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird device XML info defs.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Songbird device XML info imported services.
//
//------------------------------------------------------------------------------

// Standard Includes
#include <stdarg.h>

// Songbird imports.
#include <sbIDevice.h>

// Mozilla imports.
#include <nsCOMPtr.h>
#include <nsIArray.h>
#include <nsIDOMDocument.h>
#include <nsIDOMElement.h>
#include <nsStringAPI.h>
#include <nsTArray.h>


//------------------------------------------------------------------------------
//
// Songbird device XML info defs.
//
//------------------------------------------------------------------------------

// Device info XML namespace.
#define SB_DEVICE_INFO_NS "http://songbirdnest.com/deviceinfo/1.0"


//------------------------------------------------------------------------------
//
// Songbird device XML info classes.
//
//------------------------------------------------------------------------------

class sbDeviceXMLInfo
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public :

  //
  // Public services.
  //

  nsresult Read(const char* aDeviceXMLInfoSpecList,
                const char* aExtensionsList = nsnull);

  nsresult Read(nsIURI *           aDeviceXMLInfoURI,
                const nsAString &  aExtensionsList);

  nsresult Read(nsIFile *          aDeviceXMLInfoFile,
                const nsAString &  aExtensionsList);

  nsresult Read(nsIInputStream *    aDeviceXMLInfoStream);

  nsresult Read(nsIDOMDocument* aDeviceXMLInfoDocument);

  nsresult GetDeviceInfoPresent(PRBool* aDeviceInfoPresent);

  nsresult GetDeviceInfoElement(nsIDOMElement** aDeviceInfoElement);

  nsresult GetDefaultName(nsAString& aDefaultName);

  nsresult GetDeviceFolder(const nsAString& aFolderType,
                           nsAString&       aFolderURL);

  nsresult GetDeviceFolder(PRUint32   aContentType,
                           nsAString& aFolderURL);

  nsresult GetImportRules(nsIArray ** aImportRules);

  nsresult GetMountTimeout(PRUint32* aMountTimeout);

  nsresult GetDoesDeviceSupportReformat(PRBool *aOutSupportsReformat);

  nsresult GetOnlyMountMediaFolders(PRBool* aOnlyMountMediaFolders);

  nsresult GetExcludedFolders(nsAString & aExcludedFolders);

  nsresult GetStorageDeviceInfoList(nsIArray** aStorageDeviceInfoList);

  nsresult GetDeviceIcon(nsAString& aDeviceIconURL);

  sbDeviceXMLInfo(sbIDevice* aDevice = nsnull);

  virtual ~sbDeviceXMLInfo();

  static nsCString GetDeviceIdentifier(sbIDevice * aDevice);

  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private :

  //
  // mDevice                    Device to use with XML info.
  // mDeviceInfoElement         Root device info element.
  // mDeviceElement             Device element matching device.  May be null if
  //                            device does not match a specific device element.
  //

  sbIDevice*                    mDevice;
  nsString                      mDeviceInfoVersion;
  nsCOMPtr<nsIDOMElement>       mDeviceInfoElement;
  nsCOMPtr<nsIDOMElement>       mDeviceElement;
  bool                          mLogDeviceInfo;


  nsresult DeviceMatchesDeviceInfoNode(nsIDOMNode*  aDeviceInfoNode,
                                       nsAString &  aFoundVersion,
                                       nsIDOMNode** aDeviceNode);

  nsresult GetDeviceInfoVersion(nsIDOMElement * aDeviceInfoElement,
                                nsAString &     aVersion);

  nsresult DeviceMatchesDeviceNode(nsIDOMNode*      aDeviceNode,
                                   nsIPropertyBag2* aDeviceProperties,
                                   PRBool*          aDeviceMatches);

  nsresult GetDeviceInfoNodes(const nsAString&                  aNameSpace,
                              const nsAString&                  aTagName,
                              nsTArray< nsCOMPtr<nsIDOMNode> >& aNodeList);

  nsresult GetDeviceInfoNodes(const nsAString&                  aTagName,
                              nsTArray< nsCOMPtr<nsIDOMNode> >& aNodeList);

  nsresult IsDeviceNodeDescendant(nsIDOMNode* aNode,
                                  PRBool*     aIsDeviceNodeDescendant);

  inline
  void Log(const char * aFmt, ...);

  void LogIfFailed(nsresult aRV, const char * aPrintf, ...);

  void LogArgs(const char * aFmt, va_list aArgs);
};


#endif // _SB_DEVICE_XML_INFO_H_