XmlParser Namespace Reference

Classes
struct	XMLParserDeleter
	deleter for a unique_ptr<XML_Parser> More...

Typedefs
using	XMLParserPtr = std::unique_ptr<std::remove_pointer_t<XML_Parser>, XMLParserDeleter>
	RAII XMLParser pointer.

Functions
std::string	xmlFileName (const std::string &fname, const std::string &prefix="")
	find the xml file locally or on the datapath, return the full filename
bool	debug_enabled ()
	true if XML debug mode is enabled in the environment
std::string	label (const std::source_location loc=std::source_location::current())
	report function name in a string, for debugging
XMLParserPtr	make_parser ()
	Create an RAII XMLParser pointer.
std::string	rtrim (const XML_Char *s, int len)
	Trim newline from end of a XML_Char * , return the trimmed string as std::string.

Typedef Documentation

XMLParserPtr

using XmlParser::XMLParserPtr = std::unique_ptr<std::remove_pointer_t<XML_Parser>, XMLParserDeleter>

RAII XMLParser pointer.

Definition at line 49 of file XMLParserUtilities.h.

Function Documentation

debug_enabled()

bool XmlParser::debug_enabled ( )

inline

true if XML debug mode is enabled in the environment

Definition at line 29 of file XMLParserUtilities.h.

                  {
    static const bool enabled = (std::getenv("XMLDEBUG") != nullptr);
    return enabled;
  }

label()

std::string XmlParser::label ( const std::source_location loc = std::source_location::current() )

inline

report function name in a string, for debugging

Definition at line 36 of file XMLParserUtilities.h.

                                                                 {
    return loc.function_name();
  }

make_parser()

XMLParserPtr XmlParser::make_parser ( )

inline

Create an RAII XMLParser pointer.

Definition at line 52 of file XMLParserUtilities.h.

                                   {
    XML_Parser p = XML_ParserCreate(nullptr);
    if (!p) {
      std::cout << "ExpatCoreParser::Couldn't allocate memory for parser" << std::endl;
      std::abort();
    }
    return XMLParserPtr{p};
  }

rtrim()

std::string XmlParser::rtrim ( const XML_Char * s, int len )

inline

Trim newline from end of a XML_Char * , return the trimmed string as std::string.

Definition at line 62 of file XMLParserUtilities.h.

                                   {
    while (len > 0 && s[len - 1] == '\n') {
      --len;
    }
    return (len > 0) ? std::string{s, static_cast<std::size_t>(len)} : std::string{};
  }

xmlFileName()

std::string XmlParser::xmlFileName	(	const std::string &	fname,
		const std::string &	prefix )

find the xml file locally or on the datapath, return the full filename

Definition at line 19 of file XMLParserUtilities.cxx.

                                                                 {
     if (fs::exists(fname) ) return fname;
     std::string fileWithPrefix = prefix + "/" + fname;
     if (fs::exists(fileWithPrefix) ) return fileWithPrefix;
     //
     const char* xmlpathenv = std::getenv ("XMLPATH");
     if (xmlpathenv == nullptr) return "";
     std::string xmlpath = xmlpathenv;
     std::string::size_type pos = 0;
     std::string temp_name;
     while (pos != std::string::npos){
       std::string::size_type sep = xmlpath.find (":", pos);
       if (sep == std::string::npos){
        temp_name = xmlpath.substr (pos);
        pos = std::string::npos;
       } else {
        temp_name = xmlpath.substr (pos, sep - pos);
        pos = sep + 1;
       }
       if (temp_name.empty()) continue;
       std::string last_temp_name = temp_name;
       temp_name += "/";
       temp_name += fname;
       if (fs::exists (temp_name)) return temp_name;
      // Test whether prefix is a relative path and if so use it
      if (prefix != "" && '/' != prefix[0]) {
        temp_name =  std::move(last_temp_name);
        temp_name += "/";
        temp_name += prefix;
        temp_name += "/";
        temp_name += fname;
        if (fs::exists (temp_name)) return temp_name;
      }
    }
    return "";
   }