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.


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, (const char*)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.


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.


134
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
# File 'ext/libxml/ruby_xml_parser_context.c', line 134

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.


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# 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), (int)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_uriObject

Obtain the base url for this parser context.



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

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((const xmlChar*)ctxt->input->filename, ctxt->encoding);
  else
    return Qnil;
}

#base_uri=(url) ⇒ Object

Sets the base url for this parser context.



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

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 char* xurl = StringValuePtr(url);
    ctxt->input->filename = (const char*)xmlStrdup((const xmlChar*)xurl);
  }
  return self;
}

#closenil

Closes the underlying input streams. This is useful when parsing a large amount of files and you want to close the files without relying on Ruby’s garbage collector to run.

Returns:

  • (nil)


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

static VALUE rxml_parser_context_close(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  xmlParserInputPtr xinput;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

  while ((xinput = inputPop(ctxt)) != NULL)
  {
	 xmlFreeInputStream(xinput);
  }
  return Qnil;
}

#data_directoryObject

Obtain the data directory associated with this context.



243
244
245
246
247
248
249
250
251
252
# File 'ext/libxml/ruby_xml_parser_context.c', line 243

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((const xmlChar*)ctxt->directory, ctxt->encoding));
}

#depthNumeric

Obtain the depth of this context.

Returns:

  • (Numeric)


260
261
262
263
264
265
266
# File 'ext/libxml/ruby_xml_parser_context.c', line 260

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

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

#disable_cdata=(value) ⇒ Object

Control whether CDATA nodes will be created in this context.



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'ext/libxml/ruby_xml_parser_context.c', line 292

static VALUE rxml_parser_context_disable_cdata_set(VALUE self, VALUE value)
{
  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 (value)
    ctxt->sax->cdataBlock = NULL;
  else
    ctxt->sax->cdataBlock = xmlDefaultSAXHandler.cdataBlock;

  return value;
}

#disable_cdata?Boolean

Determine whether CDATA nodes will be created in this context.

Returns:

  • (Boolean)


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

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)


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

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)


333
334
335
336
337
338
339
340
341
342
# File 'ext/libxml/ruby_xml_parser_context.c', line 333

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);
}

#encodingXML::Encoding::UTF_8

Obtain the character encoding identifier used in this context.



351
352
353
354
355
356
# File 'ext/libxml/ruby_xml_parser_context.c', line 351

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

#encoding=(XML) ⇒ Object

Sets the character encoding for this context.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'ext/libxml/ruby_xml_parser_context.c', line 364

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;
}

#errnoNumeric

Obtain the last-error number in this context.

Returns:

  • (Numeric)


393
394
395
396
397
398
399
# File 'ext/libxml/ruby_xml_parser_context.c', line 393

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)


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

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_streamsNumeric

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

Returns:

  • (Numeric)


425
426
427
428
429
430
431
432
# File 'ext/libxml/ruby_xml_parser_context.c', line 425

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_streamsObject

Obtain the actual number of IO streams in this context.



441
442
443
444
445
446
447
# File 'ext/libxml/ruby_xml_parser_context.c', line 441

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)


456
457
458
459
460
461
462
463
464
465
# File 'ext/libxml/ruby_xml_parser_context.c', line 456

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_depthNumeric

Obtain the name depth for this context.

Returns:

  • (Numeric)


473
474
475
476
477
478
479
# File 'ext/libxml/ruby_xml_parser_context.c', line 473

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

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

#name_depth_maxNumeric

Obtain the maximum name depth for this context.

Returns:

  • (Numeric)


487
488
489
490
491
492
493
# File 'ext/libxml/ruby_xml_parser_context.c', line 487

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

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

#name_nodeObject

Obtain the name node for this context.



501
502
503
504
505
506
507
508
509
510
# File 'ext/libxml/ruby_xml_parser_context.c', line 501

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( ctxt->name, ctxt->encoding));
}

#name_tabArray

Obtain the name table for this context.

Returns:

  • (Array)


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'ext/libxml/ruby_xml_parser_context.c', line 518

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( ctxt->nameTab[i], ctxt->encoding));
  }

  return (tab_ary);
}

#nodeObject

Obtain the root node of this context.



562
563
564
565
566
567
568
569
570
571
# File 'ext/libxml/ruby_xml_parser_context.c', line 562

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_depthNumeric

Obtain the node depth for this context.

Returns:

  • (Numeric)


548
549
550
551
552
553
554
# File 'ext/libxml/ruby_xml_parser_context.c', line 548

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

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

#node_depth_maxNumeric

Obtain the maximum node depth for this context.

Returns:

  • (Numeric)


579
580
581
582
583
584
585
# File 'ext/libxml/ruby_xml_parser_context.c', line 579

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

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

#num_charsNumeric

Obtain the number of characters in this context.

Returns:

  • (Numeric)


593
594
595
596
597
598
599
# File 'ext/libxml/ruby_xml_parser_context.c', line 593

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 (|).



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

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::NOCDATAObject

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 (|).



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_options_set(VALUE self, VALUE options)
{
  xmlParserCtxtPtr ctxt;
  Check_Type(options, T_FIXNUM);

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

  return self;
}

#recovery=(true) ⇒ Object

Control whether recovery mode is enabled in this context.



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
# File 'ext/libxml/ruby_xml_parser_context.c', line 662

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

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

#recovery?Boolean

Determine whether recovery mode is enabled in this context.

Returns:

  • (Boolean)


644
645
646
647
648
649
650
651
652
653
# File 'ext/libxml/ruby_xml_parser_context.c', line 644

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.



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
# File 'ext/libxml/ruby_xml_parser_context.c', line 704

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

  if (value == Qfalse)
  {
    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)


686
687
688
689
690
691
692
693
694
695
# File 'ext/libxml/ruby_xml_parser_context.c', line 686

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_depthNumeric

Obtain the space depth for this context.

Returns:

  • (Numeric)


727
728
729
730
731
732
733
# File 'ext/libxml/ruby_xml_parser_context.c', line 727

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

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

#space_depthNumeric

Obtain the maximum space depth for this context.

Returns:

  • (Numeric)


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

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)


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

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)


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

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)


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_external_q(VALUE self)
{
  xmlParserCtxtPtr ctxt;
  Data_Get_Struct(self, xmlParserCtxt, ctxt);

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

#subset_external_system_idObject

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



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

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( ctxt->extSubSystem, ctxt->encoding));
}

#subset_external_uriObject

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



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

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( ctxt->extSubURI, ctxt->encoding));
}

#subset_internal?Boolean

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

Returns:

  • (Boolean)


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

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_nameObject

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



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

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(ctxt->intSubName, ctxt->encoding));
}

#valid?Object

Determine whether this context is valid.



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

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)


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

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);
}

#versionObject

Obtain this context’s version identifier.



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

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( ctxt->version, ctxt->encoding));
}

#well_formed?Boolean

Determine whether this context contains well-formed XML.

Returns:

  • (Boolean)


933
934
935
936
937
938
939
940
941
942
# File 'ext/libxml/ruby_xml_parser_context.c', line 933

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);
}