ROSE  0.9.9.123
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
SgFile Class Reference

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

Definition at line 22898 of file Cxx_Grammar.h.

Inheritance diagram for SgFile:
Inheritance graph
[legend]
Collaboration diagram for SgFile:
Collaboration graph
[legend]

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
 
typedef SgSupport base_node_type
 
- Public Types inherited from SgSupport
enum  { static_variant = V_SgSupport }
 static variant value
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const ROSE_OVERRIDE
 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.
 
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)
 
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.
 
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::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...
 
SgProjectget_project ()
 Get the SgProject IR node if available (template instantiation information is stored there)
 
 SgFile (const SgFile &X)
 
Sg_File_Infoget_file_info () const ROSE_OVERRIDE
 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.
 
void initializeSourcePosition (const std::string &sourceFilename)
 
void runFrontend (int &nextErrorCode)
 
virtual void addNewAttribute (std::string s, AstAttribute *a) ROSE_OVERRIDE
 Add a new attribute represented by the named string.
 
virtual AstAttribute * getAttribute (std::string s) const ROSE_OVERRIDE
 Returns attribute of name 's'.
 
virtual void updateAttribute (std::string s, AstAttribute *a) ROSE_OVERRIDE
 Replace existing attribute of name 's' with new AstAttribute.
 
virtual void setAttribute (std::string s, AstAttribute *a) ROSE_OVERRIDE
 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) ROSE_OVERRIDE
 Remove attribute of name 's' if present.
 
virtual bool attributeExists (std::string s) const ROSE_OVERRIDE
 Tests if attribute of name 's' is present.
 
virtual int numberOfAttributes () const ROSE_OVERRIDE
 Returns the number of attributes on this IR node.
 
virtual std::string class_name () const ROSE_OVERRIDE
 returns a string representing the class name
 
virtual VariantT variantT () const ROSE_OVERRIDE
 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)
 ROSETTA generated delete operator: deletes all non-traversed members.
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer () ROSE_OVERRIDE
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer () ROSE_OVERRIDE
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual size_t get_numberOfTraversalSuccessors () ROSE_OVERRIDE
 return number of children in the traversal successor list
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx) ROSE_OVERRIDE
 index-based access to traversal successors by index number
 
virtual size_t get_childIndex (SgNode *child) ROSE_OVERRIDE
 index-based access to traversal successors by child node
 
virtual RTIReturnType roseRTI () ROSE_OVERRIDE
 return C++ Runtime-Time-Information
 
virtual const char * sage_class_name () const ROSE_OVERRIDE ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor) ROSE_OVERRIDE
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool () ROSE_OVERRIDE
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool () ROSE_OVERRIDE
 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 ROSE_OVERRIDE
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *) ROSE_OVERRIDE
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const ROSE_OVERRIDE
 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)
 IR node constructor to support AST File I/O.
 
SgFileaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
Sg_File_Infoget_startOfConstruct () const ROSE_OVERRIDE
 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)
 Sets the list of strings representing the original command-line.
 
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_C11_gnu_only () const
 
void set_C11_gnu_only (bool C11_gnu_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_Cxx11_gnu_only () const
 
void set_Cxx11_gnu_only (bool Cxx11_gnu_only)
 
bool get_C14_only () const
 
void set_C14_only (bool C14_only)
 
bool get_C14_gnu_only () const
 
void set_C14_gnu_only (bool C14_gnu_only)
 
bool get_Cxx14_only () const
 
void set_Cxx14_only (bool Cxx14_only)
 
bool get_Cxx14_gnu_only () const
 
void set_Cxx14_gnu_only (bool Cxx14_gnu_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_F2008_only () const
 
void set_F2008_only (bool F2008_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)
 
std::string get_objectFileNameWithPath () const
 
void set_objectFileNameWithPath (std::string objectFileNameWithPath)
 
std::string get_objectFileNameWithoutPath () const
 
void set_objectFileNameWithoutPath (std::string objectFileNameWithoutPath)
 
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 ROSE_OVERRIDE
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
void set_attributeMechanism (AstAttributeMechanism *attributeMechanism) ROSE_OVERRIDE
 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_sourceFileUsesFortran2008FileExtension () const
 
void set_sourceFileUsesFortran2008FileExtension (bool sourceFileUsesFortran2008FileExtension)
 
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_experimental_fortran_frontend_OFP_test () const
 
void set_experimental_fortran_frontend_OFP_test (bool experimental_fortran_frontend_OFP_test)
 
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)
 
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)
 
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_unparse_using_leading_and_trailing_token_mappings () const
 
void set_unparse_using_leading_and_trailing_token_mappings (bool unparse_using_leading_and_trailing_token_mappings)
 
bool get_unparse_template_ast () const
 
void set_unparse_template_ast (bool unparse_template_ast)
 
bool get_skipAstConsistancyTests () const
 
void set_skipAstConsistancyTests (bool skipAstConsistancyTests)
 
bool get_multifile_support () const
 
void set_multifile_support (bool multifile_support)
 
bool get_optimization () const
 
void set_optimization (bool optimization)
 
bool get_use_token_stream_to_improve_source_position_info () const
 
void set_use_token_stream_to_improve_source_position_info (bool use_token_stream_to_improve_source_position_info)
 
bool get_suppress_variable_declaration_normalization () const
 
void set_suppress_variable_declaration_normalization (bool suppress_variable_declaration_normalization)
 
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_midendErrorCode () const
 
void set_midendErrorCode (int midendErrorCode)
 
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
 
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)
 ROSETTA generated delete operator: deletes all non-traversed members.
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgSupport (const SgSupportStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgSupportaddRegExpAttribute (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
 
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)
 ROSETTA generated delete operator: deletes all non-traversed members.
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgNodeaddRegExpAttribute (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...
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...
 
bool get_isModified () const
 Acess function for isModified flag. More...
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_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.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
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_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct.
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node.
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children.
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children.
 
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version.
 
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...
 
SgNodeget_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
 
static void stripEdgCommandLineOptions (std::vector< std::string > &argv)
 function that removes all EDG related options from a command line
 
static void stripFortranCommandLineOptions (std::vector< std::string > &argv)
 function that removes all OFP related options from a command line
 
static void usage (int status)
 Move this function from ROSE into the AST restructuring tool.
 
static std::string generate_C_preprocessor_intermediate_filename (std::string filename)
 Support for C preprocessed files (Fortran only).
 
static std::string get_outputLanguageOptionName (outputLanguageOption_enum lang)
 
static void set_skip_unparse_asm_commands (bool b)
 
static bool get_skip_unparse_asm_commands ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t 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 over all IR nodes by type of IR node.
 
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 SgFilebuild_node_from_nonlist_children ()
 
- Static Public Member Functions inherited from SgSupport
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t 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 over all IR nodes by type of IR node.
 
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 SgSupportbuild_node_from_nonlist_children ()
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
static size_t 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 over all IR nodes by type of IR node.
 
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 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.
 
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_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations). More...
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations). 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 SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static SgNodebuild_node_from_nonlist_children ()
 

Protected Attributes

Sg_File_Infop_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
 
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_C11_gnu_only
 
bool p_Cxx0x_only
 
bool p_Cxx11_only
 
bool p_Cxx11_gnu_only
 
bool p_C14_only
 
bool p_C14_gnu_only
 
bool p_Cxx14_only
 
bool p_Cxx14_gnu_only
 
bool p_Fortran_only
 
bool p_F77_only
 
bool p_F90_only
 
bool p_F95_only
 
bool p_F2003_only
 
bool p_F2008_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
 
std::string p_objectFileNameWithPath
 
std::string p_objectFileNameWithoutPath
 
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_sourceFileUsesFortran2008FileExtension
 
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_experimental_fortran_frontend_OFP_test
 
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
 
SgStringList p_libraryArchiveObjectFileNameList
 
bool p_isLibraryArchive
 
bool p_isObjectFile
 
bool p_unparse_tokens
 
int p_unparse_tokens_testing
 
bool p_unparse_using_leading_and_trailing_token_mappings
 
bool p_unparse_template_ast
 
bool p_skipAstConsistancyTests
 
bool p_multifile_support
 
bool p_optimization
 
bool p_use_token_stream_to_improve_source_position_info
 
bool p_suppress_variable_declaration_normalization
 
int p_frontendErrorCode
 
int p_javacErrorCode
 
int p_ecjErrorCode
 
int p_midendErrorCode
 
int p_unparserErrorCode
 
int p_backendCompilerErrorCode
 
bool p_unparsedFileFailedCompilation
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 

Static Protected Attributes

static bool p_skip_unparse_asm_commands
 
- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
static SgTypeTablep_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.
 
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.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 

Friends

void alternativeSageEdgInterfaceConstruction (SgFile *file)
 Move this function from ROSE into the AST restructuring tool.
 
ROSE_DLL_API friend SgFileisSgFile (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const SgFileisSgFile (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgFileSgFile_getPointerFromGlobalIndex (unsigned long globalIndex)
 Methods to find the pointer to a global and local index.
 
unsigned long SgFile_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgFile_clearMemoryPool ()
 clear the memory pool
 
void SgFile_extendMemoryPoolForFileIO (unsigned long)
 internal support for AST file I/O (operating on the memory pools)
 
void SgFile_getNextValidPointer (std::pair< SgFile *, std::vector< unsigned char * >::const_iterator > &)
 internal support for AST file I/O (operating on the memory pools)
 
void SgFile_resetValidFreepointers ()
 internal support for AST file I/O (operating on the memory pools)
 

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.
 

Member Enumeration Documentation

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

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 22914 of file Cxx_Grammar.h.

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

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

Reimplemented from SgSupport.

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

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

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.

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.

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.

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.

Friends And Related Function Documentation

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

Member Data Documentation

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

Definition at line 24429 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++).

Definition at line 24433 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 24449 of file Cxx_Grammar.h.


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