kworship/archive/KwArchive.h

   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 #ifndef _KwArchive_h_
  21 #define _KwArchive_h_
  22
  23 /**
  24  * @file KwArchive.h
  25  * @brief A KWorship data archive file.
  26  * @author James Hogan <james@albanarts.com>
  27  */
  28
  29 #include <QStringList>
  30
  31 class KwDataFile;
  32 class KwPlaylistList;
  33
  34 class KArchive;
  35
  36 class QIODevice;
  37
  38 /** A KWorship data archive file.
  39  * This class provides access to a KWorship archive file without loading all
  40  * the data into memory first.
  41  */
  42 class KwArchive
  43 {
  44   public:
  45
  46     /*
  47      * Constructors + destructor
  48      */
  49
  50     /// Primary constructor.
  51     KwArchive(QIODevice* dev, bool writing);
  52
  53     /// Primary constructor.
  54     KwArchive(const QString& fileName, bool writing);
  55
  56     /// Destructor.
  57     virtual ~KwArchive();
  58
  59     /*
  60      * Accessors
  61      */
  62
  63     /// Get whether the archive is being written.
  64     bool isWriting() const;
  65
  66     /// Get whether the archive is being read.
  67     bool isReading() const;
  68
  69     /*
  70      * Playlist data
  71      */
  72
  73     /// Find how many playlists are in this archive.
  74     int numPlaylists();
  75
  76     /// Get a list of playlist names in this archive.
  77     QStringList playlists();
  78
  79     /// Create a new playlist from the archive.
  80     KwPlaylistList* extractPlaylist(QString name);
  81
  82     /// Add a playlist to the archive.
  83     void addPlaylist(KwPlaylistList* playlist);
  84
  85     /*
  86      * Access to song data
  87      */
  88
  89     /// Find how many songs are in this archive.
  90     int numSongs();
  91
  92     /// Get a list of song names in this archive.
  93     QStringList songs();
  94
  95     /*
  96      * Access to generic resources
  97      */
  98
  99     /// Find how many resources are in this archive.
 100     int numResources();
 101
 102     /// Get a list of resource names in this archive.
 103     QStringList resources();
 104
 105   protected:
 106
 107     /*
 108      * Data files
 109      */
 110
 111     /// Load a data file from the archive.
 112     KwDataFile* loadDataFile(QString path);
 113
 114     /// Write a data file to the archive.
 115     void writeDataFile(QString path, const KwDataFile* data);
 116
 117   private:
 118
 119     /*
 120      * Variables
 121      */
 122
 123     /// Whether we are in writing mode.
 124     bool m_writing;
 125
 126     /// Compressor device.
 127     QIODevice* m_compressor;
 128
 129     /// Archive object.
 130     KArchive* m_archive;
 131
 132     /// Index data file.
 133     KwDataFile* m_index;
 134
 135     /// Number of playlists.
 136     int m_numPlaylists;
 137
 138 };
 139
 140 #endif // _KwArchive_h_
 141