kc3-lang/SDL/visualtest/docs/latex/parsehelper_8c.tex

• Show log

  Commit

• Hash : 9c398852
  Author :
  Date : 2014-11-22T22:20:40
  

  Corrected header file documentation comment.

Download

• visualtest/docs/latex/parsehelper_8c.tex

• \hypertarget{parsehelper_8c}{\section{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/parsehelper.c File Reference}
  \label{parsehelper_8c}\index{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/parsehelper.\-c@{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/parsehelper.\-c}}
  }
  {\ttfamily \#include $<$S\-D\-L\-\_\-test.\-h$>$}\\*
  {\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-harness\-\_\-argparser.\-h\char`\"{}}\\*
  \subsection*{Functions}
  \begin{DoxyCompactItemize}
  \item 
  char $\ast$$\ast$ \hyperlink{parsehelper_8c_a508e690ed938e09fc3b724d2faf06899}{S\-D\-L\-Visual\-Test\-\_\-\-Tokenize} (char $\ast$str, int max\-\_\-token\-\_\-len)
  \item 
  char $\ast$$\ast$ \hyperlink{parsehelper_8c_a5f168fdd02f9d40ddbad97bd8c0b6361}{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv} (char $\ast$args)
  \end{DoxyCompactItemize}
  
  
  \subsection{Detailed Description}
  Source file with some helper functions for parsing strings. 
  
  \subsection{Function Documentation}
  \hypertarget{parsehelper_8c_a5f168fdd02f9d40ddbad97bd8c0b6361}{\index{parsehelper.\-c@{parsehelper.\-c}!S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv@{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv}}
  \index{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv@{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv}!parsehelper.c@{parsehelper.\-c}}
  \subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$$\ast$ S\-D\-L\-Visual\-Test\-\_\-\-Parse\-Args\-To\-Argv (
  \begin{DoxyParamCaption}
  \item[{char $\ast$}]{args}
  \end{DoxyParamCaption}
  )}}\label{parsehelper_8c_a5f168fdd02f9d40ddbad97bd8c0b6361}
  Takes an string of command line arguments and breaks them up into an array based on whitespace.
  
  
  \begin{DoxyParams}{Parameters}
  {\em args} & The string of arguments.\\
  \hline
  \end{DoxyParams}
  \begin{DoxyReturn}{Returns}
  N\-U\-L\-L on failure, an array of strings on success. The last element of the array is N\-U\-L\-L. The first element of the array is N\-U\-L\-L and should be set to the path of the executable by the caller. 
  \end{DoxyReturn}
  \hypertarget{parsehelper_8c_a508e690ed938e09fc3b724d2faf06899}{\index{parsehelper.\-c@{parsehelper.\-c}!S\-D\-L\-Visual\-Test\-\_\-\-Tokenize@{S\-D\-L\-Visual\-Test\-\_\-\-Tokenize}}
  \index{S\-D\-L\-Visual\-Test\-\_\-\-Tokenize@{S\-D\-L\-Visual\-Test\-\_\-\-Tokenize}!parsehelper.c@{parsehelper.\-c}}
  \subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Tokenize}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$$\ast$ S\-D\-L\-Visual\-Test\-\_\-\-Tokenize (
  \begin{DoxyParamCaption}
  \item[{char $\ast$}]{str, }
  \item[{int}]{max\-\_\-token\-\_\-len}
  \end{DoxyParamCaption}
  )}}\label{parsehelper_8c_a508e690ed938e09fc3b724d2faf06899}
  Takes a string and breaks it into tokens by splitting on whitespace.
  
  
  \begin{DoxyParams}{Parameters}
  {\em str} & The string to be split. \\
  \hline
  {\em max\-\_\-token\-\_\-len} & Length of each element in the array to be returned.\\
  \hline
  \end{DoxyParams}
  \begin{DoxyReturn}{Returns}
  N\-U\-L\-L on failure; an array of strings with the tokens on success. The last element of the array is N\-U\-L\-L. 
  \end{DoxyReturn}
  

Download