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
  33 class KArchive;
  34
  35 class QIODevice;
  36
  37 /** A KWorship data archive file.
  38  * This class provides access to a KWorship archive file without loading all
  39  * the data into memory first.
  40  */
  41 class KwArchive
  42 {
  43   public:
  44
  45     /*
  46      * Constructors + destructor
  47      */
  48
  49     /// Primary constructor.
  50     KwArchive(QIODevice* dev, bool writing);
  51
  52     /// Destructor.
  53     virtual ~KwArchive();
  54
  55     /*
  56      * Accessors
  57      */
  58
  59     /// Get whether the archive is being written.
  60     bool isWriting() const;
  61
  62     /// Get whether the archive is being read.
  63     bool isReading() const;
  64
  65     /*
  66      * Access to playlist data
  67      */
  68
  69     /// Find how many playlists are in this archive.
  70     int numPlaylists();
  71
  72     /// Get a list of playlist names in this archive.
  73     QStringList playlists();
  74
  75     /*
  76      * Access to song data
  77      */
  78
  79     /// Find how many songs are in this archive.
  80     int numSongs();
  81
  82     /// Get a list of song names in this archive.
  83     QStringList songs();
  84
  85     /*
  86      * Access to generic resources
  87      */
  88
  89     /// Find how many resources are in this archive.
  90     int numResources();
  91
  92     /// Get a list of resource names in this archive.
  93     QStringList resources();
  94
  95   protected:
  96
  97     /*
  98      * Data files
  99      */
 100
 101     /// Load a data file from the archive.
 102     KwDataFile* loadDataFile(QString path);
 103
 104     /// Write a data file to the archive.
 105     void writeDataFile(QString path, const KwDataFile* data);
 106
 107   private:
 108
 109     /*
 110      * Variables
 111      */
 112
 113     /// Whether we are in writing mode.
 114     bool m_writing;
 115
 116     /// Compressor device.
 117     QIODevice* m_compressor;
 118
 119     /// Archive object.
 120     KArchive* m_archive;
 121
 122 };
 123
 124 #endif // _KwArchive_h_
 125