allow_arrow.cpp

/*
The MIT License (MIT)

Copyright (c) 2024-2025 sigma-axis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#include <cstdint>
#include <optional>
#include <bit>

#define NOMINMAX
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
#include <CommCtrl.h>
#pragma comment(lib, "comctl32")

using byte = uint8_t;
#include <aviutl/filter.hpp>

using namespace AviUtl;

////////////////////////////////
// ウィンドウフックのラッパー．
////////////////////////////////
class HookTarget
{
	template<class TSelf>
	static LRESULT CALLBACK subclassproc(HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam, uintptr_t uid, auto)
	{
		if (message == WM_DESTROY) {
			reinterpret_cast<TSelf*>(uid)->hwnd = nullptr;
			::RemoveWindowSubclass(hwnd, subclassproc<TSelf>, uid);
		}
		else if (reinterpret_cast<TSelf*>(uid)->hwnd != nullptr) {
			if (auto ret = TSelf::callback(message, wparam, lparam); ret.has_value())
				return ret.value();
		}
		return ::DefSubclassProc(hwnd, message, wparam, lparam);
	}
	auto hook_uid() const { return reinterpret_cast<uintptr_t>(this); }

protected:
	HWND hwnd = nullptr;

public:
	// hooking window procedures.
	template<class TSelf>
	bool begin_hook(this const TSelf& self)
	{
		if (self.hwnd != nullptr)
			return ::SetWindowSubclass(self.hwnd, subclassproc<TSelf>, self.hook_uid(), 0) != FALSE;
		return false;
	}
	template<class TSelf>
	bool end_hook(this const TSelf& self)
	{
		if (self.hwnd != nullptr)
			return ::RemoveWindowSubclass(self.hwnd, subclassproc<TSelf>, self.hook_uid()) != FALSE;
		return false;
	}

	void send_message(auto... args)
	{
		if (hwnd != nullptr && ::IsWindowVisible(hwnd) != FALSE) {
			// 注意: 非表示の設定ダイアログに特定のメッセージを送ると例外が飛ぶ．
			auto t = hwnd; hwnd = nullptr;
			::SendMessageW(t, args...);
			hwnd = t;
		}
	}
};

// 拡張編集ウィンドウ．
inline constinit class : public HookTarget {
	static FilterPlugin* get_exeditfp(FilterPlugin* this_fp)
	{
		auto h_exedit = ::GetModuleHandleW(L"exedit.auf");
		SysInfo si; this_fp->exfunc->get_sys_info(nullptr, &si);
		for (int i = 0; i < si.filter_n; i++) {
			auto that_fp = this_fp->exfunc->get_filterp(i);
			if (that_fp->dll_hinst == h_exedit) return that_fp;
		}
		return nullptr;
	}

public:
	bool init(FilterPlugin* fp)
	{
		auto exeditfp = get_exeditfp(fp);
		if (exeditfp != nullptr) hwnd = exeditfp->hwnd;
		return hwnd != nullptr;
	}

	inline static std::optional<LRESULT> callback(UINT message, WPARAM wparam, LPARAM lparam);
} exedit_window;

// 設定ダイアログ．
inline constinit class : public HookTarget {
	static auto get_settingdlg()
	{
		return ::FindWindowW(L"ExtendedFilterClass", nullptr);
	}

public:
	bool init()
	{
		hwnd = get_settingdlg();
		return hwnd != nullptr;
	}

	inline static std::optional<LRESULT> callback(UINT message, WPARAM wparam, LPARAM lparam);
} setting_dlg;

// メインウィンドウ．
inline constinit struct {
	HWND hwnd = nullptr;
	auto send_message(auto... args)
	{
		return ::SendMessageW(hwnd, args...);
	}
} main_window;


////////////////////////////////
// 設定項目．
////////////////////////////////
inline constinit struct Settings {
	struct {
		bool Left = false, Right = false, Up = false, Down = false, Delete = false;
		constexpr bool is_effective() const { return Left || Right || Up || Down || Delete; }
	} Timeline;
	struct {
		bool Left = false, Right = false, Up = false, Down = false;
		constexpr bool is_effective() const { return std::bit_cast<uint32_t>(*this) != 0; }
	} SettingDlg;

	void load(const char* ini_file)
	{
#define load_val(wnd, key)	wnd.key = 0 != ::GetPrivateProfileIntA(#wnd, "hook" #key, 0, ini_file)
		load_val(Timeline, Left);
		load_val(Timeline, Right);
		load_val(Timeline, Up);
		load_val(Timeline, Down);
		load_val(Timeline, Delete);
		load_val(SettingDlg, Left);
		load_val(SettingDlg, Right);
		load_val(SettingDlg, Up);
		load_val(SettingDlg, Down);
#undef load
	}
} settings;


////////////////////////////////
// 設定ロードセーブ．
////////////////////////////////

// replacing a file extension when it's known.
template<class T, size_t len_max, size_t len_old, size_t len_new>
static void replace_tail(T(&dst)[len_max], size_t len, const T(&tail_old)[len_old], const T(&tail_new)[len_new])
{
	if (len < len_old || len - len_old + len_new > len_max) return;
	std::memcpy(dst + len - len_old, tail_new, len_new * sizeof(T));
}
inline void load_settings(HMODULE h_dll)
{
	char path[MAX_PATH];
	replace_tail(path, ::GetModuleFileNameA(h_dll, path, std::size(path)) + 1, "auf", "ini");

	settings.load(path);
}


////////////////////////////////
// 各種コマンド実行の実装．
////////////////////////////////
struct Menu {
	enum class ID : unsigned int {
		ExEditLeft,
		ExEditRight,
		ExEditUp,
		ExEditDown,
		ExEditDelete,

		SettingDlgLeft,
		SettingDlgRight,

		Invalid,
	};
	using enum ID;
	static constexpr bool is_invalid(ID id) { return id >= Invalid; }
	static constexpr bool is_timeline(ID id) { return id <= ExEditDelete; }
	static constexpr bool is_settingdlg(ID id) { return id <= SettingDlgRight; }

	inline constexpr static struct { ID id; const char* name; } Items[] = {
		{ ExEditLeft,		"タイムライン左入力" },
		{ ExEditRight,		"タイムライン右入力" },
		{ ExEditUp,			"タイムライン上入力" },
		{ ExEditDown,		"タイムライン下入力" },
		{ ExEditDelete,		"タイムラインDelete入力" },
		{ SettingDlgLeft,	"設定ダイアログ左入力" },
		{ SettingDlgRight,	"設定ダイアログ右入力" },
	};
};

bool menu_timeline_handler(Menu::ID id)
{
	WPARAM vk = 0;
	switch (id) {
	case Menu::ExEditLeft:		vk = VK_LEFT;	break;
	case Menu::ExEditRight:		vk = VK_RIGHT;	break;
	case Menu::ExEditUp:		vk = VK_UP;		break;
	case Menu::ExEditDown:		vk = VK_DOWN;	break;
	case Menu::ExEditDelete:	vk = VK_DELETE;	break;
	}
	if (vk != 0) exedit_window.send_message(WM_KEYDOWN, vk, 0);
	return false;
}

bool menu_setting_dlg_handler(Menu::ID id)
{
	WPARAM vk = 0;
	switch (id) {
	case Menu::SettingDlgLeft:	vk = VK_LEFT;	break;
	case Menu::SettingDlgRight:	vk = VK_RIGHT;	break;
	}
	if (vk != 0) setting_dlg.send_message(WM_KEYDOWN, vk, 0);
	return false;
}


////////////////////////////////
// フックのコールバック関数．
////////////////////////////////
inline std::optional<LRESULT> decltype(exedit_window)::callback(UINT message, WPARAM wparam, LPARAM lparam)
{
	switch (message) {
	case WM_KEYDOWN:
	case WM_SYSKEYDOWN:
		if ([=] {
			switch (wparam) {
			case VK_LEFT:	return settings.Timeline.Left;
			case VK_RIGHT:	return settings.Timeline.Right;
			case VK_UP:		return settings.Timeline.Up;
			case VK_DOWN:	return settings.Timeline.Down;
			case VK_DELETE:	return settings.Timeline.Delete;
			default: return false;
			}
		}()) return main_window.send_message(message, wparam, lparam);
		break;
	}
	return std::nullopt;
}

inline std::optional<LRESULT> decltype(setting_dlg)::callback(UINT message, WPARAM wparam, LPARAM lparam)
{
	switch (message) {
	case WM_KEYDOWN:
	case WM_SYSKEYDOWN:
		if ([=] {
			switch (wparam) {
			case VK_LEFT:	return settings.SettingDlg.Left;
			case VK_RIGHT:	return settings.SettingDlg.Right;
			case VK_UP:		return settings.SettingDlg.Up;
			case VK_DOWN:	return settings.SettingDlg.Down;
			default: return false;
			}
		}()) return main_window.send_message(message, wparam, lparam);
		break;
	}
	return std::nullopt;
}


////////////////////////////////
// AviUtlに渡す関数の定義．
////////////////////////////////
BOOL func_init(FilterPlugin* fp)
{
	// 拡張編集の確認．
	if (!exedit_window.init(fp)) {
		::MessageBoxA(fp->hwnd, "拡張編集が見つかりませんでした．",
			fp->name, MB_OK | MB_ICONEXCLAMATION);
		return FALSE;
	}

	// メインウィンドウのハンドルを取得，保存．
	main_window.hwnd = fp->hwnd_parent;

	// message-only window を作成，登録．これで NoConfig でも AviUtl からメッセージを受け取れる.
	fp->hwnd = ::CreateWindowExW(0, L"AviUtl", L"", 0, 0, 0, 0, 0,
		HWND_MESSAGE, nullptr, fp->hinst_parent, nullptr);

	// メニュー登録．
	for (auto [id, name] : Menu::Items)
		fp->exfunc->add_menu_item(fp, name, fp->hwnd, static_cast<int32_t>(id), 0, ExFunc::AddMenuItemFlag::None);

	// 設定ロード．
	load_settings(fp->dll_hinst);

	return TRUE;
}

BOOL func_WndProc(HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam, EditHandle* editp, FilterPlugin* fp)
{
	using Message = FilterPlugin::WindowMessage;
	switch (message) {
		// 拡張編集タイムライン/設定ダイアログのフック/アンフック．
	case Message::ChangeWindow:
		setting_dlg.init();
		if (settings.Timeline.is_effective()) exedit_window.begin_hook();
		if (settings.SettingDlg.is_effective()) setting_dlg.begin_hook();
		break;
	case Message::Exit:
		if (settings.Timeline.is_effective()) exedit_window.end_hook();
		if (settings.SettingDlg.is_effective()) setting_dlg.end_hook();

		// message-only window を削除．必要ないかもしれないけど．
		fp->hwnd = nullptr; ::DestroyWindow(hwnd);
		break;

	case Message::Command:
		// コマンドハンドラ．
		if (auto id = static_cast<Menu::ID>(wparam); !Menu::is_invalid(id) &&
			fp->exfunc->is_editing(editp) && !fp->exfunc->is_saving(editp)) {
			return (
				Menu::is_timeline(id)   ? menu_timeline_handler(id) :
				Menu::is_settingdlg(id) ? menu_setting_dlg_handler(id) :
				false) ? TRUE : FALSE;
		}
		break;
	}
	return FALSE;
}


////////////////////////////////
// Entry point.
////////////////////////////////
BOOL WINAPI DllMain(HINSTANCE hinst, DWORD fdwReason, LPVOID lpvReserved)
{
	switch (fdwReason) {
	case DLL_PROCESS_ATTACH:
		::DisableThreadLibraryCalls(hinst);
		break;
	}
	return TRUE;
}


////////////////////////////////
// 看板．
////////////////////////////////
#define PLUGIN_NAME		"Allow Arrow"
#define PLUGIN_VERSION	"v1.20"
#define PLUGIN_AUTHOR	"sigma-axis"
#define PLUGIN_INFO_FMT(name, ver, author)	(name##" "##ver##" by "##author)

extern "C" __declspec(dllexport) FilterPluginDLL* __stdcall GetFilterTable(void)
{
	// （フィルタとは名ばかりの）看板．
	using Flag = FilterPlugin::Flag;
	static constinit FilterPluginDLL filter {
		.flag = Flag::AlwaysActive | Flag::ExInformation | Flag::NoConfig,
		.name = PLUGIN_NAME,
		.func_init = func_init,
		.func_WndProc = func_WndProc,
		.information = PLUGIN_INFO_FMT(PLUGIN_NAME, PLUGIN_VERSION, PLUGIN_AUTHOR),
	};
	return &filter;
}