add flags parsing to modlib

diff --git a/modlib.py b/modlib.py
index cd87f5e9fcd10019d71e45ca0d32d6176a793a68..b36c153287f4979c107a8768c60b91536949ec15 100644 (file)
--- a/modlib.py
+++ b/modlib.py
@@ -234,11 +234,53 @@ class modlib(object):
                else:
                        return error('unknown parent')
 
+
+       def flags(self, *flags):
+               """Parses out "flags" to a command, like `MODUNLOAD -AUTOLOAD somemodule`
+               @lib.hook()
+               @lib.flags('autoload', 'force')
+               def baz(bot, user, chan, realtarget, flags, *args)
+
+               Note the added `flags` argument, which will be a dict - in this case `{'autounload':true,'force':false}`."""
+               def realhook(func):
+                       func.flags = [f.lower() for f in flags]
+
+                       @wraps(func)
+                       def parseargs(bot, user, chan, realtarget, *_args):
+                               args = list(_args) # we need a copy, also need a list, iterate over _args-tuple, mutate args-list
+                               found_flags = {f: False for f in flags}
+                               for arg in _args:
+                                       if arg[0] == "-" and len(arg) > 1:
+                                               found_prefix = None
+                                               possible_flag = arg[1:].lower()
+                                               for f in flags:
+                                                       if possible_flag == f: # Exact match?
+                                                               found_flags[possible_flag] = True
+                                                               args.remove(arg)
+                                                               found_prefix = None
+                                                               break
+                                                       elif f.find(possible_flag) == 0: # Is the current word a prefix of a flag?
+                                                               if found_prefix is not None: # Is it also a prefix of another flag?
+                                                                       return 'Error: %s is a prefix of multiple flags (%s, %s).' % (possible_flag, found_prefix[1], f)
+                                                               else:
+                                                                       found_prefix = (arg,f)
+                                               if found_prefix is not None: # found (only one) prefix
+                                                       found_flags[found_prefix[1]] = True
+                                                       args.remove(found_prefix[0])
+                               return func(bot, user, chan, realtarget, found_flags, *args)
+
+                       return parseargs
+               return realhook
+
+
        def argsEQ(self, num):
                def realhook(func):
                        @wraps(func)
                        def checkargs(bot, user, chan, realtarget, *args):
-                               if len(args) == num:
+                               adjuster = 0
+                               if hasattr(checkargs, 'flags'):
+                                       adjuster = 1
+                               if len(args)-adjuster == num:
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)
@@ -249,7 +291,10 @@ class modlib(object):
                def realhook(func):
                        @wraps(func)
                        def checkargs(bot, user, chan, realtarget, *args):
-                               if len(args) >= num:
+                               adjuster = 0
+                               if hasattr(checkargs, 'flags'):
+                                       adjuster = 1
+                               if len(args)-adjuster >= num:
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)

diff --git a/modules/test_flags.py b/modules/test_flags.py
new file mode 100644 (file)
index 0000000..d3268c7
--- /dev/null
+++ b/modules/test_flags.py
@@ -0,0 +1,31 @@
+# Erebus IRC bot - Author: Erebus Team
+# vim: fileencoding=utf-8
+# Various highly recommended "control" commands.
+# This file is released into the public domain; see http://unlicense.org/
+
+# module info
+modinfo = {
+       'author': 'Erebus Team',
+       'license': 'public domain',
+       'compatible': [0],
+       'depends': [],
+       'softdeps': ['help'],
+}
+
+# preamble
+import modlib
+lib = modlib.modlib(__name__)
+modstart = lib.modstart
+modstop = lib.modstop
+
+# module code
+import sys, os
+import ctlmod
+from collections import deque
+
+
+@lib.hook(needchan=False)
+@lib.flags('foo','bar','baz','barz')
+@lib.argsGE(1)
+def flags(bot, user, chan, realtarget, flags, *args):
+       return repr((flags, args))