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

#include <Cxx_Grammar.h>

Inheritance diagram for SgFile:

Collaboration diagram for SgFile:

Public Types
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_Java_output_language, e_X10_output_language, e_Promela_output_language, e_PHP_output_language, e_Python_output_language, e_last_output_language }
	Enum type used to specify output language (option used for testing unparsers). More...

enum	{ static_variant = V_SgFile }
	static variant value More...

typedef SgSupport	base_node_type

Public Types inherited from SgSupport
enum	{ static_variant = V_SgSupport }
	static variant value More...

typedef SgNode	base_node_type

Public Types inherited from SgNode
enum	{ static_variant = V_SgNode }
	static variant value More...

Public Member Functions
virtual SgNode *	copy (SgCopyHelp &help) const
	This function clones the current IR node object recursively or not, depending on the argument. More...

	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. More...

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

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

void	initialization ()
	Default constructor (not meant to be used) More...

void	unparse (UnparseFormatHelp unparseHelp=NULL, UnparseDelegate unparseDelagate=NULL)
	Unparsing support for generating C++ code from the internal Abstract Syntax Tree (AST) More...

void	resetSourcePositionToGeneratedCode (UnparseFormatHelp *unparseFormatHelp=NULL)

int	compileOutput (int fileNameIndex)
	Member function to compile the resulting output file from unparsing. More...

std::string	getFileName () const
	associated filename More...

virtual int	callFrontEnd ()
	Move this function from ROSE into the AST restructuring tool. More...

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

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. More...

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

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

void	build_CLANG_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. More...

std::string	getSourceDirectory ()

std::string	generateOutputFileName () const
	Generate an output filename from the source file name (xxx.C -> rose_xxx.C -> xxx.o -> xxx) More...

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)

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). More...

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

	SgFile (const SgFile &X)

Sg_File_Info *	get_file_info () const
	Sets up the source file name (there should only be one source file in the commandline to a SgFile, there can be multiple ones to a SgProject). More...

void	set_file_info (Sg_File_Info *fileinfo)
	Access function calling set_startOfConstruct(), provided to support older interface. More...

void	initializeSourcePosition (const std::string &sourceFilename)

void	runFrontend (int &nextErrorCode)

virtual void	addNewAttribute (std::string s, AstAttribute *a)
	Add a new attribute represented by the named string. More...

virtual AstAttribute *	getAttribute (std::string s) const
	Returns attribute of name 's'. More...

virtual void	updateAttribute (std::string s, AstAttribute *a)
	Replace existing attribute of name 's' with new AstAttribute. More...

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. More...

virtual void	removeAttribute (std::string s)
	Remove attribute of name 's' if present. More...

virtual bool	attributeExists (std::string s) const
	Tests if attribute of name 's' is present. More...

virtual int	numberOfAttributes () const
	Returns the number of attributes on this IR node. More...

virtual std::string	class_name () const
	Copies AST (whole subtree, depending on the SgCopyHelp class. More...

virtual VariantT	variantT () const
	returns new style SageIII enum values More...

void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

virtual std::vector< SgNode * >	get_traversalSuccessorContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

virtual std::vector< std::string >	get_traversalSuccessorNamesContainer ()
	FOR INTERNAL USE within ROSE traverals mechanism only. More...

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. More...

virtual const char *	sage_class_name () const ROSE_DEPRECATED_FUNCTION

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

virtual void	accept (ROSE_VisitorPattern &visitor)
	DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...

virtual bool	isInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

virtual void	checkDataMemberPointersIfInMemoryPool ()
	FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...

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 More...

virtual void	processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
	FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...

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. More...

	SgFile (const SgFileStorageClass &source)

SgFile *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

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). More...

void	set_startOfConstruct (Sg_File_Info *startOfConstruct)

SgStringList	get_originalCommandLineArgumentList () const
	Returns a list of strings representing the original command-line. More...

void	set_originalCommandLineArgumentList (SgStringList originalCommandLineArgumentList)
	Sets the list of strings representing the original command-line. More...

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)

bool	get_UPCxx_only () const

void	set_UPCxx_only (bool UPCxx_only)

int	get_upc_threads () const

void	set_upc_threads (int upc_threads)

bool	get_C89_only () const

void	set_C89_only (bool C89_only)

bool	get_C89_gnu_only () const

void	set_C89_gnu_only (bool C89_gnu_only)

bool	get_C99_only () const

void	set_C99_only (bool C99_only)

bool	get_C99_gnu_only () const

void	set_C99_gnu_only (bool C99_gnu_only)

bool	get_Cxx_only () const

void	set_Cxx_only (bool Cxx_only)

bool	get_C11_only () const

void	set_C11_only (bool C11_only)

bool	get_Cxx0x_only () const

void	set_Cxx0x_only (bool Cxx0x_only)

bool	get_Cxx11_only () const

void	set_Cxx11_only (bool Cxx11_only)

bool	get_C14_only () const

void	set_C14_only (bool C14_only)

bool	get_Cxx14_only () const

void	set_Cxx14_only (bool Cxx14_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_Java_only () const

void	set_Java_only (bool Java_only)

bool	get_X10_only () const

void	set_X10_only (bool X10_only)

bool	get_PHP_only () const

void	set_PHP_only (bool PHP_only)

bool	get_Python_only () const

void	set_Python_only (bool Python_only)

bool	get_Cuda_only () const

void	set_Cuda_only (bool Cuda_only)

bool	get_OpenCL_only () const

void	set_OpenCL_only (bool OpenCL_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_failsafe () const

void	set_failsafe (bool failsafe)

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_relax_syntax_check () const

void	set_relax_syntax_check (bool relax_syntax_check)

bool	get_skip_translation_from_edg_ast_to_rose_ast () const

void	set_skip_translation_from_edg_ast_to_rose_ast (bool skip_translation_from_edg_ast_to_rose_ast)

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_function_calls_using_operator_syntax () const

void	set_unparse_function_calls_using_operator_syntax (bool unparse_function_calls_using_operator_syntax)

bool	get_unparse_function_calls_using_operator_names () const

void	set_unparse_function_calls_using_operator_names (bool unparse_function_calls_using_operator_names)

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_savedFrontendCommandLine () const

void	set_savedFrontendCommandLine (std::string savedFrontendCommandLine)

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)

bool	get_unparseHeaderFiles () const

void	set_unparseHeaderFiles (bool unparseHeaderFiles)

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. More...

void	set_attributeMechanism (AstAttributeMechanism *attributeMechanism)
	FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...

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_sourceFileUsesPythonFileExtension () const

void	set_sourceFileUsesPythonFileExtension (bool sourceFileUsesPythonFileExtension)

bool	get_sourceFileUsesJavaFileExtension () const

void	set_sourceFileUsesJavaFileExtension (bool sourceFileUsesJavaFileExtension)

bool	get_sourceFileUsesBinaryFileExtension () const

void	set_sourceFileUsesBinaryFileExtension (bool sourceFileUsesBinaryFileExtension)

bool	get_sourceFileTypeIsUnknown () const

void	set_sourceFileTypeIsUnknown (bool sourceFileTypeIsUnknown)

bool	get_sourceFileUsesX10FileExtension () const

void	set_sourceFileUsesX10FileExtension (bool sourceFileUsesX10FileExtension)

int	get_detect_dangling_pointers () const

void	set_detect_dangling_pointers (int detect_dangling_pointers)

bool	get_experimental_fortran_frontend () const

void	set_experimental_fortran_frontend (bool experimental_fortran_frontend)

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)

std::string	get_partitionerConfigurationFileName () const

void	set_partitionerConfigurationFileName (std::string partitionerConfigurationFileName)

bool	get_unparse_tokens () const

void	set_unparse_tokens (bool unparse_tokens)

int	get_unparse_tokens_testing () const

void	set_unparse_tokens_testing (int unparse_tokens_testing)

bool	get_skipAstConsistancyTests () const

void	set_skipAstConsistancyTests (bool skipAstConsistancyTests)

int	get_frontendErrorCode () const

void	set_frontendErrorCode (int frontendErrorCode)

int	get_javacErrorCode () const

void	set_javacErrorCode (int javacErrorCode)

int	get_ecjErrorCode () const

void	set_ecjErrorCode (int ecjErrorCode)

int	get_unparserErrorCode () const

void	set_unparserErrorCode (int unparserErrorCode)

int	get_backendCompilerErrorCode () const

void	set_backendCompilerErrorCode (int backendCompilerErrorCode)

bool	get_unparsedFileFailedCompilation () const

void	set_unparsedFileFailedCompilation (bool unparsedFileFailedCompilation)

virtual	~SgFile ()
	This is the destructor. More...

	SgFile ()
	This is the constructor. More...

Public Member Functions inherited from SgSupport
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

	SgSupport (const SgSupportStorageClass &source)

SgSupport *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

virtual	~SgSupport ()
	This is the destructor. More...

	SgSupport ()
	This is the constructor. More...

Public Member Functions inherited from SgNode
void *	operator new (size_t size)
	returns pointer to newly allocated IR node More...

void	operator delete (void *pointer, size_t size)
	deallocated memory for IR node (returns memory to memory pool for reuse) More...

void	operator delete (void *pointer)

void	executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

	SgNode (const SgNodeStorageClass &source)

SgNode *	addRegExpAttribute (std::string s, AstRegExAttribute *a)
	Support for AST matching using regular expression. More...

void	set_isModified (bool isModified)
	All nodes in the AST contain a isModified flag used to track changes to the AST. More...

bool	get_isModified () const
	Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...

void	set_parent (SgNode *parent)
	All nodes in the AST contain a reference to a parent node. More...

SgNode *	get_parent () const
	Access function for parent node. More...

bool	isChild (SgNode *node) const
	Query function for if the input IR nodes is a child of the current IR node. More...

virtual std::string	unparseToString (SgUnparse_Info *info) const
	This function unparses the AST node (excluding comments and unnecessary white space) More...

std::string	unparseToString () const

std::string	unparseToCompleteString ()
	This function unparses the AST node (including comments and white space) More...

int	variant () const ROSE_DEPRECATED_FUNCTION
	Older version function returns enum value "NODE". More...

virtual void	fixupCopy (SgNode *copy, SgCopyHelp &help) const

virtual Sg_File_Info *	get_endOfConstruct (void) const
	New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...

VirtualCFG::CFGNode	cfgForBeginning ()
	Returns the CFG node for just before this AST node. More...

VirtualCFG::CFGNode	cfgForEnd ()
	Returns the CFG node for just after this AST node. More...

virtual unsigned int	cfgIndexForEnd () const
	Determine the CFG index for the end of this construct. More...

virtual bool	cfgIsIndexInteresting (unsigned int index) const
	Determine whether a particular CFG node index is "interesting" for this kind of node. More...

virtual unsigned int	cfgFindChildIndex (SgNode *n)
	Find the index of n in this node's CFG children. More...

virtual unsigned int	cfgFindNextChildIndex (SgNode *n)
	Find the index just after n in this node's CFG children. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgOutEdges (unsigned int index=false)
	Find the out edges of a CFG node – internal version. More...

virtual std::vector < VirtualCFG::CFGEdge >	cfgInEdges (unsigned int index=false)
	Find the in edges of a CFG node – internal version. More...

int	numberOfNodesInSubtree ()
	Computes the number of nodes in the defined subtree of the AST. More...

int	depthOfSubtree ()
	Computes the depth of the current defined subtree of the AST. More...

SgNode *	get_freepointer () const

void	set_freepointer (SgNode *freepointer)

virtual	~SgNode ()
	This is the destructor. More...

	SgNode ()
	This is the constructor. More...

bool	get_isVisited () const ROSE_DEPRECATED_FUNCTION
	DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...

void	set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
	Access function for p_isVisited flag used previously by the AST traversals. More...

Static Public Member Functions
static void	stripRoseCommandLineOptions (std::vector< std::string > &argv)
	function that removes all rose related options from a command line More...

static void	stripEdgCommandLineOptions (std::vector< std::string > &argv)
	function that removes all EDG related options from a command line More...

static void	stripFortranCommandLineOptions (std::vector< std::string > &argv)
	function that removes all OFP related options from a command line More...

static void	usage (int status)
	Move this function from ROSE into the AST restructuring tool. More...

static std::string	generate_C_preprocessor_intermediate_filename (std::string filename)
	Support for C preprocessed files (Fortran only). More...

static std::string	get_outputLanguageOptionName (outputLanguageOption_enum lang)

static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgSupport
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

Static Public Member Functions inherited from SgNode
static size_t	numberOfNodes ()
	Returns the total number of IR nodes of this type. More...

static size_t	memoryUsage ()
	Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...

static void	traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
	FOR INTERNAL USE Support for visitor pattern. More...

static void	visitRepresentativeNode (ROSE_VisitTraversal &visit)
	FOR INTERNAL USE Support for type-based traversal. More...

static std::vector< std::string >	buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
	Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...

static std::vector< VariantT >	getClassHierarchySubTreeFunction (VariantT v)

static void	getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)

static std::map< SgNode *, std::string > &	get_globalMangledNameMap ()
	Access function for performance optimizing global mangled name map. More...

static void	clearGlobalMangledNameMap ()
	Support to clear the performance optimizing global mangled name map. More...

static std::map< std::string, int > &	get_shortMangledNameCache ()
	Access function for lower level optimizing of global mangled name map. More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForNames ()
	Access function for name qualification support (for names). More...

static void	set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names). More...

static std::map< SgNode *, std::string > &	get_globalQualifiedNameMapForTypes ()
	Access function for name qualification support (for type). More...

static void	set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for type). More...

static std::map< SgNode *, std::string > &	get_globalTypeNameMap ()
	Access function for name qualification support (for names of types). More...

static void	set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
	Access function for name qualification support (for names of types). More...

static SgFunctionTypeTable *	get_globalFunctionTypeTable ()
	Access function for symbol table specific to function types. More...

static void	set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
	Access function for symbol table specific to function types. More...

static SgTypeTable *	get_globalTypeTable ()
	Access function for symbol table specific to non-function types. More...

static void	set_globalTypeTable (SgTypeTable *globalTypeTable)
	Access function for symbol table specific to non-function types. More...

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). More...

int	p_verbose

bool	p_output_warnings

bool	p_C_only

bool	p_UPC_only

bool	p_UPCxx_only

int	p_upc_threads

bool	p_C89_only

bool	p_C89_gnu_only

bool	p_C99_only

bool	p_C99_gnu_only

bool	p_Cxx_only

bool	p_C11_only

bool	p_Cxx0x_only

bool	p_Cxx11_only

bool	p_C14_only

bool	p_Cxx14_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_Java_only

bool	p_X10_only

bool	p_PHP_only

bool	p_Python_only

bool	p_Cuda_only

bool	p_OpenCL_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_failsafe

bool	p_output_parser_actions

bool	p_exit_after_parser

bool	p_skip_syntax_check

bool	p_relax_syntax_check

bool	p_skip_translation_from_edg_ast_to_rose_ast

bool	p_skip_transformation

bool	p_skip_unparse

bool	p_skipfinalCompileStep

bool	p_unparse_includes

bool	p_unparse_line_directives

bool	p_unparse_function_calls_using_operator_syntax

bool	p_unparse_function_calls_using_operator_names

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_savedFrontendCommandLine

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

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

bool	p_skip_commentsAndDirectives

bool	p_collectAllCommentsAndDirectives

bool	p_unparseHeaderFiles

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). More...

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_sourceFileUsesPythonFileExtension

bool	p_sourceFileUsesJavaFileExtension

bool	p_sourceFileUsesBinaryFileExtension

bool	p_sourceFileTypeIsUnknown

bool	p_sourceFileUsesX10FileExtension

int	p_detect_dangling_pointers

bool	p_experimental_fortran_frontend

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

std::string	p_partitionerConfigurationFileName

bool	p_unparse_tokens

int	p_unparse_tokens_testing

bool	p_skipAstConsistancyTests

int	p_frontendErrorCode

int	p_javacErrorCode

int	p_ecjErrorCode

int	p_unparserErrorCode

int	p_backendCompilerErrorCode

bool	p_unparsedFileFailedCompilation

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. More...

ROSE_DLL_API friend SgFile *	isSgFile (SgNode *s)
	Casts pointer from base class to derived class. More...

ROSE_DLL_API friend const SgFile *	isSgFile (const SgNode *s)
	Casts pointer from base class to derived class (for const pointers) More...

SgFile *	SgFile_getPointerFromGlobalIndex (unsigned long globalIndex)
	Constructor for use by AST File I/O Mechanism. More...

unsigned long	SgFile_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
	Get the size of the memory pool. More...

void	SgFile_clearMemoryPool ()

void	SgFile_extendMemoryPoolForFileIO (unsigned long)

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

void	SgFile_resetValidFreepointers ()

Additional Inherited Members
Protected Member Functions inherited from SgNode
virtual void	post_construction_initialization ()
	Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. More...

Static Protected Attributes inherited from SgNode
static SgFunctionTypeTable *	p_globalFunctionTypeTable
	Pointer to symbol table specific to function types. More...

static SgTypeTable *	p_globalTypeTable

static std::map< SgNode *, std::string >	p_globalMangledNameMap
	Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...

static std::map< std::string, int >	p_shortMangledNameCache
	STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForNames

static std::map< SgNode *, std::string >	p_globalQualifiedNameMapForTypes

static std::map< SgNode *, std::string >	p_globalTypeNameMap

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).

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

Definition at line 20812 of file Cxx_Grammar.h.

Member Typedef Documentation

typedef SgSupport SgFile::base_node_type

Definition at line 21451 of file Cxx_Grammar.h.

Member Enumeration Documentation

enum SgFile::outputFormatOption_enum

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

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

Definition at line 20828 of file Cxx_Grammar.h.

enum SgFile::outputLanguageOption_enum

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

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_Java_output_language	value used to specify output of Java (for testing Java unparser)
e_X10_output_language	value used to specify output of X10 (for testing X10 unparser)
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_Python_output_language	value used to specify output of Python
e_last_output_language	upper bound on the range of values supported for the outputLanguageOption_enum

Definition at line 20842 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant

Definition at line 21139 of file Cxx_Grammar.h.

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

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters

help	- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.

Returns: a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions

none	No exceptions are thrown by this function.

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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

virtual

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

void SgFile::initialization ( )

Default constructor (not meant to be used)

Destructor Initialization support for constructors

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

Unparsing support for generating C++ code from the internal Abstract Syntax Tree (AST)

Unparsing support for generating C++ code from the internal Abstract Syntax Tree (AST) Root of the Abstract Syntax Tree (AST) representing this file Generate the C++ file representing the AST

void SgFile::resetSourcePositionToGeneratedCode ( UnparseFormatHelp * unparseFormatHelp = NULL)

int SgFile::compileOutput ( int fileNameIndex)

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgBinaryComposite, and SgSourceFile.

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

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

static

function that removes all OFP related options from a command line

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

void SgFile::build_CLANG_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)

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

static

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
	)

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

Sets up the source file name (there should only be one source file in the commandline to a SgFile, there can be multiple ones to a SgProject).

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)

void SgFile::runFrontend ( int & nextErrorCode)

static std::string SgFile::get_outputLanguageOptionName ( outputLanguageOption_enum lang)

static

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

virtual VariantT SgFile::variantT ( ) const

virtual

returns new style SageIII enum values

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

void* SgFile::operator new ( size_t size)

returns pointer to newly allocated IR node

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

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

void SgFile::operator delete ( void * pointer)

static size_t SgFile::numberOfNodes ( )

static

Returns the total number of IR nodes of this type.

static size_t SgFile::memoryUsage ( )

static

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

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

virtual size_t SgFile::get_numberOfTraversalSuccessors ( )

virtual

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

virtual SgNode* SgFile::get_traversalSuccessorByIndex ( size_t idx)

virtual

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

virtual size_t SgFile::get_childIndex ( SgNode * child)

virtual

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

virtual const char* SgFile::sage_class_name ( ) const

virtual

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

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

void SgFile::executeVisitorMemberFunction ( ROSE_VisitorPattern & visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgFile::accept ( ROSE_VisitorPattern & visitor)

virtual

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgSupport.

Reimplemented in SgUnknownFile, SgBinaryComposite, and SgSourceFile.

static void SgFile::traverseMemoryPoolNodes ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgFile::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern & visitor)

static

FOR INTERNAL USE Support for visitor pattern.

static void SgFile::visitRepresentativeNode ( ROSE_VisitTraversal & visit)

static

FOR INTERNAL USE Support for type-based traversal.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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 SgUnknownFile, SgBinaryComposite, and SgSourceFile.

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.

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.

SgFile::set_originalCommandLineArgumentList ( SgStringList originalCommandLineArgumentList)

Sets the list of strings representing the original command-line.

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)

bool SgFile::get_UPCxx_only ( ) const

void SgFile::set_UPCxx_only ( bool UPCxx_only)

int SgFile::get_upc_threads ( ) const

void SgFile::set_upc_threads ( int upc_threads)

bool SgFile::get_C89_only ( ) const

void SgFile::set_C89_only ( bool C89_only)

bool SgFile::get_C89_gnu_only ( ) const

void SgFile::set_C89_gnu_only ( bool C89_gnu_only)

bool SgFile::get_C99_only ( ) const

void SgFile::set_C99_only ( bool C99_only)

bool SgFile::get_C99_gnu_only ( ) const

void SgFile::set_C99_gnu_only ( bool C99_gnu_only)

bool SgFile::get_Cxx_only ( ) const

void SgFile::set_Cxx_only ( bool Cxx_only)

bool SgFile::get_C11_only ( ) const

void SgFile::set_C11_only ( bool C11_only)

bool SgFile::get_Cxx0x_only ( ) const

void SgFile::set_Cxx0x_only ( bool Cxx0x_only)

bool SgFile::get_Cxx11_only ( ) const

void SgFile::set_Cxx11_only ( bool Cxx11_only)

bool SgFile::get_C14_only ( ) const

void SgFile::set_C14_only ( bool C14_only)

bool SgFile::get_Cxx14_only ( ) const

void SgFile::set_Cxx14_only ( bool Cxx14_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_Java_only ( ) const

void SgFile::set_Java_only ( bool Java_only)

bool SgFile::get_X10_only ( ) const

void SgFile::set_X10_only ( bool X10_only)

bool SgFile::get_PHP_only ( ) const

void SgFile::set_PHP_only ( bool PHP_only)

bool SgFile::get_Python_only ( ) const

void SgFile::set_Python_only ( bool Python_only)

bool SgFile::get_Cuda_only ( ) const

void SgFile::set_Cuda_only ( bool Cuda_only)

bool SgFile::get_OpenCL_only ( ) const

void SgFile::set_OpenCL_only ( bool OpenCL_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_failsafe ( ) const

void SgFile::set_failsafe ( bool failsafe)

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_relax_syntax_check ( ) const

void SgFile::set_relax_syntax_check ( bool relax_syntax_check)

bool SgFile::get_skip_translation_from_edg_ast_to_rose_ast ( ) const

void SgFile::set_skip_translation_from_edg_ast_to_rose_ast ( bool skip_translation_from_edg_ast_to_rose_ast)

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_function_calls_using_operator_syntax ( ) const

void SgFile::set_unparse_function_calls_using_operator_syntax ( bool unparse_function_calls_using_operator_syntax)

bool SgFile::get_unparse_function_calls_using_operator_names ( ) const

void SgFile::set_unparse_function_calls_using_operator_names ( bool unparse_function_calls_using_operator_names)

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_savedFrontendCommandLine ( ) const

void SgFile::set_savedFrontendCommandLine ( std::string savedFrontendCommandLine)

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)

bool SgFile::get_unparseHeaderFiles ( ) const

void SgFile::set_unparseHeaderFiles ( bool unparseHeaderFiles)

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_sourceFileUsesPythonFileExtension ( ) const

void SgFile::set_sourceFileUsesPythonFileExtension ( bool sourceFileUsesPythonFileExtension)

bool SgFile::get_sourceFileUsesJavaFileExtension ( ) const

void SgFile::set_sourceFileUsesJavaFileExtension ( bool sourceFileUsesJavaFileExtension)

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_sourceFileUsesX10FileExtension ( ) const

void SgFile::set_sourceFileUsesX10FileExtension ( bool sourceFileUsesX10FileExtension)

int SgFile::get_detect_dangling_pointers ( ) const

void SgFile::set_detect_dangling_pointers ( int detect_dangling_pointers)

bool SgFile::get_experimental_fortran_frontend ( ) const

void SgFile::set_experimental_fortran_frontend ( bool experimental_fortran_frontend)

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

Referenced by Partitioner::disassembleInterpretation().

void SgFile::set_disassemblerSearchHeuristics ( unsigned disassemblerSearchHeuristics)

unsigned SgFile::get_partitionerSearchHeuristics ( ) const

Referenced by Partitioner::disassembleInterpretation().

void SgFile::set_partitionerSearchHeuristics ( unsigned partitionerSearchHeuristics)

std::string SgFile::get_partitionerConfigurationFileName ( ) const

Referenced by Partitioner::disassembleInterpretation().

void SgFile::set_partitionerConfigurationFileName ( std::string partitionerConfigurationFileName)

bool SgFile::get_unparse_tokens ( ) const

void SgFile::set_unparse_tokens ( bool unparse_tokens)

int SgFile::get_unparse_tokens_testing ( ) const

void SgFile::set_unparse_tokens_testing ( int unparse_tokens_testing)

bool SgFile::get_skipAstConsistancyTests ( ) const

void SgFile::set_skipAstConsistancyTests ( bool skipAstConsistancyTests)

int SgFile::get_frontendErrorCode ( ) const

void SgFile::set_frontendErrorCode ( int frontendErrorCode)

int SgFile::get_javacErrorCode ( ) const

void SgFile::set_javacErrorCode ( int javacErrorCode)

int SgFile::get_ecjErrorCode ( ) const

void SgFile::set_ecjErrorCode ( int ecjErrorCode)

int SgFile::get_unparserErrorCode ( ) const

void SgFile::set_unparserErrorCode ( int unparserErrorCode)

int SgFile::get_backendCompilerErrorCode ( ) const

void SgFile::set_backendCompilerErrorCode ( int backendCompilerErrorCode)

bool SgFile::get_unparsedFileFailedCompilation ( ) const

void SgFile::set_unparsedFileFailedCompilation ( bool unparsedFileFailedCompilation)

Friends And Related Function Documentation

friend class AST_FILE_IO

friend

Definition at line 21410 of file Cxx_Grammar.h.

friend class SgFileStorageClass

friend

Definition at line 21411 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass

friend

Definition at line 21412 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass

friend

Definition at line 21413 of file Cxx_Grammar.h.

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.

Cast function (from derived class to SgFile pointer).

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)

Cast function (from derived class to SgFile pointer).

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 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.

Typedef 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

Sg_File_Info* SgFile::p_startOfConstruct

protected

Definition at line 21942 of file Cxx_Grammar.h.

SgFile::p_originalCommandLineArgumentList

protected

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

This is a deep copy.

Definition at line 21946 of file Cxx_Grammar.h.

int SgFile::p_verbose

protected

Definition at line 21950 of file Cxx_Grammar.h.

bool SgFile::p_output_warnings

protected

Definition at line 21954 of file Cxx_Grammar.h.

bool SgFile::p_C_only

protected

Definition at line 21958 of file Cxx_Grammar.h.

bool SgFile::p_UPC_only

protected

Definition at line 21962 of file Cxx_Grammar.h.

bool SgFile::p_UPCxx_only

protected

Definition at line 21966 of file Cxx_Grammar.h.

int SgFile::p_upc_threads

protected

Definition at line 21970 of file Cxx_Grammar.h.

bool SgFile::p_C89_only

protected

Definition at line 21974 of file Cxx_Grammar.h.

bool SgFile::p_C89_gnu_only

protected

Definition at line 21978 of file Cxx_Grammar.h.

bool SgFile::p_C99_only

protected

Definition at line 21982 of file Cxx_Grammar.h.

bool SgFile::p_C99_gnu_only

protected

Definition at line 21986 of file Cxx_Grammar.h.

bool SgFile::p_Cxx_only

protected

Definition at line 21990 of file Cxx_Grammar.h.

bool SgFile::p_C11_only

protected

Definition at line 21994 of file Cxx_Grammar.h.

bool SgFile::p_Cxx0x_only

protected

Definition at line 21998 of file Cxx_Grammar.h.

bool SgFile::p_Cxx11_only

protected

Definition at line 22002 of file Cxx_Grammar.h.

bool SgFile::p_C14_only

protected

Definition at line 22006 of file Cxx_Grammar.h.

bool SgFile::p_Cxx14_only

protected

Definition at line 22010 of file Cxx_Grammar.h.

bool SgFile::p_Fortran_only

protected

Definition at line 22014 of file Cxx_Grammar.h.

bool SgFile::p_F77_only

protected

Definition at line 22018 of file Cxx_Grammar.h.

bool SgFile::p_F90_only

protected

Definition at line 22022 of file Cxx_Grammar.h.

bool SgFile::p_F95_only

protected

Definition at line 22026 of file Cxx_Grammar.h.

bool SgFile::p_F2003_only

protected

Definition at line 22030 of file Cxx_Grammar.h.

bool SgFile::p_CoArrayFortran_only

protected

Definition at line 22034 of file Cxx_Grammar.h.

bool SgFile::p_Java_only

protected

Definition at line 22038 of file Cxx_Grammar.h.

bool SgFile::p_X10_only

protected

Definition at line 22042 of file Cxx_Grammar.h.

bool SgFile::p_PHP_only

protected

Definition at line 22046 of file Cxx_Grammar.h.

bool SgFile::p_Python_only

protected

Definition at line 22050 of file Cxx_Grammar.h.

bool SgFile::p_Cuda_only

protected

Definition at line 22054 of file Cxx_Grammar.h.

bool SgFile::p_OpenCL_only

protected

Definition at line 22058 of file Cxx_Grammar.h.

bool SgFile::p_requires_C_preprocessor

protected

Definition at line 22062 of file Cxx_Grammar.h.

bool SgFile::p_binary_only

protected

Definition at line 22066 of file Cxx_Grammar.h.

SgFile::outputFormatOption_enum SgFile::p_inputFormat

protected

Definition at line 22070 of file Cxx_Grammar.h.

SgFile::outputFormatOption_enum SgFile::p_outputFormat

protected

Definition at line 22074 of file Cxx_Grammar.h.

SgFile::outputFormatOption_enum SgFile::p_backendCompileFormat

protected

Definition at line 22078 of file Cxx_Grammar.h.

bool SgFile::p_fortran_implicit_none

protected

Definition at line 22082 of file Cxx_Grammar.h.

bool SgFile::p_openmp

protected

Definition at line 22086 of file Cxx_Grammar.h.

bool SgFile::p_openmp_parse_only

protected

Definition at line 22090 of file Cxx_Grammar.h.

bool SgFile::p_openmp_ast_only

protected

Definition at line 22094 of file Cxx_Grammar.h.

bool SgFile::p_openmp_lowering

protected

Definition at line 22098 of file Cxx_Grammar.h.

bool SgFile::p_cray_pointer_support

protected

Definition at line 22102 of file Cxx_Grammar.h.

bool SgFile::p_failsafe

protected

Definition at line 22106 of file Cxx_Grammar.h.

bool SgFile::p_output_parser_actions

protected

Definition at line 22110 of file Cxx_Grammar.h.

bool SgFile::p_exit_after_parser

protected

Definition at line 22114 of file Cxx_Grammar.h.

bool SgFile::p_skip_syntax_check

protected

Definition at line 22118 of file Cxx_Grammar.h.

bool SgFile::p_relax_syntax_check

protected

Definition at line 22122 of file Cxx_Grammar.h.

bool SgFile::p_skip_translation_from_edg_ast_to_rose_ast

protected

Definition at line 22126 of file Cxx_Grammar.h.

bool SgFile::p_skip_transformation

protected

Definition at line 22130 of file Cxx_Grammar.h.

bool SgFile::p_skip_unparse

protected

Definition at line 22134 of file Cxx_Grammar.h.

bool SgFile::p_skipfinalCompileStep

protected

Definition at line 22138 of file Cxx_Grammar.h.

bool SgFile::p_unparse_includes

protected

Definition at line 22142 of file Cxx_Grammar.h.

bool SgFile::p_unparse_line_directives

protected

Definition at line 22146 of file Cxx_Grammar.h.

bool SgFile::p_unparse_function_calls_using_operator_syntax

protected

Definition at line 22150 of file Cxx_Grammar.h.

bool SgFile::p_unparse_function_calls_using_operator_names

protected

Definition at line 22154 of file Cxx_Grammar.h.

bool SgFile::p_unparse_instruction_addresses

protected

Definition at line 22158 of file Cxx_Grammar.h.

bool SgFile::p_unparse_raw_memory_contents

protected

Definition at line 22162 of file Cxx_Grammar.h.

bool SgFile::p_unparse_binary_file_format

protected

Definition at line 22166 of file Cxx_Grammar.h.

SgFile::outputLanguageOption_enum SgFile::p_outputLanguage

protected

Definition at line 22170 of file Cxx_Grammar.h.

std::string SgFile::p_sourceFileNameWithPath

protected

Definition at line 22174 of file Cxx_Grammar.h.

std::string SgFile::p_sourceFileNameWithoutPath

protected

Definition at line 22178 of file Cxx_Grammar.h.

std::string SgFile::p_unparse_output_filename

protected

Definition at line 22182 of file Cxx_Grammar.h.

bool SgFile::p_useBackendOnly

protected

Definition at line 22186 of file Cxx_Grammar.h.

bool SgFile::p_compileOnly

protected

Definition at line 22190 of file Cxx_Grammar.h.

std::string SgFile::p_savedFrontendCommandLine

protected

Definition at line 22194 of file Cxx_Grammar.h.

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++).

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.

Definition at line 22198 of file Cxx_Grammar.h.

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++).

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.

Definition at line 22202 of file Cxx_Grammar.h.

bool SgFile::p_skip_commentsAndDirectives

protected

Definition at line 22206 of file Cxx_Grammar.h.

bool SgFile::p_collectAllCommentsAndDirectives

protected

Definition at line 22210 of file Cxx_Grammar.h.

bool SgFile::p_unparseHeaderFiles

protected

Definition at line 22214 of file Cxx_Grammar.h.

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.

Definition at line 22218 of file Cxx_Grammar.h.

AstAttributeMechanism* SgFile::p_attributeMechanism

protected

Definition at line 22222 of file Cxx_Grammar.h.

bool SgFile::p_KCC_frontend

protected

Definition at line 22226 of file Cxx_Grammar.h.

bool SgFile::p_new_frontend

protected

Definition at line 22230 of file Cxx_Grammar.h.

bool SgFile::p_disable_edg_backend

protected

Definition at line 22234 of file Cxx_Grammar.h.

bool SgFile::p_disable_sage_backend

protected

Definition at line 22238 of file Cxx_Grammar.h.

int SgFile::p_testingLevel

protected

Definition at line 22242 of file Cxx_Grammar.h.

bool SgFile::p_preinit_il

protected

Definition at line 22246 of file Cxx_Grammar.h.

bool SgFile::p_enable_cp_backend

protected

Definition at line 22250 of file Cxx_Grammar.h.

bool SgFile::p_markGeneratedFiles

protected

Definition at line 22254 of file Cxx_Grammar.h.

bool SgFile::p_negative_test

protected

Definition at line 22258 of file Cxx_Grammar.h.

bool SgFile::p_strict_language_handling

protected

Definition at line 22262 of file Cxx_Grammar.h.

bool SgFile::p_wave

protected

Definition at line 22266 of file Cxx_Grammar.h.

int SgFile::p_embedColorCodesInGeneratedCode

protected

Definition at line 22270 of file Cxx_Grammar.h.

int SgFile::p_generateSourcePositionCodes

protected

Definition at line 22274 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesCppFileExtension

protected

Definition at line 22278 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesFortranFileExtension

protected

Definition at line 22282 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesFortran77FileExtension

protected

Definition at line 22286 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesFortran90FileExtension

protected

Definition at line 22290 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesFortran95FileExtension

protected

Definition at line 22294 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesFortran2003FileExtension

protected

Definition at line 22298 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesCoArrayFortranFileExtension

protected

Definition at line 22302 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesPHPFileExtension

protected

Definition at line 22306 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesPythonFileExtension

protected

Definition at line 22310 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesJavaFileExtension

protected

Definition at line 22314 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesBinaryFileExtension

protected

Definition at line 22318 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileTypeIsUnknown

protected

Definition at line 22322 of file Cxx_Grammar.h.

bool SgFile::p_sourceFileUsesX10FileExtension

protected

Definition at line 22326 of file Cxx_Grammar.h.

int SgFile::p_detect_dangling_pointers

protected

Definition at line 22330 of file Cxx_Grammar.h.

bool SgFile::p_experimental_fortran_frontend

protected

Definition at line 22334 of file Cxx_Grammar.h.

bool SgFile::p_read_executable_file_format_only

protected

Definition at line 22338 of file Cxx_Grammar.h.

bool SgFile::p_visualize_executable_file_format_skip_symbols

protected

Definition at line 22342 of file Cxx_Grammar.h.

bool SgFile::p_visualize_dwarf_only

protected

Definition at line 22346 of file Cxx_Grammar.h.

bool SgFile::p_read_instructions_only

protected

Definition at line 22350 of file Cxx_Grammar.h.

bool SgFile::p_skip_unparse_asm_commands

protected

Definition at line 22354 of file Cxx_Grammar.h.

SgStringList SgFile::p_libraryArchiveObjectFileNameList

protected

Definition at line 22358 of file Cxx_Grammar.h.

bool SgFile::p_isLibraryArchive

protected

Definition at line 22362 of file Cxx_Grammar.h.

bool SgFile::p_isObjectFile

protected

Definition at line 22366 of file Cxx_Grammar.h.

unsigned SgFile::p_disassemblerSearchHeuristics

protected

Definition at line 22370 of file Cxx_Grammar.h.

unsigned SgFile::p_partitionerSearchHeuristics

protected

Definition at line 22374 of file Cxx_Grammar.h.

std::string SgFile::p_partitionerConfigurationFileName

protected

Definition at line 22378 of file Cxx_Grammar.h.

bool SgFile::p_unparse_tokens

protected

Definition at line 22382 of file Cxx_Grammar.h.

int SgFile::p_unparse_tokens_testing

protected

Definition at line 22386 of file Cxx_Grammar.h.

bool SgFile::p_skipAstConsistancyTests

protected

Definition at line 22390 of file Cxx_Grammar.h.

int SgFile::p_frontendErrorCode

protected

Definition at line 22394 of file Cxx_Grammar.h.

int SgFile::p_javacErrorCode

protected

Definition at line 22398 of file Cxx_Grammar.h.

int SgFile::p_ecjErrorCode

protected

Definition at line 22402 of file Cxx_Grammar.h.

int SgFile::p_unparserErrorCode

protected

Definition at line 22406 of file Cxx_Grammar.h.

int SgFile::p_backendCompilerErrorCode

protected

Definition at line 22410 of file Cxx_Grammar.h.

bool SgFile::p_unparsedFileFailedCompilation

protected

Definition at line 22414 of file Cxx_Grammar.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation