tbytevector.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_BYTEVECTOR_H
#define TAGLIB_BYTEVECTOR_H

#include <memory>
#include <vector>
#include <iosfwd>

#include "taglib_export.h"

namespace TagLib {


  class TAGLIB_EXPORT ByteVector
  {
  public:
#ifndef DO_NOT_DOCUMENT
    using Iterator = std::vector<char>::iterator;
    using ConstIterator = std::vector<char>::const_iterator;
    using ReverseIterator = std::vector<char>::reverse_iterator;
    using ConstReverseIterator = std::vector<char>::const_reverse_iterator;
#endif

    ByteVector();

    ByteVector(unsigned int size, char value = 0);

    ByteVector(const ByteVector &v);

    ByteVector(const ByteVector &v, unsigned int offset, unsigned int length);

    ByteVector(char c);

    ByteVector(const char *data, unsigned int length);

    ByteVector(const char *data);

    ~ByteVector();

    ByteVector &setData(const char *s, unsigned int length);

    ByteVector &setData(const char *data);

    char *data();

    const char *data() const;

    ByteVector mid(unsigned int index, unsigned int length = 0xffffffff) const;

    char at(unsigned int index) const;

    int find(const ByteVector &pattern, unsigned int offset = 0, int byteAlign = 1) const;

    int find(char c, unsigned int offset = 0, int byteAlign = 1) const;

    int rfind(const ByteVector &pattern, unsigned int offset = 0, int byteAlign = 1) const;

    bool containsAt(const ByteVector &pattern, unsigned int offset,
                    unsigned int patternOffset = 0, unsigned int patternLength = 0xffffffff) const;

    bool startsWith(const ByteVector &pattern) const;

    bool endsWith(const ByteVector &pattern) const;

    ByteVector &replace(char oldByte, char newByte);

    ByteVector &replace(const ByteVector &pattern, const ByteVector &with);

    int endsWithPartialMatch(const ByteVector &pattern) const;

    ByteVector &append(const ByteVector &v);

    ByteVector &append(char c);

    ByteVector &clear();

    unsigned int size() const;

    ByteVector &resize(unsigned int size, char padding = 0);

    Iterator begin();

    ConstIterator begin() const;

    ConstIterator cbegin() const;

    Iterator end();

    ConstIterator end() const;

    ConstIterator cend() const;

    ReverseIterator rbegin();

    ConstReverseIterator rbegin() const;

    ReverseIterator rend();

    ConstReverseIterator rend() const;

    bool isEmpty() const;

    unsigned int toUInt(bool mostSignificantByteFirst = true) const;

    unsigned int toUInt(unsigned int offset, bool mostSignificantByteFirst = true) const;

    unsigned int toUInt(unsigned int offset, unsigned int length,
                        bool mostSignificantByteFirst = true) const;

    short toShort(bool mostSignificantByteFirst = true) const;

    short toShort(unsigned int offset, bool mostSignificantByteFirst = true) const;

    unsigned short toUShort(bool mostSignificantByteFirst = true) const;

    unsigned short toUShort(unsigned int offset, bool mostSignificantByteFirst = true) const;

    long long toLongLong(bool mostSignificantByteFirst = true) const;

    long long toLongLong(unsigned int offset, bool mostSignificantByteFirst = true) const;

    unsigned long long toULongLong(bool mostSignificantByteFirst = true) const;

    unsigned long long toULongLong(unsigned int offset, bool mostSignificantByteFirst = true) const;

    float toFloat32LE(size_t offset) const;

    float toFloat32BE(size_t offset) const;

    double toFloat64LE(size_t offset) const;

    double toFloat64BE(size_t offset) const;

    long double toFloat80LE(size_t offset) const;

    long double toFloat80BE(size_t offset) const;

    static ByteVector fromUInt(unsigned int value, bool mostSignificantByteFirst = true);

    static ByteVector fromShort(short value, bool mostSignificantByteFirst = true);

    static ByteVector fromUShort(unsigned short value, bool mostSignificantByteFirst = true);

    static ByteVector fromLongLong(long long value, bool mostSignificantByteFirst = true);

    static ByteVector fromULongLong(unsigned long long value, bool mostSignificantByteFirst = true);

    static ByteVector fromFloat32LE(float value);

    static ByteVector fromFloat32BE(float value);

    static ByteVector fromFloat64LE(double value);

    static ByteVector fromFloat64BE(double value);

    static ByteVector fromCString(const char *s, unsigned int length = 0xffffffff);

    const char &operator[](int index) const;

    char &operator[](int index);

    bool operator==(const ByteVector &v) const;

    bool operator!=(const ByteVector &v) const;

    bool operator==(const char *s) const;

    bool operator!=(const char *s) const;

    bool operator<(const ByteVector &v) const;

    bool operator>(const ByteVector &v) const;

    ByteVector operator+(const ByteVector &v) const;

    ByteVector &operator=(const ByteVector &v);

    ByteVector &operator=(char c);

    ByteVector &operator=(const char *data);

    void swap(ByteVector &v) noexcept;

    ByteVector toHex() const;

    ByteVector toBase64() const;

    static ByteVector fromBase64(const ByteVector &);

  protected:
    void detach();

  private:
    class ByteVectorPrivate;
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    std::unique_ptr<ByteVectorPrivate> d;
  };
}  // namespace TagLib

TAGLIB_EXPORT std::ostream &operator<<(std::ostream &s, const TagLib::ByteVector &v);

#endif