list_8h.tex

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

\section{F:/Lab/XML/minixml/list.h File Reference}
\label{list_8h}\index{F:/Lab/XML/minixml/list.h@{F:/Lab/XML/minixml/list.h}}
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct {\bf link}
\begin{CompactList}\small\item\em An link node in list. \item\end{CompactList}\item 
struct {\bf list}
\begin{CompactList}\small\item\em list struct \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef {\bf link} $\ast$ {\bf link\-Ptr}\label{list_8h_a4f2b577998d10c1b478f9a38acf8325}

\begin{CompactList}\small\item\em Struct link pointer. \item\end{CompactList}\item 
typedef {\bf list} $\ast$ {\bf list\-Ptr}\label{list_8h_ccac2194a4f2b7d4558a81b5f24e8a29}

\begin{CompactList}\small\item\em list struct \item\end{CompactList}\item 
typedef void($\ast$) {\bf free\-User\-Data} (void $\ast$data)\label{list_8h_9d96191ddede1392c1971c0a56e0f6b3}

\begin{CompactList}\small\item\em free user data handler \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
{\bf list\-Ptr} {\bf create\-List} ()
\begin{CompactList}\small\item\em create a new list strut \item\end{CompactList}\item 
{\bf link\-Ptr} {\bf add\-Link} ({\bf list\-Ptr} {\bf list}, void $\ast$data)
\begin{CompactList}\small\item\em create a new list strut \item\end{CompactList}\item 
void {\bf destroy\-List} ({\bf list\-Ptr} $\ast$list\-Ptr\-Ptr, {\bf free\-User\-Data} on\-Free\-Data)
\begin{CompactList}\small\item\em destroy a list \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
\small\begin{alltt}{\bf C list}\end{alltt}
\normalsize 
 \small\begin{alltt}{\bf (C) 2007 GEC All rights reserved.}\end{alltt}
\normalsize 
 \begin{Desc}
\item[Author:]deng yangjun \end{Desc}
\begin{Desc}
\item[Date:]2007-1-28 \end{Desc}


\subsection{Function Documentation}
\index{list.h@{list.h}!addLink@{addLink}}
\index{addLink@{addLink}!list.h@{list.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf link\-Ptr} add\-Link ({\bf list\-Ptr} {\em list}, void $\ast$ {\em data})}\label{list_8h_c957c98da6030a0a65f935448b446d55}


create a new list strut 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em list}][in,out]list that will be add the new link \item[{\em data}][in]value of the new link \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the new link 's point, can't free it, please free it by destroy\-List or remove\-Link \end{Desc}
\index{list.h@{list.h}!createList@{createList}}
\index{createList@{createList}!list.h@{list.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf list\-Ptr} create\-List ()}\label{list_8h_05d3366e4e8eb7ff831ba4033d7e0d70}


create a new list strut 

\begin{Desc}
\item[Returns:]new list pointer, you MUST release it by destroy\-List(list\-Ptr list) \end{Desc}
\index{list.h@{list.h}!destroyList@{destroyList}}
\index{destroyList@{destroyList}!list.h@{list.h}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void destroy\-List ({\bf list\-Ptr} $\ast$ {\em list\-Ptr\-Ptr}, {\bf free\-User\-Data} {\em on\-Free\-Data})}\label{list_8h_47f7346a9121c80f3c2ee76307399a2b}


destroy a list 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em list\-Ptr\-Ptr}][in,out] list that will be destroyed, after the function, the list's pointer will be NULL \item[{\em on\-Free\-Data}][in] register user data free hander function. when destroy link, it will be invoked. if you don't need to free user data, you can set it NULL \end{description}
\end{Desc}