| 1 |
\hypertarget{group__stream__line}{ |
| 2 |
\section{Line-mode operations} |
| 3 |
\label{group__stream__line}\index{Line-mode operations@{Line-mode operations}} |
| 4 |
} |
| 5 |
|
| 6 |
|
| 7 |
\subsection{Detailed Description} |
| 8 |
Line-mode based stream methods. |
| 9 |
|
| 10 |
|
| 11 |
|
| 12 |
\subsection*{Defines} |
| 13 |
\begin{CompactItemize} |
| 14 |
\item |
| 15 |
\#define \hyperlink{group__stream__line_ga3}{LINEMODE\_\-BUFFER\_\-SIZE}\ 1024 |
| 16 |
\begin{CompactList}\small\item\em Internal library buffer size for line mode. \item\end{CompactList}\end{CompactItemize} |
| 17 |
\subsection*{Functions} |
| 18 |
\begin{CompactItemize} |
| 19 |
\item |
| 20 |
int \hyperlink{group__stream__line_ga0}{peak\_\-stream\_\-is\_\-linemode\_\-enabled} (\hyperlink{group__stream_ga0}{peak\_\-stream} s) |
| 21 |
\begin{CompactList}\small\item\em Test if the stream is currently in line mode. \item\end{CompactList}\item |
| 22 |
void \hyperlink{group__stream__line_ga1}{peak\_\-stream\_\-set\_\-linemode} (\hyperlink{group__stream_ga0}{peak\_\-stream} s) |
| 23 |
\begin{CompactList}\small\item\em Set line mode dynamically. \item\end{CompactList}\item |
| 24 |
char $\ast$ \hyperlink{group__stream__line_ga2}{peak\_\-stream\_\-get\_\-line} (\hyperlink{group__stream_ga0}{peak\_\-stream} s) |
| 25 |
\begin{CompactList}\small\item\em Get a pointer to the next line read on a stream. \item\end{CompactList}\end{CompactItemize} |
| 26 |
|
| 27 |
|
| 28 |
\subsection{Define Documentation} |
| 29 |
\hypertarget{group__stream__line_ga3}{ |
| 30 |
\index{stream_line@{stream\_\-line}!LINEMODE_BUFFER_SIZE@{LINEMODE\_\-BUFFER\_\-SIZE}} |
| 31 |
\index{LINEMODE_BUFFER_SIZE@{LINEMODE\_\-BUFFER\_\-SIZE}!stream_line@{stream\_\-line}} |
| 32 |
\subsubsection[LINEMODE\_\-BUFFER\_\-SIZE]{\setlength{\rightskip}{0pt plus 5cm}\#define LINEMODE\_\-BUFFER\_\-SIZE\ 1024}} |
| 33 |
\label{group__stream__line_ga3} |
| 34 |
|
| 35 |
|
| 36 |
Internal library buffer size for line mode. |
| 37 |
|
| 38 |
The length of the line obtained via \hyperlink{group__stream__line_ga44}{peak\_\-stream\_\-get\_\-line()} cannot be highter than that. |
| 39 |
|
| 40 |
\subsection{Function Documentation} |
| 41 |
\hypertarget{group__stream__line_ga2}{ |
| 42 |
\index{stream_line@{stream\_\-line}!peak_stream_get_line@{peak\_\-stream\_\-get\_\-line}} |
| 43 |
\index{peak_stream_get_line@{peak\_\-stream\_\-get\_\-line}!stream_line@{stream\_\-line}} |
| 44 |
\subsubsection[peak\_\-stream\_\-get\_\-line]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ peak\_\-stream\_\-get\_\-line (\hyperlink{group__stream_ga0}{peak\_\-stream} {\em s})}} |
| 45 |
\label{group__stream__line_ga2} |
| 46 |
|
| 47 |
|
| 48 |
Get a pointer to the next line read on a stream. |
| 49 |
|
| 50 |
This function loan you a pointer to a mutable buffer. You are allowed to modify it (at least the bytes until the 0 sentinel character). It's useful and efficient for inline tokenizers. Please note this buffer is only valid until the next stream operation. |
| 51 |
|
| 52 |
\begin{Desc} |
| 53 |
\item[Parameters:] |
| 54 |
\begin{description} |
| 55 |
\item[{\em s}]The stream reference.\end{description} |
| 56 |
\end{Desc} |
| 57 |
\begin{Desc} |
| 58 |
\item[Returns:]A pointer to the line read (mutable buffer). \end{Desc} |
| 59 |
\hypertarget{group__stream__line_ga0}{ |
| 60 |
\index{stream_line@{stream\_\-line}!peak_stream_is_linemode_enabled@{peak\_\-stream\_\-is\_\-linemode\_\-enabled}} |
| 61 |
\index{peak_stream_is_linemode_enabled@{peak\_\-stream\_\-is\_\-linemode\_\-enabled}!stream_line@{stream\_\-line}} |
| 62 |
\subsubsection[peak\_\-stream\_\-is\_\-linemode\_\-enabled]{\setlength{\rightskip}{0pt plus 5cm}int peak\_\-stream\_\-is\_\-linemode\_\-enabled (\hyperlink{group__stream_ga0}{peak\_\-stream} {\em s})}} |
| 63 |
\label{group__stream__line_ga0} |
| 64 |
|
| 65 |
|
| 66 |
Test if the stream is currently in line mode. |
| 67 |
|
| 68 |
\begin{Desc} |
| 69 |
\item[Parameters:] |
| 70 |
\begin{description} |
| 71 |
\item[{\em s}]The stream reference.\end{description} |
| 72 |
\end{Desc} |
| 73 |
\begin{Desc} |
| 74 |
\item[Return values:] |
| 75 |
\begin{description} |
| 76 |
\item[{\em 0}]if linemode is disabled. \item[{\em 1}]if linemode is enabled: you can use \hyperlink{group__stream__line_ga44}{peak\_\-stream\_\-get\_\-line()}. \end{description} |
| 77 |
\end{Desc} |
| 78 |
\hypertarget{group__stream__line_ga1}{ |
| 79 |
\index{stream_line@{stream\_\-line}!peak_stream_set_linemode@{peak\_\-stream\_\-set\_\-linemode}} |
| 80 |
\index{peak_stream_set_linemode@{peak\_\-stream\_\-set\_\-linemode}!stream_line@{stream\_\-line}} |
| 81 |
\subsubsection[peak\_\-stream\_\-set\_\-linemode]{\setlength{\rightskip}{0pt plus 5cm}void peak\_\-stream\_\-set\_\-linemode (\hyperlink{group__stream_ga0}{peak\_\-stream} {\em s})}} |
| 82 |
\label{group__stream__line_ga1} |
| 83 |
|
| 84 |
|
| 85 |
Set line mode dynamically. |
| 86 |
|
| 87 |
Note that you cannot disable linemode with the current implementation. |
| 88 |
|
| 89 |
\begin{Desc} |
| 90 |
\item[Parameters:] |
| 91 |
\begin{description} |
| 92 |
\item[{\em s}]The stream reference. \end{description} |
| 93 |
\end{Desc} |
