endianness_map.h

Go to the documentation of this file.

/*******************************************************************\
 
Module:
 
Author: Daniel Kroening, kroening@kroening.com
 
\*******************************************************************/
 
 
#ifndef CPROVER_UTIL_ENDIANNESS_MAP_H
#define CPROVER_UTIL_ENDIANNESS_MAP_H

 
#include <iosfwd>
#include <vector>
 
#include "invariant.h"
 
class namespacet;
class typet;

class endianness_mapt
{
public:
  endianness_mapt(
    const typet &type,
    bool little_endian,
    const namespacet &_ns):ns(_ns)
  {
    build(type, little_endian);
  }
 
  explicit endianness_mapt(const namespacet &_ns) : ns(_ns)
  {
  }
 
  virtual ~endianness_mapt() = default;
 
  size_t map_bit(size_t bit) const
  {
    PRECONDITION(bit < map.size());
    size_t result=map[bit];
    DATA_INVARIANT(result < map.size(), "bit index must be within bounds");
    return result;
  }
 
  size_t number_of_bits() const
  {
    return map.size();
  }
 
  void build(const typet &type, bool little_endian);
 
  void output(std::ostream &) const;
 
protected:
  const namespacet &ns;
  std::vector<size_t> map; // bit-nr to bit-nr
 
  virtual void build_little_endian(const typet &type);
  virtual void build_big_endian(const typet &type);
};
 
inline std::ostream &operator<<(
  std::ostream &out,
  const endianness_mapt &m)
{
  m.output(out);
  return out;
}
 
#endif // CPROVER_UTIL_ENDIANNESS_MAP_H