@specs-feup/clava-misra 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (350) hide show
  1. package/.gitignore +117 -0
  2. package/README.md +70 -15
  3. package/dist/MISRA.d.ts +129 -0
  4. package/dist/MISRA.d.ts.map +1 -0
  5. package/dist/MISRA.js +245 -0
  6. package/dist/MISRA.js.map +1 -0
  7. package/dist/MISRAContext.d.ts +21 -0
  8. package/dist/MISRAContext.d.ts.map +1 -0
  9. package/dist/MISRAContext.js +75 -0
  10. package/dist/MISRAContext.js.map +1 -0
  11. package/dist/MISRARule.d.ts +56 -0
  12. package/dist/MISRARule.d.ts.map +1 -0
  13. package/dist/MISRARule.js +45 -0
  14. package/dist/MISRARule.js.map +1 -0
  15. package/dist/MISRATool.d.ts +12 -0
  16. package/dist/MISRATool.d.ts.map +1 -0
  17. package/dist/MISRATool.js +84 -0
  18. package/dist/MISRATool.js.map +1 -0
  19. package/dist/foo.d.ts +2 -0
  20. package/dist/foo.d.ts.map +1 -0
  21. package/{src/foo.ts → dist/foo.js} +3 -2
  22. package/dist/foo.js.map +1 -0
  23. package/dist/main.d.ts +2 -0
  24. package/dist/main.d.ts.map +1 -0
  25. package/dist/main.js +5 -0
  26. package/dist/main.js.map +1 -0
  27. package/dist/misra/MISRAAnalyser.d.ts +14 -0
  28. package/dist/misra/MISRAAnalyser.d.ts.map +1 -0
  29. package/{src/misra/MISRAAnalyser.ts → dist/misra/MISRAAnalyser.js} +13 -23
  30. package/dist/misra/MISRAAnalyser.js.map +1 -0
  31. package/dist/misra/MISRAPass.d.ts +27 -0
  32. package/dist/misra/MISRAPass.d.ts.map +1 -0
  33. package/dist/misra/MISRAPass.js +60 -0
  34. package/dist/misra/MISRAPass.js.map +1 -0
  35. package/dist/misra/MISRAPassResult.d.ts +13 -0
  36. package/dist/misra/MISRAPassResult.d.ts.map +1 -0
  37. package/dist/misra/MISRAPassResult.js +11 -0
  38. package/dist/misra/MISRAPassResult.js.map +1 -0
  39. package/dist/misra/MISRAReporter.d.ts +20 -0
  40. package/dist/misra/MISRAReporter.d.ts.map +1 -0
  41. package/dist/misra/MISRAReporter.js +43 -0
  42. package/dist/misra/MISRAReporter.js.map +1 -0
  43. package/dist/misra/passes/S10_EssentialTypePass.d.ts +42 -0
  44. package/dist/misra/passes/S10_EssentialTypePass.d.ts.map +1 -0
  45. package/dist/misra/passes/S10_EssentialTypePass.js +370 -0
  46. package/dist/misra/passes/S10_EssentialTypePass.js.map +1 -0
  47. package/dist/misra/passes/S12_ExpressionPass.d.ts +18 -0
  48. package/dist/misra/passes/S12_ExpressionPass.d.ts.map +1 -0
  49. package/dist/misra/passes/S12_ExpressionPass.js +72 -0
  50. package/dist/misra/passes/S12_ExpressionPass.js.map +1 -0
  51. package/dist/misra/passes/S13_SideEffectPass.d.ts +18 -0
  52. package/dist/misra/passes/S13_SideEffectPass.d.ts.map +1 -0
  53. package/dist/misra/passes/S13_SideEffectPass.js +105 -0
  54. package/dist/misra/passes/S13_SideEffectPass.js.map +1 -0
  55. package/dist/misra/passes/S15_ControlFlowPass.d.ts +19 -0
  56. package/dist/misra/passes/S15_ControlFlowPass.d.ts.map +1 -0
  57. package/dist/misra/passes/S15_ControlFlowPass.js +94 -0
  58. package/dist/misra/passes/S15_ControlFlowPass.js.map +1 -0
  59. package/dist/misra/passes/S16_SwitchStatementPass.d.ts +17 -0
  60. package/dist/misra/passes/S16_SwitchStatementPass.d.ts.map +1 -0
  61. package/dist/misra/passes/S16_SwitchStatementPass.js +152 -0
  62. package/dist/misra/passes/S16_SwitchStatementPass.js.map +1 -0
  63. package/dist/misra/passes/S17_FunctionPass.d.ts +12 -0
  64. package/dist/misra/passes/S17_FunctionPass.d.ts.map +1 -0
  65. package/dist/misra/passes/S17_FunctionPass.js +38 -0
  66. package/dist/misra/passes/S17_FunctionPass.js.map +1 -0
  67. package/dist/misra/passes/S18_PointersArraysPass.d.ts +17 -0
  68. package/dist/misra/passes/S18_PointersArraysPass.d.ts.map +1 -0
  69. package/dist/misra/passes/S18_PointersArraysPass.js +115 -0
  70. package/dist/misra/passes/S18_PointersArraysPass.js.map +1 -0
  71. package/dist/misra/passes/S19_OverlappingStoragePass.d.ts +11 -0
  72. package/dist/misra/passes/S19_OverlappingStoragePass.d.ts.map +1 -0
  73. package/dist/misra/passes/S19_OverlappingStoragePass.js +20 -0
  74. package/dist/misra/passes/S19_OverlappingStoragePass.js.map +1 -0
  75. package/dist/misra/passes/S21_StandardLibPass.d.ts +20 -0
  76. package/dist/misra/passes/S21_StandardLibPass.d.ts.map +1 -0
  77. package/dist/misra/passes/S21_StandardLibPass.js +77 -0
  78. package/dist/misra/passes/S21_StandardLibPass.js.map +1 -0
  79. package/dist/misra/passes/S3_CommentPass.d.ts +12 -0
  80. package/dist/misra/passes/S3_CommentPass.d.ts.map +1 -0
  81. package/dist/misra/passes/S3_CommentPass.js +27 -0
  82. package/dist/misra/passes/S3_CommentPass.js.map +1 -0
  83. package/dist/misra/passes/S5_IdentifierPass.d.ts +13 -0
  84. package/dist/misra/passes/S5_IdentifierPass.d.ts.map +1 -0
  85. package/dist/misra/passes/S5_IdentifierPass.js +60 -0
  86. package/dist/misra/passes/S5_IdentifierPass.js.map +1 -0
  87. package/dist/misra/passes/S6_TypePass.d.ts +11 -0
  88. package/dist/misra/passes/S6_TypePass.d.ts.map +1 -0
  89. package/dist/misra/passes/S6_TypePass.js +25 -0
  90. package/dist/misra/passes/S6_TypePass.js.map +1 -0
  91. package/dist/misra/passes/S7_LiteralsConstantsPass.d.ts +14 -0
  92. package/dist/misra/passes/S7_LiteralsConstantsPass.d.ts.map +1 -0
  93. package/dist/misra/passes/S7_LiteralsConstantsPass.js +71 -0
  94. package/dist/misra/passes/S7_LiteralsConstantsPass.js.map +1 -0
  95. package/dist/misra/passes/S8_DeclDefPass.d.ts +18 -0
  96. package/dist/misra/passes/S8_DeclDefPass.d.ts.map +1 -0
  97. package/dist/misra/passes/S8_DeclDefPass.js +127 -0
  98. package/dist/misra/passes/S8_DeclDefPass.js.map +1 -0
  99. package/dist/misra/sections/Section10_EssentialTypeModel.d.ts +33 -0
  100. package/dist/misra/sections/Section10_EssentialTypeModel.d.ts.map +1 -0
  101. package/{src/misra/sections/Section10_EssentialTypeModel.ts → dist/misra/sections/Section10_EssentialTypeModel.js} +58 -73
  102. package/dist/misra/sections/Section10_EssentialTypeModel.js.map +1 -0
  103. package/dist/misra/sections/Section11_PointerTypeConversions.d.ts +12 -0
  104. package/dist/misra/sections/Section11_PointerTypeConversions.d.ts.map +1 -0
  105. package/{src/misra/sections/Section11_PointerTypeConversions.ts → dist/misra/sections/Section11_PointerTypeConversions.js} +16 -27
  106. package/dist/misra/sections/Section11_PointerTypeConversions.js.map +1 -0
  107. package/dist/misra/sections/Section12_Expressions.d.ts +15 -0
  108. package/dist/misra/sections/Section12_Expressions.d.ts.map +1 -0
  109. package/dist/misra/sections/Section12_Expressions.js +70 -0
  110. package/dist/misra/sections/Section12_Expressions.js.map +1 -0
  111. package/dist/misra/sections/Section13_SideEffects.d.ts +14 -0
  112. package/dist/misra/sections/Section13_SideEffects.d.ts.map +1 -0
  113. package/dist/misra/sections/Section13_SideEffects.js +90 -0
  114. package/dist/misra/sections/Section13_SideEffects.js.map +1 -0
  115. package/dist/misra/sections/Section14_ControlStmtExprs.d.ts +8 -0
  116. package/dist/misra/sections/Section14_ControlStmtExprs.d.ts.map +1 -0
  117. package/{src/misra/sections/Section14_ControlStmtExprs.ts → dist/misra/sections/Section14_ControlStmtExprs.js} +8 -10
  118. package/dist/misra/sections/Section14_ControlStmtExprs.js.map +1 -0
  119. package/dist/misra/sections/Section15_ControlFlow.d.ts +14 -0
  120. package/dist/misra/sections/Section15_ControlFlow.d.ts.map +1 -0
  121. package/dist/misra/sections/Section15_ControlFlow.js +97 -0
  122. package/dist/misra/sections/Section15_ControlFlow.js.map +1 -0
  123. package/dist/misra/sections/Section16_SwitchStatements.d.ts +13 -0
  124. package/dist/misra/sections/Section16_SwitchStatements.d.ts.map +1 -0
  125. package/{src/misra/sections/Section16_SwitchStatements.ts → dist/misra/sections/Section16_SwitchStatements.js} +49 -74
  126. package/dist/misra/sections/Section16_SwitchStatements.js.map +1 -0
  127. package/dist/misra/sections/Section17_Functions.d.ts +9 -0
  128. package/dist/misra/sections/Section17_Functions.d.ts.map +1 -0
  129. package/{src/misra/sections/Section17_Functions.ts → dist/misra/sections/Section17_Functions.js} +10 -13
  130. package/dist/misra/sections/Section17_Functions.js.map +1 -0
  131. package/dist/misra/sections/Section18_PointersAndArrays.d.ts +13 -0
  132. package/dist/misra/sections/Section18_PointersAndArrays.d.ts.map +1 -0
  133. package/{src/misra/sections/Section18_PointersAndArrays.ts → dist/misra/sections/Section18_PointersAndArrays.js} +36 -40
  134. package/dist/misra/sections/Section18_PointersAndArrays.js.map +1 -0
  135. package/dist/misra/sections/Section19_OverlappingStorage.d.ts +8 -0
  136. package/dist/misra/sections/Section19_OverlappingStorage.d.ts.map +1 -0
  137. package/dist/misra/sections/Section19_OverlappingStorage.js +16 -0
  138. package/dist/misra/sections/Section19_OverlappingStorage.js.map +1 -0
  139. package/dist/misra/sections/Section20_PreprocessingDirectives.d.ts +8 -0
  140. package/dist/misra/sections/Section20_PreprocessingDirectives.d.ts.map +1 -0
  141. package/{src/misra/sections/Section20_PreprocessingDirectives.ts → dist/misra/sections/Section20_PreprocessingDirectives.js} +7 -9
  142. package/dist/misra/sections/Section20_PreprocessingDirectives.js.map +1 -0
  143. package/dist/misra/sections/Section21_StandardLibraries.d.ts +17 -0
  144. package/dist/misra/sections/Section21_StandardLibraries.d.ts.map +1 -0
  145. package/dist/misra/sections/Section21_StandardLibraries.js +54 -0
  146. package/dist/misra/sections/Section21_StandardLibraries.js.map +1 -0
  147. package/dist/misra/sections/Section2_UnusedCode.d.ts +9 -0
  148. package/dist/misra/sections/Section2_UnusedCode.d.ts.map +1 -0
  149. package/{src/misra/sections/Section2_UnusedCode.ts → dist/misra/sections/Section2_UnusedCode.js} +11 -16
  150. package/dist/misra/sections/Section2_UnusedCode.js.map +1 -0
  151. package/dist/misra/sections/Section3_Comments.d.ts +9 -0
  152. package/dist/misra/sections/Section3_Comments.d.ts.map +1 -0
  153. package/{src/misra/sections/Section3_Comments.ts → dist/misra/sections/Section3_Comments.js} +7 -10
  154. package/dist/misra/sections/Section3_Comments.js.map +1 -0
  155. package/dist/misra/sections/Section5_Identifiers.d.ts +12 -0
  156. package/dist/misra/sections/Section5_Identifiers.d.ts.map +1 -0
  157. package/dist/misra/sections/Section5_Identifiers.js +139 -0
  158. package/dist/misra/sections/Section5_Identifiers.js.map +1 -0
  159. package/dist/misra/sections/Section6_Types.d.ts +8 -0
  160. package/dist/misra/sections/Section6_Types.d.ts.map +1 -0
  161. package/dist/misra/sections/Section6_Types.js +23 -0
  162. package/dist/misra/sections/Section6_Types.js.map +1 -0
  163. package/dist/misra/sections/Section7_LiteralsConstants.d.ts +11 -0
  164. package/dist/misra/sections/Section7_LiteralsConstants.d.ts.map +1 -0
  165. package/{src/misra/sections/Section7_LiteralsConstants.ts → dist/misra/sections/Section7_LiteralsConstants.js} +18 -25
  166. package/dist/misra/sections/Section7_LiteralsConstants.js.map +1 -0
  167. package/dist/misra/sections/Section8_DeclarationsDefinitions.d.ts +15 -0
  168. package/dist/misra/sections/Section8_DeclarationsDefinitions.d.ts.map +1 -0
  169. package/{src/misra/sections/Section8_DeclarationsDefinitions.ts → dist/misra/sections/Section8_DeclarationsDefinitions.js} +18 -33
  170. package/dist/misra/sections/Section8_DeclarationsDefinitions.js.map +1 -0
  171. package/dist/misra/tests/utils.d.ts +10 -0
  172. package/dist/misra/tests/utils.d.ts.map +1 -0
  173. package/dist/misra/tests/utils.js +33 -0
  174. package/dist/misra/tests/utils.js.map +1 -0
  175. package/dist/rules/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.d.ts +15 -0
  176. package/dist/rules/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.d.ts.map +1 -0
  177. package/dist/rules/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.js +33 -0
  178. package/dist/rules/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.js.map +1 -0
  179. package/dist/rules/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.d.ts +16 -0
  180. package/dist/rules/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.d.ts.map +1 -0
  181. package/dist/rules/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.js +60 -0
  182. package/dist/rules/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.js.map +1 -0
  183. package/dist/rules/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.d.ts +19 -0
  184. package/dist/rules/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.d.ts.map +1 -0
  185. package/dist/rules/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.js +42 -0
  186. package/dist/rules/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.js.map +1 -0
  187. package/dist/rules/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.d.ts +43 -0
  188. package/dist/rules/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.d.ts.map +1 -0
  189. package/dist/rules/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.js +103 -0
  190. package/dist/rules/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.js.map +1 -0
  191. package/dist/rules/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.d.ts +26 -0
  192. package/dist/rules/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.d.ts.map +1 -0
  193. package/dist/rules/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.js +49 -0
  194. package/dist/rules/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.js.map +1 -0
  195. package/dist/rules/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.d.ts +26 -0
  196. package/dist/rules/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.d.ts.map +1 -0
  197. package/dist/rules/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.js +49 -0
  198. package/dist/rules/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.js.map +1 -0
  199. package/dist/rules/Section17_Functions/Rule_17_4_NonVoidReturn.d.ts +31 -0
  200. package/dist/rules/Section17_Functions/Rule_17_4_NonVoidReturn.d.ts.map +1 -0
  201. package/dist/rules/Section17_Functions/Rule_17_4_NonVoidReturn.js +71 -0
  202. package/dist/rules/Section17_Functions/Rule_17_4_NonVoidReturn.js.map +1 -0
  203. package/dist/rules/Section17_Functions/Rule_17_6_StaticArraySizeParam.d.ts +27 -0
  204. package/dist/rules/Section17_Functions/Rule_17_6_StaticArraySizeParam.d.ts.map +1 -0
  205. package/dist/rules/Section17_Functions/Rule_17_6_StaticArraySizeParam.js +58 -0
  206. package/dist/rules/Section17_Functions/Rule_17_6_StaticArraySizeParam.js.map +1 -0
  207. package/dist/rules/Section17_Functions/Rule_17_7_UnusedReturnValue.d.ts +28 -0
  208. package/dist/rules/Section17_Functions/Rule_17_7_UnusedReturnValue.d.ts.map +1 -0
  209. package/dist/rules/Section17_Functions/Rule_17_7_UnusedReturnValue.js +44 -0
  210. package/dist/rules/Section17_Functions/Rule_17_7_UnusedReturnValue.js.map +1 -0
  211. package/dist/rules/Section20-PreprocessingDirectives/Rule_20_2_InvalidHeaderFileName.d.ts +55 -0
  212. package/dist/rules/Section20-PreprocessingDirectives/Rule_20_2_InvalidHeaderFileName.d.ts.map +1 -0
  213. package/dist/rules/Section20-PreprocessingDirectives/Rule_20_2_InvalidHeaderFileName.js +108 -0
  214. package/dist/rules/Section20-PreprocessingDirectives/Rule_20_2_InvalidHeaderFileName.js.map +1 -0
  215. package/dist/rules/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.d.ts +43 -0
  216. package/dist/rules/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.d.ts.map +1 -0
  217. package/dist/rules/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.js +68 -0
  218. package/dist/rules/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.js.map +1 -0
  219. package/dist/rules/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.d.ts +29 -0
  220. package/dist/rules/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.d.ts.map +1 -0
  221. package/dist/rules/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.js +53 -0
  222. package/dist/rules/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.js.map +1 -0
  223. package/dist/rules/Section2_UnusedCode/Rule_2_6_UnusedLabels.d.ts +15 -0
  224. package/dist/rules/Section2_UnusedCode/Rule_2_6_UnusedLabels.d.ts.map +1 -0
  225. package/dist/rules/Section2_UnusedCode/Rule_2_6_UnusedLabels.js +35 -0
  226. package/dist/rules/Section2_UnusedCode/Rule_2_6_UnusedLabels.js.map +1 -0
  227. package/dist/rules/Section2_UnusedCode/Rule_2_7_UnusedParameters.d.ts +13 -0
  228. package/dist/rules/Section2_UnusedCode/Rule_2_7_UnusedParameters.d.ts.map +1 -0
  229. package/dist/rules/Section2_UnusedCode/Rule_2_7_UnusedParameters.js +53 -0
  230. package/dist/rules/Section2_UnusedCode/Rule_2_7_UnusedParameters.js.map +1 -0
  231. package/dist/rules/Section3_Comments/Rule_3_1_CommentSequences.d.ts +13 -0
  232. package/dist/rules/Section3_Comments/Rule_3_1_CommentSequences.d.ts.map +1 -0
  233. package/dist/rules/Section3_Comments/Rule_3_1_CommentSequences.js +32 -0
  234. package/dist/rules/Section3_Comments/Rule_3_1_CommentSequences.js.map +1 -0
  235. package/dist/rules/Section3_Comments/Rule_3_2_LineSplicing.d.ts +10 -0
  236. package/dist/rules/Section3_Comments/Rule_3_2_LineSplicing.d.ts.map +1 -0
  237. package/dist/rules/Section3_Comments/Rule_3_2_LineSplicing.js +26 -0
  238. package/dist/rules/Section3_Comments/Rule_3_2_LineSplicing.js.map +1 -0
  239. package/dist/rules/index.d.ts +20 -0
  240. package/dist/rules/index.d.ts.map +1 -0
  241. package/dist/rules/index.js +38 -0
  242. package/dist/rules/index.js.map +1 -0
  243. package/dist/tests/Section17_Functions/misra_config.json +10 -0
  244. package/dist/tests/utils.d.ts +10 -0
  245. package/dist/tests/utils.d.ts.map +1 -0
  246. package/dist/tests/utils.js +29 -0
  247. package/dist/tests/utils.js.map +1 -0
  248. package/dist/utils/utils.d.ts +102 -0
  249. package/dist/utils/utils.d.ts.map +1 -0
  250. package/dist/utils/utils.js +202 -0
  251. package/dist/utils/utils.js.map +1 -0
  252. package/jest.config.js +6 -6
  253. package/package.json +40 -8
  254. package/src/MISRA.ts +266 -0
  255. package/src/MISRAContext.ts +91 -0
  256. package/src/MISRARule.ts +77 -0
  257. package/src/MISRATool.ts +96 -0
  258. package/src/main.ts +4 -33
  259. package/src/misra-old/MISRAAnalyser.ts +60 -0
  260. package/src/misra-old/MISRAAnalyserResult.ts +16 -0
  261. package/src/misra-old/sections/Section10_EssentialTypeModel.ts +377 -0
  262. package/src/misra-old/sections/Section11_PointerTypeConversions.ts +104 -0
  263. package/src/{misra → misra-old}/sections/Section12_Expressions.ts +7 -7
  264. package/src/{misra → misra-old}/sections/Section13_SideEffects.ts +15 -15
  265. package/src/misra-old/sections/Section14_ControlStmtExprs.ts +27 -0
  266. package/src/{misra → misra-old}/sections/Section15_ControlFlow.ts +10 -10
  267. package/src/misra-old/sections/Section18_PointersAndArrays.ts +108 -0
  268. package/src/{misra → misra-old}/sections/Section19_OverlappingStorage.ts +4 -4
  269. package/src/misra-old/sections/Section20_PreprocessingDirectives.ts +22 -0
  270. package/src/misra-old/sections/Section21_StandardLibraries.ts +99 -0
  271. package/src/{misra → misra-old}/sections/Section5_Identifiers.ts +16 -15
  272. package/src/{misra → misra-old}/sections/Section6_Types.ts +4 -4
  273. package/src/misra-old/sections/Section7_LiteralsConstants.ts +76 -0
  274. package/src/misra-old/sections/Section8_DeclarationsDefinitions.ts +133 -0
  275. package/src/rules/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.ts +40 -0
  276. package/src/rules/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.ts +69 -0
  277. package/src/rules/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.ts +46 -0
  278. package/src/rules/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.ts +113 -0
  279. package/src/rules/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.ts +57 -0
  280. package/src/rules/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.ts +56 -0
  281. package/src/rules/Section17_Functions/Rule_17_4_NonVoidReturn.ts +78 -0
  282. package/src/rules/Section17_Functions/Rule_17_6_StaticArraySizeParam.ts +68 -0
  283. package/src/rules/Section17_Functions/Rule_17_7_UnusedReturnValue.ts +47 -0
  284. package/src/rules/Section20-PreprocessingDirectives/Rule_20_2_InvalidHeaderFileName.ts +120 -0
  285. package/src/rules/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.ts +75 -0
  286. package/src/rules/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.ts +60 -0
  287. package/src/rules/Section2_UnusedCode/Rule_2_6_UnusedLabels.ts +46 -0
  288. package/src/rules/Section2_UnusedCode/Rule_2_7_UnusedParameters.ts +65 -0
  289. package/src/rules/Section3_Comments/Rule_3_1_CommentSequences.ts +41 -0
  290. package/src/rules/Section3_Comments/Rule_3_2_LineSplicing.ts +36 -0
  291. package/src/rules/index.ts +40 -0
  292. package/src/tests/Section16_SwitchStatements/Rule_16_2_TopLevelSwitch.test.ts +55 -0
  293. package/src/tests/Section16_SwitchStatements/Rule_16_3_UnconditionalBreak.test.ts +70 -0
  294. package/src/tests/Section16_SwitchStatements/Rule_16_4_SwitchHasDefault.test.ts +128 -0
  295. package/src/tests/Section16_SwitchStatements/Rule_16_5_DefaultFirstOrLast.test.ts +132 -0
  296. package/src/tests/Section16_SwitchStatements/Rule_16_6_SwitchMinTwoClauses.test.ts +146 -0
  297. package/src/tests/Section16_SwitchStatements/Rule_16_7_NonBooleanSwitchCondition.test.ts +102 -0
  298. package/src/tests/Section17_Functions/Rule_17_4_NonVoidReturn.test.ts +85 -0
  299. package/src/tests/Section17_Functions/Rule_17_4_NonVoidReturn_MissingConfig.test.ts +77 -0
  300. package/src/tests/Section17_Functions/Rule_17_6_StaticArraySizeParam.test.ts +36 -0
  301. package/src/tests/Section17_Functions/Rule_17_7_UnusedReturnValue.test.ts +44 -0
  302. package/src/tests/Section17_Functions/misra_config.json +10 -0
  303. package/src/tests/Section2_UnusedCode/Rule_2_3_UnusedTypeDecl.test.ts +175 -0
  304. package/src/tests/Section2_UnusedCode/Rule_2_4_UnusedTagDecl.test.ts +219 -0
  305. package/src/tests/Section2_UnusedCode/Rule_2_6_UnusedLabels.test.ts +49 -0
  306. package/src/tests/Section2_UnusedCode/Rule_2_7_UnusedParameters.test.ts +55 -0
  307. package/src/tests/Section3_Comments/Rule_3_1_CommentSequences.test.ts +37 -0
  308. package/src/tests/utils.ts +39 -0
  309. package/src/utils/utils.ts +221 -0
  310. package/tsconfig.json +4 -3
  311. package/typedoc.config.js +1 -1
  312. package/CxxSources/lib.cpp +0 -3
  313. package/CxxSources/lib.h +0 -8
  314. package/CxxSources/main.cpp +0 -40
  315. package/TODO.md +0 -1
  316. package/consumer_order.txt +0 -2
  317. package/enum_integer_type.txt +0 -0
  318. package/is_temporary.txt +0 -0
  319. package/omp.txt +0 -0
  320. package/src/misra/passes/S16_SwitchStatementPass.ts +0 -168
  321. package/src/misra/passes/S3_CommentPass.ts +0 -40
  322. package/src/misra/sections/Section21_StandardLibraries.ts +0 -65
  323. package/src/misra/tests/S10_EssentialTypes.test.ts +0 -253
  324. package/src/misra/tests/S12_Expressions.test.ts +0 -43
  325. package/src/misra/tests/S13_SideEffects.test.ts +0 -77
  326. package/src/misra/tests/S15_ControlFlow.test.ts +0 -144
  327. package/src/misra/tests/S16_SwitchStatements.test.ts +0 -164
  328. package/src/misra/tests/S17_Functions.test.ts +0 -46
  329. package/src/misra/tests/S18_PointersArrays.test.ts +0 -167
  330. package/src/misra/tests/S19_OverlappingStorage.test.ts +0 -38
  331. package/src/misra/tests/S3_Comments.test.ts +0 -36
  332. package/src/misra/tests/S6_Types.test.ts +0 -36
  333. package/src/misra/tests/S7_LiteralsConstants.test.ts +0 -48
  334. package/src/misra/tests/utils.ts +0 -47
  335. package/types_with_templates.txt +0 -0
  336. /package/src/{misra → misra-old}/MISRAPass.ts +0 -0
  337. /package/src/{misra → misra-old}/MISRAPassResult.ts +0 -0
  338. /package/src/{misra → misra-old}/MISRAReporter.ts +0 -0
  339. /package/src/{misra → misra-old}/passes/S10_EssentialTypePass.ts +0 -0
  340. /package/src/{misra → misra-old}/passes/S12_ExpressionPass.ts +0 -0
  341. /package/src/{misra → misra-old}/passes/S13_SideEffectPass.ts +0 -0
  342. /package/src/{misra → misra-old}/passes/S15_ControlFlowPass.ts +0 -0
  343. /package/src/{misra → misra-old}/passes/S17_FunctionPass.ts +0 -0
  344. /package/src/{misra → misra-old}/passes/S18_PointersArraysPass.ts +0 -0
  345. /package/src/{misra → misra-old}/passes/S19_OverlappingStoragePass.ts +0 -0
  346. /package/src/{misra → misra-old}/passes/S21_StandardLibPass.ts +0 -0
  347. /package/src/{misra → misra-old}/passes/S5_IdentifierPass.ts +0 -0
  348. /package/src/{misra → misra-old}/passes/S6_TypePass.ts +0 -0
  349. /package/src/{misra → misra-old}/passes/S7_LiteralsConstantsPass.ts +0 -0
  350. /package/src/{misra → misra-old}/passes/S8_DeclDefPass.ts +0 -0
@@ -0,0 +1,40 @@
1
+ import { Case, Joinpoint, Switch } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import Query from "@specs-feup/lara/api/weaver/Query.js";
5
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
6
+
7
+ /**
8
+ * MISRA Rule 16.2: A switch label shall only be used when the most closely-enclos ing
9
+ compound statement is the body of a switch statement
10
+ */
11
+ export default class Rule_16_2_TopLevelSwitch extends MISRARule {
12
+ #misplacedCases: Case[] = [];
13
+
14
+ constructor(context: MISRAContext) {
15
+ super("16.2", context);
16
+ }
17
+
18
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
19
+ if (!($jp instanceof Switch)) return false;
20
+
21
+ this.#misplacedCases = Query.searchFrom($jp, Case).get()
22
+ .filter(caseLabel => !(caseLabel.currentRegion instanceof Switch));
23
+
24
+ if (logErrors) {
25
+ this.#misplacedCases.forEach(caseLabel =>
26
+ this.logMISRAError(caseLabel, "A switch label can only be used if its enclosing compound statement is the switch statement itself.")
27
+ );
28
+ }
29
+ return this.#misplacedCases.length > 0;
30
+ }
31
+
32
+ transform($jp: Joinpoint): MISRATransformationReport {
33
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
34
+
35
+ for (const caseLabel of this.#misplacedCases) {
36
+ caseLabel.detach();
37
+ }
38
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
39
+ }
40
+ }
@@ -0,0 +1,69 @@
1
+ import { Break, Joinpoint, Statement, Switch, Case } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
5
+ import { getLastStmtOfCase } from "../../utils/utils.js";
6
+ import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
7
+
8
+ /**
9
+ * MISRA Rule 16.3: An unconditional break statement shall terminate every switch-clause
10
+ */
11
+ export default class Rule_16_3_UnconditionalBreak extends MISRARule {
12
+ #statementsNeedingBreakAfter: Joinpoint[] = [];
13
+
14
+ constructor(context: MISRAContext) {
15
+ super("16.3", context);
16
+ }
17
+
18
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
19
+ if (!($jp instanceof Switch)) return false;
20
+
21
+ this.#statementsNeedingBreakAfter = $jp.cases.map(caseLabel => getLastStmtOfCase(caseLabel))
22
+ .filter(lastStmt => lastStmt && !(lastStmt instanceof Break)) as Joinpoint[];
23
+
24
+ if (logErrors) {
25
+ this.#statementsNeedingBreakAfter.forEach(stmt => {
26
+ this.logMISRAError(stmt, `Missing unconditional break after statement '${stmt.code}'`);
27
+ });
28
+ }
29
+ return this.#statementsNeedingBreakAfter.length > 0;
30
+ }
31
+
32
+ private getNextStatementsToExecute(jp: Joinpoint): Joinpoint[] {
33
+ let stmts = [];
34
+
35
+ for (const sibling of jp.siblingsRight) {
36
+ if (sibling instanceof Break)
37
+ break;
38
+ if (sibling instanceof Case)
39
+ continue;
40
+ stmts.push(sibling.deepCopy());
41
+ }
42
+ return stmts;
43
+ }
44
+
45
+ private insertNextStatementsToExecute(jp: Joinpoint) {
46
+ const nextStmts = this.getNextStatementsToExecute(jp);
47
+ let lastStmt = jp;
48
+
49
+ for (const stmt of nextStmts) {
50
+ lastStmt.insertAfter(stmt);
51
+ lastStmt = stmt;
52
+ }
53
+ lastStmt.insertAfter(ClavaJoinPoints.breakStmt());
54
+ }
55
+
56
+ transform($jp: Joinpoint): MISRATransformationReport {
57
+ if (!this.match($jp))
58
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
59
+
60
+ for (const stmt of this.#statementsNeedingBreakAfter) {
61
+ if (stmt.rightJp === undefined) { // last statement of the switch
62
+ stmt.insertAfter(ClavaJoinPoints.breakStmt());
63
+ } else {
64
+ this.insertNextStatementsToExecute(stmt);
65
+ }
66
+ }
67
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
68
+ }
69
+ }
@@ -0,0 +1,46 @@
1
+ import { Joinpoint, Switch } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
5
+ import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
6
+ import { getNumOfSwitchClauses, switchHasBooleanCondition, switchHasConditionalBreak } from "../../utils/utils.js";
7
+
8
+ /**
9
+ * MISRA Rule 16.4: Every switch statement shall have a default label
10
+ */
11
+ export default class Rule_16_4_SwitchHasDefault extends MISRARule {
12
+ constructor(context: MISRAContext) {
13
+ super("16.4", context);
14
+ }
15
+
16
+ /**
17
+ * Checks if the given joinpoint is a switch statement with a default case
18
+ * @param $jp - Joinpoint to analyze
19
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
20
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
21
+ */
22
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
23
+ if (!($jp instanceof Switch)) return false;
24
+
25
+ const noDefaultCase = !$jp.hasDefaultCase;
26
+ if (noDefaultCase && logErrors) {
27
+ this.logMISRAError($jp, "Switch statement is missing a default case.")
28
+ }
29
+ return noDefaultCase;
30
+ }
31
+
32
+ transform($jp: Joinpoint): MISRATransformationReport {
33
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
34
+
35
+ if ((getNumOfSwitchClauses($jp as Switch) < 2 || switchHasBooleanCondition($jp as Switch)) &&
36
+ !switchHasConditionalBreak($jp as Switch)) { // Will be handled by rules 16.6 or 16.7
37
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
38
+ }
39
+
40
+ $jp.children[1].lastChild
41
+ .insertAfter(ClavaJoinPoints.defaultStmt())
42
+ .insertAfter(ClavaJoinPoints.emptyStmt())
43
+ .insertAfter(ClavaJoinPoints.breakStmt());
44
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
45
+ }
46
+ }
@@ -0,0 +1,113 @@
1
+ import {Case, Comment, Joinpoint, Statement, Switch, WrapperStmt } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
5
+ import { isCommentStmt } from "../../utils/utils.js";
6
+
7
+ /**
8
+ * MISRA Rule 16.5: A default label shall appear as either the first or the last switch label of
9
+ a switch statement
10
+ */
11
+ export default class Rule_16_5_DefaultFirstOrLast extends MISRARule {
12
+
13
+ constructor(context: MISRAContext) {
14
+ super("16.5", context);
15
+ }
16
+
17
+ /**
18
+ * Retrieves all consecutive case statements to the left of a given case statement
19
+ *
20
+ * @param $jp - The starting case statement from which the search will begin
21
+ * @returns Array containing consecutive case statements to the left of the provided joinpoint
22
+ *
23
+ */
24
+ private getConsecutiveRightCases($jp: Case): Joinpoint[] {
25
+ const cases = [];
26
+ for (const stmt of $jp.siblingsRight) {
27
+ if (!(stmt instanceof Case || isCommentStmt($jp)))
28
+ break;
29
+ cases.push(stmt);
30
+ }
31
+ return cases;
32
+ }
33
+
34
+ /**
35
+ * Retrieves all consecutive case statements to the right of a given case statement
36
+ *
37
+ * @param $jp - The starting case statement from which the search will begin
38
+ * @returns Array containing consecutive case statements to the right of the provided joinpoint
39
+ *
40
+ */
41
+ private getConsecutiveLeftCases($jp: Case): Joinpoint[] {
42
+ let cases: Joinpoint[] = [];
43
+ for (let i = $jp.siblingsLeft.length - 1; i >= 0; i--) {
44
+ const currentStmt = $jp.siblingsLeft[i];
45
+ if (!(currentStmt instanceof Case || isCommentStmt($jp))) {
46
+ break;
47
+ }
48
+ cases.push($jp.siblingsLeft[i]);
49
+ }
50
+ return cases.reverse();
51
+ }
52
+
53
+ /**
54
+ * Checks if the given joinpoint is a switch statement where the default label appears either as first of last label
55
+ * @param $jp - Joinpoint to analyze
56
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
57
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
58
+ */
59
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
60
+ if (!($jp instanceof Switch)) return false;
61
+
62
+ const caseStmts = $jp.cases;
63
+ for (let i = 0; i < caseStmts.length; i++) {
64
+ const currentCase = caseStmts[i];
65
+ if (currentCase.isDefault) {
66
+ if (i == 0 || i == caseStmts.length - 1) {
67
+ return false;
68
+ }
69
+ if (logErrors) {
70
+ this.logMISRAError($jp, "The default case of a switch statement must be the first or last label.")
71
+ }
72
+ return true;
73
+ }
74
+ }
75
+ return false;
76
+ }
77
+
78
+ /**
79
+ * Transforms a switch statement so that the default case appears as the last label
80
+ * - If the default case is not already the last case within its case clause list, it is repositioned
81
+ * - Then, the entire case clause list containing the default case to the end of the switch statement
82
+ * @param $jp - Joinpoint to transform
83
+ * @returns Report detailing the transformation result
84
+ */
85
+ transform($jp: Joinpoint): MISRATransformationReport {
86
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
87
+
88
+ const defaultCase = ($jp as Switch).getDefaultCase;
89
+ const rightStatements = defaultCase.siblingsRight.filter(sibling => !isCommentStmt(sibling));
90
+
91
+ // Reposition the default case to the last position within its case clause lis
92
+ if (rightStatements[0] instanceof Case) { // At least one of the first statements is a Case
93
+ const rightConsecutiveCases = this.getConsecutiveRightCases(defaultCase);
94
+ const lastRightCase = rightConsecutiveCases[rightConsecutiveCases.length - 1];
95
+
96
+ defaultCase.detach();
97
+ lastRightCase.insertAfter(defaultCase);
98
+ if (defaultCase.nextCase === undefined) { // Default is now the last case
99
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
100
+ }
101
+ }
102
+
103
+ // Move the entire case clause list containing the default case to the end of the switch statement
104
+ const switchScope = $jp.children[1];
105
+ const stmts = [...this.getConsecutiveLeftCases(defaultCase), defaultCase, ...defaultCase.instructions];
106
+
107
+ for (const stmt of stmts) {
108
+ stmt.detach();
109
+ switchScope.lastChild.insertAfter(stmt);
110
+ }
111
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
112
+ }
113
+ }
@@ -0,0 +1,57 @@
1
+ import {Break, Case, Joinpoint, Statement, Expression, Switch } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import { MISRASwitchConverter, MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
5
+ import { getNumOfSwitchClauses, switchHasConditionalBreak } from "../../utils/utils.js";
6
+
7
+ /**
8
+ * MISRA Rule 16.6: Every switch statement shall have at least two switch-clauses.
9
+ */
10
+ export default class Rule_16_6_SwitchMinTwoClauses extends MISRARule {
11
+
12
+ constructor(context: MISRAContext) {
13
+ super("16.6", context);
14
+ }
15
+
16
+ /**
17
+ * Checks if the given joinpoint is a switch statement with less than two clauses
18
+ * @param $jp - Joinpoint to analyze
19
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
20
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
21
+ */
22
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
23
+ if (!($jp instanceof Switch)) return false;
24
+
25
+ const nonCompliant = getNumOfSwitchClauses($jp) < 2;
26
+ if (nonCompliant && logErrors) {
27
+ this.logMISRAError($jp, "Switch statements should have at least two clauses.")
28
+ }
29
+ return nonCompliant;
30
+ }
31
+
32
+ /**
33
+ * Transforms a switch statement with less than two clauses into equivalent statement(s), only if there is no conditional break.
34
+ * If a conditional break is present, no transformation is performed and an error is generated.
35
+ *
36
+ * @param $jp - Joinpoint to transform
37
+ * @returns Report detailing the transformation result
38
+ */
39
+ transform($jp: Joinpoint): MISRATransformationReport {
40
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
41
+
42
+ if (switchHasConditionalBreak($jp as Switch)) {
43
+ this.logMISRAError($jp, "switch statement must have at least two clauses and cannot be transformed due to a conditional break statement.")
44
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
45
+ }
46
+
47
+ const transformResultNode = MISRASwitchConverter.convert($jp as Switch);
48
+ if (transformResultNode) {
49
+ return new MISRATransformationReport(
50
+ MISRATransformationType.Replacement,
51
+ transformResultNode
52
+ );
53
+ }
54
+ // Only breaks were present, so the switch was removed
55
+ return new MISRATransformationReport(MISRATransformationType.Removal);
56
+ }
57
+ }
@@ -0,0 +1,56 @@
1
+ import { BuiltinType, Joinpoint, Switch } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import { MISRASwitchConverter, MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
5
+ import { switchHasBooleanCondition, switchHasConditionalBreak } from "../../utils/utils.js";
6
+
7
+ /**
8
+ * MISRA Rule 16.7: A switch-expression shall not have essentially Boolean type.
9
+ */
10
+ export default class Rule_16_7_NonBooleanSwitchCondition extends MISRARule {
11
+ constructor(context: MISRAContext) {
12
+ super("16.7", context);
13
+ }
14
+
15
+ /**
16
+ * Checks if the given joinpoint is a switch statement with an essentially Boolean condition
17
+ * @param $jp - Joinpoint to analyze
18
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
19
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
20
+ */
21
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
22
+ if (!($jp instanceof Switch)) return false;
23
+
24
+ const booleanCondition = switchHasBooleanCondition($jp);
25
+ if (booleanCondition && logErrors) {
26
+ this.logMISRAError($jp, `Switch statement controlling expression ${$jp.condition.code} must not have essentially boolean type.`)
27
+ }
28
+ return booleanCondition;
29
+ }
30
+
31
+ /**
32
+ * Transforms a switch statement with a Boolean condition into equivalent statement(s), only if there is no conditional break.
33
+ * If a conditional break is present, no transformation is performed and an error is generated.
34
+ *
35
+ * @param $jp - Joinpoint to transform
36
+ * @returns Report detailing the transformation result
37
+ */
38
+ transform($jp: Joinpoint): MISRATransformationReport {
39
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
40
+
41
+ if (switchHasConditionalBreak($jp as Switch)) {
42
+ this.logMISRAError($jp, `The switch statement's controlling expression ${($jp as Switch).condition.code} must not be of a boolean type and cannot be transformed due to a conditional break statement.`)
43
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
44
+ }
45
+
46
+ const transformResultNode = MISRASwitchConverter.convert($jp as Switch);
47
+ if (transformResultNode) {
48
+ return new MISRATransformationReport(
49
+ MISRATransformationType.Replacement,
50
+ transformResultNode
51
+ );
52
+ }
53
+ // Only breaks were present, so the switch was removed
54
+ return new MISRATransformationReport(MISRATransformationType.Removal);
55
+ }
56
+ }
@@ -0,0 +1,78 @@
1
+ import { BuiltinType, Call, EnumDecl, ExprStmt, FunctionJp, Joinpoint, ReturnStmt } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
5
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
6
+ import Query from "@specs-feup/lara/api/weaver/Query.js";
7
+
8
+ /**
9
+ * MISRA Rule 17.4: All exit paths from a function with non-void return type shall have an
10
+ explicit return statement with an expression. In a non-void function:
11
+ - Every return statement has an expression, and a
12
+ - Control cannot reach the end of the function without encountering a return statement
13
+ */
14
+ export default class Rule_17_4_NonVoidReturn extends MISRARule {
15
+ constructor(context: MISRAContext) {
16
+ super("17.4", context);
17
+ }
18
+
19
+ /**
20
+ * Checks if the given joinpoint represents a non-void function that lacks an explicit return statement with an expression.
21
+ *
22
+ * @param $jp - Joinpoint to analyze
23
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
24
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
25
+ */
26
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
27
+ if (!($jp instanceof FunctionJp && $jp.isImplementation)) return false;
28
+
29
+ if ($jp.returnType instanceof BuiltinType && $jp.returnType.isVoid) return false;
30
+
31
+ const emptyReturnStms = Query.searchFrom($jp, ReturnStmt, {returnExpr: undefined}).get();
32
+ const exitReturn = $jp.body.children.filter(child => child instanceof ReturnStmt && !emptyReturnStms.includes(child))[0];
33
+ if (logErrors) {
34
+ emptyReturnStms?.forEach(emptyReturn =>
35
+ this.logMISRAError(emptyReturn, "Every return statement in a non-void function must include an expression.")
36
+ )
37
+ if (exitReturn === undefined) {
38
+ this.logMISRAError($jp, `Function '${$jp.name}' reaches the end without a return statement.`)
39
+ }
40
+ }
41
+ return emptyReturnStms.length > 0 || exitReturn === undefined;
42
+ }
43
+
44
+ /**
45
+ * Transforms a non-void function joinpoint that has no return statement at the end, by adding a default return value based on the config file.
46
+ * - If the configuration file is is missing or invalid, no transformation is performed.
47
+ * - Otherwise, a return statement is inserted as the last statement of the function.
48
+ *
49
+ * @param $jp - Joinpoint to transform
50
+ * @returns Report detailing the transformation result
51
+ */
52
+ transform($jp: Joinpoint): MISRATransformationReport {
53
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
54
+
55
+ const functionJp = $jp as FunctionJp;
56
+ if (this.context.config) {
57
+ try {
58
+ const returnType = functionJp.type.code;
59
+ const defaultValueReturn = this.context.config.get("defaultValues")[returnType];
60
+
61
+ if (defaultValueReturn === undefined) {
62
+ this.logMISRAError($jp, `Function '${functionJp.name}' reaches the end without a return statement. Default value return not added due to missing default value configuration for type '${returnType}'.`);
63
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
64
+ }
65
+ const newJp = ClavaJoinPoints.returnStmt(ClavaJoinPoints.exprLiteral(String(defaultValueReturn), functionJp.returnType)) as ReturnStmt;
66
+ functionJp.body.lastChild ? functionJp.body.lastChild.insertAfter(newJp) : functionJp.body.setFirstChild(newJp);
67
+
68
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
69
+
70
+ } catch (error) {
71
+ this.logMISRAError($jp, `Function '${functionJp.name}' reaches the end without a return statement. Default value return not added due to invalid structure of configuration file.`);
72
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
73
+ }
74
+ }
75
+ this.logMISRAError($jp, `Function '${functionJp.name}' reaches the end without a return statement. Default value return not added due to missing config file.`)
76
+ return new MISRATransformationReport(MISRATransformationType.NoChange);
77
+ }
78
+ }
@@ -0,0 +1,68 @@
1
+ import { AdjustedType, ArrayType, FunctionJp, Joinpoint, Param } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
5
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
6
+ import { getParamReferences } from "../../utils/utils.js";
7
+
8
+ /**
9
+ * MISRA Rule 17.6: The declaration of an array parameter shall not contain the static keyword between the [ ]
10
+ */
11
+ export default class Rule_17_6_StaticArraySizeParam extends MISRARule {
12
+ #invalidParams: Param[] = [];
13
+ constructor(context: MISRAContext) {
14
+ super("17.6", context);
15
+ }
16
+
17
+ /**
18
+ * Checks if the given joinpoint represents a function with any array parameter containing the 'static' keyword between the [ ].
19
+ *
20
+ * @param $jp - Joinpoint to analyze
21
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
22
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
23
+ */
24
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
25
+ if (!($jp instanceof FunctionJp) || $jp.root.standard === "c90") return false;
26
+
27
+ this.#invalidParams = $jp.params.filter(paramJp => paramJp.type instanceof AdjustedType &&
28
+ paramJp.type.originalType instanceof ArrayType &&
29
+ paramJp.type.originalType.arraySize !== -1 &&
30
+ /\[\s*static\s+\d+\s*\]/.test(paramJp.code)
31
+ );
32
+
33
+ if (logErrors) {
34
+ for (const invalidParam of this.#invalidParams) {
35
+ this.logMISRAError(invalidParam, `The 'static' keyword cannot appear inside the square brackets ('[]') in array parameter declarations.`)
36
+ }
37
+ }
38
+ return this.#invalidParams.length > 0;
39
+ }
40
+
41
+ /**
42
+ * Transforms the joinpoint if it represents a function with any array parameter containing the 'static' keyword between the square brackets.
43
+ *
44
+ * @param $jp - Joinpoint to transform
45
+ * @returns Report detailing the transformation result
46
+ */
47
+ transform($jp: Joinpoint): MISRATransformationReport {
48
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
49
+
50
+ for (const invalidParam of this.#invalidParams) {
51
+ const paramRefs = getParamReferences(invalidParam, $jp);
52
+
53
+ // Replace the parameter with a new array parameter whose size is variant
54
+ const originalType = (invalidParam.type as AdjustedType).originalType;
55
+ const newJp = ClavaJoinPoints.param(
56
+ invalidParam.name,
57
+ ClavaJoinPoints.incompleteArrayType((originalType as ArrayType).elementType)
58
+ );
59
+ const newParam = invalidParam.replaceWith(newJp) as Param;
60
+
61
+ // Replace all references to the invalid parameter with the new one
62
+ for (const ref of paramRefs) {
63
+ ref.replaceWith(newParam.varref());
64
+ }
65
+ }
66
+ return new MISRATransformationReport(MISRATransformationType.DescendantChange);
67
+ }
68
+ }
@@ -0,0 +1,47 @@
1
+ import { BuiltinType, Call, ExprStmt, Joinpoint } from "@specs-feup/clava/api/Joinpoints.js";
2
+ import MISRARule from "../../MISRARule.js";
3
+ import MISRAContext from "../../MISRAContext.js";
4
+ import ClavaJoinPoints from "@specs-feup/clava/api/clava/ClavaJoinPoints.js";
5
+ import { MISRATransformationReport, MISRATransformationType } from "../../MISRA.js";
6
+
7
+ /**
8
+ * MISRA Rule 17.7: The value returned by a function having non-void return type shall be
9
+ used
10
+ */
11
+ export default class Rule_17_7_UnusedReturnValue extends MISRARule {
12
+ constructor(context: MISRAContext) {
13
+ super("17.7", context);
14
+ }
15
+
16
+ /**
17
+ * Checks if the given joinpoint represents a non-void function call with an unused return value.
18
+ *
19
+ * @param $jp - Joinpoint to analyze
20
+ * @param logErrors - [logErrors=false] - Whether to log errors if a violation is detected
21
+ * @returns Returns true if the joinpoint violates the rule, false otherwise
22
+ */
23
+ match($jp: Joinpoint, logErrors: boolean = false): boolean {
24
+ if (!($jp instanceof Call)) return false;
25
+
26
+ if ($jp.returnType instanceof BuiltinType && $jp.returnType.isVoid) return false;
27
+
28
+ if ($jp.parent instanceof ExprStmt && logErrors) {
29
+ this.logMISRAError($jp,`Return value of ${$jp.signature} must be used. It can be discarded with an explicit cast to void.`);
30
+ }
31
+ return $jp.parent instanceof ExprStmt;
32
+ }
33
+
34
+ /**
35
+ * Transforms the joinpoint if it represents a non-void function call, whose return type is unused.
36
+ * It ensures that the return value is explicitly cast to void.
37
+ *
38
+ * @param $jp - Joinpoint to transform
39
+ * @returns Report detailing the transformation result
40
+ */
41
+ transform($jp: Joinpoint): MISRATransformationReport {
42
+ if (!this.match($jp)) return new MISRATransformationReport(MISRATransformationType.NoChange);
43
+
44
+ const newJp = ClavaJoinPoints.cStyleCast(ClavaJoinPoints.type("void"), $jp as Call);
45
+ return new MISRATransformationReport(MISRATransformationType.Replacement, $jp.replaceWith(newJp));
46
+ }
47
+ }