Merge pull request #67 from ErwannLesech/add_comments

doc<files> add description of files and functions

src/ast/ast.h

@@ -1,7 +1,7 @@
 /**
  * \file ast.h
  * \brief Represent a node of the AST.
- * \author Erwann Lesech, Valentin Gibert, Ugo Majer, Alexandre Privat
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
  * \version 1.0
  * \date 12/01/2024
  */

src/execute/ast_eval.c

@@ -1,7 +1,7 @@
 /**
  * \file ast_eval.c
  * \brief Evaluate the AST.
- * \author Erwann Lesech, Valentin Gibert, Ugo Majer, Alexandre Privat
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
  * \version 1.0
  * \date 12/01/2024
  */
@@ -21,6 +21,7 @@
 // error else
 
 /**
+ * \struct builtin_function
  * \brief Structure representing a builtin function.
  */
 struct builtin_function
@@ -29,10 +30,20 @@ struct builtin_function
     int (*fun)(struct ast_node *);
 };
 
+/**
+ * \struct builtin_function
+ * \brief Structure representing a builtin function.
+*/
 struct builtin_function builtin[] = { { .name = "echo", .fun = echo_fun },
                                       { .name = "true", .fun = true_fun },
                                       { .name = "false", .fun = false_fun } };
 
+/**
+ * \brief Evaluate the while loop
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int exec_cmd(struct ast_node *node, bool logger_enabled)
 {
     int pid = fork();
@@ -83,6 +94,12 @@ int ast_command(struct ast_node *node, bool logger_enabled)
     return match_ast(node->children[0], logger_enabled);
 }
 
+/**
+ * \brief Evaluate simple command from ast
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int ast_eval_simple_command(struct ast_node *node, bool logger_enabled)
 {
     if (node->children[0]->type == AST_WORD_ASSIGNMENT)
@@ -100,6 +117,12 @@ int ast_eval_simple_command(struct ast_node *node, bool logger_enabled)
     return exec_cmd(node, logger_enabled);
 }
 
+/**
+ * \brief Evaluate condition from ast
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int ast_eval_condition(struct ast_node *node, bool logger_enabled)
 {
     int cond = match_ast(node->children[0], logger_enabled);
@@ -117,6 +140,12 @@ int ast_eval_condition(struct ast_node *node, bool logger_enabled)
     }
 }
 
+/**
+ * \brief Evaluate command list from ast
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int ast_eval_command_list(struct ast_node *node, bool logger_enabled)
 {
     int status = 0;
@@ -158,4 +187,4 @@ int match_ast(struct ast_node *node, bool logger_enabled)
     default:
         return -1;
     }
-}
+}

src/execute/ast_eval.h

@@ -1,7 +1,7 @@
 /**
  * \file ast_eval.h
  * \brief Evaluate the AST.
- * \author Erwann Lesech, Valentin Gibert, Ugo Majer, Alexandre Privat
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
  * \version 1.0
  * \date 12/01/2024
  */
@@ -15,17 +15,74 @@
 #include "options/options.h"
 
 /**
- * \brief Evaluates the given AST and returns the exit status of the last
- * command. \param node The AST to evaluate. \param logger_enabled Whether the
- * logger is enabled or not. \return The exit status of the last command.
+ * \brief Evaluate the given AST
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
  */
 int match_ast(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate the while loop
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+ */
 int while_loop(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate the until loop
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int until_loop(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate the for loop
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int for_loop(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Pipeline evaluation.
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+*/
 int pipeline_eval(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate and_or
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+ */
 int ast_and_or(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate the ast assignement
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+ */
 int ast_eval_assignment(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Evaluate command from ast
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command.
+ */
 int ast_command(struct ast_node *node, bool logger_enabled);
+
+/**
+ * \brief Handle word assignment
+ * \param node The AST to evaluate.
+ * \return The exit status of the last command.
+ */
 char *handle_word(struct ast_node *node);
+
 #endif /* AST_EVAL_H */

src/execute/ast_variable.c

@@ -1,9 +1,20 @@
+/**
+ * \file ast_variable.c
+ * \brief Handle variables.
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
+ * \version 1.0
+ * \date 12/01/2024
+ */
+
 #include "ast_eval.h"
 #include "hash_map/hash_map.h"
 #include "parser/parser.h"
 
 struct hash_map *variables = NULL;
 
+/**
+ * \brief Initialize the variables hash map.
+*/
 void init_variables()
 {
     if (variables == NULL)
@@ -12,19 +23,32 @@ void init_variables()
     }
 }
 
+/**
+ * \brief Free the variables hash map.
+*/
 void free_variables()
 {
     if (variables != NULL)
         hash_map_free(variables);
 }
 
+/**
+ * \brief Set a variable in the hash map.
+ * \param key The key of the variable.
+ * \param value The value of the variable.
+*/
 void set_variable(char *key, char *value)
 {
     init_variables();
     bool updated;
     hash_map_insert(variables, key, value, &updated);
 }
 
+/**
+ * \brief Get a variable from the hash map.
+ * \param key The key of the variable.
+ * \return The value of the variable or NULL if not found.
+*/
 char *get_variable(char *key)
 {
     key++;
@@ -51,6 +75,12 @@ char *get_variable(char *key)
     return "";
 }
 
+/**
+ * \brief Evaluate a node from the AST.
+ * \param node The AST to evaluate.
+ * \param logger_enabled Whether the logger is enabled or not.
+ * \return The exit status of the last command 0 if success, 1 if error.
+*/
 int ast_eval_assignment(struct ast_node *node, bool logger_enabled)
 {
     if (logger_enabled)
@@ -63,8 +93,11 @@ int ast_eval_assignment(struct ast_node *node, bool logger_enabled)
     return 0;
 }
 
-// Small function for handle variable (just check ast_node type and check the
-// hash table)
+/**
+ * \brief Small function for handle variable (just check ast_node type and check the hash table)
+ * \param node The AST to evaluate.
+ * \return The value of the variable or NULL if not found.
+*/
 char *handle_word(struct ast_node *node)
 {
     if (node->type == AST_WORD)

src/execute/builtin.c

@@ -1,7 +1,7 @@
 /**
  * \file builtin.c
  * \brief Builtin functions.
- * \author Erwann Lesech, Valentin Gibert, Ugo Majer, Alexandre Privat
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
  * \version 1.0
  * \date 12/01/2024
  */
@@ -26,6 +26,11 @@ int false_fun(struct ast_node *node)
     return 1;
 }
 
+/**
+ * \brief Print the current working directory.
+ * \param node The AST to evaluate.
+ * \return The exit status of the last command 0 if success, 1 if error.
+*/
 void print_echo(struct ast_node *node, int enable_escapes, int j)
 {
     for (int i = j; i < node->children_count; i++)
@@ -66,7 +71,11 @@ void print_echo(struct ast_node *node, int enable_escapes, int j)
     }
 }
 
-// TO REDUCE
+/**
+ * \brief Echo builtin function and returns the exit status.
+ * \param node The AST node.
+ * \return The exit status of the last command 0 if success, 1 if error.
+*/
 int echo_fun(struct ast_node *node)
 {
     int no_newline = 0;

src/execute/builtin.h

@@ -1,7 +1,7 @@
 /**
  * \file builtin.h
- * \brief Builtin functions.
- * \author Erwann Lesech, Valentin Gibert, Ugo Majer, Alexandre Privat
+ * \brief Header of the builtin functions.
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
  * \version 1.0
  * \date 12/01/2024
  */

src/execute/hash_map/hash.c

@@ -1,3 +1,11 @@
+/**
+ * \file hash.c
+ * \brief Implement the hash function.
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
+ * \version 1.0
+ * \date 12/01/2024
+ */
+
 #include <stddef.h>
 
 #include "hash_map.h"

src/execute/hash_map/hash_map.c

@@ -1,3 +1,11 @@
+/**
+ * \file hash_map.c
+ * \brief Implement the hash map.
+ * \author Erwann Lesech, Valentin Gibbe, Ugo Majer, Alexandre Privat
+ * \version 1.0
+ * \date 12/01/2024
+ */
+
 #include "hash_map.h"
 
 #include <stdbool.h>