Robert Griesemer | 53440da | 2009-10-01 14:08:00 -0700 | [diff] [blame] | 1 | <!-- The Go Programming Language Specification --> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2 | |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 3 | <!-- |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4 | Todo |
| 5 | [ ] clarify: two equal lowercase identifiers from different packages denote different objects |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 6 | [ ] need language about function/method calls and parameter passing rules |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 7 | [ ] need to say something about "scope" of selectors? |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 8 | [ ] clarify what a field name is in struct declarations |
| 9 | (struct{T} vs struct {T T} vs struct {t T}) |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 10 | [ ] need explicit language about the result type of operations |
| 11 | [ ] may want to have some examples for the types of shift operations |
Russ Cox | 60ff8cc | 2009-10-20 08:27:14 -0700 | [diff] [blame] | 12 | [ ] should string(1<<s) and float(1<<s) be valid? |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 13 | [ ] should probably write something about evaluation order of statements even |
| 14 | though obvious |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 15 | [ ] specify iteration direction for range clause |
| 16 | [ ] review language on implicit dereferencing |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 17 | --> |
| 18 | |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 19 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 20 | <h2 id="Introduction">Introduction</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 21 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 22 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 23 | This is a reference manual for the Go programming language. For |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 24 | more information and other documents, see <a href="http://go/go">go/go</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 25 | </p> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 26 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 27 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 28 | Go is a general-purpose language designed with systems programming |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 29 | in mind. It is strongly typed and garbage-collected and has explicit |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 30 | support for concurrent programming. Programs are constructed from |
| 31 | <i>packages</i>, whose properties allow efficient management of |
| 32 | dependencies. The existing implementations use a traditional |
| 33 | compile/link model to generate executable binaries. |
| 34 | </p> |
| 35 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 36 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 37 | The grammar is compact and regular, allowing for easy analysis by |
| 38 | automatic tools such as integrated development environments. |
| 39 | </p> |
Larry Hosken | 698c6c0 | 2009-09-17 08:05:12 -0700 | [diff] [blame] | 40 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 41 | <h2 id="Notation">Notation</h2> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 42 | <p> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 43 | The syntax is specified using Extended Backus-Naur Form (EBNF): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 44 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 45 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 46 | <pre class="grammar"> |
Robert Griesemer | 88a0c40 | 2009-04-23 14:42:21 -0700 | [diff] [blame] | 47 | Production = production_name "=" Expression "." . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 48 | Expression = Alternative { "|" Alternative } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 49 | Alternative = Term { Term } . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 50 | Term = production_name | token [ "..." token ] | Group | Option | Repetition . |
| 51 | Group = "(" Expression ")" . |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 52 | Option = "[" Expression "]" . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 53 | Repetition = "{" Expression "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 54 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 55 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 56 | <p> |
| 57 | Productions are expressions constructed from terms and the following |
| 58 | operators, in increasing precedence: |
| 59 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 60 | <pre class="grammar"> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 61 | | alternation |
| 62 | () grouping |
| 63 | [] option (0 or 1 times) |
| 64 | {} repetition (0 to n times) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 65 | </pre> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 66 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 67 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 68 | Lower-case production names are used to identify lexical tokens. |
| 69 | Non-terminals are in CamelCase. Lexical symbols are enclosed in |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 70 | double quotes <code>""</code> or back quotes <code>``</code>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 71 | </p> |
| 72 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 73 | <p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 74 | The form <code>a ... b</code> represents the set of characters from |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 75 | <code>a</code> through <code>b</code> as alternatives. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 76 | </p> |
| 77 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 78 | <h2 id="Source_code_representation">Source code representation</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 79 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 80 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 81 | Source code is Unicode text encoded in UTF-8. The text is not |
| 82 | canonicalized, so a single accented code point is distinct from the |
| 83 | same character constructed from combining an accent and a letter; |
| 84 | those are treated as two code points. For simplicity, this document |
| 85 | will use the term <i>character</i> to refer to a Unicode code point. |
| 86 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 87 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 88 | Each code point is distinct; for instance, upper and lower case letters |
| 89 | are different characters. |
| 90 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 91 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 92 | <h3 id="Characters">Characters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 93 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 94 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 95 | The following terms are used to denote specific Unicode character classes: |
| 96 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 97 | <pre class="ebnf"> |
| 98 | unicode_char = /* an arbitrary Unicode code point */ . |
| 99 | unicode_letter = /* a Unicode code point classified as "Letter" */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 100 | unicode_digit = /* a Unicode code point classified as "Digit" */ . |
| 101 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 102 | |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 103 | <p> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 104 | In <a href="http://www.unicode.org/versions/Unicode5.1.0/">The Unicode Standard 5.1</a>, |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 105 | Section 4.5 General Category-Normative |
| 106 | defines a set of character categories. Go treats |
| 107 | those characters in category Lu, Ll, Lt, Lm, or Lo as Unicode letters, |
| 108 | and those in category Nd as Unicode digits. |
| 109 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 110 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 111 | <h3 id="Letters_and_digits">Letters and digits</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 112 | |
| 113 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 114 | The underscore character <code>_</code> (U+005F) is considered a letter. |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 115 | </p> |
| 116 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 117 | letter = unicode_letter | "_" . |
| 118 | decimal_digit = "0" ... "9" . |
| 119 | octal_digit = "0" ... "7" . |
| 120 | hex_digit = "0" ... "9" | "A" ... "F" | "a" ... "f" . |
| 121 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 122 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 123 | <h2 id="Lexical_elements">Lexical elements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 124 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 125 | <h3 id="Comments">Comments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 126 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 127 | <p> |
| 128 | There are two forms of comments. The first starts at the character |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 129 | sequence <code>//</code> and continues through the next newline. The |
| 130 | second starts at the character sequence <code>/*</code> and continues |
| 131 | through the character sequence <code>*/</code>. Comments do not nest. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 132 | </p> |
| 133 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 134 | <h3 id="Tokens">Tokens</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 135 | |
| 136 | <p> |
| 137 | Tokens form the vocabulary of the Go language. |
| 138 | There are four classes: identifiers, keywords, operators |
| 139 | and delimiters, and literals. <i>White space</i>, formed from |
| 140 | blanks, tabs, and newlines, is ignored except as it separates tokens |
| 141 | that would otherwise combine into a single token. Comments |
| 142 | behave as white space. While breaking the input into tokens, |
| 143 | the next token is the longest sequence of characters that form a |
| 144 | valid token. |
| 145 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 146 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 147 | <h3 id="Identifiers">Identifiers</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 148 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 149 | <p> |
| 150 | Identifiers name program entities such as variables and types. |
| 151 | An identifier is a sequence of one or more letters and digits. |
| 152 | The first character in an identifier must be a letter. |
| 153 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 154 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 155 | identifier = letter { letter | unicode_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 156 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 157 | <pre> |
| 158 | a |
| 159 | _x9 |
| 160 | ThisVariableIsExported |
| 161 | αβ |
| 162 | </pre> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 163 | Some identifiers are <a href="#Predeclared_identifiers">predeclared</a>. |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 164 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 165 | <h3 id="Keywords">Keywords</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 166 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 167 | <p> |
| 168 | The following keywords are reserved and may not be used as identifiers. |
| 169 | </p> |
| 170 | <pre class="grammar"> |
| 171 | break default func interface select |
| 172 | case defer go map struct |
| 173 | chan else goto package switch |
| 174 | const fallthrough if range type |
| 175 | continue for import return var |
| 176 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 177 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 178 | <h3 id="Operators_and_Delimiters">Operators and Delimiters</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 179 | |
| 180 | <p> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 181 | The following character sequences represent <a href="#Operators">operators</a>, delimiters, and other special tokens: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 182 | </p> |
| 183 | <pre class="grammar"> |
| 184 | + & += &= && == != ( ) |
| 185 | - | -= |= || < <= [ ] |
| 186 | * ^ *= ^= <- > >= { } |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 187 | / << /= <<= ++ = := , ; |
| 188 | % >> %= >>= -- ! ... . : |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 189 | &^ &^= |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 190 | </pre> |
| 191 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 192 | <h3 id="Integer_literals">Integer literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 193 | |
| 194 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 195 | An integer literal is a sequence of digits representing an |
| 196 | <a href="#Constants">integer constant</a>. |
| 197 | An optional prefix sets a non-decimal base: <code>0</code> for octal, <code>0x</code> or |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 198 | <code>0X</code> for hexadecimal. In hexadecimal literals, letters |
| 199 | <code>a-f</code> and <code>A-F</code> represent values 10 through 15. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 200 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 201 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 202 | int_lit = decimal_lit | octal_lit | hex_lit . |
| 203 | decimal_lit = ( "1" ... "9" ) { decimal_digit } . |
| 204 | octal_lit = "0" { octal_digit } . |
| 205 | hex_lit = "0" ( "x" | "X" ) hex_digit { hex_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 206 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 207 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 208 | <pre> |
| 209 | 42 |
| 210 | 0600 |
| 211 | 0xBadFace |
| 212 | 170141183460469231731687303715884105727 |
| 213 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 214 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 215 | <h3 id="Floating-point_literals">Floating-point literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 216 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 217 | A floating-point literal is a decimal representation of a |
| 218 | <a href="#Constants">floating-point constant</a>. |
| 219 | It has an integer part, a decimal point, a fractional part, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 220 | and an exponent part. The integer and fractional part comprise |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 221 | decimal digits; the exponent part is an <code>e</code> or <code>E</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 222 | followed by an optionally signed decimal exponent. One of the |
| 223 | integer part or the fractional part may be elided; one of the decimal |
| 224 | point or the exponent may be elided. |
| 225 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 226 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 227 | float_lit = decimals "." [ decimals ] [ exponent ] | |
| 228 | decimals exponent | |
| 229 | "." decimals [ exponent ] . |
| 230 | decimals = decimal_digit { decimal_digit } . |
| 231 | exponent = ( "e" | "E" ) [ "+" | "-" ] decimals . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 232 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 233 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 234 | <pre> |
| 235 | 0. |
| 236 | 2.71828 |
| 237 | 1.e+0 |
| 238 | 6.67428e-11 |
| 239 | 1E6 |
| 240 | .25 |
| 241 | .12345E+5 |
| 242 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 243 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 244 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 245 | <h3 id="Character_literals">Character literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 246 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 247 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 248 | A character literal represents an <a href="#Constants">integer constant</a>, |
| 249 | typically a Unicode code point, as one or more characters enclosed in single |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 250 | quotes. Within the quotes, any character may appear except single |
| 251 | quote and newline. A single quoted character represents itself, |
| 252 | while multi-character sequences beginning with a backslash encode |
| 253 | values in various formats. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 254 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 255 | <p> |
| 256 | The simplest form represents the single character within the quotes; |
| 257 | since Go source text is Unicode characters encoded in UTF-8, multiple |
| 258 | UTF-8-encoded bytes may represent a single integer value. For |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 259 | instance, the literal <code>'a'</code> holds a single byte representing |
| 260 | a literal <code>a</code>, Unicode U+0061, value <code>0x61</code>, while |
| 261 | <code>'ä'</code> holds two bytes (<code>0xc3</code> <code>0xa4</code>) representing |
| 262 | a literal <code>a</code>-dieresis, U+00E4, value <code>0xe4</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 263 | </p> |
| 264 | <p> |
| 265 | Several backslash escapes allow arbitrary values to be represented |
| 266 | as ASCII text. There are four ways to represent the integer value |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 267 | as a numeric constant: <code>\x</code> followed by exactly two hexadecimal |
| 268 | digits; <code>\u</code> followed by exactly four hexadecimal digits; |
| 269 | <code>\U</code> followed by exactly eight hexadecimal digits, and a |
| 270 | plain backslash <code>\</code> followed by exactly three octal digits. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 271 | In each case the value of the literal is the value represented by |
| 272 | the digits in the corresponding base. |
| 273 | </p> |
| 274 | <p> |
| 275 | Although these representations all result in an integer, they have |
| 276 | different valid ranges. Octal escapes must represent a value between |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 277 | 0 and 255 inclusive. Hexadecimal escapes satisfy this condition |
| 278 | by construction. The escapes <code>\u</code> and <code>\U</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 279 | represent Unicode code points so within them some values are illegal, |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 280 | in particular those above <code>0x10FFFF</code> and surrogate halves. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 281 | </p> |
| 282 | <p> |
| 283 | After a backslash, certain single-character escapes represent special values: |
| 284 | </p> |
| 285 | <pre class="grammar"> |
| 286 | \a U+0007 alert or bell |
| 287 | \b U+0008 backspace |
| 288 | \f U+000C form feed |
| 289 | \n U+000A line feed or newline |
| 290 | \r U+000D carriage return |
| 291 | \t U+0009 horizontal tab |
| 292 | \v U+000b vertical tab |
| 293 | \\ U+005c backslash |
| 294 | \' U+0027 single quote (valid escape only within character literals) |
| 295 | \" U+0022 double quote (valid escape only within string literals) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 296 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 297 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 298 | All other sequences are illegal inside character literals. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 299 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 300 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 301 | char_lit = "'" ( unicode_value | byte_value ) "'" . |
| 302 | unicode_value = unicode_char | little_u_value | big_u_value | escaped_char . |
| 303 | byte_value = octal_byte_value | hex_byte_value . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 304 | octal_byte_value = `\` octal_digit octal_digit octal_digit . |
| 305 | hex_byte_value = `\` "x" hex_digit hex_digit . |
| 306 | little_u_value = `\` "u" hex_digit hex_digit hex_digit hex_digit . |
| 307 | big_u_value = `\` "U" hex_digit hex_digit hex_digit hex_digit |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 308 | hex_digit hex_digit hex_digit hex_digit . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 309 | escaped_char = `\` ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | `\` | "'" | `"` ) . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 310 | </pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 311 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 312 | <pre> |
| 313 | 'a' |
| 314 | 'ä' |
| 315 | '本' |
| 316 | '\t' |
| 317 | '\000' |
| 318 | '\007' |
| 319 | '\377' |
| 320 | '\x07' |
| 321 | '\xff' |
| 322 | '\u12e4' |
| 323 | '\U00101234' |
| 324 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 325 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 326 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 327 | <h3 id="String_literals">String literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 328 | |
| 329 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 330 | A string literal represents a <a href="#Constants">string constant</a> |
| 331 | obtained from concatenating a sequence of characters. There are two forms: |
| 332 | raw string literals and interpreted string literals. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 333 | </p> |
| 334 | <p> |
| 335 | Raw string literals are character sequences between back quotes |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 336 | <code>``</code>. Within the quotes, any character is legal except |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 337 | back quote. The value of a raw string literal is the |
| 338 | string composed of the uninterpreted characters between the quotes; |
| 339 | in particular, backslashes have no special meaning and the string may |
| 340 | span multiple lines. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 341 | </p> |
| 342 | <p> |
| 343 | Interpreted string literals are character sequences between double |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 344 | quotes <code>""</code>. The text between the quotes forms the |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 345 | value of the literal, with backslash escapes interpreted as they |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 346 | are in character literals (except that <code>\'</code> is illegal and |
| 347 | <code>\"</code> is legal). The three-digit octal (<code>\000</code>) |
| 348 | and two-digit hexadecimal (<code>\x00</code>) escapes represent individual |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 349 | <i>bytes</i> of the resulting string; all other escapes represent |
| 350 | the (possibly multi-byte) UTF-8 encoding of individual <i>characters</i>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 351 | Thus inside a string literal <code>\377</code> and <code>\xFF</code> represent |
| 352 | a single byte of value <code>0xFF</code>=255, while <code>ÿ</code>, |
| 353 | <code>\u00FF</code>, <code>\U000000FF</code> and <code>\xc3\xbf</code> represent |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 354 | the two bytes <code>0xc3</code> <code>0xbf</code> of the UTF-8 encoding of character |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 355 | U+00FF. |
| 356 | </p> |
| 357 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 358 | <p> |
| 359 | A sequence of string literals is concatenated to form a single string. |
| 360 | </p> |
| 361 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 362 | <pre class="ebnf"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 363 | StringLit = string_lit { string_lit } . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 364 | string_lit = raw_string_lit | interpreted_string_lit . |
| 365 | raw_string_lit = "`" { unicode_char } "`" . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 366 | interpreted_string_lit = `"` { unicode_value | byte_value } `"` . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 367 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 368 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 369 | <pre> |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 370 | `abc` // same as "abc" |
| 371 | `\n |
| 372 | \n` // same as "\\n\n\\n" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 373 | "\n" |
| 374 | "" |
| 375 | "Hello, world!\n" |
| 376 | "日本語" |
| 377 | "\u65e5本\U00008a9e" |
| 378 | "\xff\u00FF" |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 379 | "Alea iacta est." |
| 380 | "Alea " /* The die */ `iacta est` /* is cast */ "." // same as "Alea iacta est." |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 381 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 382 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 383 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 384 | These examples all represent the same string: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 385 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 386 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 387 | <pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 388 | "日本語" // UTF-8 input text |
| 389 | `日本語` // UTF-8 input text as a raw literal |
| 390 | "\u65e5\u672c\u8a9e" // The explicit Unicode code points |
| 391 | "\U000065e5\U0000672c\U00008a9e" // The explicit Unicode code points |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 392 | "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e" // The explicit UTF-8 bytes |
| 393 | </pre> |
Robert Griesemer | cd49927 | 2008-09-29 12:09:00 -0700 | [diff] [blame] | 394 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 395 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 396 | If the source code represents a character as two code points, such as |
| 397 | a combining form involving an accent and a letter, the result will be |
| 398 | an error if placed in a character literal (it is not a single code |
| 399 | point), and will appear as two code points if placed in a string |
| 400 | literal. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 401 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 402 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 403 | |
| 404 | <h2 id="Constants">Constants</h2> |
| 405 | |
| 406 | <p>There are <i>boolean constants</i>, <i>integer constants</i>, <i>floating-point constants</i>, |
| 407 | and <i>string constants</i>. Integer and floating-point constants are |
| 408 | collectively called <i>numeric constants</i>. |
| 409 | </p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 410 | |
| 411 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 412 | A constant value is represented by an |
| 413 | <a href="#Integer_literals">integer</a>, |
| 414 | <a href="#Floating-point_literals">floating-point</a>, |
| 415 | <a href="#Character_literals">character</a>, or |
| 416 | <a href="#String_literals">string</a> literal, |
| 417 | an identifier denoting a constant, |
| 418 | a <a href="#Constant_expressions">constant expression</a>, or |
| 419 | the result value of some built-in functions such as <code>unsafe.Sizeof</code> |
| 420 | and <code>cap</code> or <code>len</code> applied to an array, |
| 421 | or <code>len</code> applied to a string constant. |
| 422 | The boolean truth values are represented by the predeclared constants |
| 423 | <code>true</code> and <code>false</code>. The predeclared identifier |
| 424 | <a href="#Iota">iota</a> denotes an integer constant. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 425 | </p> |
| 426 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 427 | <p> |
| 428 | Numeric constants represent values of arbitrary precision that |
| 429 | have no size and cannot overflow. |
| 430 | </p> |
| 431 | |
| 432 | <p> |
| 433 | Constants may be <a href="#Types">typed</a> or untyped. |
| 434 | Literal constants, <code>true</code>, <code>false</code>, <code>iota</code>, |
| 435 | and certain <a href="#Constant_expressions">constant expressions</a> |
| 436 | containing only untyped constant operands are untyped. |
| 437 | </p> |
| 438 | |
| 439 | <p> |
| 440 | A constant may be given a type explicitly by a <a href="#Constant_declarations">constant declaration</a> |
| 441 | or <a href="#Conversions">conversion</a>, or implicitly when used in a |
| 442 | <a href="#Variable_declarations">variable declaration</a> or an |
| 443 | <a href="#Assignments">assignment</a> or as an |
| 444 | operand in an <a href="#Expressions">expression</a>. |
| 445 | It is an error if the constant value |
| 446 | cannot be accurately represented as a value of the respective type. |
| 447 | For instance, <code>3.0</code> can be given any integer type but also any |
| 448 | floating-point type, while <code>-1e12</code> can be given the types |
| 449 | <code>float32</code>, <code>float64</code>, or even <code>int64</code> but |
| 450 | not <code>uint64</code> or <code>string</code>. |
| 451 | </p> |
| 452 | |
| 453 | <p> |
| 454 | Implementation restriction: A compiler may implement numeric constants by choosing |
| 455 | an internal representation with at least twice as many bits as any machine type; |
| 456 | for floating-point values, both the mantissa and exponent must be twice as large. |
| 457 | </p> |
| 458 | |
| 459 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 460 | <h2 id="Types">Types</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 461 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 462 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 463 | A type determines the set of values and operations specific to values of that |
| 464 | type. A type may be specified by a (possibly qualified) <i>type name</i> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 465 | (§<a href="#Qualified_identifier">Qualified identifier</a>, §<a href="#Type_declarations">Type declarations</a>) or a <i>type literal</i>, |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 466 | which composes a new type from previously declared types. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 467 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 468 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 469 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 470 | Type = TypeName | TypeLit | "(" Type ")" . |
| 471 | TypeName = QualifiedIdent. |
| 472 | TypeLit = ArrayType | StructType | PointerType | FunctionType | InterfaceType | |
| 473 | SliceType | MapType | ChannelType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 474 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 475 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 476 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 477 | Named instances of the boolean, numeric, and string types are |
| 478 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 479 | <i>Composite types</i>—array, struct, pointer, function, |
| 480 | interface, slice, map, and channel types—may be constructed using |
| 481 | type literals. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 482 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 483 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 484 | <p> |
Robert Griesemer | 3b576a7 | 2009-06-17 14:31:33 -0700 | [diff] [blame] | 485 | A type may have a <i>method set</i> associated with it |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 486 | (§<a href="#Interface_types">Interface types</a>, §<a href="#Method_declarations">Method declarations</a>). |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 487 | The method set of an <a href="#Interface_types">interface type</a> is its interface. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 488 | The method set of any other named type <code>T</code> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 489 | consists of all methods with receiver type <code>T</code>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 490 | The method set of the corresponding pointer type <code>*T</code> |
| 491 | is the set of all methods with receiver <code>*T</code> or <code>T</code> |
| 492 | (that is, it also contains the method set of <code>T</code>). |
| 493 | Any other type has an empty method set. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 494 | In a method set, each method must have a unique name. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 495 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 496 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 497 | The <i>static type</i> (or just <i>type</i>) of a variable is the |
| 498 | type defined by its declaration. Variables of interface type |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 499 | also have a distinct <i>dynamic type</i>, which |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 500 | is the actual type of the value stored in the variable at run-time. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 501 | The dynamic type may vary during execution but is always assignment compatible |
| 502 | to the static type of the interface variable. For non-interface |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 503 | types, the dynamic type is always the static type. |
| 504 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 505 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 506 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 507 | <h3 id="Boolean_types">Boolean types</h3> |
| 508 | |
| 509 | A <i>boolean type</i> represents the set of Boolean truth values |
| 510 | denoted by the predeclared constants <code>true</code> |
| 511 | and <code>false</code>. The predeclared boolean type is <code>bool</code>. |
| 512 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 513 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 514 | <h3 id="Numeric_types">Numeric types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 515 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 516 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 517 | A <i>numeric type</i> represents sets of integer or floating-point values. |
| 518 | The predeclared architecture-independent numeric types are: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 519 | </p> |
Robert Griesemer | ebf14c6 | 2008-10-30 14:50:23 -0700 | [diff] [blame] | 520 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 521 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 522 | uint8 the set of all unsigned 8-bit integers (0 to 255) |
| 523 | uint16 the set of all unsigned 16-bit integers (0 to 65535) |
| 524 | uint32 the set of all unsigned 32-bit integers (0 to 4294967295) |
| 525 | uint64 the set of all unsigned 64-bit integers (0 to 18446744073709551615) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 526 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 527 | int8 the set of all signed 8-bit integers (-128 to 127) |
| 528 | int16 the set of all signed 16-bit integers (-32768 to 32767) |
| 529 | int32 the set of all signed 32-bit integers (-2147483648 to 2147483647) |
| 530 | int64 the set of all signed 64-bit integers (-9223372036854775808 to 9223372036854775807) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 531 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 532 | float32 the set of all IEEE-754 32-bit floating-point numbers |
| 533 | float64 the set of all IEEE-754 64-bit floating-point numbers |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 534 | |
| 535 | byte familiar alias for uint8 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 536 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 537 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 538 | <p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 539 | Integer types are represented in the usual binary format; the value of |
| 540 | an n-bit integer is n bits wide. A negative signed integer is represented |
| 541 | as the two's complement of its absolute value. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 542 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 543 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 544 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 545 | There is also a set of predeclared numeric types with implementation-specific sizes: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 546 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 547 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 548 | <pre class="grammar"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 549 | uint either 32 or 64 bits |
| 550 | int either 32 or 64 bits |
| 551 | float either 32 or 64 bits |
| 552 | uintptr an unsigned integer large enough to store the uninterpreted bits of a pointer value |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 553 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 554 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 555 | <p> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 556 | To avoid portability issues all numeric types are distinct except |
| 557 | <code>byte</code>, which is an alias for <code>uint8</code>. |
| 558 | Conversions |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 559 | are required when incompatible numeric types are mixed in an expression |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 560 | or assignment. For instance, <code>int32</code> and <code>int</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 561 | are not the same type even though they may have the same size on a |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 562 | particular architecture. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 563 | |
| 564 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 565 | <h3 id="String_types">String types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 566 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 567 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 568 | A <i>string type</i> represents the set of string values. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 569 | Strings behave like arrays of bytes but are immutable: once created, |
| 570 | it is impossible to change the contents of a string. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 571 | The predeclared string type is <code>string</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 572 | |
| 573 | <p> |
| 574 | The elements of strings have type <code>byte</code> and may be |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 575 | accessed using the usual <a href="#Indexes">indexing operations</a>. It is |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 576 | illegal to take the address of such an element; if |
| 577 | <code>s[i]</code> is the <i>i</i>th byte of a |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 578 | string, <code>&s[i]</code> is invalid. The length of string |
| 579 | <code>s</code> can be discovered using the built-in function |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 580 | <code>len</code>. The length is a compile-time constant if <code>s</code> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 581 | is a string literal. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 582 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 583 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 584 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 585 | <h3 id="Array_types">Array types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 586 | |
| 587 | <p> |
| 588 | An array is a numbered sequence of elements of a single |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 589 | type, called the element type. |
| 590 | The number of elements is called the length and is never |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 591 | negative. |
| 592 | </p> |
| 593 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 594 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 595 | ArrayType = "[" ArrayLength "]" ElementType . |
| 596 | ArrayLength = Expression . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 597 | ElementType = Type . |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 598 | </pre> |
| 599 | |
| 600 | <p> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 601 | The length is part of the array's type and must must be a |
| 602 | <a href="#Constant_expressions">constant expression</a> that evaluates to a non-negative |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 603 | integer value. The length of array <code>a</code> can be discovered |
| 604 | using the built-in function <code>len(a)</code>, which is a |
| 605 | compile-time constant. The elements can be indexed by integer |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 606 | indices 0 through the <code>len(a)-1</code> (§<a href="#Indexes">Indexes</a>). |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 607 | </p> |
| 608 | |
| 609 | <pre> |
| 610 | [32]byte |
| 611 | [2*N] struct { x, y int32 } |
| 612 | [1000]*float64 |
| 613 | </pre> |
| 614 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 615 | <h3 id="Slice_types">Slice types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 616 | |
| 617 | <p> |
| 618 | A slice is a reference to a contiguous segment of an array and |
| 619 | contains a numbered sequence of elements from that array. A slice |
| 620 | type denotes the set of all slices of arrays of its element type. |
| 621 | A slice value may be <code>nil</code>. |
| 622 | </p> |
| 623 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 624 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 625 | SliceType = "[" "]" ElementType . |
| 626 | </pre> |
| 627 | |
| 628 | <p> |
| 629 | Like arrays, slices are indexable and have a length. The length of a |
| 630 | slice <code>s</code> can be discovered by the built-in function |
| 631 | <code>len(s)</code>; unlike with arrays it may change during |
| 632 | execution. The elements can be addressed by integer indices 0 |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 633 | through <code>len(s)-1</code> (§<a href="#Indexes">Indexes</a>). The slice index of a |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 634 | given element may be less than the index of the same element in the |
| 635 | underlying array. |
| 636 | </p> |
| 637 | <p> |
| 638 | A slice, once initialized, is always associated with an underlying |
| 639 | array that holds its elements. A slice therfore shares storage |
| 640 | with its array and with other slices of the same array; by contrast, |
| 641 | distinct arrays always represent distinct storage. |
| 642 | </p> |
| 643 | <p> |
| 644 | The array underlying a slice may extend past the end of the slice. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 645 | The <i>capacity</i> is a measure of that extent: it is the sum of |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 646 | the length of the slice and the length of the array beyond the slice; |
| 647 | a slice of length up to that capacity can be created by `slicing' a new |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 648 | one from the original slice (§<a href="#Slices">Slices</a>). |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 649 | The capacity of a slice <code>a</code> can be discovered using the |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 650 | built-in function <code>cap(a)</code> and the relationship between |
| 651 | <code>len()</code> and <code>cap()</code> is: |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 652 | </p> |
| 653 | |
| 654 | <pre> |
| 655 | 0 <= len(a) <= cap(a) |
| 656 | </pre> |
| 657 | |
| 658 | <p> |
| 659 | The value of an uninitialized slice is <code>nil</code>. |
| 660 | The length and capacity of a <code>nil</code> slice |
| 661 | are 0. A new, initialized slice value for a given element type <code>T</code> is |
| 662 | made using the built-in function <code>make</code>, which takes a slice type |
| 663 | and parameters specifying the length and optionally the capacity: |
| 664 | </p> |
| 665 | |
| 666 | <pre> |
| 667 | make([]T, length) |
| 668 | make([]T, length, capacity) |
| 669 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 670 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 671 | <p> |
| 672 | The <code>make()</code> call allocates a new, hidden array to which the returned |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 673 | slice value refers. That is, executing |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 674 | </p> |
| 675 | |
| 676 | <pre> |
| 677 | make([]T, length, capacity) |
| 678 | </pre> |
| 679 | |
| 680 | <p> |
| 681 | produces the same slice as allocating an array and slicing it, so these two examples |
| 682 | result in the same slice: |
| 683 | </p> |
| 684 | |
| 685 | <pre> |
| 686 | make([]int, 50, 100) |
| 687 | new([100]int)[0:50] |
| 688 | </pre> |
| 689 | |
| 690 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 691 | <h3 id="Struct_types">Struct types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 692 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 693 | <p> |
| 694 | A struct is a sequence of named |
| 695 | elements, called fields, with various types. A struct type declares |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 696 | an identifier and type for each field. Within a struct, non-<a href="#Blank_identifier">blank</a> |
| 697 | field identifiers must be unique. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 698 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 699 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 700 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 701 | StructType = "struct" "{" [ FieldDeclList ] "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 702 | FieldDeclList = FieldDecl { ";" FieldDecl } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 703 | FieldDecl = (IdentifierList Type | [ "*" ] TypeName) [ Tag ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 704 | Tag = StringLit . |
| 705 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 706 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 707 | <pre> |
| 708 | // An empty struct. |
| 709 | struct {} |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 710 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 711 | // A struct with 6 fields. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 712 | struct { |
| 713 | x, y int; |
| 714 | u float; |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 715 | _ float; // padding |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 716 | A *[]int; |
| 717 | F func(); |
| 718 | } |
| 719 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 720 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 721 | <p> |
| 722 | A field declared with a type but no field identifier is an <i>anonymous field</i>. |
| 723 | Such a field type must be specified as |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 724 | a type name <code>T</code> or as a pointer to a type name <code>*T</code>, |
Ian Lance Taylor | 3e804ba | 2009-08-17 11:40:57 -0700 | [diff] [blame] | 725 | and <code>T</code> itself may not be |
| 726 | a pointer type. The unqualified type name acts as the field identifier. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 727 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 728 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 729 | <pre> |
| 730 | // A struct with four anonymous fields of type T1, *T2, P.T3 and *P.T4 |
| 731 | struct { |
| 732 | T1; // the field name is T1 |
| 733 | *T2; // the field name is T2 |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 734 | P.T3; // the field name is T3 |
| 735 | *P.T4; // the field name is T4 |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 736 | x, y int; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 737 | } |
| 738 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 739 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 740 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 741 | The unqualified type name of an anonymous field must be distinct from the |
| 742 | field identifier (or unqualified type name for an anonymous field) of every |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 743 | other field within the struct. The following declaration is illegal: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 744 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 745 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 746 | <pre> |
| 747 | struct { |
| 748 | T; // conflicts with anonymous field *T and *P.T |
| 749 | *T; // conflicts with anonymous field T and *P.T |
| 750 | *P.T; // conflicts with anonymous field T and *T |
| 751 | } |
| 752 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 753 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 754 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 755 | Fields and methods (§<a href="#Method_declarations">Method declarations</a>) of an anonymous field are |
| 756 | promoted to be ordinary fields and methods of the struct (§<a href="#Selectors">Selectors</a>). |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 757 | The following rules apply for a struct type named <code>S</code> and |
| 758 | a type named <code>T</code>: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 759 | </p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 760 | <ul> |
| 761 | <li>If <code>S</code> contains an anonymous field <code>T</code>, the |
| 762 | method set of <code>S</code> includes the method set of <code>T</code>. |
| 763 | </li> |
| 764 | |
| 765 | <li>If <code>S</code> contains an anonymous field <code>*T</code>, the |
| 766 | method set of <code>S</code> includes the method set of <code>*T</code> |
| 767 | (which itself includes the method set of <code>T</code>). |
| 768 | </li> |
| 769 | |
| 770 | <li>If <code>S</code> contains an anonymous field <code>T</code> or |
| 771 | <code>*T</code>, the method set of <code>*S</code> includes the |
| 772 | method set of <code>*T</code> (which itself includes the method |
| 773 | set of <code>T</code>). |
| 774 | </li> |
| 775 | </ul> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 776 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 777 | A field declaration may be followed by an optional string literal <i>tag</i>, |
| 778 | which becomes an attribute for all the identifiers in the corresponding |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 779 | field declaration. The tags are made |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 780 | visible through a <a href="#Package_unsafe">reflection interface</a> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 781 | but are otherwise ignored. |
| 782 | </p> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 783 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 784 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 785 | // A struct corresponding to the TimeStamp protocol buffer. |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 786 | // The tag strings define the protocol buffer field numbers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 787 | struct { |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 788 | microsec uint64 "field 1"; |
| 789 | serverIP6 uint64 "field 2"; |
| 790 | process string "field 3"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 791 | } |
| 792 | </pre> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 793 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 794 | <h3 id="Pointer_types">Pointer types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 795 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 796 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 797 | A pointer type denotes the set of all pointers to variables of a given |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 798 | type, called the <i>base type</i> of the pointer. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 799 | A pointer value may be <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 800 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 801 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 802 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 803 | PointerType = "*" BaseType . |
| 804 | BaseType = Type . |
| 805 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 806 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 807 | <pre> |
| 808 | *int |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 809 | *map[string] *chan int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 810 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 811 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 812 | <h3 id="Function_types">Function types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 813 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 814 | <p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 815 | A function type denotes the set of all functions with the same parameter |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 816 | and result types. |
| 817 | A function value may be <code>nil</code>. |
| 818 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 819 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 820 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 821 | FunctionType = "func" Signature . |
| 822 | Signature = Parameters [ Result ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 823 | Result = Parameters | Type . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 824 | Parameters = "(" [ ParameterList ] ")" . |
| 825 | ParameterList = ParameterDecl { "," ParameterDecl } . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 826 | ParameterDecl = [ IdentifierList ] ( Type | "..." ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 827 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 828 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 829 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 830 | Within a list of parameters or results, the names (IdentifierList) |
| 831 | must either all be present or all be absent. If present, each name |
| 832 | stands for one item (parameter or result) of the specified type; if absent, each |
| 833 | type stands for one item of that type. Parameter and result |
| 834 | lists are always parenthesized except that if there is exactly |
| 835 | one unnamed result that is not a function type it may writen as an unparenthesized type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 836 | </p> |
| 837 | <p> |
| 838 | For the last parameter only, instead of a type one may write |
| 839 | <code>...</code> to indicate that the function may be invoked with |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 840 | zero or more additional arguments of any |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 841 | type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 842 | </p> |
Robert Griesemer | 2bfa957 | 2008-10-24 13:13:12 -0700 | [diff] [blame] | 843 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 844 | <pre> |
| 845 | func () |
| 846 | func (x int) |
| 847 | func () int |
| 848 | func (string, float, ...) |
| 849 | func (a, b int, z float) bool |
| 850 | func (a, b int, z float) (bool) |
| 851 | func (a, b int, z float, opt ...) (success bool) |
| 852 | func (int, int, float) (float, *[]int) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 853 | func (n int) (func (p* T)) |
| 854 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 855 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 856 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 857 | <h3 id="Interface_types">Interface types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 858 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 859 | <p> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 860 | An interface type specifies a <a href="#Types">method set</a> called its <i>interface</i>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 861 | A variable of interface type can store a value of any type with a method set |
| 862 | that is any superset of the interface. Such a type is said to |
| 863 | <i>implement the interface</i>. An interface value may be <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 864 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 865 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 866 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 867 | InterfaceType = "interface" "{" [ MethodSpecList ] "}" . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 868 | MethodSpecList = MethodSpec { ";" MethodSpec } [ ";" ] . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 869 | MethodSpec = MethodName Signature | InterfaceTypeName . |
| 870 | MethodName = identifier . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 871 | InterfaceTypeName = TypeName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 872 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 873 | |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 874 | <p> |
| 875 | As with all method sets, in an interface type, each method must have a unique name. |
| 876 | </p> |
| 877 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 878 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 879 | // A simple File interface |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 880 | interface { |
Russ Cox | 13dac65 | 2009-09-28 14:16:33 -0700 | [diff] [blame] | 881 | Read(b Buffer) bool; |
| 882 | Write(b Buffer) bool; |
| 883 | Close(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 884 | } |
| 885 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 886 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 887 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 888 | More than one type may implement an interface. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 889 | For instance, if two types <code>S1</code> and <code>S2</code> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 890 | have the method set |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 891 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 892 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 893 | <pre> |
| 894 | func (p T) Read(b Buffer) bool { return ... } |
| 895 | func (p T) Write(b Buffer) bool { return ... } |
| 896 | func (p T) Close() { ... } |
| 897 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 898 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 899 | <p> |
| 900 | (where <code>T</code> stands for either <code>S1</code> or <code>S2</code>) |
| 901 | then the <code>File</code> interface is implemented by both <code>S1</code> and |
| 902 | <code>S2</code>, regardless of what other methods |
| 903 | <code>S1</code> and <code>S2</code> may have or share. |
| 904 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 905 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 906 | <p> |
| 907 | A type implements any interface comprising any subset of its methods |
| 908 | and may therefore implement several distinct interfaces. For |
| 909 | instance, all types implement the <i>empty interface</i>: |
| 910 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 911 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 912 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 913 | interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 914 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 915 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 916 | <p> |
| 917 | Similarly, consider this interface specification, |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 918 | which appears within a <a href="#Type_declarations">type declaration</a> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 919 | to define an interface called <code>Lock</code>: |
| 920 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 921 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 922 | <pre> |
| 923 | type Lock interface { |
Russ Cox | 13dac65 | 2009-09-28 14:16:33 -0700 | [diff] [blame] | 924 | Lock(); |
| 925 | Unlock(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 926 | } |
| 927 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 928 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 929 | <p> |
| 930 | If <code>S1</code> and <code>S2</code> also implement |
| 931 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 932 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 933 | <pre> |
| 934 | func (p T) Lock() { ... } |
| 935 | func (p T) Unlock() { ... } |
| 936 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 937 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 938 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 939 | they implement the <code>Lock</code> interface as well |
| 940 | as the <code>File</code> interface. |
| 941 | </p> |
| 942 | <p> |
| 943 | An interface may contain an interface type name <code>T</code> |
| 944 | in place of a method specification. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 945 | The effect is equivalent to enumerating the methods of <code>T</code> explicitly |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 946 | in the interface. |
| 947 | </p> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 948 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 949 | <pre> |
| 950 | type ReadWrite interface { |
Russ Cox | 13dac65 | 2009-09-28 14:16:33 -0700 | [diff] [blame] | 951 | Read(b Buffer) bool; |
| 952 | Write(b Buffer) bool; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 953 | } |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 954 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 955 | type File interface { |
| 956 | ReadWrite; // same as enumerating the methods in ReadWrite |
| 957 | Lock; // same as enumerating the methods in Lock |
| 958 | Close(); |
| 959 | } |
| 960 | </pre> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 961 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 962 | <h3 id="Map_types">Map types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 963 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 964 | <p> |
| 965 | A map is an unordered group of elements of one type, called the |
| 966 | value type, indexed by a set of unique <i>keys</i> of another type, |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 967 | called the key type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 968 | A map value may be <code>nil</code>. |
| 969 | |
| 970 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 971 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 972 | <pre class="ebnf"> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 973 | MapType = "map" "[" KeyType "]" ElementType . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 974 | KeyType = Type . |
| 975 | ValueType = Type . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 976 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 977 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 978 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 979 | The comparison operators <code>==</code> and <code>!=</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 980 | (§<a href="#Comparison_operators">Comparison operators</a>) must be fully defined for operands of the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 981 | key type; thus the key type must be a boolean, numeric, string, pointer, function, interface, |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 982 | map, or channel type. If the key type is an interface type, these |
| 983 | comparison operators must be defined for the dynamic key values; |
| 984 | failure will cause a run-time error. |
| 985 | |
| 986 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 987 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 988 | <pre> |
| 989 | map [string] int |
| 990 | map [*T] struct { x, y float } |
| 991 | map [string] interface {} |
| 992 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 993 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 994 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 995 | The number of elements is called the length and is never negative. |
| 996 | The length of a map <code>m</code> can be discovered using the |
| 997 | built-in function <code>len(m)</code> and may change during execution. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 998 | Values may be added and removed |
| 999 | during execution using special forms of <a href="#Assignments">assignment</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1000 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1001 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1002 | The value of an uninitialized map is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1003 | A new, empty map value is made using the built-in |
| 1004 | function <code>make</code>, which takes the map type and an optional |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1005 | capacity hint as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1006 | </p> |
| 1007 | |
| 1008 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1009 | make(map[string] int) |
| 1010 | make(map[string] int, 100) |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1011 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1012 | |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1013 | <p> |
| 1014 | The initial capacity does not bound its size: |
| 1015 | maps grow to accommodate the number of items |
| 1016 | stored in them. |
| 1017 | </p> |
| 1018 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1019 | <h3 id="Channel_types">Channel types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1020 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1021 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1022 | A channel provides a mechanism for two concurrently executing functions |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1023 | to synchronize execution and communicate by passing a value of a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1024 | specified element type. |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 1025 | A value of channel type may be <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1026 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1027 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1028 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1029 | ChannelType = Channel | SendChannel | RecvChannel . |
| 1030 | Channel = "chan" ValueType . |
| 1031 | SendChannel = "chan" "<-" ValueType . |
| 1032 | RecvChannel = "<-" "chan" ValueType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1033 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1034 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1035 | <p> |
| 1036 | Upon creation, a channel can be used both to send and to receive values. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1037 | By conversion or assignment, a channel may be constrained only to send or |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1038 | to receive. This constraint is called a channel's <i>direction</i>; either |
| 1039 | <i>send</i>, <i>receive</i>, or <i>bi-directional</i> (unconstrained). |
| 1040 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1041 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1042 | <pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 1043 | chan T // can be used to send and receive values of type T |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 1044 | chan<- float // can only be used to send floats |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 1045 | <-chan int // can only be used to receive ints |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1046 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1047 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1048 | <p> |
| 1049 | The value of an uninitialized channel is <code>nil</code>. A new, initialized channel |
| 1050 | value is made using the built-in function <code>make</code>, |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 1051 | which takes the channel type and an optional capacity as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1052 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1053 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1054 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1055 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1056 | make(chan int, 100) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1057 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1058 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1059 | <p> |
| 1060 | The capacity, in number of elements, sets the size of the buffer in the channel. If the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1061 | capacity is greater than zero, the channel is asynchronous: provided the |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1062 | buffer is not full, sends can succeed without blocking. If the capacity is zero |
| 1063 | or absent, the communication succeeds only when both a sender and receiver are ready. |
| 1064 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1065 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1066 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 1067 | A channel may be closed and tested for closure with the built-in functions |
| 1068 | <a href="#Close_and_closed"><code>close</code> and <code>closed</code></a>. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1069 | </p> |
| 1070 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1071 | <h2 id="Properties_of_types_and_values">Properties of types and values</h2> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1072 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1073 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1074 | Two types are either <i>identical</i> or <i>different</i>, and they are |
| 1075 | either <i>compatible</i> or <i>incompatible</i>. |
| 1076 | Identical types are always compatible, but compatible types need not be identical. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1077 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1078 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1079 | <h3 id="Type_identity_and_compatibility">Type identity and compatibility</h3> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1080 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1081 | <h4 id="Type_identity">Type identity</h4> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1082 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1083 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1084 | Two named types are identical if their type names originate in the same |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1085 | type declaration (§<a href="#Declarations_and_scope">Declarations and scope</a>). A named and an unnamed type |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1086 | are never identical. Two unnamed types are identical if the corresponding |
| 1087 | type literals have the same literal structure and corresponding components have |
| 1088 | identical types. In detail: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1089 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1090 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1091 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1092 | <li>Two array types are identical if they have identical element types and |
| 1093 | the same array length.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1094 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1095 | <li>Two slice types are identical if they have identical element types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1096 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1097 | <li>Two struct types are identical if they have the same sequence of fields, |
| 1098 | and if corresponding fields have the same names and identical types. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1099 | Two anonymous fields are considered to have the same name.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1100 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1101 | <li>Two pointer types are identical if they have identical base types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1102 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1103 | <li>Two function types are identical if they have the same number of parameters |
| 1104 | and result values and if corresponding parameter and result types are |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1105 | identical. All "..." parameters are defined to have identical type. |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1106 | Parameter and result names are not required to match.</li> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1107 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1108 | <li>Two interface types are identical if they have the same set of methods |
| 1109 | with the same names and identical function types. The order |
| 1110 | of the methods is irrelevant.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1111 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1112 | <li>Two map types are identical if they have identical key and value types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1113 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1114 | <li>Two channel types are identical if they have identical value types and |
| 1115 | the same direction.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1116 | </ul> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1117 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1118 | <h4 id="Type_compatibility">Type compatibility</h4> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1119 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1120 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1121 | Type compatibility is less stringent than type identity: a named and an unnamed |
| 1122 | type are compatible if the respective type literals are compatible. |
| 1123 | In all other respects, the definition of type compatibility is the |
| 1124 | same as for type identity listed above but with ``compatible'' |
| 1125 | substituted for ``identical''. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1126 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1127 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1128 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1129 | Given the declarations |
| 1130 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1131 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1132 | <pre> |
| 1133 | type ( |
| 1134 | T0 []string; |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1135 | T1 []string; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1136 | T2 struct { a, b int }; |
| 1137 | T3 struct { a, c int }; |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1138 | T4 func (int, float) *T0; |
| 1139 | T5 func (x int, y float) *[]string; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1140 | ) |
| 1141 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1142 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1143 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1144 | these types are identical: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1145 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1146 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1147 | <pre> |
| 1148 | T0 and T0 |
| 1149 | []int and []int |
| 1150 | struct { a, b *T5 } and struct { a, b *T5 } |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1151 | func (x int, y float) *[]string and func (int, float) (result *[]string) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1152 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1153 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1154 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1155 | <code>T0</code> and <code>T1</code> are neither identical nor compatible |
| 1156 | because they are named types with distinct declarations. |
| 1157 | </p> |
| 1158 | |
| 1159 | <p> |
| 1160 | These types are compatible: |
| 1161 | </p> |
| 1162 | |
| 1163 | <pre> |
| 1164 | T0 and T0 |
| 1165 | T0 and []string |
| 1166 | T3 and struct { a int; c int } |
| 1167 | T4 and func (x int, y float) *[]string |
| 1168 | </pre> |
| 1169 | |
| 1170 | <p> |
| 1171 | <code>T2</code> and <code>struct { a, c int }</code> are incompatible because |
| 1172 | they have different field names. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1173 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1174 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1175 | <h3 id="Assignment_compatibility">Assignment compatibility</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1176 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1177 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1178 | A value <code>v</code> of static type <code>V</code> is <i>assignment compatible</i> |
| 1179 | with a type <code>T</code> if one of the following conditions applies: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1180 | </p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1181 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1182 | <ul> |
| 1183 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1184 | <code>V</code> is compatible with <code>T</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1185 | </li> |
| 1186 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1187 | <code>T</code> is an interface type and |
| 1188 | <code>V</code> <a href="#Interface_types">implements</a> <code>T</code>. |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 1189 | </li> |
| 1190 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1191 | <code>V</code> is a pointer to an array and <code>T</code> is a slice type |
| 1192 | with compatible element type and at least one of <code>V</code> or <code>T</code> is unnamed. |
| 1193 | After assignment, the slice variable refers to the original array; the elements are not |
| 1194 | copied. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1195 | </li> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1196 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1197 | <code>V</code> is a bidirectional channel and <code>T</code> is a channel type |
| 1198 | with compatible element type and at least one of <code>V</code> or <code>T</code> is unnamed. |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1199 | </li> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1200 | </ul> |
| 1201 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1202 | <p> |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 1203 | If <code>T</code> is a struct type, either all fields of <code>T</code> |
| 1204 | must be <a href="#Exported_identifiers">exported</a>, or the assignment must be in |
| 1205 | the same package in which <code>T</code> is declared. |
| 1206 | In other words, a struct value can be assigned to a struct variable only if |
| 1207 | every field of the struct may be legally assigned individually by the program. |
| 1208 | </p> |
| 1209 | |
| 1210 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1211 | An untyped <a href="#Constants">constant</a> <code>v</code> |
| 1212 | is assignment compatible with type <code>T</code> if <code>v</code> |
| 1213 | can be represented accurately as a value of type <code>T</code>. |
| 1214 | </p> |
| 1215 | |
| 1216 | <p> |
| 1217 | The predeclared identifier <code>nil</code> is assignment compatible with any |
| 1218 | pointer, function, slice, map, channel, or interface type and |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1219 | represents the <a href="#The_zero_value">zero value</a> for that type. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1220 | </p> |
| 1221 | |
| 1222 | <p> |
| 1223 | Any value may be assigned to the <a href="#Blank_identifier">blank identifier</a>. |
| 1224 | </p> |
| 1225 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1226 | <h3 id="Comparison_compatibility">Comparison compatibility</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1227 | |
| 1228 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1229 | Except as noted, values of any type may be compared to other values of |
| 1230 | <a href="#Type_compatibility">compatible static type</a>. |
| 1231 | Values of numeric and string type may be compared using the |
| 1232 | full range of <a href="#Comparison_operators;">comparison operators</a>; |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1233 | booleans may be compared only for equality or inequality. |
| 1234 | </p> |
| 1235 | |
| 1236 | <p> |
| 1237 | Values of composite type may be |
| 1238 | compared for equality or inequality using the <code>==</code> and |
| 1239 | <code>!=</code> operators, with the following provisos: |
| 1240 | </p> |
| 1241 | <ul> |
| 1242 | <li> |
| 1243 | Arrays and structs may not be compared to anything. |
| 1244 | </li> |
| 1245 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1246 | A slice value may only be compared explicitly against <code>nil</code>. |
| 1247 | A slice value is equal to <code>nil</code> if it has been assigned the explicit |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1248 | value <code>nil</code>, if it is uninitialized, or if it has |
| 1249 | been assigned another slice value equal to <code>nil</code>· |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1250 | </li> |
| 1251 | <li> |
| 1252 | Similarly, an interface value is equal to <code>nil</code> if it has |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1253 | been assigned the explicit value <code>nil</code>, if it is uninitialized, |
| 1254 | or if it has been assigned another interface value equal to <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1255 | </li> |
| 1256 | <li> |
| 1257 | For types that can be compared to <code>nil</code>, |
| 1258 | two values of the same type are equal if they both equal <code>nil</code>, |
| 1259 | unequal if one equals <code>nil</code> and one does not. |
| 1260 | </li> |
| 1261 | <li> |
| 1262 | Pointer values are equal if they point to the same location. |
| 1263 | </li> |
| 1264 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1265 | Function values are equal if they refer to the same function. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1266 | </li> |
| 1267 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1268 | Channel and map values are equal if they were created by the same call to <code>make</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1269 | (§<a href="#Making_slices">Making slices</a>, maps, and channels). |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1270 | When comparing two values of channel type, the channel value types |
| 1271 | must be compatible but the channel direction is ignored. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1272 | </li> |
| 1273 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1274 | Interface values may be compared if they have compatible static types. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1275 | They will be equal only if they have the same dynamic type and the underlying values are equal. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1276 | </li> |
| 1277 | </ul> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1278 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1279 | <h2 id="Blocks">Blocks</h2> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1280 | |
| 1281 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1282 | A <i>block</i> is a sequence of declarations and statements within matching |
| 1283 | brace brackets. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1284 | </p> |
| 1285 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1286 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1287 | Block = "{" StatementList "}" . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1288 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1289 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1290 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1291 | In addition to explicit blocks in the source code, there are implicit blocks: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1292 | </p> |
| 1293 | |
| 1294 | <ol> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1295 | <li>The <i>universe block</i> encompasses all Go source text.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1296 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1297 | <li>Each <a href="#Packages">package</a> has a <i>package block</i> containing all |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1298 | Go source text for that package.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1299 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1300 | <li>Each file has a <i>file block</i> containing all Go source text |
| 1301 | in that file.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1302 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1303 | <li>Each <code>if</code>, <code>for</code>, and <code>switch</code> |
| 1304 | statement is considered to be in its own implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1305 | |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1306 | <li>Each clause in a <code>switch</code> or <code>select</code> statement |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1307 | acts as an implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1308 | </ol> |
| 1309 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1310 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1311 | Blocks nest and influence <a href="#Declarations_and_scope">scoping</a>. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1312 | </p> |
| 1313 | |
| 1314 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1315 | <h2 id="Declarations_and_scope">Declarations and scope</h2> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1316 | |
| 1317 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1318 | A declaration binds a non-<a href="#Blank_identifier">blank</a> |
| 1319 | identifier to a constant, type, variable, function, or package. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1320 | Every identifier in a program must be declared. |
| 1321 | No identifier may be declared twice in the same block, and |
| 1322 | no identifier may be declared in both the file and package block. |
| 1323 | </p> |
| 1324 | |
| 1325 | <pre class="ebnf"> |
| 1326 | Declaration = ConstDecl | TypeDecl | VarDecl . |
| 1327 | TopLevelDecl = Declaration | FunctionDecl | MethodDecl . |
| 1328 | </pre> |
| 1329 | |
| 1330 | <p> |
| 1331 | The <i>scope</i> of a declared identifier is the extent of source text in which |
| 1332 | the identifier denotes the specified constant, type, variable, function, or package. |
| 1333 | </p> |
| 1334 | |
| 1335 | <p> |
| 1336 | Go is lexically scoped using blocks: |
| 1337 | </p> |
| 1338 | |
| 1339 | <ol> |
| 1340 | <li>The scope of a predeclared identifier is the universe block.</li> |
| 1341 | |
| 1342 | <li>The scope of an identifier denoting a constant, type, variable, |
| 1343 | or function declared at top level (outside any function) is the |
| 1344 | package block.</li> |
| 1345 | |
| 1346 | <li>The scope of an imported package identifier is the file block |
| 1347 | of the file containing the import declaration.</li> |
| 1348 | |
| 1349 | <li>The scope of an identifier denoting a function parameter or |
| 1350 | result variable is the function body.</li> |
| 1351 | |
| 1352 | <li>The scope of a constant or variable identifier declared |
| 1353 | inside a function begins at the end of the ConstSpec or VarSpec |
| 1354 | and ends at the end of the innermost containing block.</li> |
| 1355 | |
| 1356 | <li>The scope of a type identifier declared inside a function |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1357 | begins at the identifier in the TypeSpec |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1358 | and ends at the end of the innermost containing block.</li> |
| 1359 | </ol> |
| 1360 | |
| 1361 | <p> |
| 1362 | An identifier declared in a block may be redeclared in an inner block. |
| 1363 | While the identifier of the inner declaration is in scope, it denotes |
| 1364 | the entity declared by the inner declaration. |
| 1365 | </p> |
| 1366 | |
| 1367 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1368 | The <a href="#Package_clause">package clause</a> is not a declaration; the package name |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1369 | does not appear in any scope. Its purpose is to identify the files belonging |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1370 | to the same <a href="#Packages">package</a> and to specify the default package name for import |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1371 | declarations. |
| 1372 | </p> |
| 1373 | |
| 1374 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1375 | <h3 id="Label_scopes">Label scopes</h3> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1376 | |
| 1377 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1378 | Labels are declared by <a href="#Labeled_statements">labeled statements</a> and are |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1379 | used in the <code>break</code>, <code>continue</code>, and <code>goto</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1380 | statements (§<a href="#Break_statements">Break statements</a>, §<a href="#Continue_statements">Continue statements</a>, §<a href="#Goto_statements">Goto statements</a>). |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1381 | In contrast to other identifiers, labels are not block scoped and do |
| 1382 | not conflict with identifiers that are not labels. The scope of a label |
| 1383 | is the body of the function in which it is declared and excludes |
| 1384 | the body of any nested function. |
| 1385 | </p> |
| 1386 | |
| 1387 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1388 | <h3 id="Predeclared_identifiers">Predeclared identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1389 | |
| 1390 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1391 | The following identifiers are implicitly declared in the universe block: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1392 | </p> |
| 1393 | <pre class="grammar"> |
| 1394 | Basic types: |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1395 | bool byte float32 float64 int8 int16 int32 int64 |
| 1396 | string uint8 uint16 uint32 uint64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1397 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1398 | Architecture-specific convenience types: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1399 | float int uint uintptr |
| 1400 | |
| 1401 | Constants: |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1402 | true false iota |
| 1403 | |
| 1404 | Zero value: |
| 1405 | nil |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1406 | |
| 1407 | Functions: |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1408 | cap close closed len make new panic panicln print println |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1409 | </pre> |
| 1410 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1411 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1412 | <h3 id="Exported_identifiers">Exported identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1413 | |
| 1414 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1415 | An identifier may be <i>exported</i> to permit access to it from another package |
| 1416 | using a <a href="#Qualified_identifiers">qualified identifier</a>. An identifier |
| 1417 | is exported if both: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1418 | </p> |
| 1419 | <ol> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1420 | <li>the first character of the identifier's name is a Unicode upper case letter (Unicode class "Lu"); and |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1421 | <li>the identifier is declared in the <a href="#Blocks">package block</a> or denotes a field or method of a type |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1422 | declared in that block. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1423 | </ol> |
| 1424 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1425 | All other identifiers are not exported. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1426 | </p> |
| 1427 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1428 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1429 | <h3 id="Blank_identifier">Blank identifier</h3> |
| 1430 | |
| 1431 | <p> |
| 1432 | The <i>blank identifier</i>, represented by the underscore character <code>_</code>, may be used in a declaration like |
| 1433 | any other identifier but the declaration does not introduce a new binding. |
| 1434 | </p> |
| 1435 | |
| 1436 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1437 | <h3 id="Constant_declarations">Constant declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1438 | |
| 1439 | <p> |
| 1440 | A constant declaration binds a list of identifiers (the names of |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1441 | the constants) to the values of a list of <a href="#Constant_expressions">constant expressions</a>. |
| 1442 | The number of identifiers must be equal |
| 1443 | to the number of expressions, and the <i>n</i>th identifier on |
| 1444 | the left is bound to the value of the <i>n</i>th expression on the |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1445 | right. |
| 1446 | </p> |
| 1447 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1448 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1449 | ConstDecl = "const" ( ConstSpec | "(" [ ConstSpecList ] ")" ) . |
| 1450 | ConstSpecList = ConstSpec { ";" ConstSpec } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1451 | ConstSpec = IdentifierList [ [ Type ] "=" ExpressionList ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1452 | |
| 1453 | IdentifierList = identifier { "," identifier } . |
| 1454 | ExpressionList = Expression { "," Expression } . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1455 | </pre> |
| 1456 | |
| 1457 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1458 | If the type is present, all constants take the type specified, and |
| 1459 | the expressions must be <a href="#Assignment_compatibility">assignment compatible</a> with that type. |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1460 | If the type is omitted, the constants take the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1461 | individual types of the corresponding expressions. |
| 1462 | If the expression values are untyped <a href="#Constants">constants</a>, |
| 1463 | the declared constants remain untyped and the constant identifiers |
| 1464 | denote the constant values. For instance, if the expression is a |
| 1465 | floating-point literal, the constant identifier denotes a floating-point |
| 1466 | constant, even if the literal's fractional part is zero. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1467 | </p> |
| 1468 | |
| 1469 | <pre> |
| 1470 | const Pi float64 = 3.14159265358979323846 |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1471 | const zero = 0.0 // untyped floating-point constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1472 | const ( |
| 1473 | size int64 = 1024; |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1474 | eof = -1; // untyped integer constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1475 | ) |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1476 | const a, b, c = 3, 4, "foo" // a = 3, b = 4, c = "foo", untyped integer and string constants |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1477 | const u, v float = 0, 3 // u = 0.0, v = 3.0 |
| 1478 | </pre> |
| 1479 | |
| 1480 | <p> |
| 1481 | Within a parenthesized <code>const</code> declaration list the |
| 1482 | expression list may be omitted from any but the first declaration. |
| 1483 | Such an empty list is equivalent to the textual substitution of the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1484 | first preceding non-empty expression list and its type if any. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1485 | Omitting the list of expressions is therefore equivalent to |
| 1486 | repeating the previous list. The number of identifiers must be equal |
| 1487 | to the number of expressions in the previous list. |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1488 | Together with the <a href="#Iota"><code>iota</code> constant generator</a> |
| 1489 | this mechanism permits light-weight declaration of sequential values: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1490 | </p> |
| 1491 | |
| 1492 | <pre> |
| 1493 | const ( |
| 1494 | Sunday = iota; |
| 1495 | Monday; |
| 1496 | Tuesday; |
| 1497 | Wednesday; |
| 1498 | Thursday; |
| 1499 | Friday; |
| 1500 | Partyday; |
| 1501 | numberOfDays; // this constant is not exported |
| 1502 | ) |
| 1503 | </pre> |
| 1504 | |
| 1505 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1506 | <h3 id="Iota">Iota</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1507 | |
| 1508 | <p> |
| 1509 | Within a constant declaration, the predeclared pseudo-constant |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1510 | <code>iota</code> represents successive untyped integer <a href="#Constants"> |
| 1511 | constants</a>. It is reset to 0 whenever the reserved word <code>const</code> |
| 1512 | appears in the source and increments with each semicolon. It can be used to construct a |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1513 | set of related constants: |
| 1514 | </p> |
| 1515 | |
| 1516 | <pre> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1517 | const ( // iota is reset to 0 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1518 | c0 = iota; // c0 == 0 |
| 1519 | c1 = iota; // c1 == 1 |
| 1520 | c2 = iota // c2 == 2 |
| 1521 | ) |
| 1522 | |
| 1523 | const ( |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1524 | a = 1 << iota; // a == 1 (iota has been reset) |
| 1525 | b = 1 << iota; // b == 2 |
| 1526 | c = 1 << iota; // c == 4 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1527 | ) |
| 1528 | |
| 1529 | const ( |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1530 | u = iota * 42; // u == 0 (untyped integer constant) |
| 1531 | v float = iota * 42; // v == 42.0 (float constant) |
| 1532 | w = iota * 42; // w == 84 (untyped integer constant) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1533 | ) |
| 1534 | |
| 1535 | const x = iota; // x == 0 (iota has been reset) |
| 1536 | const y = iota; // y == 0 (iota has been reset) |
| 1537 | </pre> |
| 1538 | |
| 1539 | <p> |
| 1540 | Within an ExpressionList, the value of each <code>iota</code> is the same because |
| 1541 | it is only incremented at a semicolon: |
| 1542 | </p> |
| 1543 | |
| 1544 | <pre> |
| 1545 | const ( |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1546 | bit0, mask0 = 1 << iota, 1 << iota - 1; // bit0 == 1, mask0 == 0 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1547 | bit1, mask1; // bit1 == 2, mask1 == 1 |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1548 | _, _; // skips iota == 2 |
| 1549 | bit3, mask3; // bit3 == 8, mask3 == 7 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1550 | ) |
| 1551 | </pre> |
| 1552 | |
| 1553 | <p> |
| 1554 | This last example exploits the implicit repetition of the |
| 1555 | last non-empty expression list. |
| 1556 | </p> |
| 1557 | |
| 1558 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1559 | <h3 id="Type_declarations">Type declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1560 | |
| 1561 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1562 | A type declaration binds an identifier, the <i>type name</i>, to a new type |
| 1563 | that has the same definition (element, fields, channel direction, etc.) as |
| 1564 | an existing type. The new type is |
| 1565 | <a href="#Properties_of_types_and_values">compatible</a> with, but |
| 1566 | <a href="#Properties_of_types_and_values">different</a> from, the existing type. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1567 | </p> |
| 1568 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1569 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1570 | TypeDecl = "type" ( TypeSpec | "(" [ TypeSpecList ] ")" ) . |
| 1571 | TypeSpecList = TypeSpec { ";" TypeSpec } [ ";" ] . |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1572 | TypeSpec = identifier Type . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1573 | </pre> |
| 1574 | |
| 1575 | <pre> |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1576 | type IntArray [16]int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1577 | |
| 1578 | type ( |
| 1579 | Point struct { x, y float }; |
| 1580 | Polar Point |
| 1581 | ) |
| 1582 | |
| 1583 | type TreeNode struct { |
| 1584 | left, right *TreeNode; |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1585 | value *Comparable; |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1586 | } |
| 1587 | |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1588 | type Cipher interface { |
| 1589 | BlockSize() int; |
| 1590 | Encrypt(src, dst []byte); |
| 1591 | Decrypt(src, dst []byte); |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1592 | } |
| 1593 | </pre> |
| 1594 | |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1595 | <p> |
| 1596 | The declared type does not inherit any <a href="#Method_declarations">methods</a> |
| 1597 | bound to the existing type, but the <a href="#Types">method set</a> |
| 1598 | of elements of a composite type is not changed: |
| 1599 | </p> |
| 1600 | |
| 1601 | <pre> |
| 1602 | // A Mutex is a data type with two methods Lock and Unlock. |
| 1603 | type Mutex struct { /* Mutex fields */ } |
| 1604 | func (m *Mutex) Lock() { /* Lock implementation */ } |
| 1605 | func (m *Mutex) Unlock() { /* Unlock implementation */ } |
| 1606 | |
| 1607 | // NewMutex has the same composition as Mutex but its method set is empty. |
| 1608 | type NewMutex Mutex |
| 1609 | |
| 1610 | // PrintableMutex has no methods bound to it, but the method set contains |
| 1611 | // the methods Lock and Unlock bound to its anonymous field Mutex. |
| 1612 | type PrintableMutex struct { |
| 1613 | Mutex; |
| 1614 | } |
| 1615 | </pre> |
| 1616 | |
| 1617 | <p> |
| 1618 | A type declaration may be used to define a different boolean, numeric, or string |
| 1619 | type and attach methods to it: |
| 1620 | </p> |
| 1621 | |
| 1622 | <pre> |
| 1623 | type TimeZone int |
| 1624 | |
| 1625 | const ( |
| 1626 | EST TimeZone = -(5 + iota); |
| 1627 | CST; |
| 1628 | MST; |
| 1629 | PST; |
| 1630 | ) |
| 1631 | |
| 1632 | func (tz TimeZone) String() string { |
| 1633 | return fmt.Sprintf("GMT+%dh", tz); |
| 1634 | } |
| 1635 | </pre> |
| 1636 | |
| 1637 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1638 | <h3 id="Variable_declarations">Variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1639 | |
| 1640 | <p> |
| 1641 | A variable declaration creates a variable, binds an identifier to it and |
| 1642 | gives it a type and optionally an initial value. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1643 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1644 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1645 | VarDecl = "var" ( VarSpec | "(" [ VarSpecList ] ")" ) . |
| 1646 | VarSpecList = VarSpec { ";" VarSpec } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1647 | VarSpec = IdentifierList ( Type [ "=" ExpressionList ] | "=" ExpressionList ) . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1648 | </pre> |
| 1649 | |
| 1650 | <pre> |
| 1651 | var i int |
| 1652 | var U, V, W float |
| 1653 | var k = 0 |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1654 | var x, y float = -1, -2 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1655 | var ( |
| 1656 | i int; |
| 1657 | u, v, s = 2.0, 3.0, "bar" |
| 1658 | ) |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1659 | var re, im = complexSqrt(-1) |
| 1660 | var _, found = entries[name]; // map lookup; only interested in "found" |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1661 | </pre> |
| 1662 | |
| 1663 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1664 | If a list of expressions is given, the variables are initialized |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1665 | by assigning the expressions to the variables (§<a href="#Assignments">Assignments</a>) |
| 1666 | in order; all expressions must be consumed and all variables initialized from them. |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1667 | Otherwise, each variable is initialized to its <a href="#The_zero_value"><i>zero value</i></a>. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1668 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1669 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1670 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1671 | If the type is present, each variable is given that type. |
| 1672 | Otherwise, the types are deduced from the assignment |
| 1673 | of the expression list. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1674 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1675 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1676 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1677 | If the type is absent and the corresponding expression evaluates to an |
| 1678 | untyped <a href="#Constants">constant</a>, the type of the declared variable |
| 1679 | is <code>bool</code>, <code>int</code>, <code>float</code>, or <code>string</code> |
| 1680 | respectively, depending on whether the value is a boolean, integer, |
| 1681 | floating-point, or string constant: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1682 | </p> |
| 1683 | |
| 1684 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1685 | var b = true // t has type bool |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1686 | var i = 0 // i has type int |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1687 | var f = 3.0 // f has type float |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1688 | var s = "OMDB" // s has type string |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1689 | </pre> |
| 1690 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1691 | <h3 id="Short_variable_declarations">Short variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1692 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1693 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1694 | A <i>short variable declaration</i> uses the syntax: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1695 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1696 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1697 | <pre class="ebnf"> |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 1698 | ShortVarDecl = IdentifierList ":=" ExpressionList . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1699 | </pre> |
| 1700 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1701 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1702 | It is a shorthand for a regular variable declaration with |
| 1703 | initializer expressions but no types: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1704 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1705 | |
| 1706 | <pre class="grammar"> |
| 1707 | "var" IdentifierList = ExpressionList . |
| 1708 | </pre> |
| 1709 | |
| 1710 | <pre> |
| 1711 | i, j := 0, 10; |
| 1712 | f := func() int { return 7; } |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 1713 | ch := make(chan int); |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1714 | r, w := os.Pipe(fd); // os.Pipe() returns two values |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1715 | _, y, _ := coord(p); // coord() returns three values; only interested in y coordinate |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1716 | </pre> |
| 1717 | |
| 1718 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1719 | Unlike regular variable declarations, a short variable declaration may redeclare variables provided they |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1720 | were originally declared in the same block with the same type, and at |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1721 | least one of the non-<a href="#Blank_identifier">blank</a> variables is new. As a consequence, redeclaration |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1722 | can only appear in a multi-variable short declaration. |
| 1723 | Redeclaration does not introduce a new |
| 1724 | variable; it just assigns a new value to the original. |
| 1725 | </p> |
| 1726 | |
| 1727 | <pre> |
| 1728 | field1, offset := nextField(str, 0); |
| 1729 | field2, offset := nextField(str, offset); // redeclares offset |
| 1730 | </pre> |
| 1731 | |
| 1732 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1733 | Short variable declarations may appear only inside functions. |
| 1734 | In some contexts such as the initializers for <code>if</code>, |
| 1735 | <code>for</code>, or <code>switch</code> statements, |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1736 | they can be used to declare local temporary variables (§<a href="#Statements">Statements</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1737 | </p> |
| 1738 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1739 | <h3 id="Function_declarations">Function declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1740 | |
| 1741 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1742 | A function declaration binds an identifier to a function (§<a href="#Function_types">Function types</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1743 | </p> |
| 1744 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1745 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1746 | FunctionDecl = "func" identifier Signature [ Body ] . |
| 1747 | Body = Block. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1748 | </pre> |
| 1749 | |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1750 | <p> |
| 1751 | A function declaration may omit the body. Such a declaration provides the |
| 1752 | signature for a function implemented outside Go, such as an assembly routine. |
| 1753 | </p> |
| 1754 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1755 | <pre> |
| 1756 | func min(x int, y int) int { |
| 1757 | if x < y { |
| 1758 | return x; |
| 1759 | } |
| 1760 | return y; |
| 1761 | } |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1762 | |
| 1763 | func flushICache(begin, end uintptr) // implemented externally |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1764 | </pre> |
| 1765 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1766 | <h3 id="Method_declarations">Method declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1767 | |
| 1768 | <p> |
| 1769 | A method declaration binds an identifier to a method, |
| 1770 | which is a function with a <i>receiver</i>. |
| 1771 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1772 | <pre class="ebnf"> |
Robert Griesemer | da96188 | 2009-09-17 11:01:50 -0700 | [diff] [blame] | 1773 | MethodDecl = "func" Receiver MethodName Signature [ Body ] . |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1774 | Receiver = "(" [ identifier ] [ "*" ] BaseTypeName ")" . |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1775 | BaseTypeName = identifier . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1776 | </pre> |
| 1777 | |
| 1778 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1779 | The receiver type must be of the form <code>T</code> or <code>*T</code> where |
| 1780 | <code>T</code> is a type name. <code>T</code> is called the |
| 1781 | <i>receiver base type</i> or just <i>base type</i>. |
| 1782 | The base type must not be a pointer or interface type and must be |
Stephen Ma | 5db1d38 | 2009-09-02 20:09:25 -0700 | [diff] [blame] | 1783 | declared in the same package as the method. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1784 | The method is said to be <i>bound</i> to the base type |
| 1785 | and is visible only within selectors for that type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1786 | (§<a href="#Type_declarations">Type declarations</a>, §<a href="#Selectors">Selectors</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1787 | </p> |
| 1788 | |
| 1789 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1790 | Given type <code>Point</code>, the declarations |
| 1791 | </p> |
| 1792 | |
| 1793 | <pre> |
| 1794 | func (p *Point) Length() float { |
| 1795 | return Math.sqrt(p.x * p.x + p.y * p.y); |
| 1796 | } |
| 1797 | |
| 1798 | func (p *Point) Scale(factor float) { |
| 1799 | p.x = p.x * factor; |
| 1800 | p.y = p.y * factor; |
| 1801 | } |
| 1802 | </pre> |
| 1803 | |
| 1804 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1805 | bind the methods <code>Length</code> and <code>Scale</code>, |
| 1806 | with receiver type <code>*Point</code>, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1807 | to the base type <code>Point</code>. |
| 1808 | </p> |
| 1809 | |
| 1810 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1811 | If the receiver's value is not referenced inside the the body of the method, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1812 | its identifier may be omitted in the declaration. The same applies in |
| 1813 | general to parameters of functions and methods. |
| 1814 | </p> |
| 1815 | |
| 1816 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1817 | The type of a method is the type of a function with the receiver as first |
| 1818 | argument. For instance, the method <code>Scale</code> has type |
| 1819 | </p> |
| 1820 | |
| 1821 | <pre> |
| 1822 | (p *Point, factor float) |
| 1823 | </pre> |
| 1824 | |
| 1825 | <p> |
| 1826 | However, a function declared this way is not a method. |
| 1827 | </p> |
| 1828 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1829 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1830 | <h2 id="Expressions">Expressions</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1831 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1832 | <p> |
| 1833 | An expression specifies the computation of a value by applying |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1834 | operators and functions to operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1835 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1836 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1837 | <h3 id="Operands">Operands</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1838 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1839 | <p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1840 | Operands denote the elementary values in an expression. |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1841 | </p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1842 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1843 | <pre class="ebnf"> |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 1844 | Operand = Literal | QualifiedIdent | MethodExpr | "(" Expression ")" . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1845 | Literal = BasicLit | CompositeLit | FunctionLit . |
| 1846 | BasicLit = int_lit | float_lit | char_lit | StringLit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1847 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1848 | |
| 1849 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1850 | <h3 id="Qualified_identifiers">Qualified identifiers</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1851 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1852 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1853 | A qualified identifier is a non-<a href="#Blank_identifier">blank</a> identifier qualified by a package name prefix. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1854 | </p> |
Robert Griesemer | 337af31 | 2008-11-17 18:11:36 -0800 | [diff] [blame] | 1855 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1856 | <pre class="ebnf"> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1857 | QualifiedIdent = [ PackageName "." ] identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1858 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1859 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1860 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1861 | A qualified identifier accesses an identifier in a separate package. |
| 1862 | The identifier must be <a href="#Exported_identifiers">exported</a> by that |
| 1863 | package, which means that it must begin with a Unicode upper case letter. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1864 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1865 | |
| 1866 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1867 | math.Sin |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1868 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1869 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1870 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 1871 | <span class="alert">TODO: Unify this section with Selectors - it's the same syntax.</span> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1872 | </p> |
| 1873 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1874 | <h3 id="Composite_literals">Composite literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1875 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1876 | <p> |
| 1877 | Composite literals construct values for structs, arrays, slices, and maps |
| 1878 | and create a new value each time they are evaluated. |
| 1879 | They consist of the type of the value |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1880 | followed by a brace-bound list of composite elements. An element may be |
| 1881 | a single expression or a key-value pair. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1882 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1883 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1884 | <pre class="ebnf"> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1885 | CompositeLit = LiteralType "{" [ ElementList ] "}" . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1886 | LiteralType = StructType | ArrayType | "[" "..." "]" ElementType | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 1887 | SliceType | MapType | TypeName | "(" LiteralType ")" . |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1888 | ElementList = Element { "," Element } [ "," ] . |
| 1889 | Element = [ Key ":" ] Value . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1890 | Key = FieldName | Index . |
| 1891 | FieldName = identifier . |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1892 | Value = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1893 | </pre> |
Robert Griesemer | 0976e34 | 2008-09-03 13:37:44 -0700 | [diff] [blame] | 1894 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1895 | <p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1896 | The LiteralType must be a struct, array, slice, or map type |
| 1897 | (the grammar enforces this constraint except when the type is given |
| 1898 | as a TypeName). |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 1899 | The types of the expressions must be <a href="#Assignment_compatibility">assignment compatible</a> with |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 1900 | the respective field, element, and key types of the LiteralType; |
| 1901 | there is no additional conversion. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1902 | The key is interpreted as a field name for struct literals, |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1903 | an index expression for array and slice literals, and a key for map literals. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1904 | For map literals, all elements must have a key. It is an error |
| 1905 | to specify multiple elements with the same field name or |
| 1906 | constant key value. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1907 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1908 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1909 | <p> |
| 1910 | For struct literals the following rules apply: |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 1911 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1912 | <ul> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1913 | <li>A literal that does not contain any keys must |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1914 | list an element for each struct field in the |
| 1915 | order in which the fields are declared. |
| 1916 | </li> |
| 1917 | <li>If any element has a key, every element must have a key. |
| 1918 | </li> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1919 | <li>A literal that contains keys does not need to |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1920 | have an element for each struct field. Omitted fields |
| 1921 | get the zero value for that field. |
| 1922 | </li> |
| 1923 | <li>A literal may omit the element list; such a literal evaluates |
| 1924 | to the zero value for its type. |
| 1925 | </li> |
| 1926 | <li>It is an error to specify an element for a non-exported |
| 1927 | field of a struct belonging to a different package. |
| 1928 | </li> |
| 1929 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1930 | |
| 1931 | <p> |
| 1932 | Given the declarations |
| 1933 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1934 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1935 | type Point struct { x, y, z float } |
| 1936 | type Line struct { p, q Point } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1937 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1938 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1939 | <p> |
| 1940 | one may write |
| 1941 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1942 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1943 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1944 | origin := Point{}; // zero value for Point |
| 1945 | line := Line{origin, Point{y: -4, z: 12.3}}; // zero value for line.q.x |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1946 | </pre> |
| 1947 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 1948 | <p> |
| 1949 | For array and slice literals the following rules apply: |
| 1950 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1951 | <ul> |
| 1952 | <li>Each element has an associated integer index marking |
| 1953 | its position in the array. |
| 1954 | </li> |
| 1955 | <li>An element with a key uses the key as its index; the |
| 1956 | key must be a constant integer expression. |
| 1957 | </li> |
| 1958 | <li>An element without a key uses the previous element's index plus one. |
| 1959 | If the first element has no key, its index is zero. |
| 1960 | </li> |
| 1961 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1962 | |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1963 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1964 | Taking the address of a composite literal (§<a href="#Address_operators">Address operators</a>) |
Rob Pike | 2a5af74 | 2009-03-20 17:03:48 -0700 | [diff] [blame] | 1965 | generates a unique pointer to an instance of the literal's value. |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1966 | </p> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1967 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1968 | var pointer *Point = &Point{y: 1000}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1969 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1970 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1971 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1972 | The length of an array literal is the length specified in the LiteralType. |
| 1973 | If fewer elements than the length are provided in the literal, the missing |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1974 | elements are set to the zero value for the array element type. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1975 | It is an error to provide elements with index values outside the index range |
| 1976 | of the array. The notation <code>...</code> specifies an array length equal |
| 1977 | to the maximum element index plus one. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1978 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1979 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1980 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1981 | buffer := [10]string{}; // len(buffer) == 10 |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1982 | intSet := [6]int{1, 2, 3, 5}; // len(intSet) == 6 |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1983 | days := [...]string{"Sat", "Sun"}; // len(days) == 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1984 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1985 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1986 | <p> |
| 1987 | A slice literal describes the entire underlying array literal. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1988 | Thus, the length and capacity of a slice literal are the maximum |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1989 | element index plus one. A slice literal has the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1990 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1991 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1992 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1993 | []T{x1, x2, ... xn} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1994 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1995 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1996 | <p> |
| 1997 | and is a shortcut for a slice operation applied to an array literal: |
| 1998 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1999 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2000 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2001 | [n]T{x1, x2, ... xn}[0 : n] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2002 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2003 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2004 | <p> |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2005 | A parsing ambiguity arises when a composite literal using the |
| 2006 | TypeName form of the LiteralType appears in the condition of an |
| 2007 | "if", "for", or "switch" statement, because the braces surrounding |
| 2008 | the expressions in the literal are confused with those introducing |
| 2009 | a block of statements. To resolve the ambiguity in this rare case, |
| 2010 | the composite literal must appear within |
| 2011 | parentheses. |
| 2012 | </p> |
| 2013 | |
| 2014 | <pre> |
| 2015 | if x == (T{a,b,c}[i]) { ... } |
| 2016 | if (x == T{a,b,c}[i]) { ... } |
| 2017 | </pre> |
| 2018 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2019 | <p> |
| 2020 | Examples of valid array, slice, and map literals: |
| 2021 | </p> |
| 2022 | |
| 2023 | <pre> |
| 2024 | // list of prime numbers |
| 2025 | primes := []int{2, 3, 5, 7, 9, 11, 13, 17, 19, 991}; |
| 2026 | |
| 2027 | // vowels[ch] is true if ch is a vowel |
| 2028 | vowels := [128]bool{'a': true, 'e': true, 'i': true, 'o': true, 'u': true, 'y': true}; |
| 2029 | |
| 2030 | // the array [10]float{-1, 0, 0, 0, -0.1, -0.1, 0, 0, 0, -1}; |
| 2031 | filter := [10]float{-1, 4: -0.1, -0.1, 9: -1}; |
| 2032 | |
| 2033 | // frequencies in Hz for equal-tempered scale (A4 = 440Hz) |
| 2034 | noteFrequency := map[string]float{ |
| 2035 | "C0": 16.35, "D0": 18.35, "E0": 20.60, "F0": 21.83, |
| 2036 | "G0": 24.50, "A0": 27.50, "B0": 30.87, |
| 2037 | } |
| 2038 | </pre> |
| 2039 | |
| 2040 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2041 | <h3 id="Function_literals">Function literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2042 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2043 | <p> |
| 2044 | A function literal represents an anonymous function. |
| 2045 | It consists of a specification of the function type and a function body. |
| 2046 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2047 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2048 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 2049 | FunctionLit = FunctionType Body . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2050 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2051 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2052 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2053 | func (a, b int, z float) bool { return a*b < int(z) } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2054 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2055 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2056 | <p> |
| 2057 | A function literal can be assigned to a variable or invoked directly. |
| 2058 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2059 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2060 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2061 | f := func(x, y int) int { return x + y } |
| 2062 | func(ch chan int) { ch <- ACK } (reply_chan) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2063 | </pre> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2064 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2065 | <p> |
| 2066 | Function literals are <i>closures</i>: they may refer to variables |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 2067 | defined in a surrounding function. Those variables are then shared between |
| 2068 | the surrounding function and the function literal, and they survive as long |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2069 | as they are accessible. |
| 2070 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2071 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2072 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2073 | <h3 id="Primary_expressions">Primary expressions</h3> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2074 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 2075 | <p> |
| 2076 | Primary expressions are the operands for unary and binary expressions. |
| 2077 | </p> |
| 2078 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2079 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2080 | PrimaryExpr = |
| 2081 | Operand | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 2082 | Conversion | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 2083 | BuiltinCall | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2084 | PrimaryExpr Selector | |
| 2085 | PrimaryExpr Index | |
| 2086 | PrimaryExpr Slice | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2087 | PrimaryExpr TypeAssertion | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2088 | PrimaryExpr Call . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2089 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2090 | Selector = "." identifier . |
| 2091 | Index = "[" Expression "]" . |
| 2092 | Slice = "[" Expression ":" Expression "]" . |
| 2093 | TypeAssertion = "." "(" Type ")" . |
| 2094 | Call = "(" [ ExpressionList ] ")" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2095 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2096 | |
| 2097 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2098 | <pre> |
| 2099 | x |
| 2100 | 2 |
| 2101 | (s + ".txt") |
| 2102 | f(3.1415, true) |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2103 | Point{1, 2} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2104 | m["foo"] |
| 2105 | s[i : j + 1] |
| 2106 | obj.color |
| 2107 | Math.sin |
| 2108 | f.p[i].x() |
| 2109 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2110 | |
| 2111 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2112 | <h3 id="Selectors">Selectors</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2113 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2114 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2115 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2116 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2117 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2118 | <pre> |
| 2119 | x.f |
| 2120 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2121 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2122 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2123 | denotes the field or method <code>f</code> of the value denoted by <code>x</code> |
| 2124 | (or of <code>*x</code> if |
| 2125 | <code>x</code> is of pointer type). The identifier <code>f</code> |
| 2126 | is called the (field or method) |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 2127 | <i>selector</i>; it must not be the <a href="#Blank_identifier">blank identifier</a>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2128 | The type of the expression is the type of <code>f</code>. |
| 2129 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2130 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2131 | A selector <code>f</code> may denote a field or method <code>f</code> of |
| 2132 | a type <code>T</code>, or it may refer |
| 2133 | to a field or method <code>f</code> of a nested anonymous field of |
| 2134 | <code>T</code>. |
| 2135 | The number of anonymous fields traversed |
| 2136 | to reach <code>f</code> is called its <i>depth</i> in <code>T</code>. |
| 2137 | The depth of a field or method <code>f</code> |
| 2138 | declared in <code>T</code> is zero. |
| 2139 | The depth of a field or method <code>f</code> declared in |
| 2140 | an anonymous field <code>A</code> in <code>T</code> is the |
| 2141 | depth of <code>f</code> in <code>A</code> plus one. |
| 2142 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2143 | <p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2144 | The following rules apply to selectors: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2145 | </p> |
| 2146 | <ol> |
| 2147 | <li> |
| 2148 | For a value <code>x</code> of type <code>T</code> or <code>*T</code> |
| 2149 | where <code>T</code> is not an interface type, |
| 2150 | <code>x.f</code> denotes the field or method at the shallowest depth |
| 2151 | in <code>T</code> where there |
| 2152 | is such an <code>f</code>. |
| 2153 | If there is not exactly one <code>f</code> with shallowest depth, the selector |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2154 | expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2155 | </li> |
| 2156 | <li> |
| 2157 | For a variable <code>x</code> of type <code>I</code> or <code>*I</code> |
| 2158 | where <code>I</code> is an interface type, |
| 2159 | <code>x.f</code> denotes the actual method with name <code>f</code> of the value assigned |
| 2160 | to <code>x</code> if there is such a method. |
| 2161 | If no value or <code>nil</code> was assigned to <code>x</code>, <code>x.f</code> is illegal. |
| 2162 | </li> |
| 2163 | <li> |
| 2164 | In all other cases, <code>x.f</code> is illegal. |
| 2165 | </ol> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2166 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2167 | Selectors automatically dereference pointers. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2168 | If <code>x</code> is of pointer type, <code>x.y</code> |
| 2169 | is shorthand for <code>(*x).y</code>; if <code>y</code> |
| 2170 | is also of pointer type, <code>x.y.z</code> is shorthand |
| 2171 | for <code>(*(*x).y).z</code>, and so on. |
| 2172 | If <code>*x</code> is of pointer type, dereferencing |
| 2173 | must be explicit; |
| 2174 | only one level of automatic dereferencing is provided. |
| 2175 | For an <code>x</code> of type <code>T</code> containing an |
| 2176 | anonymous field declared as <code>*A</code>, |
| 2177 | <code>x.f</code> is a shortcut for <code>(*x.A).f</code>. |
| 2178 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2179 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2180 | For example, given the declarations: |
| 2181 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2182 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2183 | <pre> |
| 2184 | type T0 struct { |
| 2185 | x int; |
| 2186 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2187 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2188 | func (recv *T0) M0() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2189 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2190 | type T1 struct { |
| 2191 | y int; |
| 2192 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2193 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2194 | func (recv T1) M1() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2195 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2196 | type T2 struct { |
| 2197 | z int; |
| 2198 | T1; |
| 2199 | *T0; |
| 2200 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2201 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2202 | func (recv *T2) M2() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2203 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2204 | var p *T2; // with p != nil and p.T1 != nil |
| 2205 | </pre> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2206 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2207 | <p> |
| 2208 | one may write: |
| 2209 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2210 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2211 | <pre> |
| 2212 | p.z // (*p).z |
| 2213 | p.y // ((*p).T1).y |
| 2214 | p.x // (*(*p).T0).x |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2215 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2216 | p.M2 // (*p).M2 |
| 2217 | p.M1 // ((*p).T1).M1 |
| 2218 | p.M0 // ((*p).T0).M0 |
| 2219 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2220 | |
| 2221 | |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2222 | <span class="alert"> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2223 | TODO: Specify what happens to receivers. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2224 | </span> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2225 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2226 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2227 | <h3 id="Indexes">Indexes</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2228 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2229 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2230 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2231 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2232 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2233 | <pre> |
| 2234 | a[x] |
| 2235 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2236 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2237 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2238 | denotes the element of the array, slice, string or map <code>a</code> indexed by <code>x</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2239 | The value <code>x</code> is called the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2240 | <i>index</i> or <i>map key</i>, respectively. The following |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2241 | rules apply: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2242 | </p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2243 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2244 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2245 | For <code>a</code> of type <code>A</code> or <code>*A</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2246 | where <code>A</code> is an <a href="#Array_types">array type</a>, |
| 2247 | or for <code>a</code> of type <code>S</code> where <code>S</code> is a <a href="#Slice_types">slice type</a>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2248 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2249 | <ul> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2250 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code> |
| 2251 | <li><code>a[x]</code> is the array element at index <code>x</code> and the type of |
| 2252 | <code>a[x]</code> is the element type of <code>A</code> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2253 | </ul> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2254 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2255 | <p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2256 | For <code>a</code> of type <code>T</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2257 | where <code>T</code> is a <a href="#String_types">string type</a>: |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2258 | </p> |
| 2259 | <ul> |
| 2260 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code> |
| 2261 | <li><code>a[x]</code> is the byte at index <code>x</code> and the type of |
| 2262 | <code>a[x]</code> is <code>byte</code> |
| 2263 | <li><code>a[x]</code> may not be assigned to |
| 2264 | </ul> |
| 2265 | |
| 2266 | <p> |
| 2267 | For <code>a</code> of type <code>M</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2268 | where <code>M</code> is a <a href="#Map_types">map type</a>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2269 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2270 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 2271 | <li><code>x</code>'s type must be compatible with the key type of <code>M</code> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2272 | and the map must contain an entry with key <code>x</code> (but see special forms below) |
| 2273 | <li><code>a[x]</code> is the map value with key <code>x</code> |
| 2274 | and the type of <code>a[x]</code> is the value type of <code>M</code> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2275 | </ul> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2276 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2277 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2278 | Otherwise <code>a[x]</code> is illegal. If the index or key is out of range evaluating |
| 2279 | an otherwise legal index expression, a run-time exception occurs. |
| 2280 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2281 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2282 | <p> |
| 2283 | However, if an index expression on a map <code>a</code> of type <code>map[K] V</code> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2284 | is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2285 | </p> |
| 2286 | |
| 2287 | <pre> |
| 2288 | r, ok = a[x] |
| 2289 | r, ok := a[x] |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2290 | var r, ok = a[x] |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2291 | </pre> |
| 2292 | |
| 2293 | <p> |
| 2294 | the result of the index expression is a pair of values with types |
| 2295 | <code>(K, bool)</code>. |
| 2296 | If the key is present in the map, |
| 2297 | the expression returns the pair <code>(a[x], true)</code>; |
| 2298 | otherwise it returns <code>(Z, false)</code> where <code>Z</code> is |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2299 | the <a href="#The_zero_value">zero value</a> for <code>V</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2300 | No run-time exception occurs in this case. |
| 2301 | The index expression in this construct thus acts like a function call |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2302 | returning a value and a boolean indicating success. (§<a href="#Assignments">Assignments</a>) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2303 | </p> |
| 2304 | |
| 2305 | <p> |
| 2306 | Similarly, if an assignment to a map has the special form |
| 2307 | </p> |
| 2308 | |
| 2309 | <pre> |
| 2310 | a[x] = r, ok |
| 2311 | </pre> |
| 2312 | |
| 2313 | <p> |
| 2314 | and boolean <code>ok</code> has the value <code>false</code>, |
| 2315 | the entry for key <code>x</code> is deleted from the map; if |
| 2316 | <code>ok</code> is <code>true</code>, the construct acts like |
| 2317 | a regular assignment to an element of the map. |
| 2318 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2319 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2320 | <h3 id="Slices">Slices</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2321 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2322 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 2323 | Strings, arrays, and slices can be <i>sliced</i> to construct substrings or descriptors |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 2324 | of subarrays. The index expressions in the slice select which elements appear |
| 2325 | in the result. The result has indexes starting at 0 and length equal to the |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2326 | difference in the index values in the slice. After slicing the array <code>a</code> |
| 2327 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2328 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2329 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2330 | a := [4]int{1, 2, 3, 4}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2331 | s := a[1:3]; |
| 2332 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2333 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2334 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2335 | the slice <code>s</code> has type <code>[]int</code>, length 2, capacity 3, and elements |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2336 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2337 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2338 | <pre> |
| 2339 | s[0] == 2 |
| 2340 | s[1] == 3 |
| 2341 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2342 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2343 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2344 | The slice length must not be negative. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2345 | For arrays or strings, the indexes |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 2346 | <code>lo</code> and <code>hi</code> must satisfy |
| 2347 | 0 <= <code>lo</code> <= <code>hi</code> <= length; |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2348 | for slices, the upper bound is the capacity rather than the length. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2349 | </p> |
| 2350 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2351 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2352 | If the sliced operand is a string or slice, the result of the slice operation |
| 2353 | is a string or slice of the same type. |
| 2354 | If the sliced operand is an array, the result of the slice operation is a slice |
| 2355 | with the same element type as the array. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2356 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2357 | |
| 2358 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2359 | <h3 id="Type_assertions">Type assertions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2360 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2361 | <p> |
| 2362 | For an expression <code>x</code> and a type <code>T</code>, the primary expression |
| 2363 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2364 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2365 | <pre> |
| 2366 | x.(T) |
| 2367 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2368 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2369 | <p> |
Russ Cox | b89a54e | 2009-05-20 18:16:04 -0700 | [diff] [blame] | 2370 | asserts that <code>x</code> is not the zero interface value |
| 2371 | and that the value stored in <code>x</code> is of type <code>T</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2372 | The notation <code>x.(T)</code> is called a <i>type assertion</i>. |
| 2373 | The type of <code>x</code> must be an interface type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2374 | </p> |
| 2375 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2376 | More precisely, if <code>T</code> is not an interface type, <code>x.(T)</code> asserts |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2377 | that the dynamic type of <code>x</code> is identical to the type <code>T</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2378 | (§<a href="#Type_identity_and_compatibility">Type identity and compatibility</a>). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2379 | If <code>T</code> is an interface type, <code>x.(T)</code> asserts that the dynamic type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2380 | of <code>T</code> implements the interface <code>T</code> (§<a href="#Interface_types">Interface types</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2381 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2382 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2383 | If the type assertion holds, the value of the expression is the value |
| 2384 | stored in <code>x</code> and its type is <code>T</code>. If the type assertion is false, a run-time |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2385 | exception occurs. In other words, even though the dynamic type of <code>x</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2386 | is known only at run-time, the type of <code>x.(T)</code> is |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2387 | known to be <code>T</code> in a correct program. |
| 2388 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2389 | <p> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2390 | If a type assertion is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2391 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2392 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2393 | <pre> |
| 2394 | v, ok = x.(T) |
| 2395 | v, ok := x.(T) |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2396 | var v, ok = x.(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2397 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2398 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2399 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2400 | the result of the assertion is a pair of values with types <code>(T, bool)</code>. |
| 2401 | If the assertion holds, the expression returns the pair <code>(x.(T), true)</code>; |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2402 | otherwise, the expression returns <code>(Z, false)</code> where <code>Z</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2403 | is the <a href="#The_zero_value">zero value</a> for type <code>T</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2404 | No run-time exception occurs in this case. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2405 | The type assertion in this construct thus acts like a function call |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2406 | returning a value and a boolean indicating success. (§<a href="#Assignments">Assignments</a>) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2407 | </p> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2408 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2409 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2410 | <h3 id="Calls">Calls</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2411 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2412 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2413 | Given an expression <code>f</code> of function type |
| 2414 | <code>F</code>, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2415 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2416 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2417 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2418 | f(a1, a2, ... an) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2419 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2420 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2421 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2422 | calls <code>f</code> with arguments <code>a1, a2, ... an</code>. |
| 2423 | The arguments must be single-valued expressions |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 2424 | <a href="#Assignment_compatibility">assignment compatible</a> with the parameter types of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2425 | <code>F</code> and are evaluated before the function is called. |
| 2426 | The type of the expression is the result type |
| 2427 | of <code>F</code>. |
| 2428 | A method invocation is similar but the method itself |
| 2429 | is specified as a selector upon a value of the receiver type for |
| 2430 | the method. |
| 2431 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2432 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2433 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2434 | Atan2(x, y) // function call |
| 2435 | var pt *Point; |
| 2436 | pt.Scale(3.5) // method call with receiver pt |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2437 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2438 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2439 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 2440 | A method call <code>x.m()</code> is valid if the method set of |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2441 | (the type of) <code>x</code> contains <code>m</code> and the |
| 2442 | argument list is compatible with the parameter list of <code>m</code>. |
| 2443 | If <code>x</code> is <a href="#Address_operators">addressable</a> and <code>&x</code>'s method |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 2444 | set contains <code>m</code>, <code>x.m()</code> is shorthand |
| 2445 | for <code>(&x).m()</code>: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2446 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2447 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2448 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2449 | var p Point; |
| 2450 | p.Scale(3.5) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2451 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2452 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2453 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2454 | There is no distinct method type and there are no method literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2455 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2456 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2457 | <h3 id="Passing_arguments_to_..._parameters">Passing arguments to <code>...</code> parameters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2458 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2459 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2460 | When a function <code>f</code> has a <code>...</code> parameter, |
| 2461 | it is always the last formal parameter. Within calls to <code>f</code>, |
| 2462 | the arguments before the <code>...</code> are treated normally. |
| 2463 | After those, an arbitrary number (including zero) of trailing |
| 2464 | arguments may appear in the call and are bound to the <code>...</code> |
| 2465 | parameter. |
| 2466 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2467 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2468 | <p> |
| 2469 | Within <code>f</code>, the <code>...</code> parameter has static |
| 2470 | type <code>interface{}</code> (the empty interface). For each call, |
| 2471 | its dynamic type is a structure whose sequential fields are the |
| 2472 | trailing arguments of the call. That is, the actual arguments |
| 2473 | provided for a <code>...</code> parameter are wrapped into a struct |
| 2474 | that is passed to the function instead of the actual arguments. |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 2475 | Using the <a href="#Package_unsafe">reflection</a> interface, <code>f</code> may |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2476 | unpack the elements of the dynamic type to recover the actual |
| 2477 | arguments. |
| 2478 | </p> |
| 2479 | |
| 2480 | <p> |
| 2481 | Given the function and call |
| 2482 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2483 | <pre> |
Rob Pike | fb24d79 | 2009-05-08 11:21:20 -0700 | [diff] [blame] | 2484 | func Fprintf(f io.Writer, format string, args ...) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2485 | Fprintf(os.Stdout, "%s %d", "hello", 23); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2486 | </pre> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2487 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2488 | <p> |
| 2489 | Within <code>Fprintf</code>, the dynamic type of <code>args</code> for this |
| 2490 | call will be, schematically, |
| 2491 | <code> struct { string; int }</code>. |
| 2492 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2493 | |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2494 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2495 | <p> |
| 2496 | As a special case, if a function passes its own <code>...</code> parameter as the argument |
| 2497 | for a <code>...</code> in a call to another function with a <code>...</code> parameter, |
| 2498 | the parameter is not wrapped again but passed directly. In short, a formal <code>...</code> |
| 2499 | parameter is passed unchanged as an actual <code>...</code> parameter. |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2500 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2501 | <h3 id="Operators">Operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2502 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2503 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2504 | Operators combine operands into expressions. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2505 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2506 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2507 | <pre class="ebnf"> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2508 | Expression = UnaryExpr | Expression binary_op UnaryExpr . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2509 | UnaryExpr = PrimaryExpr | unary_op UnaryExpr . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2510 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2511 | binary_op = log_op | com_op | rel_op | add_op | mul_op . |
| 2512 | log_op = "||" | "&&" . |
| 2513 | com_op = "<-" . |
| 2514 | rel_op = "==" | "!=" | "<" | "<=" | ">" | ">=" . |
| 2515 | add_op = "+" | "-" | "|" | "^" . |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2516 | mul_op = "*" | "/" | "%" | "<<" | ">>" | "&" | "&^" . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2517 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2518 | unary_op = "+" | "-" | "!" | "^" | "*" | "&" | "<-" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2519 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2520 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2521 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2522 | Comparisons are discussed <a href="#Comparison_operators">elsewhere</a>. |
| 2523 | For other binary operators, the operand types must be identical |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2524 | (§<a href="#Properties_of_types_and_values">Properties of types and values</a>) |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2525 | unless the operation involves channels, shifts, or untyped <a href="#Constants">constants</a>. |
| 2526 | For operations involving constants only, see the section on |
| 2527 | <a href="#Constant_expressions">constant expressions</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2528 | </p> |
Robert Griesemer | c8e1876 | 2008-09-12 12:26:22 -0700 | [diff] [blame] | 2529 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2530 | <p> |
Robert Griesemer | b691e08 | 2009-10-28 18:17:24 -0700 | [diff] [blame^] | 2531 | In a channel send, the first operand is always a channel and the second |
| 2532 | must be a value <a href="#Assignment_compatibility">assignment compatible</a> |
| 2533 | with the channel's element type. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2534 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2535 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2536 | <p> |
| 2537 | Except for shift operations, |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2538 | if one operand is an untyped <a href="#Constants">constant</a> |
| 2539 | and the other operand is not, the constant is <a href="#Conversions">converted</a> |
| 2540 | to the type of the other operand. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2541 | </p> |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 2542 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2543 | <p> |
| 2544 | The right operand in a shift operation must have unsigned integer type |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2545 | or be an untyped constant that can be converted to unsigned integer type. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2546 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2547 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2548 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2549 | If the left operand of a non-constant shift operation is an untyped constant, |
| 2550 | the type of constant is what it would be if the shift operation were replaced by |
| 2551 | the left operand alone. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2552 | </p> |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 2553 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2554 | <pre> |
| 2555 | var s uint = 33; |
| 2556 | var i = 1<<s; // 1 has type int |
| 2557 | var j = int32(1<<s); // 1 has type int32; j == 0 |
| 2558 | var u = uint64(1<<s); // 1 has type uint64; u == 1<<33 |
| 2559 | var f = float(1<<s); // illegal: 1 has type float, cannot shift |
| 2560 | var g = float(1<<33); // legal; 1<<33 is a constant shift operation; g == 1<<33 |
| 2561 | </pre> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2562 | |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2563 | <h3 id="Operator_precedence">Operator precedence</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2564 | <p> |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2565 | Unary operators have the highest precedence. |
| 2566 | As the <code>++</code> and <code>--</code> operators form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2567 | statements, not expressions, they fall |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2568 | outside the operator hierarchy. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2569 | As a consequence, statement <code>*p++</code> is the same as <code>(*p)++</code>. |
| 2570 | <p> |
| 2571 | There are six precedence levels for binary operators. |
| 2572 | Multiplication operators bind strongest, followed by addition |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2573 | operators, comparison operators, <code><-</code> (channel send), |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2574 | <code>&&</code> (logical and), and finally <code>||</code> (logical or): |
| 2575 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2576 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2577 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2578 | Precedence Operator |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2579 | 6 * / % << >> & &^ |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2580 | 5 + - | ^ |
| 2581 | 4 == != < <= > >= |
| 2582 | 3 <- |
| 2583 | 2 && |
| 2584 | 1 || |
| 2585 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2586 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2587 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2588 | Binary operators of the same precedence associate from left to right. |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2589 | For instance, <code>x / y * z</code> is the same as <code>(x / y) * z</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2590 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2591 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2592 | <pre> |
| 2593 | +x |
| 2594 | 23 + 3*x[i] |
| 2595 | x <= f() |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2596 | ^a >> b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2597 | f() || g() |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2598 | x == y+1 && <-chan_ptr > 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2599 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2600 | |
| 2601 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2602 | <h3 id="Arithmetic_operators">Arithmetic operators</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2603 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2604 | Arithmetic operators apply to numeric values and yield a result of the same |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2605 | type as the first operand. The four standard arithmetic operators (<code>+</code>, |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2606 | <code>-</code>, <code>*</code>, <code>/</code>) apply to integer and |
| 2607 | floating-point types; <code>+</code> also applies |
| 2608 | to strings. All other arithmetic operators apply to integers only. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2609 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2610 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2611 | <pre class="grammar"> |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2612 | + sum integers, floats, strings |
| 2613 | - difference integers, floats |
| 2614 | * product integers, floats |
| 2615 | / quotient integers, floats |
| 2616 | % remainder integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2617 | |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2618 | & bitwise and integers |
| 2619 | | bitwise or integers |
| 2620 | ^ bitwise xor integers |
| 2621 | &^ bit clear (and not) integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2622 | |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2623 | << left shift integer << unsigned integer |
| 2624 | >> right shift integer >> unsigned integer |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2625 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2626 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2627 | <p> |
| 2628 | Strings can be concatenated using the <code>+</code> operator |
| 2629 | or the <code>+=</code> assignment operator: |
| 2630 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2631 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2632 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2633 | s := "hi" + string(c); |
| 2634 | s += " and good bye"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2635 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2636 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2637 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2638 | String addition creates a new string by concatenating the operands. |
| 2639 | </p> |
| 2640 | <p> |
| 2641 | For integer values, <code>/</code> and <code>%</code> satisfy the following relationship: |
| 2642 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2643 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2644 | <pre> |
| 2645 | (a / b) * b + a % b == a |
| 2646 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2647 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2648 | <p> |
| 2649 | with <code>(a / b)</code> truncated towards zero. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2650 | Examples: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2651 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2652 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2653 | <pre> |
| 2654 | x y x / y x % y |
| 2655 | 5 3 1 2 |
| 2656 | -5 3 -1 -2 |
| 2657 | 5 -3 -1 2 |
| 2658 | -5 -3 1 -2 |
| 2659 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2660 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2661 | <p> |
| 2662 | If the dividend is positive and the divisor is a constant power of 2, |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 2663 | the division may be replaced by a right shift, and computing the remainder may |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2664 | be replaced by a bitwise "and" operation: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2665 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2666 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2667 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2668 | x x / 4 x % 4 x >> 2 x & 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2669 | 11 2 3 2 3 |
| 2670 | -11 -2 -3 -3 1 |
| 2671 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2672 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2673 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2674 | The shift operators shift the left operand by the shift count specified by the |
| 2675 | right operand. They implement arithmetic shifts if the left operand is a signed |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2676 | integer and logical shifts if it is an unsigned integer. The shift count must |
| 2677 | be an unsigned integer. There is no upper limit on the shift count. Shifts behave |
| 2678 | as if the left operand is shifted <code>n</code> times by 1 for a shift |
| 2679 | count of <code>n</code>. |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2680 | As a result, <code>x << 1</code> is the same as <code>x*2</code> |
| 2681 | and <code>x >> 1</code> is the same as |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2682 | <code>x/2</code> truncated towards negative infinity. |
| 2683 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2684 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2685 | <p> |
| 2686 | For integer operands, the unary operators |
| 2687 | <code>+</code>, <code>-</code>, and <code>^</code> are defined as |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2688 | follows: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2689 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2690 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2691 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2692 | +x is 0 + x |
| 2693 | -x negation is 0 - x |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 2694 | ^x bitwise complement is m ^ x with m = "all bits set to 1" for unsigned x |
| 2695 | and m = -1 for signed x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2696 | </pre> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2697 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2698 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2699 | For floating-point numbers, |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2700 | <code>+x</code> is the same as <code>x</code>, |
| 2701 | while <code>-x</code> is the negation of <code>x</code>. |
| 2702 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2703 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2704 | <h3 id="Integer_overflow">Integer overflow</h3> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2705 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2706 | <p> |
| 2707 | For unsigned integer values, the operations <code>+</code>, |
| 2708 | <code>-</code>, <code>*</code>, and <code><<</code> are |
| 2709 | computed modulo 2<sup><i>n</i></sup>, where <i>n</i> is the bit width of |
| 2710 | the unsigned integer's type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2711 | (§<a href="#Numeric_types">Numeric types</a>). Loosely speaking, these unsigned integer operations |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2712 | discard high bits upon overflow, and programs may rely on ``wrap around''. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2713 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2714 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2715 | For signed integers, the operations <code>+</code>, |
| 2716 | <code>-</code>, <code>*</code>, and <code><<</code> may legally |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2717 | overflow and the resulting value exists and is deterministically defined |
| 2718 | by the signed integer representation, the operation, and its operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2719 | No exception is raised as a result of overflow. A |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2720 | compiler may not optimize code under the assumption that overflow does |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2721 | not occur. For instance, it may not assume that <code>x < x + 1</code> is always true. |
| 2722 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2723 | |
| 2724 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2725 | <h3 id="Comparison_operators">Comparison operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2726 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2727 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2728 | Comparison operators yield a value of type <code>bool</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2729 | The operators <code>==</code> and <code>!=</code> apply, at least in some cases, |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2730 | to operands of all types except arrays and structs. |
| 2731 | All other comparison operators apply only to numeric and string values. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2732 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2733 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2734 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2735 | == equal |
| 2736 | != not equal |
| 2737 | < less |
| 2738 | <= less or equal |
| 2739 | > greater |
| 2740 | >= greater or equal |
| 2741 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2742 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2743 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2744 | Operands of numeric type are compared in the usual way. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2745 | </p> |
| 2746 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2747 | Operands of string type are compared byte-wise (lexically). |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2748 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2749 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2750 | Operands of boolean type are equal if they are either both <code>true</code> |
| 2751 | or both <code>false</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2752 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2753 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2754 | The rules for comparison of composite types are described in the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2755 | section on §<a href="#Comparison_compatibility">Comparison compatibility</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2756 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 2757 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2758 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2759 | <h3 id="Logical_operators">Logical operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2760 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2761 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2762 | Logical operators apply to <a href="#Boolean_types">boolean</a> values |
| 2763 | and yield a result of the same type as the operands. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2764 | The right operand is evaluated conditionally. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2765 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2766 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2767 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2768 | && conditional and p && q is "if p then q else false" |
| 2769 | || conditional or p || q is "if p then true else q" |
| 2770 | ! not !p is "not p" |
| 2771 | </pre> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2772 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2773 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2774 | <h3 id="Address_operators">Address operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2775 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2776 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2777 | The address-of operator <code>&</code> generates the address of its operand, |
| 2778 | which must be <i>addressable</i>, |
| 2779 | that is, either a variable, pointer indirection, array or slice indexing |
| 2780 | operation, |
| 2781 | or a field selector of an addressable struct operand. |
| 2782 | A function result variable is not addressable. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2783 | (<span class="alert">TODO: remove this restriction.</span>) |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2784 | Given an operand of pointer type, the pointer indirection |
| 2785 | operator <code>*</code> retrieves the value pointed |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2786 | to by the operand. |
| 2787 | </p> |
| 2788 | |
| 2789 | <pre> |
| 2790 | &x |
| 2791 | &a[f(2)] |
| 2792 | *p |
| 2793 | *pf(x) |
| 2794 | </pre> |
| 2795 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2796 | <h3 id="Communication_operators">Communication operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2797 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2798 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2799 | The term <i>channel</i> means "value of <a href="#Channel_types">channel type</a>". |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2800 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2801 | <p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2802 | The send operation uses the binary operator "<-", which operates on |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2803 | a channel and a value (expression): |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2804 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2805 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2806 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2807 | ch <- 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2808 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2809 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2810 | <p> |
| 2811 | The send operation sends the value on the channel. Both the channel |
| 2812 | and the expression are evaluated before communication begins. |
| 2813 | Communication blocks until the send can proceed, at which point the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2814 | value is transmitted on the channel. |
| 2815 | A send on an unbuffered channel can proceed if a receiver is ready. |
| 2816 | A send on a buffered channel can proceed if there is room in the buffer. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2817 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2818 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2819 | If the send operation appears in an expression context, the value |
| 2820 | of the expression is a boolean and the operation is non-blocking. |
| 2821 | The value of the boolean reports true if the communication succeeded, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2822 | false if it did not. (The channel and |
| 2823 | the expression to be sent are evaluated regardless.) |
| 2824 | These two examples are equivalent: |
| 2825 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2826 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2827 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2828 | ok := ch <- 3; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2829 | if ok { print("sent") } else { print("not sent") } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2830 | |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2831 | if ch <- 3 { print("sent") } else { print("not sent") } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2832 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2833 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2834 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2835 | In other words, if the program tests the value of a send operation, |
| 2836 | the send is non-blocking and the value of the expression is the |
| 2837 | success of the operation. If the program does not test the value, |
| 2838 | the operation blocks until it succeeds. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2839 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2840 | <p> |
| 2841 | The receive operation uses the prefix unary operator "<-". |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2842 | The value of the expression is the value received, whose type |
| 2843 | is the element type of the channel. |
| 2844 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2845 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2846 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2847 | <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2848 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2849 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2850 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2851 | The expression blocks until a value is available, which then can |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2852 | be assigned to a variable or used like any other expression. |
| 2853 | If the receive expression does not save the value, the value is |
| 2854 | discarded. |
| 2855 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2856 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2857 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2858 | v1 := <-ch |
| 2859 | v2 = <-ch |
| 2860 | f(<-ch) |
| 2861 | <-strobe // wait until clock pulse |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2862 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2863 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2864 | <p> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2865 | If a receive expression is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2866 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2867 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2868 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 2869 | x, ok = <-ch |
| 2870 | x, ok := <-ch |
| 2871 | var x, ok = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2872 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2873 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2874 | <p> |
| 2875 | the receive operation becomes non-blocking. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2876 | If the operation can proceed, the boolean variable |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2877 | <code>ok</code> will be set to <code>true</code> |
| 2878 | and the value stored in <code>x</code>; otherwise |
| 2879 | <code>ok</code> is set |
| 2880 | to <code>false</code> and <code>x</code> is set to the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2881 | zero value for its type (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2882 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2883 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2884 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2885 | <span class="alert">TODO: Probably in a separate section, communication semantics |
| 2886 | need to be presented regarding send, receive, select, and goroutines.</span> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2887 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2888 | |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 2889 | <h3 id="Method_expressions">Method expressions</h3> |
| 2890 | |
| 2891 | <p> |
| 2892 | If <code>M</code> is in the method set of type <code>T</code>, |
| 2893 | <code>T.M</code> is a function that is callable as a regular function |
| 2894 | with the same arguments as <code>M</code> prefixed by an additional |
| 2895 | argument that is the receiver of the method. |
| 2896 | </p> |
| 2897 | |
Robert Griesemer | da96188 | 2009-09-17 11:01:50 -0700 | [diff] [blame] | 2898 | <pre class="ebnf"> |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 2899 | MethodExpr = ReceiverType "." MethodName . |
| 2900 | ReceiverType = TypeName | "(" "*" TypeName ")" . |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 2901 | </pre> |
| 2902 | |
| 2903 | <p> |
| 2904 | Consider a struct type <code>T</code> with two methods, |
| 2905 | <code>Mv</code>, whose receiver is of type <code>T</code>, and |
| 2906 | <code>Mp</code>, whose receiver is of type <code>*T</code>. |
| 2907 | </p> |
| 2908 | |
| 2909 | <pre> |
| 2910 | type T struct { |
| 2911 | a int; |
| 2912 | } |
| 2913 | func (tv T) Mv(a int) int { return 0 } // value receiver |
| 2914 | func (tp *T) Mp(f float) float { return 1 } // pointer receiver |
| 2915 | var t T; |
| 2916 | </pre> |
| 2917 | |
| 2918 | <p> |
| 2919 | The expression |
| 2920 | </p> |
| 2921 | |
| 2922 | <pre> |
| 2923 | T.Mv |
| 2924 | </pre> |
| 2925 | |
| 2926 | <p> |
| 2927 | yields a function equivalent to <code>Mv</code> but |
| 2928 | with an explicit receiver as its first argument; it has signature |
| 2929 | </p> |
| 2930 | |
| 2931 | <pre> |
| 2932 | func (tv T, a int) int |
| 2933 | </pre> |
| 2934 | |
| 2935 | <p> |
| 2936 | That function may be called normally with an explicit receiver, so |
| 2937 | these three invocations are equivalent: |
| 2938 | </p> |
| 2939 | |
| 2940 | <pre> |
| 2941 | t.Mv(7) |
| 2942 | T.Mv(t, 7) |
| 2943 | f := T.Mv; f(t, 7) |
| 2944 | </pre> |
| 2945 | |
| 2946 | <p> |
| 2947 | Similarly, the expression |
| 2948 | </p> |
| 2949 | |
| 2950 | <pre> |
| 2951 | (*T).Mp |
| 2952 | </pre> |
| 2953 | |
| 2954 | <p> |
| 2955 | yields a function value representing <code>Mp</code> with signature |
| 2956 | </p> |
| 2957 | |
| 2958 | <pre> |
| 2959 | func (tp *T, f float) float |
| 2960 | </pre> |
| 2961 | |
| 2962 | <p> |
| 2963 | For a method with a value receiver, one can derive a function |
| 2964 | with an explicit pointer receiver, so |
| 2965 | </p> |
| 2966 | |
| 2967 | <pre> |
| 2968 | (*T).Mv |
| 2969 | </pre> |
| 2970 | |
| 2971 | <p> |
| 2972 | yields a function value representing <code>Mv</code> with signature |
| 2973 | </p> |
| 2974 | |
| 2975 | <pre> |
| 2976 | func (tv *T, f int) int |
| 2977 | </pre> |
| 2978 | |
| 2979 | <p> |
| 2980 | Such a function indirects through the receiver to create a value |
| 2981 | to pass as the receiver to the underlying method; |
| 2982 | the method does not overwrite the value whose address is passed in |
| 2983 | the function call. |
| 2984 | </p> |
| 2985 | |
| 2986 | <p> |
| 2987 | The final case, a value-receiver function for a pointer-receiver method, |
| 2988 | is illegal because pointer-receiver methods are not in the method set |
| 2989 | of the value type. |
| 2990 | </p> |
| 2991 | |
| 2992 | <p> |
| 2993 | Function values derived from methods are called with function call syntax; |
| 2994 | the receiver is provided as the first argument to the call. |
| 2995 | That is, given <code>f := T.Mv</code>, <code>f</code> is invoked |
| 2996 | as <code>f(t, 7)</code> not <code>t.f(7)</code>. |
| 2997 | To construct a function that binds the receiver, use a |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2998 | <a href="#Function_literals">closure</a>. |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 2999 | </p> |
| 3000 | |
| 3001 | <p> |
| 3002 | It is legal to derive a function value from a method of an interface type. |
| 3003 | The resulting function takes an explicit receiver of that interface type. |
| 3004 | </p> |
| 3005 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3006 | <h3 id="Conversions">Conversions</h3> |
| 3007 | |
| 3008 | <p> |
| 3009 | Conversions are expressions of the form <code>T(x)</code> |
| 3010 | where <code>T</code> is a type and <code>x</code> is an expression |
| 3011 | that can be converted to type <code>T</code>. |
| 3012 | </p> |
| 3013 | |
| 3014 | <pre class="ebnf"> |
| 3015 | Conversion = LiteralType "(" Expression ")" . |
| 3016 | </pre> |
| 3017 | |
| 3018 | <p> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3019 | In general, a conversion succeeds if the value of <code>x</code> is |
| 3020 | <a href="#Assignment_compatibility">assignment compatible</a> with type <code>T</code>, |
| 3021 | or if the value would be assignment compatible with type <code>T</code> if the |
| 3022 | value's type, or <code>T</code>, or any of their component types were unnamed. |
| 3023 | Usually, such a conversion changes the type but not the representation of the value |
| 3024 | of <code>x</code> and thus has no run-time cost. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3025 | </p> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3026 | |
| 3027 | <p> |
| 3028 | Specific rules apply to conversions where <code>T</code> is a numeric or string type. |
| 3029 | These conversions may change the representation of a value and incur a run-time cost. |
| 3030 | </p> |
| 3031 | |
| 3032 | <h4>Conversions between integer types</h4> |
| 3033 | <p> |
| 3034 | If the value is a signed quantity, it is |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3035 | sign extended to implicit infinite precision; otherwise it is zero |
| 3036 | extended. It is then truncated to fit in the result type's size. |
| 3037 | For example, if <code>x := uint16(0x10F0)</code>, then <code>uint32(int8(x)) == 0xFFFFFFF0</code>. |
| 3038 | The conversion always yields a valid value; there is no indication of overflow. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3039 | </p> |
| 3040 | |
| 3041 | <h4>Conversions involving floating point types</h4> |
| 3042 | <ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3043 | <li> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3044 | When converting a floating-point number to an integer, the fraction is discarded |
| 3045 | (truncation towards zero). |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3046 | </li> |
| 3047 | <li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3048 | When converting a number to a floating-point type, the result value is rounded |
| 3049 | to the precision specified by the floating point type. |
| 3050 | For instance, the value of a variable <code>x</code> of type <code>float32</code> |
| 3051 | may be stored using additional precision beyond that of an IEEE-754 32-bit number, |
| 3052 | but float32(x) represents the result of rounding <code>x</code>'s value to |
| 3053 | 32-bit precision. Similarly, <code>x + 0.1</code> may use more than 32 bits |
| 3054 | of precision, <code>but float32(x + 0.1)</code> does not. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3055 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3056 | </ol> |
| 3057 | |
| 3058 | <p> |
| 3059 | In all conversions involving floating-point values, if the result type cannot |
| 3060 | represent the value the conversion succeeds but the result value is |
| 3061 | implementation-dependent. |
| 3062 | </p> |
| 3063 | |
| 3064 | <h4>Conversions to a string type</h4> |
| 3065 | <ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3066 | <li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3067 | Converting an integer value yields a string containing the UTF-8 |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3068 | representation of the integer. |
| 3069 | |
| 3070 | <pre> |
| 3071 | string(0x65e5) // "\u65e5" == "日" == "\xe6\x97\xa5" |
| 3072 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3073 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3074 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3075 | <li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3076 | Converting a slice of integers yields a string that is the |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3077 | concatenation of the individual integers converted to strings. |
| 3078 | If the slice value is <code>nil</code>, the result is the empty string. |
| 3079 | <pre> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3080 | string([]int{0x767d, 0x9d6c, 0x7fd4}) // "\u767d\u9d6c\u7fd4" == "白鵬翔" |
| 3081 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3082 | </li> |
| 3083 | |
| 3084 | <li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3085 | Converting a slice of bytes yields a string whose successive |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3086 | bytes are those of the slice. If the slice value is <code>nil</code>, |
| 3087 | the result is the empty string. |
| 3088 | |
| 3089 | <pre> |
| 3090 | string([]byte{'h', 'e', 'l', 'l', 'o'}) // "hello" |
| 3091 | </pre> |
| 3092 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3093 | </ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3094 | |
| 3095 | <p> |
| 3096 | There is no linguistic mechanism to convert between pointers and integers. |
| 3097 | The package <a href="#Package_unsafe"><code>unsafe</code></a> |
| 3098 | implements this functionality under |
| 3099 | restricted circumstances. |
| 3100 | </p> |
| 3101 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3102 | <h3 id="Constant_expressions">Constant expressions</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 3103 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3104 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3105 | Constant expressions may contain only <a href="#Constants">constant</a> |
| 3106 | operands and are evaluated at compile-time. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3107 | </p> |
| 3108 | |
| 3109 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3110 | Untyped boolean, numeric, and string constants may be used as operands |
| 3111 | wherever it is legal to use an operand of boolean, numeric, or string type, |
| 3112 | respectively. Except for shift operations, if the operands of a binary operation |
| 3113 | are an untyped integer constant and an untyped floating-point constant, |
| 3114 | the integer constant is converted to an untyped floating-point constant |
| 3115 | (relevant for <code>/</code> and <code>%</code>). |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3116 | </p> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 3117 | |
| 3118 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3119 | Applying an operator to untyped constants results in an untyped |
| 3120 | constant of the same kind (that is, a boolean, integer, floating-point, or |
| 3121 | string constant), except for |
| 3122 | <a href="#Comparison_operators">comparison operators</a> which result in |
| 3123 | a constant of type <code>bool</code>. |
| 3124 | </p> |
| 3125 | |
| 3126 | <p> |
| 3127 | Constant expressions are always evaluated exactly; intermediate values and the |
| 3128 | constants themselves may require precision significantly larger than supported |
| 3129 | by any predeclared type in the language. The following are legal declarations: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3130 | </p> |
| 3131 | |
| 3132 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3133 | const Huge = 1 << 100; |
| 3134 | const Four int8 = Huge >> 98; |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3135 | </pre> |
| 3136 | |
| 3137 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3138 | The values of <i>typed</i> constants must always be accurately representable as values |
| 3139 | of the constant type. The following constant expressions are illegal: |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3140 | </p> |
| 3141 | |
| 3142 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3143 | uint(-1) // -1 overflows uint |
| 3144 | int(3.14) // 3.14 truncated to integer |
| 3145 | int64(Huge) // 1<<100 overflows int64 |
| 3146 | Four * 300 // 300 overflows int8 |
| 3147 | Four * 100 // 400 overflows int8 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3148 | </pre> |
| 3149 | |
| 3150 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3151 | The mask used by the unary bitwise complement operator <code>^</code> matches |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3152 | the rule for non-constants: the mask is all 1s for unsigned constants |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3153 | and -1 for signed and untyped constants. |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3154 | </p> |
| 3155 | |
| 3156 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3157 | ^1 // untyped integer constant, equal to -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3158 | uint8(^1) // error, same as uint8(-2), out of range |
| 3159 | ^uint8(1) // typed uint8 constant, same as 0xFF ^ uint8(1) = uint8(0xFE) |
| 3160 | int8(^1) // same as int8(-2) |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 3161 | ^int8(1) // same as -1 ^ int8(1) = -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3162 | </pre> |
| 3163 | |
| 3164 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3165 | <span class="alert"> |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3166 | TODO: perhaps ^ should be disallowed on non-uints instead of assuming twos complement. |
| 3167 | Also it may be possible to make typed constants more like variables, at the cost of fewer |
| 3168 | overflow etc. errors being caught. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3169 | </span> |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3170 | </p> |
| 3171 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3172 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3173 | <h3 id="Order_of_evaluation">Order of evaluation</h3> |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3174 | |
| 3175 | <p> |
| 3176 | When evaluating the elements of an assignment or expression, |
| 3177 | all function calls, method calls and |
| 3178 | communication operations are evaluated in lexical left-to-right |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3179 | order. |
| 3180 | </p> |
| 3181 | |
| 3182 | <p> |
| 3183 | Floating-point operations within a single expression are evaluated according to |
| 3184 | the associativity of the operators. Explicit parentheses affect the evaluation |
| 3185 | by overriding the default associativity. |
| 3186 | In the expression <code>x + (y + z)</code> the addition <code>y + z</code> |
| 3187 | is performed before adding <code>x</code>. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3188 | </p> |
| 3189 | |
| 3190 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3191 | For example, in the assignment |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3192 | </p> |
| 3193 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3194 | y[f()], ok = g(h(), i() + x[j()], <-c), k() |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3195 | </pre> |
| 3196 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3197 | the function calls and communication happen in the order |
| 3198 | <code>f()</code>, <code>h()</code>, <code>i()</code>, <code>j()</code>, |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3199 | <code><-c</code>, <code>g()</code>, and <code>k()</code>. |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3200 | However, the order of those events compared to the evaluation |
| 3201 | and indexing of <code>x</code> and the evaluation |
| 3202 | of <code>y</code> is not specified. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3203 | </p> |
| 3204 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3205 | <h2 id="Statements">Statements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3206 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3207 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3208 | Statements control execution. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3209 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3210 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3211 | <pre class="ebnf"> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3212 | Statement = |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3213 | Declaration | LabeledStmt | SimpleStmt | |
| 3214 | GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt | |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3215 | FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt | |
| 3216 | DeferStmt . |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 3217 | |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3218 | SimpleStmt = EmptyStmt | ExpressionStmt | IncDecStmt | Assignment | ShortVarDecl . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3219 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3220 | StatementList = Statement { Separator Statement } . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3221 | Separator = [ ";" ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3222 | </pre> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 3223 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3224 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3225 | Elements of a list of statements are separated by semicolons, |
| 3226 | which may be omitted only if the previous statement: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 3227 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3228 | <ul> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 3229 | <li>ends with the closing parenthesis ")" of a list of <a href="#Declarations_and_scope">declarations</a>; or</li> |
Rob Pike | 736a1ae | 2009-04-02 23:03:41 -0700 | [diff] [blame] | 3230 | <li>ends with a closing brace "}" that is not part of an expression. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3231 | </ul> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 3232 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3233 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3234 | <h3 id="Empty_statements">Empty statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3235 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3236 | <p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3237 | The empty statement does nothing. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3238 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3239 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3240 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3241 | EmptyStmt = . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3242 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3243 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3244 | <p> |
| 3245 | A statement list can always in effect be terminated with a semicolon by |
| 3246 | adding an empty statement. |
| 3247 | </p> |
| 3248 | |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3249 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3250 | <h3 id="Labeled_statements">Labeled statements</h3> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3251 | |
| 3252 | <p> |
| 3253 | A labeled statement may be the target of a <code>goto</code>, |
| 3254 | <code>break</code> or <code>continue</code> statement. |
| 3255 | </p> |
| 3256 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3257 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3258 | LabeledStmt = Label ":" Statement . |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3259 | Label = identifier . |
| 3260 | </pre> |
| 3261 | |
| 3262 | <pre> |
| 3263 | Error: log.Fatal("error encountered") |
| 3264 | </pre> |
| 3265 | |
| 3266 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3267 | <h3 id="Expression_statements">Expression statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3268 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3269 | <p> |
| 3270 | Function calls, method calls, and channel operations |
| 3271 | can appear in statement context. |
| 3272 | </p> |
| 3273 | |
| 3274 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3275 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3276 | ExpressionStmt = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3277 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3278 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3279 | <pre> |
| 3280 | f(x+y) |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3281 | <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3282 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3283 | |
| 3284 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3285 | <h3 id="IncDec_statements">IncDec statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3286 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3287 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3288 | The "++" and "--" statements increment or decrement their operands |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3289 | by the untyped <a href="#Constants">constant</a> <code>1</code>. |
| 3290 | As with an assignment, the operand must be a variable, pointer indirection, |
| 3291 | field selector or index expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3292 | </p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3293 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3294 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3295 | IncDecStmt = Expression ( "++" | "--" ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3296 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3297 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3298 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 3299 | The following <a href="#Assignments">assignment statements</a> are semantically |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3300 | equivalent: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3301 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3302 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3303 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3304 | IncDec statement Assignment |
| 3305 | x++ x += 1 |
| 3306 | x-- x -= 1 |
| 3307 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3308 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3309 | <h3 id="Assignments">Assignments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3310 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3311 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3312 | Assignment = ExpressionList assign_op ExpressionList . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3313 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3314 | assign_op = [ add_op | mul_op ] "=" . |
| 3315 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3316 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3317 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3318 | Each left-hand side operand must be <a href="#Address_operators">addressable</a>, |
| 3319 | a map index expresssion, |
| 3320 | or the <a href="#Blank_identifier">blank identifier</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3321 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3322 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3323 | <pre> |
| 3324 | x = 1 |
| 3325 | *p = f() |
| 3326 | a[i] = 23 |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3327 | k = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3328 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3329 | |
| 3330 | <p> |
| 3331 | An <i>assignment operation</i> <code>x</code> <i>op</i><code>=</code> |
| 3332 | <code>y</code> where <i>op</i> is a binary arithmetic operation is equivalent |
| 3333 | to <code>x</code> <code>=</code> <code>x</code> <i>op</i> |
| 3334 | <code>y</code> but evalutates <code>x</code> |
| 3335 | only once. The <i>op</i><code>=</code> construct is a single token. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3336 | In assignment operations, both the left- and right-hand expression lists |
| 3337 | must contain exactly one single-valued expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3338 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3339 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3340 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3341 | a[i] <<= 2 |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3342 | i &^= 1<<n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3343 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3344 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3345 | <p> |
| 3346 | A tuple assignment assigns the individual elements of a multi-valued |
| 3347 | operation to a list of variables. There are two forms. In the |
| 3348 | first, the right hand operand is a single multi-valued expression |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 3349 | such as a function evaluation or <a href="#Channel_types">channel</a> or |
| 3350 | <a href="#Map_types">map</a> operation or a <a href="#Type_assertions">type assertion</a>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3351 | The number of operands on the left |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3352 | hand side must match the number of values. For instance, if |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3353 | <code>f</code> is a function returning two values, |
| 3354 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3355 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3356 | <pre> |
| 3357 | x, y = f() |
| 3358 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3359 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3360 | <p> |
| 3361 | assigns the first value to <code>x</code> and the second to <code>y</code>. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3362 | The <a href="#Blank_identifier">blank identifier</a> provides a |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3363 | way to ignore values returned by a multi-valued expression: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3364 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3365 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3366 | <pre> |
| 3367 | x, _ = f() // ignore second value returned by f() |
| 3368 | </pre> |
| 3369 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3370 | <p> |
| 3371 | In the second form, the number of operands on the left must equal the number |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 3372 | of expressions on the right, each of which must be single-valued, and the |
| 3373 | <i>n</i>th expression on the right is assigned to the <i>n</i>th |
| 3374 | operand on the left. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3375 | The expressions on the right are evaluated before assigning to |
| 3376 | any of the operands on the left, but otherwise the evaluation |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3377 | order is unspecified beyond <a href="#Order_of_evaluation">the usual rules</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3378 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3379 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3380 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3381 | a, b = b, a // exchange a and b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3382 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3383 | |
| 3384 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3385 | In assignments, each value must be |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3386 | <a href="#Assignment_compatibility">assignment compatible</a> with the type of the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3387 | operand to which it is assigned. If an untyped <a href="#Constants">constant</a> |
| 3388 | is assigned to a variable of interface type, the constant is <a href="#Conversions">converted</a> |
| 3389 | to type <code>bool</code>, <code>int</code>, <code>float</code>, or <code>string</code> |
| 3390 | respectively, depending on whether the value is a boolean, integer, floating-point, |
| 3391 | or string constant. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3392 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3393 | |
| 3394 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3395 | <h3 id="If_statements">If statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3396 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3397 | <p> |
| 3398 | "If" statements specify the conditional execution of two branches |
| 3399 | according to the value of a boolean expression. If the expression |
| 3400 | evaluates to true, the "if" branch is executed, otherwise, if |
| 3401 | present, the "else" branch is executed. A missing condition |
| 3402 | is equivalent to <code>true</code>. |
| 3403 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3404 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3405 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3406 | IfStmt = "if" [ SimpleStmt ";" ] [ Expression ] Block [ "else" Statement ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3407 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3408 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3409 | <pre> |
| 3410 | if x > 0 { |
| 3411 | return true; |
| 3412 | } |
| 3413 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3414 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3415 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3416 | The expression may be preceded by a simple statement, which |
| 3417 | executes before the expression is evaluated. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3418 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3419 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3420 | <pre> |
| 3421 | if x := f(); x < y { |
| 3422 | return x; |
| 3423 | } else if x > z { |
| 3424 | return z; |
| 3425 | } else { |
| 3426 | return y; |
| 3427 | } |
| 3428 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3429 | |
| 3430 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3431 | <h3 id="Switch_statements">Switch statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3432 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3433 | <p> |
| 3434 | "Switch" statements provide multi-way execution. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3435 | An expression or type specifier is compared to the "cases" |
| 3436 | inside the "switch" to determine which branch |
| 3437 | to execute. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3438 | </p> |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3439 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3440 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3441 | SwitchStmt = ExprSwitchStmt | TypeSwitchStmt . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3442 | </pre> |
| 3443 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3444 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3445 | There are two forms: expression switches and type switches. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3446 | In an expression switch, the cases contain expressions that are compared |
| 3447 | against the value of the switch expression. |
| 3448 | In a type switch, the cases contain types that are compared against the |
| 3449 | type of a specially annotated switch expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3450 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3451 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3452 | <h4 id="Expression_switches">Expression switches</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3453 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3454 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3455 | In an expression switch, |
| 3456 | the switch expression is evaluated and |
| 3457 | the case expressions, which need not be constants, |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3458 | are evaluated left-to-right and top-to-bottom; the first one that equals the |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3459 | switch expression |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3460 | triggers execution of the statements of the associated case; |
| 3461 | the other cases are skipped. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3462 | If no case matches and there is a "default" case, |
| 3463 | its statements are executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3464 | There can be at most one default case and it may appear anywhere in the |
| 3465 | "switch" statement. |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3466 | A missing expression is equivalent to |
| 3467 | the expression <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3468 | </p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3469 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3470 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3471 | ExprSwitchStmt = "switch" [ SimpleStmt ";" ] [ Expression ] "{" { ExprCaseClause } "}" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3472 | ExprCaseClause = ExprSwitchCase ":" [ StatementList ] . |
| 3473 | ExprSwitchCase = "case" ExpressionList | "default" . |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3474 | </pre> |
| 3475 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3476 | <p> |
| 3477 | In a case or default clause, |
| 3478 | the last statement only may be a "fallthrough" statement |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3479 | (§<a href="#Fallthrough_statement">Fallthrough statement</a>) to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3480 | indicate that control should flow from the end of this clause to |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3481 | the first statement of the next clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3482 | Otherwise control flows to the end of the "switch" statement. |
| 3483 | </p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 3484 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3485 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3486 | The expression may be preceded by a simple statement, which |
| 3487 | executes before the expression is evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3488 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3489 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3490 | <pre> |
| 3491 | switch tag { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3492 | default: s3() |
| 3493 | case 0, 1, 2, 3: s1() |
| 3494 | case 4, 5, 6, 7: s2() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3495 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3496 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3497 | switch x := f(); { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3498 | case x < 0: return -x |
| 3499 | default: return x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3500 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3501 | |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3502 | switch { // missing expression means "true" |
| 3503 | case x < y: f1(); |
| 3504 | case x < z: f2(); |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3505 | case x == 4: f3(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3506 | } |
| 3507 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3508 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3509 | <h4 id="Type_switches">Type switches</h4> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3510 | |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3511 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3512 | A type switch compares types rather than values. It is otherwise similar |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3513 | to an expression switch. It is marked by a special switch expression that |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3514 | has the form of a <a href="#Type_assertions">type assertion</a> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3515 | using the reserved word <code>type</code> rather than an actual type. |
| 3516 | Cases then match literal types against the dynamic type of the expression |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 3517 | in the type assertion. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3518 | </p> |
| 3519 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3520 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3521 | TypeSwitchStmt = "switch" [ SimpleStmt ";" ] TypeSwitchGuard "{" { TypeCaseClause } "}" . |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3522 | TypeSwitchGuard = [ identifier ":=" ] Expression "." "(" "type" ")" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3523 | TypeCaseClause = TypeSwitchCase ":" [ StatementList ] . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3524 | TypeSwitchCase = "case" TypeList | "default" . |
| 3525 | TypeList = Type { "," Type } . |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3526 | </pre> |
| 3527 | |
| 3528 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3529 | The TypeSwitchGuard may include a |
| 3530 | <a href="#Short_variable_declarations">short variable declaration</a>. |
| 3531 | When that form is used, the variable is declared in each clause. |
| 3532 | In clauses with a case listing exactly one type, the variable |
| 3533 | has that type; otherwise, the variable has the type of the expression |
| 3534 | in the TypeSwitchGuard. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3535 | </p> |
| 3536 | |
| 3537 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3538 | The type in a case may be <code>nil</code> |
| 3539 | (§<a href="#Predeclared_identifiers">Predeclared identifiers</a>); |
| 3540 | that case is used when the expression in the TypeSwitchGuard |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3541 | is a <code>nil</code> interface value. |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3542 | </p> |
| 3543 | |
| 3544 | <p> |
| 3545 | Given a function <code>f</code> that returns |
| 3546 | a value of type <code>interface{}</code>, |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3547 | the following type switch: |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3548 | </p> |
| 3549 | |
| 3550 | <pre> |
| 3551 | switch i := f().(type) { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3552 | case nil: |
| 3553 | printString("f() returns nil"); |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3554 | case int: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3555 | printInt(i); // i is an int |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3556 | case float: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3557 | printFloat(i); // i is a float |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3558 | case func(int) float: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3559 | printFunction(i); // i is a function |
| 3560 | case bool, string: |
| 3561 | printString("type is bool or string"); // i is an interface{} |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3562 | default: |
| 3563 | printString("don't know the type"); |
| 3564 | } |
| 3565 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3566 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3567 | <p> |
| 3568 | could be rewritten: |
| 3569 | </p> |
| 3570 | |
| 3571 | <pre> |
| 3572 | v := f(); |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3573 | if v == nil { |
| 3574 | printString("f() returns nil"); |
| 3575 | } else if i, is_int := v.(int); is_int { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3576 | printInt(i); // i is an int |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3577 | } else if i, is_float := v.(float); is_float { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3578 | printFloat(i); // i is a float |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3579 | } else if i, is_func := v.(func(int) float); is_func { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3580 | printFunction(i); // i is a function |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3581 | } else { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3582 | i1, is_bool := v.(bool); |
| 3583 | i2, is_string := v.(string); |
| 3584 | if is_bool || is_string { |
| 3585 | i := v; |
| 3586 | printString("type is bool or string"); // i is an interface{} |
| 3587 | } else { |
| 3588 | i := v; |
| 3589 | printString("don't know the type"); // i is an interface{} |
| 3590 | } |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3591 | } |
| 3592 | </pre> |
| 3593 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 3594 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3595 | The type switch guard may be preceded by a simple statement, which |
| 3596 | executes before the guard is evaluated. |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3597 | </p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3598 | |
| 3599 | <p> |
| 3600 | The "fallthrough" statement is not permitted in a type switch. |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3601 | </p> |
| 3602 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3603 | <h3 id="For_statements">For statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3604 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3605 | <p> |
| 3606 | A "for" statement specifies repeated execution of a block. The iteration is |
| 3607 | controlled by a condition, a "for" clause, or a "range" clause. |
| 3608 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3609 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3610 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3611 | ForStmt = "for" [ Condition | ForClause | RangeClause ] Block . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3612 | Condition = Expression . |
| 3613 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3614 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3615 | <p> |
| 3616 | In its simplest form, a "for" statement specifies the repeated execution of |
| 3617 | a block as long as a boolean condition evaluates to true. |
| 3618 | The condition is evaluated before each iteration. |
| 3619 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3620 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3621 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3622 | <pre> |
| 3623 | for a < b { |
| 3624 | a *= 2 |
| 3625 | } |
| 3626 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3627 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3628 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3629 | A "for" statement with a ForClause is also controlled by its condition, but |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3630 | additionally it may specify an <i>init</i> |
| 3631 | and a <i>post</i> statement, such as an assignment, |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3632 | an increment or decrement statement. The init statement may be a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3633 | <a href="#Short_variable_declarations">short variable declaration</a>, but the post statement must not. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3634 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3635 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3636 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3637 | ForClause = InitStmt ";" [ Condition ] ";" PostStmt . |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3638 | InitStmt = SimpleStmt . |
| 3639 | PostStmt = SimpleStmt . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3640 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3641 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3642 | <pre> |
| 3643 | for i := 0; i < 10; i++ { |
| 3644 | f(i) |
| 3645 | } |
| 3646 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3647 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3648 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3649 | If non-empty, the init statement is executed once before evaluating the |
| 3650 | condition for the first iteration; |
| 3651 | the post statement is executed after each execution of the block (and |
| 3652 | only if the block was executed). |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3653 | Any element of the ForClause may be empty but the semicolons are |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3654 | required unless there is only a condition. |
| 3655 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3656 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3657 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3658 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3659 | for cond { S() } is the same as for ; cond ; { S() } |
| 3660 | for { S() } is the same as for true { S() } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3661 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3662 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3663 | <p> |
| 3664 | A "for" statement with a "range" clause |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3665 | iterates through all entries of an array, slice, string or map, |
| 3666 | or values received on a channel. |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3667 | For each entry it first assigns the current index or key to an iteration |
| 3668 | variable - or the current (index, element) or (key, value) pair to a pair |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3669 | of iteration variables - and then executes the block. |
| 3670 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3671 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3672 | <pre class="ebnf"> |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3673 | RangeClause = ExpressionList ( "=" | ":=" ) "range" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3674 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3675 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3676 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3677 | The type of the right-hand expression in the "range" clause must be an |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3678 | array, slice, string or map, or a pointer to an array; |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3679 | or it may be a channel. |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3680 | Except for channels, |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3681 | the identifier list must contain one or two expressions |
| 3682 | (as in assignments, these must be a |
| 3683 | variable, pointer indirection, field selector, or index expression) |
| 3684 | denoting the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3685 | iteration variables. On each iteration, |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3686 | the first variable is set to the string, array or slice index or |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3687 | map key, and the second variable, if present, is set to the corresponding |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3688 | string or array element or map value. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3689 | The types of the array or slice index (always <code>int</code>) |
| 3690 | and element, or of the map key and value respectively, |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 3691 | must be <a href="#Assignment_compatibility">assignment compatible</a> with |
| 3692 | the type of the iteration variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3693 | </p> |
| 3694 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3695 | For strings, the "range" clause iterates over the Unicode code points |
| 3696 | in the string. On successive iterations, the index variable will be the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3697 | index of the first byte of successive UTF-8-encoded code points in the string, and |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3698 | the second variable, of type <code>int</code>, will be the value of |
| 3699 | the corresponding code point. If the iteration encounters an invalid |
| 3700 | UTF-8 sequence, the second variable will be <code>0xFFFD</code>, |
| 3701 | the Unicode replacement character, and the next iteration will advance |
| 3702 | a single byte in the string. |
| 3703 | </p> |
| 3704 | <p> |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3705 | For channels, the identifier list must contain one identifier. |
Robert Griesemer | ce9fbdb | 2009-04-29 11:45:08 -0700 | [diff] [blame] | 3706 | The iteration receives values sent on the channel until the channel is closed; |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3707 | it does not process the zero value sent before the channel is closed. |
| 3708 | </p> |
| 3709 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3710 | The iteration variables may be declared by the "range" clause (":="), in which |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3711 | case their scope ends at the end of the "for" statement (§<a href="#Declarations_and">Declarations and</a> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3712 | scope rules). In this case their types are set to |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3713 | <code>int</code> and the array element type, or the map key and value types, respectively. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3714 | If the iteration variables are declared outside the "for" statement, |
| 3715 | after execution their values will be those of the last iteration. |
| 3716 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3717 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3718 | <pre> |
| 3719 | var a [10]string; |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 3720 | m := map[string]int{"mon":0, "tue":1, "wed":2, "thu":3, "fri":4, "sat":5, "sun":6}; |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3721 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3722 | for i, s := range a { |
| 3723 | // type of i is int |
| 3724 | // type of s is string |
| 3725 | // s == a[i] |
| 3726 | g(i, s) |
| 3727 | } |
| 3728 | |
| 3729 | var key string; |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3730 | var val interface {}; // value type of m is assignment compatible to val |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3731 | for key, val = range m { |
| 3732 | h(key, val) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3733 | } |
| 3734 | // key == last map key encountered in iteration |
| 3735 | // val == map[key] |
| 3736 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3737 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3738 | <p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3739 | If map entries that have not yet been processed are deleted during iteration, |
| 3740 | they will not be processed. If map entries are inserted during iteration, the |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3741 | behavior is implementation-dependent, but each entry will be processed at most once. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3742 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3743 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3744 | <h3 id="Go_statements">Go statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3745 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3746 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3747 | A "go" statement starts the execution of a function or method call |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3748 | as an independent concurrent thread of control, or <i>goroutine</i>, |
| 3749 | within the same address space. |
| 3750 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3751 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3752 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3753 | GoStmt = "go" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3754 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3755 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3756 | <p> |
| 3757 | The expression must be a call, and |
| 3758 | unlike with a regular call, program execution does not wait |
Robert Griesemer | b9f8b9c | 2008-09-26 13:38:38 -0700 | [diff] [blame] | 3759 | for the invoked function to complete. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3760 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3761 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3762 | <pre> |
| 3763 | go Server() |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3764 | go func(ch chan<- bool) { for { sleep(10); ch <- true; }} (c) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3765 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3766 | |
| 3767 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3768 | <h3 id="Select_statements">Select statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3769 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3770 | <p> |
| 3771 | A "select" statement chooses which of a set of possible communications |
| 3772 | will proceed. It looks similar to a "switch" statement but with the |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3773 | cases all referring to communication operations. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3774 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3775 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3776 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3777 | SelectStmt = "select" "{" { CommClause } "}" . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3778 | CommClause = CommCase ":" StatementList . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3779 | CommCase = "case" ( SendExpr | RecvExpr) | "default" . |
| 3780 | SendExpr = Expression "<-" Expression . |
| 3781 | RecvExpr = [ Expression ( "=" | ":=" ) ] "<-" Expression . |
| 3782 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3783 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3784 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3785 | For all the send and receive expressions in the "select" |
Rob Pike | 9d7538b | 2009-09-16 11:49:35 -0700 | [diff] [blame] | 3786 | statement, the channel expressions are evaluated, along with |
| 3787 | any expressions that appear on the right hand side of send expressions, |
| 3788 | in top-to-bottom order. |
| 3789 | If any of the resulting operations can proceed, one is |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3790 | chosen and the corresponding communication and statements are |
| 3791 | evaluated. Otherwise, if there is a default case, that executes; |
Rob Pike | cd368a2 | 2008-10-02 10:37:12 -0700 | [diff] [blame] | 3792 | if not, the statement blocks until one of the communications can |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3793 | complete. The channels and send expressions are not re-evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3794 | A channel pointer may be <code>nil</code>, |
| 3795 | which is equivalent to that case not |
| 3796 | being present in the select statement |
| 3797 | except, if a send, its expression is still evaluated. |
| 3798 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3799 | <p> |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3800 | Since all the channels and send expressions are evaluated, any side |
| 3801 | effects in that evaluation will occur for all the communications |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3802 | in the "select" statement. |
| 3803 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3804 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3805 | If multiple cases can proceed, a uniform fair choice is made to decide |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3806 | which single communication will execute. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3807 | <p> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3808 | The receive case may declare a new variable using a |
| 3809 | <a href="#Short_variable_declarations">short variable declaration</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3810 | </p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 3811 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3812 | <pre> |
| 3813 | var c, c1, c2 chan int; |
| 3814 | var i1, i2 int; |
| 3815 | select { |
| 3816 | case i1 = <-c1: |
| 3817 | print("received ", i1, " from c1\n"); |
| 3818 | case c2 <- i2: |
| 3819 | print("sent ", i2, " to c2\n"); |
| 3820 | default: |
| 3821 | print("no communication\n"); |
| 3822 | } |
| 3823 | |
| 3824 | for { // send random sequence of bits to c |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3825 | select { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3826 | case c <- 0: // note: no statement, no fallthrough, no folding of cases |
| 3827 | case c <- 1: |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3828 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3829 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3830 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3831 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3832 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3833 | <h3 id="Return_statements">Return statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3834 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3835 | <p> |
| 3836 | A "return" statement terminates execution of the containing function |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3837 | and optionally provides a result value or values to the caller. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3838 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3839 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3840 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3841 | ReturnStmt = "return" [ ExpressionList ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3842 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3843 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3844 | <p> |
| 3845 | In a function without a result type, a "return" statement must not |
| 3846 | specify any result values. |
| 3847 | </p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3848 | <pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3849 | func no_result() { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3850 | return |
| 3851 | } |
| 3852 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3853 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3854 | <p> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3855 | There are three ways to return values from a function with a result |
| 3856 | type: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3857 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3858 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3859 | <ol> |
| 3860 | <li>The return value or values may be explicitly listed |
| 3861 | in the "return" statement. Each expression must be single-valued |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 3862 | and <a href="#Assignment_compatibility">assignment compatible</a> |
| 3863 | with the type of the corresponding element of the function's |
| 3864 | result type. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3865 | <pre> |
| 3866 | func simple_f() int { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3867 | return 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3868 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3869 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3870 | func complex_f1() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3871 | return -7.0, -4.0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3872 | } |
| 3873 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3874 | </li> |
| 3875 | <li>The expression list in the "return" statement may be a single |
| 3876 | call to a multi-valued function. The effect is as if each value |
| 3877 | returned from that function were assigned to a temporary |
| 3878 | variable with the type of the respective value, followed by a |
| 3879 | "return" statement listing these variables, at which point the |
| 3880 | rules of the previous case apply. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3881 | <pre> |
| 3882 | func complex_f2() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3883 | return complex_f1() |
| 3884 | } |
| 3885 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3886 | </li> |
| 3887 | <li>The expression list may be empty if the functions's result |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3888 | type specifies names for its result parameters (§<a href="#Function_Types">Function Types</a>). |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3889 | The result parameters act as ordinary local variables that are |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3890 | initialized to the zero values for their type (§<a href="#The_zero_value">The zero value</a>) |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3891 | and the function may assign values to them as necessary. |
| 3892 | The "return" statement returns the values of these variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3893 | <pre> |
| 3894 | func complex_f3() (re float, im float) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3895 | re = 7.0; |
| 3896 | im = 4.0; |
| 3897 | return; |
| 3898 | } |
| 3899 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3900 | </li> |
| 3901 | </ol> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3902 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3903 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3904 | <span class="alert"> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3905 | TODO: Define when return is required.<br /> |
| 3906 | TODO: Language about result parameters needs to go into a section on |
| 3907 | function/method invocation<br /> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3908 | </span> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3909 | </p> |
| 3910 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3911 | <h3 id="Break_statements">Break statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3912 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3913 | <p> |
| 3914 | A "break" statement terminates execution of the innermost |
| 3915 | "for", "switch" or "select" statement. |
| 3916 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3917 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3918 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3919 | BreakStmt = "break" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3920 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3921 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3922 | <p> |
| 3923 | If there is a label, it must be that of an enclosing |
| 3924 | "for", "switch" or "select" statement, and that is the one whose execution |
| 3925 | terminates |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3926 | (§<a href="#For_statements">For statements</a>, §<a href="#Switch_statements">Switch statements</a>, §<a href="#Select_statements">Select statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3927 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3928 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3929 | <pre> |
| 3930 | L: for i < n { |
| 3931 | switch i { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3932 | case 5: break L |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3933 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3934 | } |
| 3935 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3936 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3937 | <h3 id="Continue_statements">Continue statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3938 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3939 | <p> |
| 3940 | A "continue" statement begins the next iteration of the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3941 | innermost "for" loop at its post statement (§<a href="#For_statements">For statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3942 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3943 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3944 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3945 | ContinueStmt = "continue" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3946 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3947 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3948 | <p> |
| 3949 | The optional label is analogous to that of a "break" statement. |
| 3950 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3951 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3952 | <h3 id="Goto_statements">Goto statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3953 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3954 | <p> |
| 3955 | A "goto" statement transfers control to the statement with the corresponding label. |
| 3956 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3957 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3958 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3959 | GotoStmt = "goto" Label . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3960 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3961 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3962 | <pre> |
| 3963 | goto Error |
| 3964 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3965 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3966 | <p> |
| 3967 | Executing the "goto" statement must not cause any variables to come into |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3968 | scope that were not already in scope at the point of the goto. For |
| 3969 | instance, this example: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3970 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3971 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3972 | <pre> |
| 3973 | goto L; // BAD |
| 3974 | v := 3; |
| 3975 | L: |
| 3976 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3977 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3978 | <p> |
| 3979 | is erroneous because the jump to label <code>L</code> skips |
| 3980 | the creation of <code>v</code>. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3981 | (<span class="alert">TODO: Eliminate in favor of used and not set errors?</span>) |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3982 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3983 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3984 | <h3 id="Fallthrough_statements">Fallthrough statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3985 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3986 | <p> |
| 3987 | A "fallthrough" statement transfers control to the first statement of the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3988 | next case clause in a expression "switch" statement (§<a href="#Expression_switches">Expression switches</a>). It may |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3989 | be used only as the final non-empty statement in a case or default clause in an |
| 3990 | expression "switch" statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3991 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3992 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3993 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3994 | FallthroughStmt = "fallthrough" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3995 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3996 | |
| 3997 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3998 | <h3 id="Defer_statements">Defer statements</h3> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3999 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4000 | <p> |
| 4001 | A "defer" statement invokes a function whose execution is deferred to the moment |
| 4002 | the surrounding function returns. |
| 4003 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4004 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4005 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4006 | DeferStmt = "defer" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4007 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4008 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4009 | <p> |
| 4010 | The expression must be a function or method call. |
| 4011 | Each time the "defer" statement |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 4012 | executes, the parameters to the function call are evaluated and saved anew but the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4013 | function is not invoked. |
| 4014 | Deferred function calls are executed in LIFO order |
| 4015 | immediately before the surrounding function returns, |
| 4016 | but after the return values, if any, have been evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4017 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4018 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4019 | <pre> |
| 4020 | lock(l); |
| 4021 | defer unlock(l); // unlocking happens before surrounding function returns |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4022 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4023 | // prints 3 2 1 0 before surrounding function returns |
| 4024 | for i := 0; i <= 3; i++ { |
| 4025 | defer fmt.Print(i); |
| 4026 | } |
| 4027 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4028 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4029 | <h2 id="Built-in_functions">Built-in functions</h2> |
| 4030 | |
| 4031 | <p> |
| 4032 | A small number of built-in functions are |
| 4033 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 4034 | They are called like any other function but some of them |
| 4035 | accept a type instead of an expression as the first argument. |
| 4036 | </p> |
| 4037 | |
| 4038 | <pre class="ebnf"> |
| 4039 | BuiltinCall = identifier "(" [ BuiltinArgs ] ")" . |
| 4040 | BuiltinArgs = Type [ "," ExpressionList ] | ExpressionList . |
| 4041 | </pre> |
| 4042 | |
| 4043 | <h3 id="Close_and_closed">Close and closed</h3> |
| 4044 | |
| 4045 | <p> |
| 4046 | For a channel <code>c</code>, the predefined function <code>close(c)</code> |
| 4047 | marks the channel as unable to accept more |
| 4048 | values through a send operation. After any previously |
| 4049 | sent values have been received, receive operations will return |
| 4050 | the zero value for the channel's type. After at least one such zero value has been |
| 4051 | received, <code>closed(c)</code> returns true. |
| 4052 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4053 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4054 | <h3 id="Length_and_capacity">Length and capacity</h3> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 4055 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4056 | <p> |
| 4057 | The built-in functions <code>len</code> and <code>cap</code> take arguments |
| 4058 | of various types and return a result of type <code>int</code>. |
| 4059 | The implementation guarantees that the result always fits into an <code>int</code>. |
| 4060 | </p> |
| 4061 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4062 | <pre class="grammar"> |
Robert Griesemer | d3ffc5e | 2009-09-03 10:35:09 -0700 | [diff] [blame] | 4063 | Call Argument type Result |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 4064 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4065 | len(s) string type string length in bytes |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 4066 | [n]T, *[n]T array length (== n) |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 4067 | []T slice length |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4068 | map[K]T map length (number of defined keys) |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4069 | chan T number of elements queued in channel buffer |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4070 | |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 4071 | cap(s) [n]T, *[n]T array length (== n) |
| 4072 | []T slice capacity |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 4073 | chan T channel buffer capacity |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4074 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4075 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4076 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4077 | The capacity of a slice is the number of elements for which there is |
| 4078 | space allocated in the underlying array. |
| 4079 | At any time the following relationship holds: |
| 4080 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4081 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4082 | <pre> |
| 4083 | 0 <= len(s) <= cap(s) |
| 4084 | </pre> |
Robert Griesemer | 667ef6c | 2008-09-10 13:00:32 -0700 | [diff] [blame] | 4085 | |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4086 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4087 | <h3 id="Allocation">Allocation</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4088 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4089 | <p> |
| 4090 | The built-in function <code>new</code> takes a type <code>T</code> and |
| 4091 | returns a value of type <code>*T</code>. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 4092 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4093 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4094 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4095 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4096 | <pre> |
| 4097 | new(T) |
| 4098 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4099 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4100 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4101 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4102 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4103 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4104 | <pre> |
| 4105 | type S struct { a int; b float } |
| 4106 | new(S) |
| 4107 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4108 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4109 | <p> |
| 4110 | dynamically allocates memory for a variable of type <code>S</code>, |
| 4111 | initializes it (<code>a=0</code>, <code>b=0.0</code>), |
| 4112 | and returns a value of type <code>*S</code> containing the address |
| 4113 | of the memory. |
| 4114 | </p> |
| 4115 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4116 | <h3 id="Making_slices_maps_and_channels">Making slices, maps and channels</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4117 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4118 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4119 | Slices, maps and channels are reference types that do not require the |
| 4120 | extra indirection of an allocation with <code>new</code>. |
| 4121 | The built-in function <code>make</code> takes a type <code>T</code>, |
| 4122 | which must be a slice, map or channel type, |
| 4123 | optionally followed by a type-specific list of expressions. |
| 4124 | It returns a value of type <code>T</code> (not <code>*T</code>). |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4125 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4126 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4127 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4128 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4129 | <pre> |
| 4130 | make(T [, optional list of expressions]) |
| 4131 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4132 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4133 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4134 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4135 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4136 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4137 | <pre> |
| 4138 | make(map[string] int) |
| 4139 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4140 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4141 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4142 | creates a new map value and initializes it to an empty map. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4143 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4144 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4145 | <p> |
| 4146 | The parameters affect sizes for allocating slices, maps, and |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4147 | buffered channels: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4148 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4149 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4150 | <pre> |
| 4151 | s := make([]int, 10, 100); # slice with len(s) == 10, cap(s) == 100 |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 4152 | s := make([]int, 10); # slice with len(s) == cap(s) == 10 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4153 | c := make(chan int, 10); # channel with a buffer size of 10 |
| 4154 | m := make(map[string] int, 100); # map with initial space for 100 elements |
| 4155 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4156 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4157 | |
| 4158 | <h3 id="Bootstrapping">Bootstrapping</h3> |
| 4159 | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 4160 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4161 | Current implementations provide several built-in functions useful during |
| 4162 | bootstrapping. These functions are documented for completeness but are not |
| 4163 | guaranteed to stay in the language. They do not return a result. |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 4164 | </p> |
| 4165 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4166 | <pre class="grammar"> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 4167 | Function Behavior |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4168 | |
| 4169 | print prints all arguments; formatting of arguments is implementation-specific |
| 4170 | println like print but prints spaces between arguments and a newline at the end |
| 4171 | panic like print, aborts execution after printing |
| 4172 | panicln like println, aborts execution after printing |
| 4173 | </pre> |
| 4174 | |
| 4175 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4176 | <h2 id="Packages">Packages</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4177 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4178 | <p> |
| 4179 | Go programs are constructed by linking together <i>packages</i>. |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 4180 | A package in turn is constructed from one or more source files |
| 4181 | that together declare constants, types, variables and functions |
| 4182 | belonging to the package and which are accessible in all files |
| 4183 | of the same package. Those elements may be |
| 4184 | <a href="#Exported_identifiers">exported</a> and used in another package. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4185 | </p> |
| 4186 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4187 | <h3 id="Source_file_organization">Source file organization</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4188 | |
| 4189 | <p> |
| 4190 | Each source file consists of a package clause defining the package |
| 4191 | to which it belongs, followed by a possibly empty set of import |
| 4192 | declarations that declare packages whose contents it wishes to use, |
| 4193 | followed by a possibly empty set of declarations of functions, |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4194 | types, variables, and constants. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4195 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4196 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4197 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4198 | SourceFile = PackageClause { ImportDecl [ ";" ] } { TopLevelDecl [ ";" ] } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4199 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4200 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4201 | <h3 id="Package_clause">Package clause</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4202 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4203 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4204 | A package clause begins each source file and defines the package |
| 4205 | to which the file belongs. |
| 4206 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4207 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4208 | <pre class="ebnf"> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 4209 | PackageClause = "package" PackageName . |
| 4210 | PackageName = identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4211 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4212 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 4213 | <p> |
| 4214 | The PackageName must not be the <a href="#Blank_identifier">blank identifier</a>. |
| 4215 | </p> |
| 4216 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4217 | <pre> |
| 4218 | package math |
| 4219 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4220 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4221 | <p> |
| 4222 | A set of files sharing the same PackageName form the implementation of a package. |
| 4223 | An implementation may require that all source files for a package inhabit the same directory. |
| 4224 | </p> |
| 4225 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4226 | <h3 id="Import_declarations">Import declarations</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4227 | |
| 4228 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4229 | An import declaration states that the source file containing the |
| 4230 | declaration uses identifiers |
| 4231 | <a href="#Exported_identifiers">exported</a> by the <i>imported</i> |
| 4232 | package and enables access to them. The import names an |
| 4233 | identifier (PackageName) to be used for access and an ImportPath |
| 4234 | that specifies the package to be imported. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4235 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4236 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4237 | <pre class="ebnf"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4238 | ImportDecl = "import" ( ImportSpec | "(" [ ImportSpecList ] ")" ) . |
| 4239 | ImportSpecList = ImportSpec { ";" ImportSpec } [ ";" ] . |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4240 | ImportSpec = [ "." | PackageName ] ImportPath . |
| 4241 | ImportPath = StringLit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4242 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4243 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4244 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4245 | The PackageName is used in <a href="#Qualified_identifiers">qualified identifiers</a> |
| 4246 | to access the exported identifiers of the package within the importing source file. |
| 4247 | It is declared in the <a href="#Blocks">file block</a>. |
| 4248 | If the PackageName is omitted, it defaults to the identifier specified in the |
| 4249 | <a href="#Package_clauses">package clause</a> of the imported package. |
| 4250 | If an explicit period (<code>.</code>) appears instead of a name, all the |
| 4251 | package's exported identifiers will be declared in the current file's |
| 4252 | file block and can be accessed without a qualifier. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4253 | </p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4254 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4255 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4256 | The interpretation of the ImportPath is implementation-dependent but |
| 4257 | it is typically a substring of the full file name of the compiled |
| 4258 | package and may be relative to a repository of installed packages. |
| 4259 | </p> |
| 4260 | |
| 4261 | <p> |
| 4262 | Assume we have compiled a package containing the package clause |
| 4263 | <code>package math</code>, which exports function <code>Sin</code>, and |
| 4264 | installed the compiled package in the file identified by |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4265 | <code>"lib/math"</code>. |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4266 | This table illustrates how <code>Sin</code> may be accessed in files |
| 4267 | that import the package after the |
| 4268 | various types of import declaration. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4269 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4270 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4271 | <pre class="grammar"> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4272 | Import declaration Local name of Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4273 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4274 | import "lib/math" math.Sin |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4275 | import M "lib/math" M.Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4276 | import . "lib/math" Sin |
| 4277 | </pre> |
| 4278 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4279 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4280 | An import declaration declares a dependency relation between |
| 4281 | the importing and imported package. |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4282 | It is illegal for a package to import itself or to import a package without |
| 4283 | referring to any of its exported identifiers. To import a package solely for |
| 4284 | its side-effects (initialization), use the <a href="#Blank_identifier">blank</a> |
| 4285 | identifier as explicit package name: |
| 4286 | </p> |
| 4287 | |
| 4288 | <pre> |
| 4289 | import _ "lib/math" |
| 4290 | </pre> |
| 4291 | |
| 4292 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4293 | <h3 id="An_example_package">An example package</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4294 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4295 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4296 | Here is a complete Go package that implements a concurrent prime sieve. |
| 4297 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4298 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4299 | <pre> |
| 4300 | package main |
| 4301 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4302 | import "fmt" |
| 4303 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4304 | // Send the sequence 2, 3, 4, ... to channel 'ch'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4305 | func generate(ch chan<- int) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4306 | for i := 2; ; i++ { |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4307 | ch <- i; // Send 'i' to channel 'ch'. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4308 | } |
| 4309 | } |
| 4310 | |
| 4311 | // Copy the values from channel 'in' to channel 'out', |
| 4312 | // removing those divisible by 'prime'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4313 | func filter(src <-chan int, dst chan<- int, prime int) { |
| 4314 | for i := range src { // Loop over values received from 'src'. |
| 4315 | if i%prime != 0 { |
| 4316 | dst <- i; // Send 'i' to channel 'dst'. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4317 | } |
| 4318 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4319 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4320 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4321 | // The prime sieve: Daisy-chain filter processes together. |
| 4322 | func sieve() { |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4323 | ch := make(chan int); // Create a new channel. |
| 4324 | go generate(ch); // Start generate() as a subprocess. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4325 | for { |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4326 | prime := <-ch; |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4327 | fmt.Print(prime, "\n"); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4328 | ch1 := make(chan int); |
| 4329 | go filter(ch, ch1, prime); |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4330 | ch = ch1; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4331 | } |
| 4332 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4333 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4334 | func main() { |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4335 | sieve(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4336 | } |
| 4337 | </pre> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 4338 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4339 | <h2 id="Program_initialization_and_execution">Program initialization and execution</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4340 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4341 | <h3 id="The_zero_value">The zero value</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4342 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4343 | When memory is allocated to store a value, either through a declaration |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4344 | or <code>make()</code> or <code>new()</code> call, |
| 4345 | and no explicit initialization is provided, the memory is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4346 | given a default initialization. Each element of such a value is |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 4347 | set to the <i>zero value</i> for its type: <code>false</code> for booleans, |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4348 | <code>0</code> for integers, <code>0.0</code> for floats, <code>""</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4349 | for strings, and <code>nil</code> for pointers, functions, interfaces, slices, channels, and maps. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4350 | This initialization is done recursively, so for instance each element of an |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4351 | array of structs will have its fields zeroed if no value is specified. |
| 4352 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4353 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4354 | These two simple declarations are equivalent: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4355 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4356 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4357 | <pre> |
| 4358 | var i int; |
| 4359 | var i int = 0; |
| 4360 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4361 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4362 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4363 | After |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4364 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4365 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4366 | <pre> |
| 4367 | type T struct { i int; f float; next *T }; |
| 4368 | t := new(T); |
| 4369 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4370 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4371 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4372 | the following holds: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4373 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4374 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4375 | <pre> |
| 4376 | t.i == 0 |
| 4377 | t.f == 0.0 |
| 4378 | t.next == nil |
| 4379 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4380 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4381 | <p> |
| 4382 | The same would also be true after |
| 4383 | </p> |
| 4384 | |
| 4385 | <pre> |
| 4386 | var t T |
| 4387 | </pre> |
| 4388 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4389 | <h3 id="Program_execution">Program execution</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4390 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4391 | A package with no imports is initialized by assigning initial values to |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 4392 | all its package-level variables |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4393 | and then calling any |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4394 | package-level function with the name and signature of |
| 4395 | </p> |
| 4396 | <pre> |
| 4397 | func init() |
| 4398 | </pre> |
| 4399 | <p> |
| 4400 | defined in its source. Since a package may contain more |
| 4401 | than one source file, there may be more than one |
| 4402 | <code>init()</code> function in a package, but |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4403 | only one per source file. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4404 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4405 | <p> |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 4406 | Within a package, package-level variables are initialized, |
| 4407 | and constant values are determined, in |
| 4408 | data-dependent order: if the initializer of <code>A</code> |
| 4409 | depends on the value of <code>B</code>, <code>A</code> |
| 4410 | will be set after <code>B</code>. |
| 4411 | It is an error if such dependencies form a cycle. |
| 4412 | Dependency analysis is done lexically: <code>A</code> |
| 4413 | depends on <code>B</code> if the value of <code>A</code> |
| 4414 | contains a mention of <code>B</code>, contains a value |
| 4415 | whose initializer |
| 4416 | mentions <code>B</code>, or mentions a function that |
| 4417 | mentions <code>B</code>, recursively. |
| 4418 | If two items are not interdependent, they will be initialized |
| 4419 | in the order they appear in the source. |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 4420 | Since the dependency analysis is done per package, it can produce |
| 4421 | unspecified results if <code>A</code>'s initializer calls a function defined |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 4422 | in another package that refers to <code>B</code>. |
| 4423 | </p> |
| 4424 | <p> |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4425 | Initialization code may contain "go" statements, but the functions |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 4426 | they invoke do not begin execution until initialization of the entire |
| 4427 | program is complete. Therefore, all initialization code is run in a single |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4428 | goroutine. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4429 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4430 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4431 | An <code>init()</code> function cannot be referred to from anywhere |
| 4432 | in a program. In particular, <code>init()</code> cannot be called explicitly, |
| 4433 | nor can a pointer to <code>init</code> be assigned to a function variable. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4434 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4435 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4436 | If a package has imports, the imported packages are initialized |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4437 | before initializing the package itself. If multiple packages import |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4438 | a package <code>P</code>, <code>P</code> will be initialized only once. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4439 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4440 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4441 | The importing of packages, by construction, guarantees that there can |
| 4442 | be no cyclic dependencies in initialization. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4443 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4444 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4445 | A complete program, possibly created by linking multiple packages, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4446 | must have one package called <code>main</code>, with a function |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4447 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4448 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4449 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4450 | func main() { ... } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4451 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4452 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4453 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4454 | defined. |
| 4455 | The function <code>main.main()</code> takes no arguments and returns no value. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4456 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4457 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4458 | Program execution begins by initializing the <code>main</code> package and then |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4459 | invoking <code>main.main()</code>. |
| 4460 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4461 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4462 | When <code>main.main()</code> returns, the program exits. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4463 | </p> |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4464 | <p> |
| 4465 | Implementation restriction: The compiler assumes package <code>main</code> |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 4466 | is not imported by any other package. |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4467 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4468 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4469 | <h2 id="System_considerations">System considerations</h2> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4470 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4471 | <h3 id="Package_unsafe">Package <code>unsafe</code></h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4472 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4473 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4474 | The built-in package <code>unsafe</code>, known to the compiler, |
| 4475 | provides facilities for low-level programming including operations |
| 4476 | that violate the type system. A package using <code>unsafe</code> |
| 4477 | must be vetted manually for type safety. The package provides the |
| 4478 | following interface: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4479 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4480 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4481 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4482 | package unsafe |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4483 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4484 | type ArbitraryType int // shorthand for an arbitrary Go type; it is not a real type |
| 4485 | type Pointer *ArbitraryType |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4486 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4487 | func Alignof(variable ArbitraryType) int |
| 4488 | func Offsetof(selector ArbitraryType) int |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4489 | func Sizeof(variable ArbitraryType) int |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4490 | |
| 4491 | func Reflect(val interface {}) (typ runtime.Type, addr uintptr) |
| 4492 | func Typeof(val interface {}) reflect.Type |
| 4493 | func Unreflect(typ runtime.Type, addr uintptr) interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4494 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4495 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4496 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4497 | Any pointer or value of type <code>uintptr</code> can be converted into |
| 4498 | a <code>Pointer</code> and vice versa. |
| 4499 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4500 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4501 | The function <code>Sizeof</code> takes an expression denoting a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 4502 | variable of any type and returns the size of the variable in bytes. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4503 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4504 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4505 | The function <code>Offsetof</code> takes a selector (§<a href="#Selectors">Selectors</a>) denoting a struct |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4506 | field of any type and returns the field offset in bytes relative to the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4507 | struct's address. |
| 4508 | For a struct <code>s</code> with field <code>f</code>: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4509 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4510 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4511 | <pre> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4512 | uintptr(unsafe.Pointer(&s)) + uintptr(unsafe.Offsetof(s.f)) == uintptr(unsafe.Pointer(&s.f)) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4513 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4514 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4515 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4516 | Computer architectures may require memory addresses to be <i>aligned</i>; |
| 4517 | that is, for addresses of a variable to be a multiple of a factor, |
| 4518 | the variable's type's <i>alignment</i>. The function <code>Alignof</code> |
| 4519 | takes an expression denoting a variable of any type and returns the |
| 4520 | alignment of the (type of the) variable in bytes. For a variable |
| 4521 | <code>x</code>: |
| 4522 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4523 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4524 | <pre> |
| 4525 | uintptr(unsafe.Pointer(&x)) % uintptr(unsafe.Alignof(x)) == 0 |
| 4526 | </pre> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 4527 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4528 | <p> |
| 4529 | Calls to <code>Alignof</code>, <code>Offsetof</code>, and |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4530 | <code>Sizeof</code> are compile-time constant expressions of type <code>int</code>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4531 | </p> |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4532 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4533 | The functions <code>unsafe.Typeof</code>, |
| 4534 | <code>unsafe.Reflect</code>, |
Russ Cox | 13dac65 | 2009-09-28 14:16:33 -0700 | [diff] [blame] | 4535 | and <code>unsafe.Unreflect</code> allow access at run time to the dynamic |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4536 | types and values stored in interfaces. |
| 4537 | <code>Typeof</code> returns a representation of |
| 4538 | <code>val</code>'s |
| 4539 | dynamic type as a <code>runtime.Type</code>. |
| 4540 | <code>Reflect</code> allocates a copy of |
| 4541 | <code>val</code>'s dynamic |
| 4542 | value and returns both the type and the address of the copy. |
| 4543 | <code>Unreflect</code> inverts <code>Reflect</code>, |
| 4544 | creating an |
| 4545 | interface value from a type and address. |
| 4546 | The <code>reflect</code> package built on these primitives |
| 4547 | provides a safe, more convenient way to inspect interface values. |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4548 | </p> |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 4549 | |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4550 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4551 | <h3 id="Size_and_alignment_guarantees">Size and alignment guarantees</h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4552 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4553 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4554 | For the numeric types (§<a href="#Numeric_types">Numeric types</a>), the following sizes are guaranteed: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4555 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4556 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4557 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4558 | type size in bytes |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4559 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4560 | byte, uint8, int8 1 |
| 4561 | uint16, int16 2 |
| 4562 | uint32, int32, float32 4 |
| 4563 | uint64, int64, float64 8 |
| 4564 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4565 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4566 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4567 | The following minimal alignment properties are guaranteed: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 4568 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4569 | <ol> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4570 | <li>For a variable <code>x</code> of any type: <code>1 <= unsafe.Alignof(x) <= unsafe.Maxalign</code>. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4571 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4572 | <li>For a variable <code>x</code> of numeric type: <code>unsafe.Alignof(x)</code> is the smaller |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4573 | of <code>unsafe.Sizeof(x)</code> and <code>unsafe.Maxalign</code>, but at least 1. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4574 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4575 | <li>For a variable <code>x</code> of struct type: <code>unsafe.Alignof(x)</code> is the largest of |
| 4576 | all the values <code>unsafe.Alignof(x.f)</code> for each field <code>f</code> of x, but at least 1. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4577 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4578 | <li>For a variable <code>x</code> of array type: <code>unsafe.Alignof(x)</code> is the same as |
| 4579 | <code>unsafe.Alignof(x[0])</code>, but at least 1. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4580 | </ol> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4581 | |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 4582 | <h2 id="Implementation_differences"><span class="alert">Implementation differences - TODO</span></h2> |
Robert Griesemer | 237c8ab | 2009-09-01 14:07:30 -0700 | [diff] [blame] | 4583 | <ul> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 4584 | <li><span class="alert">Implementation does not honor the restriction on goto statements and targets (no intervening declarations).</span></li> |
| 4585 | <li><span class="alert">Gccgo does not implement the blank identifier.</span></li> |
| 4586 | <li><span class="alert">Method expressions are not implemented.</span></li> |
Robert Griesemer | 237c8ab | 2009-09-01 14:07:30 -0700 | [diff] [blame] | 4587 | </ul> |