polserver/pol-core/bscript/eprog.h

/** @file
 *
 * @par History
 * - 2006/09/23 Shinigami: Script_Cycles, Sleep_Cycles and Script_passes uses 64bit now
 */


#ifndef BSCRIPT_EPROG_H
#define BSCRIPT_EPROG_H

#include <iosfwd>
#include <map>
#include <stdio.h>
#include <string>
#include <vector>

#include "../clib/boostutils.h"
#include "../clib/maputil.h"
#include "../clib/rawtypes.h"
#include "../clib/refptr.h"
#include "executortype.h"
#include "symcont.h"
#include "token.h"

namespace Pol
{
namespace Plib
{
class Package;
}
namespace Bscript
{
class FunctionalityModule;

class Instruction
{
public:
  Instruction( ExecInstrFunc f ) : token(), func( f ), cycles( 0 ) {}
  Instruction() : token(), func( 0 ), cycles( 0 ) {}
  Token token;
  ExecInstrFunc func;
  mutable unsigned int cycles;
};

struct EPDbgInstr
{
  unsigned int blockidx;
  unsigned int flags;
  unsigned int fileidx;
  unsigned int line;
  unsigned int srclineidx;
  unsigned int functionidx;
};

struct EPDbgBlock
{
  unsigned parentblockidx;
  unsigned parentvariables;
  std::vector<std::string> localvarnames;

  bool operator==( const EPDbgBlock& other ) const
  {
    return parentblockidx == other.parentblockidx && parentvariables == other.parentvariables &&
           localvarnames == other.localvarnames;
  }
};

struct EPExportedFunction
{
  std::string name;
  unsigned nargs;
  unsigned PC;

  bool operator==( const EPExportedFunction& other ) const
  {
    return name == other.name && nargs == other.nargs && PC == other.PC;
  }
};

struct EPFunctionReference
{
  unsigned address;
  int parameter_count;
  int capture_count;
  bool is_variadic;
  unsigned class_index;  // max = no class
  bool is_constructor;
  std::vector<unsigned> default_parameter_addresses;

  unsigned default_parameter_count() const
  {
    return static_cast<unsigned>( default_parameter_addresses.size() );
  }

  bool operator==( const EPFunctionReference& other ) const
  {
    return address == other.address && parameter_count == other.parameter_count &&
           capture_count == other.capture_count && is_variadic == other.is_variadic &&
           class_index == other.class_index && is_constructor == other.is_constructor &&
           default_parameter_addresses == other.default_parameter_addresses;
  }
};

struct EPMethodDescriptor
{
  unsigned function_reference_index;
};
struct EPConstructorDescriptor
{
  unsigned type_tag_offset;
};

using EPConstructorList = std::vector<EPConstructorDescriptor>;

using EPMethodMap = std::map<unsigned /* name_offset */, EPMethodDescriptor>;

struct EPClassDescriptor
{
  unsigned name_offset;
  unsigned constructor_function_reference_index;
  EPConstructorList constructors;
  EPMethodMap methods;
};

struct EPDbgFunction
{
  std::string name;
  unsigned firstPC;
  unsigned lastPC;

  bool operator==( const EPDbgFunction& other ) const
  {
    return name == other.name && firstPC == other.firstPC && lastPC == other.lastPC;
  }
};

struct BSCRIPT_SECTION_HDR;

class EScriptProgram : public ref_counted
{
public:
  EScriptProgram();
  unsigned nglobals;
  unsigned expectedArgs;
  bool haveProgram;
  boost_utils::script_name_flystring name;
  std::vector<FunctionalityModule*> modules;
  StoredTokenContainer tokens;
  SymbolContainer symbols;

  void dump( std::ostream& os );
  void dump_casejmp( std::ostream& os, const Token& token );
  int read( const char* fname );
  int read_dbg_file( bool quiet = false );
  int read_progdef_hdr( FILE* fp );
  int read_module( FILE* fp );
  int read_globalvarnames( FILE* fp );
  int read_exported_functions( FILE* fp, BSCRIPT_SECTION_HDR* hdr );
  int read_function_references( FILE* fp, BSCRIPT_SECTION_HDR* hdr );
  int read_class_table( FILE* fp );
  int _readToken( Token& token, unsigned position ) const;
  int create_instructions();

  std::vector<EPExportedFunction> exported_functions;
  std::vector<EPFunctionReference> function_references;
  std::vector<EPClassDescriptor> class_descriptors;

  unsigned short version;
  unsigned int invocations;
  u64 instr_cycles;  // FIXME need an enable-profiling flag
  Plib::Package const* pkg;
  std::vector<Instruction> instr;

  // debug data:
  bool debug_loaded;
  std::vector<std::string> globalvarnames;
  std::vector<EPDbgBlock> blocks;
  std::vector<EPDbgFunction> dbg_functions;
  std::vector<std::string> dbg_filenames;

  // per instruction:
  std::vector<unsigned> dbg_filenum;
  std::vector<unsigned> dbg_linenum;
  std::vector<unsigned> dbg_ins_blocks;
  std::vector<bool> dbg_ins_statementbegin;

  std::string dbg_get_instruction( size_t atPC ) const;

  size_t sizeEstimate() const;

private:
  ~EScriptProgram() override;
  friend class ref_ptr<EScriptProgram>;
};

}  // namespace Bscript
}  // namespace Pol
#endif