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 an expression.
353 lower_expression(Named_object* function, Expression**);
357 lower_constant(Named_object*);
359 // Finalize the method lists and build stub methods for named types.
363 // Work out the types to use for unspecified variables and
368 // Type check the program.
372 // Check the types in a single block. This is used for complicated
375 check_types_in_block(Block*);
377 // Check for return statements.
379 check_return_statements();
385 // Add an import control function for an imported package to the
388 add_import_init_fn(const std::string& package_name,
389 const std::string& init_name, int prio);
391 // Turn short-cut operators (&&, ||) into explicit if statements.
395 // Use temporary variables to force order of evaluation.
399 // Build thunks for functions which call recover.
401 build_recover_thunks();
403 // Simplify statements which might use thunks: go and defer
406 simplify_thunk_statements();
408 // Convert named types to the backend representation.
410 convert_named_types();
412 // Convert named types in a list of bindings.
414 convert_named_types_in_bindings(Bindings*);
416 // True if named types have been converted to the backend
419 named_types_are_converted() const
420 { return this->named_types_are_converted_; }
422 // Write out the global values.
426 // Build a call to a builtin function. PDECL should point to a NULL
427 // initialized static pointer which will hold the fndecl. NAME is
428 // the name of the function. NARGS is the number of arguments.
429 // RETTYPE is the return type. It is followed by NARGS pairs of
430 // type and argument (both trees).
432 call_builtin(tree* pdecl, source_location, const char* name, int nargs,
435 // Build a call to the runtime error function.
437 runtime_error(int code, source_location);
439 // Build a builtin struct with a list of fields.
441 builtin_struct(tree* ptype, const char* struct_name, tree struct_type,
444 // Mark a function declaration as a builtin library function.
446 mark_fndecl_as_builtin_library(tree fndecl);
448 // Build the type of the struct that holds a slice for the given
451 slice_type_tree(tree element_type_tree);
453 // Given a tree for a slice type, return the tree for the element
456 slice_element_type_tree(tree slice_type_tree);
458 // Build a constructor for a slice. SLICE_TYPE_TREE is the type of
459 // the slice. VALUES points to the values. COUNT is the size,
460 // CAPACITY is the capacity. If CAPACITY is NULL, it is set to
463 slice_constructor(tree slice_type_tree, tree values, tree count,
466 // Build a constructor for an empty slice. SLICE_TYPE_TREE is the
467 // type of the slice.
469 empty_slice_constructor(tree slice_type_tree);
471 // Build a map descriptor.
473 map_descriptor(Map_type*);
475 // Return a tree for the type of a map descriptor. This is struct
476 // __go_map_descriptor in libgo/runtime/map.h. This is the same for
479 map_descriptor_type();
481 // Build a type descriptor for TYPE using INITIALIZER as the type
482 // descriptor. This builds a new decl stored in *PDECL.
484 build_type_descriptor_decl(const Type*, Expression* initializer,
487 // Build required interface method tables.
489 build_interface_method_tables();
491 // Build an interface method table for a type: a list of function
492 // pointers, one for each interface method. This returns a decl.
494 interface_method_table_for_type(const Interface_type*, Named_type*,
497 // Return a tree which allocate SIZE bytes to hold values of type
500 allocate_memory(Type *type, tree size, source_location);
502 // Return a type to use for pointer to const char.
504 const_char_pointer_type_tree();
506 // Build a string constant with the right type.
508 string_constant_tree(const std::string&);
510 // Build a Go string constant. This returns a pointer to the
513 go_string_constant_tree(const std::string&);
515 // Send a value on a channel.
517 send_on_channel(tree channel, tree val, bool blocking, bool for_select,
520 // Receive a value from a channel.
522 receive_from_channel(tree type_tree, tree channel, bool for_select,
525 // Return a tree for receiving an integer on a channel.
527 receive_as_64bit_integer(tree type, tree channel, bool blocking,
531 // Make a trampoline which calls FNADDR passing CLOSURE.
533 make_trampoline(tree fnaddr, tree closure, source_location);
536 // During parsing, we keep a stack of functions. Each function on
537 // the stack is one that we are currently parsing. For each
538 // function, we keep track of the current stack of blocks.
542 Named_object* function;
543 // The stack of active blocks in the function.
544 std::vector<Block*> blocks;
547 // The stack of functions.
548 typedef std::vector<Open_function> Open_functions;
550 // Create trees for implicit builtin functions.
552 define_builtin_function_trees();
554 // Set up the built-in unsafe package.
556 import_unsafe(const std::string&, bool is_exported, source_location);
558 // Add a new imported package.
560 add_package(const std::string& real_name, const std::string& alias,
561 const std::string& unique_prefix, source_location location);
563 // Return the current binding contour.
568 current_bindings() const;
570 // Return the current block.
574 // Get the name of the magic initialization function.
578 // Get the decl for the magic initialization function.
580 initialization_function_decl();
582 // Write the magic initialization function.
584 write_initialization_function(tree fndecl, tree init_stmt_list);
586 // Initialize imported packages.
590 // Register variables with the garbage collector.
592 register_gc_vars(const std::vector<Named_object*>&, tree*);
594 // Build a pointer to a Go string constant. This returns a pointer
597 ptr_go_string_constant_tree(const std::string&);
599 // Return the name to use for a type descriptor decl for an unnamed
602 unnamed_type_descriptor_decl_name(const Type* type);
604 // Return the name to use for a type descriptor decl for a type
605 // named NO, defined in IN_FUNCTION.
607 type_descriptor_decl_name(const Named_object* no,
608 const Named_object* in_function);
610 // Where a type descriptor should be defined.
611 enum Type_descriptor_location
613 // Defined in this file.
614 TYPE_DESCRIPTOR_DEFINED,
615 // Defined in some other file.
616 TYPE_DESCRIPTOR_UNDEFINED,
617 // Common definition which may occur in multiple files.
618 TYPE_DESCRIPTOR_COMMON
621 // Return where the decl for TYPE should be defined.
622 Type_descriptor_location
623 type_descriptor_location(const Type* type);
625 // Return the type of a trampoline.
627 trampoline_type_tree();
629 // Type used to map import names to packages.
630 typedef std::map<std::string, Package*> Imports;
632 // Type used to map package names to packages.
633 typedef std::map<std::string, Package*> Packages;
635 // Type used to map special names in the sys package.
636 typedef std::map<std::string, std::string> Sys_names;
638 // Hash table mapping map types to map descriptor decls.
639 typedef Unordered_map_hash(const Map_type*, tree, Type_hash_identical,
640 Type_identical) Map_descriptors;
642 // Map unnamed types to type descriptor decls.
643 typedef Unordered_map_hash(const Type*, tree, Type_hash_identical,
644 Type_identical) Type_descriptor_decls;
646 // The package we are compiling.
648 // The list of currently open functions during parsing.
649 Open_functions functions_;
650 // The global binding contour. This includes the builtin functions
651 // and the package we are compiling.
653 // Mapping from import file names to packages.
655 // Whether the magic unsafe package was imported.
656 bool imported_unsafe_;
657 // Mapping from package names we have seen to packages. This does
658 // not include the package we are compiling.
660 // Mapping from map types to map descriptors.
661 Map_descriptors* map_descriptors_;
662 // Mapping from unnamed types to type descriptor decls.
663 Type_descriptor_decls* type_descriptor_decls_;
664 // The functions named "init", if there are any.
665 std::vector<Named_object*> init_functions_;
666 // Whether we need a magic initialization function.
668 // The name of the magic initialization function.
669 std::string init_fn_name_;
670 // A list of import control variables for packages that we import.
671 std::set<Import_init> imported_init_fns_;
672 // The unique prefix used for all global symbols.
673 std::string unique_prefix_;
674 // Whether an explicit unique prefix was set by -fgo-prefix.
675 bool unique_prefix_specified_;
676 // A list of interface types defined while parsing.
677 std::vector<Interface_type*> interface_types_;
678 // Whether named types have been converted.
679 bool named_types_are_converted_;
682 // A block of statements.
687 Block(Block* enclosing, source_location);
689 // Return the enclosing block.
692 { return this->enclosing_; }
694 // Return the bindings of the block.
697 { return this->bindings_; }
701 { return this->bindings_; }
703 // Look at the block's statements.
704 const std::vector<Statement*>*
706 { return &this->statements_; }
708 // Return the start location. This is normally the location of the
709 // left curly brace which starts the block.
711 start_location() const
712 { return this->start_location_; }
714 // Return the end location. This is normally the location of the
715 // right curly brace which ends the block.
718 { return this->end_location_; }
720 // Add a statement to the block.
722 add_statement(Statement*);
724 // Add a statement to the front of the block.
726 add_statement_at_front(Statement*);
728 // Replace a statement in a block.
730 replace_statement(size_t index, Statement*);
732 // Add a Statement before statement number INDEX.
734 insert_statement_before(size_t index, Statement*);
736 // Add a Statement after statement number INDEX.
738 insert_statement_after(size_t index, Statement*);
740 // Set the end location of the block.
742 set_end_location(source_location location)
743 { this->end_location_ = location; }
745 // Traverse the tree.
749 // Set final types for unspecified variables and constants.
753 // Return true if execution of this block may fall through to the
756 may_fall_through() const;
758 // Return a tree of the code in this block.
760 get_tree(Translate_context*);
762 // Iterate over statements.
764 typedef std::vector<Statement*>::iterator iterator;
768 { return this->statements_.begin(); }
772 { return this->statements_.end(); }
777 // Statements in the block.
778 std::vector<Statement*> statements_;
781 // Location of start of block.
782 source_location start_location_;
783 // Location of end of block.
784 source_location end_location_;
792 Function(Function_type* type, Function*, Block*, source_location);
794 // Return the function's type.
797 { return this->type_; }
799 // Return the enclosing function if there is one.
802 { return this->enclosing_; }
804 // Set the enclosing function. This is used when building thunks
805 // for functions which call recover.
807 set_enclosing(Function* enclosing)
809 gcc_assert(this->enclosing_ == NULL);
810 this->enclosing_ = enclosing;
813 // Create the named result variables in the outer block.
815 create_named_result_variables(Gogo*);
817 // Update the named result variables when cloning a function which
820 update_named_result_variables();
822 // Add a new field to the closure variable.
824 add_closure_field(Named_object* var, source_location loc)
825 { this->closure_fields_.push_back(std::make_pair(var, loc)); }
827 // Whether this function needs a closure.
829 needs_closure() const
830 { return !this->closure_fields_.empty(); }
832 // Return the closure variable, creating it if necessary. This is
833 // passed to the function as a static chain parameter.
837 // Set the closure variable. This is used when building thunks for
838 // functions which call recover.
840 set_closure_var(Named_object* v)
842 gcc_assert(this->closure_var_ == NULL);
843 this->closure_var_ = v;
846 // Return the variable for a reference to field INDEX in the closure
849 enclosing_var(unsigned int index)
851 gcc_assert(index < this->closure_fields_.size());
852 return closure_fields_[index].first;
855 // Set the type of the closure variable if there is one.
859 // Get the block of statements associated with the function.
862 { return this->block_; }
864 // Get the location of the start of the function.
867 { return this->location_; }
869 // Return whether this function is actually a method.
873 // Add a label definition to the function.
875 add_label_definition(const std::string& label_name, source_location);
877 // Add a label reference to a function.
879 add_label_reference(const std::string& label_name);
881 // Whether this function calls the predeclared recover function.
883 calls_recover() const
884 { return this->calls_recover_; }
886 // Record that this function calls the predeclared recover function.
887 // This is set during the lowering pass.
890 { this->calls_recover_ = true; }
892 // Whether this is a recover thunk function.
894 is_recover_thunk() const
895 { return this->is_recover_thunk_; }
897 // Record that this is a thunk built for a function which calls
900 set_is_recover_thunk()
901 { this->is_recover_thunk_ = true; }
903 // Whether this function already has a recover thunk.
905 has_recover_thunk() const
906 { return this->has_recover_thunk_; }
908 // Record that this function already has a recover thunk.
910 set_has_recover_thunk()
911 { this->has_recover_thunk_ = true; }
913 // Swap with another function. Used only for the thunk which calls
916 swap_for_recover(Function *);
918 // Traverse the tree.
922 // Determine types in the function.
926 // Return the function's decl given an identifier.
928 get_or_make_decl(Gogo*, Named_object*, tree id);
930 // Return the function's decl after it has been built.
934 gcc_assert(this->fndecl_ != NULL);
935 return this->fndecl_;
938 // Set the function decl to hold a tree of the function code.
940 build_tree(Gogo*, Named_object*);
942 // Get the value to return when not explicitly specified. May also
943 // add statements to execute first to STMT_LIST.
945 return_value(Gogo*, Named_object*, source_location, tree* stmt_list) const;
947 // Get a tree for the variable holding the defer stack.
949 defer_stack(source_location);
951 // Export the function.
953 export_func(Export*, const std::string& name) const;
955 // Export a function with a type.
957 export_func_with_type(Export*, const std::string& name,
958 const Function_type*);
960 // Import a function.
962 import_func(Import*, std::string* pname, Typed_identifier** receiver,
963 Typed_identifier_list** pparameters,
964 Typed_identifier_list** presults, bool* is_varargs);
967 // Type for mapping from label names to Label objects.
968 typedef Unordered_map(std::string, Label*) Labels;
971 make_receiver_parm_decl(Gogo*, Named_object*, tree);
974 copy_parm_to_heap(Gogo*, Named_object*, tree);
977 build_defer_wrapper(Gogo*, Named_object*, tree*, tree*);
979 typedef std::vector<Named_object*> Named_results;
981 typedef std::vector<std::pair<Named_object*,
982 source_location> > Closure_fields;
984 // The function's type.
985 Function_type* type_;
986 // The enclosing function. This is NULL when there isn't one, which
987 // is the normal case.
988 Function* enclosing_;
989 // The named result variables, if any.
990 Named_results* named_results_;
991 // If there is a closure, this is the list of variables which appear
992 // in the closure. This is created by the parser, and then resolved
993 // to a real type when we lower parse trees.
994 Closure_fields closure_fields_;
995 // The closure variable, passed as a parameter using the static
996 // chain parameter. Normally NULL.
997 Named_object* closure_var_;
998 // The outer block of statements in the function.
1000 // The source location of the start of the function.
1001 source_location location_;
1002 // Labels defined or referenced in the function.
1004 // The function decl.
1006 // A variable holding the defer stack variable. This is NULL unless
1007 // we actually need a defer stack.
1009 // True if this function calls the predeclared recover function.
1010 bool calls_recover_;
1011 // True if this a thunk built for a function which calls recover.
1012 bool is_recover_thunk_;
1013 // True if this function already has a recover thunk.
1014 bool has_recover_thunk_;
1017 // A function declaration.
1019 class Function_declaration
1022 Function_declaration(Function_type* fntype, source_location location)
1023 : fntype_(fntype), location_(location), asm_name_(), fndecl_(NULL)
1028 { return this->fntype_; }
1032 { return this->location_; }
1036 { return this->asm_name_; }
1038 // Set the assembler name.
1040 set_asm_name(const std::string& asm_name)
1041 { this->asm_name_ = asm_name; }
1043 // Return a decl for the function given an identifier.
1045 get_or_make_decl(Gogo*, Named_object*, tree id);
1047 // Export a function declaration.
1049 export_func(Export* exp, const std::string& name) const
1050 { Function::export_func_with_type(exp, name, this->fntype_); }
1053 // The type of the function.
1054 Function_type* fntype_;
1055 // The location of the declaration.
1056 source_location location_;
1057 // The assembler name: this is the name to use in references to the
1058 // function. This is normally empty.
1059 std::string asm_name_;
1060 // The function decl if needed.
1069 Variable(Type*, Expression*, bool is_global, bool is_parameter,
1070 bool is_receiver, source_location);
1072 // Get the type of the variable.
1079 // Return whether the type is defined yet.
1082 { return this->type_ != NULL; }
1084 // Get the initial value.
1087 { return this->init_; }
1089 // Return whether there are any preinit statements.
1091 has_pre_init() const
1092 { return this->preinit_ != NULL; }
1094 // Return the preinit statements if any.
1097 { return this->preinit_; }
1099 // Return whether this is a global variable.
1102 { return this->is_global_; }
1104 // Return whether this is a function parameter.
1106 is_parameter() const
1107 { return this->is_parameter_; }
1109 // Return whether this is the receiver parameter of a method.
1112 { return this->is_receiver_; }
1114 // Change this parameter to be a receiver. This is used when
1115 // creating the thunks created for functions which call recover.
1119 gcc_assert(this->is_parameter_);
1120 this->is_receiver_ = true;
1123 // Change this parameter to not be a receiver. This is used when
1124 // creating the thunks created for functions which call recover.
1126 set_is_not_receiver()
1128 gcc_assert(this->is_parameter_);
1129 this->is_receiver_ = false;
1132 // Return whether this is the varargs parameter of a function.
1134 is_varargs_parameter() const
1135 { return this->is_varargs_parameter_; }
1137 // Whether this variable's address is taken.
1139 is_address_taken() const
1140 { return this->is_address_taken_; }
1142 // Whether this variable should live in the heap.
1145 { return this->is_address_taken_ && !this->is_global_; }
1147 // Get the source location of the variable's declaration.
1150 { return this->location_; }
1152 // Record that this is the varargs parameter of a function.
1154 set_is_varargs_parameter()
1156 gcc_assert(this->is_parameter_);
1157 this->is_varargs_parameter_ = true;
1160 // Clear the initial value; used for error handling.
1163 { this->init_ = NULL; }
1165 // Set the initial value; used for converting shortcuts.
1167 set_init(Expression* init)
1168 { this->init_ = init; }
1170 // Get the preinit block, a block of statements to be run before the
1171 // initialization expression.
1173 preinit_block(Gogo*);
1175 // Add a statement to be run before the initialization expression.
1176 // This is only used for global variables.
1178 add_preinit_statement(Gogo*, Statement*);
1180 // Lower the initialization expression after parsing is complete.
1182 lower_init_expression(Gogo*, Named_object*);
1184 // A special case: the init value is used only to determine the
1185 // type. This is used if the variable is defined using := with the
1186 // comma-ok form of a map index or a receive expression. The init
1187 // value is actually the map index expression or receive expression.
1188 // We use this because we may not know the right type at parse time.
1190 set_type_from_init_tuple()
1191 { this->type_from_init_tuple_ = true; }
1193 // Another special case: the init value is used only to determine
1194 // the type. This is used if the variable is defined using := with
1195 // a range clause. The init value is the range expression. The
1196 // type of the variable is the index type of the range expression
1197 // (i.e., the first value returned by a range).
1199 set_type_from_range_index()
1200 { this->type_from_range_index_ = true; }
1202 // Another special case: like set_type_from_range_index, but the
1203 // type is the value type of the range expression (i.e., the second
1204 // value returned by a range).
1206 set_type_from_range_value()
1207 { this->type_from_range_value_ = true; }
1209 // Another special case: the init value is used only to determine
1210 // the type. This is used if the variable is defined using := with
1211 // a case in a select statement. The init value is the channel.
1212 // The type of the variable is the channel's element type.
1214 set_type_from_chan_element()
1215 { this->type_from_chan_element_ = true; }
1217 // After we lower the select statement, we once again set the type
1218 // from the initialization expression.
1220 clear_type_from_chan_element()
1222 gcc_assert(this->type_from_chan_element_);
1223 this->type_from_chan_element_ = false;
1226 // Note that this variable was created for a type switch clause.
1228 set_is_type_switch_var()
1229 { this->is_type_switch_var_ = true; }
1231 // Traverse the initializer expression.
1233 traverse_expression(Traverse*);
1235 // Determine the type of the variable if necessary.
1239 // Note that something takes the address of this variable.
1242 { this->is_address_taken_ = true; }
1244 // Get the initial value of the variable as a tree. This may only
1245 // be called if has_pre_init() returns false.
1247 get_init_tree(Gogo*, Named_object* function);
1249 // Return a series of statements which sets the value of the
1250 // variable in DECL. This should only be called is has_pre_init()
1251 // returns true. DECL may be NULL for a sink variable.
1253 get_init_block(Gogo*, Named_object* function, tree decl);
1255 // Export the variable.
1257 export_var(Export*, const std::string& name) const;
1259 // Import a variable.
1261 import_var(Import*, std::string* pname, Type** ptype);
1264 // The type of a tuple.
1266 type_from_tuple(Expression*, bool) const;
1268 // The type of a range.
1270 type_from_range(Expression*, bool, bool) const;
1272 // The element type of a channel.
1274 type_from_chan_element(Expression*, bool) const;
1276 // The variable's type. This may be NULL if the type is set from
1279 // The initial value. This may be NULL if the variable should be
1280 // initialized to the default value for the type.
1282 // Statements to run before the init statement.
1284 // Location of variable definition.
1285 source_location location_;
1286 // Whether this is a global variable.
1287 bool is_global_ : 1;
1288 // Whether this is a function parameter.
1289 bool is_parameter_ : 1;
1290 // Whether this is the receiver parameter of a method.
1291 bool is_receiver_ : 1;
1292 // Whether this is the varargs parameter of a function.
1293 bool is_varargs_parameter_ : 1;
1294 // Whether something takes the address of this variable.
1295 bool is_address_taken_ : 1;
1296 // True if we have seen this variable in a traversal.
1298 // True if we have lowered the initialization expression.
1299 bool init_is_lowered_ : 1;
1300 // True if init is a tuple used to set the type.
1301 bool type_from_init_tuple_ : 1;
1302 // True if init is a range clause and the type is the index type.
1303 bool type_from_range_index_ : 1;
1304 // True if init is a range clause and the type is the value type.
1305 bool type_from_range_value_ : 1;
1306 // True if init is a channel and the type is the channel's element type.
1307 bool type_from_chan_element_ : 1;
1308 // True if this is a variable created for a type switch case.
1309 bool is_type_switch_var_ : 1;
1312 // A variable which is really the name for a function return value, or
1315 class Result_variable
1318 Result_variable(Type* type, Function* function, int index)
1319 : type_(type), function_(function), index_(index),
1320 is_address_taken_(false)
1323 // Get the type of the result variable.
1326 { return this->type_; }
1328 // Get the function that this is associated with.
1331 { return this->function_; }
1333 // Index in the list of function results.
1336 { return this->index_; }
1338 // Whether this variable's address is taken.
1340 is_address_taken() const
1341 { return this->is_address_taken_; }
1343 // Note that something takes the address of this variable.
1346 { this->is_address_taken_ = true; }
1348 // Whether this variable should live in the heap.
1351 { return this->is_address_taken_; }
1353 // Set the function. This is used when cloning functions which call
1356 set_function(Function* function)
1357 { this->function_ = function; }
1360 // Type of result variable.
1362 // Function with which this is associated.
1363 Function* function_;
1364 // Index in list of results.
1366 // Whether something takes the address of this variable.
1367 bool is_address_taken_;
1370 // The value we keep for a named constant. This lets us hold a type
1371 // and an expression.
1373 class Named_constant
1376 Named_constant(Type* type, Expression* expr, int iota_value,
1377 source_location location)
1378 : type_(type), expr_(expr), iota_value_(iota_value), location_(location),
1384 { return this->type_; }
1388 { return this->expr_; }
1392 { return this->iota_value_; }
1396 { return this->location_; }
1398 // Whether we are lowering.
1401 { return this->lowering_; }
1403 // Set that we are lowering.
1406 { this->lowering_ = true; }
1408 // We are no longer lowering.
1411 { this->lowering_ = false; }
1413 // Traverse the expression.
1415 traverse_expression(Traverse*);
1417 // Determine the type of the constant if necessary.
1421 // Indicate that we found and reported an error for this constant.
1425 // Export the constant.
1427 export_const(Export*, const std::string& name) const;
1429 // Import a constant.
1431 import_const(Import*, std::string*, Type**, Expression**);
1434 // The type of the constant.
1436 // The expression for the constant.
1438 // If the predeclared constant iota is used in EXPR_, this is the
1439 // value it will have. We do this because at parse time we don't
1440 // know whether the name "iota" will refer to the predeclared
1441 // constant or to something else. We put in the right value in when
1444 // The location of the definition.
1445 source_location location_;
1446 // Whether we are currently lowering this constant.
1450 // A type declaration.
1452 class Type_declaration
1455 Type_declaration(source_location location)
1456 : location_(location), in_function_(NULL), methods_(),
1457 issued_warning_(false)
1460 // Return the location.
1463 { return this->location_; }
1465 // Return the function in which this type is declared. This will
1466 // return NULL for a type declared in global scope.
1469 { return this->in_function_; }
1471 // Set the function in which this type is declared.
1473 set_in_function(Named_object* f)
1474 { this->in_function_ = f; }
1476 // Add a method to this type. This is used when methods are defined
1479 add_method(const std::string& name, Function* function);
1481 // Add a method declaration to this type.
1483 add_method_declaration(const std::string& name, Function_type* type,
1484 source_location location);
1486 // Return whether any methods were defined.
1488 has_methods() const;
1490 // Define methods when the real type is known.
1492 define_methods(Named_type*);
1494 // This is called if we are trying to use this type. It returns
1495 // true if we should issue a warning.
1500 typedef std::vector<Named_object*> Methods;
1502 // The location of the type declaration.
1503 source_location location_;
1504 // If this type is declared in a function, a pointer back to the
1505 // function in which it is defined.
1506 Named_object* in_function_;
1507 // Methods defined before the type is defined.
1509 // True if we have issued a warning about a use of this type
1510 // declaration when it is undefined.
1511 bool issued_warning_;
1514 // An unknown object. These are created by the parser for forward
1515 // references to names which have not been seen before. In a correct
1516 // program, these will always point to a real definition by the end of
1517 // the parse. Because they point to another Named_object, these may
1518 // only be referenced by Unknown_expression objects.
1523 Unknown_name(source_location location)
1524 : location_(location), real_named_object_(NULL)
1527 // Return the location where this name was first seen.
1530 { return this->location_; }
1532 // Return the real named object that this points to, or NULL if it
1533 // was never resolved.
1535 real_named_object() const
1536 { return this->real_named_object_; }
1538 // Set the real named object that this points to.
1540 set_real_named_object(Named_object* no);
1543 // The location where this name was first seen.
1544 source_location location_;
1545 // The real named object when it is known.
1550 // A named object named. This is the result of a declaration. We
1551 // don't use a superclass because they all have to be handled
1559 // An uninitialized Named_object. We should never see this.
1560 NAMED_OBJECT_UNINITIALIZED,
1561 // An unknown name. This is used for forward references. In a
1562 // correct program, these will all be resolved by the end of the
1564 NAMED_OBJECT_UNKNOWN,
1569 // A forward type declaration.
1570 NAMED_OBJECT_TYPE_DECLARATION,
1573 // A result variable in a function.
1574 NAMED_OBJECT_RESULT_VAR,
1575 // The blank identifier--the special variable named _.
1579 // A forward func declaration.
1580 NAMED_OBJECT_FUNC_DECLARATION,
1582 NAMED_OBJECT_PACKAGE
1585 // Return the classification.
1587 classification() const
1588 { return this->classification_; }
1594 { return this->classification_ == NAMED_OBJECT_UNKNOWN; }
1598 { return this->classification_ == NAMED_OBJECT_CONST; }
1602 { return this->classification_ == NAMED_OBJECT_TYPE; }
1605 is_type_declaration() const
1606 { return this->classification_ == NAMED_OBJECT_TYPE_DECLARATION; }
1610 { return this->classification_ == NAMED_OBJECT_VAR; }
1613 is_result_variable() const
1614 { return this->classification_ == NAMED_OBJECT_RESULT_VAR; }
1618 { return this->classification_ == NAMED_OBJECT_SINK; }
1622 { return this->classification_ == NAMED_OBJECT_FUNC; }
1625 is_function_declaration() const
1626 { return this->classification_ == NAMED_OBJECT_FUNC_DECLARATION; }
1630 { return this->classification_ == NAMED_OBJECT_PACKAGE; }
1634 static Named_object*
1635 make_unknown_name(const std::string& name, source_location);
1637 static Named_object*
1638 make_constant(const Typed_identifier&, const Package*, Expression*,
1641 static Named_object*
1642 make_type(const std::string&, const Package*, Type*, source_location);
1644 static Named_object*
1645 make_type_declaration(const std::string&, const Package*, source_location);
1647 static Named_object*
1648 make_variable(const std::string&, const Package*, Variable*);
1650 static Named_object*
1651 make_result_variable(const std::string&, Result_variable*);
1653 static Named_object*
1656 static Named_object*
1657 make_function(const std::string&, const Package*, Function*);
1659 static Named_object*
1660 make_function_declaration(const std::string&, const Package*, Function_type*,
1663 static Named_object*
1664 make_package(const std::string& alias, Package* package);
1671 gcc_assert(this->classification_ == NAMED_OBJECT_UNKNOWN);
1672 return this->u_.unknown_value;
1676 unknown_value() const
1678 gcc_assert(this->classification_ == NAMED_OBJECT_UNKNOWN);
1679 return this->u_.unknown_value;
1685 gcc_assert(this->classification_ == NAMED_OBJECT_CONST);
1686 return this->u_.const_value;
1689 const Named_constant*
1692 gcc_assert(this->classification_ == NAMED_OBJECT_CONST);
1693 return this->u_.const_value;
1699 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE);
1700 return this->u_.type_value;
1706 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE);
1707 return this->u_.type_value;
1711 type_declaration_value()
1713 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE_DECLARATION);
1714 return this->u_.type_declaration;
1717 const Type_declaration*
1718 type_declaration_value() const
1720 gcc_assert(this->classification_ == NAMED_OBJECT_TYPE_DECLARATION);
1721 return this->u_.type_declaration;
1727 gcc_assert(this->classification_ == NAMED_OBJECT_VAR);
1728 return this->u_.var_value;
1734 gcc_assert(this->classification_ == NAMED_OBJECT_VAR);
1735 return this->u_.var_value;
1741 gcc_assert(this->classification_ == NAMED_OBJECT_RESULT_VAR);
1742 return this->u_.result_var_value;
1745 const Result_variable*
1746 result_var_value() const
1748 gcc_assert(this->classification_ == NAMED_OBJECT_RESULT_VAR);
1749 return this->u_.result_var_value;
1755 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC);
1756 return this->u_.func_value;
1762 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC);
1763 return this->u_.func_value;
1766 Function_declaration*
1767 func_declaration_value()
1769 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC_DECLARATION);
1770 return this->u_.func_declaration_value;
1773 const Function_declaration*
1774 func_declaration_value() const
1776 gcc_assert(this->classification_ == NAMED_OBJECT_FUNC_DECLARATION);
1777 return this->u_.func_declaration_value;
1783 gcc_assert(this->classification_ == NAMED_OBJECT_PACKAGE);
1784 return this->u_.package_value;
1788 package_value() const
1790 gcc_assert(this->classification_ == NAMED_OBJECT_PACKAGE);
1791 return this->u_.package_value;
1796 { return this->name_; }
1798 // Return the name to use in an error message. The difference is
1799 // that if this Named_object is defined in a different package, this
1800 // will return PACKAGE.NAME.
1802 message_name() const;
1806 { return this->package_; }
1808 // Resolve an unknown value if possible. This returns the same
1809 // Named_object or a new one.
1813 Named_object* ret = this;
1814 if (this->is_unknown())
1816 Named_object* r = this->unknown_value()->real_named_object();
1826 const Named_object* ret = this;
1827 if (this->is_unknown())
1829 const Named_object* r = this->unknown_value()->real_named_object();
1836 // The location where this object was defined or referenced.
1840 // Return a tree for the external identifier for this object.
1844 // Return a tree representing this object.
1846 get_tree(Gogo*, Named_object* function);
1848 // Define a type declaration.
1850 set_type_value(Named_type*);
1852 // Define a function declaration.
1854 set_function_value(Function*);
1856 // Declare an unknown name as a type declaration.
1860 // Export this object.
1862 export_named_object(Export*) const;
1865 Named_object(const std::string&, const Package*, Classification);
1867 // The name of the object.
1869 // The package that this object is in. This is NULL if it is in the
1870 // file we are compiling.
1871 const Package* package_;
1872 // The type of object this is.
1873 Classification classification_;
1877 Unknown_name* unknown_value;
1878 Named_constant* const_value;
1879 Named_type* type_value;
1880 Type_declaration* type_declaration;
1881 Variable* var_value;
1882 Result_variable* result_var_value;
1883 Function* func_value;
1884 Function_declaration* func_declaration_value;
1885 Package* package_value;
1887 // The DECL tree for this object if we have already converted it.
1891 // A binding contour. This binds names to objects.
1896 // Type for mapping from names to objects.
1897 typedef Unordered_map(std::string, Named_object*) Contour;
1899 Bindings(Bindings* enclosing);
1901 // Add an unknown name.
1903 add_unknown_name(const std::string& name, source_location location)
1905 return this->add_named_object(Named_object::make_unknown_name(name,
1911 add_constant(const Typed_identifier& tid, const Package* package,
1912 Expression* expr, int iota_value)
1914 return this->add_named_object(Named_object::make_constant(tid, package,
1921 add_type(const std::string& name, const Package* package, Type* type,
1922 source_location location)
1924 return this->add_named_object(Named_object::make_type(name, package, type,
1928 // Add a named type. This is used for builtin types, and to add an
1929 // imported type to the global scope.
1931 add_named_type(Named_type* named_type);
1933 // Add a type declaration.
1935 add_type_declaration(const std::string& name, const Package* package,
1936 source_location location)
1938 Named_object* no = Named_object::make_type_declaration(name, package,
1940 return this->add_named_object(no);
1945 add_variable(const std::string& name, const Package* package,
1948 return this->add_named_object(Named_object::make_variable(name, package,
1952 // Add a result variable.
1954 add_result_variable(const std::string& name, Result_variable* result)
1956 return this->add_named_object(Named_object::make_result_variable(name,
1962 add_function(const std::string& name, const Package*, Function* function);
1964 // Add a function declaration.
1966 add_function_declaration(const std::string& name, const Package* package,
1967 Function_type* type, source_location location);
1969 // Add a package. The location is the location of the import
1972 add_package(const std::string& alias, Package* package)
1974 Named_object* no = Named_object::make_package(alias, package);
1975 return this->add_named_object(no);
1978 // Define a type which was already declared.
1980 define_type(Named_object*, Named_type*);
1982 // Add a method to the list of objects. This is not added to the
1985 add_method(Named_object*);
1987 // Add a named object to this binding.
1989 add_named_object(Named_object* no)
1990 { return this->add_named_object_to_contour(&this->bindings_, no); }
1992 // Clear all names in file scope from the bindings.
1996 // Look up a name in this binding contour and in any enclosing
1997 // binding contours. This returns NULL if the name is not found.
1999 lookup(const std::string&) const;
2001 // Look up a name in this binding contour without looking in any
2002 // enclosing binding contours. Returns NULL if the name is not found.
2004 lookup_local(const std::string&) const;
2008 remove_binding(Named_object*);
2010 // Traverse the tree. See the Traverse class.
2012 traverse(Traverse*, bool is_global);
2014 // Iterate over definitions. This does not include things which
2015 // were only declared.
2017 typedef std::vector<Named_object*>::const_iterator
2018 const_definitions_iterator;
2020 const_definitions_iterator
2021 begin_definitions() const
2022 { return this->named_objects_.begin(); }
2024 const_definitions_iterator
2025 end_definitions() const
2026 { return this->named_objects_.end(); }
2028 // Return the number of definitions.
2030 size_definitions() const
2031 { return this->named_objects_.size(); }
2033 // Return whether there are no definitions.
2035 empty_definitions() const
2036 { return this->named_objects_.empty(); }
2038 // Iterate over declarations. This is everything that has been
2039 // declared, which includes everything which has been defined.
2041 typedef Contour::const_iterator const_declarations_iterator;
2043 const_declarations_iterator
2044 begin_declarations() const
2045 { return this->bindings_.begin(); }
2047 const_declarations_iterator
2048 end_declarations() const
2049 { return this->bindings_.end(); }
2051 // Return the number of declarations.
2053 size_declarations() const
2054 { return this->bindings_.size(); }
2056 // Return whether there are no declarations.
2058 empty_declarations() const
2059 { return this->bindings_.empty(); }
2061 // Return the first declaration.
2064 { return this->bindings_.empty() ? NULL : this->bindings_.begin()->second; }
2068 add_named_object_to_contour(Contour*, Named_object*);
2071 new_definition(Named_object*, Named_object*);
2073 // Enclosing bindings.
2074 Bindings* enclosing_;
2075 // The list of objects.
2076 std::vector<Named_object*> named_objects_;
2077 // The mapping from names to objects.
2086 Label(const std::string& name)
2087 : name_(name), location_(0), decl_(NULL)
2090 // Return the label's name.
2093 { return this->name_; }
2095 // Return whether the label has been defined.
2098 { return this->location_ != 0; }
2100 // Return the location of the definition.
2103 { return this->location_; }
2105 // Define the label at LOCATION.
2107 define(source_location location)
2109 gcc_assert(this->location_ == 0);
2110 this->location_ = location;
2113 // Return the LABEL_DECL for this decl.
2117 // Return an expression for the address of this label.
2119 get_addr(source_location location);
2122 // The name of the label.
2124 // The location of the definition. This is 0 if the label has not
2125 // yet been defined.
2126 source_location location_;
2131 // An unnamed label. These are used when lowering loops.
2136 Unnamed_label(source_location location)
2137 : location_(location), decl_(NULL)
2140 // Get the location where the label is defined.
2143 { return this->location_; }
2145 // Set the location where the label is defined.
2147 set_location(source_location location)
2148 { this->location_ = location; }
2150 // Return a statement which defines this label.
2154 // Return a goto to this label from LOCATION.
2156 get_goto(source_location location);
2159 // Return the LABEL_DECL to use with GOTO_EXPR.
2163 // The location where the label is defined.
2164 source_location location_;
2169 // An imported package.
2174 Package(const std::string& name, const std::string& unique_prefix,
2175 source_location location);
2177 // The real name of this package. This may be different from the
2178 // name in the associated Named_object if the import statement used
2182 { return this->name_; }
2184 // Return the location of the import statement.
2187 { return this->location_; }
2189 // Get the unique prefix used for all symbols exported from this
2192 unique_prefix() const
2194 gcc_assert(!this->unique_prefix_.empty());
2195 return this->unique_prefix_;
2198 // The priority of this package. The init function of packages with
2199 // lower priority must be run before the init function of packages
2200 // with higher priority.
2203 { return this->priority_; }
2205 // Set the priority.
2207 set_priority(int priority);
2209 // Return the bindings.
2212 { return this->bindings_; }
2214 // Whether some symbol from the package was used.
2217 { return this->used_; }
2219 // Note that some symbol from this package was used.
2222 { this->used_ = true; }
2224 // Clear the used field for the next file.
2227 { this->used_ = false; }
2229 // Whether this package was imported in the current file.
2232 { return this->is_imported_; }
2234 // Note that this package was imported in the current file.
2237 { this->is_imported_ = true; }
2239 // Clear the imported field for the next file.
2242 { this->is_imported_ = false; }
2244 // Whether this package was imported with a name of "_".
2246 uses_sink_alias() const
2247 { return this->uses_sink_alias_; }
2249 // Note that this package was imported with a name of "_".
2251 set_uses_sink_alias()
2252 { this->uses_sink_alias_ = true; }
2254 // Clear the sink alias field for the next file.
2256 clear_uses_sink_alias()
2257 { this->uses_sink_alias_ = false; }
2259 // Look up a name in the package. Returns NULL if the name is not
2262 lookup(const std::string& name) const
2263 { return this->bindings_->lookup(name); }
2265 // Set the location of the package. This is used if it is seen in a
2266 // different import before it is really imported.
2268 set_location(source_location location)
2269 { this->location_ = location; }
2271 // Add a constant to the package.
2273 add_constant(const Typed_identifier& tid, Expression* expr)
2274 { return this->bindings_->add_constant(tid, this, expr, 0); }
2276 // Add a type to the package.
2278 add_type(const std::string& name, Type* type, source_location location)
2279 { return this->bindings_->add_type(name, this, type, location); }
2281 // Add a type declaration to the package.
2283 add_type_declaration(const std::string& name, source_location location)
2284 { return this->bindings_->add_type_declaration(name, this, location); }
2286 // Add a variable to the package.
2288 add_variable(const std::string& name, Variable* variable)
2289 { return this->bindings_->add_variable(name, this, variable); }
2291 // Add a function declaration to the package.
2293 add_function_declaration(const std::string& name, Function_type* type,
2294 source_location loc)
2295 { return this->bindings_->add_function_declaration(name, this, type, loc); }
2297 // Determine types of constants.
2302 // The real name of this package.
2304 // The unique prefix for all exported global symbols.
2305 std::string unique_prefix_;
2306 // The names in this package.
2307 Bindings* bindings_;
2308 // The priority of this package. A package has a priority higher
2309 // than the priority of all of the packages that it imports. This
2310 // is used to run init functions in the right order.
2312 // The location of the import statement.
2313 source_location location_;
2314 // True if some name from this package was used. This is mutable
2315 // because we can use a package even if we have a const pointer to
2318 // True if this package was imported in the current file.
2320 // True if this package was imported with a name of "_".
2321 bool uses_sink_alias_;
2324 // Return codes for the traversal functions. This is not an enum
2325 // because we want to be able to declare traversal functions in other
2326 // header files without including this one.
2328 // Continue traversal as usual.
2329 const int TRAVERSE_CONTINUE = -1;
2332 const int TRAVERSE_EXIT = 0;
2334 // Continue traversal, but skip components of the current object.
2335 // E.g., if this is returned by Traverse::statement, we do not
2336 // traverse the expressions in the statement even if
2337 // traverse_expressions is set in the traverse_mask.
2338 const int TRAVERSE_SKIP_COMPONENTS = 1;
2340 // This class is used when traversing the parse tree. The caller uses
2341 // a subclass which overrides functions as desired.
2346 // These bitmasks say what to traverse.
2347 static const unsigned int traverse_variables = 0x1;
2348 static const unsigned int traverse_constants = 0x2;
2349 static const unsigned int traverse_functions = 0x4;
2350 static const unsigned int traverse_blocks = 0x8;
2351 static const unsigned int traverse_statements = 0x10;
2352 static const unsigned int traverse_expressions = 0x20;
2353 static const unsigned int traverse_types = 0x40;
2355 Traverse(unsigned int traverse_mask)
2356 : traverse_mask_(traverse_mask), types_seen_(NULL), expressions_seen_(NULL)
2359 virtual ~Traverse();
2361 // The bitmask of what to traverse.
2363 traverse_mask() const
2364 { return this->traverse_mask_; }
2366 // Record that we are going to traverse a type. This returns true
2367 // if the type has already been seen in this traversal. This is
2368 // required because types, unlike expressions, can form a circular
2371 remember_type(const Type*);
2373 // Record that we are going to see an expression. This returns true
2374 // if the expression has already been seen in this traversal. This
2375 // is only needed for cases where multiple expressions can point to
2378 remember_expression(const Expression*);
2380 // These functions return one of the TRAVERSE codes defined above.
2382 // If traverse_variables is set in the mask, this is called for
2383 // every variable in the tree.
2385 variable(Named_object*);
2387 // If traverse_constants is set in the mask, this is called for
2388 // every named constant in the tree. The bool parameter is true for
2389 // a global constant.
2391 constant(Named_object*, bool);
2393 // If traverse_functions is set in the mask, this is called for
2394 // every function in the tree.
2396 function(Named_object*);
2398 // If traverse_blocks is set in the mask, this is called for every
2399 // block in the tree.
2403 // If traverse_statements is set in the mask, this is called for
2404 // every statement in the tree.
2406 statement(Block*, size_t* index, Statement*);
2408 // If traverse_expressions is set in the mask, this is called for
2409 // every expression in the tree.
2411 expression(Expression**);
2413 // If traverse_types is set in the mask, this is called for every
2414 // type in the tree.
2419 typedef Unordered_set_hash(const Type*, Type_hash_identical,
2420 Type_identical) Types_seen;
2422 typedef Unordered_set(const Expression*) Expressions_seen;
2424 // Bitmask of what sort of objects to traverse.
2425 unsigned int traverse_mask_;
2426 // Types which have been seen in this traversal.
2427 Types_seen* types_seen_;
2428 // Expressions which have been seen in this traversal.
2429 Expressions_seen* expressions_seen_;
2432 // When translating the gogo IR into trees, this is the context we
2433 // pass down the blocks and statements.
2435 class Translate_context
2438 Translate_context(Gogo* gogo, Named_object* function, Block* block,
2440 : gogo_(gogo), function_(function), block_(block), block_tree_(block_tree),
2448 { return this->gogo_; }
2452 { return this->function_; }
2456 { return this->block_; }
2460 { return this->block_tree_; }
2464 { return this->is_const_; }
2466 // Make a constant context.
2469 { this->is_const_ = true; }
2472 // The IR for the entire compilation unit.
2474 // The function we are currently translating.
2475 Named_object* function_;
2476 // The block we are currently translating.
2478 // The BLOCK node for the current block.
2480 // Whether this is being evaluated in a constant context. This is
2481 // used for type descriptor initializers.
2485 // Runtime error codes. These must match the values in
2486 // libgo/runtime/go-runtime-error.c.
2488 // Slice index out of bounds: negative or larger than the length of
2490 static const int RUNTIME_ERROR_SLICE_INDEX_OUT_OF_BOUNDS = 0;
2492 // Array index out of bounds.
2493 static const int RUNTIME_ERROR_ARRAY_INDEX_OUT_OF_BOUNDS = 1;
2495 // String index out of bounds.
2496 static const int RUNTIME_ERROR_STRING_INDEX_OUT_OF_BOUNDS = 2;
2498 // Slice slice out of bounds: negative or larger than the length of
2499 // the slice or high bound less than low bound.
2500 static const int RUNTIME_ERROR_SLICE_SLICE_OUT_OF_BOUNDS = 3;
2502 // Array slice out of bounds.
2503 static const int RUNTIME_ERROR_ARRAY_SLICE_OUT_OF_BOUNDS = 4;
2505 // String slice out of bounds.
2506 static const int RUNTIME_ERROR_STRING_SLICE_OUT_OF_BOUNDS = 5;
2508 // Dereference of nil pointer. This is used when there is a
2509 // dereference of a pointer to a very large struct or array, to ensure
2510 // that a gigantic array is not used a proxy to access random memory
2512 static const int RUNTIME_ERROR_NIL_DEREFERENCE = 6;
2514 // Slice length or capacity out of bounds in make: negative or
2515 // overflow or length greater than capacity.
2516 static const int RUNTIME_ERROR_MAKE_SLICE_OUT_OF_BOUNDS = 7;
2518 // Map capacity out of bounds in make: negative or overflow.
2519 static const int RUNTIME_ERROR_MAKE_MAP_OUT_OF_BOUNDS = 8;
2521 // Channel capacity out of bounds in make: negative or overflow.
2522 static const int RUNTIME_ERROR_MAKE_CHAN_OUT_OF_BOUNDS = 9;
2524 // This is used by some of the langhooks.
2525 extern Gogo* go_get_gogo();
2527 // Whether we have seen any errors. FIXME: Replace with a backend
2529 extern bool saw_errors();
2531 #endif // !defined(GO_GOGO_H)