code generation support for "keymod"

Author: kbilsted

ToolsForMaintainersOfTheProjectTemplate/Scintilla_iface_synchronizer/cs.py

@@ -27,7 +27,7 @@ def printLexCSFile(f):
 	return out
 
 def isTypeUnsupported(t):
-	if t in ["keymod", "formatrange"]: return True
+	if t in ["formatrange"]: return True
 	return False
 
 def translateType(t):
@@ -36,14 +36,15 @@ def translateType(t):
 	if t == "position": return "Position"
 	if t == "textrange": return "TextRange"
 	if t == "findtext": return "TextToFind"
+	if t == "keymod": return "KeyModifier"
 	return t
 
 def translateVariableAccess(name, type):
 	if type == "bool": return name + " ? 1 : 0"
 	if type in ["string", "stringresult", "Cells"]: return "(IntPtr) " +name+ "Ptr"
 
 	res = name if name else "Unused"
-	if type in ["Colour", "Position"]:
+	if type in ["Colour", "Position", "KeyModifier"]:
 		res += ".Value"
 	if type in ["TextRange", "TextToFind"]: 
 		res += ".NativePointer"

Visual Studio Project Template C#/GatewayDomain.cs

@@ -75,6 +75,41 @@ public int Value
         }
     }
 
+    /// <summary>
+    /// Class containing key and modifiers 
+    ///
+    /// The key code is a visible or control character or a key from the SCK_* enumeration, which contains:
+    /// SCK_ADD, SCK_BACK, SCK_DELETE, SCK_DIVIDE, SCK_DOWN, SCK_END, SCK_ESCAPE, SCK_HOME, SCK_INSERT, SCK_LEFT, SCK_MENU, SCK_NEXT(Page Down), SCK_PRIOR(Page Up), S
+    /// CK_RETURN, SCK_RIGHT, SCK_RWIN, SCK_SUBTRACT, SCK_TAB, SCK_UP, and SCK_WIN.
+    ///
+    /// The modifiers are a combination of zero or more of SCMOD_ALT, SCMOD_CTRL, SCMOD_SHIFT, SCMOD_META, and SCMOD_SUPER. 
+    /// On OS X, the Command key is mapped to SCMOD_CTRL and the Control key to SCMOD_META.SCMOD_SUPER is only available on GTK+ which is commonly the Windows key. 
+    /// If you are building a table, you might want to use SCMOD_NORM, which has the value 0, to mean no modifiers.
+    /// </summary>
+    public class KeyModifier
+    {
+        private readonly int value;
+
+        /// <summary>
+        /// The key code is a visible or control character or a key from the SCK_* enumeration, which contains:
+        /// SCK_ADD, SCK_BACK, SCK_DELETE, SCK_DIVIDE, SCK_DOWN, SCK_END, SCK_ESCAPE, SCK_HOME, SCK_INSERT, SCK_LEFT, SCK_MENU, SCK_NEXT(Page Down), SCK_PRIOR(Page Up), 
+        /// SCK_RETURN, SCK_RIGHT, SCK_RWIN, SCK_SUBTRACT, SCK_TAB, SCK_UP, and SCK_WIN.
+        ///
+        /// The modifiers are a combination of zero or more of SCMOD_ALT, SCMOD_CTRL, SCMOD_SHIFT, SCMOD_META, and SCMOD_SUPER. 
+        /// On OS X, the Command key is mapped to SCMOD_CTRL and the Control key to SCMOD_META.SCMOD_SUPER is only available on GTK+ which is commonly the Windows key. 
+        /// If you are building a table, you might want to use SCMOD_NORM, which has the value 0, to mean no modifiers.
+        /// </summary>
+        public KeyModifier(SciMsg SCK_KeyCode, SciMsg SCMOD_modifier)
+        {
+            value = (int) SCK_KeyCode | ((int) SCMOD_modifier << 16);
+        }
+
+        public int Value
+        {
+            get { return Value; }
+        }
+    }
+
     [StructLayout(LayoutKind.Sequential)]
     public struct CharacterRange
     {

Visual Studio Project Template C#/IScintillaGateway.cs

@@ -400,6 +400,12 @@ public interface IScintillaGateway
         /// <summary>Set the foreground colour of the caret. (Scintilla feature 2069)</summary>
         void SetCaretFore(Colour fore);
 
+        /// <summary>When key+modifier combination km is pressed perform msg. (Scintilla feature 2070)</summary>
+        void AssignCmdKey(KeyModifier km, int msg);
+
+        /// <summary>When key+modifier combination km is pressed do nothing. (Scintilla feature 2071)</summary>
+        void ClearCmdKey(KeyModifier km);
+
         /// <summary>Drop all key mappings. (Scintilla feature 2072)</summary>
         void ClearAllCmdKeys();
 

Visual Studio Project Template C#/ScintillaGateway.cs

@@ -852,6 +852,18 @@ public void SetCaretFore(Colour fore)
             IntPtr res = Win32.SendMessage(scintilla, SciMsg.SCI_SETCARETFORE, fore.Value, Unused);
         }
 
+        /// <summary>When key+modifier combination km is pressed perform msg. (Scintilla feature 2070)</summary>
+        public void AssignCmdKey(KeyModifier km, int msg)
+        {
+            IntPtr res = Win32.SendMessage(scintilla, SciMsg.SCI_ASSIGNCMDKEY, km.Value, msg);
+        }
+
+        /// <summary>When key+modifier combination km is pressed do nothing. (Scintilla feature 2071)</summary>
+        public void ClearCmdKey(KeyModifier km)
+        {
+            IntPtr res = Win32.SendMessage(scintilla, SciMsg.SCI_CLEARCMDKEY, km.Value, Unused);
+        }
+
         /// <summary>Drop all key mappings. (Scintilla feature 2072)</summary>
         public void ClearAllCmdKeys()
         {