Class: LibXML::XML::Parser::Context

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

Overview

The XML::Parser::Context class provides in-depth control over how a document is parsed.

Direct Known Subclasses

HTMLParser::Context

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.XML::Parser::Context.document(document) ⇒ XML::Parser::Context

Creates a new parser context based on the specified document.

Parameters:

document - An XML::Document instance.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 42

static VALUE rxml_parser_context_document(VALUE klass, VALUE document)
{
  xmlParserCtxtPtr ctxt;
  xmlDocPtr xdoc;
  xmlChar *buffer; 
  int length;

  if (rb_obj_is_kind_of(document, cXMLDocument) == Qfalse)
    rb_raise(rb_eTypeError, "Must pass an XML::Document object");

  Data_Get_Struct(document, xmlDoc, xdoc);
  xmlDocDumpFormatMemoryEnc(xdoc, &buffer, &length, xdoc->encoding, 0);

  ctxt = xmlCreateDocParserCtxt(buffer);

  if (!ctxt)
    rxml_raise(&xmlLastError);

  /* This is annoying, but xmlInitParserCtxt (called indirectly above) and 
     xmlCtxtUseOptionsInternal (called below) initialize slightly different
     context options, in particular XML_PARSE_NODICT which xmlInitParserCtxt
     sets to 0 and xmlCtxtUseOptionsInternal sets to 1.  So we have to call both. */
  xmlCtxtUseOptions(ctxt, rxml_libxml_default_options());

  return rxml_parser_context_wrap(ctxt);
}

.XML::Parser::Context.file(file) ⇒ XML::Parser::Context

Creates a new parser context based on the specified file or uri.

Parameters:

file - A filename or uri.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 78

static VALUE rxml_parser_context_file(VALUE klass, VALUE file)
{
  xmlParserCtxtPtr ctxt = xmlCreateURLParserCtxt(StringValuePtr(file), 0);

  if (!ctxt)
    rxml_raise(&xmlLastError);

  /* This is annoying, but xmlInitParserCtxt (called indirectly above) and 
     xmlCtxtUseOptionsInternal (called below) initialize slightly different
     context options, in particular XML_PARSE_NODICT which xmlInitParserCtxt
     sets to 0 and xmlCtxtUseOptionsInternal sets to 1.  So we have to call both. */
  xmlCtxtUseOptions(ctxt, rxml_libxml_default_options());

  return rxml_parser_context_wrap(ctxt);
}

.XML::Parser::Context.io(io) ⇒ XML::Parser::Context

Creates a new parser context based on the specified io object.

Parameters:

io - A ruby IO object.

Returns:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 135

static VALUE rxml_parser_context_io(VALUE klass, VALUE io)
{
  VALUE result;
  xmlParserCtxtPtr ctxt;
  xmlParserInputBufferPtr input;
  xmlParserInputPtr stream;

  if (NIL_P(io))
    rb_raise(rb_eTypeError, "Must pass in an IO object");

  input = xmlParserInputBufferCreateIO((xmlInputReadCallback) rxml_read_callback, NULL,
                                       (void*)io, XML_CHAR_ENCODING_NONE);
    
  ctxt = xmlNewParserCtxt();

  if (!ctxt)
  {
    xmlFreeParserInputBuffer(input);
    rxml_raise(&xmlLastError);
  }

  /* This is annoying, but xmlInitParserCtxt (called indirectly above) and 
     xmlCtxtUseOptionsInternal (called below) initialize slightly different
     context options, in particular XML_PARSE_NODICT which xmlInitParserCtxt
     sets to 0 and xmlCtxtUseOptionsInternal sets to 1.  So we have to call both. */
  xmlCtxtUseOptions(ctxt, rxml_libxml_default_options());

  stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);

  if (!stream)
  {
    xmlFreeParserInputBuffer(input);
    xmlFreeParserCtxt(ctxt);
    rxml_raise(&xmlLastError);
  }
  inputPush(ctxt, stream);
  result = rxml_parser_context_wrap(ctxt);

  /* Attach io object to parser so it won't get freed.*/
  rb_ivar_set(result, IO_ATTR, io);

  return result;
}

.XML::Parser::Context.string(string) ⇒ XML::Parser::Context

Creates a new parser context based on the specified string.

Parameters:

string - A string that contains the data to parse.

Returns:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 103

static VALUE rxml_parser_context_string(VALUE klass, VALUE string)
{
  xmlParserCtxtPtr ctxt;
  Check_Type(string, T_STRING);

  if (RSTRING_LEN(string) == 0)
    rb_raise(rb_eArgError, "Must specify a string with one or more characters");

  ctxt = xmlCreateMemoryParserCtxt(StringValuePtr(string),
                                   RSTRING_LEN(string));
  
  if (!ctxt)
    rxml_raise(&xmlLastError);

  /* This is annoying, but xmlInitParserCtxt (called indirectly above) and 
     xmlCtxtUseOptionsInternal (called below) initialize slightly different
     context options, in particular XML_PARSE_NODICT which xmlInitParserCtxt
     sets to 0 and xmlCtxtUseOptionsInternal sets to 1.  So we have to call both. */
  xmlCtxtUseOptions(ctxt, rxml_libxml_default_options());

  return rxml_parser_context_wrap(ctxt);
}

Instance Method Details

#base_uri ⇒ Object

Obtain the base url for this parser context.



185
186
187
188
189
190
191
192
193
194
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 185

static VALUE rxml_parser_context_base_uri_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->input && ctxt->input->filename)
    return rxml_new_cstr(ctxt->input->filename, ctxt->encoding);
  else
    return Qnil;
}

#base_uri=(url) ⇒ Object

Sets the base url for this parser context.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 202

static VALUE rxml_parser_context_base_uri_set(VALUE self, VALUE url)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  Check_Type(url, T_STRING);

  if (ctxt->input && !ctxt->input->filename)
  {
    const xmlChar * xurl = StringValuePtr(url);
    ctxt->input->filename = (char *) xmlStrdup(xurl);
  }
  return self;
}

#data_directory ⇒ Object

Obtain the data directory associated with this context.



224
225
226
227
228
229
230
231
232
233
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 224

static VALUE rxml_parser_context_data_directory_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->directory == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr(ctxt->directory, ctxt->encoding));
}

#depth ⇒ Numeric

Obtain the depth of this context.

Returns:

  • (Numeric) 


241
242
243
244
245
246
247
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 241

static VALUE rxml_parser_context_depth_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->depth));
}

#disable_cdata=(bool) ⇒ Object

Control whether CDATA nodes will be created in this context.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 273

static VALUE rxml_parser_context_disable_cdata_set(VALUE self, VALUE bool)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->sax == NULL)
    rb_raise(rb_eRuntimeError, "Sax handler is not yet set");

  /* LibXML controls this internally with the default SAX handler. */ 
  if (bool)
    ctxt->sax->cdataBlock = NULL;
  else
    ctxt->sax->cdataBlock = xmlDefaultSAXHandler.cdataBlock;

  return bool;
}

#disable_cdata? ⇒ Boolean

Determine whether CDATA nodes will be created in this context.

Returns:

  • (Boolean) 


255
256
257
258
259
260
261
262
263
264
265
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 255

static VALUE rxml_parser_context_disable_cdata_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  /* LibXML controls this internally with the default SAX handler. */
  if (ctxt->sax && ctxt->sax->cdataBlock)
    return (Qfalse);
  else
    return (Qtrue);
}

#disable_sax? ⇒ Boolean

Determine whether SAX-based processing is disabled in this context.

Returns:

  • (Boolean) 


297
298
299
300
301
302
303
304
305
306
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 297

static VALUE rxml_parser_context_disable_sax_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->disableSAX)
    return (Qtrue);
  else
    return (Qfalse);
}

#docbook? ⇒ Boolean

Determine whether this is a docbook context.

Returns:

  • (Boolean) 


314
315
316
317
318
319
320
321
322
323
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 314

static VALUE rxml_parser_context_docbook_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->html == 2) // TODO check this
    return (Qtrue);
  else
    return (Qfalse);
}

#encoding ⇒ XML::Encoding::UTF_8

Obtain the character encoding identifier used in this context.

Returns:



332
333
334
335
336
337
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 332

static VALUE rxml_parser_context_encoding_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);
  return INT2NUM(xmlParseCharEncoding(ctxt->encoding));
}

#encoding=(XML) ⇒ Object

Sets the character encoding for this context.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 345

static VALUE rxml_parser_context_encoding_set(VALUE self, VALUE encoding)
{
  xmlParserCtxtPtr ctxt;
  int result;
  const char* xencoding = xmlGetCharEncodingName((xmlCharEncoding)NUM2INT(encoding));
  xmlCharEncodingHandlerPtr hdlr = xmlFindCharEncodingHandler(xencoding);
  
  if (!hdlr)
    rb_raise(rb_eArgError, "Unknown encoding: %i", NUM2INT(encoding));

  Data_Get_Struct(self, xmlParserCtxt, ctxt);
  result = xmlSwitchToEncoding(ctxt, hdlr);

  if (result != 0)
    rxml_raise(&xmlLastError);

  if (ctxt->encoding != NULL)
    xmlFree((xmlChar *) ctxt->encoding);

  ctxt->encoding = xmlStrdup((const xmlChar *) xencoding);
  return self;
}

#errno ⇒ Numeric

Obtain the last-error number in this context.

Returns:

  • (Numeric) 


374
375
376
377
378
379
380
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 374

static VALUE rxml_parser_context_errno_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->errNo));
}

#html? ⇒ Boolean

Determine whether this is an html context.

Returns:

  • (Boolean) 


388
389
390
391
392
393
394
395
396
397
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 388

static VALUE rxml_parser_context_html_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->html == 1)
    return (Qtrue);
  else
    return (Qfalse);
}

#max_num_streams ⇒ Numeric

Obtain the limit on the number of IO streams opened in this context.

Returns:

  • (Numeric) 


406
407
408
409
410
411
412
413
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 406

static VALUE rxml_parser_context_io_max_num_streams_get(VALUE self)
{
  // TODO alias to max_streams and dep this?
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->inputMax));
}

#num_streams ⇒ Object

Obtain the actual number of IO streams in this context.



422
423
424
425
426
427
428
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 422

static VALUE rxml_parser_context_io_num_streams_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->inputNr));
}

#keep_blanks? ⇒ Boolean

Determine whether parsers in this context retain whitespace.

Returns:

  • (Boolean) 


437
438
439
440
441
442
443
444
445
446
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 437

static VALUE rxml_parser_context_keep_blanks_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->keepBlanks)
    return (Qtrue);
  else
    return (Qfalse);
}

#name_depth ⇒ Numeric

Obtain the name depth for this context.

Returns:

  • (Numeric) 


454
455
456
457
458
459
460
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 454

static VALUE rxml_parser_context_name_depth_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->nameNr));
}

#name_depth_max ⇒ Numeric

Obtain the maximum name depth for this context.

Returns:

  • (Numeric) 


468
469
470
471
472
473
474
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 468

static VALUE rxml_parser_context_name_depth_max_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->nameMax));
}

#name_node ⇒ Object

Obtain the name node for this context.



482
483
484
485
486
487
488
489
490
491
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 482

static VALUE rxml_parser_context_name_node_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->name == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr((const char*) ctxt->name, ctxt->encoding));
}

#name_tab ⇒ Array

Obtain the name table for this context.

Returns:

  • (Array) 


499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 499

static VALUE rxml_parser_context_name_tab_get(VALUE self)
{
  int i;
  xmlParserCtxtPtr ctxt;
  VALUE tab_ary;

  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->nameTab == NULL)
    return (Qnil);

  tab_ary = rb_ary_new();

  for (i = (ctxt->nameNr - 1); i >= 0; i--)
  {
    if (ctxt->nameTab[i] == NULL)
      continue;
    else
      rb_ary_push(tab_ary, rxml_new_cstr((const char*) ctxt->nameTab[i], ctxt->encoding));
  }

  return (tab_ary);
}

#node ⇒ Object

Obtain the root node of this context.



543
544
545
546
547
548
549
550
551
552
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 543

static VALUE rxml_parser_context_node_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->node == NULL)
    return (Qnil);
  else
    return (rxml_node_wrap(ctxt->node));
}

#node_depth ⇒ Numeric

Obtain the node depth for this context.

Returns:

  • (Numeric) 


529
530
531
532
533
534
535
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 529

static VALUE rxml_parser_context_node_depth_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->nodeNr));
}

#node_depth_max ⇒ Numeric

Obtain the maximum node depth for this context.

Returns:

  • (Numeric) 


560
561
562
563
564
565
566
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 560

static VALUE rxml_parser_context_node_depth_max_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->nodeMax));
}

#num_chars ⇒ Numeric

Obtain the number of characters in this context.

Returns:

  • (Numeric) 


574
575
576
577
578
579
580
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 574

static VALUE rxml_parser_context_num_chars_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (LONG2NUM(ctxt->nbChars));
}

#>(XML: :Parser::Options::NOENT) ⇒ Object

Returns the parser options for this context. Multiple options can be combined by using Bitwise OR (|).



590
591
592
593
594
595
596
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 590

static VALUE rxml_parser_context_options_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return INT2NUM(ctxt->options);
}

#options=(XML) ⇒ Object #XML::Parser::Options::NOCDATA ⇒ Object

Provides control over the execution of a parser. Valid values are the constants defined on XML::Parser::Options. Multiple options can be combined by using Bitwise OR (|).



607
608
609
610
611
612
613
614
615
616
617
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 607

static VALUE rxml_parser_context_options_set(VALUE self, VALUE options)
{
  int result;
  xmlParserCtxtPtr ctxt;
  Check_Type(options, T_FIXNUM);

  Data_Get_Struct(self, xmlParserCtxt, ctxt);
  result = xmlCtxtUseOptions(ctxt, NUM2INT(options));

  return self;
}

#recovery=(true) ⇒ Object

Control whether recovery mode is enabled in this context.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 644

static VALUE rxml_parser_context_recovery_set(VALUE self, VALUE bool)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (TYPE(bool) == T_FALSE)
  {
    ctxt->recovery = 0;
    return (Qfalse);
  }
  else
  {
    ctxt->recovery = 1;
    return (Qtrue);
  }
}

#recovery? ⇒ Boolean

Determine whether recovery mode is enabled in this context.

Returns:

  • (Boolean) 


626
627
628
629
630
631
632
633
634
635
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 626

static VALUE rxml_parser_context_recovery_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->recovery)
    return (Qtrue);
  else
    return (Qfalse);
}

#replace_entities=(true) ⇒ Object

Control whether external entity replacement is enabled in this context.



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 686

static VALUE rxml_parser_context_replace_entities_set(VALUE self, VALUE bool)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (TYPE(bool) == T_FALSE)
  {
    ctxt->replaceEntities = 0;
    return (Qfalse);
  }
  else
  {
    ctxt->replaceEntities = 1;
    return (Qtrue);
  }
}

#replace_entities? ⇒ Boolean

Determine whether external entity replacement is enabled in this context.

Returns:

  • (Boolean) 


668
669
670
671
672
673
674
675
676
677
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 668

static VALUE rxml_parser_context_replace_entities_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->replaceEntities)
    return (Qtrue);
  else
    return (Qfalse);
}

#space_depth ⇒ Numeric

Obtain the space depth for this context.

Returns:

  • (Numeric) 


709
710
711
712
713
714
715
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 709

static VALUE rxml_parser_context_space_depth_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->spaceNr));
}

#space_depth ⇒ Numeric

Obtain the maximum space depth for this context.

Returns:

  • (Numeric) 


723
724
725
726
727
728
729
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 723

static VALUE rxml_parser_context_space_depth_max_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  return (INT2NUM(ctxt->spaceMax));
}

#standalone? ⇒ Boolean

Determine whether this is a standalone context.

Returns:

  • (Boolean) 


830
831
832
833
834
835
836
837
838
839
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 830

static VALUE rxml_parser_context_standalone_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->standalone)
    return (Qtrue);
  else
    return (Qfalse);
}

#stats? ⇒ Boolean

Determine whether this context maintains statistics.

Returns:

  • (Boolean) 


847
848
849
850
851
852
853
854
855
856
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 847

static VALUE rxml_parser_context_stats_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->record_info)
    return (Qtrue);
  else
    return (Qfalse);
}

#subset_external? ⇒ Boolean

Determine whether this context is a subset of an external context.

Returns:

  • (Boolean) 


738
739
740
741
742
743
744
745
746
747
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 738

static VALUE rxml_parser_context_subset_external_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->inSubset == 2)
    return (Qtrue);
  else
    return (Qfalse);
}

#subset_external_system_id ⇒ Object

Obtain this context’s external subset system identifier. (valid only if either of subset_external? or subset_internal? is true).



813
814
815
816
817
818
819
820
821
822
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 813

static VALUE rxml_parser_context_subset_external_system_id_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->extSubSystem == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr((const char*) ctxt->extSubSystem, ctxt->encoding));
}

#subset_external_uri ⇒ Object

Obtain this context’s external subset URI. (valid only if either of subset_external? or subset_internal? is true).



794
795
796
797
798
799
800
801
802
803
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 794

static VALUE rxml_parser_context_subset_external_uri_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->extSubURI == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr((const char*) ctxt->extSubURI, ctxt->encoding));
}

#subset_internal? ⇒ Boolean

Determine whether this context is a subset of an internal context.

Returns:

  • (Boolean) 


756
757
758
759
760
761
762
763
764
765
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 756

static VALUE rxml_parser_context_subset_internal_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->inSubset == 1)
    return (Qtrue);
  else
    return (Qfalse);
}

#subset_internal_name ⇒ Object

Obtain this context’s subset name (valid only if either of subset_external? or subset_internal? is true).



775
776
777
778
779
780
781
782
783
784
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 775

static VALUE rxml_parser_context_subset_name_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->intSubName == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr((const char*) ctxt->intSubName, ctxt->encoding));
}

#valid? ⇒ Object

Determine whether this context is valid.



864
865
866
867
868
869
870
871
872
873
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 864

static VALUE rxml_parser_context_valid_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->valid)
    return (Qtrue);
  else
    return (Qfalse);
}

#validate? ⇒ Boolean

Determine whether validation is enabled in this context.

Returns:

  • (Boolean) 


881
882
883
884
885
886
887
888
889
890
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 881

static VALUE rxml_parser_context_validate_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->validate)
    return (Qtrue);
  else
    return (Qfalse);
}

#version ⇒ Object

Obtain this context’s version identifier.



898
899
900
901
902
903
904
905
906
907
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 898

static VALUE rxml_parser_context_version_get(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->version == NULL)
    return (Qnil);
  else
    return (rxml_new_cstr((const char*) ctxt->version, ctxt->encoding));
}

#well_formed? ⇒ Boolean

Determine whether this context contains well-formed XML.

Returns:

  • (Boolean) 


915
916
917
918
919
920
921
922
923
924
 
# File 'ext/libxml/ruby_xml_parser_context.c', line 915

static VALUE rxml_parser_context_well_formed_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  if (ctxt->wellFormed)
    return (Qtrue);
  else
    return (Qfalse);
}