GCC Middle and Back End API Reference
state_writer Class Reference
Inheritance diagram for state_writer:
Collaboration diagram for state_writer:

Public Member Functions

 state_writer ()
void write_new_line ()
void write_any_indent (int leading_spaces)
void begin_s_expr (const char *tag)
void end_s_expr ()

Private Member Functions

void write_state_fileloc (struct fileloc *floc)
void write_state_fields (pair_p fields)
void write_state_a_string (const char *s)
void write_state_string_option (options_p current)
void write_state_type_option (options_p current)
void write_state_nested_option (options_p current)
void write_state_option (options_p current)
void write_state_options (options_p opt)
void write_state_lang_bitmap (lang_bitmap bitmap)
void write_state_version (const char *version)
void write_state_scalar_type (type_p current)
void write_state_string_type (type_p current)
void write_state_undefined_type (type_p current)
void write_state_struct_union_type (type_p current, const char *kindstr)
void write_state_struct_type (type_p current)
void write_state_user_struct_type (type_p current)
void write_state_union_type (type_p current)
void write_state_lang_struct_type (type_p current)
void write_state_param_struct_type (type_p current)
void write_state_pointer_type (type_p current)
void write_state_array_type (type_p current)
void write_state_gc_used (enum gc_used_enum gus)
void write_state_common_type_content (type_p current)
void write_state_type (type_p current)
void write_state_pair (pair_p current)
int write_state_pair_list (pair_p list)
void write_state_typedefs (void)
void write_state_structures (void)
void write_state_param_structs (void)
void write_state_variables (void)
void write_state_srcdir (void)
void write_state_files_list (void)
void write_state_languages (void)

Private Attributes

int m_state_written_type_count


void write_state (const char *state_path)

Detailed Description

   A class for writing out "gtype.state".  

Constructor & Destructor Documentation

state_writer::state_writer ( )
   class state_writer's trivial constructor.  

Member Function Documentation

void s_expr_writer::begin_s_expr ( const char *  tag)
   Write the beginning of a new s-expresion e.g. "(!foo "
   The writer automatically adds whitespace to show the hierarchical
   structure of the expressions, so each one starts on a new line,
   and any within it will be at an increased indentation level.  

Referenced by write_state_array_type(), write_state_param_structs(), write_state_type(), and write_state_typedefs().

void s_expr_writer::end_s_expr ( void  )
   Write out the end of an s-expression: any necssessary indentation,
   a closing parenthesis, and a new line.  

References fatal().

Referenced by write_state_param_structs(), write_state_type(), and write_state_typedefs().

void s_expr_writer::write_any_indent ( int  leading_spaces)
   If we've just had a newline, write the indentation amount, potentially
   omitting some spaces.

   LEADING_SPACES exists to support code that writes strings with leading
   spaces (e.g " foo") which might occur within a line, or could be the first
   thing on a line.  By passing leading_spaces == 1, when such a string is the
   first thing on a line, write_any_indent () swallows the successive
   leading spaces into the indentation so that the "foo" begins at the expected

References s_expr_writer::m_indent_amount, and s_expr_writer::write_new_line().

Referenced by write_state_array_type(), write_state_fileloc(), write_state_scalar_type(), write_state_type(), write_state_union_type(), and write_state_version().

void s_expr_writer::write_new_line ( void  )
   Write a newline to the output file, merging adjacent newlines.  
     Don't add a newline if we've just had one.  

References s_expr_writer::m_had_recent_newline, and s_expr_writer::m_indent_amount.

Referenced by s_expr_writer::write_any_indent().

void state_writer::write_state_a_string ( const char *  s)
   Write a null-terminated string in our lexical convention, very
   similar to the convention of C.  

Referenced by write_state_scalar_type(), write_state_type(), and write_state_typedefs().

void state_writer::write_state_array_type ( type_p  current)
void state_writer::write_state_common_type_content ( type_p  current)
   Utility routine to write the common content of all types.  Notice
   that the next field is *not* written on purpose.  
     We do not write the next type, because list of types are
     explicitly written.  However, lang_struct are special in that
     respect.  See function write_state_lang_struct_type for more.  

Referenced by write_state_scalar_type().

void state_writer::write_state_fields ( pair_p  fields)
   Write a list of fields.  
void state_writer::write_state_fileloc ( struct fileloc floc)
   Write a file location.  Files relative to $(srcdir) are quite
   frequent and are handled specially.  This ensures that two gengtype
   state file-s produced by gengtype on the same GCC source tree are
   very similar and can be reasonably compared with diff, even if the
   two GCC source trees have different absolute paths.  
         Most of the files are inside $(srcdir) so it is worth to
         handle them specially.  

References state_file, and s_expr_writer::write_any_indent().

Referenced by write_state_type().

void state_writer::write_state_files_list ( void  )
   Count and write the list of our files.  
     Write the list of files with their lang_bitmap.  
         Most of the files are inside $(srcdir) so it is worth to
         handle them specially.  
         Terminate the inner s-expression (either "srcfile" or "file").   
     Terminate the "fileslist" s-expression.  
void state_writer::write_state_lang_bitmap ( lang_bitmap  bitmap)
   Write a bitmap representing a set of GCC front-end languages.  
void state_writer::write_state_lang_struct_type ( type_p  current)
   Write a lang_struct type.  This is tricky and was painful to debug,
   we deal with the next field specifically within their lang_struct
   subfield, which points to a linked list of homonumous types.
   Change this function with extreme care, see also
     lang_struct-ures are particularly tricky, since their
     u.s.lang_struct field gives a list of homonymous struct-s or
         Every member of the homonymous list should have the same tag.  

Referenced by write_state_gc_used().

void state_writer::write_state_languages ( void  )
   Write the list of GCC front-end languages.  
         Languages names are identifiers, we expect only letters or
         underscores or digits in them.  In particular, C++ is not a
         valid language name, but cp is valid.  
void state_writer::write_state_nested_option ( options_p  current)
void state_writer::write_state_option ( options_p  current)
     Terminate the "option" s-expression.  
void state_writer::write_state_options ( options_p  opt)
   Write a list of GTY options.  

Referenced by write_state_type().

void state_writer::write_state_pair ( pair_p  current)
   Write a pair.  
     Terminate the "pair" s-expression.  
int state_writer::write_state_pair_list ( pair_p  list)
   Write a pair list and return the number of pairs written.  
void state_writer::write_state_param_struct_type ( type_p  current)
   Write a parametrized structure GTY type.  
void state_writer::write_state_param_structs ( void  )
void state_writer::write_state_pointer_type ( type_p  current)
   Write a pointer type.  

Referenced by write_state_gc_used().

void state_writer::write_state_scalar_type ( type_p  current)
void state_writer::write_state_srcdir ( void  )
   Write the source directory.  File locations within the source
   directory have been written specifically.  
void state_writer::write_state_string_option ( options_p  current)
   Our option-s have three kinds, each with its writer.  
void state_writer::write_state_string_type ( type_p  current)
   Write the string type.  There is only one such thing! 
void state_writer::write_state_struct_type ( type_p  current)
   Write a GTY struct type.  

Referenced by write_state_gc_used().

void state_writer::write_state_struct_union_type ( type_p  current,
const char *  kindstr 
   Common code to write structure like types.  

References type::s, type::u, and write_state_type().

void state_writer::write_state_structures ( void  )
   Write our structures.  
     Terminate the "structures" s-expression.  
void state_writer::write_state_type ( type_p  current)
   The important and recursive routine writing GTY types as understood
   by gengtype.  Types which have a positive state_number have already
   been seen and written.  
     Terminate the "type" s-expression.  

References s_expr_writer::begin_s_expr(), s_expr_writer::end_s_expr(), pair::line, pair::name, pair::opt, state_file, pair::type, s_expr_writer::write_any_indent(), write_state_a_string(), write_state_fileloc(), and write_state_options().

Referenced by write_state_struct_union_type().

void state_writer::write_state_type_option ( options_p  current)
void state_writer::write_state_typedefs ( void  )
   When writing imported linked lists, like typedefs, structures,
   param_structs, ... we count their length first and write it.  These
   eases the reading, and enables an extra verification on the number
   of actually read items.  
   Write our typedefs.  

References s_expr_writer::begin_s_expr(), s_expr_writer::end_s_expr(), srcdir, and write_state_a_string().

void state_writer::write_state_undefined_type ( type_p  current)
   Write an undefined type.  

Referenced by write_state_gc_used().

void state_writer::write_state_union_type ( type_p  current)
   write a GTY union type.  

References state_file, and s_expr_writer::write_any_indent().

Referenced by write_state_gc_used().

void state_writer::write_state_user_struct_type ( type_p  current)
   Write a GTY user-defined struct type.  

Referenced by write_state_gc_used().

void state_writer::write_state_variables ( void  )
   Write our variables.  

References errno, fatal(), and state_file.

void state_writer::write_state_version ( const char *  version)
   Write version information.  

References state_file, and s_expr_writer::write_any_indent().

Friends And Related Function Documentation

void write_state ( const char *  state_path)

Field Documentation

int state_writer::m_state_written_type_count
     Counter of written types.  

Referenced by write_state_array_type().

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