\section{aversive\_\-10-03-12/modules/ihm/parse/parse\_\-string.h File Reference}
\label{parse__string_8h}\index{aversive\_\-10-03-12/modules/ihm/parse/parse\_\-string.h@{aversive\_\-10-03-12/modules/ihm/parse/parse\_\-string.h}}
{\tt \#include \char`\"{}parse.h\char`\"{}}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct {\bf token\_\-string\_\-data}
\item 
struct {\bf token\_\-string}
\item 
struct {\bf token\_\-string\_\-pgm}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define {\bf STR\_\-TOKEN\_\-SIZE}~32
\item 
\#define {\bf TOKEN\_\-STRING\_\-INITIALIZER}(structure, field, string)
\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef char {\bf fixed\_\-string\_\-t} [STR\_\-TOKEN\_\-SIZE]
\item 
typedef struct {\bf token\_\-string} {\bf parse\_\-token\_\-string\_\-t}
\item 
typedef struct {\bf token\_\-string\_\-pgm} {\bf parse\_\-pgm\_\-token\_\-string\_\-t}
\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int8\_\-t {\bf parse\_\-string} ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$tk, const char $\ast$srcbuf, void $\ast$res)
\item 
int8\_\-t {\bf complete\_\-get\_\-nb\_\-string} ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$tk)
\item 
int8\_\-t {\bf complete\_\-get\_\-elt\_\-string} ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$tk, int8\_\-t idx, char $\ast$dstbuf, uint8\_\-t size)
\item 
int8\_\-t {\bf get\_\-help\_\-string} ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$tk, char $\ast$dstbuf, uint8\_\-t size)
\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
struct {\bf token\_\-string\_\-pgm} {\bf PROGMEM}
\item 
struct {\bf token\_\-ops} {\bf token\_\-string\_\-ops}
\end{CompactItemize}


\subsection{Define Documentation}
\index{parse\_\-string.h@{parse\_\-string.h}!STR\_\-TOKEN\_\-SIZE@{STR\_\-TOKEN\_\-SIZE}}
\index{STR\_\-TOKEN\_\-SIZE@{STR\_\-TOKEN\_\-SIZE}!parse_string.h@{parse\_\-string.h}}
\subsubsection[STR\_\-TOKEN\_\-SIZE]{\setlength{\rightskip}{0pt plus 5cm}\#define STR\_\-TOKEN\_\-SIZE~32}\label{parse__string_8h_3e43088a7b00161ab6fc7b8b3b907ac4}




Definition at line 7 of file parse\_\-string.h.

Referenced by parse\_\-string().\index{parse\_\-string.h@{parse\_\-string.h}!TOKEN\_\-STRING\_\-INITIALIZER@{TOKEN\_\-STRING\_\-INITIALIZER}}
\index{TOKEN\_\-STRING\_\-INITIALIZER@{TOKEN\_\-STRING\_\-INITIALIZER}!parse_string.h@{parse\_\-string.h}}
\subsubsection[TOKEN\_\-STRING\_\-INITIALIZER]{\setlength{\rightskip}{0pt plus 5cm}\#define TOKEN\_\-STRING\_\-INITIALIZER(structure, \/  field, \/  string)}\label{parse__string_8h_81cd432fbccbf7d6048c5c3647ad8f8e}


\textbf{Value:}

\begin{Code}\begin{verbatim}{                                                           \
        .hdr = {                                            \
                .ops = &token_string_ops,                   \
                .offset = offsetof(structure, field),       \
        },                                                  \
        .string_data = {                                    \
                .str = string,                              \
        },                                                  \
}
\end{verbatim}
\end{Code}


Definition at line 34 of file parse\_\-string.h.

\subsection{Typedef Documentation}
\index{parse\_\-string.h@{parse\_\-string.h}!fixed\_\-string\_\-t@{fixed\_\-string\_\-t}}
\index{fixed\_\-string\_\-t@{fixed\_\-string\_\-t}!parse_string.h@{parse\_\-string.h}}
\subsubsection[fixed\_\-string\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef char {\bf fixed\_\-string\_\-t}[STR\_\-TOKEN\_\-SIZE]}\label{parse__string_8h_7dd96d208ea72a7685c5c68fd2d2f9eb}




Definition at line 9 of file parse\_\-string.h.\index{parse\_\-string.h@{parse\_\-string.h}!parse\_\-pgm\_\-token\_\-string\_\-t@{parse\_\-pgm\_\-token\_\-string\_\-t}}
\index{parse\_\-pgm\_\-token\_\-string\_\-t@{parse\_\-pgm\_\-token\_\-string\_\-t}!parse_string.h@{parse\_\-string.h}}
\subsubsection[parse\_\-pgm\_\-token\_\-string\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf token\_\-string\_\-pgm} {\bf parse\_\-pgm\_\-token\_\-string\_\-t}}\label{parse__string_8h_9c8bc905e729fb0e87f49010028fbcbc}




Definition at line 24 of file parse\_\-string.h.\index{parse\_\-string.h@{parse\_\-string.h}!parse\_\-token\_\-string\_\-t@{parse\_\-token\_\-string\_\-t}}
\index{parse\_\-token\_\-string\_\-t@{parse\_\-token\_\-string\_\-t}!parse_string.h@{parse\_\-string.h}}
\subsubsection[parse\_\-token\_\-string\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf token\_\-string} {\bf parse\_\-token\_\-string\_\-t}}\label{parse__string_8h_99227624255b861e9920246c17db27ab}




Definition at line 19 of file parse\_\-string.h.

\subsection{Function Documentation}
\index{parse\_\-string.h@{parse\_\-string.h}!complete\_\-get\_\-elt\_\-string@{complete\_\-get\_\-elt\_\-string}}
\index{complete\_\-get\_\-elt\_\-string@{complete\_\-get\_\-elt\_\-string}!parse_string.h@{parse\_\-string.h}}
\subsubsection[complete\_\-get\_\-elt\_\-string]{\setlength{\rightskip}{0pt plus 5cm}int8\_\-t complete\_\-get\_\-elt\_\-string ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$ {\em tk}, \/  int8\_\-t {\em idx}, \/  char $\ast$ {\em dstbuf}, \/  uint8\_\-t {\em size})}\label{parse__string_8h_50f50bb4833dac72dbf5748bc7a83ca4}




Definition at line 119 of file parse\_\-string.c.

References token\_\-string\_\-data::str.\index{parse\_\-string.h@{parse\_\-string.h}!complete\_\-get\_\-nb\_\-string@{complete\_\-get\_\-nb\_\-string}}
\index{complete\_\-get\_\-nb\_\-string@{complete\_\-get\_\-nb\_\-string}!parse_string.h@{parse\_\-string.h}}
\subsubsection[complete\_\-get\_\-nb\_\-string]{\setlength{\rightskip}{0pt plus 5cm}int8\_\-t complete\_\-get\_\-nb\_\-string ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$ {\em tk})}\label{parse__string_8h_fab16a153b9951f98472727a253ca9ce}




Definition at line 103 of file parse\_\-string.c.

References token\_\-string\_\-data::str.\index{parse\_\-string.h@{parse\_\-string.h}!get\_\-help\_\-string@{get\_\-help\_\-string}}
\index{get\_\-help\_\-string@{get\_\-help\_\-string}!parse_string.h@{parse\_\-string.h}}
\subsubsection[get\_\-help\_\-string]{\setlength{\rightskip}{0pt plus 5cm}int8\_\-t get\_\-help\_\-string ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$ {\em tk}, \/  char $\ast$ {\em dstbuf}, \/  uint8\_\-t {\em size})}\label{parse__string_8h_bc6db97143b152a47bdbe5b674f5598f}




Definition at line 146 of file parse\_\-string.c.

References ANYSTRING\_\-HELP, FIXEDSTRING\_\-HELP, MULTISTRING\_\-HELP, and token\_\-string\_\-data::str.\index{parse\_\-string.h@{parse\_\-string.h}!parse\_\-string@{parse\_\-string}}
\index{parse\_\-string@{parse\_\-string}!parse_string.h@{parse\_\-string.h}}
\subsubsection[parse\_\-string]{\setlength{\rightskip}{0pt plus 5cm}int8\_\-t parse\_\-string ({\bf parse\_\-pgm\_\-token\_\-hdr\_\-t} $\ast$ {\em tk}, \/  const char $\ast$ {\em srcbuf}, \/  void $\ast$ {\em res})}\label{parse__string_8h_dc12f56a3b35e8d1124a5d91786bbec5}




Definition at line 45 of file parse\_\-string.c.

References isendoftoken(), token\_\-string\_\-data::str, and STR\_\-TOKEN\_\-SIZE.

\subsection{Variable Documentation}
\index{parse\_\-string.h@{parse\_\-string.h}!PROGMEM@{PROGMEM}}
\index{PROGMEM@{PROGMEM}!parse_string.h@{parse\_\-string.h}}
\subsubsection[PROGMEM]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf token\_\-string\_\-pgm}  {\bf PROGMEM}}\label{parse__string_8h_b645a8b38e568271c0c7665835d8d519}


\index{parse\_\-string.h@{parse\_\-string.h}!token\_\-string\_\-ops@{token\_\-string\_\-ops}}
\index{token\_\-string\_\-ops@{token\_\-string\_\-ops}!parse_string.h@{parse\_\-string.h}}
\subsubsection[token\_\-string\_\-ops]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf token\_\-ops} {\bf token\_\-string\_\-ops}}\label{parse__string_8h_861f243fee806eb5ab2d50bfb18cb61c}




Definition at line 9 of file parse\_\-string.c.