├── .gitignore ├── LICENSE ├── Readme.md ├── combining.js ├── docs └── index.md ├── index.js ├── package.json └── test └── index.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | wcwidth.js: JavaScript Portng of Markus Kuhn's wcwidth() Implementation 2 | ======================================================================= 3 | 4 | Copyright (C) 2012 by Jun Woong. 5 | 6 | This package is a JavaScript porting of `wcwidth()` implementation 7 | [by Markus Kuhn](http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c). 8 | 9 | Permission is hereby granted, free of charge, to any person obtaining a copy of 10 | this software and associated documentation files (the "Software"), to deal in 11 | the Software without restriction, including without limitation the rights to 12 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 13 | of the Software, and to permit persons to whom the Software is furnished to do 14 | so, subject to the following conditions: 15 | 16 | The above copyright notice and this permission notice shall be included in all 17 | copies or substantial portions of the Software. 18 | 19 | 20 | THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 21 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 22 | FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR 23 | OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 24 | EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 25 | PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 26 | BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 27 | IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 | POSSIBILITY OF SUCH DAMAGE. 30 | 31 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # wcwidth 2 | 3 | Determine columns needed for a fixed-size wide-character string 4 | 5 | ---- 6 | 7 | wcwidth is a simple JavaScript port of [wcwidth](http://man7.org/linux/man-pages/man3/wcswidth.3.html) implemented in C by Markus Kuhn. 8 | 9 | JavaScript port [originally](https://github.com/mycoboco/wcwidth.js) written by Woong Jun (http://code.woong.org/) 10 | 11 | ## Example 12 | 13 | ```js 14 | '한'.length // => 1 15 | wcwidth('한'); // => 2 16 | 17 | '한글'.length // => 2 18 | wcwidth('한글'); // => 4 19 | ``` 20 | 21 | `wcwidth()` and its string version, `wcswidth()` are defined by IEEE Std 22 | 1002.1-2001, a.k.a. POSIX.1-2001, and return the number of columns used 23 | to represent the given wide character and string. 24 | 25 | Markus's implementation assumes the wide character given to those 26 | functions to be encoded in ISO 10646, which is almost true for 27 | JavaScript's characters. 28 | 29 | [Further explaination here](docs) 30 | 31 | ## License 32 | 33 | MIT 34 | -------------------------------------------------------------------------------- /combining.js: -------------------------------------------------------------------------------- 1 | module.exports = [ 2 | [ 0x0300, 0x036F ], [ 0x0483, 0x0486 ], [ 0x0488, 0x0489 ], 3 | [ 0x0591, 0x05BD ], [ 0x05BF, 0x05BF ], [ 0x05C1, 0x05C2 ], 4 | [ 0x05C4, 0x05C5 ], [ 0x05C7, 0x05C7 ], [ 0x0600, 0x0603 ], 5 | [ 0x0610, 0x0615 ], [ 0x064B, 0x065E ], [ 0x0670, 0x0670 ], 6 | [ 0x06D6, 0x06E4 ], [ 0x06E7, 0x06E8 ], [ 0x06EA, 0x06ED ], 7 | [ 0x070F, 0x070F ], [ 0x0711, 0x0711 ], [ 0x0730, 0x074A ], 8 | [ 0x07A6, 0x07B0 ], [ 0x07EB, 0x07F3 ], [ 0x0901, 0x0902 ], 9 | [ 0x093C, 0x093C ], [ 0x0941, 0x0948 ], [ 0x094D, 0x094D ], 10 | [ 0x0951, 0x0954 ], [ 0x0962, 0x0963 ], [ 0x0981, 0x0981 ], 11 | [ 0x09BC, 0x09BC ], [ 0x09C1, 0x09C4 ], [ 0x09CD, 0x09CD ], 12 | [ 0x09E2, 0x09E3 ], [ 0x0A01, 0x0A02 ], [ 0x0A3C, 0x0A3C ], 13 | [ 0x0A41, 0x0A42 ], [ 0x0A47, 0x0A48 ], [ 0x0A4B, 0x0A4D ], 14 | [ 0x0A70, 0x0A71 ], [ 0x0A81, 0x0A82 ], [ 0x0ABC, 0x0ABC ], 15 | [ 0x0AC1, 0x0AC5 ], [ 0x0AC7, 0x0AC8 ], [ 0x0ACD, 0x0ACD ], 16 | [ 0x0AE2, 0x0AE3 ], [ 0x0B01, 0x0B01 ], [ 0x0B3C, 0x0B3C ], 17 | [ 0x0B3F, 0x0B3F ], [ 0x0B41, 0x0B43 ], [ 0x0B4D, 0x0B4D ], 18 | [ 0x0B56, 0x0B56 ], [ 0x0B82, 0x0B82 ], [ 0x0BC0, 0x0BC0 ], 19 | [ 0x0BCD, 0x0BCD ], [ 0x0C3E, 0x0C40 ], [ 0x0C46, 0x0C48 ], 20 | [ 0x0C4A, 0x0C4D ], [ 0x0C55, 0x0C56 ], [ 0x0CBC, 0x0CBC ], 21 | [ 0x0CBF, 0x0CBF ], [ 0x0CC6, 0x0CC6 ], [ 0x0CCC, 0x0CCD ], 22 | [ 0x0CE2, 0x0CE3 ], [ 0x0D41, 0x0D43 ], [ 0x0D4D, 0x0D4D ], 23 | [ 0x0DCA, 0x0DCA ], [ 0x0DD2, 0x0DD4 ], [ 0x0DD6, 0x0DD6 ], 24 | [ 0x0E31, 0x0E31 ], [ 0x0E34, 0x0E3A ], [ 0x0E47, 0x0E4E ], 25 | [ 0x0EB1, 0x0EB1 ], [ 0x0EB4, 0x0EB9 ], [ 0x0EBB, 0x0EBC ], 26 | [ 0x0EC8, 0x0ECD ], [ 0x0F18, 0x0F19 ], [ 0x0F35, 0x0F35 ], 27 | [ 0x0F37, 0x0F37 ], [ 0x0F39, 0x0F39 ], [ 0x0F71, 0x0F7E ], 28 | [ 0x0F80, 0x0F84 ], [ 0x0F86, 0x0F87 ], [ 0x0F90, 0x0F97 ], 29 | [ 0x0F99, 0x0FBC ], [ 0x0FC6, 0x0FC6 ], [ 0x102D, 0x1030 ], 30 | [ 0x1032, 0x1032 ], [ 0x1036, 0x1037 ], [ 0x1039, 0x1039 ], 31 | [ 0x1058, 0x1059 ], [ 0x1160, 0x11FF ], [ 0x135F, 0x135F ], 32 | [ 0x1712, 0x1714 ], [ 0x1732, 0x1734 ], [ 0x1752, 0x1753 ], 33 | [ 0x1772, 0x1773 ], [ 0x17B4, 0x17B5 ], [ 0x17B7, 0x17BD ], 34 | [ 0x17C6, 0x17C6 ], [ 0x17C9, 0x17D3 ], [ 0x17DD, 0x17DD ], 35 | [ 0x180B, 0x180D ], [ 0x18A9, 0x18A9 ], [ 0x1920, 0x1922 ], 36 | [ 0x1927, 0x1928 ], [ 0x1932, 0x1932 ], [ 0x1939, 0x193B ], 37 | [ 0x1A17, 0x1A18 ], [ 0x1B00, 0x1B03 ], [ 0x1B34, 0x1B34 ], 38 | [ 0x1B36, 0x1B3A ], [ 0x1B3C, 0x1B3C ], [ 0x1B42, 0x1B42 ], 39 | [ 0x1B6B, 0x1B73 ], [ 0x1DC0, 0x1DCA ], [ 0x1DFE, 0x1DFF ], 40 | [ 0x200B, 0x200F ], [ 0x202A, 0x202E ], [ 0x2060, 0x2063 ], 41 | [ 0x206A, 0x206F ], [ 0x20D0, 0x20EF ], [ 0x302A, 0x302F ], 42 | [ 0x3099, 0x309A ], [ 0xA806, 0xA806 ], [ 0xA80B, 0xA80B ], 43 | [ 0xA825, 0xA826 ], [ 0xFB1E, 0xFB1E ], [ 0xFE00, 0xFE0F ], 44 | [ 0xFE20, 0xFE23 ], [ 0xFEFF, 0xFEFF ], [ 0xFFF9, 0xFFFB ], 45 | [ 0x10A01, 0x10A03 ], [ 0x10A05, 0x10A06 ], [ 0x10A0C, 0x10A0F ], 46 | [ 0x10A38, 0x10A3A ], [ 0x10A3F, 0x10A3F ], [ 0x1D167, 0x1D169 ], 47 | [ 0x1D173, 0x1D182 ], [ 0x1D185, 0x1D18B ], [ 0x1D1AA, 0x1D1AD ], 48 | [ 0x1D242, 0x1D244 ], [ 0xE0001, 0xE0001 ], [ 0xE0020, 0xE007F ], 49 | [ 0xE0100, 0xE01EF ] 50 | ] 51 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | ### Javascript porting of Markus Kuhn's wcwidth() implementation 2 | 3 | The following explanation comes from the original C implementation: 4 | 5 | This is an implementation of wcwidth() and wcswidth() (defined in 6 | IEEE Std 1002.1-2001) for Unicode. 7 | 8 | http://www.opengroup.org/onlinepubs/007904975/functions/wcwidth.html 9 | http://www.opengroup.org/onlinepubs/007904975/functions/wcswidth.html 10 | 11 | In fixed-width output devices, Latin characters all occupy a single 12 | "cell" position of equal width, whereas ideographic CJK characters 13 | occupy two such cells. Interoperability between terminal-line 14 | applications and (teletype-style) character terminals using the 15 | UTF-8 encoding requires agreement on which character should advance 16 | the cursor by how many cell positions. No established formal 17 | standards exist at present on which Unicode character shall occupy 18 | how many cell positions on character terminals. These routines are 19 | a first attempt of defining such behavior based on simple rules 20 | applied to data provided by the Unicode Consortium. 21 | 22 | For some graphical characters, the Unicode standard explicitly 23 | defines a character-cell width via the definition of the East Asian 24 | FullWidth (F), Wide (W), Half-width (H), and Narrow (Na) classes. 25 | In all these cases, there is no ambiguity about which width a 26 | terminal shall use. For characters in the East Asian Ambiguous (A) 27 | class, the width choice depends purely on a preference of backward 28 | compatibility with either historic CJK or Western practice. 29 | Choosing single-width for these characters is easy to justify as 30 | the appropriate long-term solution, as the CJK practice of 31 | displaying these characters as double-width comes from historic 32 | implementation simplicity (8-bit encoded characters were displayed 33 | single-width and 16-bit ones double-width, even for Greek, 34 | Cyrillic, etc.) and not any typographic considerations. 35 | 36 | Much less clear is the choice of width for the Not East Asian 37 | (Neutral) class. Existing practice does not dictate a width for any 38 | of these characters. It would nevertheless make sense 39 | typographically to allocate two character cells to characters such 40 | as for instance EM SPACE or VOLUME INTEGRAL, which cannot be 41 | represented adequately with a single-width glyph. The following 42 | routines at present merely assign a single-cell width to all 43 | neutral characters, in the interest of simplicity. This is not 44 | entirely satisfactory and should be reconsidered before 45 | establishing a formal standard in this area. At the moment, the 46 | decision which Not East Asian (Neutral) characters should be 47 | represented by double-width glyphs cannot yet be answered by 48 | applying a simple rule from the Unicode database content. Setting 49 | up a proper standard for the behavior of UTF-8 character terminals 50 | will require a careful analysis not only of each Unicode character, 51 | but also of each presentation form, something the author of these 52 | routines has avoided to do so far. 53 | 54 | http://www.unicode.org/unicode/reports/tr11/ 55 | 56 | Markus Kuhn -- 2007-05-26 (Unicode 5.0) 57 | 58 | Permission to use, copy, modify, and distribute this software 59 | for any purpose and without fee is hereby granted. The author 60 | disclaims all warranties with regard to this software. 61 | 62 | Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | "use strict" 2 | 3 | var defaults = require('defaults') 4 | var combining = require('./combining') 5 | 6 | var DEFAULTS = { 7 | nul: 0, 8 | control: 0 9 | } 10 | 11 | module.exports = function wcwidth(str) { 12 | return wcswidth(str, DEFAULTS) 13 | } 14 | 15 | module.exports.config = function(opts) { 16 | opts = defaults(opts || {}, DEFAULTS) 17 | return function wcwidth(str) { 18 | return wcswidth(str, opts) 19 | } 20 | } 21 | 22 | /* 23 | * The following functions define the column width of an ISO 10646 24 | * character as follows: 25 | * - The null character (U+0000) has a column width of 0. 26 | * - Other C0/C1 control characters and DEL will lead to a return value 27 | * of -1. 28 | * - Non-spacing and enclosing combining characters (general category 29 | * code Mn or Me in the 30 | * Unicode database) have a column width of 0. 31 | * - SOFT HYPHEN (U+00AD) has a column width of 1. 32 | * - Other format characters (general category code Cf in the Unicode 33 | * database) and ZERO WIDTH 34 | * SPACE (U+200B) have a column width of 0. 35 | * - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF) 36 | * have a column width of 0. 37 | * - Spacing characters in the East Asian Wide (W) or East Asian 38 | * Full-width (F) category as 39 | * defined in Unicode Technical Report #11 have a column width of 2. 40 | * - All remaining characters (including all printable ISO 8859-1 and 41 | * WGL4 characters, Unicode control characters, etc.) have a column 42 | * width of 1. 43 | * This implementation assumes that characters are encoded in ISO 10646. 44 | */ 45 | 46 | function wcswidth(str, opts) { 47 | if (typeof str !== 'string') return wcwidth(str, opts) 48 | 49 | var s = 0 50 | for (var i = 0; i < str.length; i++) { 51 | var n = wcwidth(str.charCodeAt(i), opts) 52 | if (n < 0) return -1 53 | s += n 54 | } 55 | 56 | return s 57 | } 58 | 59 | function wcwidth(ucs, opts) { 60 | // test for 8-bit control characters 61 | if (ucs === 0) return opts.nul 62 | if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0)) return opts.control 63 | 64 | // binary search in table of non-spacing characters 65 | if (bisearch(ucs)) return 0 66 | 67 | // if we arrive here, ucs is not a combining or C0/C1 control character 68 | return 1 + 69 | (ucs >= 0x1100 && 70 | (ucs <= 0x115f || // Hangul Jamo init. consonants 71 | ucs == 0x2329 || ucs == 0x232a || 72 | (ucs >= 0x2e80 && ucs <= 0xa4cf && 73 | ucs != 0x303f) || // CJK ... Yi 74 | (ucs >= 0xac00 && ucs <= 0xd7a3) || // Hangul Syllables 75 | (ucs >= 0xf900 && ucs <= 0xfaff) || // CJK Compatibility Ideographs 76 | (ucs >= 0xfe10 && ucs <= 0xfe19) || // Vertical forms 77 | (ucs >= 0xfe30 && ucs <= 0xfe6f) || // CJK Compatibility Forms 78 | (ucs >= 0xff00 && ucs <= 0xff60) || // Fullwidth Forms 79 | (ucs >= 0xffe0 && ucs <= 0xffe6) || 80 | (ucs >= 0x20000 && ucs <= 0x2fffd) || 81 | (ucs >= 0x30000 && ucs <= 0x3fffd))); 82 | } 83 | 84 | function bisearch(ucs) { 85 | var min = 0 86 | var max = combining.length - 1 87 | var mid 88 | 89 | if (ucs < combining[0][0] || ucs > combining[max][1]) return false 90 | 91 | while (max >= min) { 92 | mid = Math.floor((min + max) / 2) 93 | if (ucs > combining[mid][1]) min = mid + 1 94 | else if (ucs < combining[mid][0]) max = mid - 1 95 | else return true 96 | } 97 | 98 | return false 99 | } 100 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "wcwidth", 3 | "version": "1.0.1", 4 | "description": "Port of C's wcwidth() and wcswidth()", 5 | "author": "Tim Oxley", 6 | "contributors": [ 7 | "Woong Jun (http://code.woong.org/)" 8 | ], 9 | "main": "index.js", 10 | "dependencies": { 11 | "defaults": "^1.0.3" 12 | }, 13 | "devDependencies": { 14 | "tape": "^4.5.1" 15 | }, 16 | "license": "MIT", 17 | "keywords": [ 18 | "wide character", 19 | "wc", 20 | "wide character string", 21 | "wcs", 22 | "terminal", 23 | "width", 24 | "wcwidth", 25 | "wcswidth" 26 | ], 27 | "directories": { 28 | "doc": "docs", 29 | "test": "test" 30 | }, 31 | "scripts": { 32 | "test": "tape test/*.js" 33 | }, 34 | "repository": { 35 | "type": "git", 36 | "url": "git+https://github.com/timoxley/wcwidth.git" 37 | }, 38 | "bugs": { 39 | "url": "https://github.com/timoxley/wcwidth/issues" 40 | }, 41 | "homepage": "https://github.com/timoxley/wcwidth#readme" 42 | } 43 | -------------------------------------------------------------------------------- /test/index.js: -------------------------------------------------------------------------------- 1 | "use strict" 2 | 3 | var wcwidth = require('../') 4 | var test = require('tape') 5 | 6 | test('handles regular strings', function(t) { 7 | t.strictEqual(wcwidth('abc'), 3) 8 | t.end() 9 | }) 10 | 11 | test('handles multibyte strings', function(t) { 12 | t.strictEqual(wcwidth('字的模块'), 8) 13 | t.end() 14 | }) 15 | 16 | test('handles multibyte characters mixed with regular characters', function(t) { 17 | t.strictEqual(wcwidth('abc 字的模块'), 12) 18 | t.end() 19 | }) 20 | 21 | test('ignores control characters e.g. \\n', function(t) { 22 | t.strictEqual(wcwidth('abc\n字的模块\ndef'), 14) 23 | t.end() 24 | }) 25 | 26 | test('ignores bad input', function(t) { 27 | t.strictEqual(wcwidth(''), 0) 28 | t.strictEqual(wcwidth(3), 0) 29 | t.strictEqual(wcwidth({}), 0) 30 | t.strictEqual(wcwidth([]), 0) 31 | t.strictEqual(wcwidth(), 0) 32 | t.end() 33 | }) 34 | 35 | test('ignores nul (charcode 0)', function(t) { 36 | t.strictEqual(wcwidth(String.fromCharCode(0)), 0) 37 | t.end() 38 | }) 39 | 40 | test('ignores nul mixed with chars', function(t) { 41 | t.strictEqual(wcwidth('a' + String.fromCharCode(0) + '\n字的'), 5) 42 | t.end() 43 | }) 44 | 45 | test('can have custom value for nul', function(t) { 46 | t.strictEqual(wcwidth.config({ 47 | nul: 10 48 | })(String.fromCharCode(0) + 'a字的'), 15) 49 | t.end() 50 | }) 51 | 52 | test('can have custom control char value', function(t) { 53 | t.strictEqual(wcwidth.config({ 54 | control: 1 55 | })('abc\n字的模块\ndef'), 16) 56 | t.end() 57 | }) 58 | 59 | test('negative custom control chars == -1', function(t) { 60 | t.strictEqual(wcwidth.config({ 61 | control: -1 62 | })('abc\n字的模块\ndef'), -1) 63 | t.end() 64 | }) 65 | --------------------------------------------------------------------------------