1 /*

     2  * Copyright (C) 2008 Apple Computer, 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  * 1. Redistributions of source code must retain the above copyright

     8  *    notice, this list of conditions and the following disclaimer.

     9  * 2. Redistributions in binary form must reproduce the above copyright

    10  *    notice, this list of conditions and the following disclaimer in the

    11  *    documentation and/or other materials provided with the distribution.

    12  *

    13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY

    14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

    16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR

    17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

    18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

    19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

    20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

    21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

    24  */

    25 

    26 #ifndef JSBasePrivate_h

    27 #define JSBasePrivate_h

    28 

    29 #include <JavaScriptCore/JSBase.h>

    30 #include <JavaScriptCore/WebKitAvailability.h>

    31 

    32 #ifdef __cplusplus

    33 extern "C" {

    34 #endif

    35 

    36 /*!

    37 @function

    38 @abstract Reports an object's non-GC memory payload to the garbage collector.

    39 @param ctx The execution context to use.

    40 @param size The payload's size, in bytes.

    41 @discussion Use this function to notify the garbage collector that a GC object

    42 owns a large non-GC memory region. Calling this function will encourage the

    43 garbage collector to collect soon, hoping to reclaim that large non-GC memory

    44 region.

    45 */

    46 JS_EXPORT void JSReportExtraMemoryCost(JSContextRef ctx, size_t size) AVAILABLE_IN_WEBKIT_VERSION_4_0;

    47 

    48 #ifdef __cplusplus

    49 }

    50 #endif

    51 

    52 #endif /* JSBasePrivate_h */