code-page-0.2: Windows code page library for Haskell

System.IO.CodePage

Description

Exports functions which adjust code pages on Windows, and do nothing on other operating systems.

Synopsis

# Adjusting CodePages

withCP65001 :: IO a -> IO a #

Sets the code page for an action to UTF-8 as necessary.

withCP1200 :: IO a -> IO a #

Sets the code page for an action to UTF-16LE as necessary.

withCP1201 :: IO a -> IO a #

Sets the code page for an action to UTF-16BE as necessary.

withCP12000 :: IO a -> IO a #

Sets the code page for an action to UTF-32LE as necessary.

withCP12001 :: IO a -> IO a #

Sets the code page for an action to UTF-32BE as necessary.

withCP1252 :: IO a -> IO a #

Sets the code page for an action to Latin1 as necessary.

withCodePage :: CodePage -> IO a -> IO a #

Sets the code page for an action as necessary.

On operating systems besides Windows, this will make an effort to change the current TextEncoding to something that is equivalent to the supplied CodePage. Currently, the only supported CodePages on non-Windows OSes are cp65001, cp1200, cp1201, cp12000, and cp12001. Supplying any other CodePage will result in a runtime error on non-Windows OSes. (If you would like to configure this behavior, use withCodePageOptions instead.)

withCodePageOptions :: Options -> CodePage -> IO a -> IO a #

Sets the code page for an action as necessary. If the Bool argument is True, this function will emit a warning to stderr indicating that the code page has been changed. (withCodePage sets this argument to False.)

# Notable CodePages

type CodePage = Word32 #

A numeric type representing Windows code pages.

The UTF-8 code page.

The UTF-16LE code page.

The UTF-16BE code page.

The UTF-32LE code page.

The UTF-32BE code page.

The Latin1 code page.

# Options

data Options #

Options that specify how withCodePage and friends should work.

The default Options:

Options
{ chatty = False
, nonWindowsBehavior =
nonWindowsFallbackCodePageEncoding defaultFallbackCodePageEncoding
}


## Record fields of Options

If True, emit a warning to stderr indicating that the code page has been changed. If False, don't emit any warnings.

Configures how withCodePage and friends should work on non-Windows operating systems.

## NonWindowsBehavior

Specifies how withCodePage and friends should work on operating systems other than Windows.

## Constructing NonWindowsBehavior

Don't do anything at all on non-Windows OSes.

On non-Windows OSes, change the TextEncoding by converting the CodePage argument to a TextEncoding using the supplied function.

Provides a best-effort attempt to convert a CodePage to a TextEncoding on non-Windows OSes. Errors if given a CodePage that it doesn't know how to convert.