diff --git a/install/examples/ConsoleKeyRead.os b/install/examples/ConsoleKeyRead.os new file mode 100644 index 000000000..37649907e --- /dev/null +++ b/install/examples/ConsoleKeyRead.os @@ -0,0 +1,23 @@ +Пока Истина Цикл + + Нажатие = Консоль.ПрочитатьНажатие(); + + Сообщить("Нажатие: " + Строка(Нажатие)); + Сообщить("Код кнопки: " + Нажатие.КодКнопки); + + Если Нажатие.Control Тогда + Сообщить("Ctrl + " + Нажатие.Символ); + ИначеЕсли Нажатие.Shift Тогда + Сообщить("Shift + " + Нажатие.Символ); + ИначеЕсли Нажатие.Alt Тогда + Сообщить("Alt + " + Нажатие.Символ); + Иначе + Сообщить(Нажатие.Символ); + КонецЕсли; + + Если Нажатие.КодКнопки = 27 Тогда // Escape + Сообщить("Выход"); + Прервать; + КонецЕсли; + +КонецЦикла; \ No newline at end of file diff --git a/src/OneScript.StandardLibrary/Text/ConsoleContext.cs b/src/OneScript.StandardLibrary/Text/ConsoleContext.cs index 6648f666b..f24c10a3a 100644 --- a/src/OneScript.StandardLibrary/Text/ConsoleContext.cs +++ b/src/OneScript.StandardLibrary/Text/ConsoleContext.cs @@ -89,6 +89,40 @@ public int ReadKey() return (int)kki.Key; } + /// + /// Читает нажатие клавиши и возвращает подробное описание нажатия. + /// В отличие от , возвращает не только код клавиши, но и введённый символ + /// (в том числе кириллический), а также состояние модификаторов. + /// Символ не выводится в консоль (чтение выполняется без эха). + /// + /// + /// Объект со свойствами: + /// + /// КодКнопки — код клавиши (значение перечисления ), + /// совпадает с результатом ; + /// Символ — введённый символ; пустая строка для служебных клавиш + /// и управляющих сочетаний; + /// Shift, Alt, Control — булевы признаки удержанных + /// модификаторов. + /// + /// + /// + /// Возможности платформы различаются: + /// + /// в Windows код клавиши и состояние модификаторов определяются + /// для любых нажатий; + /// в Unix-подобных системах .NET распознаёт клавиши и модификаторы только для известных + /// символов и управляющих последовательностей. Для символов за пределами ASCII (в том числе кириллицы) + /// КодКнопки может быть равен 0, а Shift для заглавной кириллической буквы может не определиться + /// (при этом сам символ всегда возвращается в поле Символ). + /// + /// + [ContextMethod("ПрочитатьНажатие", "ReadKeyPress")] + public ConsoleKeyPress ReadKeyPress() + { + return new ConsoleKeyPress(Console.ReadKey(true)); + } + [ContextMethod("Очистить", "Clear")] public void Clear() { diff --git a/src/OneScript.StandardLibrary/Text/ConsoleKeyPress.cs b/src/OneScript.StandardLibrary/Text/ConsoleKeyPress.cs new file mode 100644 index 000000000..e2c676bb4 --- /dev/null +++ b/src/OneScript.StandardLibrary/Text/ConsoleKeyPress.cs @@ -0,0 +1,89 @@ +/*---------------------------------------------------------- +This Source Code Form is subject to the terms of the +Mozilla Public License, v.2.0. If a copy of the MPL +was not distributed with this file, You can obtain one +at http://mozilla.org/MPL/2.0/. +----------------------------------------------------------*/ + +using System; +using System.Collections.Generic; +using OneScript.Contexts; +using ScriptEngine.Machine.Contexts; + +namespace OneScript.StandardLibrary.Text +{ + /// + /// Описание нажатия клавиши, полученное методом . + /// Содержит код клавиши, введённый символ и состояние модификаторов. + /// + /// + /// Свойства объекта доступны только для чтения и имеют два имени — русское и английское. + /// Как и любой результат чтения консоли, объект нельзя создать оператором Новый: + /// он возвращается только методом . + /// + [ContextClass("НажатиеКлавиши", "KeyPress")] + public class ConsoleKeyPress : AutoContext + { + private readonly ConsoleKeyInfo _keyInfo; + + internal ConsoleKeyPress(ConsoleKeyInfo keyInfo) + { + _keyInfo = keyInfo; + } + + /// + /// Код нажатой клавиши. Совпадает со значением, которое возвращает . + /// + [ContextProperty("КодКнопки", "KeyCode", CanWrite = false)] + public int KeyCode => (int)_keyInfo.Key; + + /// + /// Введённый символ, в том числе кириллический. + /// Для служебных клавиш и управляющих сочетаний содержит пустую строку. + /// + [ContextProperty("Символ", "Symbol", CanWrite = false)] + public string Symbol => char.IsControl(_keyInfo.KeyChar) ? string.Empty : _keyInfo.KeyChar.ToString(); + + /// + /// Признак того, что при нажатии была удержана клавиша Shift. + /// + [ContextProperty("Shift", CanWrite = false)] + public bool Shift => (_keyInfo.Modifiers & ConsoleModifiers.Shift) != 0; + + /// + /// Признак того, что при нажатии была удержана клавиша Alt. + /// + [ContextProperty("Alt", CanWrite = false)] + public bool Alt => (_keyInfo.Modifiers & ConsoleModifiers.Alt) != 0; + + /// + /// Признак того, что при нажатии была удержана клавиша Control (Ctrl). + /// + [ContextProperty("Control", CanWrite = false)] + public bool Control => (_keyInfo.Modifiers & ConsoleModifiers.Control) != 0; + + public override string ToString() + { + var keyPresentation = Symbol.Length != 0 ? Symbol : _keyInfo.Key.ToString(); + var modifiersPresentation = GetModifiersPresentation(); + + return modifiersPresentation.Length != 0 + ? string.Concat(modifiersPresentation, "+", keyPresentation) + : keyPresentation; + } + + private string GetModifiersPresentation() + { + var modifiers = new List(3); + + if (Shift) + modifiers.Add("Shift"); + if (Alt) + modifiers.Add("Alt"); + if (Control) + modifiers.Add("Control"); + + return string.Join("+", modifiers); + } + } +} diff --git a/src/Tests/OneScript.StandardLibrary.Tests/ConsoleContextTests.cs b/src/Tests/OneScript.StandardLibrary.Tests/ConsoleContextTests.cs new file mode 100644 index 000000000..8a70ec9a0 --- /dev/null +++ b/src/Tests/OneScript.StandardLibrary.Tests/ConsoleContextTests.cs @@ -0,0 +1,160 @@ +/*---------------------------------------------------------- +This Source Code Form is subject to the terms of the +Mozilla Public License, v.2.0. If a copy of the MPL +was not distributed with this file, You can obtain one +at http://mozilla.org/MPL/2.0/. +----------------------------------------------------------*/ + +using System; +using System.Reflection; +using OneScript.Contexts; +using OneScript.StandardLibrary.Text; +using OneScript.Values; +using ScriptEngine.Machine; +using Xunit; + +namespace OneScript.StandardLibrary.Tests +{ + public class ConsoleContextTests + { + private static ConsoleKeyPress CreateKeyPress(ConsoleKeyInfo keyInfo) => new ConsoleKeyPress(keyInfo); + + private static IValue GetProperty(ConsoleKeyPress keyPress, string name) => + keyPress.GetPropValue(keyPress.GetPropertyNumber(name)); + + private static int GetKeyCode(ConsoleKeyPress keyPress, string name) => + (BslNumericValue)GetProperty(keyPress, name); + + private static string GetString(ConsoleKeyPress keyPress, string name) => + (BslStringValue)GetProperty(keyPress, name); + + private static bool GetBoolean(ConsoleKeyPress keyPress, string name) => + (bool)(BslBooleanValue)GetProperty(keyPress, name); + + [Fact] + public void ReadKeyPress_Is_Exposed_With_Bilingual_Name() + { + var method = typeof(ConsoleContext).GetMethod(nameof(ConsoleContext.ReadKeyPress)); + + Assert.NotNull(method); + Assert.Equal(typeof(ConsoleKeyPress), method.ReturnType); + + var attribute = method!.GetCustomAttribute(); + Assert.NotNull(attribute); + Assert.Equal("ПрочитатьНажатие", attribute!.Name); + Assert.Equal("ReadKeyPress", attribute.Alias); + } + + [Fact] + public void KeyPress_Type_Has_Bilingual_Names() + { + var attribute = typeof(ConsoleKeyPress).GetCustomAttribute(); + + Assert.NotNull(attribute); + Assert.Equal("НажатиеКлавиши", attribute!.Name); + Assert.Equal("KeyPress", attribute.Alias); + + var keyPress = CreateKeyPress(new ConsoleKeyInfo('a', ConsoleKey.A, false, false, false)); + + Assert.Equal("НажатиеКлавиши", keyPress.SystemType.Name); + Assert.Equal("KeyPress", keyPress.SystemType.Alias); + } + + [Fact] + public void KeyPress_Exposes_Expected_Properties() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo('a', ConsoleKey.A, false, false, false)); + + Assert.Equal(5, keyPress.GetPropCount()); + Assert.Equal("КодКнопки", keyPress.GetPropName(0)); + Assert.Equal("Символ", keyPress.GetPropName(1)); + Assert.Equal("Shift", keyPress.GetPropName(2)); + Assert.Equal("Alt", keyPress.GetPropName(3)); + Assert.Equal("Control", keyPress.GetPropName(4)); + } + + [Fact] + public void KeyPress_Properties_Are_ReadOnly() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo('a', ConsoleKey.A, false, false, false)); + + for (var i = 0; i < keyPress.GetPropCount(); i++) + { + Assert.True(keyPress.IsPropReadable(i)); + Assert.False(keyPress.IsPropWritable(i)); + } + } + + [Fact] + public void KeyPress_Properties_Are_Accessible_By_English_Names() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo('a', ConsoleKey.A, false, false, false)); + + Assert.Equal(keyPress.GetPropertyNumber("КодКнопки"), keyPress.GetPropertyNumber("KeyCode")); + Assert.Equal(keyPress.GetPropertyNumber("Символ"), keyPress.GetPropertyNumber("Symbol")); + Assert.Equal(keyPress.GetPropertyNumber("Shift"), keyPress.GetPropertyNumber("Shift")); + Assert.Equal(keyPress.GetPropertyNumber("Alt"), keyPress.GetPropertyNumber("Alt")); + Assert.Equal(keyPress.GetPropertyNumber("Control"), keyPress.GetPropertyNumber("Control")); + + Assert.Equal((int)ConsoleKey.A, GetKeyCode(keyPress, "KeyCode")); + Assert.Equal("a", GetString(keyPress, "Symbol")); + } + + [Fact] + public void KeyPress_Returns_Cyrillic_Symbol() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo('ф', (ConsoleKey)0, false, false, false)); + + Assert.Equal("ф", GetString(keyPress, "Символ")); + Assert.Equal(0, GetKeyCode(keyPress, "КодКнопки")); + Assert.Equal("ф", keyPress.ToString()); + } + + [Fact] + public void KeyPress_Returns_Upper_Case_Cyrillic_Symbol_With_Shift() + { + var keyPress = CreateKeyPress( + new ConsoleKeyInfo('Ф', (ConsoleKey)0, shift: true, alt: true, control: false)); + + Assert.Equal("Ф", GetString(keyPress, "Символ")); + Assert.True(GetBoolean(keyPress, "Shift")); + Assert.True(GetBoolean(keyPress, "Alt")); + Assert.False(GetBoolean(keyPress, "Control")); + Assert.Equal("Shift+Alt+Ф", keyPress.ToString()); + } + + [Fact] + public void KeyPress_Returns_Empty_Symbol_For_Control_Key_Combination() + { + // Ctrl+A: .NET сообщает управляющий символ и код клавиши A + var keyPress = CreateKeyPress( + new ConsoleKeyInfo('\u0001', ConsoleKey.A, shift: false, alt: false, control: true)); + + Assert.Equal(string.Empty, GetString(keyPress, "Символ")); + Assert.Equal((int)ConsoleKey.A, GetKeyCode(keyPress, "КодКнопки")); + Assert.True(GetBoolean(keyPress, "Control")); + Assert.False(GetBoolean(keyPress, "Shift")); + Assert.False(GetBoolean(keyPress, "Alt")); + Assert.Equal("Control+A", keyPress.ToString()); + } + + [Fact] + public void KeyPress_Returns_Empty_Symbol_For_Function_Key() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo('\0', ConsoleKey.F1, false, false, false)); + + Assert.Equal(string.Empty, GetString(keyPress, "Символ")); + Assert.Equal((int)ConsoleKey.F1, GetKeyCode(keyPress, "КодКнопки")); + Assert.Equal("F1", keyPress.ToString()); + } + + [Fact] + public void KeyPress_Keeps_Space_As_Symbol() + { + var keyPress = CreateKeyPress(new ConsoleKeyInfo(' ', ConsoleKey.Spacebar, false, false, false)); + + Assert.Equal(" ", GetString(keyPress, "Символ")); + Assert.Equal(" ", keyPress.ToString()); + } + } +} diff --git a/tests/console.os b/tests/console.os index 45a0ab981..e9f7700ba 100644 --- a/tests/console.os +++ b/tests/console.os @@ -20,6 +20,8 @@ ВсеТесты.Добавить("ТестДолжен_ПроверитьЧтоЗаданиеПолучаетУнаследованныйПотокВывода"); ВсеТесты.Добавить("ТестДолжен_ПроверитьСменуКодировкиВыводаПослеПеренаправленияВЗадании"); ВсеТесты.Добавить("ТестДолжен_ПроверитЦветКонсоли"); + ВсеТесты.Добавить("ТестДолжен_ПроверитьНаличиеМетодаПрочитатьНажатие"); + ВсеТесты.Добавить("ТестДолжен_ПроверитьТипНажатиеКлавиши"); Возврат ВсеТесты; @@ -368,3 +370,43 @@ юТест.ПроверитьТип(ЦветФона, "ЦветКонсоли"); КонецПроцедуры + +Процедура ТестДолжен_ПроверитьНаличиеМетодаПрочитатьНажатие() Экспорт + + Рефлектор = Новый Рефлектор; + ТаблицаМетодов = Рефлектор.ПолучитьТаблицуМетодов(Консоль); + + Найден = Ложь; + Для Каждого СтрокаМетода Из ТаблицаМетодов Цикл + Если СтрокаМетода.Имя = "ПрочитатьНажатие" Тогда + Найден = Истина; + юТест.ПроверитьРавенство(0, СтрокаМетода.КоличествоПараметров, "Метод ПрочитатьНажатие не должен требовать параметров"); + юТест.ПроверитьИстину(СтрокаМетода.ЭтоФункция, "Метод ПрочитатьНажатие должен быть функцией"); + КонецЕсли; + КонецЦикла; + + юТест.ПроверитьИстину(Найден, "Метод Консоль.ПрочитатьНажатие должен быть доступен"); + +КонецПроцедуры + +Процедура ТестДолжен_ПроверитьТипНажатиеКлавиши() Экспорт + + ТипНажатия = Тип("НажатиеКлавиши"); + юТест.ПроверитьРавенство(Тип("KeyPress"), ТипНажатия, "Тип НажатиеКлавиши должен иметь английское имя KeyPress"); + + Рефлектор = Новый Рефлектор; + ТаблицаСвойств = Рефлектор.ПолучитьТаблицуСвойств(ТипНажатия); + ИменаСвойств = Новый Массив; + Для Каждого СтрокаСвойства Из ТаблицаСвойств Цикл + ИменаСвойств.Добавить(СтрокаСвойства.Имя); + КонецЦикла; + + ОжидаемыеСвойства = СтрРазделить("КодКнопки,Символ,Shift,Alt,Control", ","); + юТест.ПроверитьРавенство(ОжидаемыеСвойства.Количество(), ИменаСвойств.Количество(), + "У типа НажатиеКлавиши должно быть 5 свойств"); + Для Каждого ОжидаемоеСвойство Из ОжидаемыеСвойства Цикл + юТест.ПроверитьИстину(ИменаСвойств.Найти(ОжидаемоеСвойство) <> Неопределено, + "У типа НажатиеКлавиши должно быть свойство " + ОжидаемоеСвойство); + КонецЦикла; + +КонецПроцедуры