"""\
@file helpformatter.py
@author Phoenix
@brief Class for formatting optparse descriptions.

$LicenseInfo:firstyear=2007&license=mit$

Copyright (c) 2007-2009, Linden Research, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
$/LicenseInfo$
"""

import optparse
import textwrap

class Formatter(optparse.IndentedHelpFormatter):
    def __init__(
        self, 
        p_indentIncrement = 2, 
        p_maxHelpPosition = 24,
        p_width = 79,
        p_shortFirst = 1) :
        optparse.HelpFormatter.__init__(
            self, 
            p_indentIncrement,
            p_maxHelpPosition, 
            p_width, 
            p_shortFirst)
    def format_description(self, p_description):
        t_descWidth = self.width - self.current_indent
        t_indent = " " * (self.current_indent + 2)
        return "\n".join(
            [textwrap.fill(descr, t_descWidth, initial_indent = t_indent,
                           subsequent_indent = t_indent)
             for descr in p_description.split("\n")] )
