1 // gogo.h -- Go frontend parsed representation. -*- C++ -*-
3 // Copyright 2009 The Go Authors. All rights reserved.
4 // Use of this source code is governed by a BSD-style
5 // license that can be found in the LICENSE file.
12 class Type_hash_identical;
15 class Typed_identifier;
16 class Typed_identifier_list;
28 class Struct_field_list;
34 class Forward_declaration_type;
39 class Translate_context;
43 // This file declares the basic classes used to hold the internal
44 // representation of Go which is built by the parser.
46 // An initialization function for an imported package. This is a
47 // magic function which initializes variables and runs the "init"
53 Import_init(const std::string& package_name, const std::string& init_name,
55 : package_name_(package_name), init_name_(init_name), priority_(priority)
58 // The name of the package being imported.
61 { return this->package_name_; }
63 // The name of the package's init function.
66 { return this->init_name_; }
68 // The priority of the initialization function. Functions with a
69 // lower priority number must be run first.
72 { return this->priority_; }
75 // The name of the package being imported.
76 std::string package_name_;
77 // The name of the package's init function.
78 std::string init_name_;
83 // For sorting purposes.
86 operator<(const Import_init& i1, const Import_init& i2)
88 if (i1.priority() < i2.priority())
90 if (i1.priority() > i2.priority())
92 if (i1.package_name() != i2.package_name())
93 return i1.package_name() < i2.package_name();
94 return i1.init_name() < i2.init_name();
97 // The holder for the internal representation of the entire
103 // Create the IR, passing in the sizes of the types "int" and
104 // "uintptr" in bits.
105 Gogo(int int_type_size, int pointer_size);
107 // Get the package name.
109 package_name() const;
111 // Set the package name.
113 set_package_name(const std::string&, source_location);
115 // Return whether this is the "main" package.
117 is_main_package() const;
119 // If necessary, adjust the name to use for a hidden symbol. We add
120 // a prefix of the package name, so that hidden symbols in different
121 // packages do not collide.
123 pack_hidden_name(const std::string& name, bool is_exported) const
127 : ('.' + this->unique_prefix()
128 + '.' + this->package_name()
132 // Unpack a name which may have been hidden. Returns the
133 // user-visible name of the object.
135 unpack_hidden_name(const std::string& name)
136 { return name[0] != '.' ? name : name.substr(name.rfind('.') + 1); }
138 // Return whether a possibly packed name is hidden.
140 is_hidden_name(const std::string& name)
141 { return name[0] == '.'; }
143 // Return the package prefix of a hidden name.
145 hidden_name_prefix(const std::string& name)
147 gcc_assert(Gogo::is_hidden_name(name));
148 return name.substr(1, name.rfind('.') - 1);
151 // Given a name which may or may not have been hidden, return the
152 // name to use in an error message.
154 message_name(const std::string& name);
156 // Return whether a name is the blank identifier _.
158 is_sink_name(const std::string& name)
160 return (name[0] == '.'
161 && name[name.length() - 1] == '_'
162 && name[name.length() - 2] == '.');
165 // Return the unique prefix to use for all exported symbols.
167 unique_prefix() const;
169 // Set the unique prefix.
171 set_unique_prefix(const std::string&);
173 // Return the priority to use for the package we are compiling.
174 // This is two more than the largest priority of any package we
177 package_priority() const;
179 // Import a package. FILENAME is the file name argument, LOCAL_NAME
180 // is the local name to give to the package. If LOCAL_NAME is empty
181 // the declarations are added to the global scope.
183 import_package(const std::string& filename, const std::string& local_name,
184 bool is_local_name_exported, source_location);
186 // Whether we are the global binding level.
188 in_global_scope() const;
190 // Look up a name in the current binding contours.
192 lookup(const std::string&, Named_object** pfunction) const;
194 // Look up a name in the current block.
196 lookup_in_block(const std::string&) const;
198 // Look up a name in the global namespace--the universal scope.
200 lookup_global(const char*) const;
202 // Add a new imported package. REAL_NAME is the real name of the
203 // package. ALIAS is the alias of the package; this may be the same
204 // as REAL_NAME. This sets *PADD_TO_GLOBALS if symbols added to
205 // this package should be added to the global namespace; this is
206 // true if the alias is ".". LOCATION is the location of the import
207 // statement. This returns the new package, or NULL on error.
209 add_imported_package(const std::string& real_name, const std::string& alias,
210 bool is_alias_exported,
211 const std::string& unique_prefix,
212 source_location location,
213 bool* padd_to_globals);
215 // Register a package. This package may or may not be imported.
216 // This returns the Package structure for the package, creating if
219 register_package(const std::string& name, const std::string& unique_prefix,
222 // Start compiling a function. ADD_METHOD_TO_TYPE is true if a
223 // method function should be added to the type of its receiver.
225 start_function(const std::string& name, Function_type* type,
226 bool add_method_to_type, source_location);
228 // Finish compiling a function.
230 finish_function(source_location);
232 // Return the current function.
234 current_function() const;
236 // Start a new block. This is not initially associated with a
239 start_block(source_location);
241 // Finish the current block and return it.
243 finish_block(source_location);
245 // Declare an unknown name. This is used while parsing. The name
246 // must be resolved by the end of the parse. Unknown names are
247 // always added at the package level.
249 add_unknown_name(const std::string& name, source_location);
251 // Declare a function.
253 declare_function(const std::string&, Function_type*, source_location);
257 add_label_definition(const std::string&, source_location);
259 // Add a label reference.
261 add_label_reference(const std::string&);
263 // Add a statement to the current block.
265 add_statement(Statement*);
267 // Add a block to the current block.
269 add_block(Block*, source_location);
273 add_constant(const Typed_identifier&, Expression*, int iota_value);
277 add_type(const std::string&, Type*, source_location);
279 // Add a named type. This is used for builtin types, and to add an
280 // imported type to the global scope.
282 add_named_type(Named_type*);
286 declare_type(const std::string&, source_location);
288 // Declare a type at the package level. This is used when the
289 // parser sees an unknown name where a type name is required.
291 declare_package_type(const std::string&, source_location);
293 // Define a type which was already declared.
295 define_type(Named_object*, Named_type*);
299 add_variable(const std::string&, Variable*);
301 // Add a sink--a reference to the blank identifier _.
305 // Add a named object to the current namespace. This is used for
306 // import . "package".
308 add_named_object(Named_object*);
310 // Return a name to use for a thunk function. A thunk function is
311 // one we create during the compilation, for a go statement or a
312 // defer statement or a method expression.
316 // Return whether an object is a thunk.
318 is_thunk(const Named_object*);
320 // Note that we've seen an interface type. This is used to build
321 // all required interface method tables.
323 record_interface_type(Interface_type*);
325 // Note that we need an initialization function.
328 { this->need_init_fn_ = true; }
330 // Clear out all names in file scope. This is called when we start
331 // parsing a new file.
335 // Traverse the tree. See the Traverse class.
339 // Define the predeclared global names.
341 define_global_names();
343 // Verify and complete all types.
347 // Lower the parse tree.
351 // Lower all the statements in a block.
353 lower_block(Named_object* function, Block*);
355 // Lower an expression.
357 lower_expression(Named_object* function, Expression**);
361 lower_constant(Named_object*);
363 // Finalize the method lists and build stub methods for named types.
367 // Work out the types to use for unspecified variables and
372 // Type check the program.
376 // Check the types in a single block. This is used for complicated
379 check_types_in_block(Block*);
381 // Check for return statements.
383 check_return_statements();
389 // Add an import control function for an imported package to the
392 add_import_init_fn(const std::string& package_name,
393 const std::string& init_name, int prio);
395 // Turn short-cut operators (&&, ||) into explicit if statements.
399 // Use temporary variables to force order of evaluation.
403 // Build thunks for functions which call recover.
405 build_recover_thunks();
407 // Simplify statements which might use thunks: go and defer
410 simplify_thunk_statements();
412 // Convert named types to the backend representation.
414 convert_named_types();
416 // Convert named types in a list of bindings.
418 convert_named_types_in_bindings(Bindings*);
420 // True if named types have been converted to the backend
423 named_types_are_converted() const
424 { return this->named_types_are_converted_; }
426 // Write out the global values.
430 // Build a call to a builtin function. PDECL should point to a NULL
431 // initialized static pointer which will hold the fndecl. NAME is
432 // the name of the function. NARGS is the number of arguments.
433 // RETTYPE is the return type. It is followed by NARGS pairs of
434 // type and argument (both trees).
436 call_builtin(tree* pdecl, source_location, const char* name, int nargs,
439 // Build a call to the runtime error function.
441 runtime_error(int code, source_location);
443 // Build a builtin struct with a list of fields.
445 builtin_struct(tree* ptype, const char* struct_name, tree struct_type,
448 // Mark a function declaration as a builtin library function.
450 mark_fndecl_as_builtin_library(tree fndecl);
452 // Build the type of the struct that holds a slice for the given
455 slice_type_tree(tree element_type_tree);
457 // Given a tree for a slice type, return the tree for the element
460 slice_element_type_tree(tree slice_type_tree);
462 // Build a constructor for a slice. SLICE_TYPE_TREE is the type of
463 // the slice. VALUES points to the values. COUNT is the size,
464 // CAPACITY is the capacity. If CAPACITY is NULL, it is set to
467 slice_constructor(tree slice_type_tree, tree values, tree count,
470 // Build a constructor for an empty slice. SLICE_TYPE_TREE is the
471 // type of the slice.
473 empty_slice_constructor(tree slice_type_tree);
475 // Build a map descriptor.
477 map_descriptor(Map_type*);
479 // Return a tree for the type of a map descriptor. This is struct
480 // __go_map_descriptor in libgo/runtime/map.h. This is the same for
483 map_descriptor_type();
485 // Build a type descriptor for TYPE using INITIALIZER as the type
486 // descriptor. This builds a new decl stored in *PDECL.
488 build_type_descriptor_decl(const Type*, Expression* initializer,
491 // Build required interface method tables.
493 build_interface_method_tables();
495 // Build an interface method table for a type: a list of function
496 // pointers, one for each interface method. This returns a decl.
498 interface_method_table_for_type(const Interface_type*, Named_type*,
501 // Return a tree which allocate SIZE bytes to hold values of type
504 allocate_memory(Type *type, tree size, source_location);
506 // Return a type to use for pointer to const char.
508 const_char_pointer_type_tree();
510 // Build a string constant with the right type.
512 string_constant_tree(const std::string&);
514 // Build a Go string constant. This returns a pointer to the
517 go_string_constant_tree(const std::string&);
519 // Send a value on a channel.
521 send_on_channel(tree channel, tree val, bool blocking, bool for_select,
524 // Receive a value from a channel.
526 receive_from_channel(tree type_tree, tree channel, bool for_select,
529 // Return a tree for receiving an integer on a channel.
531 receive_as_64bit_integer(tree type, tree channel, bool blocking,
535 // Make a trampoline which calls FNADDR passing CLOSURE.
537 make_trampoline(tree fnaddr, tree closure, source_location);
540 // During parsing, we keep a stack of functions. Each function on
541 // the stack is one that we are currently parsing. For each
542 // function, we keep track of the current stack of blocks.
546 Named_object* function;
547 // The stack of active blocks in the function.
548 std::vector<Block*> blocks;
551 // The stack of functions.
552 typedef std::vector<Open_function> Open_functions;
554 // Create trees for implicit builtin functions.
556 define_builtin_function_trees();
558 // Set up the built-in unsafe package.
560 import_unsafe(const std::string&, bool is_exported, source_location);
562 // Add a new imported package.
564 add_package(const std::string& real_name, const std::string& alias,
565 const std::string& unique_prefix, source_location location);
567 // Return the current binding contour.
572 current_bindings() const;
574 // Return the current block.
578 // Get the name of the magic initialization function.
582 // Get the decl for the magic initialization function.
584 initialization_function_decl();
586 // Write the magic initialization function.
588 write_initialization_function(tree fndecl, tree init_stmt_list);
590 // Initialize imported packages.
594 // Register variables with the garbage collector.
596 register_gc_vars(const std::vector<Named_object*>&, tree*);
598 // Build a pointer to a Go string constant. This returns a pointer
601 ptr_go_string_constant_tree(const std::string&);
603 // Return the name to use for a type descriptor decl for an unnamed
606 unnamed_type_descriptor_decl_name(const Type* type);
608 // Return the name to use for a type descriptor decl for a type
609 // named NO, defined in IN_FUNCTION.
611 type_descriptor_decl_name(const Named_object* no,
612 const Named_object* in_function);
614 // Where a type descriptor should be defined.
615 enum Type_descriptor_location
617 // Defined in this file.
618 TYPE_DESCRIPTOR_DEFINED,
619 // Defined in some other file.
620 TYPE_DESCRIPTOR_UNDEFINED,
621 // Common definition which may occur in multiple files.
622 TYPE_DESCRIPTOR_COMMON
625 // Return where the decl for TYPE should be defined.
626 Type_descriptor_location
627 type_descriptor_location(const Type* type);
629 // Return the type of a trampoline.
631 trampoline_type_tree();
633 // Type used to map import names to packages.
634 typedef std::map<std::string, Package*> Imports;
636 // Type used to map package names to packages.
637 typedef std::map<std::string, Package*> Packages;
639 // Type used to map special names in the sys package.
640 typedef std::map<std::string, std::string> Sys_names;
642 // Hash table mapping map types to map descriptor decls.
643 typedef Unordered_map_hash(const Map_type*, tree, Type_hash_identical,
644 Type_identical) Map_descriptors;
646 // Map unnamed types to type descriptor decls.
647 typedef Unordered_map_hash(const Type*, tree, Type_hash_identical,
648 Type_identical) Type_descriptor_decls;
650 // The package we are compiling.
652 // The list of currently open functions during parsing.
653 Open_functions functions_;
654 // The global binding contour. This includes the builtin functions
655 // and the package we are compiling.
657 // Mapping from import file names to packages.
659 // Whether the magic unsafe package was imported.
660 bool imported_unsafe_;
661 // Mapping from package names we have seen to packages. This does
662 // not include the package we are compiling.
664 // Mapping from map types to map descriptors.
665 Map_descriptors* map_descriptors_;
666 // Mapping from unnamed types to type descriptor decls.
667 Type_descriptor_decls* type_descriptor_decls_;
668 // The functions named "init", if there are any.
669 std::vector<Named_object*> init_functions_;
670 // Whether we need a magic initialization function.
672 // The name of the magic initialization function.
673 std::string init_fn_name_;
674 // A list of import control variables for packages that we import.
675 std::set<Import_init> imported_init_fns_;
676 // The unique prefix used for all global symbols.
677 std::string unique_prefix_;
678 // Whether an explicit unique prefix was set by -fgo-prefix.
679 bool unique_prefix_specified_;
680 // A list of interface types defined while parsing.
681 std::vector<Interface_type*> interface_types_;
682 // Whether named types have been converted.
683 bool named_types_are_converted_;
686 // A block of statements.
691 Block(Block* enclosing, source_location);
693 // Return the enclosing block.
696 { return this->enclosing_; }
698 // Return the bindings of the block.
701 { return this->bindings_; }
705 { return this->bindings_; }
707 // Look at the block's statements.
708 const std::vector<Statement*>*
710 { return &this->statements_; }
712 // Return the start location. This is normally the location of the
713 // left curly brace which starts the block.
715 start_location() const
716 { return this->start_location_; }
718 // Return the end location. This is normally the location of the
719 // right curly brace which ends the block.
722 { return this->end_location_; }
724 // Add a statement to the block.
726 add_statement(Statement*);
728 // Add a statement to the front of the block.
730 add_statement_at_front(Statement*);
732 // Replace a statement in a block.
734 replace_statement(size_t index, Statement*);
736 // Add a Statement before statement number INDEX.
738 insert_statement_before(size_t index, Statement*);
740 // Add a Statement after statement number INDEX.
742 insert_statement_after(size_t index, Statement*);
744 // Set the end location of the block.
746 set_end_location(source_location location)
747 { this->end_location_ = location; }
749 // Traverse the tree.
753 // Set final types for unspecified variables and constants.
757 // Return true if execution of this block may fall through to the
760 may_fall_through() const;
762 // Return a tree of the code in this block.
764 get_tree(Translate_context*);
766 // Iterate over statements.
768 typedef std::vector<Statement*>::iterator iterator;
772 { return this->statements_.begin(); }
776 { return this->statements_.end(); }
781 // Statements in the block.
782 std::vector<Statement*> statements_;
785 // Location of start of block.
786 source_location start_location_;
787 // Location of end of block.
788 source_location end_location_;
796 Function(Function_type* type, Function*, Block*, source_location);
798 // Return the function's type.
801 { return this->type_; }
803 // Return the enclosing function if there is one.
806 { return this->enclosing_; }
808 // Set the enclosing function. This is used when building thunks
809 // for functions which call recover.
811 set_enclosing(Function* enclosing)
813 gcc_assert(this->enclosing_ == NULL);
814 this->enclosing_ = enclosing;
817 // Create the named result variables in the outer block.
819 create_named_result_variables(Gogo*);
821 // Update the named result variables when cloning a function which
824 update_named_result_variables();
826 // Add a new field to the closure variable.
828 add_closure_field(Named_object* var, source_location loc)
829 { this->closure_fields_.push_back(std::make_pair(var, loc)); }
831 // Whether this function needs a closure.
833 needs_closure() const
834 { return !this->closure_fields_.empty(); }
836 // Return the closure variable, creating it if necessary. This is
837 // passed to the function as a static chain parameter.
841 // Set the closure variable. This is used when building thunks for
842 // functions which call recover.
844 set_closure_var(Named_object* v)
846 gcc_assert(this->closure_var_ == NULL);
847 this->closure_var_ = v;
850 // Return the variable for a reference to field INDEX in the closure
853 enclosing_var(unsigned int index)
855 gcc_assert(index < this->closure_fields_.size());
856 return closure_fields_[index].first;
859 // Set the type of the closure variable if there is one.
863 // Get the block of statements associated with the function.
866 { return this->block_; }
868 // Get the location of the start of the function.
871 { return this->location_; }
873 // Return whether this function is actually a method.
877 // Add a label definition to the function.
879 add_label_definition(const std::string& label_name, source_location);
881 // Add a label reference to a function.
883 add_label_reference(const std::string& label_name);
885 // Warn about labels that are defined but not used.
887 check_labels() const;
889 // Whether this function calls the predeclared recover function.
891 calls_recover() const
892 { return this->calls_recover_; }
894 // Record that this function calls the predeclared recover function.
895 // This is set during the lowering pass.
898 { this->calls_recover_ = true; }
900 // Whether this is a recover thunk function.
902 is_recover_thunk() const
903 { return this->is_recover_thunk_; }
905 // Record that this is a thunk built for a function which calls
908 set_is_recover_thunk()
909 { this->is_recover_thunk_ = true; }
911 // Whether this function already has a recover thunk.
913 has_recover_thunk() const
914 { return this->has_recover_thunk_; }
916 // Record that this function already has a recover thunk.
918 set_has_recover_thunk()
919 { this->has_recover_thunk_ = true; }
921 // Swap with another function. Used only for the thunk which calls
924 swap_for_recover(Function *);
926 // Traverse the tree.
930 // Determine types in the function.
934 // Return the function's decl given an identifier.
936 get_or_make_decl(Gogo*, Named_object*, tree id);
938 // Return the function's decl after it has been built.
942 gcc_assert(this->fndecl_ != NULL);
943 return this->fndecl_;
946 // Set the function decl to hold a tree of the function code.
948 build_tree(Gogo*, Named_object*);
950 // Get the value to return when not explicitly specified. May also
951 // add statements to execute first to STMT_LIST.
953 return_value(Gogo*, Named_object*, source_location, tree* stmt_list) const;
955 // Get a tree for the variable holding the defer stack.
957 defer_stack(source_location);
959 // Export the function.
961 export_func(Export*, const std::string& name) const;
963 // Export a function with a type.
965 export_func_with_type(Export*, const std::string& name,
966 const Function_type*);
968 // Import a function.
970 import_func(Import*, std::string* pname, Typed_identifier** receiver,
971 Typed_identifier_list** pparameters,
972 Typed_identifier_list** presults, bool* is_varargs);
975 // Type for mapping from label names to Label objects.
976 typedef Unordered_map(std::string, Label*) Labels;
979 make_receiver_parm_decl(Gogo*, Named_object*, tree);
982 copy_parm_to_heap(Gogo*, Named_object*, tree);
985 build_defer_wrapper(Gogo*, Named_object*, tree*, tree*);
987 typedef std::vector<Named_object*> Named_results;
989 typedef std::vector<std::pair<Named_object*,
990 source_location> > Closure_fields;
992 // The function's type.
993 Function_type* type_;
994 // The enclosing function. This is NULL when there isn't one, which
995 // is the normal case.
996 Function* enclosing_;
997 // The named result variables, if any.
998 Named_results* named_results_;
999 // If there is a closure, this is the list of variables which appear
1000 // in the closure. This is created by the parser, and then resolved
1001 // to a real type when we lower parse trees.
1002 Closure_fields closure_fields_;
1003 // The closure variable, passed as a parameter using the static
1004 // chain parameter. Normally NULL.
1005 Named_object* closure_var_;
1006 // The outer block of statements in the function.
1008 // The source location of the start of the function.
1009 source_location location_;
1010 // Labels defined or referenced in the function.
1012 // The function decl.
1014 // A variable holding the defer stack variable. This is NULL unless
1015 // we actually need a defer stack.
1017 // True if this function calls the predeclared recover function.
1018 bool calls_recover_;
1019 // True if this a thunk built for a function which calls recover.
1020 bool is_recover_thunk_;
1021 // True if this function already has a recover thunk.
1022 bool has_recover_thunk_;
1025 // A function declaration.
1027 class Function_declaration
1030 Function_declaration(Function_type* fntype, source_location location)
1031 : fntype_(fntype), location_(location), asm_name_(), fndecl_(NULL)
1036 { return this->fntype_; }
1040 { return this->location_; }
1044 { return this->asm_name_; }
1046 // Set the assembler name.
1048 set_asm_name(const std::string& asm_name)
1049 { this->asm_name_ = asm_name; }
1051 // Return a decl for the function given an identifier.
1053 get_or_make_decl(Gogo*, Named_object*, tree id);
1055 // Export a function declaration.
1057 export_func(Export* exp, const std::string& name) const
1058 { Function::export_func_with_type(exp, name, this->fntype_); }
1061 // The type of the function.
1062 Function_type* fntype_;
1063 // The location of the declaration.
1064 source_location location_;
1065 // The assembler name: this is the name to use in references to the
1066 // function. This is normally empty.
1067 std::string asm_name_;
1068 // The function decl if needed.
1077 Variable(Type*, Expression*, bool is_global, bool is_parameter,
1078 bool is_receiver, source_location);
1080 // Get the type of the variable.
1087 // Return whether the type is defined yet.
1090 { return this->type_ != NULL; }
1092 // Get the initial value.
1095 { return this->init_; }
1097 // Return whether there are any preinit statements.
1099 has_pre_init() const
1100 { return this->preinit_ != NULL; }
1102 // Return the preinit statements if any.
1105 { return this->preinit_; }
1107 // Return whether this is a global variable.
1110 { return this->is_global_; }
1112 // Return whether this is a function parameter.
1114 is_parameter() const
1115 { return this->is_parameter_; }
1117 // Return whether this is the receiver parameter of a method.
1120 { return this->is_receiver_; }
1122 // Change this parameter to be a receiver. This is used when
1123 // creating the thunks created for functions which call recover.
1127 gcc_assert(this->is_parameter_);
1128 this->is_receiver_ = true;
1131 // Change this parameter to not be a receiver. This is used when
1132 // creating the thunks created for functions which call recover.
1134 set_is_not_receiver()
1136 gcc_assert(this->is_parameter_);
1137 this->is_receiver_ = false;
1140 // Return whether this is the varargs parameter of a function.
1142 is_varargs_parameter() const
1143 { return this->is_varargs_parameter_; }
1145 // Whether this variable's address is taken.
1147 is_address_taken() const
1148 { return this->is_address_taken_; }
1150 // Whether this variable should live in the heap.
1153 { return this->is_address_taken_ && !this->is_global_; }
1155 // Get the source location of the variable's declaration.
1158 { return this->location_; }
1160 // Record that this is the varargs parameter of a function.
1162 set_is_varargs_parameter()
1164 gcc_assert(this->is_parameter_);
1165 this->is_varargs_parameter_ = true;
1168 // Clear the initial value; used for error handling.
1171 { this->init_ = NULL; }
1173 // Set the initial value; used for converting shortcuts.
1175 set_init(Expression* init)
1176 { this->init_ = init; }
1178 // Get the preinit block, a block of statements to be run before the
1179 // initialization expression.
1181 preinit_block(Gogo*);
1183 // Add a statement to be run before the initialization expression.
1184 // This is only used for global variables.
1186 add_preinit_statement(Gogo*, Statement*);
1188 // Lower the initialization expression after parsing is complete.
1190 lower_init_expression(Gogo*, Named_object*);
1192 // A special case: the init value is used only to determine the
1193 // type. This is used if the variable is defined using := with the
1194 // comma-ok form of a map index or a receive expression. The init
1195 // value is actually the map index expression or receive expression.
1196 // We use this because we may not know the right type at parse time.
1198 set_type_from_init_tuple()
1199 { this->type_from_init_tuple_ = true; }
1201 // Another special case: the init value is used only to determine
1202 // the type. This is used if the variable is defined using := with
1203 // a range clause. The init value is the range expression. The
1204 // type of the variable is the index type of the range expression
1205 // (i.e., the first value returned by a range).
1207 set_type_from_range_index()
1208 { this->type_from_range_index_ = true; }
1210 // Another special case: like set_type_from_range_index, but the
1211 // type is the value type of the range expression (i.e., the second
1212 // value returned by a range).
1214 set_type_from_range_value()
1215 { this->type_from_range_value_ = true; }
1217 // Another special case: the init value is used only to determine
1218 // the type. This is used if the variable is defined using := with
1219 // a case in a select statement. The init value is the channel.
1220 // The type of the variable is the channel's element type.
1222 set_type_from_chan_element()
1223 { this->type_from_chan_element_ = true; }
1225 // After we lower the select statement, we once again set the type
1226 // from the initialization expression.
1228 clear_type_from_chan_element()
1230 gcc_assert(this->type_from_chan_element_);
1231 this->type_from_chan_element_ = false;
1234 // Note that this variable was created for a type switch clause.
1236 set_is_type_switch_var()
1237 { this->is_type_switch_var_ = true; }
1239 // Traverse the initializer expression.
1241 traverse_expression(Traverse*);
1243 // Determine the type of the variable if necessary.
1247 // Note that something takes the address of this variable.
1250 { this->is_address_taken_ = true; }
1252 // Get the initial value of the variable as a tree. This may only
1253 // be called if has_pre_init() returns false.
1255 get_init_tree(Gogo*, Named_object* function);
1257 // Return a series of statements which sets the value of the
1258 // variable in DECL. This should only be called is has_pre_init()
1259 // returns true. DECL may be NULL for a sink variable.
1261 get_init_block(Gogo*, Named_object* function, tree decl);
1263 // Export the variable.
1265 export_var(Export*, const std::string& name) const;
1267 // Import a variable.
1269 import_var(Import*, std::string* pname, Type** ptype);
1272 // The type of a tuple.
1274 type_from_tuple(Expression*, bool) const;
1276 // The type of a range.
1278 type_from_range(Expression*, bool, bool) const;
1280 // The element type of a channel.
1282 type_from_chan_element(Expression*, bool) const;
1284 // The variable's type. This may be NULL if the type is set from
1287 // The initial value. This may be NULL if the variable should be
1288 // initialized to the default value for the type.
1290 // Statements to run before the init statement.
1292 // Location of variable definition.
1293 source_location location_;
1294 // Whether this is a global variable.
1295 bool is_global_ : 1;
1296 // Whether this is a function parameter.
1297 bool is_parameter_ : 1;
1298 // Whether this is the receiver parameter of a method.
1299 bool is_receiver_ : 1;
1300 // Whether this is the varargs parameter of a function.
1301 bool is_varargs_parameter_ : 1;
1302 // Whether something takes the address of this variable.
1303 bool is_address_taken_ : 1;
1304 // True if we have seen this variable in a traversal.
1306 // True if we have lowered the initialization expression.
1307 bool init_is_lowered_ : 1;
1308 // True if init is a tuple used to set the type.
1309 bool type_from_init_tuple_ : 1;
1310 // True if init is a range clause and the type is the index type.
1311 bool type_from_range_index_ : 1;
1312 // True if init is a range clause and the type is the value type.
1313 bool type_from_range_value_ : 1;
1314 // True if init is a channel and the type is the channel's element type.
1315 bool type_from_chan_element_ : 1;
1316 // True if this is a variable created for a type switch case.
1317 bool is_type_switch_var_ : 1;
1318 // True if we have determined types.
1319 bool determined_type_ : 1;
1322 // A variable which is really the name for a function return value, or
1325 class Result_variable
1328 Result_variable(Type* type, Function* function, int index)
1329 : type_(type), function_(function), index_(index),
1330 is_address_taken_(false)
1333 // Get the type of the result variable.
1336 { return this->type_; }
1338 // Get the function that this is associated with.
1341 { return this->function_; }
1343 // Index in the list of function results.
1346 { return this->index_; }
1348 // Whether this variable's address is taken.
1350 is_address_taken() const
1351 { return this->is_address_taken_; }
1353 // Note that something takes the address of this variable.
1356 { this->is_address_taken_ = true; }
1358 // Whether this variable should live in the heap.
1361 { return this->is_address_taken_; }
1363 // Set the function. This is used when cloning functions which call
1366 set_function(Function* function)
1367 { this->function_ = function; }
1370 // Type of result variable.
1372 // Function with which this is associated.
1373 Function* function_;
1374 // Index in list of results.
1376 // Whether something takes the address of this variable.
1377 bool is_address_taken_;
1380 // The value we keep for a named constant. This lets us hold a type
1381 // and an expression.
1383 class Named_constant
1386 Named_constant(Type* type, Expression* expr, int iota_value,
1387 source_location location)
1388 : type_(type), expr_(expr), iota_value_(iota_value), location_(location),
1394 { return this->type_; }
1398 { return this->expr_; }
1402 { return this->iota_value_; }
1406 { return this->location_; }
1408 // Whether we are lowering.
1411 { return this->lowering_; }
1413 // Set that we are lowering.
1416 { this->lowering_ = true; }
1418 // We are no longer lowering.
1421 { this->lowering_ = false; }
1423 // Traverse the expression.
1425 traverse_expression(Traverse*);
1427 // Determine the type of the constant if necessary.
1431 // Indicate that we found and reported an error for this constant.
1435 // Export the constant.
1437 export_const(Export*, const std::string& name) const;
1439 // Import a constant.
1441 import_const(Import*, std::string*, Type**, Expression**);
1444 // The type of the constant.
1446 // The expression for the constant.
1448 // If the predeclared constant iota is used in EXPR_, this is the
1449 // value it will have. We do this because at parse time we don't
1450 // know whether the name "iota" will refer to the predeclared
1451 // constant or to something else. We put in the right value in when
1454 // The location of the definition.
1455 source_location location_;
1456 // Whether we are currently lowering this constant.
1460 // A type declaration.
1462 class Type_declaration
1465 Type_declaration(source_location location)
1466 : location_(location), in_function_(NULL), methods_(),
1467 issued_warning_(false)
1470 // Return the location.
1473 { return this->location_; }
1475 // Return the function in which this type is declared. This will
1476 // return NULL for a type declared in global scope.
1479 { return this->in_function_; }
1481 // Set the function in which this type is declared.
1483 set_in_function(Named_object* f)
1484 { this->in_function_ = f; }
1486 // Add a method to this type. This is used when methods are defined
1489 add_method(const std::string& name, Function* function);
1491 // Add a method declaration to this type.
1493 add_method_declaration(const std::string& name, Function_type* type,
1494 source_location location);
1496 // Return whether any methods were defined.
1498 has_methods() const;
1500 // Define methods when the real type is known.
1502 define_methods(Named_type*);
1504 // This is called if we are trying to use this type. It returns
1505 // true if we should issue a warning.
1510 typedef std::vector<Named_object*> Methods;
1512 // The location of the type declaration.
1513 source_location location_;
1514 // If this type is declared in a function, a pointer back to the
1515 // function in which it is defined.
1516 Named_object* in_function_;
1517 // Methods defined before the type is defined.
1519 // True if we have issued a warning about a use of this type
1520 // declaration when it is undefined.
1521 bool issued_warning_;
1524 // An unknown object. These are created by the parser for forward
1525 // references to names which have not been seen before. In a correct
1526 // program, these will always point to a real definition by the end of
1527 // the parse. Because they point to another Named_object, these may
1528 // only be referenced by Unknown_expression objects.
1533 Unknown_name(source_location location)
1534 : location_(location), real_named_object_(NULL)
1537 // Return the location where this name was first seen.
1540 { return this->location_; }
1542 // Return the real named object that this points to, or NULL if it
1543 // was never resolved.
1545 real_named_object() const
1546 { return this->real_named_object_; }
1548 // Set the real named object that this points to.
1550 set_real_named_object(Named_object* no);
1553 // The location where this name was first seen.
1554 source_location location_;
1555 // The real named object when it is known.
1560 // A named object named. This is the result of a declaration. We
1561 // don't use a superclass because they all have to be handled
1569 // An uninitialized Named_object. We should never see this.
1570 NAMED_OBJECT_UNINITIALIZED,
1571 // An unknown name. This is used for forward references. In a
1572 // correct program, these will all be resolved by the end of the
1574 NAMED_OBJECT_UNKNOWN,
1579 // A forward type declaration.
1580 NAMED_OBJECT_TYPE_DECLARATION,
1583 // A result variable in a function.
1584 NAMED_OBJECT_RESULT_VAR,
1585 // The blank identifier--the special variable named _.
1589 // A forward func declaration.
1590 NAMED_OBJECT_FUNC_DECLARATION,
1592 NAMED_OBJECT_PACKAGE
1595 // Return the classification.
1597 classification() const
1598 { return this->classification_; }
1604 { return this->classification_ == NAMED_OBJECT_UNKNOWN; }
1608 { return this->classification_ == NAMED_OBJECT_CONST; }
1612 { return this->classification_ == NAMED_OBJECT_TYPE; }
1615 is_type_declaration() const
1616 { return this->classification_ == NAMED_OBJECT_TYPE_DECLARATION; }
1620 { return this->classification_ == NAMED_OBJECT_VAR; }
1623 is_result_variable() const
1624 { return this->classification_ == NAMED_OBJECT_RESULT_VAR; }
1628 { return this->classification_ == NAMED_OBJECT_SINK; }
1632 { return this->classification_ == NAMED_OBJECT_FUNC; }
1635 is_function_declaration() const
1636 { return this->classification_ == NAMED_OBJECT_FUNC_DECLARATION; }
1640 { return this->classification_ == NAMED_OBJECT_PACKAGE; }
1644 static Named_object*
1645 make_unknown_name(const std::string& name, source_location);
1647 static Named_object*
1648 make_constant(const Typed_identifier&, const Package*, Expression*,
1651 static Named_object*
1652 make_type(const std::string&, const Package*, Type*, source_location);
1654 static Named_object*
1655 make_type_declaration(const std::string&, const Package*, source_location);
1657 static Named_object*
1658 make_variable(const std::string&, const Package*, Variable*);
1660 static Named_object*
1661 make_result_variable(const std::string&, Result_variable*);
1663 static Named_object*
1666 static Named_object*
1667 make_function(const std::string&, const Package*, Function*);
1669 static Named_object*
1670 make_function_declaration(const std::string&, const Package*, Function_type*,
1673 static Named_object*
1674 make_package(const std::string& alias, Package* package);
1681 gcc_assert(this->classification_ == NAMED_OBJECT_UNKNOWN);
1682 return this->u_.unknown_value;
1686 unknown_value() const
1688 gcc_assert(this->classification_ == NAMED_OBJECT_UNKNOWN);
1689 return this->u_.unknown_value;
1695 gcc_assert(this->classification_ == NAMED_OBJECT_CONST);
1696 return this->u_.const_value;
1699 const Named_constant*
1702 gcc_assert(this->classification_ == NAMED_OBJECT_CONST);
1703 return this->u_.const_value;
1709 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE);
1710 return this->u_.type_value;
1716 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE);
1717 return this->u_.type_value;
1721 type_declaration_value()
1723 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE_DECLARATION);
1724 return this->u_.type_declaration;
1727 const Type_declaration*
1728 type_declaration_value() const
1730 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE_DECLARATION);
1731 return this->u_.type_declaration;
1737 gcc_assert(this->classification_ == NAMED_OBJECT_VAR);
1738 return this->u_.var_value;
1744 gcc_assert(this->classification_ == NAMED_OBJECT_VAR);
1745 return this->u_.var_value;
1751 gcc_assert(this->classification_ == NAMED_OBJECT_RESULT_VAR);
1752 return this->u_.result_var_value;
1755 const Result_variable*
1756 result_var_value() const
1758 gcc_assert(this->classification_ == NAMED_OBJECT_RESULT_VAR);
1759 return this->u_.result_var_value;
1765 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC);
1766 return this->u_.func_value;
1772 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC);
1773 return this->u_.func_value;
1776 Function_declaration*
1777 func_declaration_value()
1779 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC_DECLARATION);
1780 return this->u_.func_declaration_value;
1783 const Function_declaration*
1784 func_declaration_value() const
1786 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC_DECLARATION);
1787 return this->u_.func_declaration_value;
1793 gcc_assert(this->classification_ == NAMED_OBJECT_PACKAGE);
1794 return this->u_.package_value;
1798 package_value() const
1800 gcc_assert(this->classification_ == NAMED_OBJECT_PACKAGE);
1801 return this->u_.package_value;
1806 { return this->name_; }
1808 // Return the name to use in an error message. The difference is
1809 // that if this Named_object is defined in a different package, this
1810 // will return PACKAGE.NAME.
1812 message_name() const;
1816 { return this->package_; }
1818 // Resolve an unknown value if possible. This returns the same
1819 // Named_object or a new one.
1823 Named_object* ret = this;
1824 if (this->is_unknown())
1826 Named_object* r = this->unknown_value()->real_named_object();
1836 const Named_object* ret = this;
1837 if (this->is_unknown())
1839 const Named_object* r = this->unknown_value()->real_named_object();
1846 // The location where this object was defined or referenced.
1850 // Return a tree for the external identifier for this object.
1854 // Return a tree representing this object.
1856 get_tree(Gogo*, Named_object* function);
1858 // Define a type declaration.
1860 set_type_value(Named_type*);
1862 // Define a function declaration.
1864 set_function_value(Function*);
1866 // Declare an unknown name as a type declaration.
1870 // Export this object.
1872 export_named_object(Export*) const;
1875 Named_object(const std::string&, const Package*, Classification);
1877 // The name of the object.
1879 // The package that this object is in. This is NULL if it is in the
1880 // file we are compiling.
1881 const Package* package_;
1882 // The type of object this is.
1883 Classification classification_;
1887 Unknown_name* unknown_value;
1888 Named_constant* const_value;
1889 Named_type* type_value;
1890 Type_declaration* type_declaration;
1891 Variable* var_value;
1892 Result_variable* result_var_value;
1893 Function* func_value;
1894 Function_declaration* func_declaration_value;
1895 Package* package_value;
1897 // The DECL tree for this object if we have already converted it.
1901 // A binding contour. This binds names to objects.
1906 // Type for mapping from names to objects.
1907 typedef Unordered_map(std::string, Named_object*) Contour;
1909 Bindings(Bindings* enclosing);
1911 // Add an unknown name.
1913 add_unknown_name(const std::string& name, source_location location)
1915 return this->add_named_object(Named_object::make_unknown_name(name,
1921 add_constant(const Typed_identifier& tid, const Package* package,
1922 Expression* expr, int iota_value)
1924 return this->add_named_object(Named_object::make_constant(tid, package,
1931 add_type(const std::string& name, const Package* package, Type* type,
1932 source_location location)
1934 return this->add_named_object(Named_object::make_type(name, package, type,
1938 // Add a named type. This is used for builtin types, and to add an
1939 // imported type to the global scope.
1941 add_named_type(Named_type* named_type);
1943 // Add a type declaration.
1945 add_type_declaration(const std::string& name, const Package* package,
1946 source_location location)
1948 Named_object* no = Named_object::make_type_declaration(name, package,
1950 return this->add_named_object(no);
1955 add_variable(const std::string& name, const Package* package,
1958 return this->add_named_object(Named_object::make_variable(name, package,
1962 // Add a result variable.
1964 add_result_variable(const std::string& name, Result_variable* result)
1966 return this->add_named_object(Named_object::make_result_variable(name,
1972 add_function(const std::string& name, const Package*, Function* function);
1974 // Add a function declaration.
1976 add_function_declaration(const std::string& name, const Package* package,
1977 Function_type* type, source_location location);
1979 // Add a package. The location is the location of the import
1982 add_package(const std::string& alias, Package* package)
1984 Named_object* no = Named_object::make_package(alias, package);
1985 return this->add_named_object(no);
1988 // Define a type which was already declared.
1990 define_type(Named_object*, Named_type*);
1992 // Add a method to the list of objects. This is not added to the
1995 add_method(Named_object*);
1997 // Add a named object to this binding.
1999 add_named_object(Named_object* no)
2000 { return this->add_named_object_to_contour(&this->bindings_, no); }
2002 // Clear all names in file scope from the bindings.
2006 // Look up a name in this binding contour and in any enclosing
2007 // binding contours. This returns NULL if the name is not found.
2009 lookup(const std::string&) const;
2011 // Look up a name in this binding contour without looking in any
2012 // enclosing binding contours. Returns NULL if the name is not found.
2014 lookup_local(const std::string&) const;
2018 remove_binding(Named_object*);
2020 // Traverse the tree. See the Traverse class.
2022 traverse(Traverse*, bool is_global);
2024 // Iterate over definitions. This does not include things which
2025 // were only declared.
2027 typedef std::vector<Named_object*>::const_iterator
2028 const_definitions_iterator;
2030 const_definitions_iterator
2031 begin_definitions() const
2032 { return this->named_objects_.begin(); }
2034 const_definitions_iterator
2035 end_definitions() const
2036 { return this->named_objects_.end(); }
2038 // Return the number of definitions.
2040 size_definitions() const
2041 { return this->named_objects_.size(); }
2043 // Return whether there are no definitions.
2045 empty_definitions() const
2046 { return this->named_objects_.empty(); }
2048 // Iterate over declarations. This is everything that has been
2049 // declared, which includes everything which has been defined.
2051 typedef Contour::const_iterator const_declarations_iterator;
2053 const_declarations_iterator
2054 begin_declarations() const
2055 { return this->bindings_.begin(); }
2057 const_declarations_iterator
2058 end_declarations() const
2059 { return this->bindings_.end(); }
2061 // Return the number of declarations.
2063 size_declarations() const
2064 { return this->bindings_.size(); }
2066 // Return whether there are no declarations.
2068 empty_declarations() const
2069 { return this->bindings_.empty(); }
2071 // Return the first declaration.
2074 { return this->bindings_.empty() ? NULL : this->bindings_.begin()->second; }
2078 add_named_object_to_contour(Contour*, Named_object*);
2081 new_definition(Named_object*, Named_object*);
2083 // Enclosing bindings.
2084 Bindings* enclosing_;
2085 // The list of objects.
2086 std::vector<Named_object*> named_objects_;
2087 // The mapping from names to objects.
2096 Label(const std::string& name)
2097 : name_(name), location_(0), is_used_(false), decl_(NULL)
2100 // Return the label's name.
2103 { return this->name_; }
2105 // Return whether the label has been defined.
2108 { return this->location_ != 0; }
2110 // Return whether the label has been used.
2113 { return this->is_used_; }
2115 // Record that the label is used.
2118 { this->is_used_ = true; }
2120 // Return the location of the definition.
2123 { return this->location_; }
2125 // Define the label at LOCATION.
2127 define(source_location location)
2129 gcc_assert(this->location_ == 0);
2130 this->location_ = location;
2133 // Return the LABEL_DECL for this decl.
2137 // Return an expression for the address of this label.
2139 get_addr(source_location location);
2142 // The name of the label.
2144 // The location of the definition. This is 0 if the label has not
2145 // yet been defined.
2146 source_location location_;
2147 // Whether the label has been used.
2153 // An unnamed label. These are used when lowering loops.
2158 Unnamed_label(source_location location)
2159 : location_(location), decl_(NULL)
2162 // Get the location where the label is defined.
2165 { return this->location_; }
2167 // Set the location where the label is defined.
2169 set_location(source_location location)
2170 { this->location_ = location; }
2172 // Return a statement which defines this label.
2176 // Return a goto to this label from LOCATION.
2178 get_goto(source_location location);
2181 // Return the LABEL_DECL to use with GOTO_EXPR.
2185 // The location where the label is defined.
2186 source_location location_;
2191 // An imported package.
2196 Package(const std::string& name, const std::string& unique_prefix,
2197 source_location location);
2199 // The real name of this package. This may be different from the
2200 // name in the associated Named_object if the import statement used
2204 { return this->name_; }
2206 // Return the location of the import statement.
2209 { return this->location_; }
2211 // Get the unique prefix used for all symbols exported from this
2214 unique_prefix() const
2216 gcc_assert(!this->unique_prefix_.empty());
2217 return this->unique_prefix_;
2220 // The priority of this package. The init function of packages with
2221 // lower priority must be run before the init function of packages
2222 // with higher priority.
2225 { return this->priority_; }
2227 // Set the priority.
2229 set_priority(int priority);
2231 // Return the bindings.
2234 { return this->bindings_; }
2236 // Whether some symbol from the package was used.
2239 { return this->used_; }
2241 // Note that some symbol from this package was used.
2244 { this->used_ = true; }
2246 // Clear the used field for the next file.
2249 { this->used_ = false; }
2251 // Whether this package was imported in the current file.
2254 { return this->is_imported_; }
2256 // Note that this package was imported in the current file.
2259 { this->is_imported_ = true; }
2261 // Clear the imported field for the next file.
2264 { this->is_imported_ = false; }
2266 // Whether this package was imported with a name of "_".
2268 uses_sink_alias() const
2269 { return this->uses_sink_alias_; }
2271 // Note that this package was imported with a name of "_".
2273 set_uses_sink_alias()
2274 { this->uses_sink_alias_ = true; }
2276 // Clear the sink alias field for the next file.
2278 clear_uses_sink_alias()
2279 { this->uses_sink_alias_ = false; }
2281 // Look up a name in the package. Returns NULL if the name is not
2284 lookup(const std::string& name) const
2285 { return this->bindings_->lookup(name); }
2287 // Set the location of the package. This is used if it is seen in a
2288 // different import before it is really imported.
2290 set_location(source_location location)
2291 { this->location_ = location; }
2293 // Add a constant to the package.
2295 add_constant(const Typed_identifier& tid, Expression* expr)
2296 { return this->bindings_->add_constant(tid, this, expr, 0); }
2298 // Add a type to the package.
2300 add_type(const std::string& name, Type* type, source_location location)
2301 { return this->bindings_->add_type(name, this, type, location); }
2303 // Add a type declaration to the package.
2305 add_type_declaration(const std::string& name, source_location location)
2306 { return this->bindings_->add_type_declaration(name, this, location); }
2308 // Add a variable to the package.
2310 add_variable(const std::string& name, Variable* variable)
2311 { return this->bindings_->add_variable(name, this, variable); }
2313 // Add a function declaration to the package.
2315 add_function_declaration(const std::string& name, Function_type* type,
2316 source_location loc)
2317 { return this->bindings_->add_function_declaration(name, this, type, loc); }
2319 // Determine types of constants.
2324 // The real name of this package.
2326 // The unique prefix for all exported global symbols.
2327 std::string unique_prefix_;
2328 // The names in this package.
2329 Bindings* bindings_;
2330 // The priority of this package. A package has a priority higher
2331 // than the priority of all of the packages that it imports. This
2332 // is used to run init functions in the right order.
2334 // The location of the import statement.
2335 source_location location_;
2336 // True if some name from this package was used. This is mutable
2337 // because we can use a package even if we have a const pointer to
2340 // True if this package was imported in the current file.
2342 // True if this package was imported with a name of "_".
2343 bool uses_sink_alias_;
2346 // Return codes for the traversal functions. This is not an enum
2347 // because we want to be able to declare traversal functions in other
2348 // header files without including this one.
2350 // Continue traversal as usual.
2351 const int TRAVERSE_CONTINUE = -1;
2354 const int TRAVERSE_EXIT = 0;
2356 // Continue traversal, but skip components of the current object.
2357 // E.g., if this is returned by Traverse::statement, we do not
2358 // traverse the expressions in the statement even if
2359 // traverse_expressions is set in the traverse_mask.
2360 const int TRAVERSE_SKIP_COMPONENTS = 1;
2362 // This class is used when traversing the parse tree. The caller uses
2363 // a subclass which overrides functions as desired.
2368 // These bitmasks say what to traverse.
2369 static const unsigned int traverse_variables = 0x1;
2370 static const unsigned int traverse_constants = 0x2;
2371 static const unsigned int traverse_functions = 0x4;
2372 static const unsigned int traverse_blocks = 0x8;
2373 static const unsigned int traverse_statements = 0x10;
2374 static const unsigned int traverse_expressions = 0x20;
2375 static const unsigned int traverse_types = 0x40;
2377 Traverse(unsigned int traverse_mask)
2378 : traverse_mask_(traverse_mask), types_seen_(NULL), expressions_seen_(NULL)
2381 virtual ~Traverse();
2383 // The bitmask of what to traverse.
2385 traverse_mask() const
2386 { return this->traverse_mask_; }
2388 // Record that we are going to traverse a type. This returns true
2389 // if the type has already been seen in this traversal. This is
2390 // required because types, unlike expressions, can form a circular
2393 remember_type(const Type*);
2395 // Record that we are going to see an expression. This returns true
2396 // if the expression has already been seen in this traversal. This
2397 // is only needed for cases where multiple expressions can point to
2400 remember_expression(const Expression*);
2402 // These functions return one of the TRAVERSE codes defined above.
2404 // If traverse_variables is set in the mask, this is called for
2405 // every variable in the tree.
2407 variable(Named_object*);
2409 // If traverse_constants is set in the mask, this is called for
2410 // every named constant in the tree. The bool parameter is true for
2411 // a global constant.
2413 constant(Named_object*, bool);
2415 // If traverse_functions is set in the mask, this is called for
2416 // every function in the tree.
2418 function(Named_object*);
2420 // If traverse_blocks is set in the mask, this is called for every
2421 // block in the tree.
2425 // If traverse_statements is set in the mask, this is called for
2426 // every statement in the tree.
2428 statement(Block*, size_t* index, Statement*);
2430 // If traverse_expressions is set in the mask, this is called for
2431 // every expression in the tree.
2433 expression(Expression**);
2435 // If traverse_types is set in the mask, this is called for every
2436 // type in the tree.
2441 typedef Unordered_set_hash(const Type*, Type_hash_identical,
2442 Type_identical) Types_seen;
2444 typedef Unordered_set(const Expression*) Expressions_seen;
2446 // Bitmask of what sort of objects to traverse.
2447 unsigned int traverse_mask_;
2448 // Types which have been seen in this traversal.
2449 Types_seen* types_seen_;
2450 // Expressions which have been seen in this traversal.
2451 Expressions_seen* expressions_seen_;
2454 // When translating the gogo IR into trees, this is the context we
2455 // pass down the blocks and statements.
2457 class Translate_context
2460 Translate_context(Gogo* gogo, Named_object* function, Block* block,
2462 : gogo_(gogo), function_(function), block_(block), block_tree_(block_tree),
2470 { return this->gogo_; }
2474 { return this->function_; }
2478 { return this->block_; }
2482 { return this->block_tree_; }
2486 { return this->is_const_; }
2488 // Make a constant context.
2491 { this->is_const_ = true; }
2494 // The IR for the entire compilation unit.
2496 // The function we are currently translating.
2497 Named_object* function_;
2498 // The block we are currently translating.
2500 // The BLOCK node for the current block.
2502 // Whether this is being evaluated in a constant context. This is
2503 // used for type descriptor initializers.
2507 // Runtime error codes. These must match the values in
2508 // libgo/runtime/go-runtime-error.c.
2510 // Slice index out of bounds: negative or larger than the length of
2512 static const int RUNTIME_ERROR_SLICE_INDEX_OUT_OF_BOUNDS = 0;
2514 // Array index out of bounds.
2515 static const int RUNTIME_ERROR_ARRAY_INDEX_OUT_OF_BOUNDS = 1;
2517 // String index out of bounds.
2518 static const int RUNTIME_ERROR_STRING_INDEX_OUT_OF_BOUNDS = 2;
2520 // Slice slice out of bounds: negative or larger than the length of
2521 // the slice or high bound less than low bound.
2522 static const int RUNTIME_ERROR_SLICE_SLICE_OUT_OF_BOUNDS = 3;
2524 // Array slice out of bounds.
2525 static const int RUNTIME_ERROR_ARRAY_SLICE_OUT_OF_BOUNDS = 4;
2527 // String slice out of bounds.
2528 static const int RUNTIME_ERROR_STRING_SLICE_OUT_OF_BOUNDS = 5;
2530 // Dereference of nil pointer. This is used when there is a
2531 // dereference of a pointer to a very large struct or array, to ensure
2532 // that a gigantic array is not used a proxy to access random memory
2534 static const int RUNTIME_ERROR_NIL_DEREFERENCE = 6;
2536 // Slice length or capacity out of bounds in make: negative or
2537 // overflow or length greater than capacity.
2538 static const int RUNTIME_ERROR_MAKE_SLICE_OUT_OF_BOUNDS = 7;
2540 // Map capacity out of bounds in make: negative or overflow.
2541 static const int RUNTIME_ERROR_MAKE_MAP_OUT_OF_BOUNDS = 8;
2543 // Channel capacity out of bounds in make: negative or overflow.
2544 static const int RUNTIME_ERROR_MAKE_CHAN_OUT_OF_BOUNDS = 9;
2546 // This is used by some of the langhooks.
2547 extern Gogo* go_get_gogo();
2549 // Whether we have seen any errors. FIXME: Replace with a backend
2551 extern bool saw_errors();
2553 #endif // !defined(GO_GOGO_H)