decompiler.h

//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
//_/_/
//_/_/ AERA
//_/_/ Autocatalytic Endogenous Reflective Architecture
//_/_/ 
//_/_/ Copyright (c) 2018-2025 Jeff Thompson
//_/_/ Copyright (c) 2018-2025 Kristinn R. Thorisson
//_/_/ Copyright (c) 2018-2025 Icelandic Institute for Intelligent Machines
//_/_/ http://www.iiim.is
//_/_/ 
//_/_/ Copyright (c) 2010-2012 Eric Nivel
//_/_/ Copyright (c) 2010 Nathaniel Thurston
//_/_/ Center for Analysis and Design of Intelligent Agents
//_/_/ Reykjavik University, Menntavegur 1, 102 Reykjavik, Iceland
//_/_/ http://cadia.ru.is
//_/_/ 
//_/_/ Part of this software was developed by Eric Nivel
//_/_/ in the HUMANOBS EU research project, which included
//_/_/ the following parties:
//_/_/
//_/_/ Autonomous Systems Laboratory
//_/_/ Technical University of Madrid, Spain
//_/_/ http://www.aslab.org/
//_/_/
//_/_/ Communicative Machines
//_/_/ Edinburgh, United Kingdom
//_/_/ http://www.cmlabs.com/
//_/_/
//_/_/ Istituto Dalle Molle di Studi sull'Intelligenza Artificiale
//_/_/ University of Lugano and SUPSI, Switzerland
//_/_/ http://www.idsia.ch/
//_/_/
//_/_/ Institute of Cognitive Sciences and Technologies
//_/_/ Consiglio Nazionale delle Ricerche, Italy
//_/_/ http://www.istc.cnr.it/
//_/_/
//_/_/ Dipartimento di Ingegneria Informatica
//_/_/ University of Palermo, Italy
//_/_/ http://diid.unipa.it/roboticslab/
//_/_/
//_/_/
//_/_/ --- HUMANOBS Open-Source BSD License, with CADIA Clause v 1.0 ---
//_/_/
//_/_/ Redistribution and use in source and binary forms, with or without
//_/_/ modification, is permitted provided that the following conditions
//_/_/ are met:
//_/_/ - Redistributions of source code must retain the above copyright
//_/_/   and collaboration notice, this list of conditions and the
//_/_/   following disclaimer.
//_/_/ - Redistributions in binary form must reproduce the above copyright
//_/_/   notice, this list of conditions and the following disclaimer 
//_/_/   in the documentation and/or other materials provided with 
//_/_/   the distribution.
//_/_/
//_/_/ - Neither the name of its copyright holders nor the names of its
//_/_/   contributors may be used to endorse or promote products
//_/_/   derived from this software without specific prior 
//_/_/   written permission.
//_/_/   
//_/_/ - CADIA Clause: The license granted in and to the software 
//_/_/   under this agreement is a limited-use license. 
//_/_/   The software may not be used in furtherance of:
//_/_/    (i)   intentionally causing bodily injury or severe emotional 
//_/_/          distress to any person;
//_/_/    (ii)  invading the personal privacy or violating the human 
//_/_/          rights of any person; or
//_/_/    (iii) committing or preparing for any act of war.
//_/_/
//_/_/ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
//_/_/ CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
//_/_/ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
//_/_/ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
//_/_/ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
//_/_/ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
//_/_/ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
//_/_/ BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
//_/_/ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
//_/_/ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
//_/_/ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
//_/_/ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
//_/_/ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
//_/_/ OF SUCH DAMAGE.
//_/_/ 
//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
 
#ifndef decompiler_h
#define decompiler_h
 
#include <fstream>
#include <sstream>
 
#include "out_stream.h"
#include "segments.h"
 
 
namespace r_comp {
 
class dll_export Decompiler {
private:
  OutStream *out_stream_;
  uint16 indents_; // in chars.
  bool closing_set_; // set after writing the last element of a set: any element in an expression finding closing_set_ will indent and set closing_set_ to false.
  bool in_hlp_;
  bool hlp_postfix_;
  bool horizontal_set_;
 
  r_code::ImageObject *current_object_;
 
  r_comp::Metadata *metadata_;
  r_comp::Image *image_;
 
  Timestamp time_reference_;
 
  std::unordered_map<uint16, std::string> variable_names_; // in the form vxxx where xxx is an integer representing the order of referencing of the variable/label in the code.
  uint16 last_variable_id_;
  std::string get_variable_name(uint16 index, bool postfix); // associates iptr/vptr indexes to names; inserts them in out_stream_ if necessary; when postfix==true, a trailing ':' is added.
  std::string get_hlp_variable_name(uint16 index);
 
  std::unordered_map<uint16, std::string> object_names_; // in the form class_namexxx where xxx is an integer representing the order of appearence of the object in the image; or: user-defined names when they are provided.
  std::unordered_map<std::string, uint16> object_indices_; // inverted version of the object_names.
  std::string get_object_name(uint16 index); // retrieves the name of an object.
 
  void write_indent(uint16 i);
  void write_expression_head(uint16 read_index); // decodes the leading atom of an expression.
  void write_expression_tail(uint16 read_index); // decodes the elements of an expression following the head.
  void write_set(uint16 read_index, uint16 write_as_view_index = 0);
  void write_any(uint16 read_index, bool &after_tail_wildcard, uint16 write_as_view_index = 0); // decodes any element in an expression or a set.
 
  typedef void (Decompiler::*Renderer)(uint16);
  r_code::resized_vector<Renderer> renderers_; // indexed by opcodes; when not there, write_expression() is used.
 
  // Renderers.
  void write_expression(uint16 read_index); // default renderer.
  void write_group(uint16 read_index);
  void write_marker(uint16 read_index);
  void write_pgm(uint16 read_index);
  void write_ipgm(uint16 read_index);
  void write_icmd(uint16 read_index);
  void write_cmd(uint16 read_index);
  void write_fact(uint16 read_index);
  void write_hlp(uint16 read_index);
  void write_ihlp(uint16 read_index);
  void write_view(uint16 read_index, uint16 arity);
 
  bool partial_decompilation_; // used when decompiling on-the-fly.
  bool ignore_named_objects_;
  std::unordered_set<uint16> named_objects_;
  std::vector<r_code::SysObject *> imported_objects_; // referenced objects added to the image that were not in the original list of objects to be decompiled.
public:
  Decompiler();
  ~Decompiler();
 
  void init(r_comp::Metadata *metadata);
  uint32 decompile(r_comp::Image *image,
    std::ostringstream *stream,
    Timestamp time_reference,
    bool ignore_named_objects); // decompiles the whole image; returns the number of objects.
  uint32 decompile(r_comp::Image *image,
    std::ostringstream *stream,
    Timestamp time_reference,
    std::vector<r_code::SysObject *> &imported_objects,
    bool include_oid = true, bool include_label = true, bool include_views = true); // idem, ignores named objects if in the imported object list.
 
  uint32 decompile_references(r_comp::Image *image, std::unordered_map<uint16, std::string>* object_names = NULL);
 
  void decompile_object(
    uint16 object_index, std::ostringstream *stream, Timestamp time_reference, bool include_oid = true, 
    bool include_label = true, bool include_views = true);
 
  void decompile_object(const std::string object_name, std::ostringstream *stream, Timestamp time_reference); // decompiles a single object given its name: use this function to follow references.
};
}
 
 
#endif