SDL/visualtest/docs/latex/testharness_8c.tex

68 lines
6.0 KiB
TeX
Raw Normal View History

2013-11-29 13:06:08 +00:00
\hypertarget{testharness_8c}{\section{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/testharness.c File Reference}
\label{testharness_8c}\index{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/testharness.\-c@{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/src/testharness.\-c}}
}
{\ttfamily \#include $<$stdlib.\-h$>$}\\*
{\ttfamily \#include $<$S\-D\-L\-\_\-test.\-h$>$}\\*
{\ttfamily \#include $<$S\-D\-L.\-h$>$}\\*
{\ttfamily \#include $<$S\-D\-L\-\_\-assert.\-h$>$}\\*
{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-harness\-\_\-argparser.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-process.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-variators.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-screenshot.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-mischelper.\-h\char`\"{}}\\*
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item
\#define \hyperlink{testharness_8c_a0d1d5d1394089a10f0147ed2b89c1165}{A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}~0
\item
\#define \hyperlink{testharness_8c_acdc6cb4935ca89fbe3fda31a8f533b9a}{K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}~1
\item
\#define \hyperlink{testharness_8c_a70102426e83ed3944f9c060bd82fb54e}{A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S}~10
\item
\#define \hyperlink{testharness_8c_a562e15dd66cf158c98dbfec9f6afa1ae}{T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D}~1
\item
\#define \hyperlink{testharness_8c_a8b8b91205df891e2c7837bd03795306f}{T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D}~0
\item
\#define \hyperlink{testharness_8c_a8251bcdfc5c83845e0834adf211de033}{T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R}~-\/1
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item
int \hyperlink{testharness_8c_a0ddf1224851353fc92bfbff6f499fa97}{main} (int argc, char $\ast$argv\mbox{[}$\,$\mbox{]})
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Source file for the test harness.
\subsection{Macro Definition Documentation}
\hypertarget{testharness_8c_a70102426e83ed3944f9c060bd82fb54e}{\index{testharness.\-c@{testharness.\-c}!A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S@{A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S}}
\index{A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S@{A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S}!testharness.c@{testharness.\-c}}
\subsubsection[{A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-C\-T\-I\-O\-N\-\_\-\-L\-O\-O\-P\-\_\-\-F\-P\-S~10}}\label{testharness_8c_a70102426e83ed3944f9c060bd82fb54e}
F\-P\-S value used for delays in the action loop \hypertarget{testharness_8c_a0d1d5d1394089a10f0147ed2b89c1165}{\index{testharness.\-c@{testharness.\-c}!A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T@{A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}}
\index{A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T@{A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}!testharness.c@{testharness.\-c}}
\subsubsection[{A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-C\-T\-I\-O\-N\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T~0}}\label{testharness_8c_a0d1d5d1394089a10f0147ed2b89c1165}
Code for the user event triggered when a new action is to be executed \hypertarget{testharness_8c_acdc6cb4935ca89fbe3fda31a8f533b9a}{\index{testharness.\-c@{testharness.\-c}!K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T@{K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}}
\index{K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T@{K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}!testharness.c@{testharness.\-c}}
\subsubsection[{K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T}]{\setlength{\rightskip}{0pt plus 5cm}\#define K\-I\-L\-L\-\_\-\-T\-I\-M\-E\-R\-\_\-\-E\-V\-E\-N\-T~1}}\label{testharness_8c_acdc6cb4935ca89fbe3fda31a8f533b9a}
Code for the user event triggered when the maximum timeout is reached \hypertarget{testharness_8c_a8251bcdfc5c83845e0834adf211de033}{\index{testharness.\-c@{testharness.\-c}!T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R@{T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R}}
\index{T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R@{T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R}!testharness.c@{testharness.\-c}}
\subsubsection[{T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R}]{\setlength{\rightskip}{0pt plus 5cm}\#define T\-E\-S\-T\-\_\-\-E\-R\-R\-O\-R~-\/1}}\label{testharness_8c_a8251bcdfc5c83845e0834adf211de033}
Value returned by Run\-S\-U\-T\-And\-Test() on a fatal error \hypertarget{testharness_8c_a8b8b91205df891e2c7837bd03795306f}{\index{testharness.\-c@{testharness.\-c}!T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D@{T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D}}
\index{T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D@{T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D}!testharness.c@{testharness.\-c}}
\subsubsection[{T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D}]{\setlength{\rightskip}{0pt plus 5cm}\#define T\-E\-S\-T\-\_\-\-F\-A\-I\-L\-E\-D~0}}\label{testharness_8c_a8b8b91205df891e2c7837bd03795306f}
Value returned by Run\-S\-U\-T\-And\-Test() when the test has failed \hypertarget{testharness_8c_a562e15dd66cf158c98dbfec9f6afa1ae}{\index{testharness.\-c@{testharness.\-c}!T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D@{T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D}}
\index{T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D@{T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D}!testharness.c@{testharness.\-c}}
\subsubsection[{T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D}]{\setlength{\rightskip}{0pt plus 5cm}\#define T\-E\-S\-T\-\_\-\-P\-A\-S\-S\-E\-D~1}}\label{testharness_8c_a562e15dd66cf158c98dbfec9f6afa1ae}
Value returned by Run\-S\-U\-T\-And\-Test() when the test has passed
\subsection{Function Documentation}
\hypertarget{testharness_8c_a0ddf1224851353fc92bfbff6f499fa97}{\index{testharness.\-c@{testharness.\-c}!main@{main}}
\index{main@{main}!testharness.c@{testharness.\-c}}
\subsubsection[{main}]{\setlength{\rightskip}{0pt plus 5cm}int main (
\begin{DoxyParamCaption}
\item[{int}]{argc, }
\item[{char $\ast$}]{argv\mbox{[}$\,$\mbox{]}}
\end{DoxyParamCaption}
)}}\label{testharness_8c_a0ddf1224851353fc92bfbff6f499fa97}
Entry point for testharness