mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Djordje Todorovic
f05c08547d
By using this class we can create ptml::Tags without XML tags. It is useful in the revng-c part when we want to generate Plain C. All PTML Tags, from now on, should be created via this class only. In addition, port `Yield` library to be using this.
81 lines
2.4 KiB
C++
81 lines
2.4 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 PTMLBuilder;
|
|
}
|
|
|
|
namespace yield::ptml {
|
|
|
|
std::string functionAssembly(const ::ptml::PTMLBuilder &ThePTMLBuilder,
|
|
const yield::Function &InternalFunction,
|
|
const model::Binary &Binary);
|
|
std::string controlFlowNode(const ::ptml::PTMLBuilder &ThePTMLBuilder,
|
|
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::PTMLBuilder &ThePTMLBuilder,
|
|
std::string_view Location,
|
|
const model::Binary &Binary);
|
|
|
|
/// 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::PTMLBuilder &ThePTMLBuilder,
|
|
std::string_view Location,
|
|
const model::Binary &Binary);
|
|
|
|
/// 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::PTMLBuilder &ThePTMLBuilder,
|
|
std::string_view Location,
|
|
const model::Binary &Binary);
|
|
|
|
} // namespace yield::ptml
|