[svn:parrot] r37808 - in trunk/src/string: . charset encoding
coke at svn.parrot.org
coke at svn.parrot.org
Sun Mar 29 04:05:14 UTC 2009
Author: coke
Date: Sun Mar 29 04:05:13 2009
New Revision: 37808
URL: https://trac.parrot.org/parrot/changeset/37808
Log:
[docs] add arguments to more function docs.
Modified:
trunk/src/string/api.c
trunk/src/string/charset.c
trunk/src/string/charset/ascii.c
trunk/src/string/charset/binary.c
trunk/src/string/charset/iso-8859-1.c
trunk/src/string/charset/unicode.c
trunk/src/string/encoding.c
trunk/src/string/encoding/fixed_8.c
trunk/src/string/encoding/ucs2.c
trunk/src/string/encoding/utf16.c
trunk/src/string/encoding/utf8.c
trunk/src/string/primitives.c
Modified: trunk/src/string/api.c
==============================================================================
--- trunk/src/string/api.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/api.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -57,7 +57,7 @@
/*
-=item C<void Parrot_str_write_COW>
+=item C<void Parrot_str_write_COW(PARROT_INTERP, STRING *s)>
If the specified Parrot string is copy-on-write then the memory is
copied over and the copy-on-write flag is cleared.
@@ -109,7 +109,7 @@
/*
-=item C<STRING * Parrot_str_new_COW>
+=item C<STRING * Parrot_str_new_COW(PARROT_INTERP, STRING *s)>
Creates a copy-on-write string, cloning a string header without
allocating a new buffer.
@@ -161,7 +161,7 @@
/*
-=item C<STRING * Parrot_str_reuse_COW>
+=item C<STRING * Parrot_str_reuse_COW(PARROT_INTERP, STRING *s, STRING *d)>
Creates a copy-on-write string by cloning a string header without
allocating a new buffer. Doesn't allocate a new string header, instead
@@ -194,7 +194,7 @@
/*
-=item C<STRING * Parrot_str_set>
+=item C<STRING * Parrot_str_set(PARROT_INTERP, STRING *dest, STRING *src)>
Makes the contents of first Parrot string a copy of the contents of
second.
@@ -228,7 +228,7 @@
/*
-=item C<void Parrot_str_free>
+=item C<void Parrot_str_free(PARROT_INTERP, STRING *s)>
Frees the given STRING's header, accounting for reference counts for the
STRING's buffer &c. Use this only if you I<know> that nothing else has stored
@@ -258,7 +258,7 @@
=over 4
-=item C<void Parrot_str_init>
+=item C<void Parrot_str_init(PARROT_INTERP)>
Initializes the Parrot string subsystem.
@@ -319,7 +319,7 @@
/*
-=item C<void Parrot_str_finish>
+=item C<void Parrot_str_finish(PARROT_INTERP)>
De-Initializes the Parrot string subsystem.
@@ -343,7 +343,7 @@
/*
-=item C<UINTVAL string_capacity>
+=item C<UINTVAL string_capacity(PARROT_INTERP, const STRING *s)>
Returns the capacity of the specified Parrot string in bytes, that
is how many bytes can be appended onto strstart.
@@ -366,7 +366,8 @@
/*
-=item C<STRING * Parrot_str_new_noinit>
+=item C<STRING * Parrot_str_new_noinit(PARROT_INTERP,
+parrot_string_representation_t representation, UINTVAL capacity)>
Creates and returns an empty Parrot string.
@@ -399,7 +400,8 @@
/*
-=item C<const CHARSET * string_rep_compatible>
+=item C<const CHARSET * string_rep_compatible(PARROT_INTERP,
+const STRING *a, const STRING *b, const ENCODING **e)>
Find the "lowest" possible charset and encoding for the given string. E.g.
@@ -466,7 +468,7 @@
/*
-=item C<STRING * Parrot_str_concat>
+=item C<STRING * Parrot_str_concat(PARROT_INTERP, STRING *a, STRING *b, UINTVAL Uflags)>
Concatenates two Parrot strings. If necessary, converts the second
string's encoding and/or type to match those of the first string. If
@@ -515,7 +517,7 @@
/*
-=item C<STRING * Parrot_str_append>
+=item C<STRING * Parrot_str_append(PARROT_INTERP, STRING *a, STRING *b)>
Take in two Parrot strings and append the second to the first. NOTE THAT
RETURN VALUE MAY NOT BE THE FIRST STRING, if the first string is COW'd or
@@ -595,7 +597,7 @@
/*
-=item C<STRING * Parrot_str_new>
+=item C<STRING * Parrot_str_new(PARROT_INTERP, const char * const buffer, const UINTVAL len)>
Make a Parrot string from a specified C string.
@@ -620,7 +622,8 @@
/*
-=item C<const char* string_primary_encoding_for_representation>
+=item C<const char* string_primary_encoding_for_representation(PARROT_INTERP,
+parrot_string_representation_t representation)>
Returns the primary encoding for the specified representation.
@@ -648,7 +651,7 @@
/*
-=item C<STRING * Parrot_str_new_constant>
+=item C<STRING * Parrot_str_new_constant(PARROT_INTERP, const char *buffer)>
Creates and returns a constant Parrot string.
@@ -684,7 +687,8 @@
/*
-=item C<STRING * string_make>
+=item C<STRING * string_make(PARROT_INTERP, const char *buffer,
+UINTVAL len, const char *charset_name, UINTVAL flags)>
Creates and returns a new Parrot string using C<len> bytes of string data read
from C<buffer>.
@@ -736,7 +740,8 @@
/*
-=item C<STRING * Parrot_str_new_init>
+=item C<STRING * Parrot_str_new_init(PARROT_INTERP, const char *buffer,
+UINTVAL len, const ENCODING *encoding, const CHARSET *charset, UINTVAL flags)>
Given a buffer, its length, an encoding, a character set, and STRING flags,
creates and returns a new string. Don't call this directly.
@@ -799,7 +804,7 @@
/*
-=item C<STRING * Parrot_str_resize>
+=item C<STRING * Parrot_str_resize(PARROT_INTERP, STRING *s, UINTVAL addlen)>
Grows the Parrot string's buffer by the specified number of characters.
@@ -830,7 +835,7 @@
=over 4
-=item C<UINTVAL Parrot_str_byte_length>
+=item C<UINTVAL Parrot_str_byte_length(PARROT_INTERP, const STRING *s)>
Returns the number of characters in the specified Parrot string.
@@ -851,7 +856,7 @@
/*
-=item C<INTVAL Parrot_str_indexed>
+=item C<INTVAL Parrot_str_indexed(PARROT_INTERP, const STRING *s, UINTVAL idx)>
Returns the character (or glyph, depending upon the string's encoding). This
abstracts the process of finding the Nth character in a (possibly Unicode or
@@ -877,7 +882,8 @@
/*
-=item C<INTVAL Parrot_str_find_index>
+=item C<INTVAL Parrot_str_find_index(PARROT_INTERP, const STRING *s,
+const STRING *s2, INTVAL start)>
Returns the character position of the second Parrot string in the first at or
after C<start>. The return value is a (0 based) offset in characters, not
@@ -921,7 +927,7 @@
/*
-=item C<INTVAL string_ord>
+=item C<INTVAL string_ord(PARROT_INTERP, const STRING *s, INTVAL idx)>
Returns the codepoint at a given index into a string. Negative indexes are
treated as counting from the end of the string.
@@ -962,7 +968,7 @@
/*
-=item C<STRING * string_chr>
+=item C<STRING * string_chr(PARROT_INTERP, UINTVAL character)>
Returns a single-character Parrot string.
@@ -995,7 +1001,7 @@
/*
-=item C<STRING * Parrot_str_copy>
+=item C<STRING * Parrot_str_copy(PARROT_INTERP, STRING *s)>
Creates and returns a copy of the specified Parrot string.
@@ -1022,7 +1028,7 @@
=over 4
-=item C<INTVAL Parrot_str_length>
+=item C<INTVAL Parrot_str_length(PARROT_INTERP, STRING *s)>
Calculates and returns the number of characters in the specified Parrot string.
@@ -1044,7 +1050,7 @@
/*
-=item C<INTVAL string_max_bytes>
+=item C<INTVAL string_max_bytes(PARROT_INTERP, const STRING *s, UINTVAL nchars)>
Returns the number of bytes required to safely contain the specified number
of characters in the specified Parrot string's representation.
@@ -1065,7 +1071,7 @@
/*
-=item C<STRING * Parrot_str_repeat>
+=item C<STRING * Parrot_str_repeat(PARROT_INTERP, const STRING *s, UINTVAL num)>
Repeats the specified Parrot string I<num> times and returns the result.
@@ -1102,7 +1108,8 @@
/*
-=item C<STRING * Parrot_str_substr>
+=item C<STRING * Parrot_str_substr(PARROT_INTERP, STRING *src, INTVAL offset,
+INTVAL length, STRING **d, int replace_dest)>
Copies the substring of length C<length> from C<offset> from the specified
Parrot string and stores it in C<**d>, allocating memory if necessary. The
@@ -1175,7 +1182,8 @@
/*
-=item C<STRING * Parrot_str_replace>
+=item C<STRING * Parrot_str_replace(PARROT_INTERP, STRING *src,
+INTVAL offset, INTVAL length, STRING *rep, STRING **d)>
Replaces a sequence of C<length> characters from C<offset> in the first
Parrot string with the second Parrot string, returning what was
@@ -1329,7 +1337,7 @@
/*
-=item C<STRING * Parrot_str_chopn>
+=item C<STRING * Parrot_str_chopn(PARROT_INTERP, STRING *s, INTVAL n)>
Removes the last C<n> characters of the specified Parrot string. If C<n> is
negative, cuts the string after C<+n> characters. The returned string is a copy
@@ -1353,7 +1361,7 @@
/*
-=item C<void Parrot_str_chopn_inplace>
+=item C<void Parrot_str_chopn_inplace(PARROT_INTERP, STRING *s, INTVAL n)>
Removes the last C<n> characters of the specified Parrot string. If C<n> is
negative, cuts the string after C<+n> characters. The string passed in is
@@ -1412,7 +1420,7 @@
/*
-=item C<INTVAL Parrot_str_compare>
+=item C<INTVAL Parrot_str_compare(PARROT_INTERP, const STRING *s1, const STRING *s2)>
Compares two strings to each other. If s1 is less than s2, returns -1. If the
strings are equal, returns 0. If s1 is greater than s2, returns 2. This
@@ -1444,7 +1452,7 @@
/*
-=item C<INTVAL Parrot_str_not_equal>
+=item C<INTVAL Parrot_str_not_equal(PARROT_INTERP, const STRING *s1, const STRING *s2)>
Compares two Parrot strings, performing type and encoding conversions if
necessary. Returns 1 if the strings are not equal, and 0 otherwise.
@@ -1464,7 +1472,7 @@
/*
-=item C<INTVAL Parrot_str_equal>
+=item C<INTVAL Parrot_str_equal(PARROT_INTERP, const STRING *s1, const STRING *s2)>
Compares two Parrot strings, performing type and encoding conversions if
necessary.
@@ -1515,7 +1523,8 @@
/*
-=item C<static void make_writable>
+=item C<static void make_writable(PARROT_INTERP, STRING **s,
+const size_t len, parrot_string_representation_t representation)>
Makes the specified Parrot string writable with minimum length C<len>. The
C<representation> argument is required in case a new Parrot string has to be
@@ -1541,7 +1550,8 @@
/*
-=item C<STRING * Parrot_str_bitwise_and>
+=item C<STRING * Parrot_str_bitwise_and(PARROT_INTERP, const STRING *s1,
+const STRING *s2, STRING **dest)>
Performs a bitwise C<AND> on two Parrot string, performing type and encoding
conversions if necessary. If the second string is not C<NULL> then it is
@@ -1692,7 +1702,8 @@
/*
-=item C<STRING * Parrot_str_bitwise_or>
+=item C<STRING * Parrot_str_bitwise_or(PARROT_INTERP, const STRING *s1,
+const STRING *s2, STRING **dest)>
Performs a bitwise C<OR> on two Parrot strings, performing type and encoding
conversions if necessary. If the third string is not C<NULL>, then it is
@@ -1767,7 +1778,8 @@
/*
-=item C<STRING * Parrot_str_bitwise_xor>
+=item C<STRING * Parrot_str_bitwise_xor(PARROT_INTERP, const STRING *s1,
+const STRING *s2, STRING **dest)>
Performs a bitwise C<XOR> on two Parrot strings, performing type and encoding
conversions if necessary. If the second string is not C<NULL>, then it is
@@ -1854,7 +1866,8 @@
/*
-=item C<STRING * Parrot_str_bitwise_not>
+=item C<STRING * Parrot_str_bitwise_not(PARROT_INTERP, const STRING *s,
+STRING **dest)>
Performs a bitwise C<NOT> on a Parrot string. If the second string is
not C<NULL> then it is reused, otherwise a new Parrot string is created.
@@ -1919,7 +1932,7 @@
/*
-=item C<INTVAL Parrot_str_boolean>
+=item C<INTVAL Parrot_str_boolean(PARROT_INTERP, const STRING *s)>
Returns whether the specified Parrot string is true. A string is true if it is
equal to anything other than C<0>, C<""> or C<"0">.
@@ -1956,7 +1969,7 @@
/*
-=item C<STRING * Parrot_str_format_data>
+=item C<STRING * Parrot_str_format_data(PARROT_INTERP, const char *format, ...)>
Writes and returns a Parrot string.
@@ -1983,7 +1996,7 @@
/*
-=item C<INTVAL Parrot_str_to_int>
+=item C<INTVAL Parrot_str_to_int(PARROT_INTERP, const STRING *s)>
Converts a numeric Parrot string to an integer value.
@@ -2056,7 +2069,7 @@
/*
-=item C<FLOATVAL Parrot_str_to_num>
+=item C<FLOATVAL Parrot_str_to_num(PARROT_INTERP, const STRING *s)>
Converts a numeric Parrot STRING to a floating point number.
@@ -2112,7 +2125,7 @@
/*
-=item C<STRING * Parrot_str_from_int>
+=item C<STRING * Parrot_str_from_int(PARROT_INTERP, INTVAL i)>
Returns a Parrot string representation of the specified integer value.
@@ -2134,7 +2147,7 @@
/*
-=item C<STRING * Parrot_str_from_num>
+=item C<STRING * Parrot_str_from_num(PARROT_INTERP, FLOATVAL f)>
Returns a Parrot string representation of the specified floating-point value.
@@ -2158,7 +2171,7 @@
/*
-=item C<char * Parrot_str_to_cstring>
+=item C<char * Parrot_str_to_cstring(PARROT_INTERP, const STRING *s)>
Returns a C string for the specified Parrot string. Use
C<Parrot_str_free_cstring()> to free the string. Failure to do this will result in
@@ -2186,7 +2199,7 @@
/*
-=item C<char * string_to_cstring_nullable>
+=item C<char * string_to_cstring_nullable(PARROT_INTERP, const STRING *s)>
Returns a C string for the specified Parrot string. Use
C<Parrot_str_free_cstring()> to free the string. Failure to do this will result in
@@ -2216,7 +2229,7 @@
/*
-=item C<void Parrot_str_free_cstring>
+=item C<void Parrot_str_free_cstring(char *p)>
Free a string created by C<Parrot_str_to_cstring()>.
@@ -2238,7 +2251,7 @@
/*
-=item C<void Parrot_str_pin>
+=item C<void Parrot_str_pin(PARROT_INTERP, STRING *s)>
Replaces the specified Parrot string's managed buffer memory by system memory.
@@ -2274,7 +2287,7 @@
/*
-=item C<void Parrot_str_unpin>
+=item C<void Parrot_str_unpin(PARROT_INTERP, STRING *s)>
Undoes a C<Parrot_str_pin()> so that the string once again uses managed memory.
@@ -2323,7 +2336,7 @@
/*
-=item C<size_t Parrot_str_to_hashval>
+=item C<size_t Parrot_str_to_hashval(PARROT_INTERP, STRING *s)>
Returns the hash value for the specified Parrot string, caching it in
C<< s->hashval >>.
@@ -2356,7 +2369,7 @@
/*
-=item C<STRING * Parrot_str_escape>
+=item C<STRING * Parrot_str_escape(PARROT_INTERP, const STRING *src)>
Escapes all non-ASCII chars to backslash sequences. Control chars that
C<Parrot_str_unescape> can handle are escaped as I<\x>, as well as a double
@@ -2380,8 +2393,8 @@
/*
-=item C<STRING * Parrot_str_escape_truncate>
-
+=item C<STRING * Parrot_str_escape_truncate(PARROT_INTERP,
+const STRING *src, UINTVAL limit)>
Escapes all non-ASCII characters in the given string with backslashed versions,
but limits the length of the output (used for trace output of strings).
@@ -2508,7 +2521,8 @@
/*
-=item C<STRING * Parrot_str_unescape>
+=item C<STRING * Parrot_str_unescape(PARROT_INTERP, const char *cstring,
+char delimiter, const char *enc_char)>
Unescapes the specified C string. These sequences are covered:
@@ -2618,7 +2632,7 @@
/*
-=item C<STRING * Parrot_str_upcase>
+=item C<STRING * Parrot_str_upcase(PARROT_INTERP, const STRING *s)>
Returns a copy of the specified Parrot string converted to upper case.
Non-caseable characters are left unchanged.
@@ -2649,7 +2663,7 @@
/*
-=item C<void Parrot_str_upcase_inplace>
+=item C<void Parrot_str_upcase_inplace(PARROT_INTERP, STRING *s)>
Converts the specified Parrot string to upper case.
@@ -2675,7 +2689,7 @@
/*
-=item C<STRING * Parrot_str_downcase>
+=item C<STRING * Parrot_str_downcase(PARROT_INTERP, const STRING *s)>
Returns a copy of the specified Parrot string converted to lower case.
Non-caseable characters are left unchanged.
@@ -2700,7 +2714,7 @@
/*
-=item C<void Parrot_str_downcase_inplace>
+=item C<void Parrot_str_downcase_inplace(PARROT_INTERP, STRING *s)>
Converts the specified Parrot string to lower case.
@@ -2726,7 +2740,7 @@
/*
-=item C<STRING * Parrot_str_titlecase>
+=item C<STRING * Parrot_str_titlecase(PARROT_INTERP, const STRING *s)>
Returns a copy of the specified Parrot string converted to title case.
Non-caseable characters are left unchanged.
@@ -2751,7 +2765,7 @@
/*
-=item C<void Parrot_str_titlecase_inplace>
+=item C<void Parrot_str_titlecase_inplace(PARROT_INTERP, STRING *s)>
Converts the specified Parrot string to title case.
@@ -2771,7 +2785,7 @@
/*
-=item C<STRING * string_increment>
+=item C<STRING * string_increment(PARROT_INTERP, const STRING *s)>
Increments the string in the Perl 5 fashion, where incrementing aa gives you bb
and so on. Currently single char only.
@@ -2808,7 +2822,7 @@
/*
-=item C<const char * Parrot_string_cstring>
+=item C<const char * Parrot_string_cstring(PARROT_INTERP, const STRING *str)>
Returns a C string from a Parrot string. Both sides are treated
as constants -- i.e. do not resize the result.
@@ -2831,7 +2845,8 @@
/*
-=item C<INTVAL Parrot_str_is_cclass>
+=item C<INTVAL Parrot_str_is_cclass(PARROT_INTERP, INTVAL flags,
+const STRING *s, UINTVAL offset)>
Returns 1 if the codepoint of string C<s> at given offset is in the given
character class C<flags>. See also F<include/parrot/cclass.h> for possible
@@ -2857,7 +2872,8 @@
/*
-=item C<INTVAL Parrot_str_find_cclass>
+=item C<INTVAL Parrot_str_find_cclass(PARROT_INTERP, INTVAL flags, STRING *s,
+UINTVAL offset, UINTVAL count)>
Finds the first occurrence of the given character class in C<flags> in the
string, and returns its glyph-wise index.
@@ -2881,7 +2897,8 @@
/*
-=item C<INTVAL Parrot_str_find_not_cclass>
+=item C<INTVAL Parrot_str_find_not_cclass(PARROT_INTERP, INTVAL flags,
+STRING *s, UINTVAL offset, UINTVAL count)>
Finds the first occurrence of the a character I<not> in the given character
class in C<flags> in the string starting from C<offset> and looking at C<count>
@@ -2908,7 +2925,8 @@
/*
-=item C<STRING* Parrot_str_change_charset>
+=item C<STRING* Parrot_str_change_charset(PARROT_INTERP, STRING *src,
+INTVAL charset_nr, STRING *dest)>
If C<dest> == NULL, converts C<src> to the given charset or encoding inplace.
Otherwise returns a copy of C<src> with the charset/encoding in C<dest>.
@@ -2966,7 +2984,8 @@
/*
-=item C<STRING* Parrot_str_change_encoding>
+=item C<STRING* Parrot_str_change_encoding(PARROT_INTERP, STRING *src,
+INTVAL encoding_nr, STRING *dest)>
If C<dest> == NULL, converts C<src> to the given charset or encoding in place.
Otherwise returns a copy of C<src> with the charset/encoding in C<dest>
@@ -3018,7 +3037,7 @@
/*
-=item C<STRING * Parrot_str_compose>
+=item C<STRING * Parrot_str_compose(PARROT_INTERP, STRING *src)>
Normalizes the string.
@@ -3045,7 +3064,7 @@
/*
-=item C<STRING* Parrot_str_join>
+=item C<STRING* Parrot_str_join(PARROT_INTERP, STRING *j, PMC *ar)>
Joins the elements of the array C<ar> as strings with the string C<j> between
them, returning the result.
@@ -3085,7 +3104,7 @@
/*
-=item C<PMC* Parrot_str_split>
+=item C<PMC* Parrot_str_split(PARROT_INTERP, STRING *delim, STRING *str)>
Splits the string C<str> at the delimiter C<delim>, returning a
C<ResizableStringArray> of results. Returns PMCNULL if the string or the
@@ -3160,7 +3179,8 @@
/*
-=item C<STRING* Parrot_str_from_uint>
+=item C<STRING* Parrot_str_from_uint(PARROT_INTERP, char *tc, UHUGEINTVAL num,
+unsigned int base, int minus)>
Returns C<num> converted to a Parrot C<STRING>.
@@ -3206,7 +3226,8 @@
/*
-=item C<STRING * Parrot_str_from_int_base>
+=item C<STRING * Parrot_str_from_int_base(PARROT_INTERP, char *tc,
+HUGEINTVAL num, unsigned int base)>
Returns C<num> converted to a Parrot C<STRING>.
Modified: trunk/src/string/charset.c
==============================================================================
--- trunk/src/string/charset.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/charset.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -90,7 +90,7 @@
/*
-=item C<CHARSET * Parrot_new_charset>
+=item C<CHARSET * Parrot_new_charset(PARROT_INTERP)>
Allocates a new C<CHARSET> structure from the system.
@@ -110,7 +110,7 @@
/*
-=item C<void Parrot_charsets_encodings_deinit>
+=item C<void Parrot_charsets_encodings_deinit(PARROT_INTERP)>
Deinitializes (unloads) the charset system. Frees all charsets and the array
that holds the charsets back to the system.
@@ -140,7 +140,7 @@
/*
-=item C<const CHARSET * Parrot_find_charset>
+=item C<const CHARSET * Parrot_find_charset(PARROT_INTERP, const char *charsetname)>
Searches through the list of charsets for the charset given by C<charsetname>.
Returns the charset if it is found, NULL otherwise.
@@ -169,7 +169,7 @@
/*
-=item C<CHARSET * Parrot_load_charset>
+=item C<CHARSET * Parrot_load_charset(PARROT_INTERP, const char *charsetname)>
Throws an exception (Can't load charsets dynamically yet. RT#58184).
@@ -192,7 +192,7 @@
/*
-=item C<INTVAL Parrot_charset_number>
+=item C<INTVAL Parrot_charset_number(PARROT_INTERP, const STRING *charsetname)>
Return the number of the charset or -1 if not found.
@@ -218,7 +218,7 @@
/*
-=item C<INTVAL Parrot_charset_number_of_str>
+=item C<INTVAL Parrot_charset_number_of_str(PARROT_INTERP, const STRING *src)>
Return the number of the charset of the given string or -1 if not found.
@@ -244,7 +244,7 @@
/*
-=item C<STRING* Parrot_charset_name>
+=item C<STRING* Parrot_charset_name(PARROT_INTERP, INTVAL number_of_charset)>
Returns the name of the charset given by the INTVAL index
C<number_of_charset>.
@@ -267,7 +267,7 @@
/*
-=item C<const CHARSET * Parrot_get_charset>
+=item C<const CHARSET * Parrot_get_charset(PARROT_INTERP, INTVAL number_of_charset)>
Returns the charset given by the INTVAL index C<number_of_charset>.
@@ -289,7 +289,7 @@
/*
-=item C<const char * Parrot_charset_c_name>
+=item C<const char * Parrot_charset_c_name(PARROT_INTERP, INTVAL number_of_charset)>
Returns a NULL-terminated C string with the name of the charset given by
INTVAL index C<number_of_charset>.
@@ -312,7 +312,8 @@
/*
-=item C<static INTVAL register_charset>
+=item C<static INTVAL register_charset(PARROT_INTERP, const char *charsetname,
+CHARSET *charset)>
Adds a new charset C<charset> with name <charsetname> to the list of
all charsets. Returns 0 and does nothing if a charset with that name
@@ -353,7 +354,7 @@
/*
-=item C<static void Parrot_str_internal_register_charset_names>
+=item C<static void Parrot_str_internal_register_charset_names(PARROT_INTERP)>
Helper function for initializing characterset names. We can't create the
STRING names until the default encodings and charsets are already initted,
@@ -375,7 +376,7 @@
/*
-=item C<static void register_static_converters>
+=item C<static void register_static_converters(PARROT_INTERP)>
Registers several standard converters between common charsets, including:
@@ -409,7 +410,8 @@
/*
-=item C<INTVAL Parrot_register_charset>
+=item C<INTVAL Parrot_register_charset(PARROT_INTERP, const char *charsetname,
+CHARSET *charset)>
Register a new charset C<charset> with name C<charsetname>. Charset may only
be one of the 4 following names:
@@ -461,7 +463,7 @@
/*
-=item C<void Parrot_charsets_encodings_init>
+=item C<void Parrot_charsets_encodings_init(PARROT_INTERP)>
Creates the initial charsets and encodings, and registers the initial
charset converters.
@@ -503,7 +505,8 @@
/*
-=item C<INTVAL Parrot_make_default_charset>
+=item C<INTVAL Parrot_make_default_charset(PARROT_INTERP,
+const char *charsetname, CHARSET *charset)>
Sets the current default charset to C<charset> with name C<charsetname>.
@@ -523,7 +526,7 @@
/*
-=item C<const CHARSET * Parrot_default_charset>
+=item C<const CHARSET * Parrot_default_charset(PARROT_INTERP)>
Returns the default charset.
@@ -543,7 +546,8 @@
/*
-=item C<charset_converter_t Parrot_find_charset_converter>
+=item C<charset_converter_t Parrot_find_charset_converter(PARROT_INTERP,
+const CHARSET *lhs, const CHARSET *rhs)>
Finds a converter from charset C<lhs> to charset C<rhs>.
@@ -579,7 +583,8 @@
/*
-=item C<void Parrot_register_charset_converter>
+=item C<void Parrot_register_charset_converter(PARROT_INTERP,
+const CHARSET *lhs, CHARSET *rhs, charset_converter_t func)>
Registers a converter C<func> from charset C<lhs> to C<rhs>.
Modified: trunk/src/string/charset/ascii.c
==============================================================================
--- trunk/src/string/charset/ascii.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/charset/ascii.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -180,7 +180,8 @@
/*
-=item C<STRING * ascii_get_graphemes>
+=item C<STRING * ascii_get_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count)>
Retrieves the graphemes for the STRING C<source_string>, starting at
C<offset> and ending at C<offset + count>.
@@ -201,7 +202,8 @@
/*
-=item C<static void set_graphemes>
+=item C<static void set_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL replace_count, STRING *insert_string)>
Sets the graphemes for C<source_string>, starting at C<offset>. Replace
C<replace_count> graphemes with those from STRING C<insert_string>.
@@ -222,7 +224,8 @@
/*
-=item C<STRING * ascii_get_graphemes_inplace>
+=item C<STRING * ascii_get_graphemes_inplace(PARROT_INTERP,
+STRING *source_string, UINTVAL offset, UINTVAL count, STRING *dest_string)>
Retrieves the graphemes in place for ascii STRING C<source_string>,
starting at C<offset>. Retrieves C<count> graphemes and puts them
@@ -245,7 +248,7 @@
/*
-=item C<static STRING * to_ascii>
+=item C<static STRING * to_ascii(PARROT_INTERP, STRING *src, STRING *dest)>
Attempts to convert STRING C<src> to ASCII in STRING C<dest>. Throws
an exception if unconvertable UNICODE characters are involved.
@@ -289,7 +292,7 @@
/*
-=item C<static STRING * to_unicode>
+=item C<static STRING * to_unicode(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the ASCII STRING C<src> to UNICODE STRING C<dest>.
@@ -317,7 +320,7 @@
/*
-=item C<static STRING * to_charset>
+=item C<static STRING * to_charset(PARROT_INTERP, STRING *src, STRING *dest)>
Converts STRING C<src> to ASCII charset STRING C<dest>.
@@ -344,7 +347,7 @@
/* A noop. can't compose ascii */
/*
-=item C<static STRING* compose>
+=item C<static STRING* compose(PARROT_INTERP, STRING *src)>
Can't compose ASCII strings, so performs a string copy on it and
returns the new string.
@@ -364,7 +367,7 @@
/* A noop. can't decompose ascii */
/*
-=item C<static STRING* decompose>
+=item C<static STRING* decompose(PARROT_INTERP, STRING *src)>
Can't decompose ASCII, so we perform a string copy instead and return
a pointer to the new string.
@@ -383,7 +386,7 @@
/*
-=item C<static void upcase>
+=item C<static void upcase(PARROT_INTERP, STRING *source_string)>
Converts the STRING C<source_string> to all uppercase.
@@ -409,7 +412,7 @@
/*
-=item C<static void downcase>
+=item C<static void downcase(PARROT_INTERP, STRING *source_string)>
Converts the STRING C<source_string> to all lower-case.
@@ -435,7 +438,7 @@
/*
-=item C<static void titlecase>
+=item C<static void titlecase(PARROT_INTERP, STRING *source_string)>
Converts the STRING given by C<source_string> to title case, where
the first character is upper case and all the rest of the characters
@@ -464,7 +467,7 @@
/*
-=item C<static void upcase_first>
+=item C<static void upcase_first(PARROT_INTERP, STRING *source_string)>
Sets the first character in the STRING C<source_string> to upper case,
but doesn't modify the rest of the string.
@@ -485,7 +488,7 @@
/*
-=item C<static void downcase_first>
+=item C<static void downcase_first(PARROT_INTERP, STRING *source_string)>
Sets the first character of the STRING C<source_string> to lowercase,
but doesn't modify the rest of the characters.
@@ -506,7 +509,7 @@
/*
-=item C<static void titlecase_first>
+=item C<static void titlecase_first(PARROT_INTERP, STRING *source_string)>
Converts the first letter of STRING C<source_string> to upper case,
but doesn't modify the rest of the string.
@@ -527,7 +530,7 @@
/*
-=item C<INTVAL ascii_compare>
+=item C<INTVAL ascii_compare(PARROT_INTERP, const STRING *lhs, const STRING *rhs)>
Compares two strings as ASCII strings. If STRING C<lhs> > C<rhs>, returns
1. If C<lhs> == C<rhs> returns 0. If STRING C<lhs> < C<rhs>, returns -1.
@@ -573,7 +576,8 @@
/*
-=item C<INTVAL mixed_cs_index>
+=item C<INTVAL mixed_cs_index(PARROT_INTERP, STRING *src, STRING *search,
+UINTVAL offs)>
Searches for the first instance of STRING C<search> in STRING C<src>.
returns the position where the substring is found if it is indeed found.
@@ -621,7 +625,8 @@
/*
-=item C<INTVAL ascii_cs_index>
+=item C<INTVAL ascii_cs_index(PARROT_INTERP, STRING *source_string,
+STRING *search_string, UINTVAL offset)>
Searches for the first instance of STRING C<search> in STRING C<src>.
returns the position where the substring is found if it is indeed found.
@@ -650,7 +655,8 @@
/*
-=item C<INTVAL ascii_cs_rindex>
+=item C<INTVAL ascii_cs_rindex(PARROT_INTERP, STRING *source_string,
+STRING *search_string, UINTVAL offset)>
Searches for the last instance of STRING C<search_string> in STRING
C<source_string>. Starts searching at C<offset>.
@@ -679,7 +685,7 @@
/*
-=item C<static UINTVAL validate>
+=item C<static UINTVAL validate(PARROT_INTERP, STRING *src)>
Verifies that the given string is valid ASCII. Returns 1 if it is ASCII,
returns 0 otherwise.
@@ -707,7 +713,7 @@
/*
-=item C<static STRING * string_from_codepoint>
+=item C<static STRING * string_from_codepoint(PARROT_INTERP, UINTVAL codepoint)>
Creates a new STRING object from a single codepoint C<codepoint>. Returns
the new STRING.
@@ -729,7 +735,8 @@
/*
-=item C<static INTVAL is_cclass>
+=item C<static INTVAL is_cclass(PARROT_INTERP, INTVAL flags,
+const STRING *source_string, UINTVAL offset)>
=cut
@@ -755,7 +762,8 @@
/*
-=item C<static INTVAL find_cclass>
+=item C<static INTVAL find_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -782,7 +790,8 @@
/*
-=item C<static INTVAL find_not_cclass>
+=item C<static INTVAL find_not_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -808,7 +817,7 @@
/*
-=item C<size_t ascii_compute_hash>
+=item C<size_t ascii_compute_hash(PARROT_INTERP, const STRING *source_string, size_t seed)>
Computes the hash of STRING C<source_string> starting with seed value
C<seed>.
@@ -836,7 +845,7 @@
/*
-=item C<const CHARSET * Parrot_charset_ascii_init>
+=item C<const CHARSET * Parrot_charset_ascii_init(PARROT_INTERP)>
Initialize the ASCII charset but registering all the necessary
function pointers and settings.
@@ -885,7 +894,7 @@
/*
-=item C<STRING * charset_cvt_ascii_to_binary>
+=item C<STRING * charset_cvt_ascii_to_binary(PARROT_INTERP, STRING *src, STRING *dest)>
Converts an ASCII STRING C<src> to a binary STRING C<dest>.
@@ -916,7 +925,8 @@
/*
-=item C<STRING * charset_cvt_ascii_to_iso_8859_1>
+=item C<STRING * charset_cvt_ascii_to_iso_8859_1(PARROT_INTERP, STRING *src,
+STRING *dest)>
Converts ASCII STRING C<src> to ISO8859-1 STRING C<dest>.
Modified: trunk/src/string/charset/binary.c
==============================================================================
--- trunk/src/string/charset/binary.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/charset/binary.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -154,7 +154,8 @@
/*
-=item C<static void set_graphemes>
+=item C<static void set_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL replace_count, STRING *insert_string)>
Sets the graphemes for STRING C<source_string>, starting at offset
C<offset>. Replaces C<replace_count> graphemes from STRING
@@ -175,7 +176,7 @@
/*
-=item C<static STRING* to_charset>
+=item C<static STRING* to_charset(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the STRING C<src> to STRING C<dest> in binary mode. Throws
an exception if a suitable conversion function is not found.
@@ -201,7 +202,7 @@
/*
-=item C<static STRING* compose>
+=item C<static STRING* compose(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot compose a binary string.
@@ -220,7 +221,7 @@
/*
-=item C<static STRING* decompose>
+=item C<static STRING* decompose(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot decompose a binary string.
@@ -239,7 +240,7 @@
/*
-=item C<static void upcase>
+=item C<static void upcase(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot convert a binary string to
upper case.
@@ -257,7 +258,7 @@
/*
-=item C<static void downcase>
+=item C<static void downcase(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot convert a binary string to
lower-case.
@@ -275,7 +276,7 @@
/*
-=item C<static void titlecase>
+=item C<static void titlecase(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot convert a binary string to
title case.
@@ -293,7 +294,7 @@
/*
-=item C<static void upcase_first>
+=item C<static void upcase_first(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot set the first "character" of the
binary string to uppercase.
@@ -311,7 +312,7 @@
/*
-=item C<static void downcase_first>
+=item C<static void downcase_first(PARROT_INTERP, STRING *source_string)>
Throws an exception because we cannot set the first "character"
of the binary string to lowercase.
@@ -329,7 +330,7 @@
/*
-=item C<static void titlecase_first>
+=item C<static void titlecase_first(PARROT_INTERP, STRING *source_string)>
Throws an exception because we can't convert the first "character"
of binary data to title case.
@@ -347,7 +348,7 @@
/*
-=item C<static INTVAL compare>
+=item C<static INTVAL compare(PARROT_INTERP, const STRING *lhs, const STRING *rhs)>
Compare the two buffers, first by size, then with memcmp.
@@ -369,7 +370,8 @@
/*
-=item C<static INTVAL cs_index>
+=item C<static INTVAL cs_index(PARROT_INTERP, STRING *source_string,
+STRING *search_string, UINTVAL offset)>
Returns -1. It makes no sense to try and search for a substring in
raw binary data.
@@ -388,7 +390,8 @@
/*
-=item C<static INTVAL cs_rindex>
+=item C<static INTVAL cs_rindex(PARROT_INTERP, STRING *source_string,
+STRING *search_string, UINTVAL offset)>
Returns -1. It makes no sense to search for the last substring match
in raw binary data.
@@ -407,7 +410,7 @@
/*
-=item C<static UINTVAL validate>
+=item C<static UINTVAL validate(PARROT_INTERP, STRING *source_string)>
Returns 1. All sequential data is valid binary data.
@@ -425,7 +428,8 @@
/*
-=item C<static INTVAL is_cclass>
+=item C<static INTVAL is_cclass(PARROT_INTERP, INTVAL flags,
+const STRING *source_string, UINTVAL offset)>
=cut
@@ -441,7 +445,8 @@
/*
-=item C<static INTVAL find_cclass>
+=item C<static INTVAL find_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -457,7 +462,8 @@
/*
-=item C<static INTVAL find_not_cclass>
+=item C<static INTVAL find_not_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -473,7 +479,7 @@
/*
-=item C<static STRING * string_from_codepoint>
+=item C<static STRING * string_from_codepoint(PARROT_INTERP, UINTVAL codepoint)>
=cut
@@ -493,7 +499,7 @@
/*
-=item C<const CHARSET * Parrot_charset_binary_init>
+=item C<const CHARSET * Parrot_charset_binary_init(PARROT_INTERP)>
Initialize the binary charset, including function pointers and
settings.
Modified: trunk/src/string/charset/iso-8859-1.c
==============================================================================
--- trunk/src/string/charset/iso-8859-1.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/charset/iso-8859-1.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -181,7 +181,8 @@
/*
-=item C<static void set_graphemes>
+=item C<static void set_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL replace_count, STRING *insert_string)>
Sets C<replace_count> graphemes in STRING C<source_string> starting at offset C<offset>.
Gets the replacement graphemes from STRING C<insert_string>.
@@ -201,7 +202,7 @@
/*
-=item C<static STRING * to_iso_8859_1>
+=item C<static STRING * to_iso_8859_1(PARROT_INTERP, STRING *src, STRING *dest)>
Converts STRING C<src> to iso-8859-1 in STRING C<dest>.
@@ -243,7 +244,7 @@
/*
-=item C<static STRING * to_unicode>
+=item C<static STRING * to_unicode(PARROT_INTERP, STRING *src, STRING *dest)>
Converts STRING C<src> to unicode STRING C<dest>.
@@ -286,7 +287,7 @@
/*
-=item C<static STRING * to_charset>
+=item C<static STRING * to_charset(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the STRING C<src> to an ISO-8859-1 STRING C<dest>.
@@ -312,7 +313,7 @@
/*
-=item C<static STRING* compose>
+=item C<static STRING* compose(PARROT_INTERP, STRING *src)>
ISO-8859-1 does not support composing, so we just copy the STRING C<src> and return the
copy.
@@ -333,7 +334,7 @@
/*
-=item C<static STRING* decompose>
+=item C<static STRING* decompose(PARROT_INTERP, STRING *src)>
SO-8859-1 does not support decomposing, so we throw an exception.
@@ -352,7 +353,7 @@
/*
-=item C<static void upcase>
+=item C<static void upcase(PARROT_INTERP, STRING *source_string)>
Convert all graphemes in the STRING C<source_string> to upper case, for those
graphemes that support cases.
@@ -385,7 +386,7 @@
/*
-=item C<static void downcase>
+=item C<static void downcase(PARROT_INTERP, STRING *source_string)>
Converts all graphemes in STRING C<source_string> to lower-case, for those graphemes
that support cases.
@@ -417,7 +418,7 @@
/*
-=item C<static void titlecase>
+=item C<static void titlecase(PARROT_INTERP, STRING *source_string)>
Converts the graphemes in STRING C<source_string> to title case, for those graphemes
that support cases.
@@ -458,7 +459,7 @@
/*
-=item C<static void upcase_first>
+=item C<static void upcase_first(PARROT_INTERP, STRING *source_string)>
Converts the first grapheme in STRING C<source_string> to upper case, if it
supports cases.
@@ -488,7 +489,7 @@
/*
-=item C<static void downcase_first>
+=item C<static void downcase_first(PARROT_INTERP, STRING *source_string)>
Converts the first character of the STRING C<source_string> to lower case, if the
grapheme supports lower case.
@@ -518,7 +519,7 @@
/*
-=item C<static void titlecase_first>
+=item C<static void titlecase_first(PARROT_INTERP, STRING *source_string)>
Converts the first grapheme in STRING C<source_string> to title case, if the grapheme
supports case.
@@ -537,7 +538,7 @@
/*
-=item C<static UINTVAL validate>
+=item C<static UINTVAL validate(PARROT_INTERP, STRING *src)>
Returns 1 if the STRING C<src> is a valid ISO-8859-1 STRING. Returns 0 otherwise.
@@ -561,7 +562,8 @@
/*
-=item C<static INTVAL is_cclass>
+=item C<static INTVAL is_cclass(PARROT_INTERP, INTVAL flags,
+const STRING *source_string, UINTVAL offset)>
=cut
@@ -586,7 +588,8 @@
/*
-=item C<static INTVAL find_cclass>
+=item C<static INTVAL find_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -613,7 +616,8 @@
/*
-=item C<static INTVAL find_not_cclass>
+=item C<static INTVAL find_not_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -640,7 +644,7 @@
/*
-=item C<static STRING * string_from_codepoint>
+=item C<static STRING * string_from_codepoint(PARROT_INTERP, UINTVAL codepoint)>
Creates a new STRING from the single codepoint C<codepoint>.
@@ -661,7 +665,7 @@
/*
-=item C<const CHARSET * Parrot_charset_iso_8859_1_init>
+=item C<const CHARSET * Parrot_charset_iso_8859_1_init(PARROT_INTERP)>
Initializes the ISO-8859-1 charset by installing all the necessary function pointers.
@@ -709,7 +713,7 @@
/*
-=item C<STRING * charset_cvt_iso_8859_1_to_ascii>
+=item C<STRING * charset_cvt_iso_8859_1_to_ascii(PARROT_INTERP, STRING *src, STRING *dest)>
Converts STRING C<src> in ISO-8859-1 to ASCII STRING C<dest>.
Modified: trunk/src/string/charset/unicode.c
==============================================================================
--- trunk/src/string/charset/unicode.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/charset/unicode.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2005-2008, Parrot Foundation.
+Copyright (C) 2005-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -225,7 +225,8 @@
/*
-=item C<static void set_graphemes>
+=item C<static void set_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL replace_count, STRING *insert_string)>
Sets C<replace_count> graphemes in STRING C<source_string> starting at offset
C<offset>. Gets the graphemes to be replaced from STRING C<insert_string>.
@@ -246,7 +247,8 @@
/*
-=item C<static STRING * get_graphemes>
+=item C<static STRING * get_graphemes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count)>
Gets the graphemes from STRING C<source_string> starting at C<offset>. Gets
C<count> graphemes total.
@@ -267,7 +269,8 @@
/*
-=item C<static STRING * get_graphemes_inplace>
+=item C<static STRING * get_graphemes_inplace(PARROT_INTERP,
+STRING *source_string, UINTVAL offset, UINTVAL count, STRING *dest_string)>
Gets C<count> graphemes in place from STRING C<source_string> starting at
offset C<offset>. Puts them into STRING C<dest_string>.
@@ -289,7 +292,7 @@
/*
-=item C<static STRING* to_charset>
+=item C<static STRING* to_charset(PARROT_INTERP, STRING *src, STRING *dest)>
Converts input STRING C<src> to unicode STRING C<dest>.
@@ -315,7 +318,7 @@
/*
-=item C<static STRING* compose>
+=item C<static STRING* compose(PARROT_INTERP, STRING *src)>
If Parrot is built with ICU, composes the STRING C<src>. Attempts to
denormalize the STRING into the ICU default, NFC.
@@ -378,7 +381,7 @@
/*
-=item C<static STRING* decompose>
+=item C<static STRING* decompose(PARROT_INTERP, STRING *src)>
Decompose function for unicode charset. This function is not yet implemented.
@@ -398,7 +401,7 @@
/*
-=item C<static void upcase>
+=item C<static void upcase(PARROT_INTERP, STRING *src)>
Converts the STRING C<src> to all upper-case graphemes, for those characters
which support upper-case versions.
@@ -493,7 +496,7 @@
/*
-=item C<static void downcase>
+=item C<static void downcase(PARROT_INTERP, STRING *src)>
Converts all graphemes to lower-case, for those graphemes which have cases.
@@ -557,7 +560,7 @@
/*
-=item C<static void titlecase>
+=item C<static void titlecase(PARROT_INTERP, STRING *src)>
Converts the string to title case, for those characters which support cases.
@@ -625,7 +628,7 @@
/*
-=item C<static void upcase_first>
+=item C<static void upcase_first(PARROT_INTERP, STRING *source_string)>
Converts the first grapheme in the STRING C<source_string> to uppercase, if the
grapheme supports it. Not implemented.
@@ -645,7 +648,7 @@
/*
-=item C<static void downcase_first>
+=item C<static void downcase_first(PARROT_INTERP, STRING *source_string)>
Converts the first grapheme in the STRING C<source_string> to lower-case, if
the grapheme supports it. Not implemented
@@ -665,7 +668,7 @@
/*
-=item C<static void titlecase_first>
+=item C<static void titlecase_first(PARROT_INTERP, STRING *source_string)>
Converts the first grapheme in STRING C<source_string> to title case, if the
string supports it. Not implemented.
@@ -685,7 +688,7 @@
/*
-=item C<static INTVAL compare>
+=item C<static INTVAL compare(PARROT_INTERP, const STRING *lhs, const STRING *rhs)>
Compares two STRINGs, C<lhs> and C<rhs>. Returns -1 if C<lhs> < C<rhs>. Returns
0 if C<lhs> = C<rhs>. Returns 1 if C<lhs> > C<rhs>.
@@ -730,7 +733,8 @@
/*
-=item C<static INTVAL cs_rindex>
+=item C<static INTVAL cs_rindex(PARROT_INTERP, STRING *source_string,
+STRING *search_string, UINTVAL offset)>
Finds the last index of substring C<search_string> in STRING C<source_string>,
starting from C<offset>. Not implemented.
@@ -751,7 +755,7 @@
/*
-=item C<static UINTVAL validate>
+=item C<static UINTVAL validate(PARROT_INTERP, STRING *src)>
Returns 1 if the STRING C<src> is a valid unicode string, returns 0 otherwise.
@@ -782,7 +786,7 @@
/*
-=item C<static int u_iscclass>
+=item C<static int u_iscclass(PARROT_INTERP, UINTVAL codepoint, INTVAL flags)>
=cut
@@ -876,7 +880,8 @@
/*
-=item C<static INTVAL is_cclass>
+=item C<static INTVAL is_cclass(PARROT_INTERP, INTVAL flags,
+const STRING *source_string, UINTVAL offset)>
=cut
@@ -903,7 +908,8 @@
/*
-=item C<static INTVAL find_cclass>
+=item C<static INTVAL find_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -943,7 +949,8 @@
/*
-=item C<static INTVAL find_not_cclass>
+=item C<static INTVAL find_not_cclass(PARROT_INTERP, INTVAL flags,
+STRING *source_string, UINTVAL offset, UINTVAL count)>
=cut
@@ -991,7 +998,7 @@
/*
-=item C<static STRING * string_from_codepoint>
+=item C<static STRING * string_from_codepoint(PARROT_INTERP, UINTVAL codepoint)>
Returns a one-codepoint string for the given codepoint.
@@ -1019,7 +1026,7 @@
/*
-=item C<static size_t compute_hash>
+=item C<static size_t compute_hash(PARROT_INTERP, const STRING *src, size_t seed)>
Computes the hash of the given STRING C<src> with starting seed value C<seed>.
@@ -1049,7 +1056,7 @@
/*
-=item C<const CHARSET * Parrot_charset_unicode_init>
+=item C<const CHARSET * Parrot_charset_unicode_init(PARROT_INTERP)>
Initializes the Unicode charset by installing all the necessary function
pointers.
Modified: trunk/src/string/encoding.c
==============================================================================
--- trunk/src/string/encoding.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/encoding.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -58,7 +58,7 @@
/*
-=item C<void parrot_deinit_encodings>
+=item C<void parrot_deinit_encodings(void)>
Deinitialize encodings and free all memory used by them.
@@ -83,7 +83,7 @@
/*
-=item C<ENCODING * Parrot_new_encoding>
+=item C<ENCODING * Parrot_new_encoding(PARROT_INTERP)>
Allocates the memory for a new C<ENCODING> from the system.
@@ -103,7 +103,7 @@
/*
-=item C<const ENCODING * Parrot_find_encoding>
+=item C<const ENCODING * Parrot_find_encoding(PARROT_INTERP, const char *encodingname)>
Finds an encoding with the name C<encodingname>. Returns the encoding
if it is successfully found, returns NULL otherwise.
@@ -130,7 +130,7 @@
/*
-=item C<const ENCODING * Parrot_load_encoding>
+=item C<const ENCODING * Parrot_load_encoding(PARROT_INTERP, const char *encodingname)>
Loads an encoding. Currently throws an exception because we cannot load
encodings. See RT #58186.
@@ -161,7 +161,7 @@
/*
-=item C<INTVAL Parrot_encoding_number>
+=item C<INTVAL Parrot_encoding_number(PARROT_INTERP, const STRING *encodingname)>
Return the number of the encoding or -1 if not found.
@@ -187,7 +187,7 @@
/*
-=item C<INTVAL Parrot_encoding_number_of_str>
+=item C<INTVAL Parrot_encoding_number_of_str(PARROT_INTERP, const STRING *src)>
Return the number of the encoding of the given string or -1 if not found.
@@ -213,7 +213,7 @@
/*
-=item C<STRING* Parrot_encoding_name>
+=item C<STRING* Parrot_encoding_name(PARROT_INTERP, INTVAL number_of_encoding)>
Returns the name of a character encoding based on the INTVAL index
C<number_of_encoding> to the All_encodings array.
@@ -237,7 +237,7 @@
/*
-=item C<const ENCODING* Parrot_get_encoding>
+=item C<const ENCODING* Parrot_get_encoding(PARROT_INTERP, INTVAL number_of_encoding)>
Returns the encoding given by the INTVAL index C<number_of_encoding>.
@@ -260,7 +260,7 @@
/*
-=item C<const char * Parrot_encoding_c_name>
+=item C<const char * Parrot_encoding_c_name(PARROT_INTERP, INTVAL number_of_encoding)>
Returns the NULL-terminated C string representation of the encodings name
given by the C<number_of_encoding>.
@@ -284,7 +284,8 @@
/*
-=item C<static INTVAL register_encoding>
+=item C<static INTVAL register_encoding(PARROT_INTERP, const char *encodingname,
+ENCODING *encoding)>
Registers a new character encoding C<encoding> with the given name
C<encodingname>. Returns 1 if successful, returns 0 otherwise.
@@ -323,7 +324,7 @@
/*
-=item C<void Parrot_str_internal_register_encoding_names>
+=item C<void Parrot_str_internal_register_encoding_names(PARROT_INTERP)>
Helper function for initializing characterset encoding names. We can't create
the STRING names until the default encodings and charsets are already initted,
@@ -346,7 +347,8 @@
/*
-=item C<INTVAL Parrot_register_encoding>
+=item C<INTVAL Parrot_register_encoding(PARROT_INTERP, const char *encodingname,
+ENCODING *encoding)>
Registers a character encoding C<encoding> with name C<encodingname>.
Only allows one of 4 possibilities: fixed_8, utf8, utf16, and ucs2.
@@ -391,7 +393,8 @@
/*
-=item C<INTVAL Parrot_make_default_encoding>
+=item C<INTVAL Parrot_make_default_encoding(PARROT_INTERP,
+const char *encodingname, ENCODING *encoding)>
Sets the default encoding to C<encoding> with name C<encodingname>.
@@ -411,7 +414,7 @@
/*
-=item C<const ENCODING * Parrot_default_encoding>
+=item C<const ENCODING * Parrot_default_encoding(PARROT_INTERP)>
Gets the default encoding.
@@ -431,7 +434,8 @@
/*
-=item C<encoding_converter_t Parrot_find_encoding_converter>
+=item C<encoding_converter_t Parrot_find_encoding_converter(PARROT_INTERP,
+ENCODING *lhs, ENCODING *rhs)>
Finds a converter from encoding C<rhs> to C<lhs>. Not yet implemented, so
throws an exception.
Modified: trunk/src/string/encoding/fixed_8.c
==============================================================================
--- trunk/src/string/encoding/fixed_8.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/encoding/fixed_8.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2004-2008, Parrot Foundation.
+Copyright (C) 2004-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -218,7 +218,7 @@
/*
-=item C<static STRING * to_encoding>
+=item C<static STRING * to_encoding(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the string C<src> to this particular encoding. If C<dest> is
provided, it will contain the result. Otherwise this function operates in
@@ -241,7 +241,8 @@
/*
-=item C<static UINTVAL get_codepoint>
+=item C<static UINTVAL get_codepoint(PARROT_INTERP, const STRING *source_string,
+UINTVAL offset)>
codepoints are bytes, so delegate
@@ -260,7 +261,8 @@
/*
-=item C<static void set_codepoint>
+=item C<static void set_codepoint(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL codepoint)>
This is the same as set byte
@@ -278,7 +280,7 @@
/*
-=item C<static UINTVAL get_byte>
+=item C<static UINTVAL get_byte(PARROT_INTERP, const STRING *source_string, UINTVAL offset)>
Returns the byte in string C<src> at position C<offset>.
@@ -305,7 +307,8 @@
/*
-=item C<static void set_byte>
+=item C<static void set_byte(PARROT_INTERP, const STRING *source_string,
+UINTVAL offset, UINTVAL byte)>
Sets, in string C<src> at position C<offset>, the byte C<byte>.
@@ -330,7 +333,8 @@
/*
-=item C<static STRING * get_codepoints>
+=item C<static STRING * get_codepoints(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count)>
Returns the codepoints in string C<src> at position C<offset> and length
C<count>. (Delegates to C<get_bytes>.)
@@ -354,11 +358,11 @@
/*
-=item C<static STRING * get_bytes>
+=item C<static STRING * get_bytes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count)>
Returns the bytes in string C<src> at position C<offset> and length C<count>.
-
=cut
*/
@@ -386,7 +390,8 @@
/*
-=item C<static STRING * get_codepoints_inplace>
+=item C<static STRING * get_codepoints_inplace(PARROT_INTERP,
+STRING *source_string, UINTVAL offset, UINTVAL count, STRING *dest_string)>
Gets from string C<src> at position C<offset> C<count> codepoints and returns
them in C<return_string>. (Delegates to C<get_bytes>.)
@@ -408,7 +413,8 @@
/*
-=item C<static STRING * get_bytes_inplace>
+=item C<static STRING * get_bytes_inplace(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> bytes and returns them
in C<return_string>.
@@ -437,7 +443,8 @@
/*
-=item C<static void set_codepoints>
+=item C<static void set_codepoints(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count, STRING *new_codepoints)>
Delegate to set_bytes
@@ -455,7 +462,8 @@
/*
-=item C<static void set_bytes>
+=item C<static void set_bytes(PARROT_INTERP, STRING *source_string,
+UINTVAL offset, UINTVAL count, STRING *new_bytes)>
Replaces in string C<src> at position C<offset> for C<count> bytes with the
contents of string C<new_bytes>.
@@ -474,7 +482,7 @@
/*
-=item C<static void become_encoding>
+=item C<static void become_encoding(PARROT_INTERP, STRING *source_string)>
Unconditionally makes the string be in this encoding, if that's valid
@@ -492,7 +500,7 @@
/*
-=item C<static UINTVAL codepoints>
+=item C<static UINTVAL codepoints(PARROT_INTERP, STRING *source_string)>
Returns the number of codepoints in string C<src>.
@@ -509,7 +517,7 @@
/*
-=item C<static UINTVAL bytes>
+=item C<static UINTVAL bytes(PARROT_INTERP, STRING *source_string)>
Returns the number of bytes in string C<src>.
@@ -530,7 +538,7 @@
/*
-=item C<static UINTVAL fixed8_get_next>
+=item C<static UINTVAL fixed8_get_next(PARROT_INTERP, String_iter *iter)>
Moves the string iterator C<i> to the next codepoint.
@@ -549,7 +557,7 @@
/*
-=item C<static void fixed8_set_next>
+=item C<static void fixed8_set_next(PARROT_INTERP, String_iter *iter, UINTVAL c)>
With the string iterator C<i>, appends the codepoint C<c> and advances to the
next position in the string.
@@ -568,7 +576,7 @@
/*
-=item C<static void fixed8_set_position>
+=item C<static void fixed8_set_position(PARROT_INTERP, String_iter *iter, UINTVAL pos)>
Moves the string iterator C<i> to the position C<n> in the string.
@@ -587,7 +595,7 @@
/*
-=item C<static void iter_init>
+=item C<static void iter_init(PARROT_INTERP, const STRING *src, String_iter *iter)>
Initializes for string C<src> the string iterator C<iter>.
@@ -608,7 +616,7 @@
/*
-=item C<ENCODING * Parrot_encoding_fixed_8_init>
+=item C<ENCODING * Parrot_encoding_fixed_8_init(PARROT_INTERP)>
Initializes the fixed-8 encoding.
Modified: trunk/src/string/encoding/ucs2.c
==============================================================================
--- trunk/src/string/encoding/ucs2.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/encoding/ucs2.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -210,7 +210,7 @@
/*
-=item C<static STRING * to_encoding>
+=item C<static STRING * to_encoding(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the string C<src> to this particular encoding. If C<dest> is
provided, it will contain the result. Otherwise this function operates in
@@ -239,7 +239,7 @@
/*
-=item C<static UINTVAL get_codepoint>
+=item C<static UINTVAL get_codepoint(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the codepoint in string C<src> at position C<offset>.
@@ -262,7 +262,7 @@
/*
-=item C<static void set_codepoint>
+=item C<static void set_codepoint(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL codepoint)>
Sets, in string C<src> at position C<offset>, the codepoint C<codepoint>.
@@ -286,7 +286,7 @@
/*
-=item C<static UINTVAL get_byte>
+=item C<static UINTVAL get_byte(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the byte in string C<src> at position C<offset>.
@@ -303,7 +303,7 @@
/*
-=item C<static void set_byte>
+=item C<static void set_byte(PARROT_INTERP, const STRING *src, UINTVAL offset, UINTVAL byte)>
Sets, in string C<src> at position C<offset>, the byte C<byte>.
@@ -320,7 +320,7 @@
/*
-=item C<static STRING * get_codepoints>
+=item C<static STRING * get_codepoints(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the codepoints in string C<src> at position C<offset> and length
C<count>.
@@ -359,7 +359,7 @@
/*
-=item C<static STRING * get_bytes>
+=item C<static STRING * get_bytes(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the bytes in string C<src> at position C<offset> and length C<count>.
@@ -379,7 +379,8 @@
/*
-=item C<static STRING * get_codepoints_inplace>
+=item C<static STRING * get_codepoints_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *dest_string)>
Gets from string C<src> at position C<offset> C<count> codepoints and returns
them in C<return_string>.
@@ -400,7 +401,8 @@
/*
-=item C<static STRING * get_bytes_inplace>
+=item C<static STRING * get_bytes_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> bytes and returns them
in C<return_string>.
@@ -421,7 +423,8 @@
/*
-=item C<static void set_codepoints>
+=item C<static void set_codepoints(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_codepoints)>
Replaces in string C<src> at position C<offset> for C<count> codepoints with
the contents of string C<new_codepoints>.
@@ -440,7 +443,8 @@
/*
-=item C<static void set_bytes>
+=item C<static void set_bytes(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_bytes)>
Replaces in string C<src> at position C<offset> for C<count> bytes with the
contents of string C<new_bytes>.
@@ -459,7 +463,7 @@
/*
-=item C<static void become_encoding>
+=item C<static void become_encoding(PARROT_INTERP, STRING *src)>
Unconditionally makes the string be in this encoding, if that's valid
@@ -477,7 +481,7 @@
/*
-=item C<static UINTVAL codepoints>
+=item C<static UINTVAL codepoints(PARROT_INTERP, STRING *src)>
Returns the number of codepoints in string C<src>.
@@ -500,7 +504,7 @@
/*
-=item C<static UINTVAL bytes>
+=item C<static UINTVAL bytes(PARROT_INTERP, STRING *src)>
Returns the number of bytes in string C<src>.
@@ -518,7 +522,7 @@
/*
-=item C<static UINTVAL ucs2_decode_and_advance>
+=item C<static UINTVAL ucs2_decode_and_advance(PARROT_INTERP, String_iter *i)>
Moves the string iterator C<i> to the next UCS-2 codepoint.
@@ -545,7 +549,7 @@
/*
-=item C<static void ucs2_encode_and_advance>
+=item C<static void ucs2_encode_and_advance(PARROT_INTERP, String_iter *i, UINTVAL c)>
With the string iterator C<i>, appends the codepoint C<c> and advances to the
next position in the string.
@@ -567,7 +571,7 @@
/*
-=item C<static void ucs2_set_position>
+=item C<static void ucs2_set_position(PARROT_INTERP, String_iter *i, UINTVAL n)>
Moves the string iterator C<i> to the position C<n> in the string.
@@ -587,7 +591,7 @@
/*
-=item C<static void iter_init>
+=item C<static void iter_init(PARROT_INTERP, const STRING *src, String_iter *iter)>
Initializes for string C<src> the string iterator C<iter>.
@@ -614,7 +618,7 @@
/*
-=item C<ENCODING * Parrot_encoding_ucs2_init>
+=item C<ENCODING * Parrot_encoding_ucs2_init(PARROT_INTERP)>
Initializes the UCS-2 encoding.
Modified: trunk/src/string/encoding/utf16.c
==============================================================================
--- trunk/src/string/encoding/utf16.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/encoding/utf16.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -227,7 +227,7 @@
/*
-=item C<static STRING * to_encoding>
+=item C<static STRING * to_encoding(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the string C<src> to this particular encoding. If C<dest> is
provided, it will contain the result. Otherwise this function operates in
@@ -338,7 +338,7 @@
/*
-=item C<static UINTVAL get_codepoint>
+=item C<static UINTVAL get_codepoint(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the codepoint in string C<src> at position C<offset>.
@@ -369,7 +369,7 @@
/*
-=item C<static void set_codepoint>
+=item C<static void set_codepoint(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL codepoint)>
Sets, in string C<src> at position C<offset>, the codepoint C<codepoint>.
@@ -390,7 +390,7 @@
/*
-=item C<static UINTVAL get_byte>
+=item C<static UINTVAL get_byte(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the byte in string C<src> at position C<offset>.
@@ -414,7 +414,7 @@
/*
-=item C<static void set_byte>
+=item C<static void set_byte(PARROT_INTERP, const STRING *src, UINTVAL offset, UINTVAL byte)>
Sets, in string C<src> at position C<offset>, the byte C<byte>.
@@ -438,7 +438,7 @@
/*
-=item C<static STRING * get_codepoints>
+=item C<static STRING * get_codepoints(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the codepoints in string C<src> at position C<offset> and length
C<count>.
@@ -471,7 +471,8 @@
/*
-=item C<static STRING * get_codepoints_inplace>
+=item C<static STRING * get_codepoints_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> codepoints and returns
them in C<return_string>.
@@ -503,7 +504,7 @@
/*
-=item C<static STRING * get_bytes>
+=item C<static STRING * get_bytes(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the bytes in string C<src> at position C<offset> and length C<count>.
@@ -526,7 +527,8 @@
/*
-=item C<static STRING * get_bytes_inplace>
+=item C<static STRING * get_bytes_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> bytes and returns them
in C<return_string>.
@@ -552,7 +554,8 @@
/*
-=item C<static void set_codepoints>
+=item C<static void set_codepoints(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_codepoints)>
Replaces in string C<src> at position C<offset> for C<count> codepoints with
the contents of string C<new_codepoints>.
@@ -576,7 +579,8 @@
/*
-=item C<static void set_bytes>
+=item C<static void set_bytes(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_bytes)>
Replaces in string C<src> at position C<offset> for C<count> bytes with the
contents of string C<new_bytes>.
@@ -598,7 +602,7 @@
/*
-=item C<static void become_encoding>
+=item C<static void become_encoding(PARROT_INTERP, STRING *src)>
Unconditionally makes the string be in this encoding, if that's valid
@@ -616,7 +620,7 @@
/*
-=item C<static UINTVAL codepoints>
+=item C<static UINTVAL codepoints(PARROT_INTERP, STRING *src)>
Returns the number of codepoints in string C<src>.
@@ -642,7 +646,7 @@
/*
-=item C<static UINTVAL bytes>
+=item C<static UINTVAL bytes(PARROT_INTERP, STRING *src)>
Returns the number of bytes in string C<src>.
@@ -661,7 +665,7 @@
#if PARROT_HAS_ICU
/*
-=item C<static UINTVAL utf16_decode_and_advance>
+=item C<static UINTVAL utf16_decode_and_advance(PARROT_INTERP, String_iter *i)>
Moves the string iterator C<i> to the next UTF-16 codepoint.
@@ -688,7 +692,7 @@
/*
-=item C<static void utf16_encode_and_advance>
+=item C<static void utf16_encode_and_advance(PARROT_INTERP, String_iter *i, UINTVAL c)>
With the string iterator C<i>, appends the codepoint C<c> and advances to the
next position in the string.
@@ -711,7 +715,7 @@
/*
-=item C<static void utf16_set_position>
+=item C<static void utf16_set_position(PARROT_INTERP, String_iter *i, UINTVAL n)>
Moves the string iterator C<i> to the position C<n> in the string.
@@ -735,7 +739,7 @@
/*
-=item C<static void iter_init>
+=item C<static void iter_init(PARROT_INTERP, const STRING *src, String_iter *iter)>
Initializes for string C<src> the string iterator C<iter>.
@@ -761,7 +765,7 @@
/*
-=item C<ENCODING * Parrot_encoding_utf16_init>
+=item C<ENCODING * Parrot_encoding_utf16_init(PARROT_INTERP)>
Initializes the UTF-16 encoding.
Modified: trunk/src/string/encoding/utf8.c
==============================================================================
--- trunk/src/string/encoding/utf8.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/encoding/utf8.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2001-2008, Parrot Foundation.
+Copyright (C) 2001-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -266,7 +266,8 @@
/*
-=item C<static UINTVAL utf8_characters>
+=item C<static UINTVAL utf8_characters(PARROT_INTERP, const utf8_t *ptr,
+UINTVAL byte_len)>
Returns the number of characters in the C<byte_len> bytes from C<*ptr>.
@@ -296,7 +297,7 @@
/*
-=item C<static UINTVAL utf8_decode>
+=item C<static UINTVAL utf8_decode(PARROT_INTERP, const utf8_t *ptr)>
Returns the integer for the UTF-8 character found at C<*ptr>.
@@ -340,7 +341,7 @@
/*
-=item C<static void * utf8_encode>
+=item C<static void * utf8_encode(PARROT_INTERP, void *ptr, UINTVAL c)>
Returns the UTF-8 encoding of integer C<c>.
@@ -377,7 +378,7 @@
/*
-=item C<static const void * utf8_skip_forward>
+=item C<static const void * utf8_skip_forward(const void *ptr, UINTVAL n)>
Moves C<ptr> C<n> characters forward.
@@ -401,7 +402,7 @@
/*
-=item C<static const void * utf8_skip_backward>
+=item C<static const void * utf8_skip_backward(const void *ptr, UINTVAL n)>
Moves C<ptr> C<n> characters back.
@@ -440,7 +441,7 @@
/*
-=item C<static UINTVAL utf8_decode_and_advance>
+=item C<static UINTVAL utf8_decode_and_advance(PARROT_INTERP, String_iter *i)>
The UTF-8 implementation of the string iterator's C<get_and_advance>
function.
@@ -489,7 +490,8 @@
/*
-=item C<static void utf8_encode_and_advance>
+=item C<static void utf8_encode_and_advance(PARROT_INTERP, String_iter *i,
+UINTVAL c)>
The UTF-8 implementation of the string iterator's C<set_and_advance>
function.
@@ -514,7 +516,7 @@
/*
-=item C<static void utf8_set_position>
+=item C<static void utf8_set_position(PARROT_INTERP, String_iter *i, UINTVAL pos)>
The UTF-8 implementation of the string iterator's C<set_position>
function.
@@ -548,7 +550,7 @@
/*
-=item C<static STRING * to_encoding>
+=item C<static STRING * to_encoding(PARROT_INTERP, STRING *src, STRING *dest)>
Converts the string C<src> to this particular encoding. If C<dest> is
provided, it will contain the result. Otherwise this function operates in
@@ -637,7 +639,7 @@
/*
-=item C<static UINTVAL get_codepoint>
+=item C<static UINTVAL get_codepoint(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the codepoint in string C<src> at position C<offset>.
@@ -655,7 +657,7 @@
/*
-=item C<static void set_codepoint>
+=item C<static void set_codepoint(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL codepoint)>
Sets, in string C<src> at position C<offset>, the codepoint C<codepoint>.
@@ -678,7 +680,7 @@
/*
-=item C<static UINTVAL get_byte>
+=item C<static UINTVAL get_byte(PARROT_INTERP, const STRING *src, UINTVAL offset)>
Returns the byte in string C<src> at position C<offset>.
@@ -702,7 +704,8 @@
/*
-=item C<static void set_byte>
+=item C<static void set_byte(PARROT_INTERP, const STRING *src,
+UINTVAL offset, UINTVAL byte)>
Sets, in string C<src> at position C<offset>, the byte C<byte>.
@@ -727,7 +730,7 @@
/*
-=item C<static STRING * get_codepoints>
+=item C<static STRING * get_codepoints(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the codepoints in string C<src> at position C<offset> and length
C<count>.
@@ -766,7 +769,7 @@
/*
-=item C<static STRING * get_bytes>
+=item C<static STRING * get_bytes(PARROT_INTERP, STRING *src, UINTVAL offset, UINTVAL count)>
Returns the bytes in string C<src> at position C<offset> and length C<count>.
@@ -795,7 +798,8 @@
/*
-=item C<static STRING * get_codepoints_inplace>
+=item C<static STRING * get_codepoints_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> codepoints and returns
them in C<return_string>.
@@ -831,7 +835,8 @@
/*
-=item C<static STRING * get_bytes_inplace>
+=item C<static STRING * get_bytes_inplace(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *return_string)>
Gets from string C<src> at position C<offset> C<count> bytes and returns them
in C<return_string>.
@@ -851,7 +856,8 @@
/*
-=item C<static void set_codepoints>
+=item C<static void set_codepoints(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_codepoints)>
Replaces in string C<src> at position C<offset> for C<count> codepoints with
the contents of string C<new_codepoints>.
@@ -870,7 +876,8 @@
/*
-=item C<static void set_bytes>
+=item C<static void set_bytes(PARROT_INTERP, STRING *src,
+UINTVAL offset, UINTVAL count, STRING *new_bytes)>
Replaces in string C<src> at position C<offset> for C<count> bytes with the
contents of string C<new_bytes>.
@@ -889,7 +896,7 @@
/*
-=item C<static void become_encoding>
+=item C<static void become_encoding(PARROT_INTERP, STRING *src)>
Unconditionally makes the string be in this encoding, if that's valid
@@ -907,7 +914,7 @@
/*
-=item C<static UINTVAL codepoints>
+=item C<static UINTVAL codepoints(PARROT_INTERP, STRING *src)>
Returns the number of codepoints in string C<src>.
@@ -932,7 +939,7 @@
/*
-=item C<static UINTVAL bytes>
+=item C<static UINTVAL bytes(PARROT_INTERP, STRING *src)>
Returns the number of bytes in string C<src>.
@@ -950,7 +957,7 @@
/*
-=item C<static void iter_init>
+=item C<static void iter_init(PARROT_INTERP, const STRING *src, String_iter *iter)>
Initializes for string C<src> the string iterator C<iter>.
@@ -972,7 +979,7 @@
/*
-=item C<ENCODING * Parrot_encoding_utf8_init>
+=item C<ENCODING * Parrot_encoding_utf8_init(PARROT_INTERP)>
Initializes the UTF-8 encoding.
Modified: trunk/src/string/primitives.c
==============================================================================
--- trunk/src/string/primitives.c Sun Mar 29 04:01:23 2009 (r37807)
+++ trunk/src/string/primitives.c Sun Mar 29 04:05:13 2009 (r37808)
@@ -1,5 +1,5 @@
/*
-Copyright (C) 2006-2008, Parrot Foundation.
+Copyright (C) 2006-2009, Parrot Foundation.
$Id$
=head1 NAME
@@ -33,7 +33,7 @@
/*
-=item C<void string_set_data_directory>
+=item C<void string_set_data_directory(PARROT_INTERP, const char *dir)>
Set the directory where ICU finds its data files (encodings, locales,
etc.).
@@ -70,7 +70,8 @@
/*
-=item C<Parrot_UInt4 string_unescape_one>
+=item C<Parrot_UInt4 string_unescape_one(PARROT_INTERP, UINTVAL *offset,
+STRING *string)>
Unescape a single character. We assume that we're at the start of a
sequence, right after the \.
@@ -306,7 +307,7 @@
=over 4
-=item C<INTVAL Parrot_char_digit_value>
+=item C<INTVAL Parrot_char_digit_value(PARROT_INTERP, UINTVAL character)>
Returns the decimal digit value of the specified character if it is a decimal
digit character. If not, then -1 is returned.
@@ -336,7 +337,7 @@
/*
-=item C<char * str_dup>
+=item C<char * str_dup(const char *old)>
Duplicate a C string. Just like strdup(), except it dies if it runs
out of memory.
@@ -363,10 +364,10 @@
/*
-=item C<char * str_dup>
+=item C<char * str_dup_remove_quotes(const char *old)>
-Duplicates a C string. Just like strdup(), except it dies if it runs out of
-memory.
+Duplicates a C string (minus the wrapping quotes). Similar to strdup(),
+except it dies if it runs out of memory.
=cut
More information about the parrot-commits
mailing list