diff --git a/.github/actions/spell-check/expect.txt b/.github/actions/spell-check/expect.txt index beae360464..0f2d1b0f7b 100644 --- a/.github/actions/spell-check/expect.txt +++ b/.github/actions/spell-check/expect.txt @@ -1246,6 +1246,7 @@ LOGMSG logon LOGPIXELSX LOn +lookbehind lowlevel lowlevelkb LOWORD diff --git a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameLocalProperties.cs b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameLocalProperties.cs index 2bed187bcd..5812b2a082 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameLocalProperties.cs +++ b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameLocalProperties.cs @@ -16,6 +16,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library MaxMRUSize = 0; ShowIcon = false; ExtendedContextMenuOnly = false; + UseBoostLib = false; } private int _maxSize; @@ -48,6 +49,8 @@ namespace Microsoft.PowerToys.Settings.UI.Library public bool ExtendedContextMenuOnly { get; set; } + public bool UseBoostLib { get; set; } + public string ToJsonString() { return JsonSerializer.Serialize(this); diff --git a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameProperties.cs b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameProperties.cs index 1c64f119d3..6cc5bc4b3d 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameProperties.cs +++ b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameProperties.cs @@ -15,6 +15,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library MaxMRUSize = new IntProperty(); ShowIcon = new BoolProperty(); ExtendedContextMenuOnly = new BoolProperty(); + UseBoostLib = new BoolProperty(); Enabled = new BoolProperty(); } @@ -34,5 +35,8 @@ namespace Microsoft.PowerToys.Settings.UI.Library [JsonPropertyName("bool_show_extended_menu")] public BoolProperty ExtendedContextMenuOnly { get; set; } + + [JsonPropertyName("bool_use_boost_lib")] + public BoolProperty UseBoostLib { get; set; } } } diff --git a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameSettings.cs b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameSettings.cs index be74a62ba1..1673dc2f11 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameSettings.cs +++ b/src/core/Microsoft.PowerToys.Settings.UI.Library/PowerRenameSettings.cs @@ -35,6 +35,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library Properties.MaxMRUSize.Value = localProperties.MaxMRUSize; Properties.ShowIcon.Value = localProperties.ShowIcon; Properties.ExtendedContextMenuOnly.Value = localProperties.ExtendedContextMenuOnly; + Properties.UseBoostLib.Value = localProperties.UseBoostLib; Version = "1"; Name = ModuleName; diff --git a/src/core/Microsoft.PowerToys.Settings.UI.Library/ViewModels/PowerRenameViewModel.cs b/src/core/Microsoft.PowerToys.Settings.UI.Library/ViewModels/PowerRenameViewModel.cs index 99ef38b1a9..f437a151b6 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI.Library/ViewModels/PowerRenameViewModel.cs +++ b/src/core/Microsoft.PowerToys.Settings.UI.Library/ViewModels/PowerRenameViewModel.cs @@ -67,6 +67,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library.ViewModels _powerRenameRestoreFlagsOnLaunch = Settings.Properties.PersistState.Value; _powerRenameMaxDispListNumValue = Settings.Properties.MaxMRUSize.Value; _autoComplete = Settings.Properties.MRUEnabled.Value; + _powerRenameUseBoostLib = Settings.Properties.UseBoostLib.Value; _powerRenameEnabled = GeneralSettingsConfig.Enabled.PowerRename; } @@ -76,6 +77,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library.ViewModels private bool _powerRenameRestoreFlagsOnLaunch; private int _powerRenameMaxDispListNumValue; private bool _autoComplete; + private bool _powerRenameUseBoostLib; public bool IsEnabled { @@ -199,6 +201,24 @@ namespace Microsoft.PowerToys.Settings.UI.Library.ViewModels } } + public bool UseBoostLib + { + get + { + return _powerRenameUseBoostLib; + } + + set + { + if (value != _powerRenameUseBoostLib) + { + _powerRenameUseBoostLib = value; + Settings.Properties.UseBoostLib.Value = value; + RaisePropertyChanged(); + } + } + } + public string GetSettingsSubPath() { return _settingsConfigFileFolder + "\\" + ModuleName; diff --git a/src/core/Microsoft.PowerToys.Settings.UI/Strings/en-us/Resources.resw b/src/core/Microsoft.PowerToys.Settings.UI/Strings/en-us/Resources.resw index d019cbaebf..49a0e14420 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI/Strings/en-us/Resources.resw +++ b/src/core/Microsoft.PowerToys.Settings.UI/Strings/en-us/Resources.resw @@ -817,4 +817,11 @@ Window behavior + + Behavior + + + Use Boost library (provides extended features but may use different regex syntax) + Boost is a product name, should not be translated + \ No newline at end of file diff --git a/src/core/Microsoft.PowerToys.Settings.UI/Views/PowerRenamePage.xaml b/src/core/Microsoft.PowerToys.Settings.UI/Views/PowerRenamePage.xaml index 66bb16619e..1429ad2f89 100644 --- a/src/core/Microsoft.PowerToys.Settings.UI/Views/PowerRenamePage.xaml +++ b/src/core/Microsoft.PowerToys.Settings.UI/Views/PowerRenamePage.xaml @@ -90,6 +90,15 @@ Margin="0, 17, 0, 0" IsChecked="{x:Bind Mode=TwoWay, Path=ViewModel.RestoreFlagsOnLaunch}" IsEnabled="{x:Bind Mode=OneWay, Path=ViewModel.IsEnabled}"/> + + + + diff --git a/src/modules/powerrename/UWPui/PowerRenameUWPUI.vcxproj b/src/modules/powerrename/UWPui/PowerRenameUWPUI.vcxproj index 56a7f3db70..b47014a15d 100644 --- a/src/modules/powerrename/UWPui/PowerRenameUWPUI.vcxproj +++ b/src/modules/powerrename/UWPui/PowerRenameUWPUI.vcxproj @@ -146,6 +146,8 @@ + + @@ -153,5 +155,7 @@ + + \ No newline at end of file diff --git a/src/modules/powerrename/UWPui/packages.config b/src/modules/powerrename/UWPui/packages.config index 81f107b8bc..f93921797a 100644 --- a/src/modules/powerrename/UWPui/packages.config +++ b/src/modules/powerrename/UWPui/packages.config @@ -1,4 +1,6 @@  + + \ No newline at end of file diff --git a/src/modules/powerrename/dll/PowerRenameExt.vcxproj b/src/modules/powerrename/dll/PowerRenameExt.vcxproj index 17d52b0aa6..56dc44af79 100644 --- a/src/modules/powerrename/dll/PowerRenameExt.vcxproj +++ b/src/modules/powerrename/dll/PowerRenameExt.vcxproj @@ -218,6 +218,8 @@ + + @@ -225,5 +227,7 @@ + + \ No newline at end of file diff --git a/src/modules/powerrename/dll/Resources.resx b/src/modules/powerrename/dll/Resources.resx index bb6727ab76..2347ab2bc6 100644 --- a/src/modules/powerrename/dll/Resources.resx +++ b/src/modules/powerrename/dll/Resources.resx @@ -144,4 +144,8 @@ Only show the PowerRename menu item on the extended context menu (Shift + Right-click). - \ No newline at end of file + + Use Boost library (provides extended features but may use different regex syntax). + Boost is a product name, should not be translated + + diff --git a/src/modules/powerrename/dll/dllmain.cpp b/src/modules/powerrename/dll/dllmain.cpp index d9aede9323..606add869e 100644 --- a/src/modules/powerrename/dll/dllmain.cpp +++ b/src/modules/powerrename/dll/dllmain.cpp @@ -234,6 +234,11 @@ public: GET_RESOURCE_STRING(IDS_EXTENDED_MENU_INFO), CSettingsInstance().GetExtendedContextMenuOnly()); + settings.add_bool_toggle( + L"bool_use_boost_lib", + GET_RESOURCE_STRING(IDS_USE_BOOST_LIB), + CSettingsInstance().GetUseBoostLib()); + return settings.serialize_to_buffer(buffer, buffer_size); } @@ -252,6 +257,7 @@ public: CSettingsInstance().SetMaxMRUSize(values.get_int_value(L"int_max_mru_size").value()); CSettingsInstance().SetShowIconOnMenu(values.get_bool_value(L"bool_show_icon_on_menu").value()); CSettingsInstance().SetExtendedContextMenuOnly(values.get_bool_value(L"bool_show_extended_menu").value()); + CSettingsInstance().SetUseBoostLib(values.get_bool_value(L"bool_use_boost_lib").value()); CSettingsInstance().Save(); Trace::SettingsChanged(); diff --git a/src/modules/powerrename/dll/packages.config b/src/modules/powerrename/dll/packages.config index 81f107b8bc..f93921797a 100644 --- a/src/modules/powerrename/dll/packages.config +++ b/src/modules/powerrename/dll/packages.config @@ -1,4 +1,6 @@  + + \ No newline at end of file diff --git a/src/modules/powerrename/lib/PowerRenameLib.vcxproj b/src/modules/powerrename/lib/PowerRenameLib.vcxproj index 733319fcb2..552bf6ce25 100644 --- a/src/modules/powerrename/lib/PowerRenameLib.vcxproj +++ b/src/modules/powerrename/lib/PowerRenameLib.vcxproj @@ -189,6 +189,8 @@ + + @@ -196,5 +198,7 @@ + + \ No newline at end of file diff --git a/src/modules/powerrename/lib/PowerRenameRegEx.cpp b/src/modules/powerrename/lib/PowerRenameRegEx.cpp index c3fc84a3e1..1bafd89d76 100644 --- a/src/modules/powerrename/lib/PowerRenameRegEx.cpp +++ b/src/modules/powerrename/lib/PowerRenameRegEx.cpp @@ -1,8 +1,10 @@ #include "pch.h" #include "PowerRenameRegEx.h" +#include "Settings.h" #include #include #include +#include using namespace std; @@ -177,6 +179,8 @@ CPowerRenameRegEx::CPowerRenameRegEx() : // Init to empty strings SHStrDup(L"", &m_searchTerm); SHStrDup(L"", &m_replaceTerm); + + _useBoostLib = CSettingsInstance().GetUseBoostLib(); } CPowerRenameRegEx::~CPowerRenameRegEx() @@ -206,14 +210,29 @@ HRESULT CPowerRenameRegEx::Replace(_In_ PCWSTR source, _Outptr_ PWSTR* result) if (m_flags & UseRegularExpressions) { - std::wregex pattern(m_searchTerm, (!(m_flags & CaseSensitive)) ? regex_constants::icase | regex_constants::ECMAScript : regex_constants::ECMAScript); - if (m_flags & MatchAllOccurences) + if (_useBoostLib) { - res = regex_replace(wstring(source), pattern, replaceTerm); + boost::wregex pattern(m_searchTerm, (!(m_flags & CaseSensitive)) ? boost::regex::icase | boost::regex::ECMAScript : boost::regex::ECMAScript); + if (m_flags & MatchAllOccurences) + { + res = boost::regex_replace(wstring(source), pattern, replaceTerm); + } + else + { + res = boost::regex_replace(wstring(source), pattern, replaceTerm, boost::regex_constants::format_first_only); + } } else { - res = regex_replace(wstring(source), pattern, replaceTerm, regex_constants::format_first_only); + std::wregex pattern(m_searchTerm, (!(m_flags & CaseSensitive)) ? regex_constants::icase | regex_constants::ECMAScript : regex_constants::ECMAScript); + if (m_flags & MatchAllOccurences) + { + res = regex_replace(wstring(source), pattern, replaceTerm); + } + else + { + res = regex_replace(wstring(source), pattern, replaceTerm, regex_constants::format_first_only); + } } } else diff --git a/src/modules/powerrename/lib/PowerRenameRegEx.h b/src/modules/powerrename/lib/PowerRenameRegEx.h index ea2aa2f5c5..1bef0c2885 100644 --- a/src/modules/powerrename/lib/PowerRenameRegEx.h +++ b/src/modules/powerrename/lib/PowerRenameRegEx.h @@ -39,6 +39,7 @@ protected: size_t _Find(std::wstring data, std::wstring toSearch, bool caseInsensitive, size_t pos); + bool _useBoostLib = false; DWORD m_flags = DEFAULT_FLAGS; PWSTR m_searchTerm = nullptr; PWSTR m_replaceTerm = nullptr; diff --git a/src/modules/powerrename/lib/Settings.cpp b/src/modules/powerrename/lib/Settings.cpp index b0d9b87b87..961c8057ae 100644 --- a/src/modules/powerrename/lib/Settings.cpp +++ b/src/modules/powerrename/lib/Settings.cpp @@ -31,6 +31,7 @@ namespace const wchar_t c_mruEnabled[] = L"MRUEnabled"; const wchar_t c_mruList[] = L"MRUList"; const wchar_t c_insertionIdx[] = L"InsertionIdx"; + const wchar_t c_useBoostLib[] = L"UseBoostLib"; unsigned int GetRegNumber(const std::wstring& valueName, unsigned int defaultValue) { @@ -414,6 +415,7 @@ void CSettings::Save() jsonData.SetNamedValue(c_maxMRUSize, json::value(settings.maxMRUSize)); jsonData.SetNamedValue(c_searchText, json::value(settings.searchText)); jsonData.SetNamedValue(c_replaceText, json::value(settings.replaceText)); + jsonData.SetNamedValue(c_useBoostLib, json::value(settings.useBoostLib)); json::to_file(jsonFilePath, jsonData); GetSystemTimeAsFileTime(&lastLoadedTime); @@ -457,6 +459,7 @@ void CSettings::MigrateFromRegistry() settings.flags = GetRegNumber(c_flags, 0); settings.searchText = GetRegString(c_searchText, L""); settings.replaceText = GetRegString(c_replaceText, L""); + settings.useBoostLib = false; // Never existed in registry, disabled by default. } void CSettings::ParseJson() @@ -499,6 +502,10 @@ void CSettings::ParseJson() { settings.replaceText = jsonSettings.GetNamedString(c_replaceText); } + if (json::has(jsonSettings, c_useBoostLib, json::JsonValueType::Boolean)) + { + settings.useBoostLib = jsonSettings.GetNamedBoolean(c_useBoostLib); + } } catch (const winrt::hresult_error&) { } } diff --git a/src/modules/powerrename/lib/Settings.h b/src/modules/powerrename/lib/Settings.h index f91ad4c9ec..dcc3d5f30c 100644 --- a/src/modules/powerrename/lib/Settings.h +++ b/src/modules/powerrename/lib/Settings.h @@ -51,6 +51,16 @@ public: settings.persistState = persistState; } + inline bool GetUseBoostLib() const + { + return settings.useBoostLib; + } + + inline void SetUseBoostLib(bool useBoostLib) + { + settings.useBoostLib = useBoostLib; + } + inline bool GetMRUEnabled() const { return settings.MRUEnabled; @@ -114,6 +124,7 @@ private: bool showIconOnMenu{ true }; bool extendedContextMenuOnly{ false }; // Disabled by default. bool persistState{ true }; + bool useBoostLib{ false }; // Disabled by default. bool MRUEnabled{ true }; unsigned int maxMRUSize{ 10 }; unsigned int flags{ 0 }; diff --git a/src/modules/powerrename/lib/packages.config b/src/modules/powerrename/lib/packages.config index 81f107b8bc..f93921797a 100644 --- a/src/modules/powerrename/lib/packages.config +++ b/src/modules/powerrename/lib/packages.config @@ -1,4 +1,6 @@  + + \ No newline at end of file diff --git a/src/modules/powerrename/lib/trace.cpp b/src/modules/powerrename/lib/trace.cpp index ff539984f0..f04a085df0 100644 --- a/src/modules/powerrename/lib/trace.cpp +++ b/src/modules/powerrename/lib/trace.cpp @@ -85,5 +85,6 @@ void Trace::SettingsChanged() noexcept TraceLoggingBoolean(CSettingsInstance().GetPersistState(), "PersistState"), TraceLoggingBoolean(CSettingsInstance().GetMRUEnabled(), "IsMRUEnabled"), TraceLoggingUInt64(CSettingsInstance().GetMaxMRUSize(), "MaxMRUSize"), + TraceLoggingBoolean(CSettingsInstance().GetUseBoostLib(), "UseBoostLib"), TraceLoggingUInt64(CSettingsInstance().GetFlags(), "Flags")); } diff --git a/src/modules/powerrename/testapp/PowerRenameTest.vcxproj b/src/modules/powerrename/testapp/PowerRenameTest.vcxproj index 0ce40dc8c0..066763927f 100644 --- a/src/modules/powerrename/testapp/PowerRenameTest.vcxproj +++ b/src/modules/powerrename/testapp/PowerRenameTest.vcxproj @@ -202,6 +202,8 @@ + + @@ -209,5 +211,7 @@ + + \ No newline at end of file diff --git a/src/modules/powerrename/testapp/packages.config b/src/modules/powerrename/testapp/packages.config index 81f107b8bc..f93921797a 100644 --- a/src/modules/powerrename/testapp/packages.config +++ b/src/modules/powerrename/testapp/packages.config @@ -1,4 +1,6 @@  + + \ No newline at end of file diff --git a/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj b/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj index 03fe128bad..8f27a9ca47 100644 --- a/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj +++ b/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj @@ -1,4 +1,4 @@ - + @@ -196,6 +196,7 @@ + Create @@ -217,6 +218,8 @@ + + @@ -224,5 +227,7 @@ + + \ No newline at end of file diff --git a/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj.filters b/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj.filters index b8eb4c4f74..8708f3397e 100644 --- a/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj.filters +++ b/src/modules/powerrename/unittests/PowerRenameLibUnitTests.vcxproj.filters @@ -8,6 +8,7 @@ + diff --git a/src/modules/powerrename/unittests/PowerRenameRegExBoostTests.cpp b/src/modules/powerrename/unittests/PowerRenameRegExBoostTests.cpp new file mode 100644 index 0000000000..9fe33b3a18 --- /dev/null +++ b/src/modules/powerrename/unittests/PowerRenameRegExBoostTests.cpp @@ -0,0 +1,437 @@ +#include "pch.h" +#include "CppUnitTest.h" +#include "powerrename/lib/Settings.h" +#include +#include +#include "MockPowerRenameRegExEvents.h" + +using namespace Microsoft::VisualStudio::CppUnitTestFramework; + +namespace PowerRenameRegExBoostTests +{ + struct SearchReplaceExpected + { + PCWSTR search; + PCWSTR replace; + PCWSTR test; + PCWSTR expected; + }; + + TEST_CLASS(SimpleTests) + { + public: +TEST_CLASS_INITIALIZE(ClassInitialize) +{ + CSettingsInstance().SetUseBoostLib(true); +} + +TEST_CLASS_CLEANUP(ClassCleanup) +{ + CSettingsInstance().SetUseBoostLib(false); +} + +TEST_METHOD(GeneralReplaceTest) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(L"foo") == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(L"big") == S_OK); + Assert::IsTrue(renameRegEx->Replace(L"foobar", &result) == S_OK); + Assert::IsTrue(wcscmp(result, L"bigbar") == 0); + CoTaskMemFree(result); +} + +TEST_METHOD(ReplaceNoMatch) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(L"notfound") == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(L"big") == S_OK); + Assert::IsTrue(renameRegEx->Replace(L"foobar", &result) == S_OK); + Assert::IsTrue(wcscmp(result, L"foobar") == 0); + CoTaskMemFree(result); +} + +TEST_METHOD(ReplaceNoSearchOrReplaceTerm) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->Replace(L"foobar", &result) != S_OK); + Assert::IsTrue(result == nullptr); + CoTaskMemFree(result); +} + +TEST_METHOD(ReplaceNoReplaceTerm) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(L"foo") == S_OK); + Assert::IsTrue(renameRegEx->Replace(L"foobar", &result) == S_OK); + Assert::IsTrue(wcscmp(result, L"bar") == 0); + CoTaskMemFree(result); +} + +TEST_METHOD(ReplaceEmptyStringReplaceTerm) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(L"foo") == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(L"") == S_OK); + Assert::IsTrue(renameRegEx->Replace(L"foobar", &result) == S_OK); + Assert::IsTrue(wcscmp(result, L"bar") == 0); + CoTaskMemFree(result); +} + +TEST_METHOD(VerifyDefaultFlags) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = 0; + Assert::IsTrue(renameRegEx->GetFlags(&flags) == S_OK); + Assert::IsTrue(flags == MatchAllOccurences); +} + +TEST_METHOD(VerifyCaseSensitiveSearch) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = CaseSensitive; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"Foo", L"Foo", L"FooBar", L"FooBar" }, + { L"Foo", L"boo", L"FooBar", L"booBar" }, + { L"Foo", L"boo", L"foobar", L"foobar" }, + { L"123", L"654", L"123456", L"654456" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceFirstOnly) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = 0; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AABBA" }, + { L"B", L"BBB", L"ABABAB", L"ABBBABAB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceAll) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AAAAA" }, + { L"B", L"BBB", L"ABABAB", L"ABBBABBBABBB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceAllCaseInsensitive) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences | CaseSensitive; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AAAAA" }, + { L"B", L"BBB", L"ABABAB", L"ABBBABBBABBB" }, + { L"b", L"BBB", L"AbABAb", L"ABBBABABBB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceFirstOnlyUseRegEx) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = UseRegularExpressions; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AABBA" }, + { L"B", L"BBB", L"ABABAB", L"ABBBABAB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceAllUseRegEx) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences | UseRegularExpressions; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AAAAA" }, + { L"B", L"BBB", L"ABABAB", L"ABBBABBBABBB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceAllUseRegExCaseSensitive) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences | UseRegularExpressions | CaseSensitive; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + { L"B", L"BB", L"ABA", L"ABBA" }, + { L"B", L"A", L"ABBBA", L"AAAAA" }, + { L"b", L"BBB", L"AbABAb", L"ABBBABABBB" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyMatchAllWildcardUseRegEx) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences | UseRegularExpressions; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + // This differs from the Standard Library: .* has two matches (all and nothing). + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L".*", L"Foo", L"AAAAAA", L"FooFoo" }, + { L".+", L"Foo", L"AAAAAA", L"Foo" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +void VerifyReplaceFirstWildcard(SearchReplaceExpected sreTable[], int tableSize, DWORD flags) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + for (int i = 0; i < tableSize; i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::AreEqual(sreTable[i].expected, result); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyReplaceFirstWildCardUseRegex) +{ + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L".*", L"Foo", L"AAAAAA", L"Foo" }, + }; + VerifyReplaceFirstWildcard(sreTable, ARRAYSIZE(sreTable), UseRegularExpressions); +} + +TEST_METHOD(VerifyReplaceFirstWildCardUseRegexMatchAllOccurrences) +{ + // This differs from the Standard Library: .* has two matches (all and nothing). + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L".*", L"Foo", L"AAAAAA", L"FooFoo" }, + { L".+", L"Foo", L"AAAAAA", L"Foo" }, + }; + VerifyReplaceFirstWildcard(sreTable, ARRAYSIZE(sreTable), UseRegularExpressions | MatchAllOccurences); +} + +TEST_METHOD(VerifyReplaceFirstWildCardMatchAllOccurrences) +{ + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L".*", L"Foo", L"AAAAAA", L"AAAAAA" }, + { L".*", L"Foo", L".*", L"Foo" }, + { L".*", L"Foo", L".*Bar.*", L"FooBarFoo" }, + }; + VerifyReplaceFirstWildcard(sreTable, ARRAYSIZE(sreTable), MatchAllOccurences); +} + +TEST_METHOD(VerifyReplaceFirstWildNoFlags) +{ + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L".*", L"Foo", L"AAAAAA", L"AAAAAA" }, + { L".*", L"Foo", L".*", L"Foo" }, + }; + VerifyReplaceFirstWildcard(sreTable, ARRAYSIZE(sreTable), 0); +} + +TEST_METHOD(VerifyHandleCapturingGroups) +{ + // This differs from the Standard Library: Boost does not recognize $123 as $1 and "23". + // To use a capturing group followed by numbers as replacement curly braces are needed. + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + DWORD flags = MatchAllOccurences | UseRegularExpressions | CaseSensitive; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L"(foo)(bar)", L"$1_$002_$223_$001021_$00001", L"foobar", L"foo_$002__$001021_$00001" }, + { L"(foo)(bar)", L"$1_$002_${2}23_$001021_$00001", L"foobar", L"foo_$002_bar23_$001021_$00001" }, + { L"(foo)(bar)", L"_$1$2_$123$040", L"foobar", L"_foobar_$040" }, + { L"(foo)(bar)", L"_$1$2_${1}23$040", L"foobar", L"_foobar_foo23$040" }, + { L"(foo)(bar)", L"$$$1", L"foobar", L"$foo" }, + { L"(foo)(bar)", L"$$1", L"foobar", L"$1" }, + { L"(foo)(bar)", L"$12", L"foobar", L"" }, + { L"(foo)(bar)", L"${1}2", L"foobar", L"foo2" }, + { L"(foo)(bar)", L"$10", L"foobar", L"" }, + { L"(foo)(bar)", L"${1}0", L"foobar", L"foo0" }, + { L"(foo)(bar)", L"$01", L"foobar", L"$01" }, + { L"(foo)(bar)", L"$$$11", L"foobar", L"$" }, + { L"(foo)(bar)", L"$$${1}1", L"foobar", L"$foo1" }, + { L"(foo)(bar)", L"$$$$113a", L"foobar", L"$$113a" }, + }; + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyLookbehind) +{ + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L"(?<=E12).*", L"Foo", L"AAE12BBB", L"AAE12Foo" }, + { L"(?<=E12).+", L"Foo", L"AAE12BBB", L"AAE12Foo" }, + { L"(?<=E\\d\\d).+", L"Foo", L"AAE12BBB", L"AAE12Foo" }, + { L"(? renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + Assert::IsTrue(renameRegEx->PutFlags(UseRegularExpressions) == S_OK); + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == S_OK); + Assert::IsTrue(wcscmp(result, sreTable[i].expected) == 0); + CoTaskMemFree(result); + } +} + +TEST_METHOD(VerifyEventsFire) +{ + CComPtr renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + CMockPowerRenameRegExEvents* mockEvents = new CMockPowerRenameRegExEvents(); + CComPtr regExEvents; + Assert::IsTrue(mockEvents->QueryInterface(IID_PPV_ARGS(®ExEvents)) == S_OK); + DWORD cookie = 0; + Assert::IsTrue(renameRegEx->Advise(regExEvents, &cookie) == S_OK); + DWORD flags = MatchAllOccurences | UseRegularExpressions | CaseSensitive; + Assert::IsTrue(renameRegEx->PutFlags(flags) == S_OK); + Assert::IsTrue(renameRegEx->PutSearchTerm(L"FOO") == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(L"BAR") == S_OK); + Assert::IsTrue(lstrcmpi(L"FOO", mockEvents->m_searchTerm) == 0); + Assert::IsTrue(lstrcmpi(L"BAR", mockEvents->m_replaceTerm) == 0); + Assert::IsTrue(flags == mockEvents->m_flags); + Assert::IsTrue(renameRegEx->UnAdvise(cookie) == S_OK); + mockEvents->Release(); +} +}; +} diff --git a/src/modules/powerrename/unittests/PowerRenameRegExTests.cpp b/src/modules/powerrename/unittests/PowerRenameRegExTests.cpp index 69a041b885..356dbe42b9 100644 --- a/src/modules/powerrename/unittests/PowerRenameRegExTests.cpp +++ b/src/modules/powerrename/unittests/PowerRenameRegExTests.cpp @@ -1,5 +1,6 @@ #include "pch.h" #include "CppUnitTest.h" +#include "powerrename/lib/Settings.h" #include #include #include "MockPowerRenameRegExEvents.h" @@ -18,8 +19,14 @@ namespace PowerRenameRegExTests TEST_CLASS(SimpleTests){ public: - TEST_METHOD(GeneralReplaceTest){ - CComPtr renameRegEx; +TEST_CLASS_INITIALIZE(ClassInitialize) +{ + CSettingsInstance().SetUseBoostLib(false); +} + +TEST_METHOD(GeneralReplaceTest) +{ + CComPtr renameRegEx; Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); PWSTR result = nullptr; Assert::IsTrue(renameRegEx->PutSearchTerm(L"foo") == S_OK); @@ -362,6 +369,30 @@ TEST_METHOD(VerifyHandleCapturingGroups) } } +TEST_METHOD(VerifyLookbehindFails) +{ + // Standard Library Regex Engine does not support lookbehind, thus test should fail. + SearchReplaceExpected sreTable[] = { + //search, replace, test, result + { L"(?<=E12).*", L"Foo", L"AAAAAA", nullptr }, + { L"(? renameRegEx; + Assert::IsTrue(CPowerRenameRegEx::s_CreateInstance(&renameRegEx) == S_OK); + Assert::IsTrue(renameRegEx->PutFlags(UseRegularExpressions) == S_OK); + + for (int i = 0; i < ARRAYSIZE(sreTable); i++) + { + PWSTR result = nullptr; + Assert::IsTrue(renameRegEx->PutSearchTerm(sreTable[i].search) == S_OK); + Assert::IsTrue(renameRegEx->PutReplaceTerm(sreTable[i].replace) == S_OK); + Assert::IsTrue(renameRegEx->Replace(sreTable[i].test, &result) == E_FAIL); + Assert::AreEqual(sreTable[i].expected, result); + CoTaskMemFree(result); + } +} + TEST_METHOD(VerifyEventsFire) { CComPtr renameRegEx; diff --git a/src/modules/powerrename/unittests/packages.config b/src/modules/powerrename/unittests/packages.config index 81f107b8bc..f93921797a 100644 --- a/src/modules/powerrename/unittests/packages.config +++ b/src/modules/powerrename/unittests/packages.config @@ -1,4 +1,6 @@  + + \ No newline at end of file