Class: REXML::Text

Class | REXML::Text
In: | temp/text.rb
Parent: | Child

Represents text nodes in an XML document

### Methods

<< <=> clone empty? indent_text inspect new node_type normalize read_with_substitution to_s unnormalize value value= wrap write write_with_substitution xpath

### Included Modules

Comparable

### Constants

SPECIALS | = | [ /&(?!#?[\w-]+;)/u, /</u, />/u, /"/u, /'/u, /\r/u ] |  | The order in which the substitutions occur
SUBSTITUTES | = | ['&amp;', '&lt;', '&gt;', '&quot;', '&apos;', '&#13;']
SLAICEPS | = | [ '<', '>', '"', "'", '&' ] |  | Characters which are substituted in written strings
SETUTITSBUS | = | [ /&lt;/u, /&gt;/u, /&quot;/u, /&apos;/u, /&amp;/u ]
ILLEGAL | = | /(<|&(?!(#{Entity::NAME})|(#0*((?:\d+)|(?:x[a-fA-F0-9]+)));))/um
NUMERICENTITY | = | /&#0*((?:\d+)|(?:x[a-fA-F0-9]+));/
REFERENCE | = | /#{Entity::REFERENCE}/
EREFERENCE | = | /&(?!#{Entity::NAME};)/

### Attributes

raw | [RW] | If `raw` is true, then REXML leaves the value alone

### Public Class methods

new(arg, respect_whitespace=false, parent=nil, raw=nil, entity_filter=nil, illegal=ILLEGAL )

Constructor `arg` if a String, the content is set to the String. If a Text, the object is shallowly cloned.

`respect_whitespace` (boolean, false) if true, whitespace is respected

`parent` (nil) if this is a Parent object, the parent will be set to this.

`raw` (nil) This argument can be given three values. If true, then the value of used to construct this object is expected to contain no unescaped XML markup, and REXML will not change the text. If this value is false, the string may contain any characters, and REXML will escape any and all defined entities whose values are contained in the text. If this value is nil (the default), then the raw value of the parent will be used as the raw value for this node. If there is no raw value for the parent, and no value is supplied, the default is false. Use this field if you have entities defined for some text, and you don‘t want REXML to escape that text in output.

      Text.new( "<&", false, nil, false ) #-> "&lt;&amp;"
      Text.new( "&lt;&amp;", false, nil, false ) #-> "&amp;lt;&amp;amp;"
      Text.new( "<&", false, nil, true )  #-> Parse exception
      Text.new( "&lt;&amp;", false, nil, true )  #-> "&lt;&amp;"
      # Assume that the entity "s" is defined to be "sean"
      # and that the entity    "r" is defined to be "russell"
      Text.new( "sean russell" )          #-> "&s; &r;"
      Text.new( "sean russell", false, nil, true ) #-> "sean russell"

`entity_filter` (nil) This can be an array of entities to match in the supplied text. This argument is only useful if `raw` is set to false.

      Text.new( "sean russell", false, nil, false, ["s"] ) #-> "&s; russell"
      Text.new( "sean russell", false, nil, true, ["s"] ) #-> "sean russell"

In the last example, the `entity_filter` argument is ignored.

`pattern` INTERNAL USE ONLY

normalize( input, doctype=nil, entity_filter=nil )

Escapes all possible entities

read_with_substitution( input, illegal=nil )

Reads text, substituting entities

unnormalize( string, doctype=nil, filter=nil, illegal=nil )

Unescapes all possible entities

### Public Instance methods

<<( to_append )

Appends text to this text node. The text is appended in the `raw` mode of this text node.

<=>( other )

`other` a String or a Text `returns` the result of (to_s <=> arg.to_s)

clone()
empty?()
indent_text(string, level=1, style="\t", indentfirstline=true)
inspect()
node_type()
to_s()

Returns the string value of this text node. This string is always escaped, meaning that it is a valid XML text node string, and all entities that can be escaped, have been inserted. This method respects the entity filter set in the constructor.

      # Assume that the entity "s" is defined to be "sean", and that the
      # entity "r" is defined to be "russell"
      t = Text.new( "< & sean russell", false, nil, false, ['s'] )
      t.to_s   #-> "&lt; &amp; &s; russell"
      t = Text.new( "< & &s; russell", false, nil, false )
      t.to_s   #-> "&lt; &amp; &s; russell"
      u = Text.new( "sean russell", false, nil, true )
      u.to_s   #-> "sean russell"

value()

Returns the string value of this text. This is the text without entities, as it might be used programmatically, or printed to the console. This ignores the ‘raw’ attribute setting, and any entity_filter.

      # Assume that the entity "s" is defined to be "sean", and that the
      # entity "r" is defined to be "russell"
      t = Text.new( "< & sean russell", false, nil, false, ['s'] )
      t.value   #-> "< & sean russell"
      t = Text.new( "< & &s; russell", false, nil, false )
      t.value   #-> "< & sean russell"
      u = Text.new( "sean russell", false, nil, true )
      u.value   #-> "sean russell"

value=( val )

Sets the contents of this text node. This expects the text to be unnormalized. It returns self.

      e = Element.new( "a" )
      e.add_text( "foo" )   # <a>foo</a>
      e[0].value = "bar"    # <a>bar</a>
      e[0].value = "<a>"    # <a>&lt;a&gt;</a>

wrap(string, width, addnewline=false)
write( writer, indent=-1, transitive=false, ie_hack=false )

## DEPRECATED

See REXML::Formatters

write_with_substitution(out, input)

Writes out text, substituting special characters beforehand. `out` A String, IO, or any other object supporting <<( String ) `input` the text to substitute and the write out

      z=utf8.unpack("U*")
      ascOut=""
      z.each{|r|
        if r <  0x100
          ascOut.concat(r.chr)
        else
          ascOut.concat(sprintf("&#x%x;", r))
        end
      }
      puts ascOut

xpath()

FIXME This probably won‘t work properly

[Validate]