Как добавить пользовательскую разметку к MarkupVisitor в Swift-Markdown?

Вопросы и ответы

Я использую библиотеку swift-markdown в своем приложении.

Я пытаюсь разобраться, как добавить свой собственный Markup в MarkupVisitor.

Мне удалось использовать обходное решение с помощью visitInlineAttributes, которое применяется к ^[]().

Существует ли способ добавить свой собственный Markup?

Например, если бы я хотел сделать свой собственный встроенный разметчик, где текст внутри @[text] был бы серого цвета? Похожим образом, как **жирный** делает текст жирным.

Кто-то задавал этот вопрос в библиотеке, но я не понимаю, как реализовать единственный ответ там.

https://github.com/swiftlang/swift-markdown/issues/122

Вот пример кода, который я имею:

import UIKit
import Markdown
import SnapKit

class ViewController: UIViewController, UITextViewDelegate {

    let label = UITextView()

    override func viewDidLoad() {
        super.viewDidLoad()

        label.isEditable = false
        label.delegate = self
        label.linkTextAttributes = [:]
        view.addSubview(label)
        label.snp.makeConstraints { make in
            make.edges.equalTo(view.safeAreaLayoutGuide).inset(10)
        }

        var md = MarkdownParser()
        let attr = md.attributedString(from: "Привет, мир! Вот текст, который **жирный**, и вот текст, который *курсивный*. Вот несколько ^[[метаданных с ссылкой](https://old.reddit.com/r/SaaS/comments/1fgv248/fuck_founder_mode_work_in_fuck_off_mode/)]() который серый и не подчеркивается. И вот обычная [ссылка](https://hckrnews.com), которая подчеркивается и красная. Пожалуйста!")
        print("ATTR:\n\n\(attr)")
        label.attributedText = attr

    }

    func textView(_ textView: UITextView, shouldInteractWith URL: URL, in characterRange: NSRange, interaction: UITextItemInteraction) -> Bool {
        print("shouldInteractWith: \(URL)")
        return true
    }

}

struct MarkdownParser: MarkupVisitor {

    typealias Result = NSMutableAttributedString

    mutating func attributedString(from : String) -> NSMutableAttributedString {
        let document = Document(parsing: from)
        print(document.debugDescription())
        return NSMutableAttributedString(attributedString: visit(document))
    }

    mutating func visit(_ markup: Markup) -> NSAttributedString {
        return markup.accept(&self)
    }

    mutating func defaultVisit(_ markup: any Markdown.Markup) -> NSMutableAttributedString {
        let result = NSMutableAttributedString()

        for child in markup.children {
            result.append(visit(child))
        }

        return result
    }

    mutating func visitText(_ text: Text) -> NSMutableAttributedString {
        return NSMutableAttributedString(string: text.plainText, attributes: [.font:UIFont.systemFont(ofSize: 18, weight: .regular),.foregroundColor:UIColor.label])
    }

    mutating func visitEmphasis(_ emphasis: Emphasis) -> NSMutableAttributedString {
        return doVisit(emphasis)
    }

    mutating func visitStrong(_ strong: Strong) -> NSMutableAttributedString {
        return doVisit(strong)
    }

    mutating func visitInlineAttributes(_ attributes: InlineAttributes) -> NSMutableAttributedString {
        return doVisit(attributes)
    }

    mutating func visitLink(_ link: Link) -> NSMutableAttributedString {
        return doVisit(link)
    }

    mutating func doVisit(_ markup: any Markup) -> NSMutableAttributedString {
        let result = NSMutableAttributedString()

        for child in markup.children {
            result.append(visit(child))
        }

        switch markup {
        case is Strong:
            fallthrough
        case is Emphasis:
            result.enumerateAttribute(.font, in: result.fullRange, options: []) { value, range, stop in
                if let newFont = (value as? UIFont)?.addTrait(trait: markup is Strong ? .traitBold : .traitItalic) {
                    result.addAttribute(.font, value: newFont, range: range)
                }
            }
        case is InlineAttributes:
            result.removeAttributes([.underlineStyle,.underlineColor])
            result.addAttribute(.foregroundColor, value: UIColor.tertiaryLabel)
        case is Link:
            if let destination = (markup as? Link)?.destination, let url = URL(string: destination) {
                let color = UIColor.systemRed
                result.addAttributes([.underlineStyle : NSUnderlineStyle.single.rawValue, .underlineColor : color,.foregroundColor : color, .link : url])
            }
        default:
            break
        }

        return result
    }
}

extension NSAttributedString {
    var fullRange : NSRange {
        NSRange(location: 0, length: length)
    }
}

extension NSMutableAttributedString {
    func addAttribute(_ name: NSAttributedString.Key, value: Any) {
        addAttribute(name, value: value, range: fullRange)
    }

    func addAttributes(_ attrs: [NSAttributedString.Key : Any]) {
        addAttributes(attrs, range: fullRange)
    }

    func removeAttribute(_ name: NSAttributedString.Key) {
        removeAttribute(name, range: fullRange)
    }

    func removeAttributes(_ names: [NSAttributedString.Key]) {
        for attribute in names {
            removeAttribute(attribute)
        }
    }
}

extension UIFont {
    func addTrait(trait : UIFontDescriptor.SymbolicTraits) -> UIFont {
        var traits = fontDescriptor.symbolicTraits
        if traits.contains(trait) {
            return self
        } else {
            traits.insert([trait])
            return UIFont(descriptor: fontDescriptor.withSymbolicTraits(traits)!, size: pointSize)
        }
    }
}

Это отображает следующее:

enter image description here

Ответ

Чтобы добавить собственный пользовательский разметку в MarkupVisitor библиотеки swift-markdown, можете сделать следующее:

  1. Создайте новый тип разметки – вы можете определить новый тип разметки, например, CustomMarkup, который будет представлять вашу разметку, например, текст в формате @[text].

  2. Добавьте правку разметки в ваш MarkdownParser – в вашем MarkdownParser нужно реализовать метод visit для вашего нового типа разметки, который будет задавать необходимые атрибуты для текста.

Ниже приведен пример кода, который демонстрирует, как это реализовать:

import UIKit
import Markdown
import SnapKit

class ViewController: UIViewController, UITextViewDelegate {

    let label = UITextView()

    override func viewDidLoad() {
        super.viewDidLoad()

        label.isEditable = false
        label.delegate = self
        label.linkTextAttributes = [:]
        view.addSubview(label)
        label.snp.makeConstraints { make in
            make.edges.equalTo(view.safeAreaLayoutGuide).inset(10)
        }

        var md = MarkdownParser()
        let attr = md.attributedString(from: "Hello World! Here's some text which is **bold** and here's some which is *italics*. Here's some @[custom text] which is gray.")
        print("ATTR:\n\n\(attr)")
        label.attributedText = attr
    }

    func textView(_ textView: UITextView, shouldInteractWith URL: URL, in characterRange: NSRange, interaction: UITextItemInteraction) -> Bool {
        print("shouldInteractWith: \(URL)")
        return true
    }
}

struct MarkdownParser: MarkupVisitor {

    typealias Result = NSMutableAttributedString

    mutating func attributedString(from : String) -> NSMutableAttributedString {
        let document = Document(parsing: from)
        return NSMutableAttributedString(attributedString: visit(document))
    }

    mutating func visit(_ markup: Markup) -> NSAttributedString {
        return markup.accept(&self)
    }

    mutating func defaultVisit(_ markup: any Markdown.Markup) -> NSMutableAttributedString {
        let result = NSMutableAttributedString()
        for child in markup.children {
            result.append(visit(child))
        }
        return result
    }

    mutating func visitText(_ text: Text) -> NSMutableAttributedString {
        return NSMutableAttributedString(string: text.plainText, attributes: [.font:UIFont.systemFont(ofSize: 18, weight: .regular),.foregroundColor:UIColor.label])
    }

    // Добавьте метод для вашей пользовательской разметки
    mutating func visitCustomMarkup(_ markup: CustomMarkup) -> NSMutableAttributedString {
        let text = markup.content // Предполагается, что у вас есть свойство для текста
        let attributedString = NSMutableAttributedString(string: text, attributes: [.foregroundColor: UIColor.gray])
        return attributedString
    }

    // Переопределите метод, чтобы он распознавал вашу разметку
    mutating func visit(_ markup: Markup) -> NSMutableAttributedString {
        if let customMarkup = markup as? CustomMarkup {
            return visitCustomMarkup(customMarkup)
        }
        return defaultVisit(markup)
    }
}

// Определите структуру для вашей пользовательской разметки
struct CustomMarkup: Markup {
    let content: String

    // Реализуйте необходимые методы протокола Markup ...
}

// Не забудьте о расширениях для NSAttributedString и NSMutableAttributedString (как представлено в вашем коде выше).

Объяснение:

  1. CustomMarkup: Вы создали новый тип разметки CustomMarkup для представления вашего пользовательского синтаксиса @[text]. Обязательно реализуйте все необходимые методы, чтобы он соответствовал протоколу Markup.

  2. visitCustomMarkup: Этот метод возвращает NSMutableAttributedString с заданными атрибутами (в данном случае цветом серого).

  3. Visit: Метод visit был переопределен и теперь проверяет, является ли разметка CustomMarkup. Если это так, он использует метод visitCustomMarkup для обработки этой разметки.

Теперь, когда вы вызываете attributedString(from:) с текстом, содержащим @[custom text], ваш текст будет отображаться с серым цветом.

Этот подход позволяет вам легко добавлять новые пользовательские разметки, просто реализуя соответствующие методы для их обработки в вашем MarkupVisitor.

Оцените материал
Добавить комментарий

Капча загружается...