Skip to content

Commit a261be3

Browse files
hozlucas28hozlucas28
authored
Merge develop branch into Master branch - Release v1.0.0
2 parents 883a136 + a38b524 commit a261be3

28 files changed

+1213
-75
lines changed

‎.clang-format

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
---
22
BasedOnStyle: Google
3+
ColumnLimit: 100
34
IndentWidth: 4

‎.github/translations/es/README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,17 @@ C-Practical-Work-2024/
9696
│ ├── main.h
9797
│ ├── utilities.c
9898
│ ├── utilities.h
99+
│ ├── validators.c
100+
│ ├── validators.h
99101
| |
100-
│ └── cells/
102+
│ └── patterns/
101103
│ ├── constructors.c
102104
│ ├── constructors.h
105+
│ ├── macros.h
106+
│ ├── main.h
103107
│ ├── methods.c
104-
│ └── methods.h
108+
│ ├── methods.h
109+
│ └── structs.h
105110
|
106111
├── .clang-format
107112
├── .gitignore
@@ -131,13 +136,18 @@ C-Practical-Work-2024/
131136
- **[main.h](./libs/main.h)** - Archivo que indexa todos los archivos `.h` del proyecto.
132137
- **[utilities.c](./libs/utilities.c)** - Archivo con el desarrollo de los prototipos de función presentes en `utilities.h`.
133138
- **[utilities.h](./libs/utilities.h)** - Archivo con las estructuras y los prototipos de función de uso común.
134-
135-
- **[cells](./libs/cells)** - Funciones y estructuras de las entidades `células`.
136-
137-
- **[constructors.c](./libs/cells/constructors.c)** - Archivo con el desarrollo de los prototipos de función presentes en `constructors.h`.
138-
- **[constructors.h](./libs/cells/constructors.h)** - Archivo con las estructuras y los prototipos de función relacionados a la creación de células.
139-
- **[methods.c](./libs/cells/methods.c)** - Archivo con el desarrollo de los prototipos de función presentes en `methods.h`.
140-
- **[methods.h](./libs/cells/methods.h)** - Archivo con los prototipos de función relacionados a los métodos de las células.
139+
- **[validators.c](./libs/validators.c)** - Archivo con el desarrollo de los prototipos de función presentes en `validators.h`.
140+
- **[validators.h](./libs/validators.h)** - Archivo con prototipos de funciones relacionadas con procesos de validación.
141+
142+
- **[patterns](./libs/patterns)** - Funciones y estructuras para crear patrones con células.
143+
144+
- **[constructors.c](./libs/patterns/constructors.c)** - Archivo con el desarrollo de los prototipos de función presentes en `constructors.h`.
145+
- **[constructors.h](./libs/patterns/constructors.h)** - Archivo con las estructuras y los prototipos de función relacionados a la creación de patrones.
146+
- **[macros.h](./libs/macros.h)** - Archivo con macros.
147+
- **[main.h](./libs/main.h)** - Archivo que indexa todos los archivos `.h` dentro de la carpeta `patterns`.
148+
- **[methods.c](./libs/patterns/methods.c)** - Archivo con el desarrollo de los prototipos de función presentes en `methods.h`.
149+
- **[methods.h](./libs/patterns/methods.h)** - Archivo con los prototipos de función relacionados a los métodos de los patrones.
150+
- **[structs.h](./libs/patterns/methods.h)** - Archivo con estructuras.
141151

142152
- **[.clang-format](./.clang-format)** - Archivo de configuración de la herramienta de formateo de código `clang-format`.
143153
- **[.gitignore](./.gitignore)** - Archivo de configuración de Git para evitar el rastreo de archivos no deseados.

‎.github/workflows/format-code-on-pr.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: 'Format code on pull request'
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- Master
7+
- develop
8+
paths:
9+
- '**.c'
10+
- '**.h'
11+
12+
jobs:
13+
clang-format:
14+
name: Format code
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
with:
20+
ref: ${{github.head_ref}}
21+
22+
- name: Install clang-format (formatter tool)
23+
run: sudo apt-get install clang-format
24+
25+
- name: Run clang-format
26+
run: find . -name '*.c' -o -name '*.h' | xargs clang-format -i -style=file
27+
28+
- name: Commit changes
29+
run: |
30+
git config --global user.name 'github-actions[bot]'
31+
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
32+
git add .
33+
git diff-index --quiet HEAD || git commit -m "ci: format code"
34+
35+
- name: Push changes
36+
uses: ad-m/[email protected]
37+
with:
38+
branch: ${{ github.head_ref }}
39+
github_token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/format-code.yml

-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
name: 'Format code'
22

33
on:
4-
pull_request:
5-
branches:
6-
- Master
7-
- develop
8-
paths:
9-
- '**.c'
10-
- '**.h'
114
push:
125
branches:
136
- Master

‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11

2+
# ---------------------------------------------------------------------------- #
3+
# PERSONAL FILES #
4+
# ---------------------------------------------------------------------------- #
5+
6+
personal-*.md
7+
8+
9+
210
# ---------------------------------------------------------------------------- #
311
# CODEBLOCKS #
412
# ---------------------------------------------------------------------------- #

‎.vscode/settings.json

-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
"editor.minimap.renderCharacters": false,
1111
"emojisense.unicodeCompletionsEnabled": false,
1212
"files.associations": {"*.c": "c", "*.h": "c"},
13-
"files.autoSave": "afterDelay",
14-
"files.autoSaveDelay": 1000,
1513
"files.trimTrailingWhitespace": true,
1614
"markdown-preview-github-styles.colorTheme": "dark",
1715
"terminal.integrated.defaultProfile.windows": "Command Prompt",

‎.vscode/tasks.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@
1414
{
1515
"command": [
1616
"(gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\utilities.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\utilities.o\")",
17-
"& (gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\cells\\constructors.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\constructors.o\")",
18-
"& (gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\cells\\methods.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\methods.o\")",
19-
"& (ar -r -s \"${workspaceFolder}\\libs\\bin\\Release\\libs.a\" \"${workspaceFolder}\\libs\\obj\\Release\\constructors.o\" \"${workspaceFolder}\\libs\\obj\\Release\\methods.o\" \"${workspaceFolder}\\libs\\obj\\Release\\utilities.o\")"
17+
"& (gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\validators.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\validators.o\")",
18+
"& (gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\patterns\\constructors.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\constructors.o\")",
19+
"& (gcc -Wall -O2 -pedantic-errors -c \"${workspaceFolder}\\libs\\patterns\\methods.c\" -o \"${workspaceFolder}\\libs\\obj\\Release\\methods.o\")",
20+
"& (ar -r -s \"${workspaceFolder}\\libs\\bin\\Release\\libs.a\" \"${workspaceFolder}\\libs\\obj\\Release\\constructors.o\" \"${workspaceFolder}\\libs\\obj\\Release\\methods.o\" \"${workspaceFolder}\\libs\\obj\\Release\\utilities.o\" \"${workspaceFolder}\\libs\\obj\\Release\\validators.o\")"
2021
],
2122
"group": {"kind": "build", "isDefault": false},
2223
"label": "Compile libs project",

‎README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,17 @@ C-Practical-Work-2024/
9696
│ ├── main.h
9797
│ ├── utilities.c
9898
│ ├── utilities.h
99+
│ ├── validators.c
100+
│ ├── validators.h
99101
| |
100-
│ └── cells/
102+
│ └── patterns/
101103
│ ├── constructors.c
102104
│ ├── constructors.h
105+
│ ├── macros.h
106+
│ ├── main.h
103107
│ ├── methods.c
104-
│ └── methods.h
108+
│ ├── methods.h
109+
│ └── structs.h
105110
|
106111
├── .clang-format
107112
├── .gitignore
@@ -131,13 +136,18 @@ C-Practical-Work-2024/
131136
- **[main.h](./libs/main.h)** - File indexing all `.h` files of the project.
132137
- **[utilities.c](./libs/utilities.c)** - File with the implementation of the function prototypes found in `utilities.h`.
133138
- **[utilities.h](./libs/utilities.h)** - File with common structures and function prototypes.
134-
135-
- **[cells](./libs/cells)** - Functions and structures for `cell` entities.
136-
137-
- **[constructors.c](./libs/cells/constructors.c)** - File with the implementation of the function prototypes found in `constructors.h`.
138-
- **[constructors.h](./libs/cells/constructors.h)** - File with structures and function prototypes related to cell creation.
139-
- **[methods.c](./libs/cells/methods.c)** - File with the implementation of the function prototypes found in `methods.h`.
140-
- **[methods.h](./libs/cells/methods.h)** - File with function prototypes related to cell methods.
139+
- **[validators.c](./libs/validators.c)** - File with the implementation of the function prototypes found in `validators.h`.
140+
- **[validators.h](./libs/validators.h)** - File with functions prototypes related to validation process.
141+
142+
- **[patterns](./libs/patterns)** - Functions and structures for create patterns with cells.
143+
144+
- **[constructors.c](./libs/patterns/constructors.c)** - File with the implementation of the function prototypes found in `constructors.h`.
145+
- **[constructors.h](./libs/patterns/constructors.h)** - File with structures and function prototypes related to patterns creation.
146+
- **[macros.h](./libs/macros.h)** - File with macros.
147+
- **[main.h](./libs/main.h)** - File indexing all `.h` files inside `patterns` folder.
148+
- **[methods.c](./libs/patterns/methods.c)** - File with the implementation of the function prototypes found in `methods.h`.
149+
- **[methods.h](./libs/patterns/methods.h)** - File with function prototypes related to pattern methods.
150+
- **[structs.h](./libs/patterns/methods.h)** - File with structs.
141151

142152
- **[.clang-format](./.clang-format)** - Configuration file for the `clang-format` code formatting tool.
143153
- **[.gitignore](./.gitignore)** - Git configuration file to avoid tracking unwanted files.

‎libs/cells/constructors.c

-2
This file was deleted.

‎libs/cells/constructors.h

-4
This file was deleted.

‎libs/cells/methods.c

-2
This file was deleted.

‎libs/cells/methods.h

-4
This file was deleted.

‎libs/libs.cbp

+13-6
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,27 @@
3434
</Linker>
3535
</Target>
3636
</Build>
37-
<Unit filename="cells/constructors.c">
37+
<Unit filename="macros.h" />
38+
<Unit filename="main.h" />
39+
<Unit filename="patterns/constructors.c">
3840
<Option compilerVar="CC" />
3941
</Unit>
40-
<Unit filename="cells/constructors.h" />
41-
<Unit filename="cells/methods.c">
42+
<Unit filename="patterns/constructors.h" />
43+
<Unit filename="patterns/macros.h" />
44+
<Unit filename="patterns/main.h" />
45+
<Unit filename="patterns/methods.c">
4246
<Option compilerVar="CC" />
4347
</Unit>
44-
<Unit filename="cells/methods.h" />
45-
<Unit filename="macros.h" />
46-
<Unit filename="main.h" />
48+
<Unit filename="patterns/methods.h" />
49+
<Unit filename="patterns/structs.h" />
4750
<Unit filename="utilities.c">
4851
<Option compilerVar="CC" />
4952
</Unit>
5053
<Unit filename="utilities.h" />
54+
<Unit filename="validators.c">
55+
<Option compilerVar="CC" />
56+
</Unit>
57+
<Unit filename="validators.h" />
5158
<Extensions>
5259
<lib_finder disable_auto="1" />
5360
</Extensions>

‎libs/macros.h

+55
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,59 @@
1+
12
#ifndef MACROS_H_INCLUDED
23
#define MACROS_H_INCLUDED
34

5+
/**
6+
* @def DASHBOARD_ROWS
7+
* @brief Defines the number of rows in a grid.
8+
*
9+
* This macro is used to define the number of rows in a grid.
10+
* It is typically used in conjunction with the `DASHBOARD_COLS` macro to define
11+
* the size of a grid.
12+
*
13+
* @warning The value of `DASHBOARD_ROWS` must be a positive integer.
14+
*/
15+
#define DASHBOARD_ROWS 56
16+
17+
/**
18+
* @def DASHBOARD_COLS
19+
* @brief Defines the number of columns in a grid.
20+
*
21+
* This macro is used to define the number of columns in a grid.
22+
* It is typically used in conjunction with the `DASHBOARD_ROWS` macro to define
23+
* the size of a grid.
24+
*
25+
* @warning The value of `DASHBOARD_COLS` must be a positive integer.
26+
*/
27+
#define DASHBOARD_COLS 110
28+
29+
/**
30+
* @def MAXIMUM_DELAY
31+
* @brief Defines the maximum delay in milliseconds.
32+
*
33+
* This macro is used to define the maximum delay for a delay input.
34+
* It is typically used in conjunction with the `MINIMUM_DELAY`.
35+
*
36+
* @warning The value of `MAXIMUM_DELAY` must be a positive integer.
37+
*/
38+
#define MAXIMUM_DELAY 1000
39+
40+
/**
41+
* @def MINIMUM_DELAY
42+
* @brief Defines the minimum delay in milliseconds.
43+
*
44+
* This macro is used to define the minimum delay for a delay input.
45+
* It is typically used in conjunction with the `MAXIMUM_DELAY`.
46+
*
47+
* @warning The value of `MINIMUM_DELAY` must be a positive integer.
48+
*/
49+
#define MINIMUM_DELAY 0
50+
51+
/**
52+
* @def NEIGHBORHOOD_RADIUS
53+
* @brief Defines the radius of the neighborhood.
54+
*
55+
* @warning The value of `NEIGHBORHOOD_RADIUS` must be greater or equal to 1.
56+
*/
57+
#define NEIGHBORHOOD_RADIUS 1
58+
459
#endif // MACROS_H_INCLUDED

‎libs/main.h

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1+
12
#ifndef MAIN_H_INCLUDED
23
#define MAIN_H_INCLUDED
34

45
// Root
5-
#include "macros.h"
6-
#include "utilities.h"
6+
#include "./macros.h"
7+
#include "./utilities.h"
8+
#include "./validators.h"
79

8-
// Cells
9-
#include "cells/constructors.h"
10-
#include "cells/methods.h"
10+
// Patterns
11+
#include "./patterns/main.h"
1112

1213
#endif // MAIN_H_INCLUDED

0 commit comments

Comments
 (0)