debencode.hpp

/*
 * debencode.hpp
 *
 * Header containing declarations for decoding & encoding Bencode
 *
 * debencode copyright (C) 2015 Joseph Durel [ jadematrix.art@gmail.com ]
 * debencode homepage: [ github.com/JadeMatrix/debencode ]
 */

#ifndef DEBENCODE_HPP
#define DEBENCODE_HPP

/* INCLUDES *******************************************************************//******************************************************************************/

#include <iostream>
#include <string>
#include <vector>
#include <map>

/* DECLARATIONS ***************************************************************//******************************************************************************/

namespace dbnc
{
    enum code
    {
        MALFORMED_INPUT,
        INPUT_ERROR,
        OUTPUT_ERROR,
        WRONG_TYPE,
        TYPE_MISMATCH
    };
    
    class value
    {
    public:
        enum type
        {
            NONE,
            STRING,
            INTEGER,
            LIST,
            DICTIONARY
        };
        
        value();                                                                // Default constructor
        value( std::istream& );                                                 // Construct from an input stream
        value( const value& );                                                  // Copy constructor
        
        ~value();
        
        void set( std::string );                                                // Set the value's value to a string (clears any previous type)
        void set( long );                                                       // Set the value's value to an integer (clears any previous type)
        void push( value& );                                                    // Push a value into this as a list; if it is not already a list, clears any
                                                                                // previous type first
        void set( std::string, value& );                                        // Place a value into this as a dictionary with a string key; if it is not
                                                                                // already a dictionary, clears any previous type first
        
        type getType();
        
        std::string getString();                                                // Get the string value; throws dbnc::WRONG_TYPE if it is not a string
        long getInteger();                                                      // Get the integer value; throws dbnc::WRONG_TYPE if it is not an integer
        std::pair< std::vector< value >::iterator,
                   std::vector< value >::iterator > getList();                  // Get the begin & end iterators of the list value; throws dbnc::WRONG_TYPE if
                                                                                // it is not a list; behavior undefined if type changes while iterating
        std::pair< std::map< std::string, value >::iterator,
                   std::map< std::string, value >::iterator > getDictionary();  // Get the begin & end iterators of the dictionary value; throws
                                                                                // dbnc::WRONG_TYPE if it is not a dictionary; bahavior undefined if type
                                                                                // changes while iterating
        
        void serializeBencode( std::ostream& );                                 // Serialize the contents as Bencode to the supplied output stream
        void serializeJSON(    std::ostream& );                                 // Serialize the contents as JSON to the supplied output stream
        void serializeXML(     std::ostream& );                                 // Serialize the contents as XML to the supplied output stream
    protected:
        type val_type;
        union
        {
            void*                           void_val;
            
            std::string*                    string_val;
            long                            int_val;
            std::vector< value >*           list_val;
            std::map< std::string, value >* dict_val;
        };
        
        void clearCurrent();
    private:
    };
}

#endif