dunedaq::oks::OksXmlInputStream Class Reference

#include <xml.hpp>

Collaboration diagram for dunedaq::oks::OksXmlInputStream:

Public Member Functions
	OksXmlInputStream (std::shared_ptr< std::istream > p)
	~OksXmlInputStream ()
void	get_num_token (char last)
size_t	get_quoted ()
const char *	get_tag ()
const char *	get_tag_start ()
bool	good () const
bool	eof () const
void	store_position ()
void	restore_position ()
long	get_position () const
void	seek_position (std::streamoff off)
std::ostream &	error_msg (const char *)
unsigned long	get_line_no () const
unsigned long	get_line_pos () const
OksXmlToken &	get_xml_token ()
OksXmlValue	get_value (unsigned int len)
void	throw_unexpected_tag (const char *what, const char *expected=0)
void	throw_unexpected_attribute (const char *what)

Static Public Member Functions
static void	__throw_strto (const char *f, const char *where, const char *what, unsigned long line_no, unsigned long line_pos)

Private Member Functions
void	init ()
size_t	get_token (const char s1, OksXmlToken &token)
size_t	get_token2 (char, const char s1, const char s2, OksXmlToken &token)
void	get_token5 (const char s1, const char s2, const char s3, const char s4, const char s5, OksXmlToken &token)
char	cvt_char ()
char	get_first_non_empty ()
char	get ()
unsigned long	get_value_pre ()
void	get_value_post (unsigned long)
void	__throw_eof () const
	OksXmlInputStream (const OksXmlInputStream &)
OksXmlInputStream &	operator= (const OksXmlInputStream &)

Private Attributes
std::shared_ptr< std::istream >	f
std::streambuf *	m_pbuf
unsigned long	line_no
unsigned long	line_pos
char	last_read_c
std::istream::pos_type	pos
unsigned long	m_line_no_sav
unsigned long	m_line_pos_sav
OksXmlToken *	m_cvt_char
OksXmlToken *	m_v1
OksXmlToken *	m_v2
OksXmlToken *	m_v3

Static Private Attributes
static OksXmlTokenPool	s_tokens_pool

Friends
struct	OksXmlAttribute
struct	OksData
class	OksObject

Detailed Description

Definition at line 335 of file xml.hpp.

Constructor & Destructor Documentation

OksXmlInputStream() [1/2]

dunedaq::oks::OksXmlInputStream::OksXmlInputStream ( std::shared_ptr< std::istream > p )

inline

Definition at line 343 of file xml.hpp.

    : f(p)
    , m_pbuf(p->rdbuf())
    , line_no(1)
    , line_pos(0)
  {
    init();
  };

~OksXmlInputStream()

dunedaq::oks::OksXmlInputStream::~OksXmlInputStream ( )

inline

Definition at line 352 of file xml.hpp.

  {
    std::lock_guard lock(s_tokens_pool.m_mutex);
    s_tokens_pool.release(m_v3);
    s_tokens_pool.release(m_v2);
    s_tokens_pool.release(m_v1);
    s_tokens_pool.release(m_cvt_char);
  }

OksXmlInputStream() [2/2]

dunedaq::oks::OksXmlInputStream::OksXmlInputStream ( const OksXmlInputStream & )

private

Member Function Documentation

__throw_eof()

void dunedaq::oks::OksXmlInputStream::__throw_eof ( ) const

private

Definition at line 645 of file xml.cpp.

{
  throw std::runtime_error("unexpected end of file");
}

__throw_strto()

void dunedaq::oks::OksXmlInputStream::__throw_strto ( const char * f, const char * where, const char * what, unsigned long line_no, unsigned long line_pos )

static

Definition at line 651 of file xml.cpp.

{
  std::ostringstream text;
  text << "function " << f << "(\'" << what << "\') has failed";
  if (*where)
    text << " on unrecognized characters \'" << where << "\'";
  if (errno)
    text << " with code " << errno << ", reason = \'" << oks::strerror(errno) << '\'';
  throw oks::BadFileData(text.str(), line_no, line_pos);
}

cvt_char()

char dunedaq::oks::OksXmlInputStream::cvt_char ( )

private

Read encoded symbol (&xxx;)

Definition at line 610 of file xml.cpp.

{
  get_token(';', *m_cvt_char);
 
  if (oks::cmp_str2n(m_cvt_char->m_buf, oks::xml::left_angle_bracket + 1))
    return '<';
  else if (oks::cmp_str2n(m_cvt_char->m_buf, oks::xml::right_angle_bracket + 1))
    return '>';
  else if (oks::cmp_str3n(m_cvt_char->m_buf, oks::xml::ampersand + 1))
    return '&';
  else if (oks::cmp_str3n(m_cvt_char->m_buf, oks::xml::carriage_return + 1))
    return '\r';
  else if (oks::cmp_str3n(m_cvt_char->m_buf, oks::xml::new_line + 1))
    return '\n';
  else if (oks::cmp_str3n(m_cvt_char->m_buf, oks::xml::tabulation + 1))
    return '\t';
  else if (oks::cmp_str4n(m_cvt_char->m_buf, oks::xml::single_quote + 1))
    return '\'';
  else if (oks::cmp_str4n(m_cvt_char->m_buf, oks::xml::double_quote + 1))
    return '\"';
  else {
    std::string text("bad symbol \'&");
    text += m_cvt_char->m_buf;
    text += '\'';
    throw std::runtime_error(text.c_str());
  }
}

eof()

bool dunedaq::oks::OksXmlInputStream::eof ( ) const

inline

Definition at line 380 of file xml.hpp.

{ return f->eof(); }

error_msg()

std::ostream & dunedaq::oks::OksXmlInputStream::error_msg

(

const char *

msg

)

Definition at line 639 of file xml.cpp.

{
  return Oks::error_msg(msg) << "(line " << line_no << ", char " << line_pos << ")\n";
}

get()

char dunedaq::oks::OksXmlInputStream::get ( )

inlineprivate

Definition at line 478 of file xml.hpp.

{
  char c(m_pbuf->sbumpc());
 
  line_pos++;
  if (__builtin_expect((c == EOF), 0))
    __throw_eof();
  else if (__builtin_expect((c == '\n'), 0)) {
    line_no++;
    line_pos = 0;
  }
 
  return c;
}

get_first_non_empty()

char dunedaq::oks::OksXmlInputStream::get_first_non_empty ( )

inlineprivate

Definition at line 499 of file xml.hpp.

{
  while (true) {
    char c(get());
    if (c == ' ' || c == '\n' || c == '\r' || c == '\t')
      continue;
    else
      return c;
  }
}

get_line_no()

unsigned long dunedaq::oks::OksXmlInputStream::get_line_no ( ) const

inline

Definition at line 400 of file xml.hpp.

{ return line_no; }

get_line_pos()

unsigned long dunedaq::oks::OksXmlInputStream::get_line_pos ( ) const

inline

Definition at line 401 of file xml.hpp.

{ return line_pos; }

get_num_token()

void dunedaq::oks::OksXmlInputStream::get_num_token

(

char

last

)

get_position()

long dunedaq::oks::OksXmlInputStream::get_position ( ) const

inline

Definition at line 394 of file xml.hpp.

{ return f->tellg(); }

get_quoted()

size_t dunedaq::oks::OksXmlInputStream::get_quoted

(

)

Definition at line 297 of file xml.cpp.

{
  size_t pos(0);
 
  try {
    char c = get_first_non_empty();
 
    if (__builtin_expect((c != '\"'), 0)) {
      __throw_runtime_error_unexpected_symbol('\"', c);
    }
 
    while (true) {
      c = get();
 
      if (__builtin_expect((c == '\"'), 0)) {
        m_v1->m_buf[pos] = 0;
        return pos;
      } else if (__builtin_expect((c == '&'), 0)) {
        c = cvt_char();
      }
 
      m_v1->realloc(pos);
      m_v1->m_buf[pos++] = c;
    }
 
    throw std::runtime_error("cannot find closing quote character");
  } catch (std::exception& ex) {
    m_v1->m_buf[pos] = 0;
    throw oks::BadFileData(std::string("Failed to read quoted string: ") + ex.what(), line_no, line_pos);
  }
}

get_tag()

const char * dunedaq::oks::OksXmlInputStream::get_tag

(

)

Definition at line 343 of file xml.cpp.

{
  m_v1->m_buf[0] = 0;
 
  unsigned long start_line_no = line_no;
  unsigned long start_line_pos = line_pos;
 
  size_t pos(0);
 
  try {
    while (true) {
      char c(get_first_non_empty());
 
      if (__builtin_expect((c != '<'), 0)) {
        __throw_bad_file_data_unexpected_symbol("start-of-tag", '<', c, line_no, line_pos);
      }
 
      start_line_no = line_no;
      start_line_pos = line_pos;
 
      m_v1->m_buf[0] = c;
      pos = 1;
 
      int count(1);
 
      while (true) {
        char c2 = get();
 
        if (c2 == '<')
          count++;
        else if (c2 == '>')
          count--;
 
        m_v1->realloc(pos);
        m_v1->m_buf[pos++] = c2;
 
        if (pos > 3) {
          if (__is_comment(m_v1->m_buf + pos - 4)) {
            char buf[3] = { 0, 0, 0 };
            unsigned long start_comment_line_no = line_no;
            try {
              while (true) {
                buf[0] = buf[1];
                buf[1] = buf[2];
                buf[2] = get();
 
                if (oks::cmp_str3n(buf, "-->")) {
                  break; // end of comment = '-->'
                }
              }
            } catch (std::exception& failure) {
              std::ostringstream what;
              what << "Cannot find end of comment started on line " << start_comment_line_no << ": " << failure.what();
              throw oks::BadFileData(what.str(), line_no, line_pos);
            }
 
            pos -= 4;
            count--;
          }
        }
 
        if (count == 0) {
          m_v1->m_buf[pos] = '\0';
          break;
        }
      }
 
      if (pos > 0) {
        if (count != 0) {
          throw std::runtime_error("unbalanced tags");
        } else {
          return m_v1->m_buf;
        }
      }
    }
  } catch (std::exception& ex) {
    m_v1->m_buf[pos] = '\0';
    throw oks::BadFileData(std::string(ex.what()) + " when read xml tag started at", start_line_no, start_line_pos);
  }
}

get_tag_start()

const char * dunedaq::oks::OksXmlInputStream::get_tag_start

(

)

Definition at line 510 of file xml.cpp.

{
  try {
    while (true) {
      char c = get_first_non_empty();
 
      if (__builtin_expect((c != '<'), 0)) {
        __throw_runtime_error_unexpected_symbol('<', c);
      }
 
      get_token5(' ', '>', '\t', '\n', '\r', *m_v1);
      TLOG_DEBUG(8) << "read tag \'" << m_v1->m_buf << '\'';
 
      if (__builtin_expect((oks::cmp_str3n(m_v1->m_buf, "!--")), 0)) {
        char buf[3] = { 0, 0, 0 };
        unsigned long start_comment_line_no = line_no;
        auto tag_len = strlen(m_v1->m_buf);
        if (tag_len < 5 || !oks::cmp_str2n(m_v1->m_buf + tag_len - 2,
                                           "--")) // special case for comments without empty symbols like <!--foo-->
          try {
            while (true) {
              buf[0] = buf[1];
              buf[1] = buf[2];
              c = buf[2] = get();
              if (oks::cmp_str3n(buf, "-->")) {
                break; // end of comment = '-->'
              }
            }
          } catch (std::exception& failure) {
            std::ostringstream what;
            what << "Cannot find end of comment started on line " << start_comment_line_no << ": " << failure.what();
            throw oks::BadFileData(what.str(), line_no, line_pos);
          }
      }
 
      if (__builtin_expect((c != '>'), 1))
        return m_v1->m_buf;
    }
  } catch (std::exception& ex) {
    throw oks::BadFileData(std::string("Failed to read start-of-tag: ") + ex.what(), line_no, line_pos);
  }
 
  return 0; // never reach this line
}

get_token()

size_t dunedaq::oks::OksXmlInputStream::get_token ( const char s1, OksXmlToken & token )

inlineprivate

Read token (one separator)

Definition at line 430 of file xml.cpp.

{
  size_t pos(0);
 
  while (true) {
    last_read_c = get();
 
    if (last_read_c == __s1) {
      token.m_buf[pos] = '\0';
      return pos;
    } else if (__builtin_expect((last_read_c == '&'), 0))
      last_read_c = cvt_char();
 
    token.realloc(pos);
    token.m_buf[pos++] = last_read_c;
  }
 
  token.m_buf[pos] = 0;
 
  throw std::runtime_error("cannot find closing separator while read token");
}

get_token2()

size_t dunedaq::oks::OksXmlInputStream::get_token2 ( char __fs, const char s1, const char s2, OksXmlToken & token )

inlineprivate

Read token (two separators)

Definition at line 453 of file xml.cpp.

{
  size_t pos(1);
  token.m_buf[0] = __fs;
  if (__fs == __s1 || __fs == __s2) {
    token.m_buf[1] = '\0';
    return 1;
  }
 
  while (true) {
    last_read_c = get();
 
    if (last_read_c == __s1 || last_read_c == __s2) {
      token.m_buf[pos] = '\0';
      return pos;
    } else if (__builtin_expect((last_read_c == '&'), 0))
      last_read_c = cvt_char();
 
    token.realloc(pos);
    token.m_buf[pos++] = last_read_c;
  }
 
  token.m_buf[pos] = 0;
 
  throw std::runtime_error("cannot find closing separator while read token");
}

get_token5()

void dunedaq::oks::OksXmlInputStream::get_token5 ( const char s1, const char s2, const char s3, const char s4, const char s5, OksXmlToken & token )

inlineprivate

Read token (five separators)

Definition at line 481 of file xml.cpp.

{
  size_t pos(0);
 
  while (true) {
    last_read_c = get();
 
    if (last_read_c == __s1 || last_read_c == __s2 || last_read_c == __s3 || last_read_c == __s4 ||
        last_read_c == __s5) {
      token.m_buf[pos] = '\0';
      return;
    } else if (__builtin_expect((last_read_c == '&'), 0))
      last_read_c = cvt_char();
 
    token.realloc(pos);
    token.m_buf[pos++] = last_read_c;
  }
 
  token.m_buf[pos] = 0;
 
  throw std::runtime_error("cannot find closing separator while read token");
}

get_value()

OksXmlValue dunedaq::oks::OksXmlInputStream::get_value ( unsigned int len )

inline

Definition at line 405 of file xml.hpp.

  {
    OksXmlValue value(m_v2, len, line_no, line_pos);
    m_v2 = m_v3;
    m_v3 = value.get_token();
    return value;
  }

get_value_post()

void dunedaq::oks::OksXmlInputStream::get_value_post ( unsigned long )

inlineprivate

get_value_pre()

unsigned long dunedaq::oks::OksXmlInputStream::get_value_pre ( )

inlineprivate

get_xml_token()

OksXmlToken & dunedaq::oks::OksXmlInputStream::get_xml_token ( )

inline

Definition at line 403 of file xml.hpp.

{ return *m_v1; }

good()

bool dunedaq::oks::OksXmlInputStream::good ( ) const

inline

Definition at line 379 of file xml.hpp.

{ return f->good(); }

init()

void dunedaq::oks::OksXmlInputStream::init ( )

inlineprivate

Definition at line 436 of file xml.hpp.

  {
    f->setf(std::ios::showbase, std::ios::basefield);
    f->exceptions(std::istream::eofbit | std::istream::failbit | std::istream::badbit);
 
    std::lock_guard lock(s_tokens_pool.m_mutex);
    m_cvt_char = s_tokens_pool.get();
    m_v1 = s_tokens_pool.get();
    m_v2 = s_tokens_pool.get();
    m_v3 = s_tokens_pool.get();
  }

operator=()

OksXmlInputStream & dunedaq::oks::OksXmlInputStream::operator= ( const OksXmlInputStream & )

private

restore_position()

void dunedaq::oks::OksXmlInputStream::restore_position ( )

inline

Definition at line 388 of file xml.hpp.

  {
    f->seekg(pos);
    line_no = m_line_no_sav;
    line_pos = m_line_pos_sav;
  }

seek_position()

void dunedaq::oks::OksXmlInputStream::seek_position ( std::streamoff off )

inline

Definition at line 396 of file xml.hpp.

{ f->seekg(off, std::ios_base::cur); }

store_position()

void dunedaq::oks::OksXmlInputStream::store_position ( )

inline

Definition at line 382 of file xml.hpp.

  {
    pos = f->tellg();
    m_line_no_sav = line_no;
    m_line_pos_sav = line_pos;
  }

throw_unexpected_attribute()

void dunedaq::oks::OksXmlInputStream::throw_unexpected_attribute

(

const char *

what

)

Definition at line 291 of file xml.cpp.

{
  throw oks::BadFileData(std::string("Value \'") + what + "\' is not a valid attribute name", line_no, line_pos);
}

throw_unexpected_tag()

void dunedaq::oks::OksXmlInputStream::throw_unexpected_tag	(	const char *	what,
		const char *	expected = 0 )

Definition at line 270 of file xml.cpp.

{
  std::ostringstream s;
 
  if (!*what) {
    if (expected) {
      s << "expected tag \'" << expected << '\'';
    } else {
      s << "empty tag";
    }
  } else {
    s << "unexpected tag \'" << what << '\'';
    if (expected) {
      s << " instead of \'" << expected << '\'';
    }
  }
 
  throw oks::BadFileData(s.str(), line_no, line_pos);
}

Friends And Related Symbol Documentation

OksData

friend struct OksData

friend

Definition at line 339 of file xml.hpp.

OksObject

friend class OksObject

friend

Definition at line 340 of file xml.hpp.

OksXmlAttribute

friend struct OksXmlAttribute

friend

Definition at line 338 of file xml.hpp.

Member Data Documentation

f

std::shared_ptr<std::istream> dunedaq::oks::OksXmlInputStream::f

private

Definition at line 417 of file xml.hpp.

last_read_c

char dunedaq::oks::OksXmlInputStream::last_read_c

private

Definition at line 422 of file xml.hpp.

line_no

unsigned long dunedaq::oks::OksXmlInputStream::line_no

private

Definition at line 419 of file xml.hpp.

line_pos

unsigned long dunedaq::oks::OksXmlInputStream::line_pos

private

Definition at line 420 of file xml.hpp.

m_cvt_char

OksXmlToken* dunedaq::oks::OksXmlInputStream::m_cvt_char

private

Definition at line 431 of file xml.hpp.

m_line_no_sav

unsigned long dunedaq::oks::OksXmlInputStream::m_line_no_sav

private

Definition at line 426 of file xml.hpp.

m_line_pos_sav

unsigned long dunedaq::oks::OksXmlInputStream::m_line_pos_sav

private

Definition at line 427 of file xml.hpp.

m_pbuf

std::streambuf* dunedaq::oks::OksXmlInputStream::m_pbuf

private

Definition at line 418 of file xml.hpp.

m_v1

OksXmlToken* dunedaq::oks::OksXmlInputStream::m_v1

private

Definition at line 432 of file xml.hpp.

m_v2

OksXmlToken* dunedaq::oks::OksXmlInputStream::m_v2

private

Definition at line 433 of file xml.hpp.

m_v3

OksXmlToken* dunedaq::oks::OksXmlInputStream::m_v3

private

Definition at line 434 of file xml.hpp.

pos

std::istream::pos_type dunedaq::oks::OksXmlInputStream::pos

private

Definition at line 424 of file xml.hpp.

s_tokens_pool

OksXmlTokenPool dunedaq::oks::OksXmlInputStream::s_tokens_pool

staticprivate

Definition at line 429 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