API/JSProfilerPrivate.h

   1 /*
   2  * Copyright (C) 2008 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  * 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 JSProfiler_h
  27 #define JSProfiler_h
  28
  29 #include <JavaScriptCore/JSBase.h>
  30
  31 #ifndef __cplusplus
  32 #include <stdbool.h>
  33 #endif
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /*!
  40 @function JSStartProfiling
  41 @abstract Enables the profler.
  42 @param ctx The execution context to use.
  43 @param title The title of the profile.
  44 @result The profiler is turned on.
  45 */
  46 JS_EXPORT void JSStartProfiling(JSContextRef ctx, JSStringRef title);
  47
  48 /*!
  49 @function JSEndProfiling
  50 @abstract Disables the profler.
  51 @param ctx The execution context to use.
  52 @param title The title of the profile.
  53 @result The profiler is turned off. If there is no name, the most recently started
  54         profile is stopped. If the name does not match any profile then no profile
  55         is stopped.
  56 */
  57 JS_EXPORT void JSEndProfiling(JSContextRef ctx, JSStringRef title);
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62
  63 #endif /* JSProfiler_h */