Libft

◦ Your very first own library

📖 Table of Contents

📖 Table of Contents
📍 Overview
📦 Features
📂 repository Structure
⚙️ Modules
🚀 Getting Started
🛣 Roadmap
🤝 Contributing
📄 License
👏 Acknowledgments

📍 Overview

The Libft project involves creating a C library containing a wide range of general-purpose functions to support your programs. These functions emulate the behavior of standard C library functions but are prefixed with "ft_".

📦 Features

Libc Functions: Reimplementation of standard C library functions with names prefixed by "ft_". ft_isalpha, ft_isdigit, ft_isalnum, ft_isascii, ft_isprint, ft_strlen, ft_memset, ft_bzero, ft_memcpy, ft_memmove, ft_strlcpy, ft_strlcat, ft_toupper, ft_tolower, ft_strchr, ft_strrchr, ft_strncmp, ft_memchr, ft_memcmp, ft_strnstr, ft_atoi

Additional Functions: Extended functionality for string manipulation. ft_substr, ft_strjoin, ft_strtrim, ft_split, ft_itoa, ft_strmapi, ft_striteri, ft_putchar_fd, ft_putstr_fd, ft_putendl_fd, ft_putnbr_fd

Linked List Functions: Additional functions for working with linked lists. ft_lstnew, ft_lstadd_front, ft_lstsize, ft_lstlast, ft_lstadd_back, ft_lstdelone, ft_lstclear, ft_lstiter, ft_lstmap

📂 Repository Structure

└── Libft/
    ├── Makefile
    ├── ft_atoi.c
    ├── ft_bzero.c
    ├── ft_calloc.c
    ├── ft_isalnum.c
    ├── ft_isalpha.c
    ├── ft_isascii.c
    ├── ft_isdigit.c
    ├── ft_isprint.c
    ├── ft_itoa.c
    ├── ft_lstadd_back_bonus.c
    ├── ft_lstadd_front_bonus.c
    ├── ft_lstclear_bonus.c
    ├── ft_lstdelone_bonus.c
    ├── ft_lstiter_bonus.c
    ├── ft_lstlast_bonus.c
    ├── ft_lstmap_bonus.c
    ├── ft_lstnew_bonus.c
    ├── ft_lstsize_bonus.c
    ├── ft_memchr.c
    ├── ft_memcmp.c
    ├── ft_memcpy.c
    ├── ft_memmove.c
    ├── ft_memset.c
    ├── ft_putchar_fd.c
    ├── ft_putendl_fd.c
    ├── ft_putnbr_fd.c
    ├── ft_putstr_fd.c
    ├── ft_split.c
    ├── ft_strchr.c
    ├── ft_strdup.c
    ├── ft_striteri.c
    ├── ft_strjoin.c
    ├── ft_strlcat.c
    ├── ft_strlcpy.c
    ├── ft_strlen.c
    ├── ft_strmapi.c
    ├── ft_strncmp.c
    ├── ft_strnstr.c
    ├── ft_strrchr.c
    ├── ft_strtrim.c
    ├── ft_substr.c
    ├── ft_tolower.c
    ├── ft_toupper.c
    └── libft.h

⚙️ Modules

Root

File	Summary
libft.h	Header file with function prototypes
Makefile	Makefile for compiling the library

Libc functions

File	Summary
ft_toupper.c	Convert character to uppercase
ft_tolower.c	Convert character to uppercase
ft_strrchr.c	Locate character in string from the end
ft_strnstr.c	Locate substring in string
ft_strncmp.c	Compare two strings up to a specified number of characters
ft_strlen.c	Calculate the length of a string
ft_strlcpy.c	Copy a string to a specified size
ft_strlcat.c	Concatenate strings with a specified size
ft_strdup.c	Duplicate a string with malloc
ft_strchr.c	Locate character in string
ft_memset.c	Fill memory with a constant byte
ft_memmove.c	Copy memory area
ft_memcpy.c	Copy memory area
ft_memcmp.c	Compare memory areas
ft_memchr.c	Locate byte in byte string
ft_isprint.c	Check if a character is printable
ft_isdigit.c	Check if a character is a digit
ft_isascii.c	Check if a character is an ASCII character
ft_isalpha.c	Check if a character is an alphabet character
ft_isalnum.c	Check if a character is alphanumeric
ft_calloc.c	Allocate and zero-initialize array
ft_bzero.c	Set a byte string to zero
ft_atoi.c	Convert a string to an integer

Additional functions

File	Summary
ft_substr.c	Extract substring from string
ft_strjoin.c	Concatenate two strings
ft_strtrim.c	Trim leading and trailing a character from a string
ft_split.c	Split a string into an array of substrings
ft_itoa.c	Convert an integer to a string
ft_strmapi.c	Apply a function to each character of a string
ft_striteri.c	Apply a function to each character of a string with its index
ft_putstr_fd.c	Output a string to a file descriptor
ft_putnbr_fd.c	Output an integer to a file descriptor
ft_putendl_fd.c	Output a string to a file descriptor, followed by a newline
ft_putchar_fd.c	Output a character to a file descriptor

Bonus

File	Summary
ft_lstsize_bonus.c	Count the number of elements in a list
ft_lstnew_bonus.c	Create a new list element
ft_lstmap_bonus.c	Apply a function to each element of a list and create a new list
ft_lstlast_bonus.c	Return the last element of a list
ft_lstiter_bonus.c	Apply a function to each element of a list
ft_lstdelone_bonus.c	Delete a list element
ft_lstclear_bonus.c	Delete and free a list
ft_lstadd_front_bonus.c	Add a new element at the beginning of the list
ft_lstadd_back_bonus.c	Add a new element at the end of the list

🚀 Getting Started

🔧 Installation

Clone the Libft repository:

git clone https://github.com/San-tito/Libft

Change to the project directory:

cd Libft

Compile the dependencies:

make

🤖 Use Libft

Once the library is successfully compiled, you can use it in your projects. Link the libft.a file to your program, and include the libft.h header in your source files. To compile your program with Libft, use:

gcc -o my_program my_program.c -L . -lft

🧪 Tests

/* Not implemented */

🛣 Roadmap

ℹ️ Implement linked list functions.

ℹ️ Continuous integration for automated testing.

ℹ️ Explore opportunities for optimization.

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Submit Pull Requests: Review open PRs, and submit your own PRs.
Join the Discussions: Share your insights, provide feedback, or ask questions.
Report Issues: Submit bugs found or log feature requests for SAN-TITO.

📄 License

This project is protected under the UNLICENSE License. For more details, refer to the LICENSE file.

👏 Acknowledgments

Return