SearchQueryParser

SearchQueryParser

SearchQueryParser ist ein einfacher Google-ähnlicher Parser (und Marker) für Suchmaschinenabfragen für Swift. Es nimmt eine Suchzeichenfolge und erstellt seinen abstrakten Syntaxbaum. Dieses Paket kann mit dem Search Kit von Apple verwendet werden, um gefundene Ergebnisse hervorzuheben.

Merkmale

• Scannerlos (lexerlos)
• Boolesche Syntaxunterstützung (logische Operatoren AND ("&"), OR ("|"), NOT ("!")
• Präfix- und Suffix-Platzhalter („*“)
• Phrasensuche
• Toleriert gegenüber Syntaxfehlern bei Suchanfragen
• Bietet Funktionen zum Auffinden von Suchbegriffen in einem Eingabetext

Grammatik der Suchanfrage

Backus-Naur-Form (BNF):

 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" ;

Anwendungsfälle

Drucken Sie den abstrakten Syntaxbaum einer Suchanfrage aus

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 " )

Markieren Sie Übereinstimmungen mit Suchanfragen

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 ) 

Installation

Swift-Paket als Abhängigkeit in Xcode 11+

1. Gehen Sie zu „Datei“ -> „Swift-Pakete“ -> „Paketabhängigkeit hinzufügen“
2. Fügen Sie die URL des Search Query Parser-Repositorys in das Suchfeld ein:

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

3. Klicken Sie auf „Weiter“

4. Stellen Sie sicher, dass das Feld „Regeln“ etwa so eingestellt ist: „Version: Bis zur nächsten Hauptversion: 1.3.0“

5. Klicken Sie zum Abschluss auf „Weiter“.

Weitere Informationen finden Sie hier.

Kakaokapseln

Fügen Sie Folgendes zu Ihrem Podfile hinzu:

 platform :osx , '10.12'

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

Führen Sie dann pod install aus.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.