SwiftのUITextViewでキャレットを1行上に移動する。

この記事は2019年02月01日に投稿しました。

目次

1. はじめに
2. SwiftのUITextViewでキャレットを1行上に移動する
3. おわりに

[改訂新版]Swift実践入門 ── 直感的な文法と安全性を兼ね備えた言語 (WEB+DB PRESS plus)

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
PWEditorで使用しているSwiftのUITextViewでキャレットを1行上に移動する方法についてです。

目次へ

2. SwiftのUITextViewでキャレットを1行上に移動する

SwiftのUITextViewでキャレットを1行上に移動する方法ですが、以下のような手順になります。

1. キャレットの現在位置を取得します。
2. 文の全行をチェックし、キャレットがどの行にあるか求めます。
3. 対象の行での位置を求めます。
4. 対象行での位置と前行の長さによりオフセット位置を求めます。 対象行での位置が前行の長さより短い場合、前行で対象行での位置と同じ位置をオフセットとします。 対象行での位置が前行の長さより長い場合、前行の行末位置をオフセットとします。
5. 最終行が改行の場合、最終行の1行下にキャレットがいる場合があります。 その場合に1行上に移動します。
6. キャレットをオフセット分移動します。

キャレットの現在位置の取得は

paveway.hatenablog.com

で紹介したメソッドを使用します。

実装例

import UIKit
...
var textView: UITextView!
...
guard let range = textView.selectedTextRange else {
    // 範囲が取得できない場合、終了します。
    // 念のためのチェック
    return
}

guard let text = targetView.text else {
    // テキストが取得できない場合、終了します。
    // 念のためのチェック
    return
}

// テキストの全文字数を取得します。
// characters.countは現在deprecateのためそのうち修正します。
let textCount = text.characters.count

// 1. キャレットの現在位置を取得します。
let current = getCurrent(targetView, range: range)

// 2. キャレットがどの行にあるかチェックします。
//    enumerateLinesメソッドで取得される文字列に改行文字は含まれません。
//    全行をチェックし、各行の行頭の位置と行末の位置を求め、
//    キャレットの現在位置がその範囲にあれば、その行を対象行としています。
var first = true  // 先頭行のみ処理するフラグ
var trail = 0     // 行末位置
var preLead = 0   // 全行の行頭位置
var preTrail = 0  // 全行の行末位置
var position: UITextPosition?
text.enumerateLines() { (line, stop) -> Void in
    let lead: Int // 行頭位置
    if first {
        // 先頭行の場合
        // 行頭位置を0に設定します。
        lead = 0
        first = false

    } else {
        // 行頭位置を前行の行末位置+改行文字分に設定します。
        lead = trail + 1
    }

    // 行の文字数を取得します。
    // characters.countは現在deprecateのためそのうち修正します。
    let count = line.characters.count
    // 行末位置を更新します。
    trail = lead + count
    // 前行の長さを取得します。
    let preLineLen = preTrail - preLead
    if lead <= current && current <= trail {
        // 3. キャレットがある行の場合
        //    対象行での位置を求めます。
        let linePos = current - lead
        // 4. 前行が対象行より長いか短いかでオフセットを求めます。
        let offset: Int
        if linePos <= preLineLen {
            // 対象行での位置より前行が長い場合
            // 前行の同じ位置+改行文字分をオフセットとします。
            offset = preLineLen + 1

        } else {
            // 対象行での位置より前行が短い場合
            // 前行の行末位置+改行文字分をオフセットとします。
            offset = linePos + 1
        }

        let start = range.start
        position = targetView.position(from: start, offset: -offset)
        stop = true
    }

    // 前行の行頭と行末の位置を保存する。
    preLead = lead
    preTrail = trail

    // 5. 最終行が改行の場合、最終行の1行下にキャレットがいる場合があります。
    //    その場合に1行上に移動します。
    if textCount == preTrail + 1 {
        if current == textCount {
            let offset = preTrail - preLead + 1
            let start = range.start
            position = targetView.position(from: start, offset: -offset)
            stop = true
        }
    }

    // 6. キャレットをオフセット分移動します。
    guard let pos = position else {
        return
    }
    targetView.selectedTextRange = targetView.textRange(from: pos, to: pos)
}

目次へ

3. おわりに

キャレットを1行上に移動する方法ですが、前行の長さを考慮しなくては目的の位置に移動できません。
この部分の処理を考えるのが一番難しかった記憶があります。

teratail

詳細！Swift 4 iPhoneアプリ開発 入門ノート Swift 4+Xcode 9対応

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

---

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ