ProgramOptions.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_PROGRAMOPTIONS_H_
#define _MIRA_PROGRAMOPTIONS_H_

#ifndef Q_MOC_RUN
#include <boost/program_options.hpp>
#endif
#include <utils/Singleton.h>

#include <platform/Console.h>

#define MIRA_CMDLINE mira::ProgramOptions::instance()

namespace mira {


class MIRA_BASE_EXPORT ProgramOptions :
    public ExplicitSingleton<ProgramOptions>
{
public:
    typedef boost::program_options::options_description Description;
    typedef boost::program_options::positional_options_description PositionalDescription;
    typedef boost::program_options::variables_map VariableMap;

    inline static Description createOptionsDescription(const std::string& name = "")
    {
        int w = console::getWidth();
        int left=w/2;
        if(left>40)
            left=40;
        if (name.empty())
            return Description(w,w-left);
        else
            return Description(name, w,w-left);
    }

    ProgramOptions(int argc, char** argv, const std::string& helpCategory = "");

    ProgramOptions(const std::vector<std::string>& args, const std::string& helpCategory = "");

    Description& getDescriptions()
    {
        return mOptionDescriptions;
    }

    PositionalDescription& getPositionalDescriptions()
    {
        mEnablePositionalArguments = true;
        return mPositionalDescriptions;
    }

    void getOptions(VariableMap& oMap) const;

    VariableMap getOptions() const
    {
        VariableMap vmap;
        getOptions(vmap);
        return vmap;
    }

    const std::vector<std::string>& getArgs() const
    {
        return mArgs;
    }

private:
    void init(const std::string& helpCategory);

private:
    Description mOptionDescriptions;    
    PositionalDescription mPositionalDescriptions;
    bool mEnablePositionalArguments;
    std::vector<std::string> mArgs;
};


}

#endif