https://github.com/hubtou/pylists4c

Python-style lists for the C language
https://github.com/hubtou/pylists4c
c data-structures dll library linked-list linked-lists linkedlist list lists lists-python pylists4c python queue queues shared-library stack stacks tree tree-structure trees
Last synced: about 1 month ago
JSON representation
Python-style lists for the C language
Host: GitHub
URL: https://github.com/hubtou/pylists4c
Owner: HubTou
License: bsd-3-clause
Created: 2022-08-05T20:10:11.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-04-06T20:06:03.000Z (about 3 years ago)
Last Synced: 2025-11-07T12:06:03.926Z (7 months ago)
Topics: c, data-structures, dll, library, linked-list, linked-lists, linkedlist, list, lists, lists-python, pylists4c, python, queue, queues, shared-library, stack, stacks, tree, tree-structure, trees
Language: C
Homepage:
Size: 451 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: License
- Security: security/RATS_2.4_on_version_1.0.0.md
Awesome Lists containing this project

README

          ![alt text](https://github.com/HubTou/PyLists4C/blob/main/logo/pylists4c-logo.png "PyLists4C: Python-style lists for the C language")

# PyLists4C: Python-style lists for the C language

## Features

This library provides a [Python-style](https://docs.python.org/3/tutorial/datastructures.html) (within the limits of the C language syntax of course) [lists](https://en.wikipedia.org/wiki/List_(abstract_data_type)) implementation, as doubly-[linked lists](https://en.wikipedia.org/wiki/Linked_list):

* List items are ordered, changeable, and allow duplicate values.

* List items can be of any standard C data type, plus:

  * strings,

  * sub-lists (thus enabling [trees](https://en.wikipedia.org/wiki/Tree_(data_structure)) data structures)

  * and self-contained (= without pointers) structs of variable sizes.

* A list can contain different data types at the same time.

Beyond Python lists emulation, you'll also find:

* List initialization with a powerful constructor or from C language tables

* Conversion from or to [arrays](https://en.wikipedia.org/wiki/Array_(data_structure))

* List deduplication, sorted insertion (with optional removal of duplicate values) or shuffling

* List joining (beyond concatenation or extension) or splitting

* [Stacks](https://en.wikipedia.org/wiki/Stack_(abstract_data_type)) (push/pop) and [queues](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)) (enqueue/dequeue) management aliases

* Statistics and debugging, including memory allocation followup

With:

* Over 60 base functions,

* Plus over 320 convenience type-oriented functions and intuitive aliases,

* High modularity so your linker only includes what you use in your own executables,

* Identical behavior across Unix-like and Windows operating systems for your programs portability,

* Extensive [documentation](DOC.md) with examples for almost everything,

* And friendly [BSD license](License), for open and free usage.

## Base functions overview

Base function | Aliases | Description

--- | --- | ---

**Creating a list**||

[LIST](DOC.md#list-type)* MyList = NULL;||Creates an empty [LIST](DOC.md#list-type)

[listCreateElement()](DOC.md#listcreateelement)||Creates an unlinked LIST element (rather for internal use)

[list()](DOC.md#list)||Creates a LIST from a [Python-style LIST declaration string](DOC.md#list)

[listFromTable()](DOC.md#listfromtable)||Converts a C language table into a LIST

**Adding & changing elements**||

[listAppend()](DOC.md#listappend)|[listPush()](DOC.md#listpush)
[listEnqueue()](DOC.md#listenqueue)|Adds an element at the end of a LIST

[listInsertFirst()](DOC.md#listinsertfirst)|[listPrepend()](DOC.md#listprepend)|Adds an element at the start of a LIST

[listInsert(n)](DOC.md#listinsertn)||Inserts an element at the Nth position of a LIST

[listInsertSorted()](DOC.md#listinsertsorted)||Inserts an element in a sorted LIST

[listInsertList(n)](DOC.md#listinsertlistn)||Inserts a copy of the elements of a LIST at the Nth position of another LIST

[listChange(n)](DOC.md#listchangen)||Changes the value of the element at the Nth position of a LIST

[listChangeSlice(n, m)](DOC.md#listchangeslicen-m)||Changes the elements at the defined LIST [slice](https://docs.python.org/3/library/stdtypes.html#typesseq) with those from the second LIST

**Displaying lists**||

[listStr()](DOC.md#liststr)|[listAscii()](DOC.md#listascii)
[listRepr()](DOC.md#listrepr)|Returns a pointer to a string containing a [Python-style LIST representation](DOC.md#displaying-lists)

[listFreeStr()](DOC.md#listfreestr)||Frees the memory allocated to a [Python-style LIST representation](DOC.md#displaying-lists)

[listPrint()](DOC.md#listprint)||Prints a [Python-style LIST representation](DOC.md#displaying-lists) to [stdout](https://en.wikipedia.org/wiki/Standard_streams#Standard_output_(stdout))

[listDebug()](DOC.md#listdebug)||Prints all LIST details to [stderr](https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr))

**Getting list information**||

[listLen()](DOC.md#listlen)||Returns the number of elements in a LIST

[listStats()](DOC.md#liststats)||Fills statistics about a LIST in one walkthrough

[listStatsPrint()](DOC.md#liststatsprint)||Prints statistics about a LIST to [stdout](https://en.wikipedia.org/wiki/Standard_streams#Standard_output_(stdout))

**Searching for elements**||

[listContains()](DOC.md#listcontains)||Tests if a value appears in a LIST

[listCount()](DOC.md#listcount)||Returns the number of elements with the specified value

[listIndex()](DOC.md#listindex)||Returns the index of the first element with the specified value

[listIndexAll()](DOC.md#listindexall)|[listFind()](DOC.md#listfind)
[listSearch()](DOC.md#listsearch)|Returns a LIST of all the indexes of the elements with the specified value

**Working with numerical lists**||

[listMaxXXX()](DOC.md#listmaxxxx)||Returns the maximum value in the LIST for the XXX type

[listMinXXX()](DOC.md#listminxxx)||Returns the minimum value in the LIST for the XXX type

[listSumXXX()](DOC.md#listsumxxx)||Returns the sum of values in the LIST for the XXX type

**Fetching elements**||

[listGet(n)](DOC.md#listgetn)||Returns the Nth [LIST_ELEMENT](DOC.md#list_element-type) of a LIST

[listGetLast()](DOC.md#listgetlast)||Returns the last LIST_ELEMENT of a LIST

[listSetIterator()](DOC.md#listsetiterator)||Defines a [LIST_ITERATOR](DOC.md#list_iterator-type) from a LIST_ELEMENT of a LIST

[listNext()](DOC.md#listnext)||Returns the next LIST_ELEMENT of a LIST starting from a LIST_ITERATOR

[listPrevious()](DOC.md#listprevious)||Returns the previous LIST_ELEMENT of a LIST starting from a LIST_ITERATOR

**Fetching elements values**||

[listValueXXX()](DOC.md#listvaluexxx)||Returns the element value in the requested type

**Testing lists**||

[listAreEqual()](DOC.md#listareequal)||Tests if two LISTs contain the same values

**Working with lists**||

[listCopy()](DOC.md#listcopy)||Returns a copy of the LIST (a full/deep copy as we don't want multiple references to the same values)

[listSlice(n, m)](DOC.md#listslicen-m)
[listSliceFrom(n)](DOC.md#listslicefromn)
[listSliceTo(m)](DOC.md#listslicetom)||Returns a copy of a [slice](https://docs.python.org/3/library/stdtypes.html#typesseq) (i.e.: [n:m]) of a LIST

[listFilter()](DOC.md#listfilter)||Returns a filtered copy of the LIST according to a user defined function telling if a LIST_ELEMENT should be included or not

[listComprehension()](DOC.md#listcomprehension)|[listForEach()](DOC.md#listforeach)|Returns a new LIST according to a user defined function producing 0-N elements for each LIST_ELEMENT

[listConcat()](DOC.md#listconcat)||Returns a new LIST with the concatenation of the elements of LIST1 and LIST2

[listExtend()](DOC.md#listextend)||Adds a copy of the elements of the second LIST to the end of the first one

[listJoin()](DOC.md#listjoin)||Moves the elements of the second LIST to the end of the first one

[listSplit(n)](DOC.md#listsplitn)|[listHalve()](DOC.md#listhalve) for n = length/2|Cuts a LIST in two parts and returns a pointer to the second part

**Changing list order**||

[listSort()](DOC.md#listsort)||Sorts a LIST

[listSorted()](DOC.md#listsorted)||Returns a sorted copy of a LIST

[listSetDefaultSort()](DOC.md#listsetdefaultsort)||Sets the default sorting algorithm

[listSortedByInsertion()](DOC.md#listsortedbyinsertion)||Returns a sorted copy of a LIST, using an [insertion sort](DOC.md#listinsertsorted) algorithm

[listSortedByQsort()](DOC.md#listsortedbyqsort)||Returns a sorted copy of a LIST, using a [Quicksort](https://en.wikipedia.org/wiki/Quicksort) algorithm

[listReverse()](DOC.md#listreverse)||Reverses the order of a LIST

[listReversed()](DOC.md#listreversed)||Returns a reversed copy of a LIST

[listShuffle()](DOC.md#listshuffle)||Shuffles a LIST

[listShuffled()](DOC.md#listshuffled)||Returns a shuffled copy of a LIST

**Lists to arrays conversion**||

[listToArray()](DOC.md#listtoarray)||Converts a LIST into an [ARRAY](DOC.md#array-type)

[listFromArray()](DOC.md#listfromarray)||Converts an ARRAY into a LIST

[listFreeArray()](DOC.md#listfreearray)||Frees the memory allocated to an ARRAY

**Removing elements**||

[listDelNth(n)](DOC.md#listdelnthn)|[listDelFirst()](DOC.md#listdelfirst) for n=0
[listDelLast()](DOC.md#listdellast) for n=-1|Removes the element at the specified position

[listDelSlice(n, m)](DOC.md#listdelslicen-m)||Removes the elements at the specified [slice](https://docs.python.org/3/library/stdtypes.html#typesseq)

[listPopNth(n)](DOC.md#listpopnthn)|[listPopFirst()](doc.md#listpopfirst) for n=0
[listDequeue()](DOC.md#listdequeue) for n=0
[listPop()](DOC.md#listpop) for n=-1|Removes the element at the specified position and returns it
(you'll have to free it after use with [listClear()](DOC.md#listclear))

[listRemove()](DOC.md#listremove)||Removes the first item with the specified value

[listRemoveAll()](DOC.md#listremoveall)||Removes all the items with the specified value

[listRemoveDuplicates()](DOC.md#listremoveduplicates)||Removes adjacent duplicate items in a sorted LIST

**Clearing lists**||

[listClear()](DOC.md#listclear)|[listDel()](DOC.md#listdel)
[listFree()](DOC.md#listfree)|Removes all the elements of the LIST

**Structs handling**||

[listSetStructSize()](DOC.md#listsetstructsize)||Sets the size of a STRUCT you want to compare

[listSetStructComparator()](DOC.md#listsetstructcomparator)||Sets the function to be used to compare STRUCTs

[listSetStructStringer()](DOC.md#listsetstructstringer)||Sets the function to be used to string STRUCTs

[listSetStructPrinter()](DOC.md#listsetstructprinter)||Sets the function to be used to print STRUCTs to [stdout](https://en.wikipedia.org/wiki/Standard_streams#Standard_output_(stdout))

[listSetStructDebugger()](DOC.md#listsetstructdebugger)||Sets the function to be used to debug STRUCTs to [stderr](https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr))

**Miscellaneous**||

[listSetDebugMessagesDisplay()](DOC.md#listsetdebugmessagesdisplay)||Sets whether or not to print debugging messages to [stderr](https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr))

[listSetFatalMallocErrors()](DOC.md#listsetfatalmallocerrors)||Sets whether memory allocation errors are fatal or not

[listGetAllocatedMemory()](DOC.md#listgetallocatedmemory)||Returns the quantity of allocated/unfreed memory used by this library

## Where to go from here?

Interested? Then go to the [documentation](DOC.md) to learn more about this library and find multiple [examples](tests/).

Still missing something? Then go to the [discussions](https://github.com/HubTou/PyLists4C/discussions) and tell me!

Encountering an issue? Then report it in the [issues](https://github.com/HubTou/PyLists4C/issues) section.

Happy with it? Then please help me promote this library.

* Go, tell it on the mountain(s), over the hills and everywhere!

* If your code is also on GitHub, reference and co-promote your own creations with the [pylists4c](https://github.com/topics/pylists4c) topic 

Volunteering to contribute? Then check our [evolution ideas](TODO.md). For example:

* Make a package for your favourite operating system

* Translate the [documentation](DOC.md)

* Help with missing features and evolution ideas

* ...
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/hubtou/pylists4c

Awesome Lists containing this project

README
