minixml_8h.tex

用C写的十分精巧的XML实现程序库

\section{F:/Lab/XML/minixml/minixml.h File Reference}
\label{minixml_8h}\index{F:/Lab/XML/minixml/minixml.h@{F:/Lab/XML/minixml/minixml.h}}
Mini XML lib. 

{\tt \#include $<$stdio.h$>$}\par
{\tt \#include \char`\"{}list.h\char`\"{}}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct {\bf xml\-Prop\-Node}
\begin{CompactList}\small\item\em XML property node struct. \item\end{CompactList}\item 
struct {\bf xml\-Text\-Node}
\begin{CompactList}\small\item\em XML text node struct. \item\end{CompactList}\item 
struct {\bf xml\-Node}
\begin{CompactList}\small\item\em XML text node struct pointer. \item\end{CompactList}\item 
struct {\bf xml\-Doc}
\begin{CompactList}\small\item\em XML document struct. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef {\bf xml\-Prop\-Node} $\ast$ {\bf xml\-Prop\-Node\-Ptr}\label{minixml_8h_1cd8271e9ab8352b9df2f4581e58b6da}

\begin{CompactList}\small\item\em XML property node struct. \item\end{CompactList}\item 
typedef {\bf xml\-Text\-Node} $\ast$ {\bf xml\-Text\-Node\-Ptr}\label{minixml_8h_4e7f7ea33a5b5dc811b0ec7766140056}

\begin{CompactList}\small\item\em XML text node struct. \item\end{CompactList}\item 
typedef {\bf xml\-Node} $\ast$ {\bf xml\-Node\-Ptr}
\begin{CompactList}\small\item\em XML node struct. \item\end{CompactList}\item 
typedef {\bf xml\-Doc} $\ast$ {\bf xml\-Doc\-Ptr}\label{minixml_8h_47f52222d8cff556c9bb029ad0d55116}

\begin{CompactList}\small\item\em \doxyref{xml\-Doc}{p.}{structxml_doc} struct \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
{\bf xml\-Doc\-Ptr} {\bf xml\-New\-Doc} ()
\begin{CompactList}\small\item\em \doxyref{xml\-Doc}{p.}{structxml_doc} struct pointer \item\end{CompactList}\item 
void {\bf xml\-Free\-Doc} ({\bf xml\-Doc\-Ptr} doc)
\begin{CompactList}\small\item\em free XML document struct \item\end{CompactList}\item 
{\bf xml\-Node\-Ptr} {\bf xml\-New\-Node} (const char $\ast$name)
\begin{CompactList}\small\item\em create a new element node \item\end{CompactList}\item 
void {\bf xml\-Free\-Node} ({\bf xml\-Node\-Ptr} node)
\begin{CompactList}\small\item\em free XML document struct \item\end{CompactList}\item 
{\bf xml\-Node\-Ptr} {\bf xml\-Add\-Child} ({\bf xml\-Node\-Ptr} father, {\bf xml\-Node\-Ptr} child)
\begin{CompactList}\small\item\em add child node to the father node \item\end{CompactList}\item 
{\bf xml\-Text\-Node\-Ptr} {\bf xml\-New\-Text} (const char $\ast$text)
\begin{CompactList}\small\item\em create a new text node \item\end{CompactList}\item 
void {\bf xml\-Add\-Text} ({\bf xml\-Node\-Ptr} node, {\bf xml\-Text\-Node\-Ptr} text)
\begin{CompactList}\small\item\em add a text node to a element \item\end{CompactList}\item 
void {\bf xml\-Add\-Prop} ({\bf xml\-Node\-Ptr} node, const char $\ast$prop\-Name, const char $\ast$prop\-Value)
\begin{CompactList}\small\item\em add property to a node \item\end{CompactList}\item 
void {\bf printf\-Xml\-Doc} (FILE $\ast$fc, {\bf xml\-Doc\-Ptr} doc)
\begin{CompactList}\small\item\em print document's XML to a file \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Mini XML lib. 

(C) 2007 GEC. All rights reserved.

\begin{Desc}
\item[Version:]0.1 \end{Desc}
\begin{Desc}
\item[Author:]Deng Yangjun 

{\tt [e-mail]} \end{Desc}
\begin{Desc}
\item[Date:]2007-1-28 \end{Desc}
\begin{Desc}
\item[Warning:]Because the string pointer of 'name', 'value', 'prop' will be used in printf\-Doc function, so you can't release it before invoke printf\-Doc function \end{Desc}
\begin{Desc}
\item[{\bf Bug}]\begin{itemize}
\item Encoding\begin{enumerate}
\item can't support chinese language translate into UTF-8\item only support ASCII\end{enumerate}
\item Need more strong check(be careful)\begin{enumerate}
\item not check tag name\item not set transferred meaning letter for text value\end{enumerate}
\item Not support namespace \end{itemize}
\end{Desc}
\begin{Desc}
\item[{\bf Todo}]\begin{itemize}
\item Add chinese support\item Check name and value validity\item Xml Parser \end{itemize}
\end{Desc}


\subsection{Typedef Documentation}
\index{minixml.h@{minixml.h}!xmlNodePtr@{xmlNodePtr}}
\index{xmlNodePtr@{xmlNodePtr}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf xml\-Node}
$\ast$ {\bf xml\-Node\-Ptr}}\label{minixml_8h_ce16c3a6675db13e4e6631256c977716}


XML node struct. 

XML node struct it must be a text node or element node, can't contain both 

\subsection{Function Documentation}
\index{minixml.h@{minixml.h}!printfXmlDoc@{printfXmlDoc}}
\index{printfXmlDoc@{printfXmlDoc}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void printf\-Xml\-Doc (FILE $\ast$ {\em f}, {\bf xml\-Doc\-Ptr} {\em doc})}\label{minixml_8h_307de8bef4a2617c30231f98bf369af0}


print document's XML to a file 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em f}][in] file pointer \item[{\em doc}][in] doc pointer \end{description}
\end{Desc}
\index{minixml.h@{minixml.h}!xmlAddChild@{xmlAddChild}}
\index{xmlAddChild@{xmlAddChild}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf xml\-Node\-Ptr} xml\-Add\-Child ({\bf xml\-Node\-Ptr} {\em father}, {\bf xml\-Node\-Ptr} {\em child})}\label{minixml_8h_61210b05d003f772984e49bc1dfd16b4}


add child node to the father node 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em father}][in] father node \item[{\em child}][in] child node \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]child node \end{Desc}
\index{minixml.h@{minixml.h}!xmlAddProp@{xmlAddProp}}
\index{xmlAddProp@{xmlAddProp}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void xml\-Add\-Prop ({\bf xml\-Node\-Ptr} {\em node}, const char $\ast$ {\em prop\-Name}, const char $\ast$ {\em prop\-Value})}\label{minixml_8h_d6194b6aa2f53e2313a4610bf4f798db}


add property to a node 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em node}][in] file pointer \item[{\em prop\-Name}][in] name of the property \item[{\em prop\-Value}][in] value of the property \end{description}
\end{Desc}
\index{minixml.h@{minixml.h}!xmlAddText@{xmlAddText}}
\index{xmlAddText@{xmlAddText}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void xml\-Add\-Text ({\bf xml\-Node\-Ptr} {\em node}, {\bf xml\-Text\-Node\-Ptr} {\em text})}\label{minixml_8h_dd9e10eea08dd71f8b171d2d8ac0cabe}


add a text node to a element 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em node}][in] XML element node \item[{\em text}][in] text node \end{description}
\end{Desc}
\index{minixml.h@{minixml.h}!xmlFreeDoc@{xmlFreeDoc}}
\index{xmlFreeDoc@{xmlFreeDoc}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void xml\-Free\-Doc ({\bf xml\-Doc\-Ptr} {\em doc})}\label{minixml_8h_309c9851f4ca866f3136bedfe9ecb4bd}


free XML document struct 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em doc}][in] doc that want to destroy \end{description}
\end{Desc}
\index{minixml.h@{minixml.h}!xmlFreeNode@{xmlFreeNode}}
\index{xmlFreeNode@{xmlFreeNode}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void xml\-Free\-Node ({\bf xml\-Node\-Ptr} {\em node})}\label{minixml_8h_d9953555fb07de46d3015eeca188aee5}


free XML document struct 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em node}][in] XML node that want to destroy \end{description}
\end{Desc}
\index{minixml.h@{minixml.h}!xmlNewDoc@{xmlNewDoc}}
\index{xmlNewDoc@{xmlNewDoc}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf xml\-Doc\-Ptr} xml\-New\-Doc ()}\label{minixml_8h_69701ce3d0f8331132d197da5802b2ed}


\doxyref{xml\-Doc}{p.}{structxml_doc} struct pointer 

\begin{Desc}
\item[Returns:]new XML document pointer, you MUST release it by xml\-Free\-Doc \end{Desc}
\index{minixml.h@{minixml.h}!xmlNewNode@{xmlNewNode}}
\index{xmlNewNode@{xmlNewNode}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf xml\-Node\-Ptr} xml\-New\-Node (const char $\ast$ {\em name})}\label{minixml_8h_8251cf8c24635242ffce4d4e98149d8e}


create a new element node 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}][in] tag name of the new element node \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]new element node \end{Desc}
\index{minixml.h@{minixml.h}!xmlNewText@{xmlNewText}}
\index{xmlNewText@{xmlNewText}!minixml.h@{minixml.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf xml\-Text\-Node\-Ptr} xml\-New\-Text (const char $\ast$ {\em text})}\label{minixml_8h_8f8779f8481d2bc6840b10ee2bdd313a}


create a new text node 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em text}][in] valve of the text node \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]new text node \end{Desc}