Libft - 42AD
@nickdotht and adjusted accordingly
READ ME TAKEN FROMImplementation of some of the Standard C Library functions.
TOC
- What is libft?
- What's in it?
- How does it work?
- How do I test it? How do I test my own implementations?
What is libft?
Libft is an individual project at 42 that requires us to re-create some standard C library functions including some additional ones that can be used later to build a library of useful functions for the rest of the program.
Disclaimer: Reinventing the wheel is bad, 42 makes us do this just so we can have a deeper understanding of data structures and basic algorithms. At 42 we're not allowed to use some standard libraries on our projects, so we have to keep growing this library with our own functions as we go farther in the program.
What's in it?
As you can see from the Project instructions, there are 3 sections:
- Libc Functions: Some of the standard C functions
- Additional functions: Functions 42 deems will be useful for later projects
- Bonus Functions: Functions 42 deems will be useful for linked list manipulation
Libc functions | Additional functions | Bonus Functions |
---|---|---|
memset | ft_memalloc | ft_lstnew |
bzero | ft_memdel | ft_lstdelone |
memcpy | ft_strnew | ft_lstadd_front |
memccpy | ft_strdel | ft_lstadd_back |
memmove | ft_striteri | ft_lstiter |
memchr | ft_strmapi | ft_lstmap |
memcmp | ft_strjoin | |
strlen | ft_strtrim | |
strdup | ft_itoa | |
strcpy | ft_putchar_fd | |
strncpy | ft_putstr_fd | |
strcat | ft_putendl_fd | |
strlcat | ft_putnbr_fd | |
strchr | ||
strrchr | ||
strstr | ||
strnstr | ||
strcmp | ||
strncmp | ||
atoi | ||
isalpha | ||
isdigit | ||
isalnum | ||
isascii | ||
isprint | ||
toupper | ||
tolower |
Notes:
- The project instructions require that we put all the source files in the root directory
My code passed all the 42 tests successfully (even the bonus functions).
How does it work?
The goal is to create a library called libft.a from the source files so I can later use that library from other projects at 42.
To create that library, after downloading/cloning this project, cd into the project then call make:
git clone https://github.com/AdamJeddy/Libft
cd libft
make
You should see a libft.a file and some object files (.o).
Now to clean up (removing the .o files and the .c files from the root), call make clean
How do I test it? How do I test my own implementations?
To test the code we're going to be using @alelievr's Libft Unit Test. There are some good others but I'll only be covering this one.
1. To test the code in this repo
-
Clone this repo and cd into it, make sure it's called
libft
:git clone https://github.com/AdamJeddy/Libft cd libft/
-
Copy all the source files to the root directory:
make copy
-
Run Make so you can build the library:
make
-
Go back to the root directory and download @alelievr's Libft Unit Test:
cd .. git clone https://github.com/alelievr/libft-unit-test
-
Go into the test folder and run the test:
cd libft-unit-test/ make f
If you did everything correctly you should get a cool list of tests showing you the function names and if they passed or not.
2. To test your own code
You might want to have a go at this project too. If you've never heard of Makefiles, don't worry, you don't have to learn about it now. So go ahead and follow those steps:
-
Create a directory for your project, make sure you call it
libft
:mkdir libft
-
Clone this repo (don't name it libft) and copy the Makefile-sample as Makefile and libft.h to your own project:
git clone https://github.com/AdamJeddy/Libft r4-libft cp r4-libft/Makefile-sample libft/Makefile cp r4-libft/libft.h libft/
-
Go to your project, read the instructions for the function you want to create, code it and uncomment it from the Makefile:
cd libft vim ft_memset.c vim Makefile
As an example, after creating ft_memset as your first function, you go into the Makefile, remove the
#
in front ofFILES
, remove the\
at the end offt_memset
and add a#
in front offt_bzero
.If it still looks complicated, DON'T PANIC, just ask me :)
-
Run Make so you can build the library:
make
-
Go back to the root directory and download @alelievr's Libft Unit Test:
cd .. git clone https://github.com/alelievr/libft-unit-test
-
Go into the test folder and run the test:
cd libft-unit-test/ make f
That's it! If you're having some problems, just send me a tweet. If you think your problem is due to my code or this README, create a new issue. I'll definitely check it out.
Enjoy.