https://github.com/composewell/unicode-data

Access unicode character database
https://github.com/composewell/unicode-data

haskell streamly unicode

Last synced: 25 days ago
JSON representation

Access unicode character database

• Host: GitHub
• URL: https://github.com/composewell/unicode-data
• Owner: composewell
• License: apache-2.0
• Created: 2020-05-19T14:00:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-29T12:36:39.000Z (11 months ago)
• Last Synced: 2024-04-25T23:02:16.096Z (6 months ago)
• Topics: haskell, streamly, unicode
• Language: Haskell
• Homepage:
• Size: 5.99 MB
• Stars: 17
• Watchers: 6
• Forks: 5
• Open Issues: 18
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README

## The `unicode-data` packages family

This repository provides packages to use the

[Unicode character database](https://www.unicode.org/ucd/) (UCD):

- [`unicode-data`](#unicode-data) for general character properties.

- [`unicode-data-names`](#unicode-data-names) for characters names and aliases.

- [`unicode-data-scripts`](#unicode-data-scripts) for characters scripts.

- [`unicode-data-security`](#unicode-data-security) for security mechanisms.

The Haskell data structures are generated programmatically from the UCD files.

The latest Unicode version supported by these libraries is

[`15.1.0`](https://www.unicode.org/versions/Unicode15.1.0/).

### `unicode-data`

[`unicode-data`](unicode-data#readme) provides Haskell APIs to efficiently

access the Unicode character database.

Performance is the primary goal in the design of this package.

Please see the

[Haddock documentation](https://hackage.haskell.org/package/unicode-data)

for reference documentation.

### `unicode-data-names`

[`unicode-data-names`](unicode-data-names#readme) provides Haskell APIs

to efficiently access the Unicode character _names_ from the Unicode character

database.

Please see the

[Haddock documentation](https://hackage.haskell.org/package/unicode-data-names)

for reference documentation.

### `unicode-data-scripts`

[`unicode-data-scripts`](unicode-data-scripts#readme) provides Haskell APIs

to efficiently access the Unicode character _scripts_ from the Unicode character

database.

Please see the

[Haddock documentation](https://hackage.haskell.org/package/unicode-data-scripts)

for reference documentation.

### `unicode-data-security`

[`unicode-data-security`](unicode-data-security#readme) provides Haskell APIs

to efficiently access the

[Unicode security mechanisms database](https://www.unicode.org/reports/tr39/).

Please see the

[Haddock documentation](https://hackage.haskell.org/package/unicode-data-security)

for reference documentation.

## Performance

`unicode-data` is up to [_5 times faster_](unicode-data#performance)

than `base`.

## Unicode database version update

See `unicode-data`’s [guide](unicode-data/README.md#unicode-database-version-update).

## Unicode version in some major libraries

The following sections tracks the Unicode versions used in some major libraries.

While `unicode-data` packages do not depend on the Unicode version used in these

packages, there may be some mismatches when using them together.

### GHC / [`base`](https://hackage.haskell.org/package/base)

| GHC version   | `base` version | Unicode version |

| ------------- | -------------- | --------------- |

| 8.8           | 4.13           | 12.0            |

| 8.10.\[1-4\]  | 4.14.\[0-1\]   | 12.0            |

| 8.10.5+       | 4.14.2+        | 13.0            |

| 9.0.\[1-2\]   | 4.15.0         | 12.1            |

| 9.2.\[1-6\]   | 4.16.0         | 14.0            |

| 9.4.\[1-4\]   | 4.17.0         | 14.0            |

| 9.6.\[1-3\]   | 4.18.\[0-1\]   | 15.0            |

| 9.6.4-5       | 4.18.2+        | 15.1            |

| 9.8.1         | 4.19.0         | 15.1            |

| 9.10.1        | 4.20.0         | 15.1            |

### [`text`](https://hackage.haskell.org/package/text)

| `text` version | Unicode version |

| -------------- | --------------- |

| 1.2.5.0        | 13.0            |

| 2.0.\[0-2\]    | 14.0            |

| 2.1.\[0-1\]    | 14.0            |

## Licensing

`unicode-data*` packages are an [open source](https://github.com/composewell/unicode-data)

project available under a liberal [Apache-2.0 license](unicode-data/LICENSE).

## Contributing

As an open project we welcome contributions.