Changeset 54b4a87 for perl/modules/IRC/lib/BarnOwl/Module

Timestamp:

Dec 28, 2009, 12:24:59 AM (15 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, release-1.10, release-1.6, release-1.7, release-1.8, release-1.9

Children:

3acab0e

Parents:

dc8f6e0

git-author:

Nelson Elhage <nelhage@mit.edu> (12/23/09 12:28:21)

git-committer:

Nelson Elhage <nelhage@mit.edu> (12/28/09 00:24:59)

Message:

IRC: Refactor the mk_irc_command API and document it.

File:

• perl/modules/IRC/lib/BarnOwl/Module/IRC.pm (modified) (9 diffs)

perl/modules/IRC/lib/BarnOwl/Module/IRC.pm

@@ -137 +137 @@
 }
 
-use constant OPTIONAL_CHANNEL => 1;
-use constant REQUIRE_CHANNEL => 2;
+=head2 mk_irc_command SUB FLAGS
+
+Return a subroutine that can be bound as a an IRC command. The
+subroutine will be called with arguments (COMMAND-NAME,
+IRC-CONNECTION, [CHANNEL], ARGV...).
+
+C<IRC-CONNECTION> and C<CHANNEL> will be inferred from arguments to
+the command and the current message if appropriate.
+
+The bitwise C<or> of zero or more C<FLAGS> can be passed in as a
+second argument to alter the behavior of the returned commands:
+
+=over 4
+
+=item C<CHANNEL_ARG>
+
+This command accepts the name of a channel. Pass in the C<CHANNEL>
+argument listed above, and die if no channel argument can be found.
+
+=item C<CHANNEL_OPTIONAL>
+
+Pass the channel argument, but don't die if not present. Only relevant
+with C<CHANNEL_ARG>.
+
+=back
+
+=cut
+
+use constant CHANNEL_ARG        => 1;
+use constant CHANNEL_OPTIONAL   => 2;
 
 sub register_commands {
@@ -192 +220 @@
 
     BarnOwl::new_command(
-        'irc-mode' => mk_irc_command( \&cmd_mode, OPTIONAL_CHANNEL ),
+        'irc-mode' => mk_irc_command( \&cmd_mode, CHANNEL_OPTIONAL|CHANNEL_ARG ),
         {
             summary => 'Change an IRC channel or user mode',
@@ -216 +244 @@
 
     BarnOwl::new_command(
-        'irc-part' => mk_irc_command( \&cmd_part, REQUIRE_CHANNEL ),
+        'irc-part' => mk_irc_command( \&cmd_part, CHANNEL_ARG ),
         {
             summary => 'Leave an IRC channel',
@@ -241 +269 @@
 
     BarnOwl::new_command(
-        'irc-names' => mk_irc_command( \&cmd_names, REQUIRE_CHANNEL ),
+        'irc-names' => mk_irc_command( \&cmd_names, CHANNEL_ARG ),
         {
             summary => 'View the list of users in a channel',
@@ -294 +322 @@
 
     BarnOwl::new_command(
-        'irc-topic' => mk_irc_command( \&cmd_topic, REQUIRE_CHANNEL ),
+        'irc-topic' => mk_irc_command( \&cmd_topic, CHANNEL_ARG ),
         {
             summary => 'View or change the topic of an IRC channel',
@@ -547 +575 @@
 sub mk_irc_command {
     my $sub = shift;
-    my $use_channel = shift || 0;
+    my $flags = shift || 0;
     return sub {
         my $cmd = shift;
@@ -563 +591 @@
             $conn = get_connection_by_alias($alias);
         }
-        if($use_channel) {
+        if($flags & CHANNEL_ARG) {
             $channel = $ARGV[0];
             if(defined($channel) && $channel =~ /^#/) {
@@ -577 +605 @@
         }
 
-        if(!$channel && $use_channel == REQUIRE_CHANNEL) {
+        if(!$channel &&
+           ($flags & CHANNEL_ARG) &&
+           !($flags & CHANNEL_OPTIONAL)) {
             die("Usage: $cmd <channel>\n");
         }
@@ -591 +621 @@
             die("You must specify an IRC network using -a.\n");
         }
-        if($use_channel) {
+        if($flags & CHANNEL_ARG) {
             $sub->($cmd, $conn, $channel, @ARGV);
         } else {