Merge pull request #4775 from jmarshallnz/empty_episode_playcount
[vuplus_xbmc] / xbmc / NfoFile.h
1 /*
2  *      Copyright (C) 2005-2013 Team XBMC
3  *      http://xbmc.org
4  *
5  *  This Program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2, or (at your option)
8  *  any later version.
9  *
10  *  This Program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with XBMC; see the file COPYING.  If not, see
17  *  <http://www.gnu.org/licenses/>.
18  *
19  */
20 // NfoFile.h: interface for the CNfoFile class.
21 //
22 //////////////////////////////////////////////////////////////////////
23
24 #if !defined(AFX_NfoFile_H__641CCF68_6D2A_426E_9204_C0E4BEF12D00__INCLUDED_)
25 #define AFX_NfoFile_H__641CCF68_6D2A_426E_9204_C0E4BEF12D00__INCLUDED_
26
27 #pragma once
28
29 #include "utils/XBMCTinyXML.h"
30 #include "addons/Scraper.h"
31 #include "utils/CharsetConverter.h"
32 #include "utils/XMLUtils.h"
33
34 class CNfoFile
35 {
36 public:
37   CNfoFile() : m_doc(NULL), m_headofdoc(NULL), m_type(ADDON::ADDON_UNKNOWN) {}
38   virtual ~CNfoFile() { Close(); }
39
40   enum NFOResult
41   {
42     NO_NFO       = 0,
43     FULL_NFO     = 1,
44     URL_NFO      = 2,
45     COMBINED_NFO = 3,
46     ERROR_NFO    = 4
47   };
48
49   NFOResult Create(const CStdString&, const ADDON::ScraperPtr&, int episode=-1);
50   template<class T>
51     bool GetDetails(T& details,const char* document=NULL, bool prioritise=false)
52   {
53     CXBMCTinyXML doc;
54     CStdString strDoc;
55     if (document)
56       strDoc = document;
57     else
58       strDoc = m_headofdoc;
59
60     doc.Parse(strDoc, TIXML_ENCODING_UNKNOWN);
61     return details.Load(doc.RootElement(), true, prioritise);
62   }
63
64   void Close();
65   void SetScraperInfo(const ADDON::ScraperPtr& info) { m_info = info; }
66   const ADDON::ScraperPtr& GetScraperInfo() const { return m_info; }
67   const CScraperUrl &ScraperUrl() const { return m_scurl; }
68
69 private:
70   char* m_doc;
71   char* m_headofdoc;
72   ADDON::ScraperPtr m_info;
73   ADDON::TYPE m_type;
74   CScraperUrl m_scurl;
75
76   int Load(const CStdString&);
77   int Scrape(ADDON::ScraperPtr& scraper);
78 };
79
80 #endif // !defined(AFX_NfoFile_H__641CCF68_6D2A_426E_9204_C0E4BEF12D00__INCLUDED_)