JavaScriptCore-1097.13.tar.gz

[apple/javascriptcore.git] / runtime / GCActivityCallback.h

/*
 * Copyright (C) 2010 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer. 
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution. 
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission. 
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef GCActivityCallback_h
#define GCActivityCallback_h

#include <wtf/OwnPtr.h>
#include <wtf/PassOwnPtr.h>

#if USE(CF)
#include <CoreFoundation/CoreFoundation.h>
#endif

namespace JSC {

class Heap;

class GCActivityCallback {
public:
    virtual ~GCActivityCallback() { }
    virtual void didAllocate(size_t) { }
    virtual void willCollect() { }
    virtual void synchronize() { }
    virtual void cancel() { }
    virtual void didStartVMShutdown() { }
    virtual void invalidate() { }

    static bool s_shouldCreateGCTimer;

protected:
    GCActivityCallback() {}
};

struct DefaultGCActivityCallbackPlatformData;

class DefaultGCActivityCallback : public GCActivityCallback {
public:
    static DefaultGCActivityCallback* create(Heap*);

    DefaultGCActivityCallback(Heap*);
    JS_EXPORT_PRIVATE virtual ~DefaultGCActivityCallback();

    JS_EXPORT_PRIVATE virtual void didAllocate(size_t);
    JS_EXPORT_PRIVATE virtual void willCollect();
    JS_EXPORT_PRIVATE virtual void synchronize();
    JS_EXPORT_PRIVATE virtual void cancel();
    JS_EXPORT_PRIVATE virtual void didStartVMShutdown();
    JS_EXPORT_PRIVATE virtual void invalidate();

#if USE(CF)
protected:
    JS_EXPORT_PRIVATE DefaultGCActivityCallback(Heap*, CFRunLoopRef);
    void commonConstructor(Heap*, CFRunLoopRef);
#endif

private:
    OwnPtr<DefaultGCActivityCallbackPlatformData> d;
};

inline DefaultGCActivityCallback* DefaultGCActivityCallback::create(Heap* heap)
{
    // Big hack.
    if (GCActivityCallback::s_shouldCreateGCTimer)
        return new DefaultGCActivityCallback(heap);
    return 0;
}

}

#endif