sbiTunesXMLParser.h

Go to the documentation of this file.

/*
 //
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2009 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
//
 */
#ifndef SBITUNESXMLPARSER_H_
#define SBITUNESXMLPARSER_H_

#include <nsTArray.h>
#include <nsCOMPtr.h>
#include <nsISAXContentHandler.h>
#include <nsISAXErrorHandler.h>
#include <nsISAXXMLReader.h>
#include <nsStringAPI.h>
#include <sbIStringMap.h>

#include <sbIiTunesXMLParser.h>

class nsIInputStream;
class nsIInputStreamPump;

typedef nsCOMPtr<nsISAXXMLReader> nsISAXXMLReaderPtr;

#define SBITUNESXMLPARSER_CONTRACTID                     \
  "@songbirdnest.com/Songbird/sbiTunesXMLParser;1"
#define SBITUNESXMLPARSER_CLASSNAME                      \
  "Songbird iTunes XML Parser Interface"
// {F0EBF580-C5FB-4efc-960A-50BEF0BCEDCC}
#define SBITUNESXMLPARSER_CID                            \
{ 0xf0ebf580, 0xc5fb, 0x4efc, { 0x96, 0xa, 0x50, 0xbe, 0xf0, 0xbc, 0xed, 0xcc } }

class sbiTunesXMLParser : public sbIiTunesXMLParser, 
                          public nsISAXContentHandler, 
                          public nsISAXErrorHandler 
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_SBIITUNESXMLPARSER
  NS_DECL_NSISAXCONTENTHANDLER
  NS_DECL_NSISAXERRORHANDLER

  // For use when directly allocating a parser
  static sbiTunesXMLParser * New();
  sbiTunesXMLParser();

protected:
  ~sbiTunesXMLParser();
private:
  enum State
  {
    START,                     // Initial state
    TOP_LEVEL_PROPERTIES,      // Base top level properties state <dict>
    
    TRACKS,                    // Found the Tracks section 
    TRACKS_COLLECTION,         // In the tracks collection <dict>
    TRACK,                     // Base track state <dict>
    
    PLAYLISTS,                 // Playlists section
    PLAYLISTS_COLLECTION,      // Playlists collection <array>
    PLAYLIST,                  // Base playlist state <dict>
    PLAYLIST_ITEMS,            // Playlist items collection <array>
    PLAYLIST_ITEM,             // Base playlist item state <dict>
    DONE                       // We're done, ignore the rest
  };
  
  // Typedefs
  typedef nsCOMPtr<sbIMutableStringMap> sbIMutableStringMapPtr;
  typedef nsCOMPtr<sbIiTunesXMLParserListener> sbIiTunesXMLParserListenerPtr;
  typedef nsTArray<PRInt32> Tracks;
  typedef nsCOMPtr<nsIInputStream> nsIInputStreamPtr;
  
  nsISAXXMLReaderPtr const & GetSAXReader();
  nsresult InitializeProperties();

  nsresult ClearProperties();
  
  PRInt32 mState;
  sbIMutableStringMapPtr mProperties;
  nsCOMPtr<nsIInputStreamPump> mPump;
  nsISAXXMLReaderPtr mSAXReader;
  nsString mPropertyName;
  nsString mCharacters;
  sbIiTunesXMLParserListenerPtr mListener;
  Tracks mTracks;
  PRInt64 mBytesRead;
};

#endif /* SBITUNESXMLPARSER_H_ */