Open
Graph Drawing
Framework

 v. 2023.09 (Elderberry)
 

pugi Namespace Reference

Classes

class  xml_attribute
 
class  xml_attribute_iterator
 
class  xml_document
 
class  xml_named_node_iterator
 
class  xml_node
 
class  xml_node_iterator
 
class  xml_object_range
 
struct  xml_parse_result
 
class  xml_text
 
class  xml_tree_walker
 
class  xml_writer
 
class  xml_writer_file
 
class  xml_writer_stream
 
class  xpath_node
 
class  xpath_node_set
 
struct  xpath_parse_result
 
class  xpath_query
 
class  xpath_variable
 
class  xpath_variable_set
 

Typedefs

using allocation_function = void *(*)(size_t size)
 
using char_t = PUGIXML_CHAR
 
using deallocation_function = void(*)(void *ptr)
 
using string_t = std::basic_string< PUGIXML_CHAR, std::char_traits< PUGIXML_CHAR >, std::allocator< PUGIXML_CHAR > >
 

Enumerations

enum  xml_encoding { encoding_auto, encoding_utf8, encoding_utf16_le, encoding_utf16_be, encoding_utf16, encoding_utf32_le, encoding_utf32_be, encoding_utf32, encoding_wchar, encoding_latin1 }
 
enum  xml_node_type { node_null, node_document, node_element, node_pcdata, node_cdata, node_comment, node_pi, node_declaration, node_doctype }
 
enum  xml_parse_status {
  status_ok = 0, status_file_not_found, status_io_error, status_out_of_memory, status_internal_error, status_unrecognized_tag, status_bad_pi, status_bad_comment, status_bad_cdata, status_bad_doctype, status_bad_pcdata, status_bad_start_element, status_bad_attribute, status_bad_end_element,
  status_end_element_mismatch, status_append_invalid_root, status_no_document_element
}
 
enum  xpath_value_type { xpath_type_none, xpath_type_node_set, xpath_type_number, xpath_type_string, xpath_type_boolean }
 

Functions

std::basic_string< char, std::char_traits< char >, std::allocator< char > > PUGIXML_FUNCTION as_utf8 (const std::basic_string< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > &str)
 
std::basic_string< char, std::char_traits< char >, std::allocator< char > > PUGIXML_FUNCTION as_utf8 (const wchar_t *str)
 
std::basic_string< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > PUGIXML_FUNCTION as_wide (const char *str)
 
std::basic_string< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > PUGIXML_FUNCTION as_wide (const std::basic_string< char, std::char_traits< char >, std::allocator< char > > &str)
 
allocation_function PUGIXML_FUNCTION get_memory_allocation_function ()
 
deallocation_function PUGIXML_FUNCTION get_memory_deallocation_function ()
 
void PUGIXML_FUNCTION set_memory_management_functions (allocation_function allocate, deallocation_function deallocate)
 

Variables

const unsigned int format_default = format_indent
 
const unsigned int format_indent = 0x01
 
const unsigned int format_indent_attributes = 0x40
 
const unsigned int format_no_declaration = 0x08
 
const unsigned int format_no_escapes = 0x10
 
const unsigned int format_raw = 0x04
 
const unsigned int format_save_file_text = 0x20
 
const unsigned int format_write_bom = 0x02
 
const unsigned int parse_cdata = 0x0004
 
const unsigned int parse_comments = 0x0002
 
const unsigned int parse_declaration = 0x0100
 
const unsigned int parse_default = parse_cdata | parse_escapes | parse_wconv_attribute | parse_eol
 
const unsigned int parse_doctype = 0x0200
 
const unsigned int parse_embed_pcdata = 0x2000
 
const unsigned int parse_eol = 0x0020
 
const unsigned int parse_escapes = 0x0010
 
const unsigned int parse_fragment = 0x1000
 
const unsigned int parse_full = parse_default | parse_pi | parse_comments | parse_declaration | parse_doctype
 
const unsigned int parse_minimal = 0x0000
 
const unsigned int parse_pi = 0x0001
 
const unsigned int parse_trim_pcdata = 0x0800
 
const unsigned int parse_wconv_attribute = 0x0040
 
const unsigned int parse_wnorm_attribute = 0x0080
 
const unsigned int parse_ws_pcdata = 0x0008
 
const unsigned int parse_ws_pcdata_single = 0x0400
 

Typedef Documentation

◆ allocation_function

using pugi::allocation_function = typedef void* (*)(size_t size)

Definition at line 1339 of file pugixml.h.

◆ char_t

using pugi::char_t = typedef PUGIXML_CHAR

Definition at line 86 of file pugixml.h.

◆ deallocation_function

using pugi::deallocation_function = typedef void (*)(void* ptr)

Definition at line 1342 of file pugixml.h.

◆ string_t

using pugi::string_t = typedef std::basic_string<PUGIXML_CHAR, std::char_traits<PUGIXML_CHAR>, std::allocator<PUGIXML_CHAR> >

Definition at line 90 of file pugixml.h.

Enumeration Type Documentation

◆ xml_encoding

Enumerator
encoding_auto 
encoding_utf8 
encoding_utf16_le 
encoding_utf16_be 
encoding_utf16 
encoding_utf32_le 
encoding_utf32_be 
encoding_utf32 
encoding_wchar 
encoding_latin1 

Definition at line 176 of file pugixml.h.

◆ xml_node_type

Enumerator
node_null 
node_document 
node_element 
node_pcdata 
node_cdata 
node_comment 
node_pi 
node_declaration 
node_doctype 

Definition at line 98 of file pugixml.h.

◆ xml_parse_status

Enumerator
status_ok 
status_file_not_found 
status_io_error 
status_out_of_memory 
status_internal_error 
status_unrecognized_tag 
status_bad_pi 
status_bad_comment 
status_bad_cdata 
status_bad_doctype 
status_bad_pcdata 
status_bad_start_element 
status_bad_attribute 
status_bad_end_element 
status_end_element_mismatch 
status_append_invalid_root 
status_no_document_element 

Definition at line 894 of file pugixml.h.

◆ xpath_value_type

Enumerator
xpath_type_none 
xpath_type_node_set 
xpath_type_number 
xpath_type_string 
xpath_type_boolean 

Definition at line 1016 of file pugixml.h.

Function Documentation

◆ as_utf8() [1/2]

std::basic_string<char, std::char_traits<char>, std::allocator<char> > PUGIXML_FUNCTION pugi::as_utf8 ( const std::basic_string< wchar_t, std::char_traits< wchar_t >, std::allocator< wchar_t > > &  str)

◆ as_utf8() [2/2]

std::basic_string<char, std::char_traits<char>, std::allocator<char> > PUGIXML_FUNCTION pugi::as_utf8 ( const wchar_t *  str)

◆ as_wide() [1/2]

std::basic_string<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> > PUGIXML_FUNCTION pugi::as_wide ( const char *  str)

◆ as_wide() [2/2]

std::basic_string<wchar_t, std::char_traits<wchar_t>, std::allocator<wchar_t> > PUGIXML_FUNCTION pugi::as_wide ( const std::basic_string< char, std::char_traits< char >, std::allocator< char > > &  str)

◆ get_memory_allocation_function()

allocation_function PUGIXML_FUNCTION pugi::get_memory_allocation_function ( )

◆ get_memory_deallocation_function()

deallocation_function PUGIXML_FUNCTION pugi::get_memory_deallocation_function ( )

◆ set_memory_management_functions()

void PUGIXML_FUNCTION pugi::set_memory_management_functions ( allocation_function  allocate,
deallocation_function  deallocate 
)

Variable Documentation

◆ format_default

const unsigned int pugi::format_default = format_indent

Definition at line 215 of file pugixml.h.

◆ format_indent

const unsigned int pugi::format_indent = 0x01

Definition at line 193 of file pugixml.h.

◆ format_indent_attributes

const unsigned int pugi::format_indent_attributes = 0x40

Definition at line 211 of file pugixml.h.

◆ format_no_declaration

const unsigned int pugi::format_no_declaration = 0x08

Definition at line 202 of file pugixml.h.

◆ format_no_escapes

const unsigned int pugi::format_no_escapes = 0x10

Definition at line 205 of file pugixml.h.

◆ format_raw

const unsigned int pugi::format_raw = 0x04

Definition at line 199 of file pugixml.h.

◆ format_save_file_text

const unsigned int pugi::format_save_file_text = 0x20

Definition at line 208 of file pugixml.h.

◆ format_write_bom

const unsigned int pugi::format_write_bom = 0x02

Definition at line 196 of file pugixml.h.

◆ parse_cdata

const unsigned int pugi::parse_cdata = 0x0004

Definition at line 124 of file pugixml.h.

◆ parse_comments

const unsigned int pugi::parse_comments = 0x0002

Definition at line 121 of file pugixml.h.

◆ parse_declaration

const unsigned int pugi::parse_declaration = 0x0100

Definition at line 143 of file pugixml.h.

◆ parse_default

const unsigned int pugi::parse_default = parse_cdata | parse_escapes | parse_wconv_attribute | parse_eol

Definition at line 168 of file pugixml.h.

◆ parse_doctype

const unsigned int pugi::parse_doctype = 0x0200

Definition at line 146 of file pugixml.h.

◆ parse_embed_pcdata

const unsigned int pugi::parse_embed_pcdata = 0x2000

Definition at line 163 of file pugixml.h.

◆ parse_eol

const unsigned int pugi::parse_eol = 0x0020

Definition at line 134 of file pugixml.h.

◆ parse_escapes

const unsigned int pugi::parse_escapes = 0x0010

Definition at line 131 of file pugixml.h.

◆ parse_fragment

const unsigned int pugi::parse_fragment = 0x1000

Definition at line 158 of file pugixml.h.

◆ parse_full

const unsigned int pugi::parse_full = parse_default | parse_pi | parse_comments | parse_declaration | parse_doctype

Definition at line 173 of file pugixml.h.

◆ parse_minimal

const unsigned int pugi::parse_minimal = 0x0000

Definition at line 115 of file pugixml.h.

◆ parse_pi

const unsigned int pugi::parse_pi = 0x0001

Definition at line 118 of file pugixml.h.

◆ parse_trim_pcdata

const unsigned int pugi::parse_trim_pcdata = 0x0800

Definition at line 154 of file pugixml.h.

◆ parse_wconv_attribute

const unsigned int pugi::parse_wconv_attribute = 0x0040

Definition at line 137 of file pugixml.h.

◆ parse_wnorm_attribute

const unsigned int pugi::parse_wnorm_attribute = 0x0080

Definition at line 140 of file pugixml.h.

◆ parse_ws_pcdata

const unsigned int pugi::parse_ws_pcdata = 0x0008

Definition at line 128 of file pugixml.h.

◆ parse_ws_pcdata_single

const unsigned int pugi::parse_ws_pcdata_single = 0x0400

Definition at line 151 of file pugixml.h.