https://github.com/clementvidon/get_next_line

[documented code / -pedantic -std=c89] - Get the next line of text available on a file descriptor. Can be used within a loop to read a file line by line.
https://github.com/clementvidon/get_next_line

42 42-get-next-line 42-gnl 42born2code 42cursus 42projects 42school cleancode getline getnextline getnextline-42 getnextline42 gnl gnl-42 gnl42 gnlte gnltester tester

Last synced: about 10 hours ago
JSON representation

[documented code / -pedantic -std=c89] - Get the next line of text available on a file descriptor. Can be used within a loop to read a file line by line.

• Host: GitHub
• URL: https://github.com/clementvidon/get_next_line
• Owner: clementvidon
• Created: 2022-08-16T08:59:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-31T12:09:56.000Z (over 2 years ago)
• Last Synced: 2024-10-09T08:08:00.630Z (7 months ago)
• Topics: 42, 42-get-next-line, 42-gnl, 42born2code, 42cursus, 42projects, 42school, cleancode, getline, getnextline, getnextline-42, getnextline42, gnl, gnl-42, gnl42, gnlte, gnltester, tester
• Language: C
• Homepage:
• Size: 2.6 MB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


	GNL - GET_NEXT_LINE 42





	Summary

	 · 

	Usage

	 · 

	Tester

	 · 

	Tools



## Summary

Get the next line of text available on a file descriptor.

Calling get_next_line in a loop will allow us to read the text available on the

file descriptor one line at a time until the end of it.  

> *"May it be a file, stdin, or even later a network connection, you will always

> need a way to read content line by line. It is time to start working on this

> function, which will be essential for your future projects."* - [Subject](https://cdn.intra.42.fr/pdf/pdf/57350/en.subject.pdf)

External functions: `read`, `malloc`, `free`

Code written in accordance with **42 C** coding style,  **ANSI C89** compliant and entirely **documented with docstrings**.

## Usage

Add `get_next_line.h` to your project header to access the function.

To test the function run `make` from within the `test` directory and launch as

follows: `./get_next_line `

For example: `./get_next_line main.c`

## Tester

**First of all** `cd test && make`.

- **[Gnltester](test/gnltester.sh)** check if the number of characters returned by

  `get_next_line` call on multiple pre defined input files with a set of

  different BUFFER_SIZE is correct.  Uses valgrind.

Usage: `make test` or `bash gnltester.sh`

- **[Gnldiff](test/gnldiff.sh)** is a simple tester that check `get_next_line` output accuracy and create

a `diff.log` file if something went wrong.

Usage: `bash gnldiff.sh `

Example:

    cat Makefile > file; bash gnldiff.sh file

    cat ../*.[ch] > file; bash gnldiff.sh file

**Make sure to** use a `BUFFER_SIZE` of 1 if your `` parameter contains

multi byte characters like those from binary file or `/dev/urandom` like:

    cat /bin/cat > file; bash gnldiff.sh file

    head -4242 /dev/urandom > file; bash gnldiff.sh file

- **[gnlTester](https://github.com/Tripouille/gnlTester)**

## Tools

- **[ft_mallocator](https://github.com/tmatis/ft_mallocator)**

*Check with different arguments (ft_mallocator/config.sh:`ARGS`) and buffer size (get_next_line.h:`BUFFER_SIZE`).*

- **valgrind**: `valgrind -q --leak-check=yes --show-leak-kinds=all`

- **sanitizer**: `-fsanitize=address`

*Add `-g` flag when compiling with `-fsanitize=address` to print errors line numbers instead of addresses in hexadecimal.*