tm_data_type_base.g.hh

Go to the documentation of this file.

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

/*!
        \file
        \brief Target-machine data types.
        \author jaz
*/

#ifndef lestes__md__types__tm_data_type_base_g_hh__included
#define lestes__md__types__tm_data_type_base_g_hh__included

#include <lestes/std/map.hh>
#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_declaration;
end_package(sem);
end_package(cplus);
end_package(lang);
end_package(lestes);

package(lestes);
package(md);
package(registers);
class tm_register_base;
end_package(registers);
end_package(md);
end_package(lestes);

package(lestes);
package(md);
package(types);


class tm_data_type_base;
class tm_dt_simple_base;
class tm_dt_bitfield_base;
class tm_dt_array_base;
class tm_dt_union_base;
class tm_dt_struct_base;
class tm_dt_struct_member_base;


/*! \brief Target-architecture data type.


There is a few kinds of data type defined in backend. 

On the first place there are simple types. These types are basic types directly used and known by target CPU (e.g. int, long, double).

On the other hand there are higher-level relicts - struct, enum, array. They are used to keep information about relationship of their 
elements - simple types. CPU doesn't work with these data-type classes as with units but it accesses individual elements directly.
                
*/
class tm_data_type_base : public ::lestes::std::object {
public:
        typedef ulint id_type;
        
        //! Data type kinds.
        enum kind_type {
                SIMPLE,
                BITFIELD,
                STRUCT,
                UNION,
                ARRAY
        };
//! Data type formats.
        enum format_type {
                FORMAT_PLAIN,
                FORMAT_C1,
                FORMAT_C2,
                FORMAT_OFF,
                FORMAT_SM,
                FORMAT_BCD,
                FORMAT_PBCD,
                FORMAT_IEEE
        };

        //! The method id_get returns the value of the field tm_data_type_base::id.
        tm_data_type_base::id_type id_get() const;

        //! The method id_set sets the field tm_data_type_base::id to the given value.
        void id_set(tm_data_type_base::id_type);

        //! The method format_get returns the value of the field tm_data_type_base::format.
        format_type format_get() const;

        //! The method format_set sets the field tm_data_type_base::format to the given value.
        void format_set(format_type);

        //! The method bitwidth_get returns the value of the field tm_data_type_base::bitwidth.
        ulint bitwidth_get() const;

        //! The method bitwidth_set sets the field tm_data_type_base::bitwidth to the given value.
        void bitwidth_set(ulint);

        //! The method alignment_get returns the value of the field tm_data_type_base::alignment.
        ulint alignment_get() const;

        //! The method alignment_set sets the field tm_data_type_base::alignment to the given value.
        void alignment_set(ulint);

        //! The method return_reg_get returns the value of the field tm_data_type_base::return_reg.
        ptr< ::lestes::md::registers::tm_register_base > return_reg_get() const;

        //! The method return_reg_set sets the field tm_data_type_base::return_reg to the given value.
        void return_reg_set(const ptr< ::lestes::md::registers::tm_register_base > &);

        //! The method asm_output_get returns the value of the field tm_data_type_base::asm_output.
        lstring asm_output_get() const;

        //! The method asm_output_set sets the field tm_data_type_base::asm_output to the given value.
        void asm_output_set(lstring);

        //! The method asm_decl_get returns the value of the field tm_data_type_base::asm_decl.
        lstring asm_decl_get() const;

        //! The method asm_decl_set sets the field tm_data_type_base::asm_decl to the given value.
        void asm_decl_set(lstring);

        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get() 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 tm_data_type_base.
        tm_data_type_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl);

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

private:
        /*! \brief Data type id.

        Each data type is identified by its id (integer has id, double has id, struct has id, etc.)
        */
        tm_data_type_base::id_type id;
        //! Data type format.
        format_type format;
        //! Data type bitwidth.
        ulint bitwidth;
        //! Data type alignment.
        ulint alignment;
        //! Register where return value of the type is returned from function call.
        srp< ::lestes::md::registers::tm_register_base > return_reg;
        //! Asm output produced by the type.
        lstring asm_output;
        //! Asm output used in declarations.
        lstring asm_decl;
        static ptr<reflection_list> reflection;
        
}; // tm_data_type_base


/*! \brief Represents a simple type.


This type is base class for basic data types. 
Note: A concrete implementation is target-machine dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/types/ directory.
                
*/
class tm_dt_simple_base : public tm_data_type_base {
public:
        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get();

        

        //! 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 tm_dt_simple_base.
        tm_dt_simple_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl);

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

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


/*! \brief Bitfield type.

Bitfield is subtype of tm_dt_simple_base - it has different bitwidth and layout than its base data type. 

Note: Two bitfields can occupy single inseparable memory unit (e.g byte ) so that they must be transfered from memory together and some extra 
CPU work is needed to unpack them before and pack them after computation.

Note: This type is base class for bitfields. A concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/types/ directory.
                
*/
class tm_dt_bitfield_base : public tm_dt_simple_base {
public:
        //! The method bitfield_width_get returns the value of the field tm_dt_bitfield_base::bitfield_width.
        ulint bitfield_width_get() const;

        //! The method bitfield_width_set sets the field tm_dt_bitfield_base::bitfield_width to the given value.
        void bitfield_width_set(ulint);

        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get();

        

        //! 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 tm_dt_bitfield_base.
        tm_dt_bitfield_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl,
                ulint a__tm_dt_bitfield_base__bitfield_width);

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

private:
        //! Bitfield width.
        ulint bitfield_width;
        static ptr<reflection_list> reflection;
        
}; // tm_dt_bitfield_base


/*! \brief Array data type.

Note: This type is base class for arrays. A concrete implementation is target-machine dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/types/ directory.
*/
class tm_dt_array_base : public tm_data_type_base {
public:
        //! The method bound_get returns the value of the field tm_dt_array_base::bound.
        t_size bound_get() const;

        //! The method bound_set sets the field tm_dt_array_base::bound to the given value.
        void bound_set(t_size);

        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get();

        

        //! 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 tm_dt_array_base.
        tm_dt_array_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl,
                t_size a__tm_dt_array_base__bound);

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

private:
        //! Array bound.
        t_size bound;
        static ptr<reflection_list> reflection;
        
}; // tm_dt_array_base


/*! \brief Union data type.

Union is variable type that can change type it represents. The actual type is 
determined by datatype of pseudoinstruction where the union is used.

Note: A concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/md/types/ directory.
                
*/
class tm_dt_union_base : public tm_data_type_base {
public:
        //! The method types_get returns the value of the field tm_dt_union_base::types.
        ptr< ::lestes::std::list< srp< tm_data_type_base > > > types_get() const;

        //! The method types_set sets the field tm_dt_union_base::types to the given value.
        void types_set(const ptr< ::lestes::std::list< srp< tm_data_type_base > > > & );

        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get();

        

        //! 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 tm_dt_union_base.
        tm_dt_union_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl,
                ptr< ::lestes::std::list< srp< tm_data_type_base > > > a__tm_dt_union_base__types);

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

private:
        //! List of types that union can represent.
        srp< ::lestes::std::list< srp< tm_data_type_base > > >  types;
        static ptr<reflection_list> reflection;
        
}; // tm_dt_union_base


/*! \brief Struct data type.

Struct contains data fields. Each field is of its own datatype. Info about its size, offset and its 
higher-level declaration is stored with each field. This additional info is used to e.g. compute its placement within the struct.

Concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/backend/target/ directory.
                
*/
class tm_dt_struct_base : public tm_data_type_base {
public:
        //! The method members_get returns the value of the field tm_dt_struct_base::members.
        ptr< ::lestes::std::list< srp< tm_dt_struct_member_base > > > members_get() const;

        //! The method members_set sets the field tm_dt_struct_base::members to the given value.
        void members_set(const ptr< ::lestes::std::list< srp< tm_dt_struct_member_base > > > & );

        //! Returns kind of the data type represented by this instance.
        virtual tm_data_type_base::kind_type kind_get();

        

        //! 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 tm_dt_struct_base.
        tm_dt_struct_base (
                tm_data_type_base::id_type a__tm_data_type_base__id,
                format_type a__tm_data_type_base__format,
                ulint a__tm_data_type_base__bitwidth,
                ulint a__tm_data_type_base__alignment,
                ptr< ::lestes::md::registers::tm_register_base > a__tm_data_type_base__return_reg,
                lstring a__tm_data_type_base__asm_output,
                lstring a__tm_data_type_base__asm_decl,
                ptr< ::lestes::std::list< srp< tm_dt_struct_member_base > > > a__tm_dt_struct_base__members);

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

private:
        //! List of struct's fields.
        srp< ::lestes::std::list< srp< tm_dt_struct_member_base > > >  members;
        static ptr<reflection_list> reflection;
        
}; // tm_dt_struct_base


/*! \brief Struct data field.

Represents data field of a tm_dt_struct_base datatype.
                
Concrete implementation is target machine-dependent and it is placed in /target/machine/${TARGET_CPU}/lestes/backend/target/ directory.
                
*/
class tm_dt_struct_member_base : public ::lestes::std::object {
public:
        //! The method offset_get returns the value of the field tm_dt_struct_member_base::offset.
        ulint offset_get() const;

        //! The method offset_set sets the field tm_dt_struct_member_base::offset to the given value.
        void offset_set(ulint);

        //! The method bitwidth_get returns the value of the field tm_dt_struct_member_base::bitwidth.
        ulint bitwidth_get() const;

        //! The method bitwidth_set sets the field tm_dt_struct_member_base::bitwidth to the given value.
        void bitwidth_set(ulint);

        //! The method type_get returns the value of the field tm_dt_struct_member_base::type.
        ptr< tm_data_type_base > type_get() const;

        //! The method type_set sets the field tm_dt_struct_member_base::type to the given value.
        void type_set(const ptr< tm_data_type_base > &);

        //! The method ss_decl_get returns the value of the field tm_dt_struct_member_base::ss_decl.
        ptr< ::lestes::lang::cplus::sem::ss_declaration > ss_decl_get() const;

        //! The method ss_decl_set sets the field tm_dt_struct_member_base::ss_decl to the given value.
        void ss_decl_set(const ptr< ::lestes::lang::cplus::sem::ss_declaration > &);

        

        //! 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 tm_dt_struct_member_base.
        tm_dt_struct_member_base (
                ulint a__tm_dt_struct_member_base__offset,
                ulint a__tm_dt_struct_member_base__bitwidth,
                ptr< tm_data_type_base > a__tm_dt_struct_member_base__type,
                ptr< ::lestes::lang::cplus::sem::ss_declaration > a__tm_dt_struct_member_base__ss_decl);

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

private:
        //! Field's offset within struct.
        ulint offset;
        //! Field's bitwidth.
        ulint bitwidth;
        //! Field's data type.
        srp< tm_data_type_base > type;
        /*! \brief Field's declaration passed from higher-level.

        It is used to access the field in struct.
        */
        srp< ::lestes::lang::cplus::sem::ss_declaration > ss_decl;
        static ptr<reflection_list> reflection;
        
}; // tm_dt_struct_member_base


end_package(types);
end_package(md);
end_package(lestes);

package(lestes);
package(std);
specialize_objectize_for_enum( ::lestes::md::types::tm_data_type_base::kind_type );
specialize_objectize_for_enum( ::lestes::md::types::tm_data_type_base::format_type );
end_package(std);
end_package(lestes);

#endif // lestes__md__types__tm_data_type_base_g_hh__included

---