PythonList

PythonList is a concise library that written in pure C language in order to replicate literally the list data structure in the Python programming language. This library targeting those who are familiar with Python syntax and want to experience the same type of data structure in Python while coding C.

Acknowledgements

Since the syntax of the replicated list aren't perfectly identical to the Python language,
there isn't any prerequisites to use the library. However, it's encouraged to have the basic
knowledge of general C concepts inorder to expand this library:

• What are pointer
• Python List Data Structure

    Syntax of the library will be clarified in the API Reference

• Go to API Reference

Authors

• @gugugiyu

Features

• Replication of Python List in C with integrated function featuring:

- Initilization
- Searching with index or data
- Insertion
- Deletion
- Integrated print function
- Reversal
- Auto-type detect using generic selection
- Sorting

Structure defined

List

This is the main list used for storing. Defined this list in the following syntax:

list *my_list_name = NULL;

Note: the upper list must be initialized to be NULL

typedef struct list{
    struct l_elem*    root;
    size_t                  size;
}list;

Data

The specific data type used for storing values. Defined either through parseData function or manually:

Manually example:

data \*my_data_name = (data\*)malloc(sizeof(data));//Allocating memory with malloc

my_data_name->data = pointer_to_data; //Set the data

my_data_name->size = size_in_bytes;//Set the size

my_data_name->mode = defined macros; //Set the mode (datatype) of this data

Using parseData() function example:

data \*my_data_name = (data\*)malloc(sizeof(data));

data = parseData(size_int_bytes, pointer_to_data, defined_macros);** //Built in parse function

Calling auto-detect macro:

data* my_data_name = (data*)malloc(sizeof(data));
int   some_number  = 10;

data = dataOf(&some_number); //If the value is rvalue
data = dataOf_l(10L);        //If the value is lvalue (literal)

The structure data is defined as follow:

typedef struct data{
    void*                   data; //Pointer to the data
    size_t                  size; //Size of the data
    int                     mode; //Mode to know the type of the data
}data;

l_elem

The replication of nodes inside this list, it's not encouraged to declare this out as an variable or pointer, as the usages are internal

typedef struct l_elem{
    void*                   data;
    size_t                  size;
    int                     mode;
    struct l_elem*          next;  
}l_elem;

Defined macro

Initialize a list

void makeList(list ** list, ...);

Parameter	Type	Description
list	list**	Required. The given list to be initialize
...	undefined	The variadic parameters

Note: The ... parameter must be ended with macro '__ MAKE_END'

The makeList() function will initialize the list with multiple input, the ... will contains only the data* type, which can be retrieve by explicitly calling the parseData() function or using the (BETA) feature of auto detect: dataOf() or dataOf_l()

Adding an element

All defined macro will invoke the static function 'addIndex'

MACRO: append(list, type)

Parameter	Type	Description
list	list**	Required. The given list to be initialize
type	data*	Required. The given data structure (must be initialized)

This macro will add a new l_elem node to the end of the list

MACRO: head(list, type)

Parameter	Type	Description
list	list**	Required. The given list to be initialize
type	data*	Required. The given data structure (must be initialized)

This macro will add a new l_elem node to the start of the list

MACRO: insert(list, type)

Parameter	Type	Description
list	list**	Required. The given list to be initialize
type	data*	Required. The given data structure (must be initialized)

This macro will add a new l_elem node to a given index of the list

Searching with Data

All defined macro will invoke the static function 'findData'

MACRO: index(list, type)

Parameter	Type	Description
list	list**	Required. The given list to be initialize
type	data*	Required. The given data structure (must be initialized)

This macro will return the index of the given data, if error, the macro will return 1

MACRO: indexOffset(list, type, offset)

Parameter	Type	Description
list	list**	Required. The given list to be initialize
type	data*	Required. The given data structure (must be initialized)
offset	int	Required. The given offset to be searched

This macro will return the index of the given data from range of [offset...n]