Swift enumerateLinesの引数の意味

Question

文字列型の関数であるenumerateLinesの詳しい使い方を教えてください。
わからない箇所はenumerateLinesの引数であるstopとLineの意味です。これらの引数の役割はなんでしょうか？

import UIKit

var text: String = "hogehoge\npiyopiyp\nfugafuga"

var lineIndex = 1

text.enumerateLines { (line, stop) -> () in
print("(lineIndex) : (line)")
lineIndex += 1
}

また変数textの中身を"Apple\Orange\Lemon"に変更するとエラーになってしまいます。同じ文字列なのにエラーになるのでとても不思議に思います。わかる方教えてください！

Answer 1

enumerateLinesは改行（\n (バックスラッシュ + n))単位で文字列を読み込むメソッドになります。
実行すると改行した文字列単位で、クロージャーの中がループされていることが分かると思います。

// 出力
1 : hogehoge
2 : piyopiyp
3 : fugafuga

stopはそのままの意味でstop変数にtrueを代入した時にループが終了します。

var text: String = "hogehoge\npiyopiyp\nfugafuga"

var lineIndex = 1

text.enumerateLines { (line, stop) -> () in
    print("\(lineIndex) : \(line)")
    lineIndex += 1
    
    if lineIndex == 3 {
        stop = true
    }
}

上記の書き方ですと、lineIndexが3の時にループを止める処理になるので３が実行されません。
1 : hogehoge
2 : piyopiyp

ちなみに"Apple\Orange\Lemon"のバックスラッシュ『\』だけでは改行コードと認識されないので、そもそも
文字列としてみなされていません。

Comments

[fuzzball]

>>バックスラッシュ『\』だけでは改行コードと認識されないので

正しくは、「\Oや\Lがエスケープシーケンスとして認識されないので」ですね。
ちなみに、\rも改行（行区切り）として認識します。

let text: String = "hogehoge\tomato\radish"
例えば、これならエラーは出ませんが、tomatoとradishが正しく切り出せません。
\t=タブ、\r=改行、と認識されていることが分かると思います。

[_Kentarou]

fuzzballさん補足ありがとうございます。

[Blue0999]

ご回答ありがとうございます！
\nは改行という意味だったのですね。
お教え頂いた事を参考にPlaygroundでいろいろ試していると疑問に思う事が２つあったので答えていただけると嬉しいです。

1.
２つの変数(strとrts)を用意しました。enumerateLinesで明示的にどちらか指定してないのですがなぜ引数であるlineに変数strが格納されるのでしょうか？

2.
enumerateLinesの引数stopは何か関数などの既存の処理だと思っていたのですがをstopをstopStopに変更してもエラーになりません。これはどういう事でしょうか？

import UIKit

var str = "A\nB\nC"
var rts = "C\nB\nA"
var num = 1
str.enumerateLines {(line, stopStop) -> () in
print("\(num) : \(line)")
num += 1
}

[Blue0999]

一番目の質問の答えがわかりました。
よく見たのですが、気づきませんでした…ちゃんと指定していました。すみません。

[fuzzball]

lineやstopは決められた名前ではなく、自分の好きな名前を付けられます。

[Blue0999]

なるほど、一時的に値を格納する変数という事ですね。