scales.xml.impl.Keys.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scales-xml_2.11 Show documentation
An alternate Scala Xml processing library
The newest version!
package scales.xml.impl

import scales.xml.{QName, Attributes, emptyAttributes, emptyNamespaces}

object DefaultHashes {
  
  val emptyAttributesHash = emptyAttributes.hashCode
  val emptyNamespacesHash = emptyNamespaces.hashCode

}

import DefaultHashes._

/**
 * Allows quick lookups without creating elements, only use via copy and then don't change it
 */ 
class ElemKey {
  var name : QName = _
  var nameHash : Int = 0// incase it can be passed in
  var attributes : Attributes = _
  var namespaces : Map[String, String] = _

  def set(name : QName, attributes : Attributes, namespaces : Map[String, String], nameHash : Int = 0) = {
    this.name = name
    this.attributes = attributes
    this.namespaces = namespaces

    if (nameHash == 0)
      this.nameHash = name.hashCode
    else
      this.nameHash = nameHash
    
    lastHash = 0
    // do it now
    hashCode
    this
  }

  def copy = {
    val r = new ElemKey
    r.name = name
    r.attributes = attributes
    r.namespaces = namespaces
    r.lastHash = lastHash
    r
  }

  /**
   * Why are we doing eq's as well? Defaults and caching, and having to recast every time when we already know what we are..
   */ 
  override def equals( other : Any ) = other match {
    case oq : ElemKey =>
      if ((lastHash == oq.lastHash) &&
	((name eq oq.name) || (name ==== oq.name)) && 
	  ((attributes eq oq.attributes) || (attributes == oq.attributes)) &&
	  ((namespaces eq oq.namespaces) || (namespaces == oq.namespaces)) // only checks after running equals == instanceof checks ++
	)
	true
      else
	false
    case _ => scales.utils.error("Cannot compare an ElemKey to anything else other than a ElemKey")
  }

  /**
   * When non 0 it has been calculated
   */ 
  var lastHash : Int = 0

  override def hashCode() : Int = {
    if (lastHash != 0) return lastHash

    var hs = 1
    hs = (hs * 31) + nameHash
    hs = (hs * 31) + (
      if (emptyAttributes eq attributes)
	emptyAttributesHash // don't do it more than once
      else
	attributes.hashCode
      )
    hs = (hs * 31) + (
      if (namespaces eq emptyNamespaces)
	emptyNamespacesHash // don't do it more than once
      else
	namespaces.hashCode
      )

    lastHash = hs
    hs    
  }
}


/**
 * Provides a key that also checks ===, used in caching where you
 * want to remove all collision possibilities.
 *
 * Note to reduce allocation costs its very mutable, use QName directly when
 * possible.  Note here the allocation costs refer more to the gc hit of the
 * extra allocations that are then directly thrown away.
 *
 * No QNames were hurt during the use of this class.
 */
final class FullEqualQNameKey() {
  
  // Some also adds creation cost
  var prefix : String = _
  var local : String = _
  var namespace : String = _  

  /**
   * Makes a copy suitable for caching.
   */ 
  @inline def copy = {
    val n = new FullEqualQNameKey()
    n.prefix = prefix
    n.local = local
    n.namespace = namespace
    n.lastHash = lastHash
    n
  }

  @inline def set( qname : QName ) = {
    prefix = qname.prefix.getOrElse(null:String)
    local = qname.local
    namespace = qname.namespace.uri
    lastHash = 0
    hashCode
    this
  }

  @inline def setNoNamespaceQName( nlocal : String ) = {
    prefix = null:String
    local = nlocal
    namespace = ""//Default.noNamespace
    lastHash = 0
    hashCode
    this
  }

  @inline def setUnprefixedQName( nlocal : String, nnamespace : String ) = {
    prefix = null:String
    local = nlocal
    namespace = nnamespace
    lastHash = 0
    hashCode
    this
  }

  @inline def setPrefixedQName( nlocal : String, nnamespace : String, nprefix : String ) = {
    prefix = nprefix
    local = nlocal
    namespace = nnamespace
    lastHash = 0
    hashCode
    this
  }

  def =:=( other : FullEqualQNameKey ) =
    if (this eq other) true
    else
    (other.local == local && namespace == other.namespace)

  override def equals( other : Any ) = other match {
    case oq : FullEqualQNameKey =>
      if (this eq oq) true
      else
      if ((oq.lastHash == lastHash) && (this =:= oq)) 
	if ((oq.prefix ne null) && (prefix ne null))
	  prefix == oq.prefix
	else
	  ((oq.prefix eq null) && (prefix eq null))
      else 
	false
    case _ => scales.utils.error("Cannot compare a FullEqualQNameKey to anything else other than a FullEqualQNameKey")
  }

  /**
   * If its non 0 then its the last caclulated hash since a setXX
   */ 
  var lastHash : Int = 0

  override def hashCode() : Int = {
    if (lastHash != 0) return lastHash

    var hs = 1
    hs = (hs * 31) + (
      if (prefix eq null) 1
      else prefix.hashCode
      )
    hs = (hs * 31) + local.hashCode
    hs = (hs * 31) + namespace.hashCode
    lastHash = hs
    hs
  }
}