helpwritercontext.cpp File Reference

#include "gmxpre.h"
#include "helpwritercontext.h"
#include <cctype>
#include <cstring>
#include <algorithm>
#include <memory>
#include <string>
#include <vector>
#include "gromacs/onlinehelp/helpformat.h"
#include "gromacs/utility/classhelpers.h"
#include "gromacs/utility/exceptions.h"
#include "gromacs/utility/gmxassert.h"
#include "gromacs/utility/programcontext.h"
#include "gromacs/utility/stringutil.h"
#include "gromacs/utility/textwriter.h"
#include "rstparser.h"

Include dependency graph for helpwritercontext.cpp:

Description

Implements gmx::HelpWriterContext.

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::anonymous_namespace{helpwritercontext.cpp}::IWrapper
	Custom output interface for HelpWriterContext::Impl::processMarkup(). More...
class	gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToString
	Wraps markup output into a single string. More...
class	gmx::anonymous_namespace{helpwritercontext.cpp}::WrapperToVector
	Wraps markup output into a vector of string (one line per element). More...
class	gmx::HelpLinks::Impl
	Private implementation class for HelpLinks. More...
class	gmx::HelpWriterContext::Impl
	Private implementation class for HelpWriterContext. More...
class	gmx::HelpWriterContext::Impl::SharedState
	Shared, non-modifiable state for context objects. More...

Functions
std::string	gmx::anonymous_namespace{helpwritercontext.cpp}::repall (const std::string &s, int nsr, const t_sandr sa[])
	Replaces all entries from a list of replacements.
template<size_t nsr>
std::string	gmx::anonymous_namespace{helpwritercontext.cpp}::repall (const std::string &s, const t_sandr(&sa)[nsr])
	Replaces all entries from a list of replacements.
std::string	gmx::anonymous_namespace{helpwritercontext.cpp}::removeExtraNewlinesRst (const std::string &text)
	Removes extra newlines from reStructuredText. More...

Variables
const char	gmx::anonymous_namespace{helpwritercontext.cpp}::g_titleChars [] = "=-^*~+#'_."
	Characters used for reStructuredText title underlining.
const t_sandr	gmx::anonymous_namespace{helpwritercontext.cpp}::sandrTty []
	List of replacements for console output. More...
const t_sandr	gmx::anonymous_namespace{helpwritercontext.cpp}::sandrRst []
	List of replacements for reStructuredText output. More...