classchm_1_1chmistream.tex

It is a chm file viewer lib with source code

\hypertarget{classchm_1_1chmistream}{
\subsection{chm::chmistream Class Reference}
\label{classchm_1_1chmistream}\index{chm::chmistream@{chm::chmistream}}
}
Inputstream for reading files inside a chm archives. 


{\tt \#include $<$chmxx.h$>$}

\subsubsection*{Public Methods}
\begin{CompactItemize}
\item 
\hyperlink{classchm_1_1chmistream_a0}{chmistream} (const \hyperlink{classchm_1_1chmfile}{chmfile} \&chm, const std::string \&path, size\_\-t buf\_\-size=1024)
\begin{CompactList}\small\item\em Create a new input stream from archive for given path.\item\end{CompactList}\item 
std::streamsize \hyperlink{classchm_1_1chmistream_a1}{read\_\-left} () const
\begin{CompactList}\small\item\em Returns the number of bytes that are left to be read from this stream.\item\end{CompactList}\item 
virtual \hyperlink{classchm_1_1chmistream_a2}{$\sim$chmistream} ()
\item 
size\_\-t \hyperlink{classchm_1_1chmistream_a3}{get\_\-encint} ()
\begin{CompactList}\small\item\em Get little endian MS encint from the stream.\item\end{CompactList}\item 
unsigned long \hyperlink{classchm_1_1chmistream_a4}{get\_\-dword} ()
\begin{CompactList}\small\item\em Get local endianized MS dword (2 x 2 bytes) from the stream.\item\end{CompactList}\item 
unsigned int \hyperlink{classchm_1_1chmistream_a5}{get\_\-word} ()
\begin{CompactList}\small\item\em Get local endianized MS word (2 bytes) from the stream.\item\end{CompactList}\item 
unsigned long \hyperlink{classchm_1_1chmistream_a6}{get\_\-sr} (int s, int r, int \&pos)
\begin{CompactList}\small\item\em Get a s-r encoded value from the stream.\item\end{CompactList}\item 
void \hyperlink{classchm_1_1chmistream_a7}{get\_\-sr\_\-finish} (int \&pos)
\end{CompactItemize}


\subsubsection{Detailed Description}
Inputstream for reading files inside a chm archives.



\footnotesize\begin{verbatim}        chm::chmfile chm("/chmfile.chm");
        chm::chmistream in(chm, "/path");
        string line;
        while ( readline(chm, line) ) {
            cout << line;
        }
\end{verbatim}\normalsize 
 



Definition at line 148 of file chmxx.h.

\subsubsection{Constructor \& Destructor Documentation}
\hypertarget{classchm_1_1chmistream_a0}{
\index{chm::chmistream@{chm::chmistream}!chmistream@{chmistream}}
\index{chmistream@{chmistream}!chm::chmistream@{chm::chmistream}}
\paragraph[chmistream]{\setlength{\rightskip}{0pt plus 5cm}chm::chmistream::chmistream (const \hyperlink{classchm_1_1chmfile}{chmfile} \& {\em chm}, const std::string \& {\em path}, size\_\-t {\em buf\_\-size} = 1024)}\hfill}
\label{classchm_1_1chmistream_a0}


Create a new input stream from archive for given path.

\hypertarget{classchm_1_1chmistream_a2}{
\index{chm::chmistream@{chm::chmistream}!~chmistream@{$\sim$chmistream}}
\index{~chmistream@{$\sim$chmistream}!chm::chmistream@{chm::chmistream}}
\paragraph[$\sim$chmistream]{\setlength{\rightskip}{0pt plus 5cm}virtual chm::chmistream::$\sim$chmistream ()\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a2}




\subsubsection{Member Function Documentation}
\hypertarget{classchm_1_1chmistream_a4}{
\index{chm::chmistream@{chm::chmistream}!get_dword@{get\_\-dword}}
\index{get_dword@{get\_\-dword}!chm::chmistream@{chm::chmistream}}
\paragraph[get\_\-dword]{\setlength{\rightskip}{0pt plus 5cm}unsigned long chm::chmistream::get\_\-dword ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a4}


Get local endianized MS dword (2 x 2 bytes) from the stream.



Definition at line 176 of file chmxx.h.\hypertarget{classchm_1_1chmistream_a3}{
\index{chm::chmistream@{chm::chmistream}!get_encint@{get\_\-encint}}
\index{get_encint@{get\_\-encint}!chm::chmistream@{chm::chmistream}}
\paragraph[get\_\-encint]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t chm::chmistream::get\_\-encint ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a3}


Get little endian MS encint from the stream.



Definition at line 160 of file chmxx.h.\hypertarget{classchm_1_1chmistream_a6}{
\index{chm::chmistream@{chm::chmistream}!get_sr@{get\_\-sr}}
\index{get_sr@{get\_\-sr}!chm::chmistream@{chm::chmistream}}
\paragraph[get\_\-sr]{\setlength{\rightskip}{0pt plus 5cm}unsigned long chm::chmistream::get\_\-sr (int {\em s}, int {\em r}, int \& {\em pos})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a6}


Get a s-r encoded value from the stream.

Scale must alwqays be 2. Use 0 for initial pos. When finished reading an entry of sr-s call the get\_\-sr\_\-finish(pos). 

Definition at line 213 of file chmxx.h.\hypertarget{classchm_1_1chmistream_a7}{
\index{chm::chmistream@{chm::chmistream}!get_sr_finish@{get\_\-sr\_\-finish}}
\index{get_sr_finish@{get\_\-sr\_\-finish}!chm::chmistream@{chm::chmistream}}
\paragraph[get\_\-sr\_\-finish]{\setlength{\rightskip}{0pt plus 5cm}void chm::chmistream::get\_\-sr\_\-finish (int \& {\em pos})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a7}




Definition at line 253 of file chmxx.h.\hypertarget{classchm_1_1chmistream_a5}{
\index{chm::chmistream@{chm::chmistream}!get_word@{get\_\-word}}
\index{get_word@{get\_\-word}!chm::chmistream@{chm::chmistream}}
\paragraph[get\_\-word]{\setlength{\rightskip}{0pt plus 5cm}unsigned int chm::chmistream::get\_\-word ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}\hfill}
\label{classchm_1_1chmistream_a5}


Get local endianized MS word (2 bytes) from the stream.



Definition at line 195 of file chmxx.h.\hypertarget{classchm_1_1chmistream_a1}{
\index{chm::chmistream@{chm::chmistream}!read_left@{read\_\-left}}
\index{read_left@{read\_\-left}!chm::chmistream@{chm::chmistream}}
\paragraph[read\_\-left]{\setlength{\rightskip}{0pt plus 5cm}std::streamsize chm::chmistream::read\_\-left ()}\hfill}
\label{classchm_1_1chmistream_a1}


Returns the number of bytes that are left to be read from this stream.

So returns the size of file when nothing has been read. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
\hyperlink{chmxx_8h}{chmxx.h}\end{CompactItemize}