dunedaq::oks::OksXmlOutputStream Class Reference

#include <xml.hpp>

Public Member Functions
	OksXmlOutputStream (std::ostream &p)
std::ostream &	get_stream () const
void	put (char c)
void	put (const char *s)
void	put_raw (char c)
void	put_raw (const char *s, long len)
template<class T>
void	put_value (T value)
void	put_quoted (const char *)
void	put_start_tag (const char *, size_t len)
void	put_end_tag ()
void	put_last_tag (const char *, size_t len)
void	put_attribute (const char *, size_t len, const char *)
void	put_attribute (const char *, size_t len, uint32_t)
void	put_attribute (const char *, size_t len, const OksData &)
void	put_eol ()

Static Private Member Functions
static void	__throw_write_failed ()

Private Attributes
std::ostream &	f

Detailed Description

Definition at line 125 of file xml.hpp.

Constructor & Destructor Documentation

OksXmlOutputStream()

dunedaq::oks::OksXmlOutputStream::OksXmlOutputStream ( std::ostream & p )

inline

Definition at line 129 of file xml.hpp.

    : f(p)
  {
    ;
  }

Member Function Documentation

__throw_write_failed()

void dunedaq::oks::OksXmlOutputStream::__throw_write_failed ( )

staticprivate

Definition at line 120 of file xml.cpp.

{
  throw std::runtime_error("write to file failed");
}

get_stream()

std::ostream & dunedaq::oks::OksXmlOutputStream::get_stream ( ) const

inline

Definition at line 135 of file xml.hpp.

{ return f; }

put() [1/2]

void dunedaq::oks::OksXmlOutputStream::put

(

char

c

)

Write char to xml output stream. Convert special symbols.

Exceptions

std::exception

if failed

Definition at line 131 of file xml.cpp.

{
  if (c == '<')
    put_raw(oks::xml::left_angle_bracket, sizeof(oks::xml::left_angle_bracket) - 1);
  else if (c == '>')
    put_raw(oks::xml::right_angle_bracket, sizeof(oks::xml::right_angle_bracket) - 1);
  else if (c == '&')
    put_raw(oks::xml::ampersand, sizeof(oks::xml::ampersand) - 1);
  else if (c == '\'')
    put_raw(oks::xml::single_quote, sizeof(oks::xml::single_quote) - 1);
  else if (c == '\"')
    put_raw(oks::xml::double_quote, sizeof(oks::xml::double_quote) - 1);
  else if (c == '\r')
    put_raw(oks::xml::carriage_return, sizeof(oks::xml::carriage_return) - 1);
  else if (c == '\n')
    put_raw(oks::xml::new_line, sizeof(oks::xml::new_line) - 1);
  else if (c == '\t')
    put_raw(oks::xml::tabulation, sizeof(oks::xml::tabulation) - 1);
  else
    put_raw(c);
}

put() [2/2]

void dunedaq::oks::OksXmlOutputStream::put

(

const char *

s

)

Write string to xml output stream. Convert special symbols.

Exceptions

std::exception

if failed

Definition at line 159 of file xml.cpp.

{
  while (*str)
    put(*str++);
}

put_attribute() [1/3]

void dunedaq::oks::OksXmlOutputStream::put_attribute	(	const char *	name,
		size_t	len,
		const char *	value )

Definition at line 230 of file xml.cpp.

{
  put_raw(' ');
  put_raw(name, len);
  put_raw('=');
  put_raw('\"');
  put(value);
  put_raw('\"');
}

put_attribute() [2/3]

void dunedaq::oks::OksXmlOutputStream::put_attribute	(	const char *	name,
		size_t	len,
		const OksData &	value )

Definition at line 259 of file xml.cpp.

{
  put_raw(' ');
  put_raw(name, len);
  put_raw('=');
  put_raw('\"');
  value.WriteTo(*this);
  put_raw('\"');
}

put_attribute() [3/3]

void dunedaq::oks::OksXmlOutputStream::put_attribute	(	const char *	name,
		size_t	len,
		uint32_t	value )

Definition at line 241 of file xml.cpp.

{
  put_raw(' ');
  put_raw(name, len);
  put_raw('=');
  put_raw('\"');
  if (value == 0) {
    put_raw('0');
  } else {
    char buf[12];
    char* ptr = buf;
    boost::spirit::karma::generate(ptr, boost::spirit::uint_, (unsigned int)value);
    put_raw(buf, ptr - buf);
  }
  put_raw('\"');
}

put_end_tag()

void dunedaq::oks::OksXmlOutputStream::put_end_tag

(

)

Definition at line 196 of file xml.cpp.

{
  static const char __end_tag[] = "/>\n";
  put_raw(__end_tag, sizeof(__end_tag) - 1);
}

put_eol()

void dunedaq::oks::OksXmlOutputStream::put_eol

(

)

Definition at line 203 of file xml.cpp.

{
  static const char __eol_tag[] = ">\n";
  put_raw(__eol_tag, sizeof(__eol_tag) - 1);
}

put_last_tag()

void dunedaq::oks::OksXmlOutputStream::put_last_tag	(	const char *	name,
		size_t	len )

Definition at line 215 of file xml.cpp.

{
  put_raw('<');
  put_raw('/');
  put_raw(name, len);
  put_raw('>');
  put_raw('\n');
}

put_quoted()

void dunedaq::oks::OksXmlOutputStream::put_quoted

(

const char *

str

)

Definition at line 171 of file xml.cpp.

{
  put_raw('\"');
  put(str);
  put_raw('\"');
}

put_raw() [1/2]

void dunedaq::oks::OksXmlOutputStream::put_raw ( char c )

inline

Write char to xml output stream without check for special symbols.

Exceptions

std::exception

if failed

Definition at line 153 of file xml.hpp.

  {
    if (__builtin_expect((f.rdbuf()->sputc(c) != c), 0))
      __throw_write_failed();
  }

put_raw() [2/2]

void dunedaq::oks::OksXmlOutputStream::put_raw ( const char * s, long len )

inline

Definition at line 159 of file xml.hpp.

  {
    if (__builtin_expect((f.rdbuf()->sputn(s, len) != len), 0))
      __throw_write_failed();
  }

put_start_tag()

void dunedaq::oks::OksXmlOutputStream::put_start_tag	(	const char *	name,
		size_t	len )

Definition at line 184 of file xml.cpp.

{
  put_raw('<');
  put_raw(name, len);
}

put_value()

template<class T>

void dunedaq::oks::OksXmlOutputStream::put_value ( T value )

inline

Definition at line 166 of file xml.hpp.

  {
    f << value;
  }

Member Data Documentation

f

std::ostream& dunedaq::oks::OksXmlOutputStream::f

private

Definition at line 188 of file xml.hpp.

---

The documentation for this class was generated from the following files:

• /github/workspace/dunedaq/sourcecode/oks/include/oks/xml.hpp
• /github/workspace/dunedaq/sourcecode/oks/src/xml.cpp