application.hpp

Go to the documentation of this file.

#pragma once
/*
 * Copyright (c) 2012, 2013 Aldebaran Robotics. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the COPYING file.
 */

#ifndef _QI_APPLICATION_HPP_
# define _QI_APPLICATION_HPP_

# include <functional>
# include <vector>
# include <string>
# include <qi/api.hpp>

namespace qi {

  class QI_API Application
  {
  public:
    Application(int& argc, char** &argv, const std::string& name = "", const std::string& path = "");
    QI_API_DEPRECATED_MSG(Use 'Application(int, char**, string, string)' instead)
    Application(const std::string &name, int& argc, char** &argv);
    ~Application();

    static void run();
    static void stop();

    static const std::vector<std::string>& arguments();
    static int argc();
    static const char** argv();
    static void setName(const std::string &name);
    static std::string name();
    static void setArguments(int argc, char** argv);
    static void setArguments(const std::vector<std::string>& arguments);

    static void* loadModule(const std::string& name, int flags=-1);
    static void unloadModule(void* handle);
    static bool terminated();
    static bool initialized();

    static const char* program();

    static const char* realProgram();

    static const char* _suggestedSdkPath();

    static bool atEnter(std::function<void()> func);

    static bool atExit(std::function<void()> func);

    static bool atRun(std::function<void()> func);

    static bool atStop(std::function<void()> func);

    static bool atSignal(std::function<void(int)> func, int signal);
  };
}

#define QI_AT_ENTER(func)                                               \
  static bool QI_UNIQ_DEF(_qi_atenter) = ::qi::Application::atEnter(func);

#define QI_AT_EXIT(func)                                                \
  static bool QI_UNIQ_DEF(_qi_atexit) = ::qi::Application::atExit(func);

//THIS IS INTERNAL
//API is not maintained for this function
//The user need to include <boost/program_options.hpp> and <boost/bind.hpp>
//Use like this:
//namespace {
//  _QI_COMMAND_LINE_OPTIONS(
//    "Name of category",
//    (option1)
//    (option2)
//  )
//}
#define _QI_COMMAND_LINE_OPTIONS(desc, opts)                            \
  static void QI_UNIQ_DEF(_qi_opt_func)() {                             \
    namespace po = boost::program_options;                              \
    po::variables_map vm;                                               \
    po::command_line_parser p(::qi::Application::arguments());          \
    po::options_description options(desc);                              \
    {                                                                   \
      using namespace boost::program_options;                           \
      options.add_options() opts;                                       \
    }                                                                   \
    po::parsed_options res = p.options(options)                         \
      .allow_unregistered()                                             \
      .run();                                                           \
    po::store(res, vm);                                                 \
    /* Invoke notify callbacks*/                                        \
    po::notify(vm);                                                     \
    {                                                                   \
      po::options_description descTmp;                                  \
      descTmp.add_options()                                             \
        ("help,h", "");                                                 \
      po::variables_map vmTmp;                                          \
      po::store(po::command_line_parser(qi::Application::arguments())   \
                .options(descTmp).allow_unregistered().run(), vmTmp);   \
      if (vmTmp.count("help"))                                          \
        std::cout << options << std::endl;                              \
    }                                                                   \
    std::vector<std::string> args                                       \
      = po::collect_unrecognized(res.options, po::include_positional);  \
    /* Set arguments to what was not used */                            \
    ::qi::Application::setArguments(args);                              \
  }                                                                     \
  QI_AT_ENTER(boost::bind(&(QI_UNIQ_DEF(_qi_opt_func))))

#endif  // _QI_APPLICATION_HPP_