llvm-journey

commit 28f174d300700d5a8b1ca105d197e092af2dc4f0
parent fa8d0f1cfd9f933499bb2ad0331fb8442e862981
Author: Mohammad-Reza Nabipoor <m.nabipoor@yahoo.com>
Date:   Fri,  2 Oct 2020 02:14:43 +0330

kaleidoscope_codegen.hpp: Document pre-conditions

Diffstat:
M
kaleidoscope_codegen.hpp
 | 
14
++++++++------

1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/kaleidoscope_codegen.hpp b/kaleidoscope_codegen.hpp
@@ -25,17 +25,19 @@ llvm::Value*
 codegen(const BinaryOp&);
 llvm::Value*
 codegen(const Call&);
-
-class ASTNode;
-
-llvm::Value*
-codegen(const ASTNode&);
-
 llvm::Function*
 codegen(const Prototype&);
 llvm::Function*
 codegen(const Function&);
 
+class ASTNode;
+
+// pre-condition: kal::node_type(n) != kal::NodeType::None
+// pre-condition: kal::node_type(n) != kal::NodeType::Prototype
+// pre-condition: kal::node_type(n) != kal::NodeType::Function
+llvm::Value*
+codegen(const ASTNode& n);
+
 llvm::Function*
 mkfunc(const std::string& name, kal::ASTNode* f, kal::ASTNode* l);