mirror of
https://github.com/linux-man/LoveFrames.git
synced 2024-11-26 05:14:21 +00:00
63 lines
2.3 KiB
Markdown
63 lines
2.3 KiB
Markdown
|
# utf8.lua
|
||
|
|
pure-lua 5.3 regex library for Lua 5.3, Lua 5.1, LuaJIT
|
||
|
|
|
||
|
|
This library provides simple way to add UTF-8 support into your application.
|
||
|
|
|
||
|
|
#### Example:
|
||
|
|
```Lua
|
||
|
|
local utf8 = require('.utf8'):init()
|
||
|
|
for k,v in pairs(utf8) do
|
||
|
|
string[k] = v
|
||
|
|
end
|
||
|
|
|
||
|
|
local str = "пыщпыщ ололоо я водитель нло"
|
||
|
|
print(str:find("(.л.+)н"))
|
||
|
|
-- 8 26 ололоо я водитель
|
||
|
|
|
||
|
|
print(str:gsub("ло+", "보라"))
|
||
|
|
-- пыщпыщ о보라보라 я водитель н보라 3
|
||
|
|
|
||
|
|
print(str:match("^п[лопыщ ]*я"))
|
||
|
|
-- пыщпыщ ололоо я
|
||
|
|
```
|
||
|
|
|
||
|
|
#### Usage:
|
||
|
|
|
||
|
|
This library can be used as drop-in replacement for vanilla string library. It exports all vanilla functions under `raw` sub-object.
|
||
|
|
|
||
|
|
```Lua
|
||
|
|
local utf8 = require('.utf8'):init()
|
||
|
|
local str = "пыщпыщ ололоо я водитель нло"
|
||
|
|
utf8.gsub(str, "ло+", "보라")
|
||
|
|
-- пыщпыщ о보라보라 я водитель н보라 3
|
||
|
|
utf8.raw.gsub(str, "ло+", "보라")
|
||
|
|
-- пыщпыщ о보라보라о я водитель н보라 3
|
||
|
|
```
|
||
|
|
|
||
|
|
It also provides all functions from Lua 5.3 UTF-8 [module](https://www.lua.org/manual/5.3/manual.html#6.5) except `utf8.len (s [, i [, j]])`. If you need to validate your strings use `utf8.validate(str, byte_pos)` or iterate over with `utf8.validator`.
|
||
|
|
|
||
|
|
#### Installation:
|
||
|
|
|
||
|
|
Download repository to your project folder. (no rockspecs yet)
|
||
|
|
|
||
|
|
As of Lua 5.3 default `utf8` module has precedence over user-provided. In this case you can specify full module path (`.utf8`).
|
||
|
|
|
||
|
|
#### Configuration:
|
||
|
|
|
||
|
|
Library is highly modular. You can provide your implementation for almost any function used. Library already has several back-ends:
|
||
|
|
- [Runtime character class processing](charclass/runtime/init.lua) using hardcoded codepoint ranges or using native functions through `ffi`.
|
||
|
|
- [Basic functions](primitives/init.lua) for working with UTF-8 characters have specializations for `ffi`-enabled runtime and for tarantool.
|
||
|
|
|
||
|
|
Probably most interesting [customizations](init.lua) are `utf8.config.loadstring` and `utf8.config.cache` if you want to precompile your regexes.
|
||
|
|
|
||
|
|
```Lua
|
||
|
|
local utf8 = require('.utf8')
|
||
|
|
utf8.config = {
|
||
|
|
cache = my_smart_cache,
|
||
|
|
}
|
||
|
|
utf8:init()
|
||
|
|
```
|
||
|
|
Customization is done before initialization. If you want, you can change configuration after `init`, it might work for everything but modules. All of them should be reloaded.
|
||
|
|
|
||
|
|
#### [Documentation:](test/test.lua)
|