object.h

// Copyright (C) 1999-2005 Open Source Telecom Corporation.
// Copyright (C) 2006-2014 David Sugar, Tycho Softworks.
// Copyright (C) 2015 Cherokees of Idaho.
//
// 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 2 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 Lesser General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// Common C++.  If you copy code from other releases into a copy of GNU
// Common C++, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU Common C++, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef COMMONCPP_OBJECT_H_
#define COMMONCPP_OBJECT_H_

#ifndef COMMONCPP_CONFIG_H_
#include <commoncpp/config.h>
#endif

namespace ost {

class MapObject;
class MapIndex;

class __EXPORT RefObject
{
private:
    __DELETE_COPY(RefObject);

protected:
    friend class RefPointer;

    unsigned refCount;

    inline RefObject() {
        refCount = 0;
    }

    virtual ~RefObject();

public:
    virtual void *getObject(void) = 0;
};

class __EXPORT RefPointer
{
protected:
    RefObject *ref;

    void detach(void);

    virtual void enterLock(void);

    virtual void leaveLock(void);

public:
    inline RefPointer() {
        ref = NULL;
    }

    RefPointer(RefObject *obj);

    RefPointer(const RefPointer &ptr);

    virtual ~RefPointer();

    RefPointer& operator=(const RefObject &ref);

    inline void *operator*() const {
        return getObject();
    }

    void *getObject(void) const;

    operator bool() const;

    bool operator!() const;
};

class __EXPORT LinkedSingle
{
private:
    __DELETE_COPY(LinkedSingle);

protected:
    LinkedSingle *nextObject;

    inline LinkedSingle() {
        nextObject = NULL;
    }

    virtual ~LinkedSingle();

public:
    virtual LinkedSingle *getFirst(void);

    virtual LinkedSingle *getLast(void);

    inline LinkedSingle *getNext(void) {
        return nextObject;
    }

    virtual void insert(LinkedSingle& obj);

    LinkedSingle &operator+=(LinkedSingle &obj);
};

class __EXPORT LinkedDouble
{
private:
    __DELETE_COPY(LinkedDouble);

protected:
    LinkedDouble *nextObject, *prevObject;

    inline LinkedDouble() {
        nextObject = prevObject = NULL;
    }

    virtual ~LinkedDouble();

    virtual void enterLock(void);

    virtual void leaveLock(void);

    virtual LinkedDouble *firstObject();

    virtual LinkedDouble *lastObject();

public:

    enum InsertMode
    {
      modeAtFirst,  
      modeAtLast,   
      modeBefore,   
      modeAfter     
    };

    virtual LinkedDouble *getFirst(void);

    virtual LinkedDouble *getLast(void);

    virtual LinkedDouble *getInsert(void);

    inline LinkedDouble *getNext(void) {
        return nextObject;
    }

    inline LinkedDouble *getPrev(void) {
        return prevObject;
    }

    virtual void insert(LinkedDouble& obj, InsertMode position = modeAtLast);

    virtual void detach(void);

    LinkedDouble &operator+=(LinkedDouble &obj);

    LinkedDouble &operator--();
};

class __EXPORT MapTable : public Mutex
{
private:
    __DELETE_COPY(MapTable);

protected:
    friend class MapObject;
    friend class MapIndex;
    unsigned range;
    unsigned count;
    MapObject **map;

    void cleanup(void);

public:
    MapTable(unsigned size);

    virtual ~MapTable();

    virtual unsigned getIndex(const char *id);

    inline unsigned getRange(void) {
        return range;
    }

    inline unsigned getSize(void) {
        return count;
    }

    void *getObject(const char *id);

    void addObject(MapObject &obj);
    void *getFirst();

    void *getLast();

    void *getEnd() {
        return NULL;
    }

    void *getFree(void);

    void addFree(MapObject *obj);

    MapTable &operator+=(MapObject &obj);

    virtual MapTable &operator-=(MapObject &obj);
};

class __EXPORT MapIndex
{
    MapObject*  thisObject;

public :

    MapIndex() : thisObject(NULL) {}

    MapIndex(MapObject* theObject) : thisObject(theObject) {}

    MapIndex(const MapIndex& theIndex) : thisObject(theIndex.thisObject) {}

    void* operator*() const {
        return (void*)thisObject;
    }

    MapIndex& operator=(MapObject *theObject);

    MapIndex& operator++();           // prefix

    MapIndex  operator++(int) {     // postfix
        return this->operator++();
    }

    bool operator==(const MapIndex& theIndex) const {
        return thisObject == theIndex.thisObject;
    }

    bool operator!=(const MapIndex& theIndex) const {
        return !(*this == theIndex);
    }

    bool operator==(const MapObject* theObject) const {
        return thisObject == theObject;
    }

    bool operator!=(const MapObject* theObject) const {
        return !(*this == theObject);
    }
};

class __EXPORT MapObject
{
private:
    __DELETE_COPY(MapObject);

protected:
    friend class MapTable;
    friend class MapIndex;
    MapObject *nextObject;
    const char *idObject;
    MapTable *table;

public:

    void detach(void);

    MapObject(const char *id);
};

} // namespace ost

#endif