Add pre_expand signal for filtering tidbits #100
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
New signal called before expanding variables in a factoid. The tidbit itself is passed in as a reference.
|
Ping @zigdon, is there anything you'd change about this before I merge it? |
zigdon
reviewed
May 10, 2017
| @@ -3063,6 +3063,8 @@ sub sql { | |||
| sub expand { | |||
| my ( $who, $chl, $msg, $editable, $to ) = @_; | |||
|
|
|||
| return if &signal_plugin( "pre_expand", {tidbit => \$msg} ); | |||
There was a problem hiding this comment.
Why pass by reference? Seems out of norm relative to the other plugins?
There was a problem hiding this comment.
I elected to pass by reference because of the existing plugin documentation, which states:
Any sub that is handling a signal should return -1, 0 or 1:
- -1 - no further processing should be done, no other plugins called.
- 1 - process other plugins, but shouldn't continue with the core functions.
- 0 - process other plugins and core functions.
The signal could return an array/list instead, but I preferred the simplicity of modifying $msg directly in the signaled plugin and returning a simple integer. I can rewrite it if you like, but I honestly think passing by reference is the least complicated method from a plugin writer's perspective.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New signal called before expanding variables in a factoid. The tidbit itself is passed in as a reference.
Added for use by my plugin that implements the new syntax described in #89.