From 1c0c7b7ff30a7ff821c127514fa3354d2864dacf Mon Sep 17 00:00:00 2001 From: knu Date: Wed, 16 Sep 2015 06:03:18 +0000 Subject: [DOC] Document the full list of supported escape sequences in string literals git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@51874 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- ChangeLog | 5 +++++ doc/syntax/literals.rdoc | 27 +++++++++++++++++++++++++-- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2bf1fa6a30..377dae254f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Wed Sep 16 14:55:33 2015 Akinori MUSHA + + * doc/syntax/literals.rdoc (Strings): [DOC] Document the full list + of supported escape sequences in string literals. + Wed Sep 16 14:49:58 2015 Nobuyoshi Nakada * string.c (rb_str_setbyte): keep the code range as possible. diff --git a/doc/syntax/literals.rdoc b/doc/syntax/literals.rdoc index 1d4ca80ada..7fcd7ca3a3 100644 --- a/doc/syntax/literals.rdoc +++ b/doc/syntax/literals.rdoc @@ -83,8 +83,31 @@ Any internal " must be escaped: "This string has a quote: \". As you can see, it is escaped" -Double-quote strings allow escaped characters such as \n for newline, -\t for tab, etc. +Double-quote strings allow escaped characters such as \n for +newline, \t for tab, etc. The full list of supported escape +sequences are as follows: + + \0 null, ASCII 00h (NUL) + \a bell, ASCII 07h (BEL) + \b backspace, ASCII 08h (BS) + \t horizontal tab, ASCII 09h (TAB) + \n newline (line feed), ASCII 0Ah (LF) + \v vertical tab, ASCII 0Bh (VT) + \f form feed, ASCII 0Ch (FF) + \r carriage return, ASCII 0Dh (CR) + \e escape, ASCII 1Bh (ESC) + \s space, ASCII 20h (SPC) + \\ backslash, \ + \nnn octal bit pattern, where nnn is 1-3 octal digits ([0-7]) + \xnn hexadecimal bit pattern, where nn is 1-2 hexadecimal digits ([0-9a-fA-F]) + \unnnn Unicode character, where nnnn is exactly 4 hexadecimal digits ([0-9a-fA-F]) + \u{nnnn ...} Unicode character(s), where each nnnn is 1-6 hexadecimal digits ([0-9a-fA-F]) + \cx or \C-x control character, where x is an ASCII printable character + \M-x meta character, where x is an ASCII printable character + \M-\C-x meta control character, where x is an ASCII printable character + +Any other charater followed by a backslash is interpreted as the +character itself. Double-quote strings allow interpolation of other values using #{...}: -- cgit v1.2.3