band.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Based on the original sources
 *   Faery Tale II -- The Halls of the Dead
 *   (c) 1993-1996 The Wyrmkeep Entertainment Co.
 */

#ifndef SAGA2_BAND_H
#define SAGA2_BAND_H

namespace Saga2 {

class Actor;
class Band;

/* ===================================================================== *
   Function prototypes
 * ===================================================================== */

//  Allocate a new band
Band *newBand();
Band *newBand(BandID id);

//  Delete a previously allocated band
void deleteBand(Band *p);

//  Get a band's ID given its address
BandID getBandID(Band *b);
//  Get a band's address given its ID
Band *getBandAddress(BandID id);

//  Initialize the band list
void initBands();
void saveBands(Common::OutSaveFile *outS);
void loadBands(Common::InSaveFile *in, int32 chunkSize);
//  Cleanup the band list
void cleanupBands();

/* ===================================================================== *
   BandList class
 * ===================================================================== */

//  Manages the memory used for the Band's.  There will only be one
//  global instantiation of this class
class BandList {
public:
    enum {
        kNumBands = 32
    };

    Band *_list[kNumBands];

    //  Constructor -- initial construction
    BandList();

    //  Destructor
    ~BandList();

    void read(Common::InSaveFile *in);

    //  Return the number of bytes necessary to archive this task list
    //  in a buffer
    int32 archiveSize();

    void write(Common::MemoryWriteStreamDynamic *out);

    //  Place a Band from the inactive list into the active
    //  list.
    Band *newBand();
    Band *newBand(BandID id);

    void addBand(Band *band);

    //  Place a Band back into the inactive list.
    void deleteBand(Band *p);

    //  Return the specified Band's ID
    BandID getBandID(Band *b) {
        for (int i = 0; i < kNumBands; i++)
            if (_list[i] == b)
                return i;

        error("BandList::getBandID(): Unknown band");
    }

    //  Return a pointer to a Band given a BandID
    Band *getBandAddress(BandID id) {
        assert(id >= 0 && id < kNumBands);
        return _list[id];
    }
};

/* ===================================================================== *
   Band class
 * ===================================================================== */

class Band {
    enum {
        kMaxBandMembers = 32
    };

    Actor       *_leader;

    int16       _memberCount;
    Actor       *_members[kMaxBandMembers];

public:

    Band();
    Band(Actor *l);

    Band(Common::InSaveFile *in);

    ~Band() { deleteBand(this); }

    //  Return the number of bytes needed to archive this object in a
    //  buffer
    int32 archiveSize();

    void write(Common::MemoryWriteStreamDynamic *out);

    Actor *getLeader() {
        return _leader;
    }

    bool add(Actor *newMember) {
        if (_memberCount < ARRAYSIZE(_members)) {
            _members[_memberCount++] = newMember;
            return true;
        } else
            return false;
    }

    void remove(Actor *member) {
        int     i;

        for (i = 0; i < _memberCount; i++) {
            if (_members[i] == member) {
                _memberCount--;

                for (; i < _memberCount; i++)
                    _members[i] = _members[i + 1];

                break;
            }
        }
    }

    void remove(int index) {
        assert(index < _memberCount);

        int     i;

        _memberCount--;

        for (i = index; i < _memberCount; i++)
            _members[i] = _members[i + 1];
    }

    int size() {
        return _memberCount;
    }
    Actor *const &operator [](int index) {
        return _members[index];
    }
};

} // end of namespace Saga2

#endif