raphael/minishell
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

style: norming the vec_pid

Browse source
This commit is contained in:
Raphael 2024-09-19 14:04:37 +02:00
parent 95d781f5f1
commit db80dafe9a
1 changed files with 58 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

82
output/include/me/vec/vec_pid.h
View file

@ -6,7 +6,7 @@
/* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */ /* By: maiboyer <maiboyer@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */ /* +#+#+#+#+#+ +#+ */
/* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */ /* Created: 2023/12/04 18:46:53 by maiboyer #+# #+# */
/* Updated: 2023/12/09 17:53:00 by maiboyer ### ########.fr */ /* Updated: 2024/09/19 14:04:24 by rparodi ### ########.fr */
/* */ /* */
/* ************************************************************************** */ /* ************************************************************************** */
@ -22,15 +22,13 @@ typedef bool (*t_vec_pid_sort_fn)(t_pid *, t_pid *);
typedef void (*t_free_pid_item)(t_pid); typedef void (*t_free_pid_item)(t_pid);
/// @brief A dynamic array of t_pid /// @brief A dynamic array of t_pid
typedef struct s_vec_pid t_vec_pid;
struct s_vec_pid struct s_vec_pid
{ {
t_free_pid_item free_func; t_free_pid_item free_func;
t_usize len; t_usize len;
t_usize capacity; t_usize capacity;
t_pid *buffer; t_pid *buffer;
}; } t_vec_pid;
struct s_vec_pid_splice_arguments struct s_vec_pid_splice_arguments
{ {
@ -45,26 +43,28 @@ struct s_vec_pid_splice_arguments
/// elements) /// elements)
/// @param free_function The function that will be used to free the elements of /// @param free_function The function that will be used to free the elements of
/// the vec_pid /// the vec_pid
t_vec_pid vec_pid_new(t_usize capacity, t_vec_pid vec_pid_new(\
t_free_pid_item free_function); t_usize capacity, t_free_pid_item free_function);
/// @brief Push an element to the last position of the vec_pid /// @brief Push an element to the last position of the vec_pid
/// @param vec The vec_pid to push the element to /// @param vec The vec_pid to push the element to
/// @param element The element to push /// @param element The element to push
t_error vec_pid_push(t_vec_pid *vec, t_pid element); t_error vec_pid_push(\
t_vec_pid *vec, t_pid element);
/// @brief Push an element to the first position of the vec_pid /// @brief Push an element to the first position of the vec_pid
/// @param vec The vec_pid to push the element to /// @param vec The vec_pid to push the element to
/// @param element The element to push /// @param element The element to push
/// @note This operation is O(n) /// @note This operation is O(n)
t_error vec_pid_push_front(t_vec_pid *vec, t_error vec_pid_push_front(\
t_pid element); t_vec_pid *vec, t_pid element);
/// @brief Get the last element from the vec_pid, and remove it from the /// @brief Get the last element from the vec_pid, and remove it from the
/// vec_pid /// vec_pid
/// @param vec The vec_pid to get the element from /// @param vec The vec_pid to get the element from
/// @param[out] out The last element of the vec_pid /// @param[out] out The last element of the vec_pid
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
t_error vec_pid_pop(t_vec_pid *vec, t_pid *value); t_error vec_pid_pop(\
t_vec_pid *vec, t_pid *value);
/// @brief Get the first element from the vec_pid, and remove it from /// @brief Get the first element from the vec_pid, and remove it from
/// the vec_pid /// the vec_pid
@ -72,26 +72,28 @@ t_error vec_pid_pop(t_vec_pid *vec, t_pid *value);
/// @param[out] out The first element of the vec_pid /// @param[out] out The first element of the vec_pid
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
/// @note This operation is O(n) /// @note This operation is O(n)
t_error vec_pid_pop_front(t_vec_pid *vec, t_pid *value); t_error vec_pid_pop_front(\
t_vec_pid *vec, t_pid *value);
/// @brief Free the vector and all its elements /// @brief Free the vector and all its elements
/// @param vec The vec_pid to free /// @param vec The vec_pid to free
void vec_pid_free(t_vec_pid vec); void vec_pid_free(\
t_vec_pid vec);
/// @brief Make the vec_pid at least the given capacity /// @brief Make the vec_pid at least the given capacity
/// @param vec The vec_pid to reserve /// @param vec The vec_pid to reserve
/// @param wanted_capacity The minimum capacity to reserve /// @param wanted_capacity The minimum capacity to reserve
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
t_error vec_pid_reserve(t_vec_pid *vec, t_error vec_pid_reserve(\
t_usize wanted_capacity); t_vec_pid *vec, t_usize wanted_capacity);
/// @brief Run the function and returns the index of the first element that /// @brief Run the function and returns the index of the first element that
/// returns true /// returns true
/// @param vec The vec_pid to search in /// @param vec The vec_pid to search in
/// @param fn The function to run on each element /// @param fn The function to run on each element
/// @param[out] index The index of the first element that returns true /// @param[out] index The index of the first element that returns true
t_error vec_pid_find(t_vec_pid *vec, t_error vec_pid_find(\
bool (*fn)(const t_pid *), t_usize *index); t_vec_pid *vec, bool (*fn)(const t_pid *), t_usize *index);
/// @brief Run the function and returns the index of the first element that /// @brief Run the function and returns the index of the first element that
/// returns true, but starting at index starting_index /// returns true, but starting at index starting_index
@ -99,9 +101,9 @@ t_error vec_pid_find(t_vec_pid *vec,
/// @param fn The function to run on each element /// @param fn The function to run on each element
/// @param starting_index The index to start the search from /// @param starting_index The index to start the search from
/// @param[out] index The index of the first element that returns true /// @param[out] index The index of the first element that returns true
t_error vec_pid_find_starting(t_vec_pid *vec, t_error vec_pid_find_starting(\
bool (*fn)(const t_pid *), t_vec_pid *vec, bool (*fn)(\
t_usize starting_index, t_usize *index); const t_pid *), t_usize starting_index, t_usize *index);
/// @brief Run the function on every element of the vec_pid and returns /// @brief Run the function on every element of the vec_pid and returns
/// if all elements returned true /// if all elements returned true
@ -110,8 +112,8 @@ t_error vec_pid_find_starting(t_vec_pid *vec,
/// @param[out] result The result of the operation /// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
/// @note If the vec_pid is empty, result will be true /// @note If the vec_pid is empty, result will be true
t_error vec_pid_all(t_vec_pid *vec, t_error vec_pid_all(\
bool (*fn)(const t_pid *), bool *result); t_vec_pid *vec, bool (*fn)(const t_pid *), bool *result);
/// @brief Run the function on every element of the vec_pid and returns /// @brief Run the function on every element of the vec_pid and returns
/// if any element returned true /// if any element returned true
@ -120,55 +122,59 @@ t_error vec_pid_all(t_vec_pid *vec,
/// @param[out] result The result of the operation /// @param[out] result The result of the operation
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
/// @note If the vec_pid is empty, result will be false /// @note If the vec_pid is empty, result will be false
t_error vec_pid_any(t_vec_pid *vec, t_error vec_pid_any(\
bool (*fn)(const t_pid *), bool *result); t_vec_pid *vec, bool (*fn)(const t_pid *), bool *result);
/// @brief Run the function on every element of the vec_pid /// @brief Run the function on every element of the vec_pid
/// @param vec The vec_pid to iterate over /// @param vec The vec_pid to iterate over
/// @param fn The function to run on each element /// @param fn The function to run on each element
/// @param state The state to pass to the function /// @param state The state to pass to the function
void vec_pid_iter(t_vec_pid *vec, void vec_pid_iter(\
void (*fn)(t_usize index, t_pid *value, t_vec_pid *vec, void (*fn)(\
void *state), t_usize index, t_pid *value, void *state), void *state);
void *state);
/// @brief Reverse the order of the elements in the vec_pid /// @brief Reverse the order of the elements in the vec_pid
/// @param vec The vec_pid to reverse /// @param vec The vec_pid to reverse
void vec_pid_reverse(t_vec_pid *vec); void vec_pid_reverse(\
t_vec_pid *vec);
/// @brief Sort the elements of the vec_pid /// @brief Sort the elements of the vec_pid
/// @param vec The vec_pid to sort /// @param vec The vec_pid to sort
/// @param is_sorted The function to use to compare the elements /// @param is_sorted The function to use to compare the elements
void vec_pid_sort(t_vec_pid *vec, void vec_pid_sort(\
t_vec_pid_sort_fn is_sorted); t_vec_pid *vec, t_vec_pid_sort_fn is_sorted);
/// @brief Get a pointer to the last element of the vec_pid /// @brief Get a pointer to the last element of the vec_pid
/// @param vec The vec_pid to get the element from /// @param vec The vec_pid to get the element from
/// @param[out] out A pointer to the last element of the vec_pid /// @param[out] out A pointer to the last element of the vec_pid
/// @return true if the operation failed, false otherwise /// @return true if the operation failed, false otherwise
t_error vec_pid_back(t_vec_pid *vec, t_pid **out); t_error vec_pid_back(\
t_vec_pid *vec, t_pid **out);
/// @brief Get a pointer to the i'th element, or NULL otherwise /// @brief Get a pointer to the i'th element, or NULL otherwise
/// @param vec The vec_pid to get the element from /// @param vec The vec_pid to get the element from
/// @return A pointer to the element or NULL /// @return A pointer to the element or NULL
t_pid *vec_pid_get(t_vec_pid *vec, t_usize i); t_pid *vec_pid_get(\
t_vec_pid *vec, t_usize i);
/// @brief Get a pointer to the last element, or NULL otherwise /// @brief Get a pointer to the last element, or NULL otherwise
/// @param vec The vec_pid to get the element from /// @param vec The vec_pid to get the element from
/// @return A pointer to the last element or NULL /// @return A pointer to the last element or NULL
t_pid *vec_pid_last(t_vec_pid *vec); t_pid *vec_pid_last(\
t_vec_pid *vec);
/// @brief Perform a simple bytewise copy into the other vector /// @brief Perform a simple bytewise copy into the other vector
/// @param vec The vec_pid to be copied from /// @param vec The vec_pid to be copied from
/// @param dest The vec_pid to be copied to /// @param dest The vec_pid to be copied to
void vec_pid_copy_into(t_vec_pid *vec, t_vec_pid *dest); void vec_pid_copy_into(\
t_vec_pid *vec, t_vec_pid *dest);
/// read code lol /// read code lol
void vec_pid_splice(t_vec_pid *self, void vec_pid_splice(\
struct s_vec_pid_splice_arguments args); t_vec_pid *self, struct s_vec_pid_splice_arguments args);
struct s_vec_pid_splice_arguments vec_pid_splice_args( struct s_vec_pid_splice_arguments vec_pid_splice_args( \
t_usize index, t_usize old_count, t_usize new_count, t_usize index, t_usize old_count, t_usize new_count, \
const t_pid *elements); const t_pid *elements);
#endif #endif