Library: Character encodings, international (OMEFIO) Include: omefio.xin

Declaration

  define external source function sjis-input-file
                  value stream filename
    exceptions-to value io-exception exceptions-to optional

This external function reads the file named by the "filename" argument and returns the text of that file converted from a Shift-JIS encoding to a UTF-8 encoding. The file is in Shift-JIS, but the program receives the UTF-8 conversion.

Arguments:

• "filename". This is the name of the Shift-JIS encoded file you want to read and convert to UTF-8. If a zero-length "filename" is used (that is, ""), then sjis-input-file does not open a file, but reads from standard input. The zero-length file name option allows the conversion functionality to be used in an OmniMark program that is being used as a filter.
• "exceptions-to". This optional argument indicates that errors are to be recorded in the passed "io-exception" object, and that the OmniMark program is not to be immediately terminated. There are three types of errors, categorized according to how they are handled:
  • Whenever an invalid or out-of-range encoding is found, it is converted to the UTF-8 encoding of the Unicode "REPLACEMENT CHARACTER" (0xFFFD). If "exceptions-to" is specified, the "io-exception" object is marked for a data encoding error. The function continues processing in either case.
  • If the external source function cannot be created, either because the declaration does not match what is expected or because there is not enough memory to create the source object, an error is signaled to OmniMark, and your program is terminated.
  • If "exceptions-to" is specified, then for any other type of error that occurs during memory allocation, file opening or closing, or reading or writing, the "io-exception" object is marked for the error found, and processing continues. If "exceptions-to" is not specified, an error is signaled to OmniMark and your program is terminated.

The file format is interpreted according to the Japanese Industry Standards JIS X 0201, JIS X 0208, and JIS X 0212, transformed using the JIS<->Shift-JIS conversion algorithms.

Example:

  ; Submitting a Shift-JIS file to the XML parser and directing the output to another.
  ; Shift-JIS file.

  do xml-parse document scan sjis-input-file "input.shj"
     set sjis-output-file "output.shj" to "%c"
  done

Related Syntax    sjis-output-file

Related Concepts    Character set encoding

Other Library Functions    Big5-input-file    Big5-output-file    euc-input-file    euc-output-file    input-file    jis-input-file    jis-output-file    output-file    sjis-input-file    sjis-output-file    utf16-input-file    utf16-output-file

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]