include/wipal/tool/endianness.hh

/*
 * WiPal - A library and a set of tools to manipulate wireless traces.
 * Copyright (C) 2007, 2008, 2009  Universite Pierre et Marie Curie - Paris 6
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301  USA
 *
 * Author: Thomas Claveirole <thomas.claveirole@lip6.fr>
 */
#ifndef TOOL_ENDIANNESS_HH_
# define TOOL_ENDIANNESS_HH_

extern "C"
{
# include <inttypes.h>
}

# include <ostream>

namespace wpl
{

  namespace tool
  {

    namespace end
    {

      enum endianness
        {
          big,          
          little,       
          raw,          
          swap,         
          guess         
        };

      std::ostream&
      operator << (std::ostream&, const endianness& e);

    } // End of namespace wpl::tool::end.

    bool        need_swap(end::endianness tag, bool guess_swap);


    /*----------------.
    | Unsigned shorts |
    `----------------*/

    uint16_t
    extract_unswapped_short_u(const void* p);

    uint16_t
    extract_swapped_short_u(const uint16_t s);

    uint16_t
    extract_swapped_short_u(const void* p);

    uint16_t
    extract_short_u(const void* p, bool swapped);

    uint16_t
    extract_short_u(const uint16_t s, bool swapped);

    uint16_t
    extract_big_endian_short_u(const void* p);

    uint16_t
    extract_big_endian_short_u(const uint16_t s);

    uint16_t
    extract_little_endian_short_u(const void* p);

    uint16_t
    extract_little_endian_short_u(const uint16_t s);


    /*---------------.
    | Unsigned longs |
    `---------------*/

    uint32_t
    extract_unswapped_long_u(const void* p);

    uint32_t
    extract_swapped_long_u(const uint32_t l);

    uint32_t
    extract_swapped_long_u(const void* p);

    uint32_t
    extract_long_u(const void* p, bool swapped);

    uint32_t
    extract_long_u(const uint32_t l, bool swapped);

    uint32_t
    extract_big_endian_long_u(const void* p);

    uint32_t
    extract_big_endian_long_u(const uint32_t l);

    uint32_t
    extract_little_endian_long_u(const void* p);

    uint32_t
    extract_little_endian_long_u(const uint32_t l);


    /*-------------.
    | Signed longs |
    `-------------*/

    int32_t
    extract_unswapped_long_s(const void* p);

    int32_t
    extract_swapped_long_s(const int32_t l);

    int32_t
    extract_swapped_long_s(const void* p);

    int32_t
    extract_long_s(const void* p, bool swapped);

    int32_t
    extract_long_s(const int32_t l, bool swapped);

    int32_t
    extract_big_endian_long_s(const void* p);

    int32_t
    extract_big_endian_long_s(const int32_t l);

    int32_t
    extract_little_endian_long_s(const void* p);

    int32_t
    extract_little_endian_long_s(const int32_t l);

  } // End of namespace wpl::tool.

} // End of namespace wpl.

# include "endianness.hxx"

#endif // ! TOOL_ENDIANNESS_HH_

---