SgAsmDOSFileHeader.h

 
#ifndef ROSE_SgAsmDOSFileHeader_H
#define ROSE_SgAsmDOSFileHeader_H
#include <RoseFirst.h>
#include <Cxx_GrammarDeclarations.h>
#include <SgAsmGenericHeader.h>
 
 
 
/* #line 1 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
// WARNING -- GENERATED CODE -- DO NOT MODIFY THIS CODE -- WARNING!
//      This code is automatically generated for each 
//      terminal and non-terminal within the defined 
//      grammar.  There is a simple way to change the 
//      code to fix bugs etc.  See the ROSE README file
//      for directions.
 
// tps: (02/22/2010): Adding DLL export requirements
#include "rosedll.h"
 
// predeclarations for SgAsmDOSFileHeader
 
/* #line 25 "../../../src/frontend/SageIII//SgAsmDOSFileHeader.h" */
/* #line 28632 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
#include <Rose/BinaryAnalysis/Address.h>
 
 
/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
 
/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
#if !defined(DOCUMENTATION)
// Class Definition for SgAsmDOSFileHeader
class ROSE_DLL_API SgAsmDOSFileHeader  : public SgAsmGenericHeader
   {
     public:
 
 
/* #line 42 "../../../src/frontend/SageIII//SgAsmDOSFileHeader.h" */
 
          virtual SgNode* copy ( SgCopyHelp& help) const override;
// Start of memberFunctionString
/* #line 28741 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
 
 
    //----------------------- Boost serialization for SgAsmDOSFileHeader -----------------------
#ifdef ROSE_ENABLE_BOOST_SERIALIZATION
private:
    friend class boost::serialization::access;
 
    template<class S>
    void serialize(S &s, const unsigned /*version*/) {
        debugSerializationBegin("SgAsmDOSFileHeader");
        s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmGenericHeader);
        s & BOOST_SERIALIZATION_NVP(p_e_last_page_size);
        s & BOOST_SERIALIZATION_NVP(p_e_total_pages);
        s & BOOST_SERIALIZATION_NVP(p_e_nrelocs);
        s & BOOST_SERIALIZATION_NVP(p_e_header_paragraphs);
        s & BOOST_SERIALIZATION_NVP(p_e_minalloc);
        s & BOOST_SERIALIZATION_NVP(p_e_maxalloc);
        s & BOOST_SERIALIZATION_NVP(p_e_ss);
        s & BOOST_SERIALIZATION_NVP(p_e_sp);
        s & BOOST_SERIALIZATION_NVP(p_e_cksum);
        s & BOOST_SERIALIZATION_NVP(p_e_ip);
        s & BOOST_SERIALIZATION_NVP(p_e_cs);
        s & BOOST_SERIALIZATION_NVP(p_e_overlay);
        s & BOOST_SERIALIZATION_NVP(p_e_relocs_offset);
        s & BOOST_SERIALIZATION_NVP(p_e_res1);
        s & BOOST_SERIALIZATION_NVP(p_relocs);
        s & BOOST_SERIALIZATION_NVP(p_rm_section);
        debugSerializationEnd("SgAsmDOSFileHeader");
    }
#endif // ROSE_ENABLE_BOOST_SERIALIZATION
    // Local types
public:
#ifdef _MSC_VER
# pragma pack (1)
#endif
    struct DOSFileHeader_disk {
        unsigned char e_magic[2];                
        uint16_t      e_last_page_size;           //
        uint16_t      e_total_pages;             
        uint16_t      e_nrelocs;                 
        uint16_t      e_header_paragraphs;       
        uint16_t      e_minalloc;                
        uint16_t      e_maxalloc;                
        uint16_t      e_ss;                      
        uint16_t      e_sp;                      
        uint16_t      e_cksum;                   
        uint16_t      e_ip;                      
        uint16_t      e_cs;                      
        uint16_t      e_relocs_offset;           
        uint16_t      e_overlay;                 
        uint32_t      e_res1;                    
    }                                            /* 0x20 */
#if !defined(SWIG) && !defined(_MSC_VER)
    __attribute__((packed))
#endif
    ;
 
    struct DOSRelocEntry_disk {
        uint16_t      offset;                       /* 0x00 */
        uint16_t      segment;                      /* 0x02 */
    }                                               /* 0x04 */
#if !defined(SWIG) && !defined(_MSC_VER)
    __attribute__((packed))
#endif
    ;
 
#ifdef _MSC_VER
# pragma pack ()
#endif
 
    // Properties
public:
public:
    uint16_t const& get_e_last_page_size() const;
    void set_e_last_page_size(uint16_t const&);
public:
    uint16_t const& get_e_total_pages() const;
    void set_e_total_pages(uint16_t const&);
public:
    uint16_t const& get_e_nrelocs() const;
    void set_e_nrelocs(uint16_t const&);
public:
    uint16_t const& get_e_header_paragraphs() const;
    void set_e_header_paragraphs(uint16_t const&);
public:
    uint16_t const& get_e_minalloc() const;
    void set_e_minalloc(uint16_t const&);
public:
    uint16_t const& get_e_maxalloc() const;
    void set_e_maxalloc(uint16_t const&);
public:
    uint16_t const& get_e_ss() const;
    void set_e_ss(uint16_t const&);
public:
    uint16_t const& get_e_sp() const;
    void set_e_sp(uint16_t const&);
public:
    uint16_t const& get_e_cksum() const;
    void set_e_cksum(uint16_t const&);
public:
    uint16_t const& get_e_ip() const;
    void set_e_ip(uint16_t const&);
public:
    uint16_t const& get_e_cs() const;
    void set_e_cs(uint16_t const&);
public:
    uint16_t const& get_e_overlay() const;
    void set_e_overlay(uint16_t const&);
public:
    Rose::BinaryAnalysis::Address const& get_e_relocs_offset() const;
    void set_e_relocs_offset(Rose::BinaryAnalysis::Address const&);
public:
    unsigned const& get_e_res1() const;
    void set_e_res1(unsigned const&);
public:
    SgAsmGenericSection* const& get_relocs() const;
    void set_relocs(SgAsmGenericSection* const&);
public:
    SgAsmGenericSection* const& get_rm_section() const;
    void set_rm_section(SgAsmGenericSection* const&);
    // Functions
public:
    explicit SgAsmDOSFileHeader(SgAsmGenericFile*);
    virtual SgAsmDOSFileHeader *parse() override {return parse(true);}
    SgAsmDOSFileHeader *parse(bool define_rm_section);
    virtual bool reallocate() override;
    virtual void unparse(std::ostream&) const override;
    virtual void dump(FILE*, const char *prefix, ssize_t idx) const override;
    virtual const char *formatName() const override;
 
    SgAsmGenericSection *parseRealModeSection(Rose::BinaryAnalysis::Address max_offset=0);
 
    void updateFromRealModeSection();
 
    static bool isDos(SgAsmGenericFile*);
 
private:
    void *encode(SgAsmDOSFileHeader::DOSFileHeader_disk*) const;
 
    // Deprecated 2023-11
public:
    virtual const char* format_name() const override ROSE_DEPRECATED("use formatName");
    SgAsmGenericSection* parse_rm_section(Rose::BinaryAnalysis::Address max_offset = 0) ROSE_DEPRECATED("use parseRealModeSection");
    void update_from_rm_section() ROSE_DEPRECATED("use updateFromRealModeSection");
    static bool is_DOS(SgAsmGenericFile*) ROSE_DEPRECATED("use isDos");
public:
    virtual ~SgAsmDOSFileHeader();
 
public:
    SgAsmDOSFileHeader();
 
protected:
    void initializeProperties();
 
 
// End of memberFunctionString
// Start of memberFunctionString
/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
 
// *** COMMON CODE SECTION BEGINS HERE ***
 
    public:
 
       // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required 
       // and not required which is required to match the other aspects of the copy mechanism code generation.
       // Specifically it is a problem to declare the copy function everywhere because it is not implemented 
       // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
       /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
       // virtual SgNode* copy ( const SgCopyHelp & help) const;
 
          virtual std::string class_name() const override;
 
          virtual VariantT variantT() const override; // MS: new variant used in tree traversal
 
       // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
       // static const VariantT static_variant = V_SgAsmDOSFileHeader;
          enum { static_variant = V_SgAsmDOSFileHeader };
 
       /* the generated cast function */
          ROSE_DLL_API friend       SgAsmDOSFileHeader* isSgAsmDOSFileHeader(       SgNode * s );
 
          ROSE_DLL_API friend const SgAsmDOSFileHeader* isSgAsmDOSFileHeader( const SgNode * s );
 
     // ******************************************
     // * Memory Pool / New / Delete
     // ******************************************
 
     public:
          static const unsigned pool_size; // 
          static std::vector<unsigned char *> pools; // 
          static SgAsmDOSFileHeader * next_node; // 
 
          static unsigned long initializeStorageClassArray(SgAsmDOSFileHeaderStorageClass *); // 
 
          static void clearMemoryPool(); // 
          static void deleteMemoryPool(); // 
 
          static void extendMemoryPoolForFileIO(); // 
 
          static SgAsmDOSFileHeader * getPointerFromGlobalIndex(unsigned long); // 
          static SgAsmDOSFileHeader * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); // 
 
          static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); // 
          static void resetValidFreepointers(); // 
          static unsigned long getNumberOfLastValidPointer(); // 
 
 
#if defined(INLINE_FUNCTIONS)
          inline void *operator new (size_t size);
#else
          void *operator new (size_t size);
#endif
          void operator delete (void* pointer, size_t size);
 
       // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
          void operator delete (void* pointer)
             {
            // This is the generated delete operator...
               SgAsmDOSFileHeader::operator delete (pointer,sizeof(SgAsmDOSFileHeader));
             }
 
          static size_t numberOfNodes();
 
          static size_t memoryUsage();
 
      // End of scope which started in IR nodes specific code 
      /* */
 
      /* name Internal Functions
          \brief Internal functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgeable users for specialized tools or applications.
 
          \internal We could not make these private because they are required by user for special purposes. And 
              it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
         
       */
 
       // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
       // overridden in every class by *generated* implementation
          virtual std::vector<SgNode*> get_traversalSuccessorContainer() const override;
       // MS: 06/28/02 container of names of variables or container indices 
       // used used in the traversal to access AST successor nodes
       // overridden in every class by *generated* implementation
          virtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override;
 
       // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
       // than all the vector copies. The implementation for these functions is generated for each class.
          virtual size_t get_numberOfTraversalSuccessors() const override;
          virtual SgNode *get_traversalSuccessorByIndex(size_t idx) const override;
          virtual size_t get_childIndex(SgNode *child) const override;
 
#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
       // MS: 08/16/2002 method for generating RTI information
          virtual RTIReturnType roseRTI() override;
#endif
      /* */
 
 
 
      /* name Deprecated Functions
          \brief Deprecated functions ... incomplete-documentation
 
          These functions have been deprecated from use.
       */
      /* */
 
          virtual const char* sage_class_name() const  override ROSE_DEPRECATED_FUNCTION;
 
      // JJW (10/16/2008): Changed to a single function in Node.code, and put
      // getVariant() in #if 0 block to prevent confusing Doxygen
#if 0
          virtual int variant() const ROSE_DEPRECATED_FUNCTION;
       // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
#endif
      /* */
 
 
 
 
     public:
      /* name Traversal Support Functions
          \brief Traversal support functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgable users for specialized tools or applications.
       */
      /* */
 
       // DQ (11/26/2005): Support for visitor pattern mechanims
       // (inferior to ROSE traversal mechanism, experimental).
          void executeVisitorMemberFunction (ROSE_VisitorPattern & visitor);
 
      /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
          virtual void accept (ROSE_VisitorPattern & visitor) override;
 
       // DQ (12/26/2005): Support for traversal based on the memory pool
          static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
 
          static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern & visitor);
 
       // DQ (2/9/2006): Added to support traversal over single representative of each IR node
       // This traversal helps support internal tools that call static member functions.
       // note: this function operates on the memory pools.
          static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
      /* */
 
     public: 
        /* NodeId support functions */
        static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
        static SgAsmDOSFileHeader* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
        static std::string getNodeIdString(SgAsmDOSFileHeader* sgnode);
        static std::string getNodeIdStringInternal(SgAsmDOSFileHeader* sgnode);
 
     public:
      /* name Memory Allocation Functions
          \brief Memory allocations functions ... incomplete-documentation
 
          These functions have been made public as part of the design, but they are suggested for internal use 
          or by particularly knowledgable users for specialized tools or applications.
       */
      /* */
 
          virtual bool isInMemoryPool() override;
 
          virtual void checkDataMemberPointersIfInMemoryPool() override;
 
      // DQ (4/30/2006): Modified to be a const function.
          virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
 
          virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override;
 
          virtual long getChildIndex( SgNode* childNode ) const override;
 
      // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Constructor for use by AST File I/O Mechanism
 
          This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory 
          which obtained via fast binary file I/O from disk.
       */
       // SgAsmDOSFileHeader( SgAsmDOSFileHeaderStorageClass& source );
 
 
 
 
 
 // JH (10/24/2005): methods added to support the ast file IO
    private:
 
      /* name AST Memory Allocation Support Functions
          \brief Memory allocations support....
 
          These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated 
          in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
          and support the AST File I/O Mechanism.
       */
      /* */
 
       /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
          we compare them. Since I had several problems with this, I decided to make a typdef to ensure
          that I use the same type everywhere, if any changes are made. THe second one declares the type
          (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
          might got changed, but unfortunatly, the return types are still unsigned longs. There exists
          a correspinding one in the AST_FILE_IO class!
       */
      // DQ (9/2/2015): This typedef is no longer used, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Typedef used for low level memory access.
       */
       // typedef unsigned char* TestType;
 
      // DQ (9/2/2015): This typedef is no longer used, we can't define the 
      // comment here (changed to be a C style comment and not be a doxygen comment).
      /* \brief Typedef used to hold memory addresses as values.
       */
       // typedef unsigned long  AddressType;
 
 
 
       // necessary, to have direct access to the p_freepointer and the private methods !
          friend class AST_FILE_IO;
 
          friend class SgAsmDOSFileHeaderStorageClass;
 
          friend class AstSpecificDataManagingClass;
 
          friend class AstSpecificDataManagingClassStorageClass;
    public:
          SgAsmDOSFileHeader( const SgAsmDOSFileHeaderStorageClass& source );
 
 // private: // JJW hack
       /*
          name AST Memory Allocation Support Variables
          Memory allocations support variables 
 
          These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated 
          in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
          and support the AST File I/O Mechanism.
       */
      /* */
 
    public:
 
      // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer 
      // to current node (so that it will work cleanly with build functions to specify patterns).
      // virtual SgNode* addRegExpAttribute();
          SgAsmDOSFileHeader* addRegExpAttribute(std::string s, AstRegExAttribute* a);
 
#ifndef _MSC_VER
// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
// and likely never fully implemented nor tested.  Files remain in the src tree but are no
// longer built.
#define BUILD_ATERM_SUPPORT 0
   #if BUILD_ATERM_SUPPORT
   #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
      // DQ (10/4/2014): Adding ATerm support to ROSE.
       // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
          virtual ATerm generate_ATerm() override;
 
          virtual void generate_ATerm_Annotation(ATerm & term) override;
   #endif
   #endif // BUILD_ATERM_SUPPORT
#endif
       // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
       // virtual generate_AST(ATerm & term);
       // virtual void read_ATerm_Annotation(ATerm & term);
 
// *** COMMON CODE SECTION ENDS HERE ***
 
 
// End of memberFunctionString
// Start of memberFunctionString
/* #line 710 "/workspace/src/ROSETTA/Grammar/Node.code" */
 
     // the generated cast function
     // friend ROSE_DLL_API SgAsmDOSFileHeader* isSgAsmDOSFileHeader ( SgNode* s );
 
          typedef SgAsmGenericHeader base_node_type;
 
 
// End of memberFunctionString
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
    protected:
// Start of memberFunctionString
uint16_t p_e_last_page_size;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_total_pages;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_nrelocs;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_header_paragraphs;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_minalloc;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_maxalloc;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_ss;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_sp;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_cksum;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_ip;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_cs;
          
// End of memberFunctionString
// Start of memberFunctionString
uint16_t p_e_overlay;
          
// End of memberFunctionString
// Start of memberFunctionString
Rose::BinaryAnalysis::Address p_e_relocs_offset;
          
// End of memberFunctionString
// Start of memberFunctionString
unsigned p_e_res1;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmGenericSection* p_relocs;
          
// End of memberFunctionString
// Start of memberFunctionString
SgAsmGenericSection* p_rm_section;
          
// End of memberFunctionString
 
    friend struct Rose::Traits::generated::describe_node_t<SgAsmDOSFileHeader>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_last_page_size>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_total_pages>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_nrelocs>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_header_paragraphs>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_minalloc>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_maxalloc>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_ss>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_sp>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_cksum>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_ip>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_cs>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, uint16_t,&SgAsmDOSFileHeader::p_e_overlay>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, Rose::BinaryAnalysis::Address,&SgAsmDOSFileHeader::p_e_relocs_offset>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, unsigned,&SgAsmDOSFileHeader::p_e_res1>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, SgAsmGenericSection*,&SgAsmDOSFileHeader::p_relocs>;
    friend struct Rose::Traits::generated::describe_field_t<SgAsmDOSFileHeader, SgAsmGenericSection*,&SgAsmDOSFileHeader::p_rm_section>;
 
/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
   };
#endif
 
// postdeclarations for SgAsmDOSFileHeader
 
/* #line 855 "../../../src/frontend/SageIII//SgAsmDOSFileHeader.h" */
 
/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
 
/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
 
 
/* #line 862 "../../../src/frontend/SageIII//SgAsmDOSFileHeader.h" */
 
#endif // ROSE_SgAsmDOSFileHeader_H