runewidth

README

go-runewidth
============

[![Build Status](https://travis-ci.org/mattn/go-runewidth.png?branch=master)](https://travis-ci.org/mattn/go-runewidth)
[![Coverage Status](https://coveralls.io/repos/mattn/go-runewidth/badge.png?branch=HEAD)](https://coveralls.io/r/mattn/go-runewidth?branch=HEAD)
[![GoDoc](https://godoc.org/github.com/mattn/go-runewidth?status.svg)](http://godoc.org/github.com/mattn/go-runewidth)
[![Go Report Card](https://goreportcard.com/badge/github.com/mattn/go-runewidth)](https://goreportcard.com/report/github.com/mattn/go-runewidth)

Provides functions to get fixed width of the character or string.

Usage
-----

```go
runewidth.StringWidth("つのだ☆HIRO") == 12
```


Author
------

Yasuhiro Matsumoto

License
-------

under the MIT License: http://mattn.mit-license.org/2013

Documentation

Index

• Variables
• func FillLeft(s string, w int) string
• func FillRight(s string, w int) string
• func IsAmbiguousWidth(r rune) bool
• func IsEastAsian() bool
• func IsNeutralWidth(r rune) bool
• func RuneWidth(r rune) int
• func StringWidth(s string) (width int)
• func Truncate(s string, w int, tail string) string
• func Wrap(s string, w int) string
• type Condition
  • func NewCondition() *Condition
  • func (c *Condition) FillLeft(s string, w int) string
  • func (c *Condition) FillRight(s string, w int) string
  • func (c *Condition) RuneWidth(r rune) int
  • func (c *Condition) StringWidth(s string) (width int)
  • func (c *Condition) Truncate(s string, w int, tail string) string
  • func (c *Condition) Wrap(s string, w int) string

Variables

var (
	// EastAsianWidth will be set true if the current locale is CJK
	EastAsianWidth bool

	// ZeroWidthJoiner is flag to set to use UTR#51 ZWJ
	ZeroWidthJoiner bool

	// DefaultCondition is a condition in current locale
	DefaultCondition = &Condition{}
)

Functions

func FillLeft

func FillLeft(s string, w int) string

FillLeft return string filled in left by spaces in w cells

func FillRight

func FillRight(s string, w int) string

FillRight return string filled in left by spaces in w cells

func IsAmbiguousWidth

func IsAmbiguousWidth(r rune) bool

IsAmbiguousWidth returns whether is ambiguous width or not.

func IsEastAsian

func IsEastAsian() bool

IsEastAsian return true if the current locale is CJK

func IsNeutralWidth

func IsNeutralWidth(r rune) bool

IsNeutralWidth returns whether is neutral width or not.

func RuneWidth

func RuneWidth(r rune) int

RuneWidth returns the number of cells in r. See http://www.unicode.org/reports/tr11/

func StringWidth

func StringWidth(s string) (width int)

StringWidth return width as you can see

func Truncate

func Truncate(s string, w int, tail string) string

Truncate return string truncated with w cells

func Wrap

func Wrap(s string, w int) string

Wrap return string wrapped with w cells

Types

type Condition

type Condition struct {
	EastAsianWidth  bool
	ZeroWidthJoiner bool
}

Condition have flag EastAsianWidth whether the current locale is CJK or not.

func NewCondition

func NewCondition() *Condition

NewCondition return new instance of Condition which is current locale.

func (*Condition) FillLeft

func (c *Condition) FillLeft(s string, w int) string

FillLeft return string filled in left by spaces in w cells

func (*Condition) FillRight

func (c *Condition) FillRight(s string, w int) string

FillRight return string filled in left by spaces in w cells

func (*Condition) RuneWidth

func (c *Condition) RuneWidth(r rune) int

RuneWidth returns the number of cells in r. See http://www.unicode.org/reports/tr11/

func (*Condition) StringWidth

func (c *Condition) StringWidth(s string) (width int)

StringWidth return width as you can see

func (*Condition) Truncate

func (c *Condition) Truncate(s string, w int, tail string) string

Truncate return string truncated with w cells

func (*Condition) Wrap

func (c *Condition) Wrap(s string, w int) string

Wrap return string wrapped with w cells