Feature/colon to emoji toggle

Keyboards/KeyboardsBase/InterfaceVariables.swift

@@ -96,6 +96,7 @@ enum CommandState {
   case alreadyPlural
   case invalid
   case displayInformation
+  case colonToEmoji
 }
 
 /// States of the keyboard corresponding to which auto actions should be presented.

Keyboards/KeyboardsBase/KeyboardViewController.swift

@@ -404,6 +404,51 @@ class KeyboardViewController: UIInputViewController {
     }
   }
 
+  func getEmojiAutoSuggestionsPatternMatching(for word: String) {
+    let emojisToDisplay = LanguageDBManager.shared.queryEmojisPatternMatching(of: word.lowercased())
+
+    if !emojisToDisplay[0].isEmpty {
+      emojisToDisplayArray = [String]()
+      currentEmojiTriggerWord = ":" + word.lowercased()
+
+      if !emojisToDisplay[2].isEmpty && DeviceType.isPad {
+        for i in 0 ..< 3 {
+          emojisToDisplayArray.append(emojisToDisplay[i])
+        }
+        autoAction2Visible = false
+        emojisToShow = .three
+
+        if UITraitCollection.current.userInterfaceStyle == .light {
+          padEmojiDivider0.backgroundColor = specialKeyColor
+          padEmojiDivider1.backgroundColor = specialKeyColor
+        } else if UITraitCollection.current.userInterfaceStyle == .dark {
+          padEmojiDivider0.backgroundColor = UIColor(cgColor: commandBarPlaceholderColorCG)
+          padEmojiDivider1.backgroundColor = UIColor(cgColor: commandBarPlaceholderColorCG)
+        }
+        conditionallyHideEmojiDividers()
+      } else if !emojisToDisplay[1].isEmpty {
+        for i in 0 ..< 2 {
+          emojisToDisplayArray.append(emojisToDisplay[i])
+        }
+        autoAction2Visible = false
+        emojisToShow = .two
+
+        if UITraitCollection.current.userInterfaceStyle == .light {
+          phoneEmojiDivider.backgroundColor = specialKeyColor
+        } else if UITraitCollection.current.userInterfaceStyle == .dark {
+          phoneEmojiDivider.backgroundColor = UIColor(cgColor: commandBarPlaceholderColorCG)
+        }
+        conditionallyHideEmojiDividers()
+      } else {
+        emojisToDisplayArray.append(emojisToDisplay[0])
+
+        emojisToShow = .one
+      }
+    } else {
+      emojisToShow = .zero
+    }
+  }
+
   /// Generates an array of the three autocomplete words.
   func getAutocompletions() {
     completionWords = [" ", " ", " "]
@@ -633,12 +678,14 @@ class KeyboardViewController: UIInputViewController {
     autoActionAnnotationSeparators.forEach { $0.removeFromSuperview() }
     autoActionAnnotationSeparators.removeAll()
 
-    if autoActionState == .suggest {
+    if commandState == .colonToEmoji {
+      getEmojiAutoSuggestionsPatternMatching(for: colonSearchString)
+    } else if autoActionState == .suggest {
       getAutosuggestions()
     } else {
       getAutocompletions()
     }
-    if commandState == .idle {
+    if [.idle, .colonToEmoji].contains(commandState) {
       deactivateBtn(btn: translateKey)
       deactivateBtn(btn: conjugateKey)
       deactivateBtn(btn: pluralKey)
@@ -843,6 +890,16 @@ class KeyboardViewController: UIInputViewController {
       allowUndo = false
     }
 
+    if commandState == .colonToEmoji {
+      for _ in 0 ... colonSearchString.count {
+        proxy.deleteBackward()
+      }
+      proxy.insertText(keyPressed.titleLabel?.text ?? "")
+      commandState = .idle
+      loadKeys()
+      return
+    }
+
     clearPrefixFromTextFieldProxy()
     emojisToDisplayArray = [String]()
     // Remove the space from the previous auto action or replace the current prefix.
@@ -2330,6 +2387,17 @@ class KeyboardViewController: UIInputViewController {
 
   }
 
+  func colonToEmojiIsEnabled() -> Bool {
+    let langCode = languagesAbbrDict[controllerLanguage] ?? "unknown"
+    if let userDefaults = UserDefaults(suiteName: "group.be.scri.userDefaultsContainer") {
+      let dictionaryKey = langCode + "ColonToEmoji"
+
+      return userDefaults.bool(forKey: dictionaryKey)
+    } else {
+      return true // return the default value
+    }
+  }
+
   // MARK: Button Actions
 
   /// Triggers actions based on the press of a key.
@@ -2716,6 +2784,15 @@ class KeyboardViewController: UIInputViewController {
           pastStringInTextProxy = ""
         }
 
+        if commandState == .colonToEmoji {
+          if !colonSearchString.isEmpty {
+            colonSearchString.removeLast()
+          } else {
+            commandState = .idle
+            loadKeys()
+          }
+        }
+
         handleDeleteButtonPressed()
         autoCapAtStartOfProxy()
 
@@ -2870,7 +2947,20 @@ class KeyboardViewController: UIInputViewController {
         shiftButtonState = .normal
         loadKeys()
       }
-      if [.idle, .selectCommand, .alreadyPlural, .invalid].contains(commandState) {
+
+      if keyToDisplay == ":" && commandState == .idle && colonToEmojiIsEnabled() {
+        commandState = .colonToEmoji
+        colonSearchString = ""
+      } else if commandState == .colonToEmoji {
+        if keyToDisplay.rangeOfCharacter(from: CharacterSet.alphanumerics) != nil {
+          colonSearchString += keyToDisplay
+        } else {
+          commandState = .idle
+          loadKeys()
+        }
+      }
+
+      if [.idle, .selectCommand, .alreadyPlural, .invalid, .colonToEmoji].contains(commandState) {
         proxy.insertText(keyToDisplay)
       } else {
         if let currentText = commandBar.text {

Keyboards/KeyboardsBase/LanguageDBManager.swift

@@ -268,6 +268,47 @@ extension LanguageDBManager {
     return queryDBRow(query: query, outputCols: outputCols, args: StatementArguments(args))
   }
 
+  /// Query emojis of word in `emoji_keywords` using pattern matching.
+  func queryEmojisPatternMatching(of word: String) -> [String] {
+    var outputValues = [String]()
+    let query = """
+    SELECT
+      emoji_keyword_0, emoji_keyword_1, emoji_keyword_2
+
+    FROM
+      emoji_keywords
+
+    WHERE
+      word LIKE ?
+
+    ORDER BY
+      LENGTH(word) ASC
+
+    LIMIT
+      3
+    """
+    let args = StatementArguments(["\(word.lowercased())%"])
+    do {
+      try database?.read { db in
+        let rows = try Row.fetchAll(db, sql: query, arguments: args)
+        for row in rows {
+          for col in ["emoji_keyword_0", "emoji_keyword_1", "emoji_keyword_2"] {
+            if let val = row[col] as? String, !val.isEmpty {
+              outputValues.append(val)
+              if outputValues.count == 3 { return }
+            }
+          }
+        }
+      }
+    } catch {}
+
+    while outputValues.count < 3 {
+      outputValues.append("")
+    }
+
+    return Array(outputValues.prefix(3))
+  }
+
   /// Query the noun form of word in `nonuns`.
   func queryNounForm(of word: String) -> [String] {
     let query = """

Keyboards/KeyboardsBase/ScribeFunctionality/CommandVariables.swift

@@ -24,6 +24,7 @@ enum EmojisToShow {
 var emojisToShow: EmojisToShow = .zero
 var currentEmojiTriggerWord = ""
 var emojiAutoActionRepeatPossible = false
+var colonSearchString = ""
 
 var firstCompletionIsHighlighted = false
 var spaceAutoInsertIsPossible = false

Scribe/ParentTableCellModel.swift

@@ -70,6 +70,7 @@ enum UserInteractiveState {
   case autosuggestEmojis
   case toggleAccentCharacters
   case toggleWordForWordDeletion
+  case colonToEmoji
   case none
 }
 

Scribe/SettingsTab/SettingsTableData.swift

@@ -78,6 +78,12 @@ enum SettingsTableData {
           hasToggle: true,
           sectionState: .none(.toggleWordForWordDeletion),
           shortDescription: NSLocalizedString("i18n.app.word_for_word.description", value: "Word for word deletion.", comment: "")
+        ),
+        Section(
+          sectionTitle: NSLocalizedString("i18n.app.settings.keyboard.functionality.colon_to_emoji", value: "Colon to emoji entry", comment: ""),
+          hasToggle: true,
+          sectionState: .none(.colonToEmoji),
+          shortDescription: NSLocalizedString("i18n.app.settings.keyboard.functionality.colon_to_emoji_description", value: "Type : followed by a keyword to suggest emojis.", comment: "")
         )
       ],
       hasDynamicData: nil

Scribe/Views/Cells/InfoChildTableViewCell/InfoChildTableViewCell.swift

@@ -151,6 +151,10 @@ final class InfoChildTableViewCell: UITableViewCell {
       let dictionaryKey = languageCode + "WordForWordDeletion"
       userDefaults.setValue(toggleSwitch.isOn, forKey: dictionaryKey)
 
+    case .colonToEmoji:
+      let dictionaryKey = languageCode + "ColonToEmoji"
+      userDefaults.setValue(toggleSwitch.isOn, forKey: dictionaryKey)
+
     case .none: break
     }
 
@@ -199,6 +203,14 @@ final class InfoChildTableViewCell: UITableViewCell {
         toggleSwitch.isOn = false // Default value
       }
 
+    case .colonToEmoji:
+      let dictionaryKey = languageCode + "ColonToEmoji"
+      if let toggleValue = userDefaults.object(forKey: dictionaryKey) as? Bool {
+        toggleSwitch.isOn = toggleValue
+      } else {
+        toggleSwitch.isOn = true // Default value
+      }
+
     case .none: break
     }
   }

Tests/Keyboards/KeyboardsBase/EmojiQueryTests.swift

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+import Foundation
+@testable import Scribe
+import XCTest
+
+class EmojiQueryTests: XCTestCase {
+
+    func testQueryEmojisPatternMatchingWithCommonKeyword() {
+        // This test assumes the database is populated with some emojis.
+        // If not, it might return empty, which we also handle.
+        let keyword = "happ"
+        let results = LanguageDBManager.shared.queryEmojisPatternMatching(of: keyword)
+
+        XCTAssertEqual(results.count, 3, "Should always return 3 elements (including empty strings)")
+    }
+
+    func testQueryEmojisPatternMatchingWithEmptyKeyword() {
+        let results = LanguageDBManager.shared.queryEmojisPatternMatching(of: "")
+        XCTAssertEqual(results.count, 3)
+    }
+
+    func testQueryEmojisPatternMatchingWithNonExistentKeyword() {
+        let results = LanguageDBManager.shared.queryEmojisPatternMatching(of: "nonexistentkeyword12345")
+        XCTAssertEqual(results.count, 3)
+        XCTAssertEqual(results[0], "")
+        XCTAssertEqual(results[1], "")
+        XCTAssertEqual(results[2], "")
+    }
+}

Tests/Keyboards/KeyboardsBase/KeyboardCommandTests.swift

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+import Foundation
+@testable import Scribe
+import XCTest
+
+class KeyboardCommandTests: XCTestCase {
+
+    func testColonToEmojiIsEnabled() {
+        let keyboard = KeyboardViewController()
+        // Default should be true as per the implementation
+        XCTAssertTrue(keyboard.colonToEmojiIsEnabled())
+    }
+
+    // Note: Testing UI state transitions often requires a more complex setup
+    // with UIInputViewController and its proxy. Here we test the logic we can.
+}