ops.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2001-2002  The Exult Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef OPCODES_H
#define OPCODES_H

#include <map>
#include <string>
#include <vector>
#include <iostream>
#include <cassert>
#include "Configuration.h"
#include "ucc.h"

std::vector<std::string> qnd_ocsplit(const std::string &s);

void map_type_size(const std::vector<std::string> &param_types, std::vector<std::pair<unsigned int, bool> > &param_sizes);

static inline std::string strip_backticks(const std::string &s)
{
  if(s.size()==2 && s[0]=='`' && s[1]=='`')
    return std::string();
  else if(s[0]=='`' && s[s.size()-1]=='`')
    return s.substr(1, s.size()-2);
  return s;
}

/* Just a basic class to tie together half a dozen initialisation routines. */
class ucxtInit
{
  public:
    ucxtInit(const std::string &new_ucxtdata=std::string("ucxt.data"))
      : ucxtdata(new_ucxtdata)
    { };
    void init(const Configuration &config, const UCOptions &options);
    
  private:
    std::string get_datadir(const Configuration &config, const UCOptions &options);
    void misc();
    void opcodes();
    void intrinsics(const std::string &intrinsics_data, const std::string &intrinsics_root);
    
    const std::string ucxtdata;
    std::string datadir;
    
    std::string opcodes_data;
    std::string opcodes_root;
    
    std::string misc_data;
    std::string misc_root;
    
    std::string bg_intrinsics_data;
    std::string bg_intrinsics_root;
    
    std::string si_intrinsics_data;
    std::string si_intrinsics_root;
    
};

class UCOpcodeData
{
  public:
    UCOpcodeData() : opcode(0x00), num_bytes(0), num_pop(0),
                     num_push(0), call_effect(0), flag_return(false),
                     flag_paren(false), flag_indent_inc(false),
                     flag_indent_dec(false), flag_indent_tmpinc(false),
                     flag_indent_tmpdec(false)
    {};
    UCOpcodeData(unsigned int op, const Configuration::KeyTypeList &ktl)
                   : opcode(op), num_bytes(0), num_pop(0),
                     num_push(0), call_effect(0), flag_return(false),
                     flag_paren(false), flag_indent_inc(false),
                     flag_indent_dec(false), flag_indent_tmpinc(false),
                     flag_indent_tmpdec(false)
    {
      for(Configuration::KeyTypeList::const_iterator k=ktl.begin(); k!=ktl.end(); ++k)
      {
        switch(k->first[0])
        {
          case 'a':
            if(k->first=="asm_nmo")             asm_nmo = strip_backticks(k->second);
            else if(k->first=="asm_comment")    asm_comment = strip_backticks(k->second);
            break;
          case 'c':
            if(k->first=="call_effect")         call_effect = strtol(k->second.c_str(), 0, 0);
            break;
          case 'i':
            if(k->first=="indent_inc/")         flag_indent_inc=true;
            else if(k->first=="indent_dec/")    flag_indent_dec=true;
            else if(k->first=="indent_tmpinc/") flag_indent_tmpinc=true;
            else if(k->first=="indent_tmpdec/") flag_indent_tmpdec=true;
            break;
          case 'n':
            if(k->first=="name")                name = strip_backticks(k->second);
            else if(k->first=="num_bytes")      num_bytes = strtol(k->second.c_str(), 0, 0);
            else if(k->first=="num_pop")        num_pop = strtol(k->second.c_str(), 0, 0);
            else if(k->first=="num_push")       num_push = strtol(k->second.c_str(), 0, 0);
            break;
          case 'p':
            if(k->first=="param_types")         param_types = qnd_ocsplit(k->second);
            else if(k->first=="paren/")         flag_paren=true;
            break;
          case 'r':
            if(k->first=="return/")             flag_return=true;
            break;
          case 'u':
            if(k->first=="ucs_nmo")              ucs_nmo = strip_backticks(k->second);
            break;
          case '!': // ignore, it's a comment or something.
            break;
          default:
            std::cerr << "invalid key `" << k->first << "` value `" << k->second << "`" << std::endl;
        }
      }
      map_type_size(param_types, param_sizes);
    };
    
    UCOpcodeData(const std::vector<std::string> &v)
    {
      if((v.size()==12)==false)
      {
        std::cerr << "Error in opcodes file:" << std::endl;
        for(unsigned int i=0; i<v.size(); i++)
          std::cerr << v[i] << '\t';
        std::cerr << std::endl;
      }
      
      assert(v.size()==12);
      opcode = strtol(v[1].c_str(), 0, 0);
      name = v[2];
      asm_nmo = v[3];
      asm_comment = v[4];
      ucs_nmo = v[5];
      num_bytes = strtol(v[6].c_str(), 0, 0);
      param_types = qnd_ocsplit(v[7]);
      num_pop = strtol(v[8].c_str(), 0, 0);
      num_push = strtol(v[9].c_str(), 0, 0);
      call_effect = strtol(v[10].c_str(), 0, 0);
      assert(v[11].size()>=6);
      flag_return        = (v[11][0]=='0') ? false : true;
      flag_paren         = (v[11][1]=='0') ? false : true;
      flag_indent_inc    = (v[11][2]=='0') ? false : true;
      flag_indent_dec    = (v[11][3]=='0') ? false : true;
      flag_indent_tmpinc = (v[11][4]=='0') ? false : true;
      flag_indent_tmpdec = (v[11][5]=='0') ? false : true;
      map_type_size(param_types, param_sizes);
    };
    
    void dump(std::ostream &o)
    {
      o << "opcode: " << opcode << std::endl;
      o << "name: " << name << std::endl;
      o << "asm_nmo: " << asm_nmo << std::endl;
      o << "asm_comment: " << asm_comment << std::endl;
      o << "ucs_nmo: " << ucs_nmo << std::endl;
      o << "num_bytes: " << num_bytes << std::endl;
      o << "param_types: ";
      for(typeof(param_types.begin()) i=param_types.begin(); i!=param_types.end(); i++)
        o << *i << ',';
      o << std::endl;
      o << "num_pop: " << num_pop << std::endl;
      o << "num_push: " << num_push << std::endl;
      o << "call_effect: " << call_effect << std::endl;
      o << "flag_return: " << flag_return << std::endl;
      o << "flag_paren: " << flag_paren << std::endl;
      o << "flag_indent_inc: " << flag_indent_inc << std::endl;
      o << "flag_indent_dec: " << flag_indent_dec << std::endl;
      o << "flag_indent_tmpinc: " << flag_indent_tmpinc << std::endl;
      o << "flag_indent_tmpdec: " << flag_indent_tmpdec << std::endl;
    };
    
    unsigned int   opcode;
    std::string    name;
    std::string    asm_nmo;
    std::string    asm_comment;
    std::string    ucs_nmo;
    unsigned int   num_bytes;
    
    unsigned int   num_pop;
    unsigned int   num_push;
    unsigned int   call_effect;
    bool           flag_return;
    bool           flag_paren;
    bool           flag_indent_inc;
    bool           flag_indent_dec;
    bool           flag_indent_tmpinc;
    bool           flag_indent_tmpdec;
    
    std::vector<std::string> param_types;
    // values caluclated from param_types
    std::vector<std::pair<unsigned int, bool> > param_sizes; // .first==size of parameter in bytes .second==whether to treat it as a relative offset and calculate for it
    
};

extern std::vector<UCOpcodeData> opcode_table_data;
extern std::vector<std::pair<unsigned int, unsigned int> > opcode_jumps;

extern std::map<unsigned int, std::string> uc_intrinsics;

#endif

---