ByteArray.h

Go to the documentation of this file.

/*
 * ByteArray.h
 *
 * Smalltalk like class library for C++
 * Array of bytes. Header.
 *
 * Copyright (c) 2003 Jan Vrany
 */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __BYTEARRAY_H
#define __BYTEARRAY_H

#include <stlib/SequenceableCollection.h>
#include <stlib/String.h>

namespace Core {

class Integer;
class InternalEncodedStreamFactory;
        
class ByteArray : public SequenceableCollection
{
  protected:
    unsigned char * bytes;

    long tally;

  public:
    ByteArray(int size = 0);

    ByteArray(const ByteArray &origin);

    ByteArray(const char * buffer, int size);
    ~ByteArray(void);

    virtual String* className(void) const
    { return new String("ByteArray"); }

    /* Instance creation protocol */
    static ByteArray *fromStringEncoding(const String *string, String *encoding);

    /* Accessing protocol */
    virtual long int size() const
    { return tally; }

    virtual Object* at(int index) const;

    virtual void put(int index, Object* obj);

    virtual void replace(long start, long stop,
                         const SequenceableCollection *collection)
    { SequenceableCollection::replace(start, stop, collection); }
    virtual void replace(long start, long stop, unsigned char *collection);
    virtual void replace(long start, long stop,
                         const SequenceableCollection *collection, long startIndex)
    { SequenceableCollection::replace(start, stop, collection, startIndex); }
    virtual void replace(long start, long stop,
                         unsigned char *collection, long startIndex);

    virtual void changeSize(long newSize);

    virtual void add(Object* obj);

    virtual Object *copy(void);
    virtual Object *copy(long from, long to)
      { return SequenceableCollection::copy(from, to); }

    virtual Object *copyEmpty(long int size);

    virtual unsigned char *rawBytes(void) const;

    virtual const unsigned char *rawBytesReadOnly(void) const;

    /* Comparing protocol */
    virtual long hash(void) const;
    virtual bool isEqual(const Object *object) const;
    virtual bool isEqual(const Object &object) const
      { return SequenceableCollection::isEqual(object); }
    virtual bool isEqual(const char *array, int size) const;
    virtual bool isEqualToByteArray(const Object *array) const;

    /* Converting protocol */
    virtual ByteArray *asByteArray(void);

    virtual char *asCString(void);
    virtual String *asString(void);
    virtual String *asStringWithEncoding(String *encoding);
    virtual String *asStringWithEncoding(const char *encoding);
    virtual unsigned long asInteger(void);
    virtual unsigned long asNumberWithRadix(int radix);

    /* Stream construction protocol */
    virtual InternalEncodedStreamFactory *withEncoding(String *encoding);
    virtual InternalEncodedStreamFactory *withEncoding(const char *encoding);

    /* Testing protocol */
    virtual bool isByteArray(void);

  private:
    virtual void checkObject(Object *obj, const char *sel);
};

};

#endif /* __BYTEARRAY_H */

---