feat: Require that *_free functions are nullable.

These should always be no-ops when passed a null pointer.
TokTok · Apr 2, 2022 · a2dde5f · a2dde5f
1 parent 391d878
commit a2dde5f
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/Tokstyle/Linter/NonNull.hs b/src/Tokstyle/Linter/NonNull.hs
@@ -59,13 +59,22 @@ checkParams file (indices -> nonnull) (indices -> nullable) params = do
           p:_ -> "`" <> showNode p <> "`"
 
 
+isDestructor :: Lexeme Text -> Bool
+isDestructor name =
+    "_free" `Text.isSuffixOf` lexemeText name ||
+    "_kill" `Text.isSuffixOf` lexemeText name
+
+
 linter :: AstActions (State Linter) Text
 linter = astActions
     { doNode = \file node act ->
         case unFix node of
             FunctionDecl Static (Fix (FunctionPrototype _ name _)) ->
                 State.modify $ \l@Linter{statics} -> l{statics = (lexemeText name, name) : statics}
 
+            NonNull _ [] (Fix (FunctionDecl _ (Fix (FunctionPrototype _ name [_])))) | isDestructor name ->
+                warn file name "destructor function (free/kill) must accept nullable arguments"
+
             NonNull nonnull nullable (Fix (FunctionDefn Static (Fix (FunctionPrototype _ name params)) _)) -> do
                 checkParams file nonnull nullable params
                 Linter{statics} <- State.get