JSStringRefCF.h 2.4 KB

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