libft | 42 Madrid

Your very own first library :smile:

<div align="center"> <img src=https://user-images.githubusercontent.com/40824677/149224482-9a5f469c-4748-4dcb-8321-8eafd9a44715.png /> </div>

Table of Contents

• Introduction
• Function Overview
• Bonus
• Additional Functions
• Installation
• Summary

Introduction

In this project we'll be implementing our home-made functions from libc, which will be very useful to get familiar with memory allocation, and to think of creative ways to code these functions.

Function Overview

| Function | Description | | :------: | :---------: | | ft_atoi | Reads a String, and, after ignoring spaces with ft_isspace, saves the string into an integer | | ft_bzero | Writes n zeroes to the string s | | ft_calloc | Reserves x blocks of y bits of memory | | ft_isalnum | Returns 1 if the input is a number or a letter in the ASCII table | | ft_isalpha | Returns 1 if the input is a letter in the ASCII table | | ft_isascii | Returns whether or not a value belongs to the ASCII table | | ft_isdigit | Returns 1 if the input is a number in the ASCII table | | ft_isprint | Returns whether a character is printable | | ft_itoa | Saves the given number as a string (char array) | | ft_memccpy | Copies from one memory point to another, until the specified character is copied or until n bytes are copied | | ft_memchr | Looks for a matching character inside a part of the memory | | ft_memcmp | Compares two parts of memory, returning 0 if they're the same, or else a nonzero value | | ft_memcpy | Copies from one part of memory to another, ignoring possible overlaps | | ft_memmove | Copies from one part of memory to another, preventing possible overlaps | | ft_memset | Assigns a character n times to a part of the memory | | ft_putchar_fd | Prints a character to the given file descriptor | | ft_putendl_fd | Prints a string followed by a new line \n to a given file descriptor | | ft_putnbr_fd | Prints number to the given file descriptor | | ft_putstr_fd | Prints string to the given file descriptor | | ft_split | Splits a string according to a given separator character | | ft_strchr | Looks for a specific character inside a given string | | ft_strdup | Saves enoug space and duplicates a string | | ft_strjoin | Concatenates two strings allocating enough space first | | ft_strlcat | Concatenates two strings ensuring it ends with \0 | | ft_strlcpy | Copies n - 1 bytes from a source string to a destination string | | ft_strlen | Returns length of a string | | ft_strmapi | Applies a function (mapping) to every element in a string | | ft_strncmp | Compares two strings up to the n-th character | | ft_strnstr | Tries to find a substring (needle) in a second string (haystack) before the n-th char is reached | | ft_strrchr | Looks for a given character in a string, reading it from back to front | | ft_strtrim | Removes occurrences of characters in a string from the start and end of another one | | ft_substr | Copies from the n-th char of a string | | ft_tolower | Makes every uppercase character in a string lowercase | | ft_toupper | Makes every lowercase character in a string uppercase |

Bonus

For this part we implemented a struct defining the well-known linked lists

typedef	struct	s_list
{
	void		*content;
	struct	s_list	*next;
}			t_list;

Bonus functions to implement

| Bonus Function | Description | | :------------: | :---------: | | ft_lstnew | Creates new node allocating with malloc | | ft_lstadd_front | Adds new node at the beginning of the linked list | | ft_lstsize | Returns number of elements of linked list | | ft_lstlast | Retrieves last node of the list | | ft_lstadd_back | Adds new node at the end of the linked list | | ft_lstdelone | Deletes, frees, and applies function del to content of a given node | | ft_lstclear | Deletes a given element and every element after that | | ft_lstiter | Applies a function to the content of every node of the linked list | | ft_lstmap | Applies function to a copy of the list, freeing when necessary | | ft_lstget_at | [EXTRA] Retrieves linked list node at idex i, or NULL|

Additional Functions

Besides mandatory and bonus functions, I also have a set of functions inside the srca/ folder. These functions are not part of the libft subject but they will be useful in future projects. You can check their description in the libft.h file

Installation

To test this library out, it's recommended that you have the following packages installed

gcc clang make python-norminette valgrind (linux)

Clone the repository

git clone https://gitlab.com/madebypixel02/libft.git
cd libft
make

• Usage:

The makefile compiles all files from the src/, srcb/ or srca/ folders and saves the object files to the obj/, objb/ and obja/ folders. It then generates the output file libft.a inside the bin/ folder. Here are some of the commands you can try:

make all		Compiles the libft.a file
make bonus		Compiles all bonus files instead of the mandatory ones
make norminette		Checks Norm for all .c and .h files in the libft/ folder	

Summary

Really enjoyed this first project, can't wait for the next one :wink:

May 4th, 2021