[#llvm-TextCodeGenDataReader]
= xref:llvm.adoc[llvm]::TextCodeGenDataReader
:relfileprefix: ../
:mrdocs:

Reader for text codegen data suitable for test inputs.

== Synopsis

Declared in `<llvm/CGData/CodeGenDataReader.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class TextCodeGenDataReader
    : public xref:llvm/CodeGenDataReader.adoc[CodeGenDataReader]
----

== Description

The header is a custom format starting with `:` per line to indicate which codegen data is recorded. `#` is used to indicate a comment. The subsequent data is a YAML format per each codegen data in order. Currently, it only has a function outlined hash tree.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/CodeGenDataReader.adoc[CodeGenDataReader]`
| Abstract base class for reading codegen data from binary or text sources.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/TextCodeGenDataReader/2constructor-0d.adoc[`TextCodeGenDataReader`]         [.small]#[constructor]#
| Constructors
| xref:llvm/TextCodeGenDataReader/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Deleted copy assignment operator.
| xref:llvm/TextCodeGenDataReader/getDataKind.adoc[`getDataKind`]  [.small]#[virtual]#
| Return the codegen data kind.
| xref:llvm/TextCodeGenDataReader/getVersion.adoc[`getVersion`]  [.small]#[virtual]#
| Text format does not have version, so return 0.
| xref:llvm/TextCodeGenDataReader/hasOutlinedHashTree.adoc[`hasOutlinedHashTree`]  [.small]#[virtual]#
| Return true if the header indicates the data has an outlined hash tree. This does not mean that the data is still available.
| xref:llvm/TextCodeGenDataReader/hasStableFunctionMap.adoc[`hasStableFunctionMap`]  [.small]#[virtual]#
| Return true if the header indicates the data has a stable function map. This does not mean that the data is still available.
| xref:llvm/TextCodeGenDataReader/read.adoc[`read`]  [.small]#[virtual]#
| Read the contents including the header.
| xref:llvm/CodeGenDataReader/releaseOutlinedHashTree.adoc[`releaseOutlinedHashTree`] 
| Return the outlined hash tree that is released from the reader.
| xref:llvm/CodeGenDataReader/releaseStableFunctionMap.adoc[`releaseStableFunctionMap`] 
| Return the stable function map that is released from the reader.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/CodeGenDataReader/create-09.adoc[`create`] 
| `create` overloads
| xref:llvm/TextCodeGenDataReader/hasFormat.adoc[`hasFormat`] 
| Return true if the given buffer is in text codegen data format.
| xref:llvm/CodeGenDataReader/mergeFromObjectFile.adoc[`mergeFromObjectFile`] 
| Extract cgdata from object‐file sections and merge into global records.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/CodeGenDataReader/error-0e.adoc[`error`] 
| `error` overloads
| xref:llvm/CodeGenDataReader/success.adoc[`success`] 
| Clear the current error and return a successful one.
|===


== Protected Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/CodeGenDataReader/FunctionMapRecord.adoc[`FunctionMapRecord`] 
| The stable function map that has been read. When it's released by
| xref:llvm/CodeGenDataReader/HashTreeRecord.adoc[`HashTreeRecord`] 
| The outlined hash tree that has been read. When it's released by releaseOutlinedHashTree(), it's no longer valid.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#