runtime/GCActivityCallback.h

   1 /*
   2  * Copyright (C) 2010 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef GCActivityCallback_h
  30 #define GCActivityCallback_h
  31
  32 #include <wtf/OwnPtr.h>
  33 #include <wtf/PassOwnPtr.h>
  34
  35 #if USE(CF)
  36 #include <CoreFoundation/CoreFoundation.h>
  37 #endif
  38
  39 namespace JSC {
  40
  41 class Heap;
  42
  43 class GCActivityCallback {
  44 public:
  45     virtual ~GCActivityCallback() { }
  46     virtual void didAllocate(size_t) { }
  47     virtual void willCollect() { }
  48     virtual void synchronize() { }
  49     virtual void cancel() { }
  50     virtual void didStartVMShutdown() { }
  51     virtual void invalidate() { }
  52
  53     static bool s_shouldCreateGCTimer;
  54
  55 protected:
  56     GCActivityCallback() {}
  57 };
  58
  59 struct DefaultGCActivityCallbackPlatformData;
  60
  61 class DefaultGCActivityCallback : public GCActivityCallback {
  62 public:
  63     static DefaultGCActivityCallback* create(Heap*);
  64
  65     DefaultGCActivityCallback(Heap*);
  66     JS_EXPORT_PRIVATE virtual ~DefaultGCActivityCallback();
  67
  68     JS_EXPORT_PRIVATE virtual void didAllocate(size_t);
  69     JS_EXPORT_PRIVATE virtual void willCollect();
  70     JS_EXPORT_PRIVATE virtual void synchronize();
  71     JS_EXPORT_PRIVATE virtual void cancel();
  72     JS_EXPORT_PRIVATE virtual void didStartVMShutdown();
  73     JS_EXPORT_PRIVATE virtual void invalidate();
  74
  75 #if USE(CF)
  76 protected:
  77     JS_EXPORT_PRIVATE DefaultGCActivityCallback(Heap*, CFRunLoopRef);
  78     void commonConstructor(Heap*, CFRunLoopRef);
  79 #endif
  80
  81 private:
  82     OwnPtr<DefaultGCActivityCallbackPlatformData> d;
  83 };
  84
  85 inline DefaultGCActivityCallback* DefaultGCActivityCallback::create(Heap* heap)
  86 {
  87     // Big hack.
  88     if (GCActivityCallback::s_shouldCreateGCTimer)
  89         return new DefaultGCActivityCallback(heap);
  90     return 0;
  91 }
  92
  93 }
  94
  95 #endif