nz-nz / libft Goto Github PK

Prototype | char* ft_strmapi(charconst*s,char (*f)(unsigned int, char));
Description | Applies the function f to each character of the string passed as argument by giving its index as first argument to create a “fresh” new string (with malloc(3)) resulting from the suc- cessive applications of f.
Param. #1 | The string to map.
Param. #2 | The function to apply to each character of s and its index.
Return value | The “fresh” string created from the successive applications of f.
Libc functions | malloc(3)

Prototype | char** ft_strsplit(charconsts,charc);
Description | Allocates (with malloc(3)) and returns an array of “fresh” strings (all ending with ’\0’, including the array itself) ob- tained by spliting s using the character c as a delimiter. If the allocation fails the function returns NULL. Example : ft_strsplit("hellofellowstudents", ’’) re- turns the array ["hello", "fellow", "students"].
Param. #1 | The string to split.
Param. #2 | The delimiter character.
Return value | The array of “fresh” strings result of the split.
Libc functions | malloc(3), free(3)

Prototype | void ft_memdel(void**ap);
Description | Takes as a parameter the address of a memory area that needs to be freed with free(3), then puts the pointer to NULL.
Param. #1 | A pointer’s address that needs its memory freed and set to NULL.
Return value | None.
Libc functions | free(3).

Prototype | int ft_strnequ(charconsts1,charconsts2, size_t n);
Description | Lexicographical comparison between s1 and s2 up to n char- acters or until a ’\0’ is reached. If the 2 strings are identical, the function returns 1, or 0 otherwise.
Param. #1 | The first string to be compared.
Param. #2 | The second string to be compared.
Param. #3 | The maximum number of characters to be compared.
Return value | 1 or 0 according to if the 2 strings are identical or not.
Libc functions | None.

Prototype | void ft_putchar_fd(charc,intfd);
Description | Outputs the char c to the file descriptor fd.
Param. #1 | The character to output.
Param. #2 | The file descriptor.
Return value | None.
Libc functions | write(2).

Prototype | void ft_strdel(char**as);
Description | Takes as a parameter the address of a string that need to be freed with free(3), then sets its pointer to NULL.
Param. #1 | The string’s address that needs to be freed and its pointer set to NULL.
Return value | None.
Libc functions | Free(3).

Prototype | char* ft_strmap(charconst*s,char(*f)(char));
Description | Applies the function f to each character of the string given as argument to create a “fresh” new string (with malloc(3)) resulting from the successive applications of f.
Param. #1 | The string to map.
Param. #2 | The function to apply to each character of s.
Return value | The “fresh” string created from the successive applications of f.
Libc functions | malloc(3)

Prototype | int ft_strequ(charconsts1,charconsts2);
Description | Lexicographical comparison between s1 and s2. If the 2 strings are identical the function returns 1, or 0 otherwise.
Param. #1 | The first string to be compared.
Param. #2 | The second string to be compared.
Return value | 1 or 0 according to if the 2 strings are identical or not.
Libc functions | None.

Prototype | void ft_putendl_fd(charconst*s,intfd);
Description | Outputs the string s to the file descriptor fd followed by a ’\n’.
Param. #1 | The string to output.
Param. #2 | The file descriptor.
Return value | None.
Libc functions | write(2).

Prototype | char* ft_strsub(charconst*s,unsignedint start, size_t len);
Description | Allocates (with malloc(3)) and returns a “fresh” substring from the string given as argument. The substring begins at indexstart and is of size len. If start and len aren’t refer- ing to a valid substring, the behavior is undefined. If the allocation fails, the function returns NULL.
Param. #1 | The string from which create the substring.
Param. #2 | The start index of the substring.
Param. #3 | The size of the substring.
Return value | The substring.
Libc functions | malloc(3)

Prototype | char* ft_strnew(size_tsize);
Description | Allocates (with malloc(3)) and returns a “fresh” string end- ing with ’\0’. Each character of the string is initialized at ’\0’. If the allocation fails the function returns NULL.
Param. #1 | The size of the string to be allocated.
Return value | The string allocated and initialized to 0.
Libc functions | malloc(3)

Prototype | void ft_putstr_fd(charconst*s,intfd);
Description | Outputs the string s to the file descriptor fd.
Param. #1 | The string to output.
Param. #2 | The file descriptor.
Return value | None.
Libc functions | write(2).

Prototype | void ft_putnbr(intn);
Description | Outputs the integer n to the standard output.
Param. #1 | The integer to output.
Return value | None.
Libc functions | write(2).

Prototype | void ft_putchar(charc);
Description | Outputs the character c to the standard output.
Param. #1 | The character to output.
Return value | None.
Libc functions | write(2).

Prototype | char* ft_strtrim(charconst*s);
Description | Allocates (with malloc(3)) and returns a copy of the string given as argument without whitespaces at the beginning or at the end of the string. Will be considered as whitespaces the following characters ’ ’, ’\n’ and ’\t’. If s has no whites- paces at the beginning or at the end, the function returns a copy of s. If the allocation fails the function returns NULL.
Param. #1 | The string to be trimed.
Return value | The “fresh” trimmed string or a copy of s.
Libc functions | malloc(3)

Prototype | void ft_putendl(charconst*s);
Description | Outputs the string s to the standard output followed by a ’\n’.
Param. #1 | The string to output.
Return value | None.
Libc functions | write(2).

Prototype | char* ft_itoa(intn);
Description | Allocate (with malloc(3)) and returns a “fresh” string end- ing with ’\0’ representing the integer n given as argument. Negative numbers must be supported. If the allocation fails, the function returns NULL.
Param. #1 | The integer to be transformed into a string.
Return value | The string representing the integer passed as argument.
Libc functions | malloc(3)

Prototype | void ft_strclr(char*s);
Description | Sets every character of the string to the value ’\0’.
Param. #1 | The string that needs to be cleared.
Return value | None.
Libc functions | None.

Prototype | void ft_putnbr_fd(intn,intfd);
Description | Outputs the integer n to the file descriptor fd.
Param. #1 | The integer to print.
Param. #2 | The file descriptor.
Return value | None.
Libc functions | write(2).

Prototype | void ft_putstr(charconst*s);
Description | Outputs the string s to the standard output.
Param. #1 | The string to output.
Return value | None.
Libc functions | write(2).

Prototype | void* ft_memalloc(size_tsize);
Description | Allocates (with malloc(3)) and returns a “fresh” memory area. The memory allocated is initialized to 0. If the alloca- tion fails, the function returns NULL.
Param. #1 | The size of the memory that needs to be allocated.
Return value | The allocated memory area.
Libc functions | malloc(3)

Prototype | char* ft_strjoin(charconst*s1,charconst *s2);
Description | Allocates (with malloc(3)) and returns a “fresh” string end- ing with ’\0’, result of the concatenation of s1 and s2. If the allocation fails the function returns NULL.
Param. #1 | The prefix string.
Param. #2 | The su x string.
Return value | The “fresh” string result of the concatenation of the 2 strings.
Libc functions | malloc(3)

Prototype | void ft_striter(char*s,void(f)(char));
Description | Applies the function f to each character of the string passed as argument. Each character is passed by address to f to be modified if necessary.
Param. #1 | The string to iterate.
Param. #2 | The function to apply to each character of s.
Return value | None.
Libc functions | None.

Prototype | void ft_striteri(char*s,void(*f)(unsignedint, char *));
Description | Applies the function f to each character of the string passed as argument, and passing its index as first argument. Each character is passed by address to f to be modified if necessary.
Param. #1 | The string to iterate.
Param. #2 | The function to apply to each character of s and its index.
Return value | None.
Libc functions | None.