Macros et préprocesseur » Historique » Version 5
Patrice Nadeau, 2024-03-09 11:46
| 1 | 5 | Patrice Nadeau | # Macros et préprocesseur |
|---|---|---|---|
| 2 | 4 | Patrice Nadeau | Directives du préprocesseur gcc. |
| 3 | 1 | Patrice Nadeau | |
| 4 | ## Règles |
||
| 5 | 1. Comportent au maximum 31 caractères |
||
| 6 | 1. Commence par une lettre |
||
| 7 | 1. Si plusieurs mots sont utilisés, ils sont séparées par des traits de soulignement |
||
| 8 | 1. Les macros ne devant plus être utilisées, DOIVENT générer un message lors de la compilation avec `#pragma GCC poison` |
||
| 9 | 3 | Patrice Nadeau | |
| 10 | 1 | Patrice Nadeau | > Dans ce cas, la documentation doit indiquer le substitut à utiliser |
| 11 | > Pour la définition d’une valeur entière signée (int), un enum DOIT être utilisé. |
||
| 12 | |||
| 13 | ## Exemple |
||
| 14 | ```c |
||
| 15 | /** |
||
| 16 | * @brief MACRO1 |
||
| 17 | * @deprecated Utiliser NEWMACRO à la place |
||
| 18 | * @since Version x.x.xx |
||
| 19 | */ |
||
| 20 | #define MACRO1 43 |
||
| 21 | #pragma GCC poison MACRO1 |
||
| 22 | 4 | Patrice Nadeau | ``` |
| 23 | |||
| 24 | ## Règles |
||
| 25 | 1. `ifdef` / `ifndef` : Utiliser une forme évitant les répétitions. |
||
| 26 | 1. Macros `#warning` et `#error` : Utilisées pour afficher des avertissements ou des erreurs lors de la compilation. |
||
| 27 | |||
| 28 | > N’est pas documenté dans Doxygen. |
||
| 29 | |||
| 30 | 1. Un `#define` est utilisé pour remplacer une valeur au moment de la compilation |
||
| 31 | |||
| 32 | > Pour la définition d'une valeur « integer », un `enum` DOIT être utilisé. |
||
| 33 | |||
| 34 | ## Exemple |
||
| 35 | ```c |
||
| 36 | const char BLUE = |
||
| 37 | #if ENABLED(FEATURE_ONE) |
||
| 38 | '1' |
||
| 39 | #else |
||
| 40 | '0' |
||
| 41 | #endif |
||
| 42 | ; |
||
| 43 | |||
| 44 | #ifndef usart_AVR |
||
| 45 | #error "__FILE_NAME__ n'est pas supporté sur ce AVR !" |
||
| 46 | #endif |
||
| 47 | |||
| 48 | #ifndef test |
||
| 49 | #warning "test n'est pas défini!" |
||
| 50 | #endif |
||
| 51 | |||
| 52 | /** |
||
| 53 | * @name Nom des registres |
||
| 54 | */ |
||
| 55 | /** @{ */ |
||
| 56 | /** @brief USART1 */ |
||
| 57 | #define USART1 REG1 |
||
| 58 | /** @brief USART2 */ |
||
| 59 | #define USART2 REG2 |
||
| 60 | /** @} */ |
||
| 61 | |||
| 62 | USART1 = 0x0F; |
||
| 63 | 1 | Patrice Nadeau | ``` |
| 64 | |||
| 65 | ## Justification |
||
| 66 | 2 | Patrice Nadeau | • [Linux kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#naming) |
| 67 | • [GNU Coding Standards](https://www.gnu.org/prep/standards/html_node/Writing-C.html#Writing-C) |
||
| 68 | • [Embedded C Coding Standard](https://barrgroup.com/embedded-systems/books/embedded-c-coding-standard) |
||
| 69 | 1 | Patrice Nadeau | • Correspondance avec la fiche technique (datasheet) |