EVEMarshal.h

Go to the documentation of this file.

/*
    ------------------------------------------------------------------------------------
    LICENSE:
    ------------------------------------------------------------------------------------
    This file is part of EVEmu: EVE Online Server Emulator
    Copyright 2006 - 2021 The EVEmu Team
    For the latest information visit https://evemu.dev
    ------------------------------------------------------------------------------------
    This program is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser 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, or go to
    http://www.gnu.org/copyleft/lesser.txt.
    ------------------------------------------------------------------------------------
    Author:     Zhur
*/

#ifndef EVE_MARSHAL_H
#define EVE_MARSHAL_H

#include "marshal/EVEMarshalOpcodes.h"
#include "python/PyVisitor.h"

/*
 * @brief Marshal Stream builder.
 *
 * @param[in]  rep  Python object to marshal.
 * @param[out] into Buffer which receives marshaled stream.
 *
 * @retval true  Marshaling ran successfully.
 * @retval false Error occured during marshaling.
 */
extern bool Marshal( const PyRep* rep, Buffer& into );
/*
 * @brief Deflated Marshal Stream builder.
 *
 * @param[in]  rep            Python object to marshal.
 * @param[out] into           Buffer which receives deflated marshaled stream.
 * @param[in]  deflationLimit The least size of buffer which gets deflated.
 *
 * @retval true  Marshaling ran successfully.
 * @retval false Error occured during marshaling.
 */
extern bool MarshalDeflate( const PyRep* rep, Buffer& into, const uint32 deflationLimit = 0x2000 );

class MarshalStream
: protected PyVisitor
{
public:
    MarshalStream();

    bool Save( const PyRep* rep, Buffer& into );

protected:
    bool SaveStream( const PyRep* rep );

    template<typename T>
    void Put( const T& value ) { mBuffer->Append<T>( value ); }
    template<typename Iter>
    void Put( Iter first, Iter last ) { mBuffer->AppendSeq<Iter>( first, last ); }

    void PutSizeEx( uint32 size )
    {
        if( size < 0xFF )
        {
            Put<uint8>( size );
        }
        else
        {
            Put<uint8>( 0xFF );
            Put<uint32>( size );
        }
    }

    bool VisitInteger( const PyInt* rep );
    bool VisitLong( const PyLong* rep );
    bool VisitBoolean( const PyBool* rep );
    bool VisitReal( const PyFloat* rep );
    bool VisitNone( const PyNone* rep );
    bool VisitBuffer( const PyBuffer* rep );
    bool VisitString( const PyString* rep );
    bool VisitWString( const PyWString* rep );
    bool VisitToken( const PyToken* rep );

    bool VisitTuple( const PyTuple* rep );
    bool VisitList( const PyList* rep );
    bool VisitDict( const PyDict* rep );

    bool VisitObject( const PyObject* rep );
    bool VisitObjectEx( const PyObjectEx* rep );

    bool VisitPackedRow( const PyPackedRow* pyPackedRow );

    bool VisitSubStruct( const PySubStruct* rep );
    bool VisitSubStream( const PySubStream* rep );
    bool VisitChecksumedStream( const PyChecksumedStream* rep );

private:
    // utility to handle Op_PyVarInteger (a bit hacky......)
    void SaveVarInteger( const PyLong* v );
    // zero-compresses given buffer and adds it to the stream
    bool SaveRLE(const Buffer& in );

    Buffer* mBuffer;
};

#endif