ByteSize.cpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2017.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#include "fwMemory/ByteSize.hpp"

#include "fwMemory/exception/BadCast.hpp"

#include <boost/spirit/include/phoenix_operator.hpp>
#include <boost/spirit/include/qi.hpp>

#include <sstream>

namespace fwMemory
{

const std::uint64_t ByteSize::Bytes = 1;

// SI units
const std::uint64_t ByteSize::KB = 1000LL;
const std::uint64_t ByteSize::MB = 1000000LL;
const std::uint64_t ByteSize::GB = 1000000000LL;
const std::uint64_t ByteSize::TB = 1000000000000LL;
const std::uint64_t ByteSize::PB = 1000000000000000LL;

// IEC units
const std::uint64_t ByteSize::KiB = 1LL << 10;
const std::uint64_t ByteSize::MiB = 1LL << 20;
const std::uint64_t ByteSize::GiB = 1LL << 30;
const std::uint64_t ByteSize::TiB = 1LL << 40;
const std::uint64_t ByteSize::PiB = 1LL << 50;

ByteSize::ByteSize () :
    m_size(0)
{
}

//------------------------------------------------------------------------------

ByteSize::ByteSize ( SizeType size, UnitType unit ) :
    m_size(0)
{
    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    this->setSize(size, unit);
}

//------------------------------------------------------------------------------

ByteSize::ByteSize ( double size, UnitType unit ) :
    m_size(0)
{
    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    if(size < 0)
    {
        FW_RAISE_EXCEPTION_MSG( ::fwMemory::exception::BadCast, "Bad size : " << size << " < 0");
    }
    this->setSize(size, unit);
}

//------------------------------------------------------------------------------

ByteSize::ByteSize ( const std::string& size )
{
    this->setSize(size);
}

//------------------------------------------------------------------------------

ByteSize& ByteSize::operator= ( SizeType size )
{
    this->setSize(size);
    return *this;
}

//------------------------------------------------------------------------------

ByteSize& ByteSize::operator= ( double size )
{
    if(size < 0)
    {
        FW_RAISE_EXCEPTION_MSG( ::fwMemory::exception::BadCast, "Bad size : " << size << " < 0");
    }

    this->setSize(size);
    return *this;
}

//------------------------------------------------------------------------------

ByteSize& ByteSize::operator= ( const std::string& size )
{
    this->setSize(size);
    return *this;
}

//------------------------------------------------------------------------------

void ByteSize::setSize ( SizeType size, UnitType unit )
{
    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    m_size = size*unit;
}

//------------------------------------------------------------------------------

void ByteSize::setSize ( double size, UnitType unit )
{
    if(size < 0)
    {
        FW_RAISE_EXCEPTION_MSG( ::fwMemory::exception::BadCast, "Bad size : " << size << " < 0");
    }

    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    m_size = static_cast<SizeType>(size*unit);
}

//------------------------------------------------------------------------------

void ByteSize::setSize ( const std::string& size )
{
    SizeType newSize = 0;
    bool r           = parseSize(size, newSize);
    if(r)
    {
        m_size = newSize;
    }
    else
    {
        FW_RAISE_EXCEPTION_MSG( ::fwMemory::exception::BadCast, "Bad size : " << size );
    }
}

//------------------------------------------------------------------------------

std::string ByteSize::unitToString(ByteSize::UnitType unit)
{
    switch ( unit )
    {
        case Bytes:
            return "Bytes";
        case KB:
            return "KB";
        case GB:
            return "GB";
        case MB:
            return "MB";
        case TB:
            return "TB";
        case KiB:
            return "KiB";
        case GiB:
            return "GiB";
        case MiB:
            return "MiB";
        case TiB:
            return "TiB";
    }
    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    return "?";
}

//------------------------------------------------------------------------------

bool ByteSize::parseSize(const std::string& s, SizeType& size)
{
    using ::boost::phoenix::ref;
    using ::boost::spirit::ascii::no_case;
    using ::boost::spirit::ascii::space;
    using ::boost::spirit::qi::as;
    using ::boost::spirit::qi::_1;
    using ::boost::spirit::qi::double_;
    using ::boost::spirit::qi::eoi;
    using ::boost::spirit::qi::phrase_parse;
    using ::boost::spirit::qi::symbols;
    using ::boost::spirit::qi::ulong_long;

    std::string::const_iterator first = s.begin();
    std::string::const_iterator last  = s.end();

    ByteSize::SizeType intSize    = 0;
    double floatSize              = 0;
    ByteSize::SizeType multiplier = ByteSize::Bytes;

    symbols<char, ByteSize::SizeType> unit;

    unit.add
        ( "b", ByteSize::Bytes ) ( "byte", ByteSize::Bytes ) ( "bytes", ByteSize::Bytes )
        ( "kb", ByteSize::KB  )
        ( "mb", ByteSize::MB  )
        ( "gb", ByteSize::GB  )
        ( "tb", ByteSize::TB  )
        ( "pb", ByteSize::PB  )
        ( "k", ByteSize::KiB ) ( "kib", ByteSize::KiB )
        ( "m", ByteSize::MiB ) ( "mib", ByteSize::MiB )
        ( "g", ByteSize::GiB ) ( "gib", ByteSize::GiB )
        ( "t", ByteSize::TiB ) ( "tib", ByteSize::TiB )
        ( "p", ByteSize::PiB ) ( "pib", ByteSize::PiB )
    ;

    bool r = false;
    r = phrase_parse(first, last,
                     //  Begin grammar
                     (
                         ( *space >>
                           ( &((double_) >> no_case[-unit] >> *space >> eoi)
                             >> double_[ ref(floatSize) = _1 ] >> no_case[-unit[ ref(multiplier) = _1 ]] )
                           | ( &((ulong_long) >> no_case[-unit]  >> *space >> eoi)
                               >> ulong_long[ ref(intSize) = _1 ] >> no_case[-unit[ ref(multiplier) = _1 ]] )
                         )
                         >> *space >> eoi
                     ),
                     //  End grammar

                     space);

    if (!r || first != last) // fail if we did not get a full match
    {
        return false;
    }

    if (intSize != 0)
    {
        size = intSize * multiplier;
    }
    else if (floatSize != 0)
    {
        if(floatSize < 0)
        {
            FW_RAISE_EXCEPTION_MSG( ::fwMemory::exception::BadCast, "Bad size : " << floatSize << " < 0");
        }

        size = static_cast< ByteSize::SizeType >(floatSize * multiplier);
    }
    else
    {
        return false;
    }
    return r;
}

//------------------------------------------------------------------------------

std::string ByteSize::getSizeAsString( UnitType unit )
{
    SLM_ASSERT("Bad Unit",
               (unit == Bytes) || (unit == KB) || (unit == MB) || (unit == GB) || (unit == TB)  || (unit == PB)
               || (unit == KiB) || (unit == MiB) || (unit == GiB) || (unit == TiB) || (unit == PiB));
    std::stringstream sstr;
    sstr << std::noshowpoint;

    if(unit == Bytes)
    {
        sstr << m_size;
    }
    else
    {
        sstr << (static_cast<double>(m_size) / unit);
    }
    sstr << " " << unitToString(unit);

    return sstr.str();
}

//------------------------------------------------------------------------------

std::string ByteSize::getHumanReadableSize( StandardType standard )
{
    static UnitType si []          = {Bytes, KB,  MB,  GB,  TB,  PB};
    static UnitType iec []         = {Bytes, KiB, MiB, GiB, TiB, PiB};
    const size_t sizeOfStandardSet = 5;

    UnitType* unitSet = iec;
    if( standard == SI)
    {
        unitSet = si;
    }

    size_t i;
    for ( i = 1; i < sizeOfStandardSet; ++i )
    {
        if (m_size < unitSet[i])
        {
            break;
        }
    }

    return getSizeAsString(unitSet[i-1]);

}
//------------------------------------------------------------------------------

} //namespace fwMemory