Guams/extFS-Seyshell
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
df61a12ae8
extFS-Seyshell/docs/html/parsing_8c.html
guamss df61a12ae8 docs: added doxygen doc
2026-05-25 15:39:10 +02:00

268 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Seyshell: src/parsing.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Seyshell
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">parsing.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Gestion de l'interface utilisateur (CLI), du parsing syntaxique de la ligne de commande et de la boucle principale du Shell.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="parsing_8h_source.html">parsing.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="disk_8h_source.html">disk.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="exec_8h_source.html">exec.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="struct_8h_source.html">struct.h</a>&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;unistd.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for parsing.c:</div>
<div class="dyncontent">
<div class="center"><img src="parsing_8c__incl.png" border="0" usemap="#asrc_2parsing_8c" alt=""/></div>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9e35a75d71f9fc522c563668fbbec457" id="r_a9e35a75d71f9fc522c563668fbbec457"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsing_8c.html#a9e35a75d71f9fc522c563668fbbec457">read_line</a> ()</td></tr>
<tr class="memdesc:a9e35a75d71f9fc522c563668fbbec457"><td class="mdescLeft">&#160;</td><td class="mdescRight">Récupère une ligne de texte saisie par l'utilisateur sur l'entrée standard (stdin). <br /></td></tr>
<tr class="separator:a9e35a75d71f9fc522c563668fbbec457"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a464ab1601eda451f2836222bc20a4932" id="r_a464ab1601eda451f2836222bc20a4932"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcommand.html">command</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsing_8c.html#a464ab1601eda451f2836222bc20a4932">split_line</a> (char *line)</td></tr>
<tr class="memdesc:a464ab1601eda451f2836222bc20a4932"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analyse une ligne de texte brute et la transforme en un tableau de structures de commandes. <br /></td></tr>
<tr class="separator:a464ab1601eda451f2836222bc20a4932"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad74877f90b508ee0351985458b570a98" id="r_ad74877f90b508ee0351985458b570a98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsing_8c.html#ad74877f90b508ee0351985458b570a98">shell_loop</a> (<a class="el" href="structdisk.html">disk</a> *<a class="el" href="structdisk.html">disk</a>)</td></tr>
<tr class="memdesc:ad74877f90b508ee0351985458b570a98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Boucle d'exécution infinie (REPL) régissant le cycle de vie du Shell. <br /></td></tr>
<tr class="separator:ad74877f90b508ee0351985458b570a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6aa59f98cad89c73966351ad7afb303c" id="r_a6aa59f98cad89c73966351ad7afb303c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsing_8c.html#a6aa59f98cad89c73966351ad7afb303c">signal_handler</a> (int sig)</td></tr>
<tr class="memdesc:a6aa59f98cad89c73966351ad7afb303c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intercepteur (Handler) de signal pour dérouter l'action par défaut du signal d'interruption SIGINT. <br /></td></tr>
<tr class="separator:a6aa59f98cad89c73966351ad7afb303c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4208525aa40712ec3f936080773468c8" id="r_a4208525aa40712ec3f936080773468c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="parsing_8c.html#a4208525aa40712ec3f936080773468c8">open_seyshell</a> (<a class="el" href="structdisk.html">disk</a> *<a class="el" href="structdisk.html">disk</a>)</td></tr>
<tr class="memdesc:a4208525aa40712ec3f936080773468c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise le contexte opérationnel complet et démarre le Shell intégré. <br /></td></tr>
<tr class="separator:a4208525aa40712ec3f936080773468c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Gestion de l'interface utilisateur (CLI), du parsing syntaxique de la ligne de commande et de la boucle principale du Shell. </p>
<p>Ce fichier implémente l'analyseur lexical (tokenizer) et syntaxique basique capable de découper une ligne de texte en commandes interconnectées par des opérateurs de contrôle ('|', '&gt;', '&gt;&gt;'). </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a4208525aa40712ec3f936080773468c8" name="a4208525aa40712ec3f936080773468c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4208525aa40712ec3f936080773468c8">&#9670;&#160;</a></span>open_seyshell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void open_seyshell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdisk.html">disk</a> *&#160;</td>
<td class="paramname"><em>disk</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise le contexte opérationnel complet et démarre le Shell intégré. </p>
<p>Configure la table des signaux pour immuniser le processus père contre les interruptions de terminal (<code>SIGINT</code>), instancie le dictionnaire global des variables d'environnement, puis bascule dans la boucle d'écoute.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">disk</td><td>Pointeur vers le disque virtuel à attacher au Shell. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9e35a75d71f9fc522c563668fbbec457" name="a9e35a75d71f9fc522c563668fbbec457"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e35a75d71f9fc522c563668fbbec457">&#9670;&#160;</a></span>read_line()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * read_line </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Récupère une ligne de texte saisie par l'utilisateur sur l'entrée standard (stdin). </p>
<p>Lit les caractères un par un jusqu'à rencontrer un retour à la ligne ('<br />
') ou la fin de fichier (EOF). Alloue dynamiquement un tampon mémoire (buffer) et l'agrandit par blocs successifs via <code>realloc</code> si la taille de la saisie dépasse le volume initial <code>BUFSIZE</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>La chaîne renvoyée est allouée dynamiquement. Il incombe à la fonction appelante de libérer la mémoire via <code>free()</code>.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>char* Un pointeur vers la chaîne de caractères lue (terminée par '\0'), ou provoque l'arrêt du programme en cas d'échec d'allocation. </dd></dl>
</div>
</div>
<a id="ad74877f90b508ee0351985458b570a98" name="ad74877f90b508ee0351985458b570a98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad74877f90b508ee0351985458b570a98">&#9670;&#160;</a></span>shell_loop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shell_loop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdisk.html">disk</a> *&#160;</td>
<td class="paramname"><em>disk</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Boucle d'exécution infinie (REPL) régissant le cycle de vie du Shell. </p>
<p>Cette fonction orchestre en continu les étapes suivantes :</p><ol type="1">
<li>Affiche l'invite de commande (Prompt) formatée à l'aide des variables utilisateur et système.</li>
<li>Bloque l'exécution dans l'attente d'une entrée utilisateur via <code><a class="el" href="parsing_8c.html#a9e35a75d71f9fc522c563668fbbec457" title="Récupère une ligne de texte saisie par l&#39;utilisateur sur l&#39;entrée standard (stdin).">read_line()</a></code>.</li>
<li>Découpe syntaxiquement la chaîne obtenue via <code><a class="el" href="parsing_8c.html#a464ab1601eda451f2836222bc20a4932" title="Analyse une ligne de texte brute et la transforme en un tableau de structures de commandes.">split_line()</a></code>.</li>
<li>Transmet le résultat au moteur d'exécution <code><a class="el" href="exec_8c.html#a82beace5b13f7e2d89dae34187bb7f46" title="Point d&#39;entrée principal pour l&#39;orchestration, le pipelining et l&#39;exécution d&#39;une ligne de commande.">execute_cmd()</a></code>.</li>
<li>Libère proprement les structures temporaires avant le tour suivant.</li>
</ol>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">disk</td><td>Pointeur vers le disque virtuel sur lequel opèrent les commandes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6aa59f98cad89c73966351ad7afb303c" name="a6aa59f98cad89c73966351ad7afb303c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aa59f98cad89c73966351ad7afb303c">&#9670;&#160;</a></span>signal_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void signal_handler </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sig</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Intercepteur (Handler) de signal pour dérouter l'action par défaut du signal d'interruption SIGINT. </p>
<p>Empêche le processus parent du Shell de se terminer brutalement lors de la combinaison de touches Ctrl+C. À la place, il effectue un retour à la ligne et réaffiche un prompt propre pour restituer le contrôle à l'utilisateur.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sig</td><td>Numéro du signal reçu (attendu : SIGINT). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a464ab1601eda451f2836222bc20a4932" name="a464ab1601eda451f2836222bc20a4932"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a464ab1601eda451f2836222bc20a4932">&#9670;&#160;</a></span>split_line()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structcommand.html">command</a> ** split_line </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>line</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Analyse une ligne de texte brute et la transforme en un tableau de structures de commandes. </p>
<p>Le traitement s'effectue en deux phases principales :</p><ol type="1">
<li>Un découpage lexical premier basé sur l'espace (" ") via <code>strtok</code> pour isoler les mots.</li>
<li>Un découpage syntaxique (parsing) qui regroupe les arguments dans des structures <code>command</code>. Les caractères spéciaux comme le tube (<code>|</code>) créent une nouvelle structure de commande, tandis que les opérateurs de redirection (<code>&gt;</code> et <code>&gt;&gt;</code>) configurent les champs <code>redirect_out</code> et <code>append_mode</code> de la commande courante.</li>
</ol>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">line</td><td>La chaîne de caractères brute saisie dans le terminal. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>command** Un tableau de pointeurs vers des structures <code>command</code> (le tableau est terminé par un pointeur NULL). Retourne NULL si la ligne est vide. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink