Difference between revisions of "Utf8.escape"

Latest revision as of 21:43, 1 December 2023

Available since: Gideros 2016.06
Class: utf8

Escapes a str to UTF-8 format string.

(string) = utf8.escape(s)

It supports several escape format:

%ddd - which ddd is a decimal number at any length: change Unicode code point to UTF-8 format
%{ddd} - same as %ddd but has bracket around
%uddd - same as %ddd, u stands Unicode
%u{ddd} - same as %{ddd}
%xhhh - hexadigit version of %ddd
%x{hhh} same as %xhhh
%? - '?' stands for any other character: escape this character

s: (string)

Returns (string) escaped string

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2016.06<br/>
+'''Class:''' [[utf8]]<br/>
 === Description ===
-Escape a str to UTF-8 format string. It support several escape format:
+Escapes a str to UTF-8 format string.
-%ddd - which ddd is a decimal number at any length: change Unicode code point to UTF-8 format. %{ddd} - same as %nnn but has bracket around. %uddd - same as %ddd, u stands Unicode %u{ddd} - same as %{ddd} %xhhh - hexadigit version of %ddd %x{hhh} same as %xhhh. %? - '?' stands for any other character: escape this character.
+<syntaxhighlight lang="lua">
-<source lang="lua">
+(string) = utf8.escape(s)
-(string), = utf8.escape(s,)
+</syntaxhighlight>
-</source>
-'''s:''' (string)  ''''''<br/>
+It supports several escape format:
+*'''%ddd''' - which ddd is a decimal number at any length: change Unicode code point to UTF-8 format
+*'''%{ddd}''' - same as %ddd but has bracket around
+*'''%uddd''' - same as %ddd, u stands Unicode
+*'''%u{ddd}''' - same as %{ddd}
+*'''%xhhh''' - hexadigit version of %ddd
+*'''%x{hhh}''' same as %xhhh
+*'''%?''' - '?' stands for any other character: escape this character
+=== Parameters ===
+'''s''': (string) <br/>
+=== Return values ===
 '''Returns''' (string) escaped string<br/>
+{{Utf8}}