Class: LibXML::XML::RelaxNG

Inherits:
Object
  • Object
show all
Defined in:
ext/libxml/ruby_xml_relaxng.c,
ext/libxml/ruby_xml_relaxng.c

Overview

The XML::RelaxNG class is used to prepare RelaxNG schemas for validation of xml documents.

Schemas can be created from XML documents, strings or URIs using the corresponding methods (new for URIs).

Once a schema is prepared, an XML document can be validated by the XML::Document#validate_relaxng method providing the XML::RelaxNG object as parameter. The method will raise an exception if the document is not valid.

Basic Usage:

# parse schema as xml document
relaxng_document = XML::Document.file('schema.rng')

# prepare schema for validation
relaxng_schema = XML::RelaxNG.document(relaxng_document)

# parse xml document to be validated
instance = XML::Document.file('instance.xml')

# validate
instance.validate_relaxng(relaxng_schema)

Class Method Summary collapse

Class Method Details

.XML::RelaxNG.document(document) ⇒ Object

Create a new relaxng from the specified document.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'ext/libxml/ruby_xml_relaxng.c', line 66

static VALUE rxml_relaxng_init_from_document(VALUE class, VALUE document)
{
  xmlDocPtr xdoc;
  xmlRelaxNGPtr xrelaxng;
  xmlRelaxNGParserCtxtPtr xparser;

  Data_Get_Struct(document, xmlDoc, xdoc);

  xparser = xmlRelaxNGNewDocParserCtxt(xdoc);
  xrelaxng = xmlRelaxNGParse(xparser);
  xmlRelaxNGFreeParserCtxt(xparser);

  return Data_Wrap_Struct(cXMLRelaxNG, NULL, rxml_relaxng_free, xrelaxng);
}

.XML::RelaxNG.string("relaxng_data") ⇒ Object

Create a new relaxng using the specified string.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'ext/libxml/ruby_xml_relaxng.c', line 87

static VALUE rxml_relaxng_init_from_string(VALUE self, VALUE relaxng_str)
{
  xmlRelaxNGParserCtxtPtr xparser;
  xmlRelaxNGPtr xrelaxng;

  Check_Type(relaxng_str, T_STRING);

  xparser = xmlRelaxNGNewMemParserCtxt(StringValuePtr(relaxng_str), strlen(
      StringValuePtr(relaxng_str)));
  xrelaxng = xmlRelaxNGParse(xparser);
  xmlRelaxNGFreeParserCtxt(xparser);

  return Data_Wrap_Struct(cXMLRelaxNG, NULL, rxml_relaxng_free, xrelaxng);
}

.XML::Relaxng.new(relaxng_uri) ⇒ Object

Create a new relaxng from the specified URI.



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'ext/libxml/ruby_xml_relaxng.c', line 46

static VALUE rxml_relaxng_init_from_uri(VALUE class, VALUE uri)
{
  xmlRelaxNGParserCtxtPtr xparser;
  xmlRelaxNGPtr xrelaxng;

  Check_Type(uri, T_STRING);

  xparser = xmlRelaxNGNewParserCtxt(StringValuePtr(uri));
  xrelaxng = xmlRelaxNGParse(xparser);
  xmlRelaxNGFreeParserCtxt(xparser);

  return Data_Wrap_Struct(cXMLRelaxNG, NULL, rxml_relaxng_free, xrelaxng);
}