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 "taglib.h"
#include "taglib_export.h"

#include <vector>
#include <iostream>

namespace TagLib {


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

    ByteVector();

    ByteVector(uint size, char value = 0);

    ByteVector(const ByteVector &v);

    ByteVector(const ByteVector &v, uint offset, uint length);

    ByteVector(char c);

    ByteVector(const char *data, uint length);

    ByteVector(const char *data);

    virtual ~ByteVector();

    ByteVector &setData(const char *data, uint length);

    ByteVector &setData(const char *data);

    char *data();

    const char *data() const;

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

    char at(uint index) const;

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

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

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

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

    bool startsWith(const ByteVector &pattern) const;

    bool endsWith(const ByteVector &pattern) const;

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

    int endsWithPartialMatch(const ByteVector &pattern) const;

    ByteVector &append(const ByteVector &v);

    ByteVector &clear();

    uint size() const;

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

    Iterator begin();

    ConstIterator begin() const;

    Iterator end();

    ConstIterator end() const;

    ReverseIterator rbegin();

    ConstReverseIterator rbegin() const;

    ReverseIterator rend();

    ConstReverseIterator rend() const;

    bool isNull() const;

    bool isEmpty() const;

    uint checksum() const;

    uint toUInt(bool mostSignificantByteFirst = true) const;

    uint toUInt(uint offset, bool mostSignificantByteFirst = true) const;

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

    short toShort(bool mostSignificantByteFirst = true) const;

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

    unsigned short toUShort(bool mostSignificantByteFirst = true) const;

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

    long long toLongLong(bool mostSignificantByteFirst = true) const;

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

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

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

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

    static ByteVector fromCString(const char *s, uint 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);

    static ByteVector null;

    ByteVector toHex() const;

  protected:
    /*
     * If this ByteVector is being shared via implicit sharing, do a deep copy
     * of the data and separate from the shared members.  This should be called
     * by all non-const subclass members.
     */
    void detach();

  private:
    class ByteVectorPrivate;
    ByteVectorPrivate *d;
  };
}

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

#endif