tfile.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/

/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful, but   *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_FILE_H
#define TAGLIB_FILE_H

#include "taglib_export.h"
#include "taglib.h"
#include "tag.h"
#include "tbytevector.h"
#include "tiostream.h"

namespace TagLib {

  class String;
  class Tag;
  class AudioProperties;
  class PropertyMap;


  class TAGLIB_EXPORT File
  {
  public:
    enum Position {
      Beginning,
      Current,
      End
    };

    virtual ~File();

    FileName name() const;

    virtual Tag *tag() const = 0;

    PropertyMap properties() const;

    void removeUnsupportedProperties(const StringList& properties);

    PropertyMap setProperties(const PropertyMap &properties);
    virtual AudioProperties *audioProperties() const = 0;

    virtual bool save() = 0;

    ByteVector readBlock(ulong length);

    void writeBlock(const ByteVector &data);

    long find(const ByteVector &pattern,
              long fromOffset = 0,
              const ByteVector &before = ByteVector::null);

    long rfind(const ByteVector &pattern,
               long fromOffset = 0,
               const ByteVector &before = ByteVector::null);

    void insert(const ByteVector &data, ulong start = 0, ulong replace = 0);

    void removeBlock(ulong start = 0, ulong length = 0);

    bool readOnly() const;

    bool isOpen() const;

    bool isValid() const;

    void seek(long offset, Position p = Beginning);

    void clear();

    long tell() const;

    long length();

    static bool isReadable(const char *file);

    static bool isWritable(const char *name);

  protected:
    File(FileName file);

    File(IOStream *stream);

    void setValid(bool valid);

    void truncate(long length);

    static uint bufferSize();

  private:
    File(const File &);
    File &operator=(const File &);

    class FilePrivate;
    FilePrivate *d;
  };

}

#endif