xbmc/platform/MessagePrinter.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include <string>
  12 #include <utility>
  13 #include <vector>
  14
  15 class CMessagePrinter
  16 {
  17 public:
  18
  19   /*! \brief Display a normal message to the user during startup
  20   *
  21   * \param[in] message  message to display
  22   */
  23   static void DisplayMessage(const std::string& message);
  24
  25   /*! \brief Display a warning message to the user during startup
  26   *
  27   * \param[in] warning   warning to display
  28   */
  29   static void DisplayWarning(const std::string& warning);
  30
  31   /*! \brief Display an error message to the user during startup
  32   *
  33   * \param[in] error  error to display
  34   */
  35   static void DisplayError(const std::string& error);
  36
  37   /*! \brief Display the help message with command line options available
  38   *
  39   * \param[in] help  List of commands and explanations,
  40                      help.push_back(std::make_pair("--help", "this displays the help))
  41   */
  42   static void DisplayHelpMessage(const std::vector<std::pair<std::string, std::string>>& help);
  43 };