memory_allocator_bases.g.hh

Go to the documentation of this file.

// This file is automatically generated, do not edit.

/*!
        \file
        \brief Base classes for memory allocators.
        \author jaz
*/

#ifndef lestes__md__mem__memory_allocator_bases_g_hh__included
#define lestes__md__mem__memory_allocator_bases_g_hh__included

#include <lestes/md/common.hh>

#include <lestes/std/objectize_macros.hh>
package(lestes);
package(std);
class object;
end_package(std);
end_package(lestes);

package(lestes);
package(lang);
package(cplus);
package(sem);
class ss_function_declaration;
end_package(sem);
end_package(cplus);
end_package(lang);
end_package(lestes);

package(lestes);
package(lang);
package(cplus);
package(sem);
class ss_object_declaration;
end_package(sem);
end_package(cplus);
end_package(lang);
end_package(lestes);

package(lestes);
package(backend_v2);
package(intercode);
class pi_mem_factory;
end_package(intercode);
end_package(backend_v2);
end_package(lestes);

package(lestes);
package(backend_v2);
package(intercode);
class pi_abstract_function_call;
end_package(intercode);
end_package(backend_v2);
end_package(lestes);

package(lestes);
package(md);
package(literals);
class literal_info_base;
end_package(literals);
end_package(md);
end_package(lestes);

package(lestes);
package(backend_v2);
package(intercode);
class pi_pi;
end_package(intercode);
end_package(backend_v2);
end_package(lestes);

package(lestes);
package(backend_v2);
package(intercode);
class pi_sp;
end_package(intercode);
end_package(backend_v2);
end_package(lestes);

package(lestes);
package(md);
package(types);
class tm_data_type_base;
end_package(types);
end_package(md);
end_package(lestes);

package(lestes);
package(md);
package(mem);


class allocator_base;
class local_variable_allocator_base;
class global_variable_allocator_base;


/*! \brief Base class for memory allocators.

Memory allocators allows to allocate variables.
*/
class allocator_base : public ::lestes::std::object {
public:
        // WARNING: Detailed doxygen description for method
        // should be near it's implementation, not in XML file.

        /*! \brief Deallocates previously allocated space.

        Dealocates space occupied by given pi_mem_factory. Point in time, when the dealocation tooks place, is
between psp and nsp sequencepoints.
                                        
                                \param mem A memory space to be dealloacated.
                                \param psp A sequencepoint that is set as psp to any generated deallocation code.
                                \param nsp A sequencepoint that is set as nsp to any generated deallocation code.
                                
        */
        virtual void deallocate(ptr< ::lestes::backend_v2::intercode::pi_mem_factory > mem, ptr< ::lestes::backend_v2::intercode::pi_sp > psp, ptr< ::lestes::backend_v2::intercode::pi_sp > nsp) abstract;

        //! Calculates placement of allocated variables.
        virtual void calculate_placement() abstract;

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class allocator_base.
        allocator_base (
                );

        //! Marking routine for class allocator_base. 
        virtual void gc_mark();

private:
        static ptr<reflection_list> reflection;
        
}; // allocator_base


/*! \brief Manager for local variable allocation.

Note: A concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/memory/ directory.
*/
class local_variable_allocator_base : public allocator_base {
public:
        //! The method function_get returns the value of the field local_variable_allocator_base::function.
        ptr< ::lestes::lang::cplus::sem::ss_function_declaration > function_get() const;

        //! The method function_set sets the field local_variable_allocator_base::function to the given value.
        void function_set(const ptr< ::lestes::lang::cplus::sem::ss_function_declaration > &);

        //! Allocates space for variable on the local stack.
        virtual ptr< ::lestes::backend_v2::intercode::pi_mem_factory > allocate(ptr< ::lestes::lang::cplus::sem::ss_object_declaration > decl) abstract;

        //! Allocates space for variable on the local stack.
        virtual ptr< ::lestes::backend_v2::intercode::pi_mem_factory > allocate_tmp(ptr< ::lestes::md::types::tm_data_type_base > type) abstract;

        //! Deallocates space occupied by variable.
        virtual void deallocate(ptr< ::lestes::backend_v2::intercode::pi_mem_factory > mem, ptr< ::lestes::backend_v2::intercode::pi_sp > psp, ptr< ::lestes::backend_v2::intercode::pi_sp > nsp) abstract;

        //! Calculates placement of local variables and parameters in memory.
        virtual void calculate_placement() abstract;

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class local_variable_allocator_base.
        local_variable_allocator_base (
                ptr< ::lestes::lang::cplus::sem::ss_function_declaration > a__local_variable_allocator_base__function);

        //! Marking routine for class local_variable_allocator_base. 
        virtual void gc_mark();

private:
        //! Declaration of the function in which's body the allocation is performed.
        srp< ::lestes::lang::cplus::sem::ss_function_declaration > function;
        static ptr<reflection_list> reflection;
        
}; // local_variable_allocator_base


/*! \brief Manager for global variable allocation.

Note: A concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/memory/ directory.
*/
class global_variable_allocator_base : public allocator_base {
public:
        //! Allocates space for variable in global data storage.
        virtual ptr< ::lestes::backend_v2::intercode::pi_mem_factory > allocate(ptr< ::lestes::lang::cplus::sem::ss_object_declaration > decl) abstract;

        //! Initialiaze memory space in global data storage with given value.
        virtual void init_variable(ptr< ::lestes::backend_v2::intercode::pi_mem_factory > mem, ptr< ::lestes::md::literals::literal_info_base > value) abstract;

        //! Deallocates space occupied by variable.
        virtual void deallocate(ptr< ::lestes::backend_v2::intercode::pi_mem_factory > mem, ptr< ::lestes::backend_v2::intercode::pi_sp > psp, ptr< ::lestes::backend_v2::intercode::pi_sp > nsp) abstract;

        //! Calculates placement of local variables and parameters in memory.
        virtual void calculate_placement() abstract;

        

        //! for purposes of dumping
        virtual ptr<reflection_list> reflection_get() const;
        //! for purposes of dumping
        virtual ptr<field_list_list> field_values_get() const;
        
protected:
        //! Generated constructor for class global_variable_allocator_base.
        global_variable_allocator_base (
                );

        //! Marking routine for class global_variable_allocator_base. 
        virtual void gc_mark();

private:
        static ptr<reflection_list> reflection;
        
}; // global_variable_allocator_base


end_package(mem);
end_package(md);
end_package(lestes);

#endif // lestes__md__mem__memory_allocator_bases_g_hh__included

---