core/io/encodings/utf16/utf16-docs.factor

   1 ! Copyright (C) 2008 Daniel Ehrenberg
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax ;
   4 IN: io.encodings.utf16
   5
   6 ARTICLE: "io.encodings.utf16" "UTF-16 encoding"
   7 "The UTF-16 encoding is a variable-width encoding. Unicode code points are encoded as 2 or 4 byte sequences. There are four encoding descriptor classes for working with UTF-16, depending on endianness or the presence of a BOM:"
   8 { $subsections
   9     utf16
  10     utf16le
  11     utf16be
  12     utf16n
  13 } ;
  14
  15 ABOUT: "io.encodings.utf16"
  16
  17 HELP: utf16le
  18 { $class-description "The encoding descriptor for UTF-16LE, that is, UTF-16 in little endian, without a byte order mark. Streams can be made which read or write wth this encoding." }
  19 { $see-also "encodings-introduction" } ;
  20
  21 HELP: utf16be
  22 { $class-description "The encoding descriptor for UTF-16BE, that is, UTF-16 in big endian, without a byte order mark. Streams can be made which read or write wth this encoding." }
  23 { $see-also "encodings-introduction" } ;
  24
  25 HELP: utf16
  26 { $class-description "The encoding descriptor for UTF-16, that is, UTF-16 with a byte order mark. This is the most useful for general input and output in UTF-16. Streams can be made which read or write wth this encoding." }
  27 { $see-also "encodings-introduction" } ;
  28
  29 HELP: utf16n
  30 { $class-description "The encoding descriptor for UTF-16 without a byte order mark in native endian order. This is useful mostly for FFI calls which take input of strings of the type " { $snippet "wchar_t*" } "." }
  31 { $see-also "encodings-introduction" } ;
  32
  33 { utf16 utf16le utf16be utf16n } related-words