oomph::DebugHelpers Namespace Reference

Functions
std::string	debug_string (const std::string &filename, const int &line, const bool &make_new_line)

Detailed Description

Namespace for debugging helpers. Currently only contains a function to prett-ify file name and line numbers (in red) to use when debugging. Makes it easy to identify where a std::cout statement was called.

Function Documentation

debug_string()

std::string oomph::DebugHelpers::debug_string	(	const std::string &	filename,
		const int &	line,
		const bool &	make_new_line
	)

Return the concaternation of the initials of the input file name and line number. The make_new_line flag indicates whether the string starts with a "\n", i.e. a new line

Return the concaternation of the initials of the input file name and line number. The make_new_line flag indicates whether the string starts on a new line or not

    {
      // Make a string
      std::string debug_string;
 
      // Temporary storage for the filename which can be edited
      std::string file = filename;
 
      // The delimeter
      std::string delimiter = "_";
 
      // Posiiton of the delimiter
      size_t pos = 0;
 
      // The string before the delimiter
      std::string token;
 
      // Get the filename (gets rid of e.g. ./ before filename)
      while ((pos = file.find("/")) != std::string::npos)
      {
        // Get the string before the delimiter
        token = file.substr(0, pos);
 
        // Erase the string before the delimeter
        file = file.substr(pos + delimiter.length());
      }
 
      // While we can find delimeters
      while ((pos = file.find(delimiter)) != std::string::npos)
      {
        // Get the string before the delimiter
        token = file.substr(0, pos);
 
        // Output the string
        debug_string += toupper(token.at(0));
 
        // Erase the delimeter
        file = file.substr(pos + delimiter.length());
      }
 
      // Output the string
      debug_string += toupper(file.at(0));
 
      // String stream
      std::ostringstream debug_stream;
 
      // If they want a new line
      if (make_new_line)
      {
        // Add a newline string
        debug_stream << "\n";
      }
 
      // Create debug string
      debug_stream << "\033[1;31m" << debug_string << line << ":\033[0m ";
 
      // Return the string
      return debug_stream.str();
    } // End of create_debug_string

References MergeRestartFiles::filename, calibrate::line, and oomph::Global_string_for_annotation::string().