valki/dockerized_openAger

Fork 0

valki 664c6d8ca3 Intial Commit

2020-10-17 18:42:50 +02:00

12 KiB

Raw Permalink Blame History

encoding.js

Converts character encoding in JavaScript.
JavaScript で文字コード変換をします

Installation

In Browser:

<script src="encoding.js"></script>

<script src="encoding.min.js"></script>

Encoding というオブジェクトがグローバルに定義されます

配列に対して変換または判別します

In Node.js:

encoding-japanese というモジュール名になっています

npm install encoding-japanese

var encoding = require('encoding-japanese');

encoding.js の各メソッドは Node.js の Buffer に対しても使えます

bower:

bower install encoding-japanese

CDN

cdnjs.com でCDNが利用できます。

文字コード変換 (convert):

{Array.<number>|string} Encoding.convert ( data, to_encoding [, from_encoding ] )
文字コードを変換します
@param {Array.<number>|TypedArray|Buffer|string} data 対象のデータ
@param {(string|Object)} to_encoding 変換先の文字コード
@param {(string|Array.<string>)=} [from_encoding] 変換元の文字コード or 'AUTO'
@return {Array|string} 変換した配列または(文字列を渡した場合)文字列が返ります

// UTF-8のデータをShift_JISに変換
var utf8Array = new Uint8Array(...) or [...] or Array(...) or Buffer(...);
var sjisArray = Encoding.convert(utf8Array, 'SJIS', 'UTF8');

// 自動判別で変換 (AUTO detect)
var sjisArray = Encoding.convert(utf8Array, 'SJIS');
// or  
var sjisArray = Encoding.convert(utf8Array, 'SJIS', 'AUTO');

// 文字コード判別 (戻り値は下の"Available Encodings"のいずれか)
var detected = Encoding.detect(utf8Array);
if (detected === 'UTF8') {
  console.log('Encoding is UTF-8');
}

Available Encodings:

'UTF32' (detect only)
'UTF16'
'UTF16BE'
'UTF16LE'
'BINARY' (detect only)
'ASCII' (detect only)
'JIS'
'UTF8'
'EUCJP'
'SJIS'
'UNICODE' (JavaScript Unicode Array)

※ UNICODE は JavaScript の String.charCodeAt() の値を持つ配列です
　　(配列の各値は 256 を超える数値になり得ます)

引数に Object を指定する

var sjisArray = Encoding.convert(utf8Array, {
  to: 'SJIS', // to_encoding
  from: 'UTF8' // from_encoding
});

第二引数にオブジェクトで渡すことで可読性が上がります

'type' オプションで文字列を指定し、文字列を直接渡す

var utf8String = 'ã\u0081\u0093ã\u0082\u0093ã\u0081«ã\u0081¡ã\u0081¯';
var unicodeString = Encoding.convert(utf8String, {
  to: 'UNICODE',
  from: 'UTF8',
  type: 'string' // 文字列 'string' を指定 (string で返ります)
});
console.log(unicodeString); // こんにちは

'type' オプションは以下が利用可能です:

'string': 文字列として返ります
'arraybuffer': ArrayBuffer として返ります
'array': Array として返ります (デフォルト)

UTF16 に BOM をつける

UTF16 に変換する際に bom オプションを指定すると BOM が付加できます

var utf16Array = Encoding.convert(utf8Array, {
  to: 'UTF16', // to_encoding
  from: 'UTF8', // from_encoding
  bom: true // BOMをつける
});

UTF16 のバイトオーダーはデフォルトで big-endian になります

little-endian として変換したい場合は bom オプションに 'LE' を指定します

var utf16leArray = Encoding.convert(utf8Array, {
  to: 'UTF16', // to_encoding
  from: 'UTF8', // from_encoding
  bom: 'LE' // BOM (little-endian) をつける
});

BOM が不要な場合は UTF16LE または UTF16BE を使用します

var utf16beArray = Encoding.convert(utf8Array, {
  to: 'UTF16BE',
  from: 'UTF8'
});

※ UTF16, UTF16BE, UTF16LE は、JavaScript の内部コードではなく各バイトを持つ配列です

文字コード検出 (detect):

{string|boolean} Encoding.detect ( data [, encodings ] )
文字コードを検出します
@param {Array.<number>|TypedArray|string} data 対象のデータ
@param {(string|Array.<string>)} [encodings] 検出を絞り込む際の文字コード
@return {string|boolean} 検出された文字コード、または false が返ります

// 自動判別 (AUTO detect)
var detected = Encoding.detect(utf8Array);
if (detected === 'UTF8') {
  console.log('Encoding is UTF-8');
}

// 文字コード指定判別
var isSJIS = Encoding.detect(sjisArray, 'SJIS');
if (isSJIS) {
  console.log('Encoding is SJIS');
}

URL Encode/Decode:

{string} Encoding.urlEncode ( data )
URL(percent) エンコードします
@param {Array.<number>|TypedArray} data 対象のデータ
@return {string} エンコードされた文字列が返ります
{Array.<number>} Encoding.urlDecode ( string )
URL(percent) デコードします
@param {string} string 対象の文字列
@return {Array.<number>} デコードされた文字コード配列が返ります

// 文字コードの配列をURLエンコード/デコード
var sjisArray = [
  130, 177, 130, 241, 130, 201, 130, 191, 130, 205, 129,
  65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230
];

var encoded = Encoding.urlEncode(sjisArray);
console.log(encoded);
// output:
// '%82%B1%82%F1%82%C9%82%BF%82%CD%81A%82%D9%82%B0%81%99%82%D2%82%E6'

var decoded = Encoding.urlDecode(encoded);
console.log(decoded);
// output: [
//   130, 177, 130, 241, 130, 201, 130, 191, 130, 205, 129,
//    65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230
// ]

Base64 Encode/Decode:

{string} Encoding.base64Encode ( data )
Base64エンコードします
@param {Array.<number>|TypedArray} data 対象のデータ
@return {string} Base64エンコードされた文字列が返ります
{Array.<number>} Encoding.base64Decode ( string )
Base64デコードします
@param {string} string 対象のデータ
@return {Array.<number>} Base64デコードされた文字コード配列が返ります

var sjisArray = [
  130, 177, 130, 241, 130, 201, 130, 191, 130, 205
];
var encoded = Encoding.base64Encode(sjisArray);
console.log(encoded); // 'grGC8YLJgr+CzQ=='

var decoded = Encoding.base64Decode(encoded);
console.log(decoded);
// [130, 177, 130, 241, 130, 201, 130, 191, 130, 205]

Example:

XMLHttpRequest と Typed arrays (Uint8Array) を使用した例:

このサンプルでは Shift_JIS で書かれたテキストファイルをバイナリデータとして読み込み、Encoding.convert によって Unicode に変換して表示します

var req = new XMLHttpRequest();
req.open('GET', '/my-shift_jis.txt', true);
req.responseType = 'arraybuffer';

req.onload = function (event) {
  var buffer = req.response;
  if (buffer) {
    // Shift_JIS Array
    var sjisArray = new Uint8Array(buffer);

    // Convert encoding to UNICODE (JavaScript Unicode Array).
    var unicodeArray = Encoding.convert(sjisArray, {
      to: 'UNICODE',
      from: 'SJIS'
    });

    // Join to string.
    var unicodeString = Encoding.codeToString(unicodeArray);
    console.log(unicodeString);
  }
};

req.send(null);

File API を使用したファイルの文字コード検出・変換例:

File API を使用してファイルを読み込みます。
その際にファイルの文字コードを検出し、正しく表示されるようUnicodeに変換して表示します。

<input type="file" id="file">
<div id="encoding"></div>
<textarea id="result" rows="5" cols="80"></textarea>

<script>
function onFileSelect(event) {
  var file = event.target.files[0];

  var reader = new FileReader();
  reader.onload = function(e) {
    var codes = new Uint8Array(e.target.result);
    var encoding = Encoding.detect(codes);
    document.getElementById('encoding').textContent = encoding;

    // Convert encoding to unicode
    var unicodeString = Encoding.convert(codes, {
      to: 'unicode',
      from: encoding,
      type: 'string'
    });
    document.getElementById('result').value = unicodeString;
  };

  reader.readAsArrayBuffer(file);
}

document.getElementById('file').addEventListener('change', onFileSelect, false);
</script>

この例のデモ

文字コード変換例:

var eucjpArray = [
  164, 179, 164, 243, 164, 203, 164, 193, 164, 207, 161,
  162, 164, 219, 164, 178, 161, 249, 164, 212, 164, 232
];

var utf8Array = Encoding.convert(eucjpArray, {
  to: 'UTF8',
  from: 'EUCJP'
});
console.log( utf8Array );
// output: [
//   227, 129, 147, 227, 130, 147, 227, 129, 171,
//   227, 129, 161, 227, 129, 175, 227, 128, 129,
//   227, 129, 187, 227, 129, 146, 226, 152, 134,
//   227, 129, 180, 227, 130, 136
// ]
//   => 'こんにちは、ほげ☆ぴよ'

文字コード自動検出での変換例 (Auto detect):

var sjisArray = [
  130, 177, 130, 241, 130, 201, 130, 191, 130, 205, 129,
   65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230
];
var unicodeArray = Encoding.convert(sjisArray, {
  to: 'UNICODE',
  from: 'AUTO'
});
// codeToStringは文字コード配列を文字列に変換(連結)して返します
console.log( Encoding.codeToString(unicodeArray) );
// output: 'こんにちは、ほげ☆ぴよ'

Utilities

{string} Encoding.codeToString ( {Array.<number>|TypedArray} data )
文字コード配列を文字列に変換(連結)して返します
{Array.<number>} Encoding.stringToCode ( {string} string )
文字列を文字コード配列に分割して返します

全角/半角変換

以下のメソッドは Unicode 文字または Unicode 文字コード配列に対して使用できます

{Array.<number>|string} Encoding.toHankakuCase ( {Array.<number>|string} data )
全角英数記号文字を半角英数記号文字に変換
{Array.<number>|string} Encoding.toZenkakuCase ( {Array.<number>|string} data )
半角英数記号文字を全角英数記号文字に変換
{Array.<number>|string} Encoding.toHiraganaCase ( {Array.<number>|string} data )
全角カタカナを全角ひらがなに変換
{Array.<number>|string} Encoding.toKatakanaCase ( {Array.<number>|string} data )
全角ひらがなを全角カタカナに変換
{Array.<number>|string} Encoding.toHankanaCase ( {Array.<number>|string} data )
全角カタカナを半角ｶﾀｶﾅに変換
{Array.<number>|string} Encoding.toZenkanaCase ( {Array.<number>|string} data )
半角ｶﾀｶﾅを全角カタカナに変換
{Array.<number>|string} Encoding.toHankakuSpace ({Array.<number>|string} data )
全角スペース(U+3000)を半角スペース(U+0020)に変換
{Array.<number>|string} Encoding.toZenkakuSpace ( {Array.<number>|string} data )
半角スペース(U+0020)を全角スペース(U+3000)に変換

Demo

貢献

pull request または issues を歓迎します。

pull request の際は、 npm run test を実行してエラーがないことを確認してください。

License

MIT

12 KiB Raw Permalink Blame History Unescape Escape