SearchQueryParser

Поисковый парсер

SearchQueryParser — это простой парсер (и маркер) запросов поисковых систем, похожий на Google, для Swift. Он берет строку поиска и строит ее абстрактное синтаксическое дерево. Этот пакет применим для использования с Apple Search Kit для выделения найденных результатов.

Функции

• Без сканера (без лексера)
• Поддержка логического синтаксиса (логические операторы AND ("&"), OR ("|"), NOT ("!")
• Подстановочные знаки префикса и суффикса ("*").
• Поиск фраз
• Устойчивость к синтаксическим ошибкам поисковых запросов.
• Предоставляет возможности для поиска условий поиска во входном тексте.

Грамматика поискового запроса

Форма Бэкуса – Наура (БНФ):

 Query = Sweeping-Mute-And-Term, ⧚’?, EOF ;
Sweeping-Mute-And-Term = Mute-And-Term, { ⧚’?, Mute-And-Term }* ;
Mute-And-Term = Or-Term, Or-Term* ;
Or-Term = And-Term, {⧚?, (‘|’ | “OR”), And-Term }* ;
And-Term = Not-Term, {⧚?, (‘&’ | “AND”), Not-Term }* ;
Not-Term = ⧚?, (’!’ | “NOT”), Not-Term | Primary-Term ;
Primary-Term = ⧚?, ’(‘ ⧚?, Mute-And-Term, ⧚? ‘)’ |
               ⧚?, “‘“ ⧚?, Phrase, ⧚? “‘“ |
               ⧚?, Prefix-Wildcard-Search-Term |
               ⧚?, Suffix-Wildcard-Search-Term |
               ⧚?, Search-Term ;
Phrase = Search-Term, { ⧚, Search-Term }* ;
Prefix-Wildcard-Search-Term = ‘*’, Search-Term ;
Suffix-Wildcard-Search-Term = Search-Term, ‘*’ ;
Search-Term = Letter | Letter, Search-Term ;
Letter = Alpha | Digit | ‘_’ ;
⧚’ = ⧚-(“*” | “!” | “&” | “(“ | “)” | “””)
⧚ = { ? any-character ?-Letter }+ ;
Alpha = ? alpha-character ? ;
Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;

Варианты использования

Распечатайте абстрактное синтаксическое дерево поискового запроса.

import SearchQueryParser

func printQueryAST ( _ query : String ) {
    guard let parser = SearchQueryParser ( query ) , let ast = parser . astRoot
    else {
        print ( " Couldn't parse " )
        return
    }
    print ( " AST: ( ast ) " )
}

printQueryAST ( " foo bar " )

Выделить совпадения поискового запроса

import SearchQueryParser

func highlightSearchQueryMatches ( query : String , in text : NSMutableAttributedString ) {
    guard let queryTerms = SearchQueryParser ( query )
    else {
        print ( " No matches found " )
        return
    }
    let tokensProvider = SearchTextScanner ( text . string )
    guard let applicator = SearchQueryApplicator ( searchQueryTerms : queryTerms ,
                                                 textTokens : tokensProvider )
    else {
        print ( " Nothing was marked " )
        return
    }
    applicator . markedRanges . forEach { range in
        text . addAttribute ( . backgroundColor , value : NSColor . yellow , range : range )
    }
}
let text = NSMutableAttributedString ( string : " Lorem ipsum ... " )
highlightSearchQueryMatches ( query : " foo & bar " , in : text ) 

Установка

Пакет Swift как зависимость в Xcode 11+

1. Перейдите в «Файл» -> «Пакеты Swift» -> «Добавить зависимость пакета».
2. Вставьте URL-адрес репозитория Search Query Parser в поле поиска:

https://github.com/SerhiyButz/SearchQueryParser.git

3. Нажмите «Далее»

4. Убедитесь, что в поле «Правила» установлено примерно следующее: «Версия: до следующего основного: 1.3.0».

5. Нажмите «Далее», чтобы закончить

Для получения дополнительной информации посетите здесь.

Какао-стручки

Добавьте в свой подфайл следующее:

 platform :osx , '10.12'

target 'YOUR-TARGET' do
  use_frameworks!
  pod 'SearchQueryParser' , :git => 'https://github.com/SerhiyButz/SearchQueryParser.git'
end

Затем запустите pod install .

Лицензия

Этот проект лицензируется по лицензии MIT.