tiostream.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2011 by Lukas Lalinsky
    email                : lalinsky@gmail.com
 ***************************************************************************/

/***************************************************************************
 *   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_IOSTREAM_H
#define TAGLIB_IOSTREAM_H

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

#ifdef _WIN32
#include <string>
#endif

namespace TagLib {

#ifdef _WIN32
  class TAGLIB_EXPORT FileName
  {
  public:
    FileName(const wchar_t *name);
    FileName(const char *name);

    FileName(const FileName &name);

    operator const wchar_t *() const;

    const std::wstring &wstr() const;

    String toString() const;

  private:
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    const std::wstring m_wname;
  };
#else
  using FileName = const char *;
#endif


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

    IOStream();

    virtual ~IOStream();

    IOStream(const IOStream &) = delete;
    IOStream &operator=(const IOStream &) = delete;

    virtual FileName name() const = 0;

    virtual ByteVector readBlock(size_t length) = 0;

    virtual void writeBlock(const ByteVector &data) = 0;

    virtual void insert(const ByteVector &data,
                        offset_t start = 0, size_t replace = 0) = 0;

    virtual void removeBlock(offset_t start = 0, size_t length = 0) = 0;

    virtual bool readOnly() const = 0;

    virtual bool isOpen() const = 0;

    virtual void seek(offset_t offset, Position p = Beginning) = 0;

    virtual void clear();

    virtual offset_t tell() const = 0;

    virtual offset_t length() = 0;

    virtual void truncate(offset_t length) = 0;

  private:
    class IOStreamPrivate;
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    std::unique_ptr<IOStreamPrivate> d;
  };

}  // namespace TagLib

#endif