sl@0: // Copyright Vladimir Prus 2004.
sl@0: // Distributed under the Boost Software License, Version 1.0.
sl@0: // (See accompanying file LICENSE_1_0.txt
sl@0: // or copy at http://www.boost.org/LICENSE_1_0.txt)
sl@0: 
sl@0: #ifndef BOOST_CMDLINE_HPP_VP_2004_03_13
sl@0: #define BOOST_CMDLINE_HPP_VP_2004_03_13
sl@0: 
sl@0: namespace boost { namespace program_options { namespace command_line_style {
sl@0:     /** Various possible styles of options.
sl@0:         
sl@0:     There are "long" options, which start with "--" and "short",
sl@0:     which start with either "-" or "/". Both kinds can be allowed or
sl@0:     disallowed, see allow_long and allow_short. The allowed character
sl@0:     for short options is also configurable.
sl@0: 
sl@0:     Option's value can be specified in the same token as name
sl@0:     ("--foo=bar"), or in the next token.
sl@0: 
sl@0:     It's possible to introduce long options by the same character as
sl@0:     short options, see allow_long_disguise.
sl@0: 
sl@0:     Finally, guessing (specifying only prefix of option) and case
sl@0:     insensitive processing are supported.
sl@0:     */
sl@0:     enum style_t {
sl@0:         /// Allow "--long_name" style
sl@0:         allow_long = 1,
sl@0:         /// Alow "-<single character" style
sl@0:         allow_short = allow_long << 1,
sl@0:         /// Allow "-" in short options
sl@0:         allow_dash_for_short = allow_short << 1,
sl@0:         /// Allow "/" in short options
sl@0:         allow_slash_for_short = allow_dash_for_short << 1,
sl@0:         /** Allow option parameter in the same token
sl@0:             for long option, like in
sl@0:             @verbatim
sl@0:             --foo=10
sl@0:             @endverbatim
sl@0:         */
sl@0:         long_allow_adjacent = allow_slash_for_short << 1,
sl@0:         /** Allow option parameter in the next token for
sl@0:             long options. */
sl@0:         long_allow_next = long_allow_adjacent << 1,
sl@0:         /** Allow option parameter in the same token for
sl@0:             short options. */
sl@0:         short_allow_adjacent = long_allow_next << 1,
sl@0:         /** Allow option parameter in the next token for
sl@0:             short options. */
sl@0:         short_allow_next = short_allow_adjacent << 1,
sl@0:         /** Allow to merge several short options together,
sl@0:             so that "-s -k" become "-sk". All of the options
sl@0:             but last should accept no parameter. For example, if
sl@0:             "-s" accept a parameter, then "k" will be taken as
sl@0:             parameter, not another short option. 
sl@0:             Dos-style short options cannot be sticky.
sl@0:         */
sl@0:         allow_sticky = short_allow_next << 1,
sl@0:         /** Allow abbreviated spellings for long options,
sl@0:             if they unambiguously identify long option. 
sl@0:             No long option name should be prefix of other 
sl@0:             long option name if guessing is in effect.
sl@0:         */
sl@0:         allow_guessing = allow_sticky << 1,
sl@0:         /** Ignore the difference in case for options. 
sl@0:             @todo Should this apply to long options only?
sl@0:         */            
sl@0:         case_insensitive = allow_guessing << 1,
sl@0:         /** Allow long options with single option starting character,
sl@0:             e.g <tt>-foo=10</tt>
sl@0:         */
sl@0:         allow_long_disguise = case_insensitive << 1,
sl@0:         /** The more-or-less traditional unix style. */
sl@0:         unix_style = (allow_short | short_allow_adjacent | short_allow_next
sl@0:                       | allow_long | long_allow_adjacent | long_allow_next
sl@0:                       | allow_sticky | allow_guessing 
sl@0:                       | allow_dash_for_short),
sl@0:         /** The default style. */
sl@0:         default_style = unix_style
sl@0:     };
sl@0: }}}
sl@0: 
sl@0: 
sl@0: #endif
sl@0: