1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Location: ./crates/cpex-core/src/hooks/macros.rs
// Copyright 2025
// SPDX-License-Identifier: Apache-2.0
// Authors: Teryl Taylor
//
// define_hook! macro.
//
// Generates a HookTypeDef marker struct and trait implementation
// from a single declaration. This is the primary way to define new
// hooks — both built-in (CMF, tool, prompt) and custom (rate
// limiting, deployment gates, federation sync).
//
// Plugins implement the generic HookHandler<H> trait (from
// trait_def.rs) for the generated marker struct. The handler
// receives a borrowed payload and returns the hook's result type.
/// Generates a hook type definition and marker struct.
///
/// # Usage
///
/// ```rust,ignore
/// define_hook! {
/// /// Doc comment for the hook.
/// MyHook, "my_hook" => {
/// payload: MyPayload,
/// result: PluginResult<MyPayload>,
/// }
/// }
/// ```
///
/// This generates a marker struct `MyHook` implementing `HookTypeDef`.
/// Plugins handle it by implementing `HookHandler<MyHook>`.
///
/// # CMF Pattern (one handler, multiple hook names)
///
/// For CMF hooks where one handler covers multiple hook names:
///
/// ```rust,ignore
/// define_hook! {
/// /// CMF message evaluation hook.
/// CmfHook, "cmf" => {
/// payload: MessagePayload,
/// result: PluginResult<MessagePayload>,
/// }
/// }
///
/// // Register the same handler for multiple names:
/// // manager.register_handler_for_names::<CmfHook, _>(plugin, config, &[
/// // "cmf.tool_pre_invoke", "cmf.llm_input", ...
/// // ]);
/// ```