{"id":293,"date":"2014-04-13T14:48:32","date_gmt":"2014-04-13T22:48:32","guid":{"rendered":"http:\/\/www.android-decompiler.com\/blog\/?p=293"},"modified":"2018-12-19T13:39:43","modified_gmt":"2018-12-19T21:39:43","slug":"using-the-ast-tagging-api","status":"publish","type":"post","link":"https:\/\/www.pnfsoftware.com\/blog\/using-the-ast-tagging-api\/","title":{"rendered":"Using the AST Tagging API"},"content":{"rendered":"

JEB version 1.5.201404100<\/a> introduces new methods to the AST IElement objects,\u00a0attachTag()<\/a> and retrieveTag()<\/a>. These methods allow an API user to tag<\/a> elements of Abstract Syntax Trees. When a tagged tree is rendered (that is, when decompiled Java code is being generated), tags are processed and provided to the user alongside the decompiled code, with associated text coordinates (line, column). Within the API documentation, a “located tag” is referred to as a mark<\/a>.<\/p>\n

One example use case: Tagging nodes of an AST can be useful if the yielded source code is of specific interest, and potentially require follow-up human analysis.<\/p>\n

The example below shows how one can navigate a Class tree, looking for specific calls to findViewById<\/em>:<\/p>\n

def processTree(e):\r\n  if isinstance(e, Call) and e.getMethod().getName() == 'findViewById' and ... :\r\n    print 'Tagging Call element:', e #e.getMethod().getName()\r\n    e.attachTag('testTag', 'Calling interesting findViewById')\r\n  if e:\r\n    # recursively process sub-elements\r\n    for e1 in e.getSubElements():\r\n      processTree(e1)\r\n\r\nsig = ...\r\nast = self.jeb.getDecompiledClassTree(sig)  # assume the class was decompiled\r\nprocessTree(e)<\/pre>\n
The Class tree can be rendered by calling the newly introduced overloaded decompile(sig, is_class, regenerate, marks)<\/a> method:<\/span><\/p>\n
marks = []\r\ndecompiled_class = self.jeb.decompile(sig, True, False, marks)\r\nprint marks<\/pre>\n
Remember to set regenerate<\/em> to False since you want to avoid re-decompilation (doing so would generate a new, tag-less AST).<\/p>\n
The marks<\/em> array will contain the precise locations (lines and columns) of each tag within the decompiled_class<\/em> text buffer.<\/p>\n
Hopefully, this simplistic example showed you how to use the new AST tagging methods. Happy reversing and code analysis.<\/p>\n","protected":false},"excerpt":{"rendered":"
JEB version 1.5.201404100 introduces new methods to the AST IElement objects,\u00a0attachTag() and retrieveTag(). These methods allow an API user to tag elements of Abstract Syntax Trees. When a tagged tree is rendered (that is, when decompiled Java code is being generated), tags are processed and provided to the user alongside the decompiled code, with associated … Continue reading Using the AST Tagging API<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7,3],"tags":[],"class_list":["post-293","post","type-post","status-publish","format-standard","hentry","category-api-jeb1","category-decompilation"],"_links":{"self":[{"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/posts\/293","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/comments?post=293"}],"version-history":[{"count":0,"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/posts\/293\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/media?parent=293"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/categories?post=293"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.pnfsoftware.com\/blog\/wp-json\/wp\/v2\/tags?post=293"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}