SgFile Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgFile:

[legend]Collaboration diagram for SgFile:

Detailed Description

This class represents a source file for a project (which may contian many source files and or directories).

This IR node contains information specific to this file and references the project for more project (global) information. The dominately useful data in this IR node is the pointer to the global scope for this file (structurally global scope, but actually file scope and global scope by C++ scoping rules).

For internal use only.

This IR node does not appear many times in an AST. Also it is current rather bizzar that we keep all the file names instead of just the single relavant one! This should be fixed as it is confusing.

Todo:: The ROSEAttributesListContainerPtr p_preprocessorDirectivesAndCommentsList should be implemented a list instead of a pointer to a list. This might require a list copy in the internal hand,ing, but would simplify the design and there is not the same memory constraint of having a pointer to a list vs. a list here because the list is almost always valid (most source code incluses at least one comment or CPP directive) and there is only one SgFile object per source file (so there are relatively few SgFile nodes in even a very large AST).

Todo:: This IR nodes now has a Sg_File_Info pointer, however it needs to be made consistant with the filename that is returned from SgFile::get_fileName().

Todo:: The default constructor for SgFile sets the SgGlobal pointer to NULL and perhaps it would be better if it set it to a valid SgGlobal object then we would have a better defined empty list of declarations.

Todo:: Yarden has suggested we provide a way to modify the link line that would be generated to support the backend compilation. I think we should have a list of strings that could be added to the link line (appended to the end would be the simplist). Else we need a virtual function that could be overloaded to customize the control over the link command generation (however we want to discourage the derivation of user defined IR nodes from existing IR nodes since this would break some of the internal mechanisms that use the memory pools).

See also:: Example of using a SgFile object

Public Types

e_unknown_output_format

e_fixed_form_output_format

e_free_form_output_format

e_error_output_language

e_default_output_language

e_C_output_language

e_Cxx_output_language

e_Fortran_output_language

e_Promela_output_language

e_PHP_output_language

e_last_output_language

enum outputFormatOption_enum {
  e_unknown_output_format,
  e_fixed_form_output_format,
  e_free_form_output_format
}

Enum type used to specify output of Fortran as fixed for free format. More...

enum outputLanguageOption_enum {
  e_error_output_language,
  e_default_output_language,
  e_C_output_language,
  e_Cxx_output_language,
  e_Fortran_output_language,
  e_Promela_output_language,
  e_PHP_output_language,
  e_last_output_language
}

Enum type used to specify output language (option used for testing unparsers). More...

Public Member Functions

virtual SgNode * copy (SgCopyHelp &help) const

SgFile (int &argc, char **&argv, SgProject *project=NULL)

The only useful constructor (the argc and argv are the user's command line inputs and the errorCode is the return value assembled from the multiple error codes associated with the different phases of the compilation.

SgFile (std::vector< std::string > &argv, SgProject *project=NULL)

virtual void doSetupForConstructor (const std::vector< std::string > &argv, SgProject *project)

void initialization ()

Initialization support for constructors.

void unparse (UnparseFormatHelp *unparseHelp=NULL, UnparseDelegate *unparseDelagate=NULL)

Generate the C++ file representing the AST.

int compileOutput (int fileNameIndex, const std::string &compilerName)

Member function to compile the resulting output file from unparsing.

std::string getFileName () const

associated filename

virtual int callFrontEnd ()

Move this function from ROSE into the AST restructuring tool.

void secondaryPassOverSourceFile ()

Fixups to be run when the whole project has been created (this attaches preprocessing information).

virtual int buildAST (std::vector< std::string > argv, std::vector< std::string > inputCommandLine)

void processRoseCommandLineOptions (std::vector< std::string > &argv)

Move this function from ROSE into the AST restructuring tool.

void processBackendSpecificCommandLineOptions (const std::vector< std::string > &argv)

void build_EDG_CommandLine (std::vector< std::string > &inputCommandLine, std::vector< std::string > &argv, int fileNameIndex)

std::string getWorkingDirectory ()

Move this function from ROSE into the AST restructuring tool.

std::string getSourceDirectory ()

std::string generateOutputFileName () const

Generate an output filename from the source file name (xxx.C -> rose_xxx.C -> xxx.o -> xxx).

std::string generate_C_preprocessor_intermediate_filename (std::string filename)

Support for C preprocessed files (Fortran only).

std::vector< std::string > buildCompilerCommandLineOptions (std::vector< std::string > &argv, int fileNameIndex, const std::string &compilerName)

int compileOutput (std::vector< std::string > &argv, int fileNameIndex, const std::string &compilerName)

void display (const std::string &label) const

bool isPrelinkPhase () const

Test if project is compiled with -prelink as signal that we are prelinking and we have to process the generated code instead of the user's application (to see and instatiate all templates).

SgProject * get_project ()

Get the SgProject IR node if available (template instantiation information is stored there).

SgFile (const SgFile &X)

Sg_File_Info * get_file_info () const

Access function calling get_startOfConstruct(), provided to support older interface.

void set_file_info (Sg_File_Info *fileinfo)

Access function calling set_startOfConstruct(), provided to support older interface.

void initializeSourcePosition (const std::string &sourceFilename)

virtual void addNewAttribute (std::string s, AstAttribute *a)

Add a new attribute represented by the named string.

virtual AstAttribute * getAttribute (std::string s) const

Returns attribute of name 's'.

virtual void updateAttribute (std::string s, AstAttribute *a)

Replace existing attribute of name 's' with new AstAttribute.

virtual void setAttribute (std::string s, AstAttribute *a)

This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.

virtual void removeAttribute (std::string s)

Remove attribute of name 's' if present.

virtual bool attributeExists (std::string s) const

Tests if attribute of name 's' is present.

virtual int numberOfAttributes () const

Returns the number of attributes on this IR node.

virtual std::string class_name () const

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

virtual VariantT variantT () const

returns new style SageIII enum values

void * operator new (size_t size)

returns pointer to newly allocated IR node

void operator delete (void *pointer, size_t size)

deallocated memory for IR node (returns memory to memory pool for reuse)

void operator delete (void *pointer)

virtual std::vector< SgNode * > get_traversalSuccessorContainer ()

FOR INTERNAL USE within ROSE traverals mechanism only.

virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()

FOR INTERNAL USE within ROSE traverals mechanism only.

virtual size_t get_numberOfTraversalSuccessors ()

virtual SgNode * get_traversalSuccessorByIndex (size_t idx)

virtual size_t get_childIndex (SgNode *child)

virtual RTIReturnType roseRTI ()

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION

void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual bool isInMemoryPool ()

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

virtual void checkDataMemberPointersIfInMemoryPool ()

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

virtual std::vector< std::pair<
SgNode *, std::string > > returnDataMemberPointers () const

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

virtual long getChildIndex (SgNode *childNode) const

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

SgFile (const SgFileStorageClass &source)

SgFile * addRegExpAttribute (std::string s, AstRegExAttribute *a)

Support for AST matching using regular expression.

Sg_File_Info * get_startOfConstruct () const

New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).

void set_startOfConstruct (Sg_File_Info *startOfConstruct)

SgStringList get_originalCommandLineArgumentList () const

Returns a list of strings representing the original command-line.

void set_originalCommandLineArgumentList (SgStringList originalCommandLineArgumentList)

int get_verbose () const

void set_verbose (int verbose)

bool get_output_warnings () const

void set_output_warnings (bool output_warnings)

bool get_C_only () const

void set_C_only (bool C_only)

bool get_UPC_only () const

void set_UPC_only (bool UPC_only)

int get_upc_threads () const

void set_upc_threads (int upc_threads)

bool get_C99_only () const

void set_C99_only (bool C99_only)

bool get_Cxx_only () const

void set_Cxx_only (bool Cxx_only)

bool get_Fortran_only () const

void set_Fortran_only (bool Fortran_only)

bool get_F77_only () const

void set_F77_only (bool F77_only)

bool get_F90_only () const

void set_F90_only (bool F90_only)

bool get_F95_only () const

void set_F95_only (bool F95_only)

bool get_F2003_only () const

void set_F2003_only (bool F2003_only)

bool get_CoArrayFortran_only () const

void set_CoArrayFortran_only (bool CoArrayFortran_only)

bool get_PHP_only () const

void set_PHP_only (bool PHP_only)

bool get_requires_C_preprocessor () const

void set_requires_C_preprocessor (bool requires_C_preprocessor)

bool get_binary_only () const

void set_binary_only (bool binary_only)

SgFile::outputFormatOption_enum get_inputFormat () const

void set_inputFormat (SgFile::outputFormatOption_enum inputFormat)

SgFile::outputFormatOption_enum get_outputFormat () const

void set_outputFormat (SgFile::outputFormatOption_enum outputFormat)

SgFile::outputFormatOption_enum get_backendCompileFormat () const

void set_backendCompileFormat (SgFile::outputFormatOption_enum backendCompileFormat)

bool get_fortran_implicit_none () const

void set_fortran_implicit_none (bool fortran_implicit_none)

bool get_openmp () const

void set_openmp (bool openmp)

bool get_openmp_parse_only () const

void set_openmp_parse_only (bool openmp_parse_only)

bool get_openmp_ast_only () const

void set_openmp_ast_only (bool openmp_ast_only)

bool get_openmp_lowering () const

void set_openmp_lowering (bool openmp_lowering)

bool get_cray_pointer_support () const

void set_cray_pointer_support (bool cray_pointer_support)

bool get_output_parser_actions () const

void set_output_parser_actions (bool output_parser_actions)

bool get_exit_after_parser () const

void set_exit_after_parser (bool exit_after_parser)

bool get_skip_syntax_check () const

void set_skip_syntax_check (bool skip_syntax_check)

bool get_skip_transformation () const

void set_skip_transformation (bool skip_transformation)

bool get_skip_unparse () const

void set_skip_unparse (bool skip_unparse)

bool get_skipfinalCompileStep () const

void set_skipfinalCompileStep (bool skipfinalCompileStep)

bool get_unparse_includes () const

void set_unparse_includes (bool unparse_includes)

bool get_unparse_line_directives () const

void set_unparse_line_directives (bool unparse_line_directives)

bool get_unparse_instruction_addresses () const

void set_unparse_instruction_addresses (bool unparse_instruction_addresses)

bool get_unparse_raw_memory_contents () const

void set_unparse_raw_memory_contents (bool unparse_raw_memory_contents)

bool get_unparse_binary_file_format () const

void set_unparse_binary_file_format (bool unparse_binary_file_format)

SgFile::outputLanguageOption_enum get_outputLanguage () const

void set_outputLanguage (SgFile::outputLanguageOption_enum outputLanguage)

std::string get_sourceFileNameWithPath () const

void set_sourceFileNameWithPath (std::string sourceFileNameWithPath)

std::string get_sourceFileNameWithoutPath () const

void set_sourceFileNameWithoutPath (std::string sourceFileNameWithoutPath)

std::string get_unparse_output_filename () const

void set_unparse_output_filename (std::string unparse_output_filename)

bool get_useBackendOnly () const

void set_useBackendOnly (bool useBackendOnly)

bool get_compileOnly () const

void set_compileOnly (bool compileOnly)

std::string get_savedEdgCommandLine () const

void set_savedEdgCommandLine (std::string savedEdgCommandLine)

bool get_no_implicit_templates () const

void set_no_implicit_templates (bool no_implicit_templates)

bool get_no_implicit_inline_templates () const

void set_no_implicit_inline_templates (bool no_implicit_inline_templates)

bool get_skip_commentsAndDirectives () const

void set_skip_commentsAndDirectives (bool skip_commentsAndDirectives)

bool get_collectAllCommentsAndDirectives () const

void set_collectAllCommentsAndDirectives (bool collectAllCommentsAndDirectives)

ROSEAttributesListContainerPtr get_preprocessorDirectivesAndCommentsList () const

void set_preprocessorDirectivesAndCommentsList (ROSEAttributesListContainerPtr preprocessorDirectivesAndCommentsList)

AstAttributeMechanism * get_attributeMechanism () const

FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.

void set_attributeMechanism (AstAttributeMechanism *attributeMechanism)

FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.

bool get_KCC_frontend () const

void set_KCC_frontend (bool KCC_frontend)

bool get_new_frontend () const

void set_new_frontend (bool new_frontend)

bool get_disable_edg_backend () const

void set_disable_edg_backend (bool disable_edg_backend)

bool get_disable_sage_backend () const

void set_disable_sage_backend (bool disable_sage_backend)

int get_testingLevel () const

void set_testingLevel (int testingLevel)

bool get_preinit_il () const

void set_preinit_il (bool preinit_il)

bool get_enable_cp_backend () const

void set_enable_cp_backend (bool enable_cp_backend)

bool get_markGeneratedFiles () const

void set_markGeneratedFiles (bool markGeneratedFiles)

bool get_negative_test () const

void set_negative_test (bool negative_test)

bool get_strict_language_handling () const

void set_strict_language_handling (bool strict_language_handling)

bool get_wave () const

void set_wave (bool wave)

int get_embedColorCodesInGeneratedCode () const

void set_embedColorCodesInGeneratedCode (int embedColorCodesInGeneratedCode)

int get_generateSourcePositionCodes () const

void set_generateSourcePositionCodes (int generateSourcePositionCodes)

bool get_sourceFileUsesCppFileExtension () const

void set_sourceFileUsesCppFileExtension (bool sourceFileUsesCppFileExtension)

bool get_sourceFileUsesFortranFileExtension () const

void set_sourceFileUsesFortranFileExtension (bool sourceFileUsesFortranFileExtension)

bool get_sourceFileUsesFortran77FileExtension () const

void set_sourceFileUsesFortran77FileExtension (bool sourceFileUsesFortran77FileExtension)

bool get_sourceFileUsesFortran90FileExtension () const

void set_sourceFileUsesFortran90FileExtension (bool sourceFileUsesFortran90FileExtension)

bool get_sourceFileUsesFortran95FileExtension () const

void set_sourceFileUsesFortran95FileExtension (bool sourceFileUsesFortran95FileExtension)

bool get_sourceFileUsesFortran2003FileExtension () const

void set_sourceFileUsesFortran2003FileExtension (bool sourceFileUsesFortran2003FileExtension)

bool get_sourceFileUsesCoArrayFortranFileExtension () const

void set_sourceFileUsesCoArrayFortranFileExtension (bool sourceFileUsesCoArrayFortranFileExtension)

bool get_sourceFileUsesPHPFileExtension () const

void set_sourceFileUsesPHPFileExtension (bool sourceFileUsesPHPFileExtension)

bool get_sourceFileUsesBinaryFileExtension () const

void set_sourceFileUsesBinaryFileExtension (bool sourceFileUsesBinaryFileExtension)

bool get_sourceFileTypeIsUnknown () const

void set_sourceFileTypeIsUnknown (bool sourceFileTypeIsUnknown)

bool get_read_executable_file_format_only () const

void set_read_executable_file_format_only (bool read_executable_file_format_only)

bool get_visualize_executable_file_format_skip_symbols () const

void set_visualize_executable_file_format_skip_symbols (bool visualize_executable_file_format_skip_symbols)

bool get_visualize_dwarf_only () const

void set_visualize_dwarf_only (bool visualize_dwarf_only)

bool get_read_instructions_only () const

void set_read_instructions_only (bool read_instructions_only)

bool get_skip_unparse_asm_commands () const

void set_skip_unparse_asm_commands (bool skip_unparse_asm_commands)

const SgStringList & get_libraryArchiveObjectFileNameList () const

SgStringList & get_libraryArchiveObjectFileNameList ()

bool get_isLibraryArchive () const

void set_isLibraryArchive (bool isLibraryArchive)

bool get_isObjectFile () const

void set_isObjectFile (bool isObjectFile)

unsigned get_disassemblerSearchHeuristics () const

void set_disassemblerSearchHeuristics (unsigned disassemblerSearchHeuristics)

unsigned get_partitionerSearchHeuristics () const

void set_partitionerSearchHeuristics (unsigned partitionerSearchHeuristics)

virtual ~SgFile ()

This is the destructor.

SgFile ()

This is the constructor.

Static Public Member Functions

static void stripRoseCommandLineOptions (std::vector< std::string > &argv)

function that removes all rose related options from a command line

static void stripEdgCommandLineOptions (std::vector< std::string > &argv)

function that removes all EDG related options from a command line

static void usage (int status)

Move this function from ROSE into the AST restructuring tool.

static int numberOfNodes ()

Returns the total number of IR nodes of this type.

static int memoryUsage ()

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)

FOR INTERNAL USE Support for visitor pattern.

static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)

FOR INTERNAL USE Support for visitor pattern.

static void visitRepresentativeNode (ROSE_VisitTraversal &visit)

FOR INTERNAL USE Support for type-based traversal.

Static Public Attributes

static const VariantT static_variant = V_SgFile

static variant value

Protected Attributes

Sg_File_Info * p_startOfConstruct

SgStringList p_originalCommandLineArgumentList

Copy of original argc and argv command line passed to ROSE translator (converted to STL list of strings).

int p_verbose

bool p_output_warnings

bool p_C_only

bool p_UPC_only

int p_upc_threads

bool p_C99_only

bool p_Cxx_only

bool p_Fortran_only

bool p_F77_only

bool p_F90_only

bool p_F95_only

bool p_F2003_only

bool p_CoArrayFortran_only

bool p_PHP_only

bool p_requires_C_preprocessor

bool p_binary_only

SgFile::outputFormatOption_enum p_inputFormat

SgFile::outputFormatOption_enum p_outputFormat

SgFile::outputFormatOption_enum p_backendCompileFormat

bool p_fortran_implicit_none

bool p_openmp

bool p_openmp_parse_only

bool p_openmp_ast_only

bool p_openmp_lowering

bool p_cray_pointer_support

bool p_output_parser_actions

bool p_exit_after_parser

bool p_skip_syntax_check

bool p_skip_transformation

bool p_skip_unparse

bool p_skipfinalCompileStep

bool p_unparse_includes

bool p_unparse_line_directives

bool p_unparse_instruction_addresses

bool p_unparse_raw_memory_contents

bool p_unparse_binary_file_format

SgFile::outputLanguageOption_enum p_outputLanguage

std::string p_sourceFileNameWithPath

std::string p_sourceFileNameWithoutPath

std::string p_unparse_output_filename

bool p_useBackendOnly

bool p_compileOnly

std::string p_savedEdgCommandLine

bool p_no_implicit_templates

This is a reference to the GNU g++ command line option (same name).

bool p_no_implicit_inline_templates

This is a reference to the GNU g++ command line option (same name).

bool p_skip_commentsAndDirectives

bool p_collectAllCommentsAndDirectives

ROSEAttributesListContainerPtr p_preprocessorDirectivesAndCommentsList

This is the container of comments and preprocessor control statements that was extracted from the file and which has been woven back into the AST (using heuristics).

AstAttributeMechanism * p_attributeMechanism

bool p_KCC_frontend

bool p_new_frontend

bool p_disable_edg_backend

bool p_disable_sage_backend

int p_testingLevel

bool p_preinit_il

bool p_enable_cp_backend

bool p_markGeneratedFiles

bool p_negative_test

bool p_strict_language_handling

bool p_wave

int p_embedColorCodesInGeneratedCode

int p_generateSourcePositionCodes

bool p_sourceFileUsesCppFileExtension

bool p_sourceFileUsesFortranFileExtension

bool p_sourceFileUsesFortran77FileExtension

bool p_sourceFileUsesFortran90FileExtension

bool p_sourceFileUsesFortran95FileExtension

bool p_sourceFileUsesFortran2003FileExtension

bool p_sourceFileUsesCoArrayFortranFileExtension

bool p_sourceFileUsesPHPFileExtension

bool p_sourceFileUsesBinaryFileExtension

bool p_sourceFileTypeIsUnknown

bool p_read_executable_file_format_only

bool p_visualize_executable_file_format_skip_symbols

bool p_visualize_dwarf_only

bool p_read_instructions_only

bool p_skip_unparse_asm_commands

SgStringList p_libraryArchiveObjectFileNameList

bool p_isLibraryArchive

bool p_isObjectFile

unsigned p_disassemblerSearchHeuristics

unsigned p_partitionerSearchHeuristics

Friends

class AST_FILE_IO

class SgFileStorageClass

class AstSpecificDataManagingClass

class AstSpecificDataManagingClassStorageClass

void alternativeSageEdgInterfaceConstruction (SgFile *file)

Move this function from ROSE into the AST restructuring tool.

SgFile * isSgFile (SgNode *s)

Casts pointer from base class to derived class.

const SgFile * isSgFile (const SgNode *s)

Casts pointer from base class to derived class (for const pointers).

SgFile * SgFile_getPointerFromGlobalIndex (unsigned long globalIndex)

Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.

unsigned long SgFile_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)

Get the size of the memory pool.

void SgFile_clearMemoryPool ()

void SgFile_extendMemoryPoolForFileIO (unsigned long)

void SgFile_getNextValidPointer (std::pair< SgFile *, std::vector< unsigned char * >::const_iterator > &)

void SgFile_resetValidFreepointers ()

Member Enumeration Documentation

enum SgFile::outputFormatOption_enum

Enum type used to specify output of Fortran as fixed for free format.

For internal use only.

Has no effect on C/C++ code generation.

Enumerator:

e_unknown_output_format	default value (uses filename extension to determine the output format, f77: fixed, F90 and later: free)
e_fixed_form_output_format	value used to specify output of Fortran as fixed format
e_free_form_output_format	value used to specify output of Fortran as free format

enum SgFile::outputLanguageOption_enum

Enum type used to specify output language (option used for testing unparsers).

For internal use only.

This is only for testing the unparsers and some language constructs will not unparse. This is also a way to play with some language translation ideas, but most useful one will require a specialized tranlator to be built.

Enumerator:

e_error_output_language	error value (uses filename extension to determine the output format, f77: fixed, F90 and later: free)
e_default_output_language	default value (uses filename extension to determine the output format, f77: fixed, F90 and later: free)
e_C_output_language	value used to specify output of C (for testing C unparser)
e_Cxx_output_language	value used to specify output of C++ (for testing C++ unparser)
e_Fortran_output_language	value used to specify output of Fortran (for testing the Fortran unparser from C)
e_Promela_output_language	value used to specify output of Promela for uses with SPIN (unsupported option)
e_PHP_output_language	value used to specify output of PHP
e_last_output_language	upper bound on the range of values supported for the outputLanguageOption_enum

Constructor & Destructor Documentation

SgFile::SgFile	(	int &	argc,
		char **&	argv,
		SgProject *	project = `NULL`
	)

The only useful constructor (the argc and argv are the user's command line inputs and the errorCode is the return value assembled from the multiple error codes associated with the different phases of the compilation.

The fileNameIndex is the index into the list of file names input on the user's command line. We need a way to process them individually!

SgFile::SgFile	(	std::vector< std::string > &	argv,
		SgProject *	project = `NULL`
	)

SgFile::SgFile ( const SgFile & X )

SgFile::SgFile ( const SgFileStorageClass & source )

SgFile::~SgFile ( ) [virtual]

This is the destructor.

There is nothing to delete in this object.

SgFile::SgFile ( )

This is the constructor.

This constructor builds the SgFile base class.

See also:: Example:create an SgFile object

Member Function Documentation

virtual SgNode* SgFile::copy ( SgCopyHelp & help ) const [virtual]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual void SgFile::doSetupForConstructor	(	const std::vector< std::string > &	argv,
		SgProject *	project
	)			`[virtual]`

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void SgFile::initialization ( )

Initialization support for constructors.

void SgFile::unparse	(	UnparseFormatHelp *	unparseHelp = `NULL`,
		UnparseDelegate *	unparseDelagate = `NULL`
	)

Generate the C++ file representing the AST.

int SgFile::compileOutput	(	int	fileNameIndex,
		const std::string &	compilerName
	)

Member function to compile the resulting output file from unparsing.

std::string SgFile::getFileName ( ) const

associated filename

virtual int SgFile::callFrontEnd ( ) [virtual]

Move this function from ROSE into the AST restructuring tool.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void SgFile::secondaryPassOverSourceFile ( )

Fixups to be run when the whole project has been created (this attaches preprocessing information).

virtual int SgFile::buildAST	(	std::vector< std::string >	argv,
		std::vector< std::string >	inputCommandLine
	)			`[virtual]`

Reimplemented in SgSourceFile, and SgBinaryComposite.

void SgFile::processRoseCommandLineOptions ( std::vector< std::string > & argv )

Move this function from ROSE into the AST restructuring tool.

void SgFile::processBackendSpecificCommandLineOptions ( const std::vector< std::string > & argv )

static void SgFile::stripRoseCommandLineOptions ( std::vector< std::string > & argv ) [static]

function that removes all rose related options from a command line

static void SgFile::stripEdgCommandLineOptions ( std::vector< std::string > & argv ) [static]

function that removes all EDG related options from a command line

void SgFile::build_EDG_CommandLine	(	std::vector< std::string > &	inputCommandLine,
		std::vector< std::string > &	argv,
		int	fileNameIndex
	)

static void SgFile::usage ( int status ) [static]

Move this function from ROSE into the AST restructuring tool.

std::string SgFile::getWorkingDirectory ( )

Move this function from ROSE into the AST restructuring tool.

std::string SgFile::getSourceDirectory ( )

std::string SgFile::generateOutputFileName ( ) const

Generate an output filename from the source file name (xxx.C -> rose_xxx.C -> xxx.o -> xxx).

std::string SgFile::generate_C_preprocessor_intermediate_filename ( std::string filename )

Support for C preprocessed files (Fortran only).

std::vector<std::string> SgFile::buildCompilerCommandLineOptions	(	std::vector< std::string > &	argv,
		int	fileNameIndex,
		const std::string &	compilerName
	)

int SgFile::compileOutput	(	std::vector< std::string > &	argv,
		int	fileNameIndex,
		const std::string &	compilerName
	)

void SgFile::display ( const std::string & label ) const

bool SgFile::isPrelinkPhase ( ) const

Test if project is compiled with -prelink as signal that we are prelinking and we have to process the generated code instead of the user's application (to see and instatiate all templates).

SgProject* SgFile::get_project ( )

Get the SgProject IR node if available (template instantiation information is stored there).

Sg_File_Info* SgFile::get_file_info ( ) const [virtual]

Access function calling get_startOfConstruct(), provided to support older interface.

Reimplemented from SgNode.

void SgFile::set_file_info ( Sg_File_Info * fileinfo )

Access function calling set_startOfConstruct(), provided to support older interface.

void SgFile::initializeSourcePosition ( const std::string & sourceFilename )

virtual void SgFile::addNewAttribute	(	std::string	s,
		AstAttribute *	a
	)			`[virtual]`

Add a new attribute represented by the named string.

Reimplemented from SgNode.

virtual AstAttribute* SgFile::getAttribute ( std::string s ) const [virtual]

Returns attribute of name 's'.

Reimplemented from SgNode.

virtual void SgFile::updateAttribute	(	std::string	s,
		AstAttribute *	a
	)			`[virtual]`

Replace existing attribute of name 's' with new AstAttribute.

Reimplemented from SgNode.

virtual void SgFile::setAttribute	(	std::string	s,
		AstAttribute *	a
	)			`[virtual]`

This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called.

Reimplemented from SgNode.

virtual void SgFile::removeAttribute ( std::string s ) [virtual]

Remove attribute of name 's' if present.

Reimplemented from SgNode.

virtual bool SgFile::attributeExists ( std::string s ) const [virtual]

Tests if attribute of name 's' is present.

Reimplemented from SgNode.

virtual int SgFile::numberOfAttributes ( ) const [virtual]

Returns the number of attributes on this IR node.

Reimplemented from SgNode.

virtual std::string SgFile::class_name ( ) const [virtual]

Copies AST (whole subtree, depending on the SgCopyHelp class returns a string representing the class name.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual VariantT SgFile::variantT ( ) const [virtual]

returns new style SageIII enum values

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void* SgFile::operator new ( size_t size )

returns pointer to newly allocated IR node

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void SgFile::operator delete	(	void *	pointer,
		size_t	size
	)

deallocated memory for IR node (returns memory to memory pool for reuse)

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void SgFile::operator delete ( void * pointer )

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

static int SgFile::numberOfNodes ( ) [static]

Returns the total number of IR nodes of this type.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

static int SgFile::memoryUsage ( ) [static]

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual std::vector<SgNode*> SgFile::get_traversalSuccessorContainer ( ) [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:: Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual std::vector<std::string> SgFile::get_traversalSuccessorNamesContainer ( ) [virtual]

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns:: Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual size_t SgFile::get_numberOfTraversalSuccessors ( ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual SgNode* SgFile::get_traversalSuccessorByIndex ( size_t idx ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual size_t SgFile::get_childIndex ( SgNode * child ) [virtual]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual RTIReturnType SgFile::roseRTI ( ) [virtual]

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

This function provides runtime type information for accessing the structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns:: Returns a RTIReturnType object (runtime type information).

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual const char* SgFile::sage_class_name ( ) const [virtual]

returns a C style string (char*) representing the class name

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void SgFile::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor )

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

static void SgFile::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

static void SgFile::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor ) [static]

FOR INTERNAL USE Support for visitor pattern.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

static void SgFile::visitRepresentativeNode ( ROSE_VisitTraversal & visit ) [static]

FOR INTERNAL USE Support for type-based traversal.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual bool SgFile::isInMemoryPool ( ) [virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual void SgFile::checkDataMemberPointersIfInMemoryPool ( ) [virtual]

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual std::vector<std::pair<SgNode*,std::string> > SgFile::returnDataMemberPointers ( ) const [virtual]

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Returns:: STL vector of pairs of SgNode* and strings

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual void SgFile::processDataMemberReferenceToPointers ( ReferenceToPointerHandler * ) [virtual]

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning:: This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

virtual long SgFile::getChildIndex ( SgNode * childNode ) const [virtual]

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning:: The mapping on children to integer values could change from release to release of ROSE.

Returns:: long

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

SgFile* SgFile::addRegExpAttribute	(	std::string	s,
		AstRegExAttribute *	a
	)

Support for AST matching using regular expression.

This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

Sg_File_Info* SgFile::get_startOfConstruct ( void ) const [virtual]

New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword).

Reimplemented from SgNode.

void SgFile::set_startOfConstruct ( Sg_File_Info * startOfConstruct )

list< string > SgFile::get_originalCommandLineArgumentList ( ) const

Returns a list of strings representing the original command-line.

void SgFile::set_originalCommandLineArgumentList ( SgStringList originalCommandLineArgumentList )

int SgFile::get_verbose ( ) const

void SgFile::set_verbose ( int verbose )

bool SgFile::get_output_warnings ( ) const

void SgFile::set_output_warnings ( bool output_warnings )

bool SgFile::get_C_only ( ) const

void SgFile::set_C_only ( bool C_only )

bool SgFile::get_UPC_only ( ) const

void SgFile::set_UPC_only ( bool UPC_only )

int SgFile::get_upc_threads ( ) const

void SgFile::set_upc_threads ( int upc_threads )

bool SgFile::get_C99_only ( ) const

void SgFile::set_C99_only ( bool C99_only )

bool SgFile::get_Cxx_only ( ) const

void SgFile::set_Cxx_only ( bool Cxx_only )

bool SgFile::get_Fortran_only ( ) const

void SgFile::set_Fortran_only ( bool Fortran_only )

bool SgFile::get_F77_only ( ) const

void SgFile::set_F77_only ( bool F77_only )

bool SgFile::get_F90_only ( ) const

void SgFile::set_F90_only ( bool F90_only )

bool SgFile::get_F95_only ( ) const

void SgFile::set_F95_only ( bool F95_only )

bool SgFile::get_F2003_only ( ) const

void SgFile::set_F2003_only ( bool F2003_only )

bool SgFile::get_CoArrayFortran_only ( ) const

void SgFile::set_CoArrayFortran_only ( bool CoArrayFortran_only )

bool SgFile::get_PHP_only ( ) const

void SgFile::set_PHP_only ( bool PHP_only )

bool SgFile::get_requires_C_preprocessor ( ) const

void SgFile::set_requires_C_preprocessor ( bool requires_C_preprocessor )

bool SgFile::get_binary_only ( ) const

void SgFile::set_binary_only ( bool binary_only )

SgFile::outputFormatOption_enum SgFile::get_inputFormat ( ) const

void SgFile::set_inputFormat ( SgFile::outputFormatOption_enum inputFormat )

SgFile::outputFormatOption_enum SgFile::get_outputFormat ( ) const

void SgFile::set_outputFormat ( SgFile::outputFormatOption_enum outputFormat )

SgFile::outputFormatOption_enum SgFile::get_backendCompileFormat ( ) const

void SgFile::set_backendCompileFormat ( SgFile::outputFormatOption_enum backendCompileFormat )

bool SgFile::get_fortran_implicit_none ( ) const

void SgFile::set_fortran_implicit_none ( bool fortran_implicit_none )

bool SgFile::get_openmp ( ) const

void SgFile::set_openmp ( bool openmp )

bool SgFile::get_openmp_parse_only ( ) const

void SgFile::set_openmp_parse_only ( bool openmp_parse_only )

bool SgFile::get_openmp_ast_only ( ) const

void SgFile::set_openmp_ast_only ( bool openmp_ast_only )

bool SgFile::get_openmp_lowering ( ) const

void SgFile::set_openmp_lowering ( bool openmp_lowering )

bool SgFile::get_cray_pointer_support ( ) const

void SgFile::set_cray_pointer_support ( bool cray_pointer_support )

bool SgFile::get_output_parser_actions ( ) const

void SgFile::set_output_parser_actions ( bool output_parser_actions )

bool SgFile::get_exit_after_parser ( ) const

void SgFile::set_exit_after_parser ( bool exit_after_parser )

bool SgFile::get_skip_syntax_check ( ) const

void SgFile::set_skip_syntax_check ( bool skip_syntax_check )

bool SgFile::get_skip_transformation ( ) const

void SgFile::set_skip_transformation ( bool skip_transformation )

bool SgFile::get_skip_unparse ( ) const

void SgFile::set_skip_unparse ( bool skip_unparse )

bool SgFile::get_skipfinalCompileStep ( ) const

void SgFile::set_skipfinalCompileStep ( bool skipfinalCompileStep )

bool SgFile::get_unparse_includes ( ) const

void SgFile::set_unparse_includes ( bool unparse_includes )

bool SgFile::get_unparse_line_directives ( ) const

void SgFile::set_unparse_line_directives ( bool unparse_line_directives )

bool SgFile::get_unparse_instruction_addresses ( ) const

void SgFile::set_unparse_instruction_addresses ( bool unparse_instruction_addresses )

bool SgFile::get_unparse_raw_memory_contents ( ) const

void SgFile::set_unparse_raw_memory_contents ( bool unparse_raw_memory_contents )

bool SgFile::get_unparse_binary_file_format ( ) const

void SgFile::set_unparse_binary_file_format ( bool unparse_binary_file_format )

SgFile::outputLanguageOption_enum SgFile::get_outputLanguage ( ) const

void SgFile::set_outputLanguage ( SgFile::outputLanguageOption_enum outputLanguage )

std::string SgFile::get_sourceFileNameWithPath ( ) const

void SgFile::set_sourceFileNameWithPath ( std::string sourceFileNameWithPath )

std::string SgFile::get_sourceFileNameWithoutPath ( ) const

void SgFile::set_sourceFileNameWithoutPath ( std::string sourceFileNameWithoutPath )

std::string SgFile::get_unparse_output_filename ( ) const

void SgFile::set_unparse_output_filename ( std::string unparse_output_filename )

bool SgFile::get_useBackendOnly ( ) const

void SgFile::set_useBackendOnly ( bool useBackendOnly )

bool SgFile::get_compileOnly ( ) const

void SgFile::set_compileOnly ( bool compileOnly )

std::string SgFile::get_savedEdgCommandLine ( ) const

void SgFile::set_savedEdgCommandLine ( std::string savedEdgCommandLine )

bool SgFile::get_no_implicit_templates ( ) const

void SgFile::set_no_implicit_templates ( bool no_implicit_templates )

bool SgFile::get_no_implicit_inline_templates ( ) const

void SgFile::set_no_implicit_inline_templates ( bool no_implicit_inline_templates )

bool SgFile::get_skip_commentsAndDirectives ( ) const

void SgFile::set_skip_commentsAndDirectives ( bool skip_commentsAndDirectives )

bool SgFile::get_collectAllCommentsAndDirectives ( ) const

void SgFile::set_collectAllCommentsAndDirectives ( bool collectAllCommentsAndDirectives )

ROSEAttributesListContainerPtr SgFile::get_preprocessorDirectivesAndCommentsList ( ) const

void SgFile::set_preprocessorDirectivesAndCommentsList ( ROSEAttributesListContainerPtr preprocessorDirectivesAndCommentsList )

AstAttributeMechanism * SgFile::get_attributeMechanism ( ) const [virtual]

FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error.

This is an access function used for getting the interally held pointer to a valid AstAttributeMechanism. It provides access to lower level functionality of the AstAttributeMechanism, put is mostly of use to internal tools.

Reimplemented from SgNode.

void SgFile::set_attributeMechanism ( AstAttributeMechanism * a ) [virtual]

FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism.

This is an access function used for setting the interally held pointer to a valid AstAttributeMechanism.

Reimplemented from SgNode.

bool SgFile::get_KCC_frontend ( ) const

void SgFile::set_KCC_frontend ( bool KCC_frontend )

bool SgFile::get_new_frontend ( ) const

void SgFile::set_new_frontend ( bool new_frontend )

bool SgFile::get_disable_edg_backend ( ) const

void SgFile::set_disable_edg_backend ( bool disable_edg_backend )

bool SgFile::get_disable_sage_backend ( ) const

void SgFile::set_disable_sage_backend ( bool disable_sage_backend )

int SgFile::get_testingLevel ( ) const

void SgFile::set_testingLevel ( int testingLevel )

bool SgFile::get_preinit_il ( ) const

void SgFile::set_preinit_il ( bool preinit_il )

bool SgFile::get_enable_cp_backend ( ) const

void SgFile::set_enable_cp_backend ( bool enable_cp_backend )

bool SgFile::get_markGeneratedFiles ( ) const

void SgFile::set_markGeneratedFiles ( bool markGeneratedFiles )

bool SgFile::get_negative_test ( ) const

void SgFile::set_negative_test ( bool negative_test )

bool SgFile::get_strict_language_handling ( ) const

void SgFile::set_strict_language_handling ( bool strict_language_handling )

bool SgFile::get_wave ( ) const

void SgFile::set_wave ( bool wave )

int SgFile::get_embedColorCodesInGeneratedCode ( ) const

void SgFile::set_embedColorCodesInGeneratedCode ( int embedColorCodesInGeneratedCode )

int SgFile::get_generateSourcePositionCodes ( ) const

void SgFile::set_generateSourcePositionCodes ( int generateSourcePositionCodes )

bool SgFile::get_sourceFileUsesCppFileExtension ( ) const

void SgFile::set_sourceFileUsesCppFileExtension ( bool sourceFileUsesCppFileExtension )

bool SgFile::get_sourceFileUsesFortranFileExtension ( ) const

void SgFile::set_sourceFileUsesFortranFileExtension ( bool sourceFileUsesFortranFileExtension )

bool SgFile::get_sourceFileUsesFortran77FileExtension ( ) const

void SgFile::set_sourceFileUsesFortran77FileExtension ( bool sourceFileUsesFortran77FileExtension )

bool SgFile::get_sourceFileUsesFortran90FileExtension ( ) const

void SgFile::set_sourceFileUsesFortran90FileExtension ( bool sourceFileUsesFortran90FileExtension )

bool SgFile::get_sourceFileUsesFortran95FileExtension ( ) const

void SgFile::set_sourceFileUsesFortran95FileExtension ( bool sourceFileUsesFortran95FileExtension )

bool SgFile::get_sourceFileUsesFortran2003FileExtension ( ) const

void SgFile::set_sourceFileUsesFortran2003FileExtension ( bool sourceFileUsesFortran2003FileExtension )

bool SgFile::get_sourceFileUsesCoArrayFortranFileExtension ( ) const

void SgFile::set_sourceFileUsesCoArrayFortranFileExtension ( bool sourceFileUsesCoArrayFortranFileExtension )

bool SgFile::get_sourceFileUsesPHPFileExtension ( ) const

void SgFile::set_sourceFileUsesPHPFileExtension ( bool sourceFileUsesPHPFileExtension )

bool SgFile::get_sourceFileUsesBinaryFileExtension ( ) const

void SgFile::set_sourceFileUsesBinaryFileExtension ( bool sourceFileUsesBinaryFileExtension )

bool SgFile::get_sourceFileTypeIsUnknown ( ) const

void SgFile::set_sourceFileTypeIsUnknown ( bool sourceFileTypeIsUnknown )

bool SgFile::get_read_executable_file_format_only ( ) const

void SgFile::set_read_executable_file_format_only ( bool read_executable_file_format_only )

bool SgFile::get_visualize_executable_file_format_skip_symbols ( ) const

void SgFile::set_visualize_executable_file_format_skip_symbols ( bool visualize_executable_file_format_skip_symbols )

bool SgFile::get_visualize_dwarf_only ( ) const

void SgFile::set_visualize_dwarf_only ( bool visualize_dwarf_only )

bool SgFile::get_read_instructions_only ( ) const

void SgFile::set_read_instructions_only ( bool read_instructions_only )

bool SgFile::get_skip_unparse_asm_commands ( ) const

void SgFile::set_skip_unparse_asm_commands ( bool skip_unparse_asm_commands )

const SgStringList& SgFile::get_libraryArchiveObjectFileNameList ( ) const

SgStringList& SgFile::get_libraryArchiveObjectFileNameList ( )

bool SgFile::get_isLibraryArchive ( ) const

void SgFile::set_isLibraryArchive ( bool isLibraryArchive )

bool SgFile::get_isObjectFile ( ) const

void SgFile::set_isObjectFile ( bool isObjectFile )

unsigned SgFile::get_disassemblerSearchHeuristics ( ) const

void SgFile::set_disassemblerSearchHeuristics ( unsigned disassemblerSearchHeuristics )

unsigned SgFile::get_partitionerSearchHeuristics ( ) const

void SgFile::set_partitionerSearchHeuristics ( unsigned partitionerSearchHeuristics )

Friends And Related Function Documentation

friend class AST_FILE_IO [friend]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

friend class SgFileStorageClass [friend]

friend class AstSpecificDataManagingClass [friend]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

friend class AstSpecificDataManagingClassStorageClass [friend]

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

void alternativeSageEdgInterfaceConstruction ( SgFile * file ) [friend]

Move this function from ROSE into the AST restructuring tool.

SgFile::isSgFile ( SgNode * s ) [friend]

Casts pointer from base class to derived class.

This functions returns a SgFile pointer for any input of a pointer to an object derived from a SgFile.

Returns:: Returns valid pointer to SgFile if input is derived from a SgLocatedNode.

SgFile::isSgFile ( const SgNode * s ) [friend]

Casts pointer from base class to derived class (for const pointers).

This functions returns a SgFile pointer for any input of a pointer to an object derived from a SgFile.

Returns:: Returns valid pointer to SgFile if input is derived from a SgLocatedNode.

SgFile* SgFile_getPointerFromGlobalIndex ( unsigned long globalIndex ) [friend]

Constructor for use by AST File I/O MechanismTypedef used for low level memory access. Typedef used to hold memory addresses as values. Methods to find the pointer to a global and local index.

unsigned long SgFile_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned long ) [friend]

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgFile_clearMemoryPool ( ) [friend]

void SgFile_extendMemoryPoolForFileIO ( unsigned long ) [friend]

void SgFile_getNextValidPointer ( std::pair< SgFile *, std::vector< unsigned char * >::const_iterator > & ) [friend]

void SgFile_resetValidFreepointers ( ) [friend]

Member Data Documentation

const VariantT SgFile::static_variant = V_SgFile [static]

static variant value

Reimplemented from SgSupport.

Reimplemented in SgSourceFile, SgBinaryComposite, and SgUnknownFile.

Sg_File_Info* SgFile::p_startOfConstruct [protected]

SgFile::p_originalCommandLineArgumentList [protected]

Copy of original argc and argv command line passed to ROSE translator (converted to STL list of strings).

For internal use only.

This is a deep copy.

int SgFile::p_verbose [protected]

bool SgFile::p_output_warnings [protected]

bool SgFile::p_C_only [protected]

bool SgFile::p_UPC_only [protected]

int SgFile::p_upc_threads [protected]

bool SgFile::p_C99_only [protected]

bool SgFile::p_Cxx_only [protected]

bool SgFile::p_Fortran_only [protected]

bool SgFile::p_F77_only [protected]

bool SgFile::p_F90_only [protected]

bool SgFile::p_F95_only [protected]

bool SgFile::p_F2003_only [protected]

bool SgFile::p_CoArrayFortran_only [protected]

bool SgFile::p_PHP_only [protected]

bool SgFile::p_requires_C_preprocessor [protected]

bool SgFile::p_binary_only [protected]

SgFile::outputFormatOption_enum SgFile::p_inputFormat [protected]

SgFile::outputFormatOption_enum SgFile::p_outputFormat [protected]

SgFile::outputFormatOption_enum SgFile::p_backendCompileFormat [protected]

bool SgFile::p_fortran_implicit_none [protected]

bool SgFile::p_openmp [protected]

bool SgFile::p_openmp_parse_only [protected]

bool SgFile::p_openmp_ast_only [protected]

bool SgFile::p_openmp_lowering [protected]

bool SgFile::p_cray_pointer_support [protected]

bool SgFile::p_output_parser_actions [protected]

bool SgFile::p_exit_after_parser [protected]

bool SgFile::p_skip_syntax_check [protected]

bool SgFile::p_skip_transformation [protected]

bool SgFile::p_skip_unparse [protected]

bool SgFile::p_skipfinalCompileStep [protected]

bool SgFile::p_unparse_includes [protected]

bool SgFile::p_unparse_line_directives [protected]

bool SgFile::p_unparse_instruction_addresses [protected]

bool SgFile::p_unparse_raw_memory_contents [protected]

bool SgFile::p_unparse_binary_file_format [protected]

SgFile::outputLanguageOption_enum SgFile::p_outputLanguage [protected]

std::string SgFile::p_sourceFileNameWithPath [protected]

std::string SgFile::p_sourceFileNameWithoutPath [protected]

std::string SgFile::p_unparse_output_filename [protected]

bool SgFile::p_useBackendOnly [protected]

bool SgFile::p_compileOnly [protected]

std::string SgFile::p_savedEdgCommandLine [protected]

SgFile::p_no_implicit_templates [protected]

This is a reference to the GNU g++ command line option (same name).

If the option "-no_implicit_templates" is seen on the command line then this is true. Else it may be manipulated directly within the ROSE command line processing.

This option controls if instantiated templates should be output where they are not specified explicitly via explicit template instatiation directives (see SgTemplateInstatiationDirectiveStatement, formally part of C++).

For internal use only.

We need to see this option since it effects how template instantiations are generated. Other backend compilers may force this to be recognized in other ways so that we map other vendor's equivalent compiler options to this one.

SgFile::p_no_implicit_inline_templates [protected]

This is a reference to the GNU g++ command line option (same name).

If the option "-no_implicit_inline_templates" is seen on the command line then this is true. Else it may be manipulated directly within the ROSE command line processing.

This option controls if instantiated templates for inline functions should be output where they are not specified explicitly via explicit template instatiation directives (see SgTemplateInstatiationDirectiveStatement, formally part of C++).

For internal use only.

bool SgFile::p_skip_commentsAndDirectives [protected]

bool SgFile::p_collectAllCommentsAndDirectives [protected]

ROSEAttributesListContainerPtr SgFile::p_preprocessorDirectivesAndCommentsList [protected]

This is the container of comments and preprocessor control statements that was extracted from the file and which has been woven back into the AST (using heuristics).

This information is extracted from the file using a lex based parser. Within AST post processing the comments and preprocessor control statements are woven back into the AST using simple heuristics. They are attached to the IR nodes as attributes (see AST attribute Mechanism). They are unparsed as part of the code generation phase.

AstAttributeMechanism* SgFile::p_attributeMechanism [protected]

bool SgFile::p_KCC_frontend [protected]

bool SgFile::p_new_frontend [protected]

bool SgFile::p_disable_edg_backend [protected]

bool SgFile::p_disable_sage_backend [protected]

int SgFile::p_testingLevel [protected]

bool SgFile::p_preinit_il [protected]

bool SgFile::p_enable_cp_backend [protected]

bool SgFile::p_markGeneratedFiles [protected]

bool SgFile::p_negative_test [protected]

bool SgFile::p_strict_language_handling [protected]

bool SgFile::p_wave [protected]