Skip to content

Commit

Permalink
feat: Improve the readme structure file
Browse files Browse the repository at this point in the history
  • Loading branch information
@AmrDeveloper
AmrDeveloper committed May 5, 2024
1 parent 1368699 commit e0de3db
Showing 1 changed file with 73 additions and 54 deletions.
127 changes: 73 additions & 54 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,70 +41,89 @@ SELECT COUNT(name) from globals WHERE type = "int"
SELECT * FROM globals WHERE is_volatile
```

### Classes and Structs table structure

| Name | Type | Description |
| ------------- | ------- | ------------------------------- |
| name | Text | Class variable name |
| is_struct | Boolean | True if it a struct declaration |
| bases_count | Integer | Number of bases for this class |
| methods_count | Integer | Number of methods declarations |
| fields_count | Integer | Number of fields declarations |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
### Tables structures

<details>

<summary>Classes table</summary>

| Name | Type | Description |
| ------------- | ------- | ------------------------------- |
| name | Text | Class variable name |
| is_struct | Boolean | True if it a struct declaration |
| bases_count | Integer | Number of bases for this class |
| methods_count | Integer | Number of methods declarations |
| fields_count | Integer | Number of fields declarations |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |

</details>

---

### Enums table structure
<details>

<summary>Enums table</summary>

| Name | Type | Description |
| --------------- | ------- | -------------------------------- |
| name | Text | Enumeration name |
| constants_count | Integer | Number of constants in this enum |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
| Name | Type | Description |
| --------------- | ------- | -------------------------------- |
| name | Text | Enumeration name |
| constants_count | Integer | Number of constants in this enum |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |

</details>

---

### Functions table structure

| Name | Type | Description |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | Text | Function or Method name |
| signature | Text | Parameters and return type literal |
| args_count | Integer | Number of arguments |
| class_name | Text | Return class name for method |
| return_type | Text | Return type literal |
| is_method | Boolean | True if it's a method |
| is_virtual | Boolean | Return true if a C++ member function or member function template is explicitly declared 'virtual' or if it overrides a virtual method from one of the base classes |
| is_pure_virtual | Boolean | Return ture if a C++ member function or member function template is pure virtual |
| is_static | Boolean | Return ture if a C++ member function is static |
| is_const | Boolean | Return ture if a C++ member function is const |
| has_template | Boolean | True if it's has template |
| access_modifier | Integer | Returns the access control level for method, 1 for public, 2 protected, 3 provide, 0 for invalid |
| is_variadic | Boolean | True if function type is variadic |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
<details>

<summary>Functions table</summary>

| Name | Type | Description |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | Text | Function or Method name |
| signature | Text | Parameters and return type literal |
| args_count | Integer | Number of arguments |
| class_name | Text | Return class name for method |
| return_type | Text | Return type literal |
| is_method | Boolean | True if it's a method |
| is_virtual | Boolean | Return true if a C++ member function or member function template is explicitly declared 'virtual' or if it overrides a virtual method from one of the base classes |
| is_pure_virtual | Boolean | Return ture if a C++ member function or member function template is pure virtual |
| is_static | Boolean | Return ture if a C++ member function is static |
| is_const | Boolean | Return ture if a C++ member function is const |
| has_template | Boolean | True if it's has template |
| access_modifier | Integer | Returns the access control level for method, 1 for public, 2 protected, 3 provide, 0 for invalid |
| is_variadic | Boolean | True if function type is variadic |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |

</details>

---

### Gloal variables table structure

| Name | Type | Description |
| ----------- | ------- | --------------------------------- |
| name | Text | Global variable name |
| type | Text | Global variable type literal |
| is_volatile | Boolean | True if variable type is volatile |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |
<details>

<summary>Globals table</summary>

| Name | Type | Description |
| ----------- | ------- | --------------------------------- |
| name | Text | Global variable name |
| type | Text | Global variable type literal |
| is_volatile | Boolean | True if variable type is volatile |
| file | Text | File path |
| line | Integer | Line at the file path |
| column | Integer | Column at the file path |
| offset | Integer | Offset at the file path |

</details>


---

Expand Down

0 comments on commit e0de3db

Please sign in to comment.