From 82f7a9823642a46ca021794de5efc9c9c894d0e7 Mon Sep 17 00:00:00 2001 From: akr Date: Mon, 28 Jun 2010 13:05:07 +0000 Subject: [PATCH] update doc. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28458 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- pack.c | 254 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 128 insertions(+), 126 deletions(-) diff --git a/pack.c b/pack.c index 245c940237..be42c6293e 100644 --- a/pack.c +++ b/pack.c @@ -305,7 +305,8 @@ static unsigned long utf8_to_uv(const char*,long*); * elements to convert. If the count is an asterisk * (``*''), all remaining array elements will be * converted. Any of the directives ``sSiIlL'' may be - * followed by an underscore (``_'') to use the underlying + * followed by an underscore (``_'') or + * exclamation mark (``!'') to use the underlying * platform's native size for the specified type; otherwise, they use a * platform-independent size. Spaces are ignored in the template * string. See also String#unpack. @@ -318,68 +319,68 @@ static unsigned long utf8_to_uv(const char*,long*); * * Directives for +pack+. * - * Integer | Array | - * Directive | Element | Meaning - * ------------------------------------------------------------------------ - * C | Integer | 8-bit unsigned integer (unsigned char) - * S | Integer | 16-bit unsigned integer, native endian (uint16_t) - * L | Integer | 32-bit unsigned integer, native endian (uint32_t) - * Q | Integer | 64-bit unsigned integer, native endian (uint64_t) - * | | - * c | Integer | 8-bit signed integer (char) - * s | Integer | 16-bit signed integer, native endian (int16_t) - * l | Integer | 32-bit signed integer, native endian (int32_t) - * q | Integer | 64-bit signed integer, native endian (int64_t) - * | | - * S_ | Integer | unsigned short, native endian - * I, I_ | Integer | unsigned int, native endian - * L_ | Integer | unsigned long, native endian - * | | - * s_ | Integer | signed short, native endian - * i, i_ | Integer | signed int, native endian - * l_ | Integer | signed long, native endian - * | | - * n | Integer | 16-bit unsigned integer, network (big-endian) byte order - * N | Integer | 32-bit unsigned integer, network (big-endian) byte order - * v | Integer | 16-bit unsigned integer, VAX (little-endian) byte order - * V | Integer | 32-bit unsigned integer, VAX (little-endian) byte order - * | | - * U | Integer | UTF-8 character - * w | Integer | BER-compressed integer - * - * Float | | - * Directive | | Meaning - * ------------------------------------------------------------------------ - * D, d | Float | double-precision float, native format - * F, f | Float | single-precision float, native format - * E | Float | double-precision float, little-endian byte order - * e | Float | single-precision float, little-endian byte order - * G | Float | double-precision float, network (big-endian) byte order - * g | Float | single-precision float, network (big-endian) byte order - * - * String | | - * Directive | | Meaning - * ------------------------------------------------------------------------ - * A | String | arbitrary binary string (space padded, count is width) - * a | String | arbitrary binary string (null padded, count is width) - * Z | String | same as ``a'', except that null is added with * - * B | String | bit string (MSB first) - * b | String | bit string (LSB first) - * H | String | hex string (high nibble first) - * h | String | hex string (low nibble first) - * u | String | UU-encoded string - * M | String | quoted printable, MIME encoding (see RFC2045) - * m | String | base64 encoded string (see RFC 2045, count is width) - * | | (if count is 0, no line feed are added, see RFC 4648) - * P | String | pointer to a structure (fixed-length string) - * p | String | pointer to a null-terminated string - * - * Misc. | | - * Directive | | Meaning - * ------------------------------------------------------------------------ - * @ | --- | moves to absolute position - * X | --- | back up a byte - * x | --- | null byte + * Integer | Array | + * Directive | Element | Meaning + * --------------------------------------------------------------------------- + * C | Integer | 8-bit unsigned integer (unsigned char) + * S | Integer | 16-bit unsigned integer, native endian (uint16_t) + * L | Integer | 32-bit unsigned integer, native endian (uint32_t) + * Q | Integer | 64-bit unsigned integer, native endian (uint64_t) + * | | + * c | Integer | 8-bit signed integer (char) + * s | Integer | 16-bit signed integer, native endian (int16_t) + * l | Integer | 32-bit signed integer, native endian (int32_t) + * q | Integer | 64-bit signed integer, native endian (int64_t) + * | | + * S_, S! | Integer | unsigned short, native endian + * I, I_, I! | Integer | unsigned int, native endian + * L_, L! | Integer | unsigned long, native endian + * | | + * s_, s! | Integer | signed short, native endian + * i, i_, i! | Integer | signed int, native endian + * l_, l! | Integer | signed long, native endian + * | | + * n | Integer | 16-bit unsigned integer, network (big-endian) byte order + * N | Integer | 32-bit unsigned integer, network (big-endian) byte order + * v | Integer | 16-bit unsigned integer, VAX (little-endian) byte order + * V | Integer | 32-bit unsigned integer, VAX (little-endian) byte order + * | | + * U | Integer | UTF-8 character + * w | Integer | BER-compressed integer + * + * Float | | + * Directive | | Meaning + * --------------------------------------------------------------------------- + * D, d | Float | double-precision float, native format + * F, f | Float | single-precision float, native format + * E | Float | double-precision float, little-endian byte order + * e | Float | single-precision float, little-endian byte order + * G | Float | double-precision float, network (big-endian) byte order + * g | Float | single-precision float, network (big-endian) byte order + * + * String | | + * Directive | | Meaning + * --------------------------------------------------------------------------- + * A | String | arbitrary binary string (space padded, count is width) + * a | String | arbitrary binary string (null padded, count is width) + * Z | String | same as ``a'', except that null is added with * + * B | String | bit string (MSB first) + * b | String | bit string (LSB first) + * H | String | hex string (high nibble first) + * h | String | hex string (low nibble first) + * u | String | UU-encoded string + * M | String | quoted printable, MIME encoding (see RFC2045) + * m | String | base64 encoded string (see RFC 2045, count is width) + * | | (if count is 0, no line feed are added, see RFC 4648) + * P | String | pointer to a structure (fixed-length string) + * p | String | pointer to a null-terminated string + * + * Misc. | | + * Directive | | Meaning + * --------------------------------------------------------------------------- + * @ | --- | moves to absolute position + * X | --- | back up a byte + * x | --- | null byte */ static VALUE @@ -1213,7 +1214,8 @@ infected_str_new(const char *ptr, long len, VALUE str) * by a number, indicating the number of times to repeat with this * directive. An asterisk (``*'') will use up all * remaining elements. The directives sSiIlL may each be - * followed by an underscore (``_'') to use the underlying + * followed by an underscore (``_'') or + * exclamation mark (``!'') to use the underlying * platform's native size for the specified type; otherwise, it uses a * platform-independent consistent size. Spaces are ignored in the * format string. See also Array#pack. @@ -1230,68 +1232,68 @@ infected_str_new(const char *ptr, long len, VALUE str) * This table summarizes the various formats and the Ruby classes * returned by each. * - * Integer | | - * Directive | Returns | Meaning - * -------------------------------------------------------------- - * C | Integer | 8-bit unsigned integer (unsigned char) - * S | Integer | 16-bit unsigned integer, native endian (uint16_t) - * L | Integer | 32-bit unsigned integer, native endian (uint32_t) - * Q | Integer | 64-bit unsigned integer, native endian (uint64_t) - * | | - * c | Integer | 8-bit signed integer (signed char) - * s | Integer | 16-bit signed integer, native endian (int16_t) - * l | Integer | 32-bit signed integer, native endian (int32_t) - * q | Integer | 64-bit signed integer, native endian (int64_t) - * | | - * S_ | Integer | unsigned short, native endian - * I, I_ | Integer | unsigned int, native endian - * L_ | Integer | unsigned long, native endian - * | | - * s_ | Integer | signed short, native endian - * i, i_ | Integer | signed int, native endian - * l_ | Integer | signed long, native endian - * | | - * n | Integer | 16-bit unsigned integer, network (big-endian) byte order - * N | Integer | 32-bit unsigned integer, network (big-endian) byte order - * v | Integer | 16-bit unsigned integer, VAX (little-endian) byte order - * V | Integer | 32-bit unsigned integer, VAX (little-endian) byte order - * | | - * U | Integer | UTF-8 character - * w | Integer | BER-compressed integer (see Array.pack) - * - * Float | | - * Directive | Returns | Meaning - * -------------------------------------------------------------- - * D, d | Float | double-precision float, native format - * F, f | Float | single-precision float, native format - * E | Float | double-precision float, little-endian byte order - * e | Float | single-precision float, little-endian byte order - * G | Float | double-precision float, network (big-endian) byte order - * g | Float | single-precision float, network (big-endian) byte order - * - * String | | - * Directive | Returns | Meaning - * -------------------------------------------------------------- - * A | String | arbitrary binary string (remove trailing nulls and ASCII spaces) - * a | String | arbitrary binary string - * Z | String | null-terminated string - * B | String | bit string (MSB first) - * b | String | bit string (LSB first) - * H | String | hex string (high nibble first) - * h | String | hex string (low nibble first) - * u | String | UU-encoded string - * M | String | quoted-printable, MIME encoding (see RFC2045) - * m | String | base64 encoded string (RFC 2045) (default) - * | | base64 encoded string (RFC 4648) if followed by 0 - * P | String | pointer to a structure (fixed-length string) - * p | String | pointer to a null-terminated string - * - * Misc. | | - * Directive | Returns | Meaning - * -------------------------------------------------------------- - * @ | --- | skip to the offset given by the length argument - * X | --- | skip backward one byte - * x | --- | skip forward one byte + * Integer | | + * Directive | Returns | Meaning + * ----------------------------------------------------------------- + * C | Integer | 8-bit unsigned integer (unsigned char) + * S | Integer | 16-bit unsigned integer, native endian (uint16_t) + * L | Integer | 32-bit unsigned integer, native endian (uint32_t) + * Q | Integer | 64-bit unsigned integer, native endian (uint64_t) + * | | + * c | Integer | 8-bit signed integer (signed char) + * s | Integer | 16-bit signed integer, native endian (int16_t) + * l | Integer | 32-bit signed integer, native endian (int32_t) + * q | Integer | 64-bit signed integer, native endian (int64_t) + * | | + * S_, S! | Integer | unsigned short, native endian + * I, I_, I! | Integer | unsigned int, native endian + * L_, L! | Integer | unsigned long, native endian + * | | + * s_, s! | Integer | signed short, native endian + * i, i_, i! | Integer | signed int, native endian + * l_, l! | Integer | signed long, native endian + * | | + * n | Integer | 16-bit unsigned integer, network (big-endian) byte order + * N | Integer | 32-bit unsigned integer, network (big-endian) byte order + * v | Integer | 16-bit unsigned integer, VAX (little-endian) byte order + * V | Integer | 32-bit unsigned integer, VAX (little-endian) byte order + * | | + * U | Integer | UTF-8 character + * w | Integer | BER-compressed integer (see Array.pack) + * + * Float | | + * Directive | Returns | Meaning + * ----------------------------------------------------------------- + * D, d | Float | double-precision float, native format + * F, f | Float | single-precision float, native format + * E | Float | double-precision float, little-endian byte order + * e | Float | single-precision float, little-endian byte order + * G | Float | double-precision float, network (big-endian) byte order + * g | Float | single-precision float, network (big-endian) byte order + * + * String | | + * Directive | Returns | Meaning + * ----------------------------------------------------------------- + * A | String | arbitrary binary string (remove trailing nulls and ASCII spaces) + * a | String | arbitrary binary string + * Z | String | null-terminated string + * B | String | bit string (MSB first) + * b | String | bit string (LSB first) + * H | String | hex string (high nibble first) + * h | String | hex string (low nibble first) + * u | String | UU-encoded string + * M | String | quoted-printable, MIME encoding (see RFC2045) + * m | String | base64 encoded string (RFC 2045) (default) + * | | base64 encoded string (RFC 4648) if followed by 0 + * P | String | pointer to a structure (fixed-length string) + * p | String | pointer to a null-terminated string + * + * Misc. | | + * Directive | Returns | Meaning + * ----------------------------------------------------------------- + * @ | --- | skip to the offset given by the length argument + * X | --- | skip backward one byte + * x | --- | skip forward one byte */ static VALUE