StringUtility/Diagnostics.h

#ifndef ROSE_StringUtility_Diagnostics_H
#define ROSE_StringUtility_Diagnostics_H
#include <RoseFirst.h>
#include <rosedll.h>
 
#include <boost/algorithm/string/erase.hpp>
#include <boost/algorithm/string/predicate.hpp>
#include <boost/algorithm/string/replace.hpp>
#include <boost/lexical_cast.hpp>
#include <cassert>
#include <string>
 
namespace Rose {
namespace StringUtility {
 
//                                      Functions related to diagnostic messages
 
ROSE_UTIL_API std::string indentMultilineString(const std::string& inputString, int statementColumnNumber);
 
ROSE_UTIL_API void add_to_reason_string(std::string &result, bool isset, bool do_pad,
                                        const std::string &abbr, const std::string &full);
 
 
ROSE_UTIL_API std::string appendAsmComment(const std::string &s, const std::string &comment);
 
std::string insertCommas(const std::string&);
 
template<typename T>
std::string plural(T n, const std::string &plural_phrase, const std::string &singular_phrase="") {
    assert(!plural_phrase.empty());
    std::string retval = insertCommas(boost::lexical_cast<std::string>(n)) + " ";
    if (1==n) {
        if (!singular_phrase.empty()) {
            retval += singular_phrase;
        } else if (boost::ends_with(plural_phrase, "vertices")) {
            retval += boost::replace_tail_copy(plural_phrase, 8, "vertex");
        } else if (boost::ends_with(plural_phrase, "indices")) {
            retval += boost::replace_tail_copy(plural_phrase, 7, "index");
        } else if (boost::ends_with(plural_phrase, "ies") && plural_phrase.size() > 3) {
            // string ends with "ies", as in "parties", so emit "party" instead
            retval += boost::replace_tail_copy(plural_phrase, 3, "y");
        } else if (boost::ends_with(plural_phrase, "sses") || boost::ends_with(plural_phrase, "indexes")) {
            // Sometimes we need to drop an "es" rather than just the "s"
            retval += boost::erase_tail_copy(plural_phrase, 2);
        } else if (boost::ends_with(plural_phrase, "s") && plural_phrase.size() > 1) {
            // strings ends with "s", as in "runners", so drop the final "s" to get "runner"
            retval += boost::erase_tail_copy(plural_phrase, 1);
        } else {
            // I give up.  Use the plural and risk being grammatically incorrect.
            retval += plural_phrase;
        }
    } else {
        retval += plural_phrase;
    }
    return retval;
}
 
// demangledName is defined in rose_support.cpp
std::string demangledName(std::string);
 
} // namespace
} // namespace
 
#endif