cmdline.h

Go to the documentation of this file.

/*
 * cmdline.h
 *
 * Copyright 2004  Thomas A. Vaughan
 * 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 <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 *
 *
 * Abstractions for dealing with the command line
 */

#ifndef WAVEPACKET_CMDLINE_H__
#define WAVEPACKET_CMDLINE_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include "threadsafe/smart_ptr.h"


/// \ingroup general
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup cmdline Command Line API
///
/// This is an older class, and it should probably be deprecated in favor of
/// better command-line parsing objects out there.  But for whatever reason
/// I've been using this one for most projects.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


////////////////////////////////////////////////////////////////////////////////
///
/// Command Line object
///
/// Create one of these from the command line strings, and then query it about
/// options you care about.
///
/// Example:
/// \code
///     int main(int argc, char * argv[]) {
///             smart_ptr<CommandLine> cmdline = CommandLine::create(argc, argv);
///             const char * file = getSingleKeyValue(cmdline, "file", false);
///             if (!file) {
///                     std::cout << "recommended usage: ";
///                     std::cout << "my_program --file <path>";
///             }
///             return 0;
///     }
/// \endcode
///
////////////////////////////////////////////////////////////////////////////////
class CommandLine {
public:
        // virtual destructor --------------------------------------------------
        virtual ~CommandLine(void) throw();

        // CommandLine class interface methods ---------------------------------
        virtual void getKeys(OUT VecString& keys) throw() = 0;
        virtual bool getValues(IN const char * key,
                                OUT VecString& values) throw() = 0;

        // static class methods (factories) ------------------------------------
        static smart_ptr<CommandLine> create(IN int argc,
                                IN const char * argv[]) throw();
};


const char * getSingleKeyValue(IN CommandLine * cmd, IN const char * key,
                        bool is_required,
                        const char * description = NULL) throw();


/*@}*/  // end of documentation block

#endif  // WAVEPACKET_CMDLINE_H__