Object.h

Go to the documentation of this file.

/*****************************************************************************
 *                                                                           *
 *  Copyright 2018 Rice University                                           *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *      http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 *****************************************************************************/

#ifndef OBJECT_H
#define OBJECT_H

#include <cstddef>
#include <iostream>
#include <vector>
#include <algorithm>
#include <iterator>
#include <cstring>

#include "TypeName.h"
#include "DeepCopy.h"

namespace pdb {

enum ObjectPolicy { defaultObject, noReferenceCountObject };


// This is the basic PDB Object type.  Everything that is stored in PDB should
// derive from this.  Currently, it simply overrides all of the new () operators
// so that it is basically impossible to create an object via new ().  Additional
// v-table fixing code will be added in the near future.
//
class Object {

public:
    // these all just error out since they should never be called
    static void* operator new(size_t sz, const std::nothrow_t& tag);
    static void* operator new(size_t sz);
    static void operator delete(void* me);
    static void* operator new(std::size_t count, void* ptr);
    void setVTablePtr(void* setToMe);
    void* getVTablePtr();

    // these are properly defined via the ENABLE_DEEP_COPY macro
    virtual void setUpAndCopyFrom(void* target, void* source) const;
    virtual void deleteObject(void* deleteMe);
    virtual size_t getSize(void* ofMe);
};
}

#include "Object.cc"

#endif