Data.Text.Encoding.MsJIS

The CdText standard technically allows for data encoded as Shift JIS; I am unaware of any discs produced with such data as no member of the libcdio-dev mailing list (or any of the very few other resources) have Japanese imports, but for completion the ability to read that encoding is required. This module provides a light-weight implementation modeled on the Data.Text.Encoding UTF-8 interface.

Types

data JISChar

The characters which may be represented under the Shift JIS encoding. Note that this type is only exposed as part of error reporting or recovery functions, and is not intended as a replacement of Char.

Constructors

Single Word8

Double Word8 Word8

Instances

Bounded JISChar

Defined in Data.Text.Encoding.MsJIS

Methods

minBound :: JISChar

maxBound :: JISChar

Enum JISChar

Ignores the three invalid single-byte characters "xFDxFExFF", and any double-byte characters outside the primary range ([0x81..0x9F]++[0xE0..0xFC], [0x40..0xFC]). fromEnum any such "invalid" characters will overlap with the canonical characters, and the result should not be relied upon to remain consistent between versions.

>>> succ $ Single 0xFC
Double 0x81 0x40

>>> succ $ Double 0x9F 0xFC
Double 0xE0 0x40

Defined in Data.Text.Encoding.MsJIS

Methods

succ :: JISChar -> JISChar

pred :: JISChar -> JISChar

toEnum :: Int -> JISChar

fromEnum :: JISChar -> Int

enumFrom :: JISChar -> [JISChar]

enumFromThen :: JISChar -> JISChar -> [JISChar]

enumFromTo :: JISChar -> JISChar -> [JISChar]

enumFromThenTo :: JISChar -> JISChar -> JISChar -> [JISChar]

Eq JISChar

Defined in Data.Text.Encoding.MsJIS

Methods

(==) :: JISChar -> JISChar -> Bool

(/=) :: JISChar -> JISChar -> Bool

Ord JISChar

Defined in Data.Text.Encoding.MsJIS

Methods

compare :: JISChar -> JISChar -> Ordering

(<) :: JISChar -> JISChar -> Bool

(<=) :: JISChar -> JISChar -> Bool

(>) :: JISChar -> JISChar -> Bool

(>=) :: JISChar -> JISChar -> Bool

max :: JISChar -> JISChar -> JISChar

min :: JISChar -> JISChar -> JISChar

Read JISChar

Defined in Data.Text.Encoding.MsJIS

Methods

readsPrec :: Int -> ReadS JISChar

readList :: ReadS [JISChar]

readPrec :: ReadPrec JISChar

readListPrec :: ReadPrec [JISChar]

Show JISChar

Defined in Data.Text.Encoding.MsJIS

Methods

showsPrec :: Int -> JISChar -> ShowS

show :: JISChar -> String

showList :: [JISChar] -> ShowS

data JISDecodeError

The given one- or two- byte sequence was unable to be decoded; the error may be described by the unstructured text.

Constructors

JISDecodeError String (Maybe JISChar)

Instances

Eq JISDecodeError

Defined in Data.Text.Encoding.MsJIS

Methods

(==) :: JISDecodeError -> JISDecodeError -> Bool

(/=) :: JISDecodeError -> JISDecodeError -> Bool

Read JISDecodeError

Defined in Data.Text.Encoding.MsJIS

Methods

readsPrec :: Int -> ReadS JISDecodeError

readList :: ReadS [JISDecodeError]

readPrec :: ReadPrec JISDecodeError

readListPrec :: ReadPrec [JISDecodeError]

Show JISDecodeError

Defined in Data.Text.Encoding.MsJIS

Methods

showsPrec :: Int -> JISDecodeError -> ShowS

show :: JISDecodeError -> String

showList :: [JISDecodeError] -> ShowS

data JISEncodeError

The given character was unable to be serialized in binary form; this is almost certainly due to it not being included in Shift JIS, but the error is described by the unstructured text anyway.

Constructors

JISEncodeError String (Maybe Char)

Instances

Eq JISEncodeError

Defined in Data.Text.Encoding.MsJIS

Methods

(==) :: JISEncodeError -> JISEncodeError -> Bool

(/=) :: JISEncodeError -> JISEncodeError -> Bool

Read JISEncodeError

Defined in Data.Text.Encoding.MsJIS

Methods

readsPrec :: Int -> ReadS JISEncodeError

readList :: ReadS [JISEncodeError]

readPrec :: ReadPrec JISEncodeError

readListPrec :: ReadPrec [JISEncodeError]

Show JISEncodeError

Defined in Data.Text.Encoding.MsJIS

Methods

showsPrec :: Int -> JISEncodeError -> ShowS

show :: JISEncodeError -> String

showList :: [JISEncodeError] -> ShowS

Transformations

Decode

decodeMsJIS' :: ByteString -> Either JISDecodeError Text

Transform a ByteString into unambiguous Chars according to Microsoft's extension of the Shift JIS encoding scheme.

If the input contains any invalid sequences under that scheme, the first byte(s) which triggered an error will be returned instead.

decodeMsJISWith :: OnError JISChar Char -> ByteString -> Text

Transform a ByteString into unambiguous Chars according to Microsoft's extension of the Shift JIS encoding scheme.

Encode

encodeMsJIS' :: Text -> Either JISEncodeError ByteString

Transform an unambiguous string into a binary stream according to Microsoft's extension of the Shift JIS encoding scheme.

If the input contains any characters without an associated binary sequence under that scheme, the first such character which triggers the error will be returned instead.

encodeMsJISWith :: OnError Char ByteString -> Text -> ByteString

Transform an unambiguous string into a binary stream according to Microsoft's extension of the Shift JIS encoding scheme.