ucd

README

go-ucd

Go libraries and utilities for working with Unicode character data.

Example

package main

import(
	"fmt"
	"flag"
	ucd "github.com/cooperhewitt/go-ucd"
)

func main(){

     flag.Parse()
     char := flag.Arg(0)

     name := ucd.Name(char)
     fmt.Println(name)
}

Tools

The following tools are included in the cmd directory. Note however that you will need to compile them yourself. You can do this (and all the steps in-between using the handy Makefile and the build target included in this repository. Like this:

$> export GOPATH=`pwd`
$> make build

This will build the ucd and ucd-server applications and place them in the bin directory.

ucd

$> bin/ucd A
LATIN CAPITAL LETTER A

$> ucd THIS → WAY
LATIN CAPITAL LETTER T
LATIN CAPITAL LETTER H
LATIN CAPITAL LETTER I
LATIN CAPITAL LETTER S
SPACE
RIGHTWARDS ARROW
SPACE
LATIN CAPITAL LETTER W
LATIN CAPITAL LETTER A
LATIN CAPITAL LETTER Y

ucd supports the Unicode Han Data character set, or at least endeavours to. There may still be bugs.

$> bin/ucd 䍕
NET; WEB; NETWORK, NET FOR CATCHING RABBIT

ucd-server

Usage

$> bin/ucd-server --help
Usage of ./ucd-server:
  -host="localhost": host
  -port=8080: port

Install as a service

To install as an init.d script, copy the example provided, replace the values of UCD_USER, UCD_DAEMON and UCD_PORT, and start the service.

    $> sudo cp init.d/ucd-server.sh.example /etc/init.d/ucd-server.sh
    $> sudo service ucd-server start

If using cooperhewitt-vagrant, and assuming you cloned this repository and compiled from /vagrant/go-ucd, you can use these values:

    UCD_USER=www-data
    UCD_DAEMON=/vagrant/go-ucd/bin/ucd-server
    UCD_PORT=3456

as JSON

$> curl -X GET -s 'http://localhost:8080/?text=♕%20HAT' | python -mjson.tool
{
    "Chars": [
        {
            "Char": "\u2655",
            "Hex": "2655",
            "Name": "WHITE CHESS QUEEN"
        },
        {
            "Char": " ",
            "Hex": "0020",
            "Name": "SPACE"
        },
        {
            "Char": "H",
            "Hex": "0048",
            "Name": "LATIN CAPITAL LETTER H"
        },
        {
            "Char": "A",
            "Hex": "0041",
            "Name": "LATIN CAPITAL LETTER A"
        },
        {
            "Char": "T",
            "Hex": "0054",
            "Name": "LATIN CAPITAL LETTER T"
        }
    ]
}

As plain text

$> curl -H 'Accept: text/plain' -s 'http://localhost:8080/?text=♕%20HAT%20WITH%20😸'
WHITE CHESS QUEEN
SPACE
LATIN CAPITAL LETTER H
LATIN CAPITAL LETTER A
LATIN CAPITAL LETTER T
SPACE
LATIN CAPITAL LETTER W
LATIN CAPITAL LETTER I
LATIN CAPITAL LETTER T
LATIN CAPITAL LETTER H
SPACE
GRINNING CAT FACE WITH SMILING EYES

Versions

go-ucd supports Unicode 12.0 as of March 05, 2019.

This package exports data defined in the UnicodeData.txt and the Unihan.zip. Both are available from http://unicode.org/Public/UCD/latest/ucd/. You can see the dates that each was last compiled in to the source code for ucd at the top of each source file in the data directory.

If the Unicode consortium releases newer data files and you want or need to updated your version of go-ucd before we do you do so manually by using the ucd-build-unicodedata and ucd-build-unihan tools included in the bin directory. For example:

go run ./cmd/ucd-build-unicodedata.go > ./unicodedata/unicodedata.go
go run ./cmd/ucd-build-unihan.go > ./unihan/unihan.go

Note: You will need to recompile your ucd and ucd-server binaries manually.

Shout outs

Many thanks to friend and Go-friend Richard Crowley who is always kind and patient answering my Go-related questions. Go is lovely but Go is weird.

See also

• http://unicode.org/Public/UCD/latest/ucd/
• http://www.washingtonpost.com/news/the-intersect/wp/2015/02/23/the-surprisingly-complex-reason-you-never-see-emoji-urls/
• https://modelviewculture.com/pieces/i-can-text-you-a-pile-of-poo-but-i-cant-write-my-name

Documentation

Index

• type UCDName
  • func Name(char string) (f UCDName)
  • func NamesForString(s string) (n []UCDName)
  • func (u UCDName) String() string

Types

type UCDName

type UCDName struct {
	Char string
	Hex  string
	Name string
}

func Name

func Name(char string) (f UCDName)

func NamesForString

func NamesForString(s string) (n []UCDName)

func (UCDName) String

func (u UCDName) String() string