mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Ivan Krysak
c6e38cd485
Because of how name builders used to lazy gather namespaces on the first requested name, the objects were self mutating. As such only non-const references could be used to pass them around. Since that is no longer the case, this restores most of lost const qualifiers.
84 lines
2.5 KiB
C++
84 lines
2.5 KiB
C++
#pragma once
|
|
|
|
//
|
|
// This file is distributed under the MIT License. See LICENSE.md for details.
|
|
//
|
|
|
|
#include <string>
|
|
|
|
#include "revng/PTML/Tag.h"
|
|
#include "revng/Pipeline/Location.h"
|
|
#include "revng/Support/BasicBlockID.h"
|
|
|
|
class MetaAddress;
|
|
namespace model {
|
|
class Binary;
|
|
}
|
|
namespace yield {
|
|
class Function;
|
|
}
|
|
|
|
namespace ptml {
|
|
class MarkupBuilder;
|
|
}
|
|
|
|
namespace yield::ptml {
|
|
|
|
std::string functionAssembly(const ::ptml::MarkupBuilder &B,
|
|
const yield::Function &InternalFunction,
|
|
const model::Binary &Binary);
|
|
std::string controlFlowNode(const ::ptml::MarkupBuilder &B,
|
|
const BasicBlockID &BasicBlock,
|
|
const yield::Function &Function,
|
|
const model::Binary &Binary);
|
|
|
|
/// Emits a PTML containing a function name marked as a definition (it can be
|
|
/// jumped to).
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.function"
|
|
/// data-location-definition="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string functionNameDefinition(const ::ptml::MarkupBuilder &B,
|
|
llvm::StringRef Location,
|
|
const model::Binary &Binary,
|
|
const model::AssemblyNameBuilder &Builder);
|
|
|
|
/// Emits a PTML containing a function name marked as a reference
|
|
/// (it can be used to jump to any definition of the same function).
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.function"
|
|
/// data-location-references="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string functionLink(const ::ptml::MarkupBuilder &B,
|
|
llvm::StringRef Location,
|
|
const model::Binary &Binary,
|
|
const model::AssemblyNameBuilder &NameBuilder);
|
|
|
|
/// Emits a PTML containing a function name marked as a reference
|
|
/// \see functionLink
|
|
///
|
|
/// The only difference is that it uses a distinct token type to let clients
|
|
/// display it in a visually distinct way.
|
|
///
|
|
/// For example,
|
|
/// ```html
|
|
/// <div data-token="call-graph.shallow-function-link"
|
|
/// data-location-references="$FUNCTION_LOCATION">
|
|
/// $FUNCTION_NAME
|
|
/// </div>
|
|
/// ```
|
|
std::string shallowFunctionLink(const ::ptml::MarkupBuilder &B,
|
|
llvm::StringRef Location,
|
|
const model::Binary &Binary,
|
|
const model::AssemblyNameBuilder &NameBuilder);
|
|
|
|
} // namespace yield::ptml
|