From: Chris Lattner Date: Fri, 6 Sep 2002 21:31:57 +0000 (+0000) Subject: * Clean up some comments X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=fab8c796f6754962f5732145248303e3a1f7b96b;p=oota-llvm.git * Clean up some comments * Move code out of header file to .cpp files, to make future changes easier * Add arguments to classes so that they can be automatically inserted into their parent structure upon creation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3604 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/include/llvm/Argument.h b/include/llvm/Argument.h index 7a9acdab1dd..03690ea37e6 100644 --- a/include/llvm/Argument.h +++ b/include/llvm/Argument.h @@ -1,7 +1,7 @@ //===-- llvm/Argument.h - Definition of the Argument class -------*- C++ -*--=// // // This file defines the Argument class, which represents and incoming formal -// argument to a function. +// argument to a Function. // //===----------------------------------------------------------------------===// @@ -10,20 +10,20 @@ #include "llvm/Value.h" -class Argument : public Value { // Defined in the InstrType.cpp file +class Argument : public Value { // Defined in the Function.cpp file Function *Parent; Argument *Prev, *Next; // Next and Prev links for our intrusive linked list void setNext(Argument *N) { Next = N; } void setPrev(Argument *N) { Prev = N; } friend class SymbolTableListTraits; - inline void setParent(Function *parent) { Parent = parent; } + void setParent(Function *parent); public: - Argument(const Type *Ty, const std::string &Name = "") - : Value(Ty, Value::ArgumentVal, Name) { - Parent = 0; - } + /// Argument ctor - If Function argument is specified, this argument is + /// inserted at the end of the argument list for the function. + /// + Argument(const Type *Ty, const std::string &Name = "", Function *F = 0); /// setName - Specialize setName to handle symbol table majik... virtual void setName(const std::string &name, SymbolTable *ST = 0); diff --git a/include/llvm/BasicBlock.h b/include/llvm/BasicBlock.h index bf0e19d8026..e545a575262 100644 --- a/include/llvm/BasicBlock.h +++ b/include/llvm/BasicBlock.h @@ -44,7 +44,7 @@ private : InstListType InstList; BasicBlock *Prev, *Next; // Next and Prev links for our intrusive linked list - void setParent(Function *parent) { InstList.setParent(parent); } + void setParent(Function *parent); void setNext(BasicBlock *N) { Next = N; } void setPrev(BasicBlock *N) { Prev = N; } friend class SymbolTableListTraits; @@ -53,20 +53,23 @@ private : void operator=(const BasicBlock &); // Do not implement public: - // Instruction iterators... + /// Instruction iterators... typedef InstListType::iterator iterator; typedef InstListType::const_iterator const_iterator; typedef std::reverse_iterator const_reverse_iterator; typedef std::reverse_iterator reverse_iterator; - // Ctor, dtor + /// BasicBlock ctor - If the function parameter is specified, the basic block + /// is automatically inserted at the end of the function. + /// BasicBlock(const std::string &Name = "", Function *Parent = 0); ~BasicBlock(); // Specialize setName to take care of symbol table majik virtual void setName(const std::string &name, SymbolTable *ST = 0); - // getParent - Return the enclosing method, or null if none + /// getParent - Return the enclosing method, or null if none + /// const Function *getParent() const { return InstList.getParent(); } Function *getParent() { return InstList.getParent(); } @@ -94,8 +97,8 @@ public: //===--------------------------------------------------------------------===// - // Instruction iterator methods - // + /// Instruction iterator methods + /// inline iterator begin() { return InstList.begin(); } inline const_iterator begin() const { return InstList.begin(); } inline iterator end () { return InstList.end(); } diff --git a/include/llvm/Function.h b/include/llvm/Function.h index 5976745c3e6..4c0e0ec5235 100644 --- a/include/llvm/Function.h +++ b/include/llvm/Function.h @@ -22,7 +22,7 @@ template<> struct ilist_traits : public SymbolTableListTraits { // createNode is used to create a node that marks the end of the list... - static BasicBlock *createNode() { return new BasicBlock(); } + static BasicBlock *createNode(); static iplist &getList(Function *F); }; diff --git a/include/llvm/GlobalValue.h b/include/llvm/GlobalValue.h index 0e17f3603ca..56e4a3e28a1 100644 --- a/include/llvm/GlobalValue.h +++ b/include/llvm/GlobalValue.h @@ -1,7 +1,7 @@ //===-- llvm/GlobalValue.h - Class to represent a global value ---*- C++ -*--=// // // This file is a common base class of all globally definable objects. As such, -// it is subclassed by GlobalVariable and by Method. This is used because you +// it is subclassed by GlobalVariable and by Function. This is used because you // can do certain things with these global objects that you can't do to anything // else. For example, use the address of one as a constant. // diff --git a/include/llvm/GlobalVariable.h b/include/llvm/GlobalVariable.h index 2e2dd2bb41d..fd5e3a69241 100644 --- a/include/llvm/GlobalVariable.h +++ b/include/llvm/GlobalVariable.h @@ -24,7 +24,7 @@ template >; - void setParent(Module *parent) { Parent = parent; } + void setParent(Module *parent); GlobalVariable *Prev, *Next; void setNext(GlobalVariable *N) { Next = N; } @@ -32,9 +32,12 @@ class GlobalVariable : public GlobalValue { bool isConstantGlobal; // Is this a global constant? public: + /// GlobalVariable ctor - If a parent module is specified, the global is + /// automatically inserted into the end of the specified modules global list. + /// GlobalVariable(const Type *Ty, bool isConstant, bool isInternal, - Constant *Initializer = 0, const std::string &Name = ""); - ~GlobalVariable() {} + Constant *Initializer = 0, const std::string &Name = "", + Module *Parent = 0); // Specialize setName to handle symbol table majik... virtual void setName(const std::string &name, SymbolTable *ST = 0); diff --git a/include/llvm/Instruction.h b/include/llvm/Instruction.h index 805371bd157..8dd9f63b693 100644 --- a/include/llvm/Instruction.h +++ b/include/llvm/Instruction.h @@ -1,7 +1,7 @@ //===-- llvm/Instruction.h - Instruction class definition --------*- C++ -*--=// // // This file contains the declaration of the Instruction class, which is the -// base class for all of the VM instructions. +// base class for all of the LLVM instructions. // //===----------------------------------------------------------------------===// @@ -22,9 +22,9 @@ class Instruction : public User { friend class SymbolTableListTraits >; - inline void setParent(BasicBlock *P) { Parent = P; } + void setParent(BasicBlock *P); protected: - unsigned iType; // InstructionType + unsigned iType; // InstructionType: The opcode of the instruction public: Instruction(const Type *Ty, unsigned iType, const std::string &Name = ""); virtual ~Instruction() {