API/JSStringRefCF.h

   1 // -*- mode: c++; c-basic-offset: 4 -*-
   2 /*
   3  * Copyright (C) 2006, 2007 Apple Computer, Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef JSStringRefCF_h
  28 #define JSStringRefCF_h
  29
  30 #include "JSBase.h"
  31 #include <CoreFoundation/CoreFoundation.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 // CFString convenience methods
  38
  39 /*!
  40 @function
  41 @abstract         Creates a JavaScript string from a CFString.
  42 @discussion       This function is optimized to take advantage of cases when
  43  CFStringGetCharactersPtr returns a valid pointer.
  44 @param string     The CFString to copy into the new JSString.
  45 @result           A JSString containing string. Ownership follows the Create Rule.
  46 */
  47 JS_EXPORT JSStringRef JSStringCreateWithCFString(CFStringRef string);
  48 /*!
  49 @function
  50 @abstract         Creates a CFString from a JavaScript string.
  51 @param alloc      The alloc parameter to pass to CFStringCreate.
  52 @param string     The JSString to copy into the new CFString.
  53 @result           A CFString containing string. Ownership follows the Create Rule.
  54 */
  55 JS_EXPORT CFStringRef JSStringCopyCFString(CFAllocatorRef alloc, JSStringRef string);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif // JSStringRefCF_h