help_messages.h

// -*-c++-*-
#ifndef STORMM_HELP_MESSAGES_H
#define STORMM_HELP_MESSAGES_H
 
#include <string>
#include <vector>
#include "copyright.h"
#include "Namelists/namelist_emulator.h"
#include "Namelists/namelist_inventory.h"
#include "reporting_enumerators.h"
 
namespace stormm {
namespace display {
 
using namelist::NamelistEmulator;
using namelist::NamelistToken;
  
bool detectHelpSignal(const int argc, const char* argv[],
                      HelpSignalKind kind = HelpSignalKind::KEYWORD,
                      const std::vector<std::string> &help_words = {});

bool displayNamelistHelp(const int argc, const char* argv[],
                         const std::vector<std::string> &module_name,
                         const std::vector<NamelistToken> &custom_namelists = {});
 
bool displayNamelistHelp(const int argc, const char* argv[], const std::string &module_name,
                         const std::vector<NamelistToken> &custom_namelists = {});
 
bool displayNamelistHelp(const std::string &module_name,
                         const std::vector<NamelistToken> &custom_namelists = {});
 
} // namespace display
} // namespace stormm
 
#endif