Classes | Public Types | Public Member Functions | Static Public Member Functions

v8::String Class Reference

#include <v8.h>

Inheritance diagram for v8::String:
v8::Primitive v8::Value v8::Data

List of all members.

Classes

class  AsciiValue
class  ExternalAsciiStringResource
class  ExternalStringResource
class  ExternalStringResourceBase
class  Utf8Value
class  Value

Public Types

enum  WriteHints { NO_HINTS = 0, HINT_MANY_WRITES_EXPECTED = 1 }

Public Member Functions

V8EXPORT int Length () const
V8EXPORT int Utf8Length () const
V8EXPORT int Write (uint16_t *buffer, int start=0, int length=-1, WriteHints hints=NO_HINTS) const
V8EXPORT int WriteAscii (char *buffer, int start=0, int length=-1, WriteHints hints=NO_HINTS) const
V8EXPORT int WriteUtf8 (char *buffer, int length=-1, int *nchars_ref=NULL, WriteHints hints=NO_HINTS) const
V8EXPORT bool IsExternal () const
V8EXPORT bool IsExternalAscii () const
ExternalStringResource * GetExternalStringResource () const
V8EXPORT
ExternalAsciiStringResource * 		GetExternalAsciiStringResource () const
V8EXPORT bool MakeExternal (ExternalStringResource *resource)
V8EXPORT bool MakeExternal (ExternalAsciiStringResource *resource)
V8EXPORT bool CanMakeExternal ()

Static Public Member Functions

static V8EXPORT v8::Local
< v8::String > 		Empty ()
static String * Cast (v8::Value *obj)
static V8EXPORT Local< String > New (const char *data, int length=-1)
static V8EXPORT Local< String > New (const uint16_t *data, int length=-1)
static V8EXPORT Local< String > NewSymbol (const char *data, int length=-1)
static V8EXPORT Local< String > Concat (Handle< String > left, Handle< String >right)
static V8EXPORT Local< String > NewExternal (ExternalStringResource *resource)
static V8EXPORT Local< String > NewExternal (ExternalAsciiStringResource *resource)
static V8EXPORT Local< String > NewUndetectable (const char *data, int length=-1)
static V8EXPORT Local< String > NewUndetectable (const uint16_t *data, int length=-1)

Detailed Description

A JavaScript string value (ECMA-262, 4.3.17).

Member Enumeration Documentation

enum v8::String::WriteHints

Write the contents of the string to an external buffer. If no arguments are given, expects the buffer to be large enough to hold the entire string and NULL terminator. Copies the contents of the string and the NULL terminator into the buffer.

WriteUtf8 will not write partial UTF-8 sequences, preferring to stop before the end of the buffer.

Copies up to length characters into the output buffer. Only null-terminates if there is enough space in the buffer.

Parameters:
buffer The buffer into which the string will be copied.
start The starting position within the string at which copying begins.
length The number of characters to copy from the string. For WriteUtf8 the number of bytes in the buffer.
nchars_ref The number of characters written, can be NULL.
hints Various hints that might affect performance of this or subsequent operations.
Returns:
The number of characters copied to the buffer excluding the null terminator. For WriteUtf8: The number of bytes copied to the buffer including the null terminator.

Member Function Documentation

V8EXPORT bool v8::String::CanMakeExternal (  ) 

Returns true if this string can be made external.

static V8EXPORT Local<String> v8::String::Concat ( Handle< String >  left,
Handle< String >  right 
) [static]

Creates a new string by concatenating the left and the right strings passed in as parameters.

static V8EXPORT v8::Local<v8::String> v8::String::Empty (  )  [static]

A zero length string.

V8EXPORT ExternalAsciiStringResource* v8::String::GetExternalAsciiStringResource (  )  const

Get the ExternalAsciiStringResource for an external ascii string. Returns NULL if IsExternalAscii() doesn't return true.

String::ExternalStringResource * v8::String::GetExternalStringResource (  )  const [inline]

Get the ExternalStringResource for an external string. Returns NULL if IsExternal() doesn't return true.

V8EXPORT bool v8::String::IsExternal (  )  const

Returns true if the string is external

Reimplemented from v8::Value.

V8EXPORT bool v8::String::IsExternalAscii (  )  const

Returns true if the string is both external and ascii

V8EXPORT int v8::String::Length (  )  const

Returns the number of characters in this string.

V8EXPORT bool v8::String::MakeExternal ( ExternalStringResource *  resource  ) 

Associate an external string resource with this string by transforming it in place so that existing references to this string in the JavaScript heap will use the external string resource. The external string resource's character contents need to be equivalent to this string. Returns true if the string has been changed to be an external string. The string is not modified if the operation fails. See NewExternal for information on the lifetime of the resource.

V8EXPORT bool v8::String::MakeExternal ( ExternalAsciiStringResource *  resource  ) 

Associate an external string resource with this string by transforming it in place so that existing references to this string in the JavaScript heap will use the external string resource. The external string resource's character contents need to be equivalent to this string. Returns true if the string has been changed to be an external string. The string is not modified if the operation fails. See NewExternal for information on the lifetime of the resource.

static V8EXPORT Local<String> v8::String::New ( const char *  data,
int  length = -1 
) [static]

Allocates a new string from either utf-8 encoded or ascii data. The second parameter 'length' gives the buffer length. If the data is utf-8 encoded, the caller must be careful to supply the length parameter. If it is not given, the function calls 'strlen' to determine the buffer length, it might be wrong if 'data' contains a null character.

static V8EXPORT Local<String> v8::String::New ( const uint16_t *  data,
int  length = -1 
) [static]

Allocates a new string from utf16 data.

static V8EXPORT Local<String> v8::String::NewExternal ( ExternalStringResource *  resource  )  [static]

Creates a new external string using the data defined in the given resource. When the external string is no longer live on V8's heap the resource will be disposed by calling its Dispose method. The caller of this function should not otherwise delete or modify the resource. Neither should the underlying buffer be deallocated or modified except through the destructor of the external string resource.

static V8EXPORT Local<String> v8::String::NewExternal ( ExternalAsciiStringResource *  resource  )  [static]

Creates a new external string using the ascii data defined in the given resource. When the external string is no longer live on V8's heap the resource will be disposed by calling its Dispose method. The caller of this function should not otherwise delete or modify the resource. Neither should the underlying buffer be deallocated or modified except through the destructor of the external string resource.

static V8EXPORT Local<String> v8::String::NewSymbol ( const char *  data,
int  length = -1 
) [static]

Creates a symbol. Returns one if it exists already.

static V8EXPORT Local<String> v8::String::NewUndetectable ( const char *  data,
int  length = -1 
) [static]

Creates an undetectable string from the supplied ascii or utf-8 data.

static V8EXPORT Local<String> v8::String::NewUndetectable ( const uint16_t *  data,
int  length = -1 
) [static]

Creates an undetectable string from the supplied utf-16 data.

V8EXPORT int v8::String::Utf8Length (  )  const

Returns the number of bytes in the UTF-8 encoded representation of this string.

The documentation for this class was generated from the following file:
Generated on Thu Oct 6 2011 12:01:33 for V8 by  doxygen 1.7.1