Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 2.67 KB

README.md

File metadata and controls

64 lines (47 loc) · 2.67 KB
Raw

Lean 4 / Unicode Basic

Unicode support for Lean 4.

Unicode properties that are currently supported by UnicodeBasic include:

  • Alphabetic
  • Bidi_Class
  • Bidi_Control
  • Bidi_Mirrored
  • Canonical_Combining_Class
  • Case_Ignorable
  • Cased
  • Decomposition_Mapping
  • Decomposition_Type
  • General_Category
  • Hex_Digit
  • Math
  • Name
  • Numeric_Type
  • Numeric_Value
  • Simple_Lowercase_Mapping
  • Simple_Uppercase_Mapping
  • Simple_Titlecase_Mapping
  • Lowercase
  • Uppercase
  • White_Space

To keep the UnicodeLibrary library lightweight, only commonly used properties can be supported. If you need a property not yet in the list above, please submit a feature request!

Installation

Add the following dependency to your project's lakefile.toml:

[[require]]
name = "UnicodeBasic"
git = "https://github.com/fgdorais/lean4-unicode-basic.git"
rev = "main"

Or your project's lakefile.lean:

require UnicodeBasic from git
  "https://github.com/fgdorais/lean4-unicode-basic" @ "main"

Then add import UnicodeBasic at the top of any Lean file where you plan to use this library.

Use the branch "docs" instead of "main" if you need to have local library documentation. (doc-gen4 cannot be used directly because of a circular dependency.)

Documentation

Documentation for the library is located at dorais.org/lean4-unicode-basic/docs/.

The main entry point is the root file UnicodeBasic. This file contains a description of the main API as well as all primary library functions. The file UnicodeBasic.Types contains all the primary data types used in the library.

The remaining files are implementation details. Some of these may be of interest for developers. For example UnicodeBasic.CharacterDatabase defines a stream type for parsing files from the Unicode Character Database.

  • The Lean 4 / Unicode Basic library is copyright © 2023-2024 François G. Dorais. The library is released under the Apache 2.0 license. See the file LICENSE for additional details.
  • The UnicodeData.txt and PropList.txt files are copyright © 1991-2024 Unicode, Inc. The files are distributed under the Unicode® Copyright and Terms of Use. See the file LICENSE-UNICODE for additional details.