API/JSStringRefCF.h

   1 /*
   2  * Copyright (C) 2006, 2007 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 JSStringRefCF_h
  27 #define JSStringRefCF_h
  28
  29 #include "JSBase.h"
  30 #include <CoreFoundation/CoreFoundation.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /* CFString convenience methods */
  37
  38 /*!
  39 @function
  40 @abstract         Creates a JavaScript string from a CFString.
  41 @discussion       This function is optimized to take advantage of cases when
  42  CFStringGetCharactersPtr returns a valid pointer.
  43 @param string     The CFString to copy into the new JSString.
  44 @result           A JSString containing string. Ownership follows the Create Rule.
  45 */
  46 JS_EXPORT JSStringRef JSStringCreateWithCFString(CFStringRef string);
  47 /*!
  48 @function
  49 @abstract         Creates a CFString from a JavaScript string.
  50 @param alloc      The alloc parameter to pass to CFStringCreate.
  51 @param string     The JSString to copy into the new CFString.
  52 @result           A CFString containing string. Ownership follows the Create Rule.
  53 */
  54 JS_EXPORT CFStringRef JSStringCopyCFString(CFAllocatorRef alloc, JSStringRef string);
  55
  56 #ifdef __cplusplus
  57 }
  58 #endif
  59
  60 #endif /* JSStringRefCF_h */