sjis-decode.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2026 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <stdint.h>
 
// Shift-JIS -> UTF-8 decoding, the inverse of sjis-encode.h. It indexes the
// forward conversion table (sjis-table.h) directly, so unlike the lightweight
// encoders it pulls the whole table in. The host counterpart is
// support/sjis_conv.cc, which shares the same table and algorithm. Usable from
// both the host and the MIPS targets, so freestanding code (e.g. psyqo) can
// display the Shift-JIS titles it reads back from a memory card.
 
namespace Sjis {
 
// Decodes up to srcLen bytes of Shift-JIS into UTF-8. Writes at most dstSize
// bytes to dst (always NUL-terminating when dstSize > 0) and returns the number
// of bytes written, not counting the terminator. A 0x00 byte ends the input
// (it is never part of a Shift-JIS sequence, so this is safe and gives a
// C-string terminator for the space/NUL-padded 64-byte card title field).
// Bytes with no table mapping, and a lead byte with no trail byte, are skipped,
// matching the host decoder. Decoding stops cleanly if the next codepoint would
// not fit in the remaining buffer.
uint32_t sjisToUtf8(char* dst, uint32_t dstSize, const uint8_t* src, uint32_t srcLen);
 
}  // namespace Sjis