dump (string & show) and save_file

Author: lindahua

src/MiniDOM.jl

@@ -14,13 +14,14 @@ module MiniDOM
 	find_element, get_elements_by_tagname,
 
 	# document
-	XMLDocument,
-	parse_file, parse_string, version, encoding, compression, standalone, 
-	docelement
+	XMLDocument, version, encoding, compression, standalone, docelement, 
+	parse_file, parse_string, save_file
+	
 
 	include("clib.jl")
 	include("errors.jl")
 
+	include("utils.jl")
 	include("nodes.jl")
 	include("document.jl")
 end

src/clib.jl

@@ -29,18 +29,27 @@ _xmlfree{T}(p::Ptr{T}) = ccall(:free, Void, (Ptr{T},), p)
 # pre-condition: p is not null
 _xcopystr(p::Xstr) = (r = bytestring(p); _xmlfree(p); r)
 
+# buffer
+
+@lx2func xmlBufferCreateSize
+@lx2func xmlBufferFree
+@lx2func xmlBufferLength
+@lx2func xmlBufferContent
+
 # functions for nodes
 
 @lx2func xmlNodeGetContent
 @lx2func xmlGetProp
 @lx2func xmlFirstElementChild
 @lx2func xmlNextElementSibling
+@lx2func xmlNodeDump
 
 # functions for documents
 
+@lx2func xmlDocGetRootElement
+@lx2func xmlFreeDoc
 @lx2func xmlParseFile
 @lx2func xmlParseMemory
-@lx2func xmlFreeDoc
-@lx2func xmlDocGetRootElement
-
+@lx2func xmlDocDumpMemoryEnc
+@lx2func xmlSaveFileEnc
 

src/document.jl

@@ -58,6 +58,15 @@ function docelement(xdoc::XMLDocument)
 	XMLElement(pr)
 end
 
+
+#### construction & free
+
+function free(xdoc::XMLDocument)
+	ccall(xmlFreeDoc, Void, (Ptr{Void},), xdoc.ptr)
+	xdoc.ptr = nullptr
+end
+
+
 #### parse and free
 
 function parse_file(filename::ASCIIString)
@@ -72,8 +81,26 @@ function parse_string(s::ASCIIString)
 	XMLDocument(p)
 end
 
-function free(xdoc::XMLDocument)
-	ccall(xmlFreeDoc, Void, (Ptr{Void},), xdoc.ptr)
-	xdoc.ptr = nullptr
+
+#### output
+
+function save_file(xdoc::XMLDocument, filename::ASCIIString; encoding::ASCIIString="utf-8")
+	ret = ccall(xmlSaveFileEnc, Cint, (Ptr{Cchar}, Xptr, Ptr{Cchar}), 
+		filename, xdoc.ptr, encoding)
+	if ret < 0
+		throw(XMLWriteError("Failed to save XML to file $filename"))
+	end
+	return int(ret)  # number of bytes written
 end
 
+function Base.string(xdoc::XMLDocument; encoding::ASCIIString="utf-8")	
+	buf_out = Array(Xstr, 1)
+	len_out = Array(Cint, 1)
+	ccall(xmlDocDumpMemoryEnc, Void, (Xptr, Ptr{Xstr}, Ptr{Cint}, Ptr{Cchar}), 
+		xdoc.ptr, buf_out, len_out, encoding)
+	_xcopystr(buf_out[1])
+end
+
+Base.show(io::IO, xdoc::XMLDocument) = println(io, Base.string(xdoc))
+
+

src/errors.jl

@@ -11,6 +11,10 @@ end
 immutable XMLAttributeNotFound <: XMLError
 end
 
+immutable XMLWriteError <: XMLError
+	msg::ASCIIString
+end
+
 const dom_exception_causes = [
 	"Index size error",        #  1
 	"DOM string size error",   #  2

src/nodes.jl

@@ -159,6 +159,23 @@ function content(nd::XMLNode)
 	(pct != nullptr ? _xcopystr(pct) : "")::ASCIIString
 end
 
+# dumping
+
+const DEFAULT_DUMPBUFFER_SIZE = 4096
+
+function Base.string(nd::XMLNode)
+	buf = XBuffer(DEFAULT_DUMPBUFFER_SIZE)
+	ccall(xmlNodeDump, Cint, (Xptr, Xptr, Xptr, Cint, Cint), 
+		buf.ptr, nd._struct.doc, nd.ptr, 0, 0)
+	r = content(buf)
+	free(buf)
+	return r
+end
+
+function Base.show(io::IO, nd::XMLNode)
+	println(io, Base.string(nd))
+end
+
 
 #######################################
 #
@@ -185,6 +202,9 @@ has_children(x::XMLElement) = has_children(x.node)
 child_nodes(x::XMLElement) = child_nodes(x.node)
 content(x::XMLElement) = content(x.node)
 
+Base.string(x::XMLElement) = Base.string(x.node)
+Base.show(io::IO, x::XMLElement) = Base.show(x.node)
+
 # attribute access
 
 function attribute(x::XMLElement, name::ASCIIString)

src/utils.jl

@@ -0,0 +1,21 @@
+# Utilities
+
+##### Buffer
+
+immutable XBuffer
+	ptr::Xptr
+
+	function XBuffer(bytes::Integer)
+		p = ccall(xmlBufferCreateSize, Xptr, (Csize_t,), bytes)
+		p != nullptr || error("Failed to create buffer of $bytes bytes.")
+		new(p)
+	end
+end
+
+free(buf::XBuffer) = ccall(xmlBufferFree, Void, (Xptr,), buf.ptr)
+
+Base.length(buf::XBuffer) = int(ccall(xmlBufferLength, Cint, (Xptr,), buf.ptr))
+
+content(buf::XBuffer) = bytestring(ccall(xmlBufferContent, Xstr, (Xptr,), buf.ptr))
+
+

test/dump.jl

@@ -0,0 +1,37 @@
+using MiniDOM
+
+# document
+
+docstr = """
+<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+<bookstore>
+  <book category="COOKING" tag="first">
+    <title lang="en">Everyday Italian</title>
+    <author>Giada De Laurentiis</author>
+    <year>2005</year>
+    <price>30.00</price>
+  </book>
+  <book category="CHILDREN">
+    <title lang="en">Harry Potter</title>
+    <author>J K. Rowling</author>
+    <year>2005</year>
+    <price>29.99</price>
+  </book>
+</bookstore>
+"""
+
+xdoc = parse_string(docstr)
+
+println("Document:")
+println("=====================")
+show(xdoc)
+
+# save_file(xdoc, "tt.xml")
+
+println("Root Element:")
+println("=====================")
+xroot = docelement(xdoc)
+show(xroot)
+
+free(xdoc)
+