Merge pull request #373 from damien-rivet/feature/371-add-functionali…

…ty-new-keyboard-expendend-layouts

[#371] Add functionality for new keyboard expanded layout

Keyboards/InterfaceConstants.swift

@@ -0,0 +1,9 @@
+//
+//  Scribe
+//
+
+struct SpecialKeys {
+
+  static let indent = "indent"
+  static let capsLock = "capslock"
+}

Keyboards/KeyboardsBase/InterfaceVariables.swift

@@ -16,7 +16,7 @@ var keyboard = [[String]]()
 var usingExpandedKeyboard = false
 var allKeys = [String]()
 let specialKeys = [
-  "shift", "delete", "ABC", "АБВ", "123", "#+=", "selectKeyboard", "space", "return", ".?123", "hideKeyboard",
+  SpecialKeys.indent, SpecialKeys.capsLock, "shift", "delete", "ABC", "АБВ", "123", "#+=", "selectKeyboard", "space", "return", ".?123", "hideKeyboard",
 ]
 var allNonSpecialKeys = [String]()
 var keyboardHeight: CGFloat!
@@ -51,11 +51,17 @@ enum KeyboardState {
 /// What the keyboard state is in regards to the shift key.
 /// - normal: not capitalized
 /// - shift: capitalized
-/// - caps: caps-lock
 enum ShiftButtonState {
   case normal
   case shift
-  case caps
+}
+
+/// What the keyboard state is in regards to the all caps key.
+/// - normal: not capitalized
+/// - locked: caps-lock
+enum CapsLockButtonState {
+  case normal
+  case locked
 }
 
 /// States of the keyboard corresponding to which commands the user is executing.
@@ -89,6 +95,7 @@ enum ConjViewShiftButtonsState {
 // Baseline state variables.
 var keyboardState: KeyboardState = .letters
 var shiftButtonState: ShiftButtonState = .normal
+var capsLockButtonState: CapsLockButtonState = .normal
 var commandState: CommandState = .idle
 var autoActionState: AutoActionState = .suggest
 var conjViewShiftButtonsState: ConjViewShiftButtonsState = .bothInactive

Keyboards/KeyboardsBase/KeyAnimation.swift

@@ -319,7 +319,7 @@ func setPhoneKeyPopCharSize(char: String) {
       keyPopChar.font = .systemFont(ofSize: letterKeyWidth / 1.15)
       keyHoldPopChar.font = .systemFont(ofSize: letterKeyWidth / 1.15)
     }
-  } else if shiftButtonState == .shift || shiftButtonState == .caps {
+  } else if shiftButtonState == .shift || capsLockButtonState == .locked {
     if isLandscapeView {
       keyPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.15)
       keyHoldPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.15)
@@ -351,7 +351,7 @@ func setPadKeyPopCharSize(char: String) {
       keyPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.5)
       keyHoldPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.5)
     }
-  } else if keyboardState == .letters, shiftButtonState == .shift || shiftButtonState == .caps {
+  } else if keyboardState == .letters, shiftButtonState == .shift || capsLockButtonState == .locked {
     if isLandscapeView {
       keyPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.5)
       keyHoldPopChar.font = .systemFont(ofSize: letterKeyWidth / 2.5)

Keyboards/KeyboardsBase/KeyboardKeys.swift

@@ -65,7 +65,7 @@ class KeyboardKey: UIButton {
     } else {
       capsKey = key
     }
-    let keyToDisplay = shiftButtonState == .normal ? key : capsKey
+    let keyToDisplay = shiftButtonState == .shift || capsLockButtonState == .locked ? capsKey : key
     setTitleColor(keyCharColor, for: .normal)
     layer.setValue(key, forKey: "original")
     layer.setValue(keyToDisplay, forKey: "keyToDisplay")
@@ -256,22 +256,14 @@ class KeyboardKey: UIButton {
     if key == "ABC" || key == "АБВ" {
       layer.setValue(true, forKey: "isSpecial")
       widthAnchor.constraint(equalToConstant: numSymKeyWidth * 1).isActive = true
-    } else if key == "delete"
-      || key == "#+="
-      || key == "shift"
-      || key == "selectKeyboard"
-    {
+    } else if ["delete", "#+=", "shift", "selectKeyboard", SpecialKeys.indent, SpecialKeys.capsLock].contains(key) {
       layer.setValue(true, forKey: "isSpecial")
       widthAnchor.constraint(equalToConstant: numSymKeyWidth * 1).isActive = true
-    } else if key == "123"
-      || key == ".?123"
-      || key == "return"
-      || key == "hideKeyboard"
-    {
+    } else if ["123", ".?123", "return", "hideKeyboard"].contains(key) {
       if key == "return"
-        && (controllerLanguage == "Portuguese" || controllerLanguage == "Italian" || commandState == .translate)
-        && row == 1
-        && DeviceType.isPad
+          && (controllerLanguage == "Portuguese" || controllerLanguage == "Italian" || commandState == .translate)
+          && row == 1
+          && DeviceType.isPad
       {
         layer.setValue(true, forKey: "isSpecial")
         widthAnchor.constraint(equalToConstant: numSymKeyWidth * 1.5).isActive = true
@@ -291,25 +283,54 @@ class KeyboardKey: UIButton {
     } else if DeviceType.isPad {
       adjustPadKeyWidth()
     }
+  }
 
+  /// Adjusts the style of the button based on different states.
+  func adjustButtonStyle() {
     guard let isSpecial = layer.value(forKey: "isSpecial") as? Bool else { return }
 
-    if key == "shift" {
-      // Switch the shift key icon given its state.
+    switch key {
+    case SpecialKeys.indent:
+      backgroundColor = specialKeyColor
+
+    case SpecialKeys.capsLock:
+      switch capsLockButtonState {
+
+      case .normal:
+        backgroundColor = specialKeyColor
+        styleIconBtn(btn: self, color: UIColor.label, iconName: "capslock")
+
+      case .locked:
+        backgroundColor = keyPressedColor
+        styleIconBtn(btn: self, color: UIColor.label, iconName: "capslock.fill")
+      }
+
+    case "shift":
       if shiftButtonState == .shift {
         backgroundColor = keyPressedColor
+
         styleIconBtn(btn: self, color: UIColor.label, iconName: "shift.fill")
-      } else if shiftButtonState == .caps {
+      } else if DeviceType.isPhone && capsLockButtonState == .locked {
+        // We need to style the SHIFT button instead of the CAPSLOCK since the keyboard is smaller
         backgroundColor = keyPressedColor
+
         styleIconBtn(btn: self, color: UIColor.label, iconName: "capslock.fill")
       } else {
         backgroundColor = specialKeyColor
       }
-    } else if key == "return" && [.translate, .conjugate, .plural].contains(commandState) {
-      // Color the return key depending on if it's being used as enter for commands.
-      backgroundColor = commandKeyColor
-    } else if isSpecial {
-      backgroundColor = specialKeyColor
+
+    case "return":
+      if [.translate, .conjugate, .plural].contains(commandState) {
+        // Color the return key depending on if it's being used as enter for commands.
+        backgroundColor = commandKeyColor
+      } else {
+        backgroundColor = specialKeyColor
+      }
+
+    default:
+      if isSpecial {
+        backgroundColor = specialKeyColor
+      }
     }
   }
 }

Keyboards/KeyboardsBase/KeyboardStyling.swift

@@ -40,7 +40,9 @@ var keysThatAreSlightlyLarger = [
   "chevron.right",
   "shift",
   "shift.fill",
+  "capslock",
   "capslock.fill",
+  "arrow.forward.to.line",
   "arrowtriangle.right.fill",
 ]
 

Keyboards/KeyboardsBase/KeyboardViewController.swift

@@ -406,7 +406,9 @@ class KeyboardViewController: UIInputViewController {
           var i = 0
           if completionOptions.count <= 3 {
             while i < completionOptions.count {
-              if shiftButtonState == .caps {
+              if shiftButtonState == .shift {
+                completionWords[i] = completionOptions[i].capitalize()
+              } else if capsLockButtonState == .locked {
                 completionWords[i] = completionOptions[i].uppercased()
               } else if currentPrefix.isCapitalized {
                 if completionOptions[i].isUppercase {
@@ -421,7 +423,9 @@ class KeyboardViewController: UIInputViewController {
             }
           } else {
             while i < 3 {
-              if shiftButtonState == .caps {
+              if shiftButtonState == .shift {
+                completionWords[i] = completionOptions[i].capitalize()
+              } else if capsLockButtonState == .locked {
                 completionWords[i] = completionOptions[i].uppercased()
               } else if currentPrefix.isCapitalized {
                 if completionOptions[i].isUppercase {
@@ -472,7 +476,7 @@ class KeyboardViewController: UIInputViewController {
       }
       if shiftButtonState == .shift {
         completionWords.append(suggestion.capitalize())
-      } else if shiftButtonState == .caps {
+      } else if capsLockButtonState == .locked {
         completionWords.append(suggestion.uppercased())
       } else {
         completionWords.append(suggestion)
@@ -492,7 +496,7 @@ class KeyboardViewController: UIInputViewController {
     while i < 3 {
       if shiftButtonState == .shift {
         completionWords.append(baseAutosuggestions[i].capitalize())
-      } else if shiftButtonState == .caps {
+      } else if capsLockButtonState == .locked {
         completionWords.append(baseAutosuggestions[i].uppercased())
       } else {
         completionWords.append(baseAutosuggestions[i])
@@ -547,7 +551,7 @@ class KeyboardViewController: UIInputViewController {
         while i < 3 {
           if shiftButtonState == .shift {
             completionWords.append(suggestionsLowerCasePrefix[i].capitalize())
-          } else if shiftButtonState == .caps {
+          } else if capsLockButtonState == .locked {
             completionWords.append(suggestionsLowerCasePrefix[i].uppercased())
           } else {
             let nounGenderQuery = "SELECT * FROM nouns WHERE noun = ?"
@@ -574,7 +578,7 @@ class KeyboardViewController: UIInputViewController {
         while i < 3 {
           if shiftButtonState == .shift {
             completionWords.append(suggestionsCapitalizedPrefix[i].capitalize())
-          } else if shiftButtonState == .caps {
+          } else if capsLockButtonState == .locked {
             completionWords.append(suggestionsCapitalizedPrefix[i].uppercased())
           } else {
             completionWords.append(suggestionsCapitalizedPrefix[i])
@@ -1875,6 +1879,14 @@ class KeyboardViewController: UIInputViewController {
             styleIconBtn(btn: btn, color: keyCharColor, iconName: "keyboard.chevron.compact.down")
           }
 
+          if key == SpecialKeys.indent {
+            styleIconBtn(btn: btn, color: keyCharColor, iconName: "arrow.forward.to.line")
+          }
+
+          if key == SpecialKeys.capsLock {
+            styleIconBtn(btn: btn, color: keyCharColor, iconName: "capslock")
+          }
+
           if key == "shift" {
             styleIconBtn(btn: btn, color: keyCharColor, iconName: "shift")
           }
@@ -1925,6 +1937,10 @@ class KeyboardViewController: UIInputViewController {
 
           // Set the width of the key given device and the given key.
           btn.adjustKeyWidth()
+
+          // Update the button style
+          btn.adjustButtonStyle()
+
           if key == "return" && proxy.keyboardType == .webSearch && ![.translate, .conjugate, .plural].contains(commandState) {
             // Override background color from adjustKeyWidth for "search" blue for web searches.
             styleIconBtn(btn: btn, color: .white.withAlphaComponent(0.9), iconName: "arrow.turn.down.left")
@@ -2482,7 +2498,14 @@ class KeyboardViewController: UIInputViewController {
       }
 
     case "shift":
-      shiftButtonState = shiftButtonState == .normal ? .shift : .normal
+      if capsLockButtonState == .locked {
+        // Return capitalization to default
+        capsLockButtonState = .normal
+        shiftButtonState = .normal
+      } else {
+        shiftButtonState = shiftButtonState == .normal ? .shift : .normal
+      }
+
       loadKeys()
       capsLockPossible = true
 
@@ -2496,6 +2519,12 @@ class KeyboardViewController: UIInputViewController {
       changeKeyboardToLetterKeys()
       autoCapAtStartOfProxy()
 
+    case SpecialKeys.capsLock:
+      switchToFullCaps()
+
+    case SpecialKeys.indent:
+      proxy.insertText("\t")
+
     case "selectKeyboard":
       advanceToNextInputMode()
 
@@ -2612,9 +2641,7 @@ class KeyboardViewController: UIInputViewController {
 
     // Caps lock given two taps of shift.
     if touch.tapCount == 2 && originalKey == "shift" && capsLockPossible {
-      shiftButtonState = .caps
-      loadKeys()
-      conditionallySetAutoActionBtns()
+      switchToFullCaps()
     }
 
     // To make sure that the user can still use the double space period shortcut after numbers and symbols.
@@ -2657,6 +2684,15 @@ class KeyboardViewController: UIInputViewController {
     }
   }
 
+  private func switchToFullCaps() {
+    // Return SHIFT button to normal state as the ALLCAPS button will be enabled
+    shiftButtonState = .normal
+    capsLockButtonState = capsLockButtonState == .normal ? .locked : .normal
+
+    loadKeys()
+    conditionallySetAutoActionBtns()
+  }
+
   /// Defines the criteria under which delete is long pressed.
   ///
   /// - Parameters

Keyboards/KeyboardsBase/ScribeFunctionality/Annotate.swift

@@ -229,18 +229,23 @@ func selectedWordAnnotation(KVC: KeyboardViewController) {
 /// - Parameters
 ///   - KVC: the keyboard view controller.
 func typedWordAnnotation(KVC: KeyboardViewController) {
-  if proxy.documentContextBeforeInput?.count != 0 {
-    wordsTyped = proxy.documentContextBeforeInput!.components(separatedBy: " ")
-    let lastWordTyped = wordsTyped.secondToLast()
-    if !languagesWithCapitalizedNouns.contains(controllerLanguage) {
-      wordToCheck = lastWordTyped!.lowercased()
-    } else {
-      wordToCheck = lastWordTyped!
-    }
-    wordAnnotation(wordToAnnotate: wordToCheck, KVC: KVC)
-  } else {
+  guard let documentContextBeforeInput = proxy.documentContextBeforeInput, !documentContextBeforeInput.isEmpty else {
+    return
+  }
+
+  wordsTyped = documentContextBeforeInput.components(separatedBy: " ")
+
+  guard let lastWordTyped = wordsTyped.secondToLast() else {
     return
   }
+
+  if !languagesWithCapitalizedNouns.contains(controllerLanguage) {
+    wordToCheck = lastWordTyped.lowercased()
+  } else {
+    wordToCheck = lastWordTyped
+  }
+
+  wordAnnotation(wordToAnnotate: wordToCheck, KVC: KVC)
 }
 
 /// Annotates nouns during autocomplete and autosuggest.

Keyboards/LanguageKeyboards/Danish/DAInterfaceVariables.swift

@@ -55,16 +55,16 @@ public enum DanishKeyboardConstants {
   // Expanded iPad keyboard layouts for wider devices.
   static let letterKeysPadExpanded = [
     ["$", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "+", "'", "delete"],
-    ["indent", "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "å", "@", "*"],
-    ["uppercase", "a", "s", "d", "f", "g", "h", "j", "k", "l", "æ", "ø", "'", "return"],
+    [SpecialKeys.indent, "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "å", "@", "*"],
+    [SpecialKeys.capsLock, "a", "s", "d", "f", "g", "h", "j", "k", "l", "æ", "ø", "'", "return"],
     ["shift", "<", "z", "x", "c", "v", "b", "n", "m", ",", ".", "-", "shift"],
     ["selectKeyboard", ".?123", "space", ".?123", "hideKeyboard"], // "microphone", "scribble"
   ]
 
   static let symbolKeysPadExpanded = [
     ["`", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "<", ">", "delete"],
-    ["indent", "[", "]", "{", "}", "#", "%", "^", "*", "+", "=", "\"", "|"],
-    ["uppercase", "-", "/", ":", ";", "(", ")", "$", "&", "@", "£", "¥", "~", "return"], // "undo"
+    [SpecialKeys.indent, "[", "]", "{", "}", "#", "%", "^", "*", "+", "=", "\"", "|"],
+    [SpecialKeys.capsLock, "-", "/", ":", ";", "(", ")", "$", "&", "@", "£", "¥", "~", "return"], // "undo"
     ["shift", "...", ".", ",", "?", "!", "'", "\"", "_", "€"], // "redo"
     ["selectKeyboard", "ABC", "space", "ABC", "hideKeyboard"], // "microphone", "scribble"
   ]

Keyboards/LanguageKeyboards/English/ENInterfaceVariables.swift

@@ -55,16 +55,16 @@ public enum EnglishKeyboardConstants {
   // Expanded iPad keyboard layouts for wider devices.
   static let letterKeysPadExpanded = [
     ["`", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "-", "=", "delete"],
-    ["indent", "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "[", "]", "\\"],
-    ["uppercase", "a", "s", "d", "f", "g", "h", "j", "k", "l", ";", "'", "return"],
+    [SpecialKeys.indent, "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "[", "]", "\\"],
+    [SpecialKeys.capsLock, "a", "s", "d", "f", "g", "h", "j", "k", "l", ";", "'", "return"],
     ["shift", "z", "x", "c", "v", "b", "n", "m", ",", ".", "/", "shift"],
     ["selectKeyboard", ".?123", "space", ".?123", "hideKeyboard"], // "microphone", "scribble"
   ]
 
   static let symbolKeysPadExpanded = [
     ["`", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "<", ">", "delete"],
-    ["indent", "[", "]", "{", "}", "#", "%", "^", "*", "+", "=", "\"", "~"],
-    ["uppercase", "-", "/", ":", ";", "(", ")", "$", "&", "@", "£", "¥", "return"], // "undo"
+    [SpecialKeys.indent, "[", "]", "{", "}", "#", "%", "^", "*", "+", "=", "\"", "~"],
+    [SpecialKeys.capsLock, "-", "/", ":", ";", "(", ")", "$", "&", "@", "£", "¥", "return"], // "undo"
     ["shift", "...", ".", ",", "?", "!", "'", "\"", "_", "€"], // "redo"
     ["selectKeyboard", "ABC", "space", "ABC", "hideKeyboard"], // "microphone", "scribble"
   ]