Skip to content

Commit

Permalink
Provide new type annotations (#20)
Browse files Browse the repository at this point in the history 
Closes #20

New type annotations were implemented for the new cutter plugin.
This commit provides integration of those changes in r2plugin.
  • Loading branch information
Peter Kubov committed Aug 18, 2020
1 parent 4a67316 commit d5dc509
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 18 deletions.
16 changes: 16 additions & 0 deletions include/r2plugin/r2cgen.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
#include <optional>
#include <rapidjson/document.h>

#include <retdec/common/address.h>
#include <r_util/r_annotated_code.h>

namespace retdec {
Expand All @@ -22,6 +23,21 @@ class R2CGenerator {

protected:
RAnnotatedCode* provideAnnotations(const rapidjson::Document &root) const;
void annotate(
RAnnotatedCode* code,
const common::Address& binAdress,
const common::AddressRange& inCode) const;

void annotate(
RAnnotatedCode* code,
const RSyntaxHighlightType& high,
const common::AddressRange& inCode) const;

std::optional<RCodeAnnotation> specialAnnotation(
const std::string& kind,
const std::string& val,
const std::optional<common::Address>& address) const;

std::optional<RSyntaxHighlightType> highlightTypeForToken(const std::string &token) const;

private:
Expand Down
123 changes: 105 additions & 18 deletions src/r2plugin/r2cgen.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ std::map<const std::string, RSyntaxHighlightType> R2CGenerator::_hig2token = {
// {"punc", ... }
// {"op", ... }
{"i_var", R_SYNTAX_HIGHLIGHT_TYPE_GLOBAL_VARIABLE},
// {"i_var", R_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE},
{"i_lvar", R_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE},
// {"i_mem", R_SYNTAX_HIGHLIGHT_TYPE_DATATYPE},
{"i_lab", R_SYNTAX_HIGHLIGHT_TYPE_KEYWORD},
{"i_fnc", R_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_NAME},
Expand Down Expand Up @@ -66,7 +66,7 @@ RAnnotatedCode* R2CGenerator::provideAnnotations(const rapidjson::Document &root
}

std::ostringstream planecode;
std::optional<unsigned long> lastAddr;
std::optional<common::Address> lastAddr;

if (!root["tokens"].IsArray()) {
throw DecompilationError("malformed JSON");
Expand All @@ -89,27 +89,29 @@ RAnnotatedCode* R2CGenerator::provideAnnotations(const rapidjson::Document &root
continue;
}
else if (token.HasMember("val") && token.HasMember("kind")) {
// Beginning position in the code.
unsigned long bpos = planecode.tellp();
planecode << token["val"].GetString();
// Ending position in the code
unsigned long epos = planecode.tellp();

if (lastAddr.has_value()) {
RCodeAnnotation annotation = {};
annotation.type = R_CODE_ANNOTATION_TYPE_OFFSET;
annotation.offset.offset = lastAddr.value();
annotation.start = bpos;
annotation.end = epos;
r_annotated_code_add_annotation(code, &annotation);
}
if (lastAddr.has_value())
annotate(code, lastAddr.value(), {bpos, epos});

auto highlight = highlightTypeForToken(token["kind"].GetString());
if (highlight.has_value())
annotate(code, highlight.value(), {bpos, epos});

auto special = specialAnnotation(
token["kind"].GetString(),
token["val"].GetString(),
lastAddr);

auto higlight = highlightTypeForToken(token["kind"].GetString());
if (higlight.has_value()) {
RCodeAnnotation annotation = {};
annotation.type = R_CODE_ANNOTATION_TYPE_SYNTAX_HIGHLIGHT;
annotation.syntax_highlight.type = higlight.value();
annotation.start = bpos;
annotation.end = epos;
r_annotated_code_add_annotation(code, &annotation);
if (special.has_value()) {
auto specialAnnotation = special.value();
specialAnnotation.start = bpos;
specialAnnotation.end = epos;
r_annotated_code_add_annotation(code, &specialAnnotation);
}
}
else {
Expand All @@ -129,6 +131,91 @@ RAnnotatedCode* R2CGenerator::provideAnnotations(const rapidjson::Document &root
return code;
}

/**
* Generates annotation of the address.
*/
void R2CGenerator::annotate(
RAnnotatedCode* code,
const common::Address& binAdress,
const common::AddressRange& inCode) const
{
RCodeAnnotation annotation = {};
annotation.type = R_CODE_ANNOTATION_TYPE_OFFSET;
annotation.offset.offset = binAdress.getValue();
annotation.start = inCode.getStart().getValue();
annotation.end = inCode.getEnd().getValue();
r_annotated_code_add_annotation(code, &annotation);
}

/**
* Generates syntax highlight annotation.
*/
void R2CGenerator::annotate(
RAnnotatedCode* code,
const RSyntaxHighlightType& highlight,
const common::AddressRange& inCode) const
{
RCodeAnnotation annotation = {};
annotation.type = R_CODE_ANNOTATION_TYPE_SYNTAX_HIGHLIGHT;
annotation.syntax_highlight.type = highlight;
annotation.start = inCode.getStart().getValue();
annotation.end = inCode.getEnd().getValue();
r_annotated_code_add_annotation(code, &annotation);
}

/**
* Possibly creates special annotation based on kind, value and address.
*/
std::optional<RCodeAnnotation> R2CGenerator::specialAnnotation(
const std::string& kind,
const std::string& val,
const std::optional<common::Address>& address) const
{
auto hl = highlightTypeForToken(kind);
if (!hl.has_value())
return {};

auto offset = [kind](const std::optional<common::Address>& a) -> common::Address {
if (!a.has_value())
throw DecompilationError("expected offset for "+kind);

return a->getValue();
};

RCodeAnnotation an;

switch (hl.value()) {
case R_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_NAME:
an.type = R_CODE_ANNOTATION_TYPE_FUNCTION_NAME;
an.reference.name = strdup(val.c_str());
an.reference.offset = offset(address);
return an;

case R_SYNTAX_HIGHLIGHT_TYPE_GLOBAL_VARIABLE:
an.type = R_CODE_ANNOTATION_TYPE_GLOBAL_VARIABLE;
an.reference.offset = offset(address);
return an;

case R_SYNTAX_HIGHLIGHT_TYPE_CONSTANT_VARIABLE:
an.type = R_CODE_ANNOTATION_TYPE_CONSTANT_VARIABLE;
an.reference.offset = offset(address);
return an;

case R_SYNTAX_HIGHLIGHT_TYPE_LOCAL_VARIABLE:
an.type = R_CODE_ANNOTATION_TYPE_LOCAL_VARIABLE;
an.variable.name = strdup(val.c_str());
return an;

case R_SYNTAX_HIGHLIGHT_TYPE_FUNCTION_PARAMETER:
an.type = R_CODE_ANNOTATION_TYPE_FUNCTION_PARAMETER;
an.variable.name = strdup(val.c_str());
return an;

default:
return {};
}
}

/**
* Generates output by parsing RetDec's JSON output and calling R2CGenerator::provideAnnotations.
*/
Expand Down

0 comments on commit d5dc509

Please sign in to comment.