command_line.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Ingo Ruhnke
*/


#pragma once

#include "../api_core.h"
#include "../Text/string_types.h"
#include <vector>

class CL_CommandLine_Generic;

class CL_API_CORE CL_CommandLine
{

public:
        CL_CommandLine();

        ~CL_CommandLine();



public:
        enum
        {
                REST_ARG  = -2
        };

        int get_key();

        CL_String8 get_argument();



public:
        void set_help_indent(int i);

        void add_usage(const CL_String8& usage);

        void add_doc(const CL_String8& doc);

        void add_group(const CL_String8& grouptopic);

        void add_option(
                int key,
                const CL_String8& long_option,
                const CL_String8& argument,
                const CL_String8& help,
                bool visible = true);

        void parse_args(int argc, char** argv);

        void print_help();

        bool next();



private:
        CL_CommandLine_Generic* impl;
};

---