source: XMLIO_V2/external/include/Poco/Util/HelpFormatter.h @ 80

//
// HelpFormatter.h
//
// $Id: //poco/1.3/Util/include/Poco/Util/HelpFormatter.h#2 $
//
// Library: Util
// Package: Options
// Module:  HelpFormatter
//
// Definition of the HelpFormatter class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
// 
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
// 
// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//


#ifndef Util_HelpFormatter_INCLUDED
#define Util_HelpFormatter_INCLUDED


#include "Poco/Util/Util.h"
#include <ostream>


namespace Poco {
namespace Util {


class OptionSet;
class Option;


class Util_API HelpFormatter
        /// This class formats a help message from an OptionSet.
{
public:
        HelpFormatter(const OptionSet& options);
                /// Creates the HelpFormatter, using the given
                /// options. 
                ///
                /// The HelpFormatter just stores a reference
                /// to the given OptionSet, so the OptionSet must not
                /// be destroyed during the lifetime of the HelpFormatter.

        ~HelpFormatter();
                /// Destroys the HelpFormatter.

        void setCommand(const std::string& command);
                /// Sets the command name.
                
        const std::string& getCommand() const;
                /// Returns the command name.
                
        void setUsage(const std::string& usage);
                /// Sets the usage string.
                
        const std::string& getUsage() const;
                /// Returns the usage string.
                
        void setHeader(const std::string& header);
                /// Sets the header string.
                
        const std::string& getHeader() const;
                /// Returns the header string.
                
        void setFooter(const std::string& footer);
                /// Sets the footer string.
                
        const std::string& getFooter() const;
                /// Returns the footer string.

        void format(std::ostream& ostr) const;
                /// Writes the formatted help text to the given stream.
        
        void setWidth(int width);
                /// Sets the line width for the formatted help text.
                
        int getWidth() const;
                /// Returns the line width for the formatted help text.
                ///
                /// The default width is 72.

        void setIndent(int indent);
                /// Sets the indentation for description continuation lines.

        int getIndent() const;
                /// Returns the indentation for description continuation lines.
                
        void setAutoIndent();
                /// Sets the indentation for description continuation lines so that
                /// the description text is left-aligned. 

        void setUnixStyle(bool flag);
                /// Enables Unix-style options. Both short and long option names
                /// are printed if Unix-style is set. Otherwise, only long option
                /// names are printed.
                ///
                /// After calling setUnixStyle(), setAutoIndent() should be called
                /// as well to ensure proper help text formatting.
                
        bool isUnixStyle() const;
                /// Returns if Unix-style options are set.

        std::string shortPrefix() const;
                /// Returns the platform-specific prefix for short options.
                /// "-" on Unix, "/" on Windows and OpenVMS.
        
        std::string longPrefix() const;
                /// Returns the platform-specific prefix for long options.
                /// "--" on Unix, "/" on Windows and OpenVMS.

protected:
        int calcIndent() const;
                /// Calculates the indentation for the option descriptions
                /// from the given options.

        void formatOptions(std::ostream& ostr) const;
                /// Formats all options.

        void formatOption(std::ostream& ostr, const Option& option, int width) const;
                /// Formats an option, using the platform-specific
                /// prefixes.

        void formatText(std::ostream& ostr, const std::string& text, int indent) const;
                /// Formats the given text.

        void formatText(std::ostream& ostr, const std::string& text, int indent, int firstIndent) const;
                /// Formats the given text.

        void formatWord(std::ostream& ostr, int& pos, const std::string& word, int indent) const;
                /// Formats the given word.
        
        void clearWord(std::ostream& ostr, int& pos, std::string& word, int indent) const;
                /// Formats and then clears the given word.
        
private:
        HelpFormatter(const HelpFormatter&);
        HelpFormatter& operator = (const HelpFormatter&);

        const OptionSet& _options;
        int _width;
        int _indent;
        std::string _command;
        std::string _usage;
        std::string _header;
        std::string _footer;
        bool _unixStyle;
        
        static const int TAB_WIDTH;
        static const int LINE_WIDTH;
};


//
// inlines
//
inline int HelpFormatter::getWidth() const
{
        return _width;
}


inline int HelpFormatter::getIndent() const
{
        return _indent;
}


inline const std::string& HelpFormatter::getCommand() const
{
        return _command;
}


inline const std::string& HelpFormatter::getUsage() const
{
        return _usage;
}


inline const std::string& HelpFormatter::getHeader() const
{
        return _header;
}


inline const std::string& HelpFormatter::getFooter() const
{
        return _footer;
}


inline bool HelpFormatter::isUnixStyle() const
{
        return _unixStyle;
}


} } // namespace Poco::Util


#endif // Util_HelpFormatter_INCLUDED