Initial Commit

Author: nerdyc

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+xcuserdata
+*.xccheckout
+*.xcuserstate
+Carthage
+docs
+builds

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian Niles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,25 @@
+# Swift Emoji
+
+`SwiftEmoji` provides a set of regular expressions to find emoji in swift strings. All forms of emoji are matched, including:
+
+* Single-character emoji (👍)
+* Emoji that are variants of other characters (e.g. ⌚️ instead of ⌚︎)
+* Fitzpatrick Modifiers (e.g. skintones 👍🏻👍🏼👍🏽👍🏾👍🏿)
+* ZWJ Sequences (e.g. 💑)
+* Combining sequences (e.g. 0️⃣)
+* Flag sequences (e.g 🇨🇦)
+
+All emoji are derived directly from the standard unicode data files, using an automated script.
+
+## Usage
+
+The `Emoji` class exposes a number of useful regular expressions as static variables. They each come
+in compiled (`NSRegularExpression`) and uncompiled (`String`) forms.
+
+The `String` values are useful when composing your own expressions. For example, the default expressions do not create any capture groups, to avoid the performance overhead.
+
+Look at the source code in `Emoji.swift` for an example.
+
+## License
+
+Squeal is released under the MIT License. Details are in the `LICENSE.txt` file in the project.

Rakefile

@@ -0,0 +1 @@
+Dir.glob('tasks/*.rake').each { |r| load r }

Sources/Emoji.swift

@@ -0,0 +1,90 @@
+import Foundation
+
+///
+/// Useful things for working with Emoji.
+///
+public final class Emoji : EmojiData {
+    
+    ///
+    /// Pattern that matches a single Emoji character, including combining marks and sequences.
+    ///
+    public static var SingleEmojiPattern:String = {
+        // The "emoji" group needs to be followed by a special character to be rendered like emoji.
+        let emojiVariants = "(?:(?:\(EmojiPatterns.joinWithSeparator("|")))\\uFE0F)"
+        
+        // Emoji can be followed by optional combining marks. The standard says only keycaps and
+        // backslash are likely to be supported.
+        let combiningMarks = "[\\u20E3\\u20E0]"
+        
+        // "Presentation" characters are rendered as emoji by default and need no variant.
+        let emojiPresentation = "\(EmojiPresentationPatterns.joinWithSeparator("|"))"
+        
+        // Some other emoji are sequences of characters, joined with 'Zero Width Joiner' characters.
+        // We want the longest match, so we sort these in reverse order.
+        let zwjSequences = ZWJSequencePatterns.reverse().joinWithSeparator("|")
+        let otherSequences = SequencePatterns.joinWithSeparator("|")
+        
+        return "(?:(?:\(zwjSequences)|\(otherSequences)|\(emojiVariants)|\(emojiPresentation))\(combiningMarks)?)"
+    }()
+    
+    /// A regular expression that matches any emoji character. Useful for plucking individual emoji
+    /// out of a string.
+    public static var SingleEmojiRegex:NSRegularExpression = {
+        return try! NSRegularExpression(pattern:SingleEmojiPattern, options:[])
+    }()
+    
+    /// Pattern that matches one or more emoji characters in a row.
+    public static var MultiEmojiPattern:String = {
+        return "(?:\(SingleEmojiPattern)+)"
+    }()
+    
+    /// Matches one or more emoji characters in a row.
+    public static var MultiEmojiRegex:NSRegularExpression = {
+        return try! NSRegularExpression(pattern:MultiEmojiPattern, options:[])
+    }()
+    
+    ///
+    /// Pattern that matches one or more Emoji or whitespace characters in a row. At least one emoji
+    /// character is required; empty or blank strings will not be matched. Leading and trailing
+    /// whitespace will be included in the match range.
+    ///
+    public static var MultiEmojiAndWhitespacePattern:String = {
+        return "(?:(?:\\s*\(MultiEmojiPattern))+\\s*)"
+    }()
+
+    ///
+    /// Matches one or more Emoji or whitespace characters in a row. At least one emoji character is
+    /// required; empty or blank strings will not be matched. Leading and trailing whitespace will
+    /// be included in the match range.
+    ///
+    public static var MultiEmojiAndWhitespaceRegex:NSRegularExpression = {
+        return try! NSRegularExpression(pattern:MultiEmojiAndWhitespacePattern, options:[])
+    }()
+
+    ///
+    /// Pattern that matches any string composed solely of emoji and (optional) whitespace. Empty or
+    /// blank strings will not match.
+    ///
+    public static var PureEmojiAndWhitespacePattern:String = {
+        return "^\(MultiEmojiAndWhitespacePattern)$"
+    }()
+    
+    ///
+    /// Matches any string composed solely of emoji and (optional) whitespace. Empty or blank
+    /// strings will not match.
+    ///
+    public static var PureEmojiAndWhitespaceRegex:NSRegularExpression = {
+        return try! NSRegularExpression(pattern:PureEmojiAndWhitespacePattern, options:[])
+    }()
+    
+    ///
+    /// Returns `true` if the given string is composed solely of emoji and (optional) whitespace.
+    /// Empty or blank strings will not match.
+    ///
+    public static func isPureEmojiString(string:String) -> Bool {
+        let range = NSRange(location: 0, length: string.utf16.count)
+        let firstMatch = PureEmojiAndWhitespaceRegex.rangeOfFirstMatchInString(string, options:[], range:range)
+        return firstMatch.location != NSNotFound
+    }
+    
+}