help_options.h

Go to the documentation of this file.

/*
   Copyright (c) 2014, 2024, Oracle and/or its affiliates.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.
 
   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/
 
#ifndef HELP_OPTIONS_INCLUDED
#define HELP_OPTIONS_INCLUDED
 
#include "client/base/abstract_options_provider.h"
#include "my_compiler.h"
 
namespace Mysql {
namespace Tools {
namespace Base {
 
class Abtract_program;
 
namespace Options {
 
/**
  Options provider providing --help option and handling usage printing.
 */
class Help_options : public Abstract_options_provider {
 public:
  /**
    Constructs new help options provider.
    @param program Pointer to main program class, used to collect list of all
      options available in program.
   */
  explicit Help_options(Base::Abstract_program *program);
  /**
    Creates all options that will be provided.
    Implementation of Abstract_options_provider virtual method.
   */
  void create_options() override;
  /**
    Prints program usage message.
  */
  virtual void print_usage();
 
 private:
  void help_callback(char *argument [[maybe_unused]]);
  void version_callback(char *argument [[maybe_unused]]);
 
  void print_version_line();
 
  Abstract_program *m_program;
};
 
}  // namespace Options
}  // namespace Base
}  // namespace Tools
}  // namespace Mysql
 
#endif