kworship/playlist/KwPlaylistItem.cpp

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship 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 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship 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 KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 /**
  21  * @file KwPlaylistItem.cpp
  22  * @brief An item that can be added to a playlist.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwPlaylistItem.h"
  27 #include "KwPlaylistUnknown.h"
  28 #include "KwResourceLink.h"
  29 #include <KwDisplayStyles.h>
  30
  31 #include <QDomDocument>
  32 #include <QDomElement>
  33
  34 /*
  35  * Item factory
  36  */
  37
  38 /// Get a factory object.
  39 KwPlaylistItem::Factory* KwPlaylistItem::factory()
  40 {
  41   static Factory fac;
  42   return &fac;
  43 }
  44
  45 /*
  46  * Constructors + destructor.
  47  */
  48
  49 /// Default constructor.
  50 KwPlaylistItem::KwPlaylistItem()
  51 : KwFilterObject()
  52 , KwCssScope(KwDisplayStyles::schema())
  53 , m_domDocument()
  54 , m_domPreserve(m_domDocument.createDocumentFragment())
  55 {
  56 }
  57
  58 /// Construct from a DOM element.
  59 KwPlaylistItem::KwPlaylistItem(const QDomElement& element, KwResourceManager* resourceManager)
  60 : KwCssScope(KwDisplayStyles::schema())
  61 , m_domDocument()
  62 , m_domPreserve(m_domDocument.createDocumentFragment())
  63 {
  64   // Import the children of element into m_domPreserve
  65   QDomNodeList children = element.childNodes();
  66   for (int i = 0; i < children.size(); ++i)
  67   {
  68     QDomNode child = children.item(i);
  69     if (child.isElement())
  70     {
  71       QDomElement childElement = child.toElement();
  72       if (childElement.tagName() == "resource")
  73       {
  74         QString name = childElement.attribute("name");
  75         if (!name.isEmpty())
  76         {
  77           setResource(name, new KwResourceLink(childElement, resourceManager));
  78           // Don't preserve this resource
  79           continue;
  80         }
  81       }
  82       else if (childElement.tagName() == "style")
  83       {
  84         importStylesFromDom(childElement, resourceManager);
  85         continue;
  86       }
  87     }
  88     QDomNode preserved = m_domDocument.importNode(child, true); // deep copy
  89     m_domPreserve.appendChild(preserved);
  90   }
  91 }
  92
  93 /// Destructor.
  94 KwPlaylistItem::~KwPlaylistItem()
  95 {
  96   // Delete resource links
  97   Resources::iterator it;
  98   for (it = m_resources.begin(); it != m_resources.end(); ++it)
  99   {
 100     delete (*it).link;
 101   }
 102 }
 103
 104 /*
 105  * DOM Translation.
 106  */
 107
 108 /// Create an item from a DOM element.
 109 KwPlaylistItem* KwPlaylistItem::createFromDom(const QDomElement& element, KwResourceManager* resourceManager)
 110 {
 111   // Look at the type
 112   QString type = element.attribute("type");
 113   KwPlaylistItem* item = factory()->construct(type, element, resourceManager);
 114   if (0 == item)
 115   {
 116     item = new KwPlaylistUnknown(element, resourceManager);
 117   }
 118   return item;
 119 }
 120
 121 /// Export this item to the DOM.
 122 void KwPlaylistItem::exportToDom(QDomDocument& document, QDomElement& element, KwResourceManager* resourceManager) const
 123 {
 124   // Add an item element with type attribute and child elements determined by type
 125   QDomElement itemElement = document.createElement("playlist_item");
 126   element.appendChild(itemElement);
 127   QString type = itemType();
 128   itemElement.setAttribute("type", type);
 129
 130   if (!isScopeEmpty())
 131   {
 132     QDomElement styleElem = document.createElement("style");
 133     itemElement.appendChild(styleElem);
 134     exportStylesToDom(document, styleElem, resourceManager);
 135   }
 136
 137   exportDetailsToDom(document, itemElement, resourceManager);
 138
 139   // Export resources after type specific stuff so they can be modified at the last minute
 140   Resources::const_iterator it;
 141   for (it = m_resources.constBegin(); it != m_resources.constEnd(); ++it)
 142   {
 143     if (!(*it).link->isNull())
 144     {
 145       QDomElement resourceElement = document.createElement("resource");
 146       resourceElement.setAttribute("name", (*it).name);
 147       itemElement.appendChild(resourceElement);
 148
 149       (*it).link->exportToDom(document, resourceElement, resourceManager);
 150     }
 151   }
 152
 153   // Add preserve elements as well
 154   QDomNode importedFragment = document.importNode(m_domPreserve, true);
 155   itemElement.appendChild(importedFragment);
 156 }
 157
 158 /*
 159  * Protected methods
 160  */
 161
 162 /// Indicate that elements of a particular tag name have been handled.
 163 void KwPlaylistItem::elementsHandled(const QString& tagName)
 164 {
 165   QDomElement current = m_domPreserve.firstChildElement(tagName);
 166   while (!current.isNull())
 167   {
 168     m_domPreserve.removeChild(current);
 169     current = current.nextSiblingElement(tagName);
 170   }
 171 }
 172
 173 /// Indicate that the first elements of a particular tag name have been handled.
 174 void KwPlaylistItem::elementHandled(const QString& tagName)
 175 {
 176   QDomElement current = m_domPreserve.firstChildElement(tagName);
 177   if (!current.isNull())
 178   {
 179     m_domPreserve.removeChild(current);
 180   }
 181 }
 182
 183 /// Get a resource by name.
 184 KwResourceLink* KwPlaylistItem::getResource(const QString& name, bool create)
 185 {
 186   Resources::iterator it;
 187   for (it = m_resources.begin(); it != m_resources.end(); ++it)
 188   {
 189     if ((*it).name == name)
 190     {
 191       return (*it).link;
 192     }
 193   }
 194   if (create)
 195   {
 196     Resource resource = { name, new KwResourceLink };
 197     m_resources.push_back(resource);
 198     return resource.link;
 199   }
 200   return 0;
 201 }
 202
 203 /// Set a resource associated with a name.
 204 KwResourceLink* KwPlaylistItem::setResource(const QString& name, KwResourceLink* link)
 205 {
 206   deleteResource(name);
 207   Resource resource = { name, link };
 208   m_resources.push_back(resource);
 209   return link;
 210 }
 211
 212 /// Delete a resource.
 213 void KwPlaylistItem::deleteResource(const QString& name)
 214 {
 215   Resources::iterator it;
 216   for (it = m_resources.begin(); it != m_resources.end(); ++it)
 217   {
 218     if ((*it).name == name)
 219     {
 220       delete (*it).link;
 221       m_resources.erase(it);
 222     }
 223   }
 224 }
 225