/** @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 <stdio.h>
#include <string>
#include <vector>

#include "../clib/boostutils.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 CompilerContext;
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 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();
  void addToken( const Token& token );
  void append( const StoredToken& stoken );
  void append( const StoredToken& stoken, unsigned* posn );
  void append( const StoredToken& stoken, const CompilerContext& ctx );
  void append( const StoredToken& stoken, const CompilerContext& ctx, unsigned* posn );
  void erase();
  void clear_modules();
  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 write( const char* fname );
  int read( const char* fname );
  int read_dbg_file();
  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 _readToken( Token& token, unsigned position ) const;
  int create_instructions();

  int write_dbg( const char* fname, bool gen_txt );

  // compiler only:
  unsigned program_PC;
  std::string program_decl;
  std::vector<std::string> sourcelines;
  std::vector<std::string> fileline;
  std::vector<std::string> function_decls;

  std::vector<EPExportedFunction> exported_functions;

  // executor only:
  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;
  unsigned savecurblock;
  unsigned curblock;
  unsigned curfile;
  unsigned curline;
  bool statementbegin;
  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;
  void setcontext( const CompilerContext& ctx );
  void setstatementbegin();

  void enterfunction();
  void leavefunction();
  void enterblock();
  void leaveblock();
  void addlocalvar( const std::string& localvarname );
  void addfunction( std::string name, unsigned firstPC, unsigned lastPC );
  void update_dbg_pos( const Token& tkn );
  void add_ins_dbg_info();

  int add_dbg_filename( const std::string& filename );
  std::string dbg_get_instruction( size_t atPC ) const;

  unsigned varcount( unsigned block );
  unsigned parentvariables( unsigned parent );
  size_t sizeEstimate() const;

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

class EScriptProgramCheckpoint
{
public:
  explicit EScriptProgramCheckpoint( const EScriptProgram& );
  void commit( const EScriptProgram& prog );
  void rollback( EScriptProgram& prog ) const;

  unsigned module_count;
  unsigned tokens_count;
  unsigned symbols_length;
  unsigned sourcelines_count;
  unsigned fileline_count;
};
}
}
#endif