[llvm] r275425 - [TableGen] Autobrief-ize Record. NFC.
Ahmed Bougacha via llvm-commits
llvm-commits at lists.llvm.org
Thu Jul 14 07:53:14 PDT 2016
Author: ab
Date: Thu Jul 14 09:53:14 2016
New Revision: 275425
URL: http://llvm.org/viewvc/llvm-project?rev=275425&view=rev
Log:
[TableGen] Autobrief-ize Record. NFC.
Modified:
llvm/trunk/include/llvm/TableGen/Record.h
llvm/trunk/lib/TableGen/Record.cpp
Modified: llvm/trunk/include/llvm/TableGen/Record.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/TableGen/Record.h?rev=275425&r1=275424&r2=275425&view=diff
==============================================================================
--- llvm/trunk/include/llvm/TableGen/Record.h (original)
+++ llvm/trunk/include/llvm/TableGen/Record.h Thu Jul 14 09:53:14 2016
@@ -66,11 +66,11 @@ public:
void print(raw_ostream &OS) const { OS << getAsString(); }
void dump() const;
- /// typeIsConvertibleTo - Return true if all values of 'this' type can be
- /// converted to the specified type.
+ /// Return true if all values of 'this' type can be converted to the specified
+ /// type.
virtual bool typeIsConvertibleTo(const RecTy *RHS) const;
- /// getListTy - Returns the type representing list<this>.
+ /// Returns the type representing list<this>.
ListRecTy *getListTy();
};
@@ -79,7 +79,7 @@ inline raw_ostream &operator<<(raw_ostre
return OS;
}
-/// BitRecTy - 'bit' - Represent a single bit
+/// 'bit' - Represent a single bit
///
class BitRecTy : public RecTy {
static BitRecTy Shared;
@@ -97,7 +97,7 @@ public:
bool typeIsConvertibleTo(const RecTy *RHS) const override;
};
-/// BitsRecTy - 'bits<n>' - Represent a fixed number of bits
+/// 'bits<n>' - Represent a fixed number of bits
///
class BitsRecTy : public RecTy {
unsigned Size;
@@ -117,7 +117,7 @@ public:
bool typeIsConvertibleTo(const RecTy *RHS) const override;
};
-/// CodeRecTy - 'code' - Represent a code fragment
+/// 'code' - Represent a code fragment
///
class CodeRecTy : public RecTy {
static CodeRecTy Shared;
@@ -133,7 +133,7 @@ public:
std::string getAsString() const override { return "code"; }
};
-/// IntRecTy - 'int' - Represent an integer value of no particular size
+/// 'int' - Represent an integer value of no particular size
///
class IntRecTy : public RecTy {
static IntRecTy Shared;
@@ -151,7 +151,7 @@ public:
bool typeIsConvertibleTo(const RecTy *RHS) const override;
};
-/// StringRecTy - 'string' - Represent an string value
+/// 'string' - Represent an string value
///
class StringRecTy : public RecTy {
static StringRecTy Shared;
@@ -168,7 +168,7 @@ public:
std::string getAsString() const override;
};
-/// ListRecTy - 'list<Ty>' - Represent a list of values, all of which must be of
+/// 'list<Ty>' - Represent a list of values, all of which must be of
/// the specified type.
///
class ListRecTy : public RecTy {
@@ -189,7 +189,7 @@ public:
bool typeIsConvertibleTo(const RecTy *RHS) const override;
};
-/// DagRecTy - 'dag' - Represent a dag fragment
+/// 'dag' - Represent a dag fragment
///
class DagRecTy : public RecTy {
static DagRecTy Shared;
@@ -205,7 +205,7 @@ public:
std::string getAsString() const override;
};
-/// RecordRecTy - '[classname]' - Represent an instance of a class, such as:
+/// '[classname]' - Represent an instance of a class, such as:
/// (R32 X = EAX).
///
class RecordRecTy : public RecTy {
@@ -227,7 +227,7 @@ public:
bool typeIsConvertibleTo(const RecTy *RHS) const override;
};
-/// resolveTypes - Find a common type that T1 and T2 convert to.
+/// Find a common type that T1 and T2 convert to.
/// Return 0 if no such type exists.
///
RecTy *resolveTypes(RecTy *T1, RecTy *T2);
@@ -292,30 +292,30 @@ protected:
public:
virtual ~Init() {}
- /// isComplete - This virtual method should be overridden by values that may
+ /// This virtual method should be overridden by values that may
/// not be completely specified yet.
virtual bool isComplete() const { return true; }
- /// print - Print out this value.
+ /// Print out this value.
void print(raw_ostream &OS) const { OS << getAsString(); }
- /// getAsString - Convert this value to a string form.
+ /// Convert this value to a string form.
virtual std::string getAsString() const = 0;
- /// getAsUnquotedString - Convert this value to a string form,
+ /// Convert this value to a string form,
/// without adding quote markers. This primaruly affects
/// StringInits where we will not surround the string value with
/// quotes.
virtual std::string getAsUnquotedString() const { return getAsString(); }
- /// dump - Debugging method that may be called through a debugger, just
+ /// Debugging method that may be called through a debugger, just
/// invokes print on stderr.
void dump() const;
- /// convertInitializerTo - This virtual function converts to the appropriate
+ /// This virtual function converts to the appropriate
/// Init based on the passed in type.
virtual Init *convertInitializerTo(RecTy *Ty) const = 0;
- /// convertInitializerBitRange - This method is used to implement the bitrange
+ /// This method is used to implement the bitrange
/// selection operator. Given an initializer, it selects the specified bits
/// out, returning them as a new init of bits type. If it is not legal to use
/// the bit subscript operator on this initializer, return null.
@@ -325,7 +325,7 @@ public:
return nullptr;
}
- /// convertInitListSlice - This method is used to implement the list slice
+ /// This method is used to implement the list slice
/// selection operator. Given an initializer, it selects the specified list
/// elements, returning them as a new init of list type. If it is not legal
/// to take a slice of this, return null.
@@ -335,7 +335,7 @@ public:
return nullptr;
}
- /// getFieldType - This method is used to implement the FieldInit class.
+ /// This method is used to implement the FieldInit class.
/// Implementors of this method should return the type of the named field if
/// they are of record type.
///
@@ -343,7 +343,7 @@ public:
return nullptr;
}
- /// getFieldInit - This method complements getFieldType to return the
+ /// This method complements getFieldType to return the
/// initializer for the specified field. If getFieldType returns non-null
/// this method should return non-null, otherwise it returns null.
///
@@ -352,7 +352,7 @@ public:
return nullptr;
}
- /// resolveReferences - This method is used by classes that refer to other
+ /// This method is used by classes that refer to other
/// variables which may not be defined at the time the expression is formed.
/// If a value is set for the variable later, this method will be called on
/// users of the value to allow the value to propagate out.
@@ -361,15 +361,15 @@ public:
return const_cast<Init *>(this);
}
- /// getBit - This method is used to return the initializer for the specified
+ /// This method is used to return the initializer for the specified
/// bit.
virtual Init *getBit(unsigned Bit) const = 0;
- /// getBitVar - This method is used to retrieve the initializer for bit
+ /// This method is used to retrieve the initializer for bit
/// reference. For non-VarBitInit, it simply returns itself.
virtual Init *getBitVar() const { return const_cast<Init*>(this); }
- /// getBitNum - This method is used to retrieve the bit number of a bit
+ /// This method is used to retrieve the bit number of a bit
/// reference. For non-VarBitInit, it simply returns 0.
virtual unsigned getBitNum() const { return 0; }
};
@@ -378,7 +378,7 @@ inline raw_ostream &operator<<(raw_ostre
I.print(OS); return OS;
}
-/// TypedInit - This is the common super-class of types that have a specific,
+/// This is the common super-class of types that have a specific,
/// explicit, type.
///
class TypedInit : public Init {
@@ -410,20 +410,20 @@ public:
Init *
convertInitListSlice(const std::vector<unsigned> &Elements) const override;
- /// getFieldType - This method is used to implement the FieldInit class.
+ /// This method is used to implement the FieldInit class.
/// Implementors of this method should return the type of the named field if
/// they are of record type.
///
RecTy *getFieldType(const std::string &FieldName) const override;
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
virtual Init *resolveListElementReference(Record &R, const RecordVal *RV,
unsigned Elt) const = 0;
};
-/// UnsetInit - ? - Represents an uninitialized value
+/// '?' - Represents an uninitialized value
///
class UnsetInit : public Init {
UnsetInit() : Init(IK_UnsetInit) {}
@@ -446,7 +446,7 @@ public:
std::string getAsString() const override { return "?"; }
};
-/// BitInit - true/false - Represent a concrete initializer for a bit.
+/// 'true'/'false' - Represent a concrete initializer for a bit.
///
class BitInit : public Init {
bool Value;
@@ -473,7 +473,7 @@ public:
std::string getAsString() const override { return Value ? "1" : "0"; }
};
-/// BitsInit - { a, b, c } - Represents an initializer for a BitsRecTy value.
+/// '{ a, b, c }' - Represents an initializer for a BitsRecTy value.
/// It contains a vector of bits, whose size is determined by the type.
///
class BitsInit final : public TypedInit, public FoldingSetNode,
@@ -515,7 +515,7 @@ public:
}
std::string getAsString() const override;
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -531,7 +531,7 @@ public:
}
};
-/// IntInit - 7 - Represent an initialization by a literal integer value.
+/// '7' - Represent an initialization by a literal integer value.
///
class IntInit : public TypedInit {
int64_t Value;
@@ -556,7 +556,7 @@ public:
std::string getAsString() const override;
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -569,7 +569,7 @@ public:
}
};
-/// StringInit - "foo" - Represent an initialization by a string value.
+/// "foo" - Represent an initialization by a string value.
///
class StringInit : public TypedInit {
std::string Value;
@@ -633,7 +633,7 @@ public:
std::string getAsUnquotedString() const override { return Value; }
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -646,7 +646,7 @@ public:
}
};
-/// ListInit - [AL, AH, CL] - Represent a list of defs
+/// [AL, AH, CL] - Represent a list of defs
///
class ListInit final : public TypedInit, public FoldingSetNode,
public TrailingObjects<BitsInit, Init *> {
@@ -685,7 +685,7 @@ public:
Init *convertInitializerTo(RecTy *Ty) const override;
- /// resolveReferences - This method is used by classes that refer to other
+ /// This method is used by classes that refer to other
/// variables which may not be defined at the time they expression is formed.
/// If a value is set for the variable later, this method will be called on
/// users of the value to allow the value to propagate out.
@@ -704,7 +704,7 @@ public:
size_t size () const { return NumValues; }
bool empty() const { return NumValues == 0; }
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -715,7 +715,7 @@ public:
}
};
-/// OpInit - Base class for operators
+/// Base class for operators
///
class OpInit : public TypedInit {
OpInit(const OpInit &Other) = delete;
@@ -746,7 +746,7 @@ public:
Init *getBit(unsigned Bit) const override;
};
-/// UnOpInit - !op (X) - Transform an init.
+/// !op (X) - Transform an init.
///
class UnOpInit : public OpInit, public FoldingSetNode {
public:
@@ -794,7 +794,7 @@ public:
std::string getAsString() const override;
};
-/// BinOpInit - !op (X, Y) - Combine two inits.
+/// !op (X, Y) - Combine two inits.
///
class BinOpInit : public OpInit, public FoldingSetNode {
public:
@@ -848,7 +848,7 @@ public:
std::string getAsString() const override;
};
-/// TernOpInit - !op (X, Y, Z) - Combine two inits.
+/// !op (X, Y, Z) - Combine two inits.
///
class TernOpInit : public OpInit, public FoldingSetNode {
public:
@@ -908,7 +908,7 @@ public:
std::string getAsString() const override;
};
-/// VarInit - 'Opcode' - Represent a reference to an entire variable object.
+/// 'Opcode' - Represent a reference to an entire variable object.
///
class VarInit : public TypedInit {
Init *VarName;
@@ -939,7 +939,7 @@ public:
Init *getFieldInit(Record &R, const RecordVal *RV,
const std::string &FieldName) const override;
- /// resolveReferences - This method is used by classes that refer to other
+ /// This method is used by classes that refer to other
/// variables which may not be defined at the time they expression is formed.
/// If a value is set for the variable later, this method will be called on
/// users of the value to allow the value to propagate out.
@@ -951,7 +951,7 @@ public:
std::string getAsString() const override { return getName(); }
};
-/// VarBitInit - Opcode{0} - Represent access to one bit of a variable or field.
+/// Opcode{0} - Represent access to one bit of a variable or field.
///
class VarBitInit : public Init {
TypedInit *TI;
@@ -988,7 +988,7 @@ public:
}
};
-/// VarListElementInit - List[4] - Represent access to one element of a var or
+/// List[4] - Represent access to one element of a var or
/// field.
class VarListElementInit : public TypedInit {
TypedInit *TI;
@@ -1014,7 +1014,7 @@ public:
TypedInit *getVariable() const { return TI; }
unsigned getElementNum() const { return Element; }
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -1026,7 +1026,7 @@ public:
Init *getBit(unsigned Bit) const override;
};
-/// DefInit - AL - Represent a reference to a 'def' in the description
+/// AL - Represent a reference to a 'def' in the description
///
class DefInit : public TypedInit {
Record *Def;
@@ -1059,7 +1059,7 @@ public:
llvm_unreachable("Illegal bit reference off def");
}
- /// resolveListElementReference - This method is used to implement
+ /// This method is used to implement
/// VarListElementInit::resolveReferences. If the list element is resolvable
/// now, we return the resolved value, otherwise we return null.
Init *resolveListElementReference(Record &R, const RecordVal *RV,
@@ -1068,7 +1068,7 @@ public:
}
};
-/// FieldInit - X.Y - Represent a reference to a subfield of a variable
+/// X.Y - Represent a reference to a subfield of a variable
///
class FieldInit : public TypedInit {
Init *Rec; // Record we are referring to
@@ -1100,7 +1100,7 @@ public:
}
};
-/// DagInit - (v a, b) - Represent a DAG tree value. DAG inits are required
+/// (v a, b) - Represent a DAG tree value. DAG inits are required
/// to have at least one value then a (possibly empty) list of arguments. Each
/// argument can have a name associated with it.
///
@@ -1388,12 +1388,12 @@ public:
SuperClasses.push_back(std::make_pair(R, Range));
}
- /// resolveReferences - If there are any field references that refer to fields
+ /// If there are any field references that refer to fields
/// that have been filled in, we can propagate the values now.
///
void resolveReferences() { resolveReferencesTo(nullptr); }
- /// resolveReferencesTo - If anything in this record refers to RV, replace the
+ /// If anything in this record refers to RV, replace the
/// reference to RV with the RHS of RV. If RV is null, we resolve all
/// possible references.
void resolveReferencesTo(const RecordVal *RV);
@@ -1420,7 +1420,7 @@ public:
// High-level methods useful to tablegen back-ends
//
- /// getValueInit - Return the initializer for a value with the specified name,
+ /// Return the initializer for a value with the specified name,
/// or throw an exception if the field does not exist.
///
Init *getValueInit(StringRef FieldName) const;
@@ -1430,67 +1430,67 @@ public:
return isa<UnsetInit>(getValueInit(FieldName));
}
- /// getValueAsString - This method looks up the specified field and returns
+ /// This method looks up the specified field and returns
/// its value as a string, throwing an exception if the field does not exist
/// or if the value is not a string.
///
std::string getValueAsString(StringRef FieldName) const;
- /// getValueAsBitsInit - This method looks up the specified field and returns
+ /// This method looks up the specified field and returns
/// its value as a BitsInit, throwing an exception if the field does not exist
/// or if the value is not the right type.
///
BitsInit *getValueAsBitsInit(StringRef FieldName) const;
- /// getValueAsListInit - This method looks up the specified field and returns
+ /// This method looks up the specified field and returns
/// its value as a ListInit, throwing an exception if the field does not exist
/// or if the value is not the right type.
///
ListInit *getValueAsListInit(StringRef FieldName) const;
- /// getValueAsListOfDefs - This method looks up the specified field and
+ /// This method looks up the specified field and
/// returns its value as a vector of records, throwing an exception if the
/// field does not exist or if the value is not the right type.
///
std::vector<Record*> getValueAsListOfDefs(StringRef FieldName) const;
- /// getValueAsListOfInts - This method looks up the specified field and
+ /// This method looks up the specified field and
/// returns its value as a vector of integers, throwing an exception if the
/// field does not exist or if the value is not the right type.
///
std::vector<int64_t> getValueAsListOfInts(StringRef FieldName) const;
- /// getValueAsListOfStrings - This method looks up the specified field and
+ /// This method looks up the specified field and
/// returns its value as a vector of strings, throwing an exception if the
/// field does not exist or if the value is not the right type.
///
std::vector<std::string> getValueAsListOfStrings(StringRef FieldName) const;
- /// getValueAsDef - This method looks up the specified field and returns its
+ /// This method looks up the specified field and returns its
/// value as a Record, throwing an exception if the field does not exist or if
/// the value is not the right type.
///
Record *getValueAsDef(StringRef FieldName) const;
- /// getValueAsBit - This method looks up the specified field and returns its
+ /// This method looks up the specified field and returns its
/// value as a bit, throwing an exception if the field does not exist or if
/// the value is not the right type.
///
bool getValueAsBit(StringRef FieldName) const;
- /// getValueAsBitOrUnset - This method looks up the specified field and
+ /// This method looks up the specified field and
/// returns its value as a bit. If the field is unset, sets Unset to true and
/// returns false.
///
bool getValueAsBitOrUnset(StringRef FieldName, bool &Unset) const;
- /// getValueAsInt - This method looks up the specified field and returns its
+ /// This method looks up the specified field and returns its
/// value as an int64_t, throwing an exception if the field does not exist or
/// if the value is not the right type.
///
int64_t getValueAsInt(StringRef FieldName) const;
- /// getValueAsDag - This method looks up the specified field and returns its
+ /// This method looks up the specified field and returns its
/// value as an Dag, throwing an exception if the field does not exist or if
/// the value is not the right type.
///
@@ -1542,7 +1542,7 @@ public:
//===--------------------------------------------------------------------===//
// High-level helper methods, useful for tablegen backends...
- /// getAllDerivedDefinitions - This method returns all concrete definitions
+ /// This method returns all concrete definitions
/// that derive from the specified class name. A class with the specified
/// name must exist.
std::vector<Record *>
@@ -1551,7 +1551,7 @@ public:
void dump() const;
};
-/// LessRecord - Sorting predicate to sort record pointers by name.
+/// Sorting predicate to sort record pointers by name.
///
struct LessRecord {
bool operator()(const Record *Rec1, const Record *Rec2) const {
@@ -1559,7 +1559,7 @@ struct LessRecord {
}
};
-/// LessRecordByID - Sorting predicate to sort record pointers by their
+/// Sorting predicate to sort record pointers by their
/// unique ID. If you just need a deterministic order, use this, since it
/// just compares two `unsigned`; the other sorting predicates require
/// string manipulation.
@@ -1569,7 +1569,7 @@ struct LessRecordByID {
}
};
-/// LessRecordFieldName - Sorting predicate to sort record pointers by their
+/// Sorting predicate to sort record pointers by their
/// name field.
///
struct LessRecordFieldName {
@@ -1659,12 +1659,12 @@ struct LessRecordRegister {
raw_ostream &operator<<(raw_ostream &OS, const RecordKeeper &RK);
-/// QualifyName - Return an Init with a qualifier prefix referring
+/// Return an Init with a qualifier prefix referring
/// to CurRec's name.
Init *QualifyName(Record &CurRec, MultiClass *CurMultiClass,
Init *Name, const std::string &Scoper);
-/// QualifyName - Return an Init with a qualifier prefix referring
+/// Return an Init with a qualifier prefix referring
/// to CurRec's name.
Init *QualifyName(Record &CurRec, MultiClass *CurMultiClass,
const std::string &Name, const std::string &Scoper);
Modified: llvm/trunk/lib/TableGen/Record.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/TableGen/Record.cpp?rev=275425&r1=275424&r2=275425&view=diff
==============================================================================
--- llvm/trunk/lib/TableGen/Record.cpp (original)
+++ llvm/trunk/lib/TableGen/Record.cpp Thu Jul 14 09:53:14 2016
@@ -32,8 +32,8 @@ using namespace llvm;
namespace llvm {
-/// TableGenStringKey - This is a wrapper for std::string suitable for
-/// using as a key to a DenseMap. Because there isn't a particularly
+/// This is a wrapper for std::string suitable for using as a key to a DenseMap.
+/// Because there isn't a particularly
/// good way to indicate tombstone or empty keys for strings, we want
/// to wrap std::string to indicate that this is a "special" string
/// not expected to take on certain values (those of the tombstone and
More information about the llvm-commits
mailing list