Files
Sokoban/rapport/latex/read_8c.tex
2025-01-08 13:47:38 +01:00

107 lines
4.9 KiB
TeX

\doxysection{Référence du fichier read.\+c}
\label{read_8c}\index{read.c@{read.c}}
{\ttfamily \#include "{}../include/function.\+h"{}}\newline
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
{\ttfamily \#include $<$string.\+h$>$}\newline
Graphe des dépendances par inclusion de read.\+c\+:
% FIG 0
\doxysubsubsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
\textbf{ vect} $\ast$ \textbf{ file\+To\+Tab2D} (const char $\ast$name\+\_\+file, char $\ast$$\ast$tab, const unsigned N, \textbf{ vect} $\ast$player, int $\ast$nbr\+\_\+targets)
\begin{DoxyCompactList}\small\item\em La fonction permet de stocker la zone de jeu en fonction de la lecture d\textquotesingle{}un fichier. \end{DoxyCompactList}\item
int \textbf{ count\+Custom\+Maps} (char $\ast$name\+\_\+directory)
\begin{DoxyCompactList}\small\item\em La fonction permet de compter le nombre de maps custom dans le fichier des maps. \end{DoxyCompactList}\item
char $\ast$$\ast$ \textbf{ generator\+Menu} (char $\ast$name\+\_\+directory, \textbf{ vect} $\ast$size, \textbf{ vect} $\ast$pos\+\_\+player)
\begin{DoxyCompactList}\small\item\em La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom. \end{DoxyCompactList}\item
void \textbf{ save\+\_\+grid\+\_\+to\+\_\+file} (int filename, char $\ast$$\ast$tab2D)
\begin{DoxyCompactList}\small\item\em La fonction permet de retranscrire un niveau creer du tableau vers le fichier.\+txt. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Description détaillée}
Ce fichier est le programe qui lit d\textquotesingle{}autre fichier, nottament les maps.
\doxysubsection{Documentation des fonctions}
\index{read.c@{read.c}!countCustomMaps@{countCustomMaps}}
\index{countCustomMaps@{countCustomMaps}!read.c@{read.c}}
\doxysubsubsection{countCustomMaps()}
{\footnotesize\ttfamily \label{read_8c_a33f349fef5188584733f08c3a0eddbf2}
int count\+Custom\+Maps (\begin{DoxyParamCaption}\item[{char $\ast$}]{name\+\_\+directory}{}\end{DoxyParamCaption})}
La fonction permet de compter le nombre de maps custom dans le fichier des maps.
\begin{DoxyParams}{Paramètres}
{\em name\+\_\+directory} & Le nom du dossier contenant les maps. return Le nombre de maps custom. \\
\hline
\end{DoxyParams}
Voici le graphe des appelants de cette fonction \+:
% FIG 1
\index{read.c@{read.c}!fileToTab2D@{fileToTab2D}}
\index{fileToTab2D@{fileToTab2D}!read.c@{read.c}}
\doxysubsubsection{fileToTab2D()}
{\footnotesize\ttfamily \label{read_8c_a223592601b10fb9487363ff4bb417d5d}
\textbf{ vect} $\ast$ file\+To\+Tab2D (\begin{DoxyParamCaption}\item[{const char $\ast$}]{name\+\_\+file}{, }\item[{char $\ast$$\ast$}]{tab}{, }\item[{const unsigned}]{N}{, }\item[{\textbf{ vect} $\ast$}]{player}{, }\item[{int $\ast$}]{nbr\+\_\+targets}{}\end{DoxyParamCaption})}
La fonction permet de stocker la zone de jeu en fonction de la lecture d\textquotesingle{}un fichier.
\begin{DoxyParams}{Paramètres}
{\em name\+\_\+file} & Le nom du fichier a ouvrir. \\
\hline
{\em tab} & Le tableau 2D carre du plateau de jeu a remplir. \\
\hline
{\em N} & La taille de tab. \\
\hline
{\em player} & Les coordonnée du joueur que le programe vas trouvé. \\
\hline
{\em nbr\+\_\+targets} & Le nombre de points d\textquotesingle{}interer trouver. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Vect La fonction renvoie le tableau des coordonnée des points d\textquotesingle{}interer.
\end{DoxyReturn}
\index{read.c@{read.c}!generatorMenu@{generatorMenu}}
\index{generatorMenu@{generatorMenu}!read.c@{read.c}}
\doxysubsubsection{generatorMenu()}
{\footnotesize\ttfamily \label{read_8c_aa77b744c6eb2919d8d69ae718210ce55}
char $\ast$$\ast$ generator\+Menu (\begin{DoxyParamCaption}\item[{char $\ast$}]{name\+\_\+directory}{, }\item[{\textbf{ vect} $\ast$}]{size}{, }\item[{\textbf{ vect} $\ast$}]{pos\+\_\+player}{}\end{DoxyParamCaption})}
La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom.
\begin{DoxyParams}{Paramètres}
{\em name\+\_\+directory} & Le nom du dossier contenant les maps. \\
\hline
{\em size} & La taille de la zone de jeu. \\
\hline
{\em pos\+\_\+player} & La position du joueur dans le menu. \\
\hline
\end{DoxyParams}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
% FIG 2
\index{read.c@{read.c}!save\_grid\_to\_file@{save\_grid\_to\_file}}
\index{save\_grid\_to\_file@{save\_grid\_to\_file}!read.c@{read.c}}
\doxysubsubsection{save\_grid\_to\_file()}
{\footnotesize\ttfamily \label{read_8c_a8f809f62f6622ef16b6dfe9081a124de}
void save\+\_\+grid\+\_\+to\+\_\+file (\begin{DoxyParamCaption}\item[{int}]{filename}{, }\item[{char $\ast$$\ast$}]{tab2D}{}\end{DoxyParamCaption})}
La fonction permet de retranscrire un niveau creer du tableau vers le fichier.\+txt.
\begin{DoxyParams}{Paramètres}
{\em filename} & Le nom du fichier a remplir. \\
\hline
{\em tab2d} & Le tableau 2d carre. \\
\hline
\end{DoxyParams}