diff --git a/.gitignore b/.gitignore index 0eb94aa..077b1e1 100644 --- a/.gitignore +++ b/.gitignore @@ -7,5 +7,4 @@ build/* luacov.report.out luacov.stats.out .luacheckcache -api *.rock diff --git a/Makefile b/Makefile index 71e6dda..dde2770 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ else LIBFLAGS = -shared endif -DOCS_DIR := api +DOCS_DIR := docs BUILD_DIR := build C_SRC_ROOT := src/luaucdn SOURCES := ucdn.c luaucdn.c diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..7b99d7a --- /dev/null +++ b/docs/index.html @@ -0,0 +1,683 @@ + + + + + luaucdn Documentation + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module ucdn

+

Lua bindings to ucdn.

+

+ +

+

+

Info:

+ + + +

Functions

+ + + + + + + + + + + + + + + + + +
get_unicode_version ()Return version of the Unicode database.
get_bidi_class (code)Get bidirectional class of a codepoint.
paired_bracket (code)Get paired bracket for a codepoint.
paired_bracket_type (code)Get paired bracket type for a codepoint.
+

Bidi_Class property

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UCDN_BIDI_CLASS_LLeft_To_Right
UCDN_BIDI_CLASS_LRELeft_To_Right_Embedding
UCDN_BIDI_CLASS_LROLeft_To_Right_Override
UCDN_BIDI_CLASS_RRight_To_Left
UCDN_BIDI_CLASS_ALArabic_Letter
UCDN_BIDI_CLASS_RLERight_To_Left_Embedding
UCDN_BIDI_CLASS_RLORight_To_Left_Override
UCDN_BIDI_CLASS_PDFPop_Directional_Format
UCDN_BIDI_CLASS_ENEuropean_Number
UCDN_BIDI_CLASS_ESEuropean_Separator
UCDN_BIDI_CLASS_ETEuropean_Terminator
UCDN_BIDI_CLASS_ANArabic_Number
UCDN_BIDI_CLASS_CSCommon_Separator
UCDN_BIDI_CLASS_NSMNonspacing_Mark
UCDN_BIDI_CLASS_BNBoundary_Neutral
UCDN_BIDI_CLASS_BParagraph_Separator
UCDN_BIDI_CLASS_SSegment_Separator
UCDN_BIDI_CLASS_WSWhite_Space
UCDN_BIDI_CLASS_ONOther_Neutral
UCDN_BIDI_CLASS_LRILeft_To_Right_Isolate
UCDN_BIDI_CLASS_RLIRight_To_Left_Isolate
UCDN_BIDI_CLASS_FSIFirst_Strong_Isolate
UCDN_BIDI_CLASS_PDIPop_Directional_Isolate
+

Bidi_Paired_Bracket_Type property

+ + + + + + + + + + + + + +
UCDN_BIDI_PAIRED_BRACKET_TYPE_OPENOpen
UCDN_BIDI_PAIRED_BRACKET_TYPE_CLOSEClose
UCDN_BIDI_PAIRED_BRACKET_TYPE_NONENone
+ +
+
+ + +

Functions

+ +
+
+ + get_unicode_version () +
+
+ Return version of the Unicode database. + + + +

Returns:

+
    + + version string, e.g. 8.0.0 +
+ + + + +
+
+ + get_bidi_class (code) +
+
+ Get bidirectional class of a codepoint. + + +

Parameters:

+
    +
  • code + Unicode codepoint +
    • +
+ +

Returns:

+
    + + value according to ucdn.UCDNBIDICLASS_* and as defined in UAX#44. +
+ + + + +
+
+ + paired_bracket (code) +
+
+ Get paired bracket for a codepoint. + + +

Parameters:

+
    +
  • code + Unicode codepoint +
    • +
+ +

Returns:

+
    + + paired bracket codepoint or the original codepoint if no paired bracket character exists +
+ + + + +
+
+ + paired_bracket_type (code) +
+
+ Get paired bracket type for a codepoint. + + +

Parameters:

+
    +
  • code + Unicode codepoint +
    • +
+ +

Returns:

+
    + + value according to ucdn.UCDNBIDIPAIREDBRACKETTYPE_* and as defined in UAX#9. +
+ + + + +
+
+

Bidi_Class property

+ +
+ Enumerated constants representing Bidi_Class values. +
+
+
+ + UCDN_BIDI_CLASS_L +
+
+ Left_To_Right + + + + + + + +
+
+ + UCDN_BIDI_CLASS_LRE +
+
+ Left_To_Right_Embedding + + + + + + + +
+
+ + UCDN_BIDI_CLASS_LRO +
+
+ Left_To_Right_Override + + + + + + + +
+
+ + UCDN_BIDI_CLASS_R +
+
+ Right_To_Left + + + + + + + +
+
+ + UCDN_BIDI_CLASS_AL +
+
+ Arabic_Letter + + + + + + + +
+
+ + UCDN_BIDI_CLASS_RLE +
+
+ Right_To_Left_Embedding + + + + + + + +
+
+ + UCDN_BIDI_CLASS_RLO +
+
+ Right_To_Left_Override + + + + + + + +
+
+ + UCDN_BIDI_CLASS_PDF +
+
+ Pop_Directional_Format + + + + + + + +
+
+ + UCDN_BIDI_CLASS_EN +
+
+ European_Number + + + + + + + +
+
+ + UCDN_BIDI_CLASS_ES +
+
+ European_Separator + + + + + + + +
+
+ + UCDN_BIDI_CLASS_ET +
+
+ European_Terminator + + + + + + + +
+
+ + UCDN_BIDI_CLASS_AN +
+
+ Arabic_Number + + + + + + + +
+
+ + UCDN_BIDI_CLASS_CS +
+
+ Common_Separator + + + + + + + +
+
+ + UCDN_BIDI_CLASS_NSM +
+
+ Nonspacing_Mark + + + + + + + +
+
+ + UCDN_BIDI_CLASS_BN +
+
+ Boundary_Neutral + + + + + + + +
+
+ + UCDN_BIDI_CLASS_B +
+
+ Paragraph_Separator + + + + + + + +
+
+ + UCDN_BIDI_CLASS_S +
+
+ Segment_Separator + + + + + + + +
+
+ + UCDN_BIDI_CLASS_WS +
+
+ White_Space + + + + + + + +
+
+ + UCDN_BIDI_CLASS_ON +
+
+ Other_Neutral + + + + + + + +
+
+ + UCDN_BIDI_CLASS_LRI +
+
+ Left_To_Right_Isolate + + + + + + + +
+
+ + UCDN_BIDI_CLASS_RLI +
+
+ Right_To_Left_Isolate + + + + + + + +
+
+ + UCDN_BIDI_CLASS_FSI +
+
+ First_Strong_Isolate + + + + + + + +
+
+ + UCDN_BIDI_CLASS_PDI +
+
+ Pop_Directional_Isolate + + + + + + + +
+
+

Bidi_Paired_Bracket_Type property

+ +
+ Enumerated constants representing Bidi_Paired_Bracket_Type values. +
+
+
+ + UCDN_BIDI_PAIRED_BRACKET_TYPE_OPEN +
+
+ Open + + + + + + + +
+
+ + UCDN_BIDI_PAIRED_BRACKET_TYPE_CLOSE +
+
+ Close + + + + + + + +
+
+ + UCDN_BIDI_PAIRED_BRACKET_TYPE_NONE +
+
+ None + + + + + + + +
+
+ + +
+
+
+generated by LDoc 1.4.5 +Last updated 2016-08-31 22:17:56 +
+
+ + diff --git a/docs/ldoc.css b/docs/ldoc.css new file mode 100644 index 0000000..52c4ad2 --- /dev/null +++ b/docs/ldoc.css @@ -0,0 +1,303 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 20px 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 14em; + vertical-align: top; + background-color: #f0f0f0; + overflow: visible; +} + +#navigation h2 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + width: 700px; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.module_list td.summary { width: 100%; } + + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f0f0f0; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +ul.nowrap { + overflow:auto; + white-space:nowrap; +} + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } +