Limnoria/plugins/Format.py

207 lines
6.7 KiB
Python
Raw Normal View History

2004-07-23 00:15:13 +02:00
###
# Copyright (c) 2004, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
"""
Provides simple commands for formatting text on IRC.
"""
import supybot
2004-07-23 00:15:13 +02:00
__revision__ = "$Id$"
__author__ = supybot.authors.jemfinch
2004-07-23 00:15:13 +02:00
2004-07-24 07:18:26 +02:00
import supybot.plugins as plugins
2004-07-23 00:15:13 +02:00
import string
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
from supybot.commands import *
2004-07-24 07:18:26 +02:00
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
2004-07-23 00:15:13 +02:00
def configure(advanced):
# This will be called by setup.py to configure this module. Advanced is
# a bool that specifies whether the user identified himself as an advanced
# user or not. You should effect your configuration by manipulating the
# registry as appropriate.
2004-07-25 20:24:51 +02:00
from supybot.questions import expect, anything, something, yn
2004-07-23 00:15:13 +02:00
conf.registerPlugin('Format', True)
class Format(callbacks.Privmsg):
def bold(self, irc, msg, args, text):
2004-07-23 00:15:13 +02:00
"""<text>
Returns <text> bolded.
"""
irc.reply(ircutils.bold(text))
bold = wrap(bold, ['text'])
2004-07-23 00:15:13 +02:00
def reverse(self, irc, msg, args, text):
2004-07-23 00:15:13 +02:00
"""<text>
Returns <text> in reverse-video.
"""
irc.reply(ircutils.reverse(text))
reverse = wrap(reverse, ['text'])
2004-07-23 00:15:13 +02:00
def underline(self, irc, msg, args, text):
2004-07-23 00:15:13 +02:00
"""<text>
Returns <text> underlined.
"""
irc.reply(ircutils.underline(text))
underline = wrap(underline, ['text'])
2004-07-23 00:15:13 +02:00
def color(self, irc, msg, args, fg, bg, text):
2004-07-23 00:15:13 +02:00
"""<foreground> [<background>] <text>
Returns <text> with foreground color <foreground> and background color
<background> (if given)
"""
2004-07-23 00:46:46 +02:00
irc.reply(ircutils.mircColor(text, fg=fg, bg=bg))
color = wrap(color, ['color', optional('color'), 'text'])
2004-07-23 00:15:13 +02:00
def join(self, irc, msg, args, sep):
"""<separator> <string 1> [<string> ...]
Joins all the arguments together with <separator>.
"""
irc.reply(sep.join(args))
join = wrap(join, ['something'], allowExtra=True)
def translate(self, irc, msg, args, bad, good, text):
"""<chars to translate> <chars to replace those with> <text>
Replaces <chars to translate> with <chars to replace those with> in
<text>. The first and second arguments must necessarily be the same
length.
"""
if len(bad) != len(good):
irc.error('<chars to translate> must be the same length as '
'<chars to replace those with>.', Raise=True)
irc.reply(text.translate(string.maketrans(bad, good)))
translate = wrap(translate, ['something', 'something', 'text'])
def upper(self, irc, msg, args, text):
"""<text>
Returns <text> uppercased.
"""
irc.reply(text.upper())
upper = wrap(upper, ['text'])
def lower(self, irc, msg, args, text):
"""<text>
Returns <text> lowercased.
"""
irc.reply(text.lower())
lower = wrap(lower, ['text'])
def capitalize(self, irc, msg, args, text):
"""<text>
Returns <text> lowercased.
"""
irc.reply(text.capitalize())
capitalize = wrap(capitalize, ['text'])
def title(self, irc, msg, args, text):
"""<text>
Returns <text> lowercased.
"""
irc.reply(text.title())
title = wrap(title, ['text'])
def repr(self, irc, msg, args, text):
"""<text>
Returns the text surrounded by double quotes.
"""
irc.reply(utils.dqrepr(text))
repr = wrap(repr, ['text'])
def concat(self, irc, msg, args, first, second):
"""<string 1> <string 2>
Concatenates two strings. Do keep in mind that this is *not* the same
2004-08-19 01:15:27 +02:00
thing as join "", since if <string 2> contains spaces, they won't be
removed by concat.
"""
irc.reply(first+second)
concat = wrap(concat, ['something', 'text'])
def cut(self, irc, msg, args, size, text):
2004-08-10 17:24:01 +02:00
"""<size> <text>
Cuts <text> down to <size> by chopping off the rightmost characters in
excess of <size>. If <size> is a negative number, it chops that many
characters off the end of <text>.
"""
irc.reply(text[:size])
cut = wrap(cut, ['int', 'text'])
2004-08-10 17:24:01 +02:00
def field(self, irc, msg, args, index, text):
2004-08-10 17:24:01 +02:00
"""<number> <text>
Returns the <number>th space-separated field of <text>. I.e., if text
is "foo bar baz" and <number> is 2, "bar" is returned.
"""
try:
irc.reply(text.split()[index])
except IndexError:
2004-09-17 06:56:38 +02:00
irc.errorInvalid('field')
field = wrap(field, ['index', 'text'])
2004-08-10 17:24:01 +02:00
2004-07-23 00:55:06 +02:00
def format(self, irc, msg, args):
"""<format string> [<arg> ...]
Expands a Python-style format string using the remaining args. Just be
sure always to use %s, not %d or %f or whatever, because all the args
are strings.
"""
if not args:
2004-07-23 00:55:06 +02:00
raise callbacks.ArgumentError
s = args.pop(0)
2004-07-23 00:55:06 +02:00
try:
s %= tuple(args)
irc.reply(s)
except TypeError, e:
self.log.debug(utils.exnToString(e))
irc.error('Not enough arguments for the format string.',Raise=True)
2004-07-23 00:55:06 +02:00
2004-07-23 00:15:13 +02:00
Class = Format
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: