module.jai

#import "Basic";
#import "Compiler";



#module_parameters(CLEAN_TABLES_UP := true);



serialize :: (input : *$T) -> []u8 #must
{
    ALIGNED_INPUT_SIZE :: #run align_for_serialization(size_of(T));

    dynamic_memory_required := cast(s64)handle_dynamic_memory(input, null, .COUNT); 

    buffer : []u8;
    buffer.count = ALIGNED_INPUT_SIZE + dynamic_memory_required;
    buffer.data  = alloc(buffer.count);
    memset(buffer.data, 0, buffer.count);

    dynamic_memory : []u8;
    dynamic_memory.count = dynamic_memory_required; 
    dynamic_memory.data  = buffer.data + ALIGNED_INPUT_SIZE;

    output := cast(*T)buffer.data;
    memcpy(output, input, size_of(type_of(input.*)));

    dynamic_memory_pointer := handle_dynamic_memory(output, dynamic_memory.data, .COPY_AND_ENCODE);
    assert(dynamic_memory_pointer == dynamic_memory.data + dynamic_memory.count);

    return buffer;
}



deserialize :: (bytes : []u8, $Output_Type : Type) -> *Output_Type  
{
    info := type_info(Output_Type);
    result := cast(*Output_Type) bytes.data;
    inline decode_dynamic_memory(result);
    return result;
}



#scope_file



#if CLEAN_TABLES_UP
{
    #import "Hash_Table";
    cleanup_for_serialization :: (table : *Table)
    {
        DEFAULT_VALUE :: table.Entry.{};
        for * table.entries
            if it.hash < FIRST_VALID_HASH 
                memcpy(it, *DEFAULT_VALUE, size_of(type_of(DEFAULT_VALUE)));
    }
}



handle_dynamic_memory :: (element : *$T,
                          dynamic_memory_pointer : *u8,
                          $mode : enum { COUNT; COPY_AND_ENCODE; },
                          $allow_pointer := false) -> next_dynamic_memory_pointer : *u8 #must
{
    #insert #run () -> string
    {
        quick_string_builder();
        p("// Handling dynamic memory for serializing %\n", T);
        info := cast(*Type_Info)type_info(T);

        #if mode == .COUNT
        {
            #if CLEAN_TABLES_UP if same_polymorph_source(info, type_info(Table(int,int)))
            {
                a(#string DONE
                cleanup_for_serialization(element);
                DONE);
            }
        }

        if #complete info.type ==
        {
            case .STRING;
            #if mode == .COPY_AND_ENCODE
            {
                a(#string DONE
                memcpy(dynamic_memory_pointer, element.data, element.count);            // copy original data
                element.data = xx (cast(u64)dynamic_memory_pointer - cast(u64)element); // make pointer, point to the dynamic buffer (encoded)
                DONE);
            }
            a(#string DONE
            dynamic_memory_pointer = align_for_serialization(dynamic_memory_pointer + element.count); // commit the dynamic allocation
            DONE);



            case .ARRAY;
            array_info   := cast(*Type_Info_Array)info;
            element_size := array_info.element_type.runtime_size;
            if #complete array_info.array_type == 
            {
                case .RESIZABLE;
                #if mode == .COPY_AND_ENCODE
                {
                    a(#string DONE
                    element.allocated = element.count;
                    element.allocator = Serialized_Data_Allocator;
                    DONE);
                }
                #through;


                case .VIEW;
                a(#string DONE
                array_data_size := element.count * size_of(type_of(element.data.*)); 
                DONE);
                #if mode == .COPY_AND_ENCODE
                {
                    a(#string DONE
                    memcpy(dynamic_memory_pointer, element.data, array_data_size);           // copy original array elements
                    element.data = xx (cast(u64)dynamic_memory_pointer - cast(u64)element);  // encode the data pointer 
                    data_start := cast(type_of(element.data)) dynamic_memory_pointer;        // get a pointer to the data to iterate
                    DONE);
                }
                else
                {
                    a(#string DONE
                    data_start := element.data; // if we're not copying we just iterate throught the original data
                    DONE);
                }
                a(#string DONE
                dynamic_memory_pointer = align_for_serialization(dynamic_memory_pointer + array_data_size); // commit the dynamic allocation
                for 0..element.count-1
                {
                    dynamic_memory_pointer = handle_dynamic_memory(data_start + it, dynamic_memory_pointer, mode); 
                }
                DONE);


                case .FIXED;
                a(#string DONE
                for 0..element.count-1
                {
                    dynamic_memory_pointer = handle_dynamic_memory(element.data + it, dynamic_memory_pointer, mode); 
                }
                DONE);
            }


            
            case .STRUCT;
            struct_info := cast(*Type_Info_Struct)info;
            
            replace := needs_serialization_replacement(struct_info);
            if replace
            {
                a(#string DONE
                replaced_element := element.serialization_replacement(element);
                #assert(size_of(T) == size_of(*element.Replacement_Type));
                DONE);
                #if mode == .COUNT
                {
                    a(#string DONE
                    pointer_to_replaced_element := *replaced_element;
                    dynamic_memory_pointer = handle_dynamic_memory(*pointer_to_replaced_element, dynamic_memory_pointer, mode, allow_pointer = true);
                    DONE);
                }
                else
                {
                    a(#string DONE
                    (cast(**element.Replacement_Type)element).* = *replaced_element;
                    dynamic_memory_pointer = handle_dynamic_memory(cast(**element.Replacement_Type)element, dynamic_memory_pointer, mode, allow_pointer = true);
                    DONE);
                }
            }
            else
            {
                for member : struct_info.members
                {
                    if !(member.flags & .CONSTANT)
                    {
                        allow_pointer := false;
                        for member.notes if it == "allow_single_element_pointer_serialization" then allow_pointer = true;
                        p(#string DONE
                        dynamic_memory_pointer = handle_dynamic_memory(cast(*type_of(T.%1))((cast(*u8)element) + %2), 
                                                                       dynamic_memory_pointer,
                                                                       mode,
                                                                       allow_pointer = %3); 
                        DONE, member.name, member.offset_in_bytes, allow_pointer);
                    }
                }
            }



            case .PROCEDURE;
            if info != type_info(Allocator_Proc)
            {
                compiler_report(tprint("Only Allocator procedures can be in serialized structs, and % isn't one", get_type(info)));
            }



            case .POINTER;
            a(#string DONE
            if element.* != null
            {
            DONE);
            #if allow_pointer
            {
                a(#string DONE
                element_size := size_of(type_of((element.*).*));
                DONE);
                #if mode == .COPY_AND_ENCODE
                {
                    a(#string DONE
                    memcpy(dynamic_memory_pointer, element.*, element_size);                      // copy original data
                    (cast(*u64)element).* = (cast(u64)dynamic_memory_pointer - cast(u64)element); // make pointer, point to the dynamic buffer (encoded)
                    element_data := cast(type_of(element.*)) dynamic_memory_pointer;
                    DONE);
                }
                else
                {
                    a(#string DONE
                    element_data := element.*;
                    DONE);
                }
                a(#string DONE
                dynamic_memory_pointer = align_for_serialization(dynamic_memory_pointer + element_size); // commit the dynamic allocation
                dynamic_memory_pointer = handle_dynamic_memory(element_data, dynamic_memory_pointer, mode); 
                DONE);
            }
            else
            {
                a(#string DONE
                log_error("We only allow null-pointers to be serialized, and % wasn't!", T);
                assert(false);
                DONE);
            }
            a(#string DONE
            } // if element.* != null
            DONE);



            case .VARIANT; 
            a(#string DONE
            INTERNAL_TYPE :: #run find_variant_contained_type(type_of(element.*));
            dynamic_memory_pointer = handle_dynamic_memory(cast(*INTERNAL_TYPE)element, dynamic_memory_pointer, mode, allow_pointer);
            DONE);



            case .INTEGER;
            case .FLOAT;
            case .BOOL;
            case .VOID;
            case .POLYMORPHIC_VARIABLE;
            case .ENUM;
            // Nothing to do for these, they will just be memcpy-ed



            case .TYPE;         #through;
            case .CODE;         #through;
            case .OVERLOAD_SET; #through;
            case .ANY;
            compiler_report(tprint("Type % cannot be serialized cause it's a %", T, info.type));
        }
        return builder_to_string(b);
    }();

    return dynamic_memory_pointer;
}



decode_dynamic_memory :: (element : *$T)
{
    #insert #run () -> string
    {
        quick_string_builder();
        p("// Decoding dynamic memory for deserializing %\n", T);
        info := cast(*Type_Info)type_info(T);
        if info.type ==
        {
            case .STRING;
            a(#string DONE
            element.data = cast(*u8)(cast(u64)element + cast(u64)element.data);
            DONE);



            case .ARRAY;
            array_info   := cast(*Type_Info_Array)info;
            element_type := array_info.element_type;
            do_decode    := !(element_type.type == .INTEGER || element_type.type == .FLOAT || element_type.type == .BOOL);
            if #complete array_info.array_type == 
            {
                case .RESIZABLE;
                a(#string DONE
                element.allocated = element.count;
                element.allocator = Serialized_Data_Allocator;
                DONE);
                #through;


                case .VIEW;
                a(#string DONE
                element.data = xx (cast(u64)element + cast(u64)element.data);
                DONE);
                #through;


                case .FIXED;
                if do_decode
                {
                    a(#string DONE
                    for 0..element.count-1
                    {
                        inline decode_dynamic_memory(element.data + it); 
                    }
                    DONE);
                }
            }


            
            case .STRUCT;
            struct_info := cast(*Type_Info_Struct)info;
            replace := needs_serialization_replacement(struct_info);
            if replace
            {
                a(#string DONE
                #assert(size_of(T) == size_of(*element.Replacement_Type));
                pointer_to_replaced_element : **element.Replacement_Type = cast(**element.Replacement_Type)element;
                inline decode_dynamic_memory(pointer_to_replaced_element); 
                element.* = element.deserialization_replacement(pointer_to_replaced_element.*); 
                DONE);
            }
            for member : struct_info.members
            {
                if !(member.flags & .CONSTANT)
                {
                    p(#string DONE
                    inline decode_dynamic_memory(cast(*type_of(T.%1))((cast(*u8)element) + %2));
                    DONE, member.name, member.offset_in_bytes);
                }
            }



            case .PROCEDURE;
            if info == type_info(Allocator_Proc)
            {
                // @@NOTE: We could catch Allocator structs on the .STRUCT codepath
                // instead, but just in case someone does an allocator procedure by itself
                // maybe this is better and simpler.
                p(#string DONE
                element.* = Serialized_Data_Allocator.proc;
                DONE);
            }



            case .POINTER;
            a(#string DONE
            offset := (cast(*u64)element).*;
            if offset > 0
            {
                element.* = cast(T)(cast(u64)element + (cast(*u64)element).*);
                inline decode_dynamic_memory(element.*); 
            }
            DONE);



            case .VARIANT;
            a(#string DONE
            INTERNAL_TYPE :: #run find_variant_contained_type(type_of(element.*));
            decode_dynamic_memory(cast(*INTERNAL_TYPE)element);
            DONE);



        }
        return builder_to_string(b);
    }();
} 



Serialized_Data_Allocator :: Allocator.{
    proc = (mode: Allocator_Mode, size: s64, old_size: s64, old_memory_pointer: *void, allocator_data: *void) -> *void
    {
        log_error("Can't allocate data on a serialized data structure!");
        assert(false);
        return null;
    },
    data = null,
};



needs_serialization_replacement :: (struct_info : *Type_Info_Struct) -> bool
{
    found_type := false; 
    found_serialization_replacement := false;
    found_deserialization_replacement := false;
    for member : struct_info.members
    {
        if member.flags & .CONSTANT
        {
            if member.name == "Replacement_Type" && member.type.type == .TYPE
            {
                found_type = true;
            }
            if member.name == "serialization_replacement" && member.type.type == .PROCEDURE
            {
                found_serialization_replacement = true;
            }
            if member.name == "deserialization_replacement" && member.type.type == .PROCEDURE
            {
                found_deserialization_replacement = true;
            }
        }
    }
    return found_type && found_serialization_replacement && found_deserialization_replacement;
}



align_for_serialization :: (value : $T) -> T
{
    return (value + 15) & (~15);
}



quick_string_builder :: () #expand
{
    `_builder : String_Builder;
    _builder.allocator = temporary_allocator;
    `defer reset(*_builder);
    `b := *_builder;
    `p :: (format_string : string, args: ..Any) #expand
    {
        print_to_builder(*_builder, format_string, ..args);
    } @PrintLike
    `a :: (the_string : string) #expand
    {
        append(*_builder, the_string);
    }
}



find_variant_contained_type :: ($variant_type : Type) -> Type
{
    info := type_info(variant_type);
    assert(info.type == .VARIANT);
    variant_info := cast(*Type_Info_Variant)info;
    return get_type(variant_info.variant_of);
}



same_polymorph_source :: (info_a : *Type_Info, info_b : *Type_Info) -> bool
{
    find_top_polymorph_source :: (info : *Type_Info) -> *Type_Info
    {
        while true
        {
            if info.type == .STRUCT
            {
                struct_info := cast(*Type_Info_Struct)info;
                if struct_info.polymorph_source_struct
                {
                    info = struct_info.polymorph_source_struct;
                    continue;
                }
            }
            break;
        }
        return info;
    }
    return find_top_polymorph_source(info_a) == find_top_polymorph_source(info_b);
}