文字列 (String)¶

StringはUTF-8文字のイミュータブルな列を表します。

通常、ダブルクォート (") で囲まれたUTF-8でエンコードされた文字の並びで文字列リテラルを記述します。

"hello world"

エスケープ文字¶

文字列中では、バックスラッシュによる名前つきのエスケープシーケンスやコードポイントの数値表現によって、特別な文字を記述できます。

次のエスケープシーケンスが有効です。

"\""                  # double quote
"\\"                  # backslash
"\#"                  # hash character (to escape interpolation)
"\a"                  # alert
"\b"                  # backspace
"\e"                  # escape
"\f"                  # form feed
"\n"                  # newline
"\r"                  # carriage return
"\t"                  # tab
"\v"                  # vertical tab
"\377"                # octal ASCII character
"\xFF"                # hexadecimal ASCII character
"\uFFFF"              # hexadecimal unicode character
"\u{0}".."\u{10FFFF}" # hexadecimal unicode character

その他の文字がバックスラッシュに続いた場合、その文字自身を表すものになります。

バックスラッシュに続く最大3つの0から7までの数値は、8進数によるコードポイントの記述となります。

"\101" # => "A"
"\123" # => "S"
"\12"  # => "\n"
"\1"   # コードポイント1の文字が1つだけの文字列

バックスラッシュにuを続けることでユニコードのコードポイントを記述できます。ユニコードの文字を表現するため、ちょうど4つの16進数の数値か (\u0000 to \uFFFF) かひげ括弧で囲った6つまでの16進数の数値が利用できます (\u{0} to \u{10FFFF}

"\u0041"    # => "A"
"\u{41}"    # => "A"
"\u{1F52E}" # => "🔮"

1つのひげ括弧の中にスペースで区切って複数のユニコード文字が記述できます。

"\u{48 45 4C 4C 4F}" # => "HELLO"

文字列の補間¶

補間を伴う文字列リテラルは、文字列に実行時に展開される式を埋め込むことができます。

a = 1
b = 2
"sum: #{a} + #{b} = #{a + b}" # => "sum: 1 + 2 = 3"

文字列の補間はString#%メソッドでも可能です。

任意の式を文字列の補間として書くことができますが、可読性を高めるためそれらの式は小さなものに保ったほうが良いです。

Interpolation can be disabled by escaping the hash character (#) with a backslash or by using a non-interpolating string literal like %q().

"\#{a + b}"  # => "#{a + b}"
%q(#{a + b}) # => "#{a + b}"

補間はString::Builderを使い、#{...}の中の式に対してObject#to_s(IO)を呼び出すことで実装されます。式"sum: #{a} + #{b} = #{a + b}"は次に等しいです。

String.build do |io|
  io << "sum: "
  io << a
  io << " + "
  io << b
  io << " = "
  io << a + b
end

パーセント文字列リテラル¶

ダブルクォートによる文字列リテラルの他に、Crystalはパーセント記号 (%) と区切り文字の組による文字列リテラルもサポートしています。有効な区切り文字は、括弧()、角括弧[]、ひげ括弧{}、三角括弧<>そしてパイプ文字||です。パイプ文字を除いて、すべての区切り文字はネストに応じて適切に処理されます。

ダブルクォートを含むような文字列を書くのにこれらのリテラルはお手軽です。

%(hello ("world")) # => "hello (\"world\")"
%[hello ["world"]] # => "hello [\"world\"]"
%{hello {"world"}} # => "hello {\"world\"}"
%<hello <"world">> # => "hello <\"world\">"
%|hello "world"|   # => "hello \"world\""

%qで記述される文字列リテラルは、文字列の補間とエスケープを受け付けません。また%Qは%と同じ意味を持ちます。

name = "world"
%q(hello \n #{name}) # => "hello \\n \#{name}"
%Q(hello \n #{name}) # => "hello \n world"

パーセント文字列配列リテラル¶

1つの文字列を表すリテラルの他に、文字列の配列を表わすパーセントリテラルがあります。それは%wと区切り文字の組によって記述します。有効な区切り文字はパーセント文字列リテラルのときと同じです。

%w(foo bar baz)  # => ["foo", "bar", "baz"]
%w(foo\nbar baz) # => ["foo\\nbar", "baz"]
%w(foo(bar) baz) # => ["foo(bar)", "baz"]

%w で記述されたリテラルはスペースを除くエスケープと文字列の補間を受け付けないことに注意してください。もちろん、エスケープされた1つのスペース () では文字列は区切られません。

%w(foo\ bar baz) # => ["foo bar", "baz"]

複数行の文字列¶

任意の文字列リテラルは複数行にまたがって記述できます。

"hello
      world" # => "hello\n      world"

上の例では、先頭と末尾の空白、および改行が結果の文字列にも入っていることに注目してください。これを防ぐために、文字列リテラルを行毎に分割して、バックスラッシュで結合するという手段を取ることができます。

"hello " \
"world, " \
"no newlines" # same as "hello world, no newlines"

もしくは、バックスラッシュに改行を続けたものを文字列中に追加する、という手段もあります。

"hello \
     world, \
     no newlines" # same as "hello world, no newlines"

この場合、先頭の空白が結果の文字列に含まれることはありません。

ヒアドキュメント¶

ヒアドキュメントないしheredocは複数行にまたがる文字列の便利な書き方です。ヒアドキュメントは<<-とそれに続くアルファベットと数字 (アンダースコアも含めることができる) の並びの識別子によって記述されます。ヒアドメントは続く行から開始して、次の行に最初に指定した識別子のみを含む行で終了します。オプションで先頭に空白文字を入れることもできます。

<<-XML
<parent>
  <child />
</parent>
XML

最後の行のヒアドキュメントの識別子の前の空白の個数分だけ、ヒアドキュメントの内容から先頭の空白文字が削除されます。

<<-STRING # => "Hello\n  world"
  Hello
    world
  STRING

<<-STRING # => "  Hello\n    world"
    Hello
      world
  STRING

ヒアドキュメントの識別子のあとで同じ行の場合、ヒアドキュメントの内容の前に任意の式を続けることができます。このとき、ヒアドキュメントの識別子は文字列リテラルの終端のように機能します。ですが、その文字列の内容は終端のヒアドキュメントの識別子までの後続の行のものとなります。

<<-STRING.upcase # => "HELLO"
hello
STRING

def upcase(string)
  string.upcase
end

upcase(<<-STRING) # => "HELLO WORLD"
  Hello World
  STRING

もし複数のヒアドキュメントが同じ行で開始した場合、それらの内容は逐次的に読み込まれます。

print(<<-FIRST, <<-SECOND) # prints "HelloWorld"
  Hello
  FIRST
  World
  SECOND

ヒアドキュメントの中では一般的に補間とエスケープが有効になっています。

ヒアドキュメントの中で補間やエスケープを禁止したい場合、ヒアドキュメント冒頭の識別子をシングルクォートで囲ってください。

<<-'HERE' # => "hello \\n \#{world}"
  hello \n #{world}
  HERE