Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1 | |
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 | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 4 | Open issues: |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 5 | [ ] Semantics of type declaration: |
| 6 | - creating a new type (status quo), or only a new type name? |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 7 | - declaration "type T S" strips methods of S. why/why not? |
| 8 | - no mechanism to declare a local type name: type T P.T |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 9 | |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 10 | Todo's: |
Robert Griesemer | 9f4a27c | 2009-01-16 15:44:08 -0800 | [diff] [blame] | 11 | [ ] document illegality of package-external tuple assignments to structs |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 12 | w/ private fields: P.T(1, 2) illegal since same as P.T(a: 1, b: 2) for |
Robert Griesemer | 9f4a27c | 2009-01-16 15:44:08 -0800 | [diff] [blame] | 13 | a T struct { a b int }. |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 14 | [ ] should probably write something about evaluation order of statements even |
| 15 | though obvious |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 16 | [ ] document new assignment rules (for named types on either side of an |
| 17 | assignment, the types must be identical) |
| 18 | [ ] document T.m mechanism to obtain a function from a method |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 19 | --> |
| 20 | |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 21 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 22 | <h2>Introduction</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 23 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 24 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 25 | This is a reference manual for the Go programming language. For |
| 26 | more information and other documents, see <a |
| 27 | href="/">the Go home page</a>. |
| 28 | </p> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 29 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 30 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 31 | Go is a general-purpose language designed with systems programming |
| 32 | in mind. It is strongly typed and garbage-collected, and has explicit |
| 33 | support for concurrent programming. Programs are constructed from |
| 34 | <i>packages</i>, whose properties allow efficient management of |
| 35 | dependencies. The existing implementations use a traditional |
| 36 | compile/link model to generate executable binaries. |
| 37 | </p> |
| 38 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 39 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 40 | The grammar is compact and regular, allowing for easy analysis by |
| 41 | automatic tools such as integrated development environments. |
| 42 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 43 | <hr/> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 44 | <h2>Notation</h2> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 45 | <p> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 46 | The syntax is specified using Extended Backus-Naur Form (EBNF): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 47 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 48 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 49 | <pre class="grammar"> |
Robert Griesemer | 88a0c40 | 2009-04-23 14:42:21 -0700 | [diff] [blame] | 50 | Production = production_name "=" Expression "." . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 51 | Expression = Alternative { "|" Alternative } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 52 | Alternative = Term { Term } . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 53 | Term = production_name | token [ "..." token ] | Group | Option | Repetition . |
| 54 | Group = "(" Expression ")" . |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 55 | Option = "[" Expression "]" . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 56 | Repetition = "{" Expression "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 57 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 58 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 59 | <p> |
| 60 | Productions are expressions constructed from terms and the following |
| 61 | operators, in increasing precedence: |
| 62 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 63 | <pre class="grammar"> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 64 | | alternation |
| 65 | () grouping |
| 66 | [] option (0 or 1 times) |
| 67 | {} repetition (0 to n times) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 68 | </pre> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 69 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 70 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 71 | Lower-case production names are used to identify lexical tokens. |
| 72 | Non-terminals are in CamelCase. Lexical symbols are enclosed in |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 73 | double quotes <code>""</code> (the double quote symbol is written as |
| 74 | <code>'"'</code>). |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 75 | </p> |
| 76 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 77 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 78 | The form <code>"a ... b"</code> represents the set of characters from |
| 79 | <code>a</code> through <code>b</code> as alternatives. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 80 | </p> |
| 81 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 82 | <hr/> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 83 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 84 | <h2>Source code representation</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 85 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 86 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 87 | Source code is Unicode text encoded in UTF-8. The text is not |
| 88 | canonicalized, so a single accented code point is distinct from the |
| 89 | same character constructed from combining an accent and a letter; |
| 90 | those are treated as two code points. For simplicity, this document |
| 91 | will use the term <i>character</i> to refer to a Unicode code point. |
| 92 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 93 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 94 | Each code point is distinct; for instance, upper and lower case letters |
| 95 | are different characters. |
| 96 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 97 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 98 | <h3>Characters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 99 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 100 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 101 | The following terms are used to denote specific Unicode character classes: |
| 102 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 103 | <ul> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 104 | <li>unicode_char an arbitrary Unicode code point</li> |
| 105 | <li>unicode_letter a Unicode code point classified as "Letter"</li> |
| 106 | <li>capital_letter a Unicode code point classified as "Letter, uppercase"</li> |
| 107 | <li>unicode_digit a Unicode code point classified as "Digit"</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 108 | </ul> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 109 | |
Robert Griesemer | 83c1760 | 2009-01-16 14:12:50 -0800 | [diff] [blame] | 110 | (The Unicode Standard, Section 4.5 General Category - Normative.) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 111 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 112 | <h3>Letters and digits</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 113 | |
| 114 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 115 | The underscore character <code>_</code> (U+005F) is considered a letter. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 116 | </> |
| 117 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 118 | letter = unicode_letter | "_" . |
| 119 | decimal_digit = "0" ... "9" . |
| 120 | octal_digit = "0" ... "7" . |
| 121 | hex_digit = "0" ... "9" | "A" ... "F" | "a" ... "f" . |
| 122 | </pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 123 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 124 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 125 | <h2>Lexical elements</h2> |
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 | <h3>Comments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 128 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 129 | <p> |
| 130 | There are two forms of comments. The first starts at the character |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 131 | sequence <code>//</code> and continues through the next newline. The |
| 132 | second starts at the character sequence <code>/*</code> and continues |
| 133 | through the character sequence <code>*/</code>. Comments do not nest. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 134 | </p> |
| 135 | |
| 136 | <h3>Tokens</h3> |
| 137 | |
| 138 | <p> |
| 139 | Tokens form the vocabulary of the Go language. |
| 140 | There are four classes: identifiers, keywords, operators |
| 141 | and delimiters, and literals. <i>White space</i>, formed from |
| 142 | blanks, tabs, and newlines, is ignored except as it separates tokens |
| 143 | that would otherwise combine into a single token. Comments |
| 144 | behave as white space. While breaking the input into tokens, |
| 145 | the next token is the longest sequence of characters that form a |
| 146 | valid token. |
| 147 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 148 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 149 | <h3>Identifiers</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 150 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 151 | <p> |
| 152 | Identifiers name program entities such as variables and types. |
| 153 | An identifier is a sequence of one or more letters and digits. |
| 154 | The first character in an identifier must be a letter. |
| 155 | </p> |
| 156 | <pre class="grammar"> |
| 157 | identifier = letter { letter | unicode_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 158 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 159 | <pre> |
| 160 | a |
| 161 | _x9 |
| 162 | ThisVariableIsExported |
| 163 | αβ |
| 164 | </pre> |
Robert Griesemer | 83c1760 | 2009-01-16 14:12:50 -0800 | [diff] [blame] | 165 | Some identifiers are predeclared (§Predeclared identifiers). |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 166 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 167 | <h3>Keywords</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 168 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 169 | <p> |
| 170 | The following keywords are reserved and may not be used as identifiers. |
| 171 | </p> |
| 172 | <pre class="grammar"> |
| 173 | break default func interface select |
| 174 | case defer go map struct |
| 175 | chan else goto package switch |
| 176 | const fallthrough if range type |
| 177 | continue for import return var |
| 178 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 179 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 180 | <h3>Operators and Delimiters</h3> |
| 181 | |
| 182 | <p> |
| 183 | The following character sequences represent operators, delimiters, and other special tokens: |
| 184 | </p> |
| 185 | <pre class="grammar"> |
| 186 | + & += &= && == != ( ) |
| 187 | - | -= |= || < <= [ ] |
| 188 | * ^ *= ^= <- > >= { } |
| 189 | / << /= <<= ++ = := , ; |
| 190 | % >> %= >>= -- ! ... . : |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 191 | &^ &^= |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 192 | </pre> |
| 193 | |
| 194 | <h3>Integer literals</h3> |
| 195 | |
| 196 | <p> |
| 197 | An integer literal is a sequence of one or more digits in the |
| 198 | corresponding base, which may be 8, 10, or 16. An optional prefix |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 199 | sets a non-decimal base: <code>0</code> for octal, <code>0x</code> or |
| 200 | <code>0X</code> for hexadecimal. In hexadecimal literals, letters |
| 201 | <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] | 202 | </p> |
| 203 | <pre class="grammar"> |
| 204 | int_lit = decimal_lit | octal_lit | hex_lit . |
| 205 | decimal_lit = ( "1" ... "9" ) { decimal_digit } . |
| 206 | octal_lit = "0" { octal_digit } . |
| 207 | hex_lit = "0" ( "x" | "X" ) hex_digit { hex_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 208 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 209 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 210 | <pre> |
| 211 | 42 |
| 212 | 0600 |
| 213 | 0xBadFace |
| 214 | 170141183460469231731687303715884105727 |
| 215 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 216 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 217 | <h3>Floating-point literals</h3> |
| 218 | <p> |
| 219 | A floating-point literal is a decimal representation of a floating-point |
| 220 | number. It has an integer part, a decimal point, a fractional part, |
| 221 | and an exponent part. The integer and fractional part comprise |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 222 | 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] | 223 | followed by an optionally signed decimal exponent. One of the |
| 224 | integer part or the fractional part may be elided; one of the decimal |
| 225 | point or the exponent may be elided. |
| 226 | </p> |
| 227 | <pre class="grammar"> |
| 228 | float_lit = decimals "." [ decimals ] [ exponent ] | |
| 229 | decimals exponent | |
| 230 | "." decimals [ exponent ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 231 | decimals = decimal_digit { decimal_digit } . |
| 232 | exponent = ( "e" | "E" ) [ "+" | "-" ] decimals . |
| 233 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 234 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 235 | <pre> |
| 236 | 0. |
| 237 | 2.71828 |
| 238 | 1.e+0 |
| 239 | 6.67428e-11 |
| 240 | 1E6 |
| 241 | .25 |
| 242 | .12345E+5 |
| 243 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 244 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 245 | <h3>Ideal numbers</h3> |
| 246 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 247 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 248 | Integer literals represent values of arbitrary precision, or <i>ideal |
| 249 | integers</i>. Similarly, floating-point literals represent values |
| 250 | of arbitrary precision, or <i>ideal floats</i>. These <i>ideal |
| 251 | numbers</i> have no size or type and cannot overflow. However, |
| 252 | when (used in an expression) assigned to a variable or typed constant, |
| 253 | the destination must be able to represent the assigned value. |
| 254 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 255 | <p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 256 | Implementation restriction: A compiler may implement ideal numbers |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 257 | by choosing an internal representation with at least twice the precision |
| 258 | of any machine type. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 259 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 260 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 261 | <h3>Character literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 262 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 263 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 264 | A character literal represents an integer value, typically a |
| 265 | Unicode code point, as one or more characters enclosed in single |
| 266 | quotes. Within the quotes, any character may appear except single |
| 267 | quote and newline. A single quoted character represents itself, |
| 268 | while multi-character sequences beginning with a backslash encode |
| 269 | values in various formats. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 270 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 271 | <p> |
| 272 | The simplest form represents the single character within the quotes; |
| 273 | since Go source text is Unicode characters encoded in UTF-8, multiple |
| 274 | UTF-8-encoded bytes may represent a single integer value. For |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 275 | instance, the literal <code>'a'</code> holds a single byte representing |
| 276 | a literal <code>a</code>, Unicode U+0061, value <code>0x61</code>, while |
| 277 | <code>'ä'</code> holds two bytes (<code>0xc3</code> <code>0xa4</code>) representing |
| 278 | a literal <code>a</code>-dieresis, U+00E4, value <code>0xe4</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 279 | </p> |
| 280 | <p> |
| 281 | Several backslash escapes allow arbitrary values to be represented |
| 282 | as ASCII text. There are four ways to represent the integer value |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 283 | as a numeric constant: <code>\x</code> followed by exactly two hexadecimal |
| 284 | digits; <code>\u</code> followed by exactly four hexadecimal digits; |
| 285 | <code>\U</code> followed by exactly eight hexadecimal digits, and a |
| 286 | plain backslash <code>\</code> followed by exactly three octal digits. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 287 | In each case the value of the literal is the value represented by |
| 288 | the digits in the corresponding base. |
| 289 | </p> |
| 290 | <p> |
| 291 | Although these representations all result in an integer, they have |
| 292 | different valid ranges. Octal escapes must represent a value between |
| 293 | 0 and 255 inclusive. (Hexadecimal escapes satisfy this condition |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 294 | by construction). The `Unicode' escapes <code>\u</code> and <code>\U</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 295 | represent Unicode code points so within them some values are illegal, |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 296 | in particular those above <code>0x10FFFF</code> and surrogate halves. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 297 | </p> |
| 298 | <p> |
| 299 | After a backslash, certain single-character escapes represent special values: |
| 300 | </p> |
| 301 | <pre class="grammar"> |
| 302 | \a U+0007 alert or bell |
| 303 | \b U+0008 backspace |
| 304 | \f U+000C form feed |
| 305 | \n U+000A line feed or newline |
| 306 | \r U+000D carriage return |
| 307 | \t U+0009 horizontal tab |
| 308 | \v U+000b vertical tab |
| 309 | \\ U+005c backslash |
| 310 | \' U+0027 single quote (valid escape only within character literals) |
| 311 | \" U+0022 double quote (valid escape only within string literals) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 312 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 313 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 314 | All other sequences are illegal inside character literals. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 315 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 316 | <pre class="grammar"> |
| 317 | char_lit = "'" ( unicode_value | byte_value ) "'" . |
| 318 | unicode_value = unicode_char | little_u_value | big_u_value | escaped_char . |
| 319 | byte_value = octal_byte_value | hex_byte_value . |
| 320 | octal_byte_value = "\" octal_digit octal_digit octal_digit . |
| 321 | hex_byte_value = "\" "x" hex_digit hex_digit . |
| 322 | little_u_value = "\" "u" hex_digit hex_digit hex_digit hex_digit . |
| 323 | big_u_value = "\" "U" hex_digit hex_digit hex_digit hex_digit |
| 324 | hex_digit hex_digit hex_digit hex_digit . |
| 325 | escaped_char = "\" ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | "\" | "'" | """ ) . |
| 326 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 327 | <pre> |
| 328 | 'a' |
| 329 | 'ä' |
| 330 | '本' |
| 331 | '\t' |
| 332 | '\000' |
| 333 | '\007' |
| 334 | '\377' |
| 335 | '\x07' |
| 336 | '\xff' |
| 337 | '\u12e4' |
| 338 | '\U00101234' |
| 339 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 340 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 341 | <p> |
| 342 | The value of a character literal is an ideal integer, just as with |
| 343 | integer literals. |
| 344 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 345 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 346 | <h3>String literals</h3> |
| 347 | |
| 348 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 349 | String literals represent constant values of type <code>string</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 350 | There are two forms: raw string literals and interpreted string |
| 351 | literals. |
| 352 | </p> |
| 353 | <p> |
| 354 | Raw string literals are character sequences between back quotes |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 355 | <code>``</code>. Within the quotes, any character is legal except |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 356 | newline and back quote. The value of a raw string literal is the |
| 357 | string composed of the uninterpreted bytes between the quotes; |
| 358 | in particular, backslashes have no special meaning. |
| 359 | </p> |
| 360 | <p> |
| 361 | Interpreted string literals are character sequences between double |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 362 | quotes <code>""</code>. The text between the quotes forms the |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 363 | value of the literal, with backslash escapes interpreted as they |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 364 | are in character literals (except that <code>\'</code> is illegal and |
| 365 | <code>\"</code> is legal). The three-digit octal (<code>\000</code>) |
| 366 | and two-digit hexadecimal (<code>\x00</code>) escapes represent individual |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 367 | <i>bytes</i> of the resulting string; all other escapes represent |
| 368 | the (possibly multi-byte) UTF-8 encoding of individual <i>characters</i>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 369 | Thus inside a string literal <code>\377</code> and <code>\xFF</code> represent |
| 370 | a single byte of value <code>0xFF</code>=255, while <code>ÿ</code>, |
| 371 | <code>\u00FF</code>, <code>\U000000FF</code> and <code>\xc3\xbf</code> represent |
| 372 | the two bytes <code>0xc3 0xbf</code> of the UTF-8 encoding of character |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 373 | U+00FF. |
| 374 | </p> |
| 375 | |
| 376 | <pre class="grammar"> |
| 377 | string_lit = raw_string_lit | interpreted_string_lit . |
| 378 | raw_string_lit = "`" { unicode_char } "`" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 379 | interpreted_string_lit = """ { unicode_value | byte_value } """ . |
| 380 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 381 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 382 | <pre> |
| 383 | `abc` |
| 384 | `\n` |
| 385 | "hello, world\n" |
| 386 | "\n" |
| 387 | "" |
| 388 | "Hello, world!\n" |
| 389 | "日本語" |
| 390 | "\u65e5本\U00008a9e" |
| 391 | "\xff\u00FF" |
| 392 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 393 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 394 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 395 | These examples all represent the same string: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 396 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 397 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 398 | <pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 399 | "日本語" // UTF-8 input text |
| 400 | `日本語` // UTF-8 input text as a raw literal |
| 401 | "\u65e5\u672c\u8a9e" // The explicit Unicode code points |
| 402 | "\U000065e5\U0000672c\U00008a9e" // The explicit Unicode code points |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 403 | "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e" // The explicit UTF-8 bytes |
| 404 | </pre> |
Robert Griesemer | cd49927 | 2008-09-29 12:09:00 -0700 | [diff] [blame] | 405 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 406 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 407 | If the source code represents a character as two code points, such as |
| 408 | a combining form involving an accent and a letter, the result will be |
| 409 | an error if placed in a character literal (it is not a single code |
| 410 | point), and will appear as two code points if placed in a string |
| 411 | literal. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 412 | </p> |
| 413 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 414 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 415 | <h2>Types</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 416 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 417 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 418 | A type determines the set of values and operations specific to values of that type. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 419 | A type may be specified by a (possibly qualified (§Qualified identifiers)) |
| 420 | type name (§Type declarations) or a <i>type literal</i>, |
| 421 | which composes a new type in terms of previously declared types. |
| 422 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 423 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 424 | <pre class="grammar"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 425 | Type = TypeName | TypeLit | "(" Type ")" . |
| 426 | TypeName = QualifiedIdent. |
| 427 | TypeLit = ArrayType | StructType | PointerType | FunctionType | InterfaceType | |
| 428 | SliceType | MapType | ChannelType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 429 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 430 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 431 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 432 | <i>Basic types</i> such as <code>int</code> are predeclared (§Predeclared identifiers). |
| 433 | Other types may be constructed from these, recursively, |
| 434 | including arrays, structs, pointers, functions, interfaces, slices, maps, and |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 435 | channels. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 436 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 437 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 438 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 439 | At any point in the source code, a type may be <i>complete</i> or |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 440 | <i>incomplete</i>. An incomplete type is one whose size is not |
| 441 | yet known, such as a struct whose fields are not yet fully |
| 442 | defined or a forward declared type (§Forward declarations). |
| 443 | Most types are always complete; for instance, a pointer |
| 444 | type is always complete even if it points to an incomplete type |
| 445 | because the size of the pointer itself is always known. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 446 | (TODO: Need to figure out how forward declarations of |
| 447 | interface fit in here.) |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 448 | </p> |
| 449 | <p> |
| 450 | The <i>interface</i> of a type is the set of methods bound to it |
| 451 | (§Method declarations); for pointer types, it is the interface |
Robert Griesemer | a1065fa | 2008-09-29 20:37:46 -0700 | [diff] [blame] | 452 | of the pointer base type (§Pointer types). All types have an interface; |
Robert Griesemer | f88c6c1 | 2009-02-25 16:58:57 -0800 | [diff] [blame] | 453 | if they have no methods, it is the <i>empty interface</i>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 454 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 455 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 456 | The <i>static type</i> (or just <i>type</i>) of a variable is the |
| 457 | type defined by its declaration. Variables of interface type |
| 458 | (§Interface types) also have a distinct <i>dynamic type</i>, which |
| 459 | is the actual type of the value stored in the variable at run-time. |
| 460 | The dynamic type may vary during execution but is always compatible |
| 461 | with the static type of the interface variable. For non-interfaces |
| 462 | types, the dynamic type is always the static type. |
| 463 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 464 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 465 | <h3>Basic types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 466 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 467 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 468 | Basic types include traditional numeric types, booleans, and strings. All are predeclared. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 469 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 470 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 471 | <h3>Numeric types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 472 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 473 | <p> |
| 474 | The architecture-independent numeric types are: |
| 475 | </p> |
Robert Griesemer | ebf14c6 | 2008-10-30 14:50:23 -0700 | [diff] [blame] | 476 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 477 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 478 | uint8 the set of all unsigned 8-bit integers (0 to 255) |
| 479 | uint16 the set of all unsigned 16-bit integers (0 to 65535) |
| 480 | uint32 the set of all unsigned 32-bit integers (0 to 4294967295) |
| 481 | uint64 the set of all unsigned 64-bit integers (0 to 18446744073709551615) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 482 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 483 | int8 the set of all signed 8-bit integers (-128 to 127) |
| 484 | int16 the set of all signed 16-bit integers (-32768 to 32767) |
| 485 | int32 the set of all signed 32-bit integers (-2147483648 to 2147483647) |
| 486 | int64 the set of all signed 64-bit integers (-9223372036854775808 to 9223372036854775807) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 487 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 488 | float32 the set of all valid IEEE-754 32-bit floating point numbers |
| 489 | float64 the set of all valid IEEE-754 64-bit floating point numbers |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 490 | |
| 491 | byte familiar alias for uint8 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 492 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 493 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 494 | <p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 495 | Integer types are represented in the usual binary format; the value of |
| 496 | an n-bit integer is n bits wide. A negative signed integer is represented |
| 497 | as the two's complement of its absolute value. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 498 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 499 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 500 | <p> |
| 501 | There is also a set of architecture-independent basic numeric types |
| 502 | whose size depends on the architecture: |
| 503 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 504 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 505 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 506 | uint at least 32 bits, at most the size of the largest uint type |
| 507 | int at least 32 bits, at most the size of the largest int type |
| 508 | float at least 32 bits, at most the size of the largest float type |
| 509 | uintptr smallest uint type large enough to store the uninterpreted |
| 510 | bits of a pointer value |
| 511 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 512 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 513 | <p> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 514 | To avoid portability issues all numeric types are distinct except |
| 515 | <code>byte</code>, which is an alias for <code>uint8</code>. |
| 516 | Conversions |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 517 | are required when different numeric types are mixed in an expression |
| 518 | or assignment. For instance, <code>int32</code> and <code>int</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 519 | 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] | 520 | particular architecture. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 521 | |
| 522 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 523 | <h3>Booleans</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 524 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 525 | The type <code>bool</code> comprises the Boolean truth values |
| 526 | represented by the predeclared constants <code>true</code> |
| 527 | and <code>false</code>. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 528 | |
| 529 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 530 | <h3>Strings</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 531 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 532 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 533 | The <code>string</code> type represents the set of textual string values. |
| 534 | Strings behave like arrays of bytes but are immutable: once created, |
| 535 | it is impossible to change the contents of a string. |
| 536 | |
| 537 | <p> |
| 538 | The elements of strings have type <code>byte</code> and may be |
| 539 | accessed using the usual indexing operations (§Indexes). It is |
| 540 | illegal to take the address of such an element, that is, even if |
| 541 | <code>s[i]</code> is the <code>i</code><sup>th</sup> byte of a |
| 542 | string, <code>&s[i]</code> is invalid. The length of a string |
| 543 | can be computed by the function <code>len(s1)</code>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 544 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 545 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 546 | <p> |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 547 | A sequence of string literals is concatenated into a single string. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 548 | </p> |
| 549 | <pre class="grammar"> |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 550 | StringLit = string_lit { string_lit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 551 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 552 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 553 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 554 | "Alea iacta est." |
| 555 | "Alea " /* The die */ `iacta est` /* is cast */ "." |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 556 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 557 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 558 | <h3>Array types</h3> |
| 559 | |
| 560 | <p> |
| 561 | An array is a numbered sequence of elements of a single |
| 562 | type, called the element type, which must be complete |
| 563 | (§Types). The number of elements is called the length and is never |
| 564 | negative. |
| 565 | </p> |
| 566 | |
| 567 | <pre class="grammar"> |
| 568 | ArrayType = "[" ArrayLength "]" ElementType . |
| 569 | ArrayLength = Expression . |
| 570 | ElementType = CompleteType . |
| 571 | </pre> |
| 572 | |
| 573 | <p> |
| 574 | The length is part of the array's type and must must be a constant |
| 575 | expression (§Constant expressions) that evaluates to a non-negative |
| 576 | integer value. The length of array <code>a</code> can be discovered |
| 577 | using the built-in function <code>len(a)</code>, which is a |
| 578 | compile-time constant. The elements can be indexed by integer |
| 579 | indices 0 through the <code>len(a)-1</code> (§Indexes). |
| 580 | </p> |
| 581 | |
| 582 | <pre> |
| 583 | [32]byte |
| 584 | [2*N] struct { x, y int32 } |
| 585 | [1000]*float64 |
| 586 | </pre> |
| 587 | |
| 588 | <h3>Slice types</h3> |
| 589 | |
| 590 | <p> |
| 591 | A slice is a reference to a contiguous segment of an array and |
| 592 | contains a numbered sequence of elements from that array. A slice |
| 593 | type denotes the set of all slices of arrays of its element type. |
| 594 | A slice value may be <code>nil</code>. |
| 595 | </p> |
| 596 | |
| 597 | <pre class="grammar"> |
| 598 | SliceType = "[" "]" ElementType . |
| 599 | </pre> |
| 600 | |
| 601 | <p> |
| 602 | Like arrays, slices are indexable and have a length. The length of a |
| 603 | slice <code>s</code> can be discovered by the built-in function |
| 604 | <code>len(s)</code>; unlike with arrays it may change during |
| 605 | execution. The elements can be addressed by integer indices 0 |
| 606 | through <code>len(s)-1</code> (§Indexes). The slice index of a |
| 607 | given element may be less than the index of the same element in the |
| 608 | underlying array. |
| 609 | </p> |
| 610 | <p> |
| 611 | A slice, once initialized, is always associated with an underlying |
| 612 | array that holds its elements. A slice therfore shares storage |
| 613 | with its array and with other slices of the same array; by contrast, |
| 614 | distinct arrays always represent distinct storage. |
| 615 | </p> |
| 616 | <p> |
| 617 | 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] | 618 | 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] | 619 | the length of the slice and the length of the array beyond the slice; |
| 620 | a slice of length up to that capacity can be created by `slicing' a new |
| 621 | one from the original slice (§Slices). |
| 622 | The capacity of a slice <code>a</code> can be discovered using the |
| 623 | built-in function |
| 624 | </p> |
| 625 | |
| 626 | <pre> |
| 627 | cap(s) |
| 628 | </pre> |
| 629 | |
| 630 | <p> |
| 631 | and the relationship between <code>len()</code> and <code>cap()</code> is: |
| 632 | </p> |
| 633 | |
| 634 | <pre> |
| 635 | 0 <= len(a) <= cap(a) |
| 636 | </pre> |
| 637 | |
| 638 | <p> |
| 639 | The value of an uninitialized slice is <code>nil</code>. |
| 640 | The length and capacity of a <code>nil</code> slice |
| 641 | are 0. A new, initialized slice value for a given element type <code>T</code> is |
| 642 | made using the built-in function <code>make</code>, which takes a slice type |
| 643 | and parameters specifying the length and optionally the capacity: |
| 644 | </p> |
| 645 | |
| 646 | <pre> |
| 647 | make([]T, length) |
| 648 | make([]T, length, capacity) |
| 649 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 650 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 651 | <p> |
| 652 | The <code>make()</code> call allocates a new, hidden array to which the returned |
| 653 | slice value refers. That is, calling <code>make</code> |
| 654 | </p> |
| 655 | |
| 656 | <pre> |
| 657 | make([]T, length, capacity) |
| 658 | </pre> |
| 659 | |
| 660 | <p> |
| 661 | produces the same slice as allocating an array and slicing it, so these two examples |
| 662 | result in the same slice: |
| 663 | </p> |
| 664 | |
| 665 | <pre> |
| 666 | make([]int, 50, 100) |
| 667 | new([100]int)[0:50] |
| 668 | </pre> |
| 669 | |
| 670 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 671 | <h3>Struct types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 672 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 673 | <p> |
| 674 | A struct is a sequence of named |
| 675 | elements, called fields, with various types. A struct type declares |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 676 | an identifier and type for each field. Within a struct, field identifiers |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 677 | must be unique and field types must be complete (§Types). |
| 678 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 679 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 680 | <pre class="grammar"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 681 | StructType = "struct" "{" [ FieldDeclList ] "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 682 | FieldDeclList = FieldDecl { ";" FieldDecl } [ ";" ] . |
| 683 | FieldDecl = (IdentifierList CompleteType | [ "*" ] TypeName) [ Tag ] . |
| 684 | Tag = StringLit . |
| 685 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 686 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 687 | <pre> |
| 688 | // An empty struct. |
| 689 | struct {} |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 690 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 691 | // A struct with 5 fields. |
| 692 | struct { |
| 693 | x, y int; |
| 694 | u float; |
| 695 | A *[]int; |
| 696 | F func(); |
| 697 | } |
| 698 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 699 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 700 | <p> |
| 701 | A field declared with a type but no field identifier is an <i>anonymous field</i>. |
| 702 | Such a field type must be specified as |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 703 | a type name <code>T</code> or as a pointer to a type name <code>*T</code>, |
| 704 | and <code>T</code> itself, may not be |
Robert Griesemer | 83c1760 | 2009-01-16 14:12:50 -0800 | [diff] [blame] | 705 | a pointer or interface type. The unqualified type name acts as the field identifier. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 706 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 707 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 708 | <pre> |
| 709 | // A struct with four anonymous fields of type T1, *T2, P.T3 and *P.T4 |
| 710 | struct { |
| 711 | T1; // the field name is T1 |
| 712 | *T2; // the field name is T2 |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 713 | P.T3; // the field name is T3 |
| 714 | *P.T4; // the field name is T4 |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 715 | x, y int; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 716 | } |
| 717 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 718 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 719 | <p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 720 | The unqualified type name of an anonymous field must not conflict with the |
| 721 | field identifier (or unqualified type name for an anonymous field) of any |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 722 | other field within the struct. The following declaration is illegal: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 723 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 724 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 725 | <pre> |
| 726 | struct { |
| 727 | T; // conflicts with anonymous field *T and *P.T |
| 728 | *T; // conflicts with anonymous field T and *P.T |
| 729 | *P.T; // conflicts with anonymous field T and *T |
| 730 | } |
| 731 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 732 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 733 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 734 | Fields and methods (§Method declarations) of an anonymous field are |
| 735 | promoted to be ordinary fields and methods of the struct (§Selectors). |
| 736 | </p> |
| 737 | <p> |
| 738 | A field declaration may be followed by an optional string literal <i>tag</i>, which |
| 739 | becomes an attribute for all the identifiers in the corresponding |
| 740 | field declaration. The tags are made |
| 741 | visible through a reflection library (TODO: reference?) |
| 742 | but are otherwise ignored. |
| 743 | </p> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 744 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 745 | <pre> |
| 746 | // A struct corresponding to the EventIdMessage protocol buffer. |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 747 | // The tag strings define the protocol buffer field numbers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 748 | struct { |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 749 | time_usec uint64 "field 1"; |
| 750 | server_ip uint32 "field 2"; |
| 751 | process_id uint32 "field 3"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 752 | } |
| 753 | </pre> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 754 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 755 | <h3>Pointer types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 756 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 757 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 758 | 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] | 759 | type, called the <i>base type</i> of the pointer. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 760 | A pointer value may be <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 761 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 762 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 763 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 764 | PointerType = "*" BaseType . |
| 765 | BaseType = Type . |
| 766 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 767 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 768 | <pre> |
| 769 | *int |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 770 | *map[string] *chan int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 771 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 772 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 773 | <h3>Function types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 774 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 775 | <p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 776 | 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] | 777 | and result types. |
| 778 | A function value may be <code>nil</code>. |
| 779 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 780 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 781 | <pre class="grammar"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 782 | FunctionType = "func" Signature . |
| 783 | Signature = Parameters [ Result ] . |
| 784 | Result = Parameters | CompleteType . |
| 785 | Parameters = "(" [ ParameterList ] ")" . |
| 786 | ParameterList = ParameterDecl { "," ParameterDecl } . |
| 787 | ParameterDecl = [ IdentifierList ] ( CompleteType | "..." ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 788 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 789 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 790 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 791 | Within a list of parameters or results, the names (IdentifierList) |
| 792 | must either all be present or all be absent. If present, each name |
| 793 | stands for one item (parameter or result) of the specified type; if absent, each |
| 794 | type stands for one item of that type. Parameter and result |
| 795 | lists are always parenthesized except that if there is exactly |
| 796 | one unnamed result that is not a function type it may writen as an unparenthesized type. |
| 797 | The types of parameters and results must be complete. |
| 798 | (TODO: is completeness necessary?) |
| 799 | </p> |
| 800 | <p> |
| 801 | For the last parameter only, instead of a type one may write |
| 802 | <code>...</code> to indicate that the function may be invoked with |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 803 | zero or more additional arguments of any |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 804 | type. If parameters of such a function are named, the final identifier |
| 805 | list must be a single name, that of the <code>...</code> parameter. |
| 806 | </p> |
Robert Griesemer | 2bfa957 | 2008-10-24 13:13:12 -0700 | [diff] [blame] | 807 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 808 | <pre> |
| 809 | func () |
| 810 | func (x int) |
| 811 | func () int |
| 812 | func (string, float, ...) |
| 813 | func (a, b int, z float) bool |
| 814 | func (a, b int, z float) (bool) |
| 815 | func (a, b int, z float, opt ...) (success bool) |
| 816 | func (int, int, float) (float, *[]int) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 817 | func (n int) (func (p* T)) |
| 818 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 819 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 820 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 821 | <h3>Interface types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 822 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 823 | <p> |
| 824 | An interface type specifies an unordered set of methods. A variable |
| 825 | of interface type can store, dynamically, any value that implements |
| 826 | at least that set of methods. |
| 827 | An interface value may be <code>nil</code>. |
| 828 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 829 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 830 | <pre class="grammar"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 831 | InterfaceType = "interface" "{" [ MethodSpecList ] "}" . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 832 | MethodSpecList = MethodSpec { ";" MethodSpec } [ ";" ] . |
| 833 | MethodSpec = IdentifierList Signature | InterfaceTypeName . |
| 834 | InterfaceTypeName = TypeName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 835 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 836 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 837 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 838 | // A simple File interface |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 839 | interface { |
| 840 | Read, Write (b Buffer) bool; |
| 841 | Close (); |
| 842 | } |
| 843 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 844 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 845 | <p> |
| 846 | Any type (including interface types) whose interface includes, |
| 847 | possibly as a subset, the complete set of methods of an interface <code>I</code> |
| 848 | is said to implement interface <code>I</code>. |
| 849 | For instance, if two types <code>S1</code> and <code>S2</code> |
| 850 | have the methods |
| 851 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 852 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 853 | <pre> |
| 854 | func (p T) Read(b Buffer) bool { return ... } |
| 855 | func (p T) Write(b Buffer) bool { return ... } |
| 856 | func (p T) Close() { ... } |
| 857 | </pre> |
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> |
| 860 | (where <code>T</code> stands for either <code>S1</code> or <code>S2</code>) |
| 861 | then the <code>File</code> interface is implemented by both <code>S1</code> and |
| 862 | <code>S2</code>, regardless of what other methods |
| 863 | <code>S1</code> and <code>S2</code> may have or share. |
| 864 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 865 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 866 | <p> |
| 867 | A type implements any interface comprising any subset of its methods |
| 868 | and may therefore implement several distinct interfaces. For |
| 869 | instance, all types implement the <i>empty interface</i>: |
| 870 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 871 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 872 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 873 | interface { } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 874 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 875 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 876 | <p> |
| 877 | Similarly, consider this interface specification, |
| 878 | which appears within a type declaration (§Type declarations) |
| 879 | to define an interface called <code>Lock</code>: |
| 880 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 881 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 882 | <pre> |
| 883 | type Lock interface { |
| 884 | Lock, Unlock (); |
| 885 | } |
| 886 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 887 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 888 | <p> |
| 889 | If <code>S1</code> and <code>S2</code> also implement |
| 890 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 891 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 892 | <pre> |
| 893 | func (p T) Lock() { ... } |
| 894 | func (p T) Unlock() { ... } |
| 895 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 896 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 897 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 898 | they implement the <code>Lock</code> interface as well |
| 899 | as the <code>File</code> interface. |
| 900 | </p> |
| 901 | <p> |
| 902 | An interface may contain an interface type name <code>T</code> |
| 903 | in place of a method specification. |
| 904 | In this notation, <code>T</code> must denote a different, complete interface type |
| 905 | and the effect is equivalent to enumerating the methods of <code>T</code> explicitly |
| 906 | in the interface. |
| 907 | </p> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 908 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 909 | <pre> |
| 910 | type ReadWrite interface { |
| 911 | Read, Write (b Buffer) bool; |
| 912 | } |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 913 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 914 | type File interface { |
| 915 | ReadWrite; // same as enumerating the methods in ReadWrite |
| 916 | Lock; // same as enumerating the methods in Lock |
| 917 | Close(); |
| 918 | } |
| 919 | </pre> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 920 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 921 | <h3>Map types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 922 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 923 | <p> |
| 924 | A map is an unordered group of elements of one type, called the |
| 925 | value type, indexed by a set of unique <i>keys</i> of another type, |
| 926 | called the key type. Both key and value types must be complete. |
| 927 | (§Types). |
| 928 | (TODO: is completeness necessary here?) |
| 929 | A map value may be <code>nil</code>. |
| 930 | |
| 931 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 932 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 933 | <pre class="grammar"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 934 | MapType = "map" "[" KeyType "]" ValueType . |
| 935 | KeyType = CompleteType . |
| 936 | ValueType = CompleteType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 937 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 938 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 939 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 940 | The comparison operators <code>==</code> and <code>!=</code> |
| 941 | (§Comparison operators) must be fully defined for operands of the |
| 942 | key type; thus the key type must be a basic, pointer, interface, |
| 943 | map, or channel type. If the key type is an interface type, these |
| 944 | comparison operators must be defined for the dynamic key values; |
| 945 | failure will cause a run-time error. |
| 946 | |
| 947 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 948 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 949 | <pre> |
| 950 | map [string] int |
| 951 | map [*T] struct { x, y float } |
| 952 | map [string] interface {} |
| 953 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 954 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 955 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 956 | The number of elements is called the length and is never negative. |
| 957 | The length of a map <code>m</code> can be discovered using the |
| 958 | built-in function <code>len(m)</code> and may change during execution. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 959 | The value of an uninitialized map is <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 960 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 961 | <p> |
| 962 | Upon creation, a map is empty. Values may be added and removed |
| 963 | during execution using special forms of assignment (§Assignments). |
| 964 | A new, empty map value is made using the built-in |
| 965 | function <code>make</code>, which takes the map type and an optional |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 966 | capacity hint as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 967 | </p> |
| 968 | |
| 969 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 970 | make(map[string] int) |
| 971 | make(map[string] int, 100) |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 972 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 973 | |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 974 | <p> |
| 975 | The initial capacity does not bound its size: |
| 976 | maps grow to accommodate the number of items |
| 977 | stored in them. |
| 978 | </p> |
| 979 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 980 | <h3>Channel types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 981 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 982 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 983 | A channel provides a mechanism for two concurrently executing functions |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 984 | to synchronize execution and communicate by passing a value of a |
| 985 | specified element type. The element type must be complete (§Types). |
| 986 | (TODO: is completeness necessary here?) |
| 987 | A channel value may be <code>nil</code>. |
| 988 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 989 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 990 | <pre class="grammar"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 991 | ChannelType = Channel | SendChannel | RecvChannel . |
| 992 | Channel = "chan" ValueType . |
| 993 | SendChannel = "chan" "<-" ValueType . |
| 994 | RecvChannel = "<-" "chan" ValueType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 995 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 996 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 997 | <p> |
| 998 | 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] | 999 | 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] | 1000 | to receive. This constraint is called a channel's <i>direction</i>; either |
| 1001 | <i>send</i>, <i>receive</i>, or <i>bi-directional</i> (unconstrained). |
| 1002 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1003 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1004 | <pre> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 1005 | chan T // can be used to send and receive values of type T |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1006 | chan <- float // can only be used to send floats |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 1007 | <-chan int // can only be used to receive ints |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1008 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1009 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1010 | <p> |
| 1011 | The value of an uninitialized channel is <code>nil</code>. A new, initialized channel |
| 1012 | value is made using the built-in function <code>make</code>, |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 1013 | which takes the channel type and an optional capacity as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1014 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1015 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1016 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1017 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1018 | make(chan int, 100) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1019 | </pre> |
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> |
| 1022 | The capacity, in number of elements, sets the size of the buffer in the channel. If the |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1023 | capacity is greater than zero, the channel is asynchronous and, provided the |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1024 | buffer is not full, sends can succeed without blocking. If the capacity is zero |
| 1025 | or absent, the communication succeeds only when both a sender and receiver are ready. |
| 1026 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1027 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1028 | <p> |
| 1029 | For a channel <code>c</code>, the predefined function <code>close(c)</code> |
| 1030 | marks the channel as unable to accept more |
| 1031 | values through a send operation. After any previously |
| 1032 | sent values have been received, receives will return |
| 1033 | the zero value for the channel's type. After at least one such zero value has been |
| 1034 | received, <code>closed(c)</code> returns true. |
| 1035 | </p> |
| 1036 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1037 | <h2>General properties of types and values</h2> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1038 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1039 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1040 | Types may be <i>different</i>, <i>structurally equal</i> (or just <i>equal</i>), |
| 1041 | or <i>identical</i>. |
| 1042 | Go is <i>type safe</i>: different types cannot be mixed |
| 1043 | in binary operations and values cannot be assigned to variables of different |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1044 | types. Values can be assigned to variables of equal type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1045 | </p> |
| 1046 | |
| 1047 | <h3>Type equality and identity </h3> |
| 1048 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1049 | <p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1050 | Two type names denote equal types if the types in the corresponding declarations |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1051 | are equal (§Declarations and Scope). |
| 1052 | Two type literals specify equal types if they have the same |
| 1053 | literal structure and corresponding components have equal types. |
| 1054 | In detail: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1055 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1056 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1057 | <ul> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1058 | <li>Two pointer types are equal if they have equal base types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1059 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1060 | <li>Two array types are equal if they have equal element types and |
| 1061 | the same array length.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1062 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1063 | <li>Two struct types are equal if they have the same sequence of fields, |
| 1064 | with the same names and equal types. Two anonymous fields are |
| 1065 | considered to have the same name.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1066 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1067 | <li>Two function types are equal if they have the same number of parameters |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1068 | and result values and if corresponding parameter and result types are |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1069 | the same. All "..." parameters have equal type. |
| 1070 | Parameter and result names are not required to match.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1071 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1072 | <li>Two slice types are equal if they have equal element types.</li> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1073 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1074 | <li>Two channel types are equal if they have equal value types and |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1075 | the same direction.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1076 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1077 | <li>Two map types are equal if they have equal key and value types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1078 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1079 | <li>Two interface types are equal if they have the same set of methods |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1080 | with the same names and equal function types. The order |
| 1081 | of the methods is irrelevant.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1082 | </ul> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1083 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1084 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1085 | Type identity is more stringent than type equality. |
| 1086 | It requires for type names |
| 1087 | that they originate in the same type declaration, while for equality it requires |
| 1088 | only that they originate in equal type declarations. |
| 1089 | Also, the names of parameters and results must match for function types. |
| 1090 | In all other respects, the definition of type identity is the |
| 1091 | same as for type equality listed above but with ``identical'' |
| 1092 | substitued for ``equal''. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1093 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1094 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1095 | By definition, identical types are also equal types. |
| 1096 | Two types are different if they are not equal. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1097 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1098 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1099 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1100 | Given the declarations |
| 1101 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1102 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1103 | <pre> |
| 1104 | type ( |
| 1105 | T0 []string; |
| 1106 | T1 []string |
| 1107 | T2 struct { a, b int }; |
| 1108 | T3 struct { a, c int }; |
| 1109 | T4 func (int, float) *T0 |
| 1110 | T5 func (x int, y float) *[]string |
| 1111 | ) |
| 1112 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1113 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1114 | <p> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1115 | these types are equal: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1116 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1117 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1118 | <pre> |
| 1119 | T0 and T0 |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1120 | T0 and T1 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1121 | T0 and []string |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1122 | T4 and T5 |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1123 | T3 and struct { a int; c int } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1124 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1125 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1126 | <p> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1127 | <code>T2</code> and <code>T3</code> are not equal because |
| 1128 | they have different field names. |
| 1129 | </p> |
| 1130 | |
| 1131 | <p> |
| 1132 | These types are identical: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1133 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1134 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1135 | <pre> |
| 1136 | T0 and T0 |
| 1137 | []int and []int |
| 1138 | struct { a, b *T5 } and struct { a, b *T5 } |
| 1139 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1140 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1141 | <p> |
| 1142 | <code>T0</code> and <code>T1</code> are equal but not |
| 1143 | identical because they have distinct declarations. |
| 1144 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1145 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1146 | <h3>Assignment compatibility</h3> |
| 1147 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1148 | <p> |
| 1149 | Values of any type may always be assigned to variables |
| 1150 | of equal static type. Some types and values have conditions under which they may |
| 1151 | be assigned to different types: |
| 1152 | </p> |
| 1153 | <ul> |
| 1154 | <li> |
| 1155 | The predeclared constant <code>nil</code> can be assigned to any |
| 1156 | pointer, function, slice, map, channel, or interface variable. |
| 1157 | <li> |
Russ Cox | bcdc247 | 2009-04-16 23:06:48 -0700 | [diff] [blame] | 1158 | A pointer to an array can be assigned to a slice variable with equal element type. |
| 1159 | The slice variable then refers to the original array; the data is not copied. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1160 | </li> |
| 1161 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1162 | A value can be assigned to an interface variable if the static |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1163 | type of the value implements the interface. |
| 1164 | </li> |
| 1165 | <li> |
| 1166 | A value of bidirectional channel type can be assigned to any channel |
| 1167 | variable of equal channel value type. |
| 1168 | </li> |
| 1169 | </ul> |
| 1170 | |
| 1171 | <h3>Comparison compatibility</h3> |
| 1172 | |
| 1173 | <p> |
| 1174 | Values of any type may be compared to other values of equal static |
| 1175 | type. Values of numeric and string type may be compared using the |
| 1176 | full range of comparison operators as described in §Comparison operators; |
| 1177 | booleans may be compared only for equality or inequality. |
| 1178 | </p> |
| 1179 | |
| 1180 | <p> |
| 1181 | Values of composite type may be |
| 1182 | compared for equality or inequality using the <code>==</code> and |
| 1183 | <code>!=</code> operators, with the following provisos: |
| 1184 | </p> |
| 1185 | <ul> |
| 1186 | <li> |
| 1187 | Arrays and structs may not be compared to anything. |
| 1188 | </li> |
| 1189 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1190 | A slice value may only be compared explicitly against <code>nil</code>. |
| 1191 | A slice value is equal to <code>nil</code> if it has been assigned the explicit |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1192 | value <code>nil</code> or if it is a variable (or array element, |
| 1193 | field, etc.) that has not been modified since it was created |
| 1194 | uninitialized. |
| 1195 | </li> |
| 1196 | <li> |
| 1197 | Similarly, an interface value is equal to <code>nil</code> if it has |
| 1198 | been assigned the explicit value <code>nil</code> or if it is a |
| 1199 | variable (or array element, field, etc.) that has not been modified |
| 1200 | since it was created uninitialized. |
| 1201 | </li> |
| 1202 | <li> |
| 1203 | For types that can be compared to <code>nil</code>, |
| 1204 | two values of the same type are equal if they both equal <code>nil</code>, |
| 1205 | unequal if one equals <code>nil</code> and one does not. |
| 1206 | </li> |
| 1207 | <li> |
| 1208 | Pointer values are equal if they point to the same location. |
| 1209 | </li> |
| 1210 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1211 | Function values are equal if they refer to the same function. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1212 | </li> |
| 1213 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1214 | Channel and map values are equal if they were created by the same call to <code>make</code> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1215 | (§Making slices, maps, and channels). |
| 1216 | </li> |
| 1217 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1218 | Interface values may be compared if they have the same static type. |
| 1219 | 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] | 1220 | </li> |
| 1221 | </ul> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1222 | <hr/> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1223 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1224 | |
| 1225 | <h2>Declarations and Scope</h2> |
| 1226 | |
| 1227 | <p> |
| 1228 | A declaration binds an identifier to a language entity such as |
| 1229 | a variable or function and specifies properties such as its type. |
| 1230 | Every identifier in a program must be declared. |
| 1231 | </p> |
| 1232 | |
| 1233 | <pre class="grammar"> |
| 1234 | Declaration = ConstDecl | TypeDecl | VarDecl | FunctionDecl | MethodDecl . |
| 1235 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1236 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1237 | <p> |
| 1238 | The <i>scope</i> of an identifier is the extent of source text within which the |
| 1239 | identifier denotes the bound entity. No identifier may be declared twice in a |
| 1240 | single scope, but inner blocks can declare a new entity with the same |
| 1241 | identifier, in which case the scope created by the outer declaration excludes |
| 1242 | that created by the inner. |
| 1243 | </p> |
| 1244 | <p> |
| 1245 | There are levels of scoping in effect before each source file is compiled. |
| 1246 | In order from outermost to innermost: |
| 1247 | </p> |
| 1248 | <ol> |
| 1249 | <li>The <i>universe</i> scope contains all predeclared identifiers.</li> |
| 1250 | <li>An implicit scope contains only the package name.</li> |
| 1251 | <li>The <i>package-level</i> scope surrounds all declarations at the |
| 1252 | top level of the file, that is, outside the body of any |
| 1253 | function or method. That scope is shared across all |
| 1254 | source files within the package (§Packages), allowing |
| 1255 | package-level identifiers to be shared between source |
| 1256 | files.</li> |
| 1257 | </ol> |
| 1258 | |
| 1259 | <p> |
| 1260 | The scope of an identifier depends on the entity declared: |
| 1261 | </p> |
| 1262 | |
| 1263 | <ol> |
| 1264 | <li> The scope of predeclared identifiers is the universe scope.</li> |
| 1265 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1266 | <li> The scope of an identifier denoting a type, function or package |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1267 | extends from the point of the identifier in the declaration |
| 1268 | to the end of the innermost surrounding block.</li> |
| 1269 | |
| 1270 | <li> The scope of a constant or variable extends textually from |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1271 | the end of its declaration to the end of the innermost |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1272 | surrounding block. If the variable is declared in the |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1273 | <i>init</i> statement of an <code>if</code>, <code>for</code>, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1274 | or <code>switch </code> statement, the |
| 1275 | innermost surrounding block is the block associated |
| 1276 | with that statement.</li> |
| 1277 | |
| 1278 | <li> The scope of a parameter or result is the body of the |
| 1279 | corresponding function.</li> |
| 1280 | |
| 1281 | <li> The scope of a field or method is selectors for the |
| 1282 | corresponding type containing the field or method (§Selectors).</li> |
| 1283 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1284 | <li> The scope of a label is a special scope emcompassing |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1285 | the body of the innermost surrounding function, excluding |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1286 | nested functions. Labels do not conflict with non-label identifiers.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1287 | </ol> |
| 1288 | |
| 1289 | <h3>Predeclared identifiers</h3> |
| 1290 | |
| 1291 | <p> |
| 1292 | The following identifiers are implicitly declared in the outermost scope: |
| 1293 | </p> |
| 1294 | <pre class="grammar"> |
| 1295 | Basic types: |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1296 | bool byte float32 float64 int8 int16 int32 int64 |
| 1297 | string uint8 uint16 uint32 uint64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1298 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1299 | Architecture-specific convenience types: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1300 | float int uint uintptr |
| 1301 | |
| 1302 | Constants: |
| 1303 | true false iota nil |
| 1304 | |
| 1305 | Functions: |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1306 | cap len make new panic panicln print println |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1307 | |
| 1308 | Packages: |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1309 | sys (TODO: does sys endure?) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1310 | </pre> |
| 1311 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1312 | <h3>Exported identifiers</h3> |
| 1313 | |
| 1314 | <p> |
| 1315 | By default, identifiers are visible only within the package in which they are declared. |
| 1316 | Some identifiers are <i>exported</i> and can be referenced using |
| 1317 | <i>qualified identifiers</i> in other packages (§Qualified identifiers). |
| 1318 | If an identifier satisfies these two conditions: |
| 1319 | </p> |
| 1320 | <ol> |
| 1321 | <li>the first character of the identifier's name is a Unicode upper case letter; |
| 1322 | <li>the identifier is declared at the package level or is a field or method of a type |
| 1323 | declared at the top level; |
| 1324 | </ol> |
| 1325 | <p> |
| 1326 | it will be exported automatically. |
| 1327 | </p> |
| 1328 | |
| 1329 | <h3>Const declarations</h3> |
| 1330 | |
| 1331 | <p> |
| 1332 | A constant declaration binds a list of identifiers (the names of |
| 1333 | the constants) to the values of a list of constant expressions |
| 1334 | (§Constant expressions). The number of identifiers must be equal |
| 1335 | to the number of expressions, and the n<sup>th</sup> identifier on |
| 1336 | the left is bound to value of the n<sup>th</sup> expression on the |
| 1337 | right. |
| 1338 | </p> |
| 1339 | |
| 1340 | <pre class="grammar"> |
| 1341 | ConstDecl = "const" ( ConstSpec | "(" [ ConstSpecList ] ")" ) . |
| 1342 | ConstSpecList = ConstSpec { ";" ConstSpec } [ ";" ] . |
Russ Cox | f8ba0f4 | 2009-03-12 19:04:56 -0700 | [diff] [blame] | 1343 | ConstSpec = IdentifierList [ [ CompleteType ] "=" ExpressionList ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1344 | |
| 1345 | IdentifierList = identifier { "," identifier } . |
| 1346 | ExpressionList = Expression { "," Expression } . |
| 1347 | |
| 1348 | CompleteType = Type . |
| 1349 | </pre> |
| 1350 | |
| 1351 | <p> |
| 1352 | If the type (CompleteType) is omitted, the constants take the |
| 1353 | individual types of the corresponding expressions, which may be |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1354 | <i>ideal integer</i> or <i>ideal float</i> (§Ideal number). If the type |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1355 | is present, all constants take the type specified, and the types |
| 1356 | of all the expressions must be assignment-compatible |
| 1357 | with that type. |
| 1358 | </p> |
| 1359 | |
| 1360 | <pre> |
| 1361 | const Pi float64 = 3.14159265358979323846 |
| 1362 | const E = 2.718281828 |
| 1363 | const ( |
| 1364 | size int64 = 1024; |
| 1365 | eof = -1; |
| 1366 | ) |
| 1367 | const a, b, c = 3, 4, "foo" // a = 3, b = 4, c = "foo" |
| 1368 | const u, v float = 0, 3 // u = 0.0, v = 3.0 |
| 1369 | </pre> |
| 1370 | |
| 1371 | <p> |
| 1372 | Within a parenthesized <code>const</code> declaration list the |
| 1373 | expression list may be omitted from any but the first declaration. |
| 1374 | Such an empty list is equivalent to the textual substitution of the |
Russ Cox | f8ba0f4 | 2009-03-12 19:04:56 -0700 | [diff] [blame] | 1375 | first preceding non-empty expression list, and its type if any. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1376 | Omitting the list of expressions is therefore equivalent to |
| 1377 | repeating the previous list. The number of identifiers must be equal |
| 1378 | to the number of expressions in the previous list. |
| 1379 | Together with the <code>iota</code> constant generator |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1380 | (§Iota) this mechanism permits light-weight declaration of sequential values: |
| 1381 | </p> |
| 1382 | |
| 1383 | <pre> |
| 1384 | const ( |
| 1385 | Sunday = iota; |
| 1386 | Monday; |
| 1387 | Tuesday; |
| 1388 | Wednesday; |
| 1389 | Thursday; |
| 1390 | Friday; |
| 1391 | Partyday; |
| 1392 | numberOfDays; // this constant is not exported |
| 1393 | ) |
| 1394 | </pre> |
| 1395 | |
| 1396 | |
| 1397 | <h3>Iota</h3> |
| 1398 | |
| 1399 | <p> |
| 1400 | Within a constant declaration, the predeclared pseudo-constant |
| 1401 | <code>iota</code> represents successive integers. It is reset to 0 |
| 1402 | whenever the reserved word <code>const</code> appears in the source |
| 1403 | and increments with each semicolon. It can be used to construct a |
| 1404 | set of related constants: |
| 1405 | </p> |
| 1406 | |
| 1407 | <pre> |
| 1408 | const ( // iota is reset to 0 |
| 1409 | c0 = iota; // c0 == 0 |
| 1410 | c1 = iota; // c1 == 1 |
| 1411 | c2 = iota // c2 == 2 |
| 1412 | ) |
| 1413 | |
| 1414 | const ( |
| 1415 | a = 1 << iota; // a == 1 (iota has been reset) |
| 1416 | b = 1 << iota; // b == 2 |
| 1417 | c = 1 << iota; // c == 4 |
| 1418 | ) |
| 1419 | |
| 1420 | const ( |
| 1421 | u = iota * 42; // u == 0 (ideal integer) |
| 1422 | v float = iota * 42; // v == 42.0 (float) |
| 1423 | w = iota * 42; // w == 84 (ideal integer) |
| 1424 | ) |
| 1425 | |
| 1426 | const x = iota; // x == 0 (iota has been reset) |
| 1427 | const y = iota; // y == 0 (iota has been reset) |
| 1428 | </pre> |
| 1429 | |
| 1430 | <p> |
| 1431 | Within an ExpressionList, the value of each <code>iota</code> is the same because |
| 1432 | it is only incremented at a semicolon: |
| 1433 | </p> |
| 1434 | |
| 1435 | <pre> |
| 1436 | const ( |
| 1437 | bit0, mask0 = 1 << iota, 1 << iota - 1; // bit0 == 1, mask0 == 0 |
| 1438 | bit1, mask1; // bit1 == 2, mask1 == 1 |
| 1439 | bit2, mask2; // bit2 == 4, mask2 == 3 |
| 1440 | ) |
| 1441 | </pre> |
| 1442 | |
| 1443 | <p> |
| 1444 | This last example exploits the implicit repetition of the |
| 1445 | last non-empty expression list. |
| 1446 | </p> |
| 1447 | |
| 1448 | |
| 1449 | <h3>Type declarations</h3> |
| 1450 | |
| 1451 | <p> |
| 1452 | A type declaration binds an identifier, the <i>type name</i>, |
| 1453 | to a new type. <font color=red>TODO: what exactly is a "new type"?</font> |
| 1454 | </p> |
| 1455 | |
| 1456 | <pre class="grammar"> |
| 1457 | TypeDecl = "type" ( TypeSpec | "(" [ TypeSpecList ] ")" ) . |
| 1458 | TypeSpecList = TypeSpec { ";" TypeSpec } [ ";" ] . |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1459 | TypeSpec = identifier ( Type | "struct" | "interface" ) . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1460 | </pre> |
| 1461 | |
| 1462 | <pre> |
| 1463 | type IntArray [16] int |
| 1464 | |
| 1465 | type ( |
| 1466 | Point struct { x, y float }; |
| 1467 | Polar Point |
| 1468 | ) |
| 1469 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1470 | type Comparable interface |
| 1471 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1472 | type TreeNode struct { |
| 1473 | left, right *TreeNode; |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1474 | value *Comparable; |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1475 | } |
| 1476 | |
| 1477 | type Comparable interface { |
| 1478 | cmp(Comparable) int |
| 1479 | } |
| 1480 | </pre> |
| 1481 | |
| 1482 | <h3>Variable declarations</h3> |
| 1483 | |
| 1484 | <p> |
| 1485 | A variable declaration creates a variable, binds an identifier to it and |
| 1486 | gives it a type and optionally an initial value. |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 1487 | The type must be complete (§Types). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1488 | </p> |
| 1489 | <pre class="grammar"> |
| 1490 | VarDecl = "var" ( VarSpec | "(" [ VarSpecList ] ")" ) . |
| 1491 | VarSpecList = VarSpec { ";" VarSpec } [ ";" ] . |
| 1492 | VarSpec = IdentifierList ( CompleteType [ "=" ExpressionList ] | "=" ExpressionList ) . |
| 1493 | </pre> |
| 1494 | |
| 1495 | <pre> |
| 1496 | var i int |
| 1497 | var U, V, W float |
| 1498 | var k = 0 |
| 1499 | var x, y float = -1.0, -2.0 |
| 1500 | var ( |
| 1501 | i int; |
| 1502 | u, v, s = 2.0, 3.0, "bar" |
| 1503 | ) |
| 1504 | </pre> |
| 1505 | |
| 1506 | <p> |
| 1507 | If there are expressions, their number must be equal |
| 1508 | to the number of identifiers, and the n<sup>th</sup> variable |
| 1509 | is initialized to the value of the n<sup>th</sup> expression. |
| 1510 | Otherwise, each variable is initialized to the <i>zero</i> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1511 | of the type (§The zero value). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1512 | The expressions can be general expressions; they need not be constants. |
| 1513 | </p> |
| 1514 | <p> |
| 1515 | Either the type or the expression list must be present. If the |
| 1516 | type is present, it sets the type of each variable and the expressions |
| 1517 | (if any) must be assignment-compatible to that type. If the type |
| 1518 | is absent, the variables take the types of the corresponding |
| 1519 | expressions. |
| 1520 | </p> |
| 1521 | <p> |
| 1522 | If the type is absent and the corresponding expression is a constant |
| 1523 | expression of ideal integer or ideal float type, the type of the |
| 1524 | declared variable is <code>int</code> or <code>float</code> |
| 1525 | respectively: |
| 1526 | </p> |
| 1527 | |
| 1528 | <pre> |
| 1529 | var i = 0 // i has type int |
| 1530 | var f = 3.1415 // f has type float |
| 1531 | </pre> |
| 1532 | |
| 1533 | <h3>Short variable declarations</h3> |
| 1534 | |
| 1535 | A <i>short variable declaration</i> uses the syntax |
| 1536 | |
| 1537 | <pre class="grammar"> |
| 1538 | SimpleVarDecl = IdentifierList ":=" ExpressionList . |
| 1539 | </pre> |
| 1540 | |
| 1541 | and is shorthand for the declaration syntax |
| 1542 | |
| 1543 | <pre class="grammar"> |
| 1544 | "var" IdentifierList = ExpressionList . |
| 1545 | </pre> |
| 1546 | |
| 1547 | <pre> |
| 1548 | i, j := 0, 10; |
| 1549 | f := func() int { return 7; } |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 1550 | ch := make(chan int); |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1551 | </pre> |
| 1552 | |
| 1553 | <p> |
| 1554 | Unlike regular variable declarations, short variable declarations |
| 1555 | can be used, by analogy with tuple assignment (§Assignments), to |
| 1556 | receive the individual elements of a multi-valued expression such |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1557 | as a call to a multi-valued function. In this form, the ExpressionList |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1558 | must be a single such multi-valued expression, the number of |
| 1559 | identifiers must equal the number of values, and the declared |
| 1560 | variables will be assigned the corresponding values. |
| 1561 | </p> |
| 1562 | |
| 1563 | <pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1564 | r, w := os.Pipe(fd); // os.Pipe() returns two values |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1565 | </pre> |
| 1566 | |
| 1567 | <p> |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1568 | A short variable declaration may redeclare variables provided they |
| 1569 | were originally declared in the same block with the same type, and at |
| 1570 | least one of the variables is new. As a consequence, redeclaration |
| 1571 | can only appear in a multi-variable short declaration. |
| 1572 | Redeclaration does not introduce a new |
| 1573 | variable; it just assigns a new value to the original. |
| 1574 | </p> |
| 1575 | |
| 1576 | <pre> |
| 1577 | field1, offset := nextField(str, 0); |
| 1578 | field2, offset := nextField(str, offset); // redeclares offset |
| 1579 | </pre> |
| 1580 | |
| 1581 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1582 | Short variable declarations may appear only inside functions. |
| 1583 | In some contexts such as the initializers for <code>if</code>, |
| 1584 | <code>for</code>, or <code>switch</code> statements, |
| 1585 | they can be used to declare local temporary variables (§Statements). |
| 1586 | </p> |
| 1587 | |
| 1588 | <h3>Function declarations</h3> |
| 1589 | |
| 1590 | <p> |
| 1591 | A function declaration binds an identifier to a function (§Function types). |
| 1592 | </p> |
| 1593 | |
| 1594 | <pre class="grammar"> |
| 1595 | FunctionDecl = "func" identifier Signature [ Block ] . |
| 1596 | </pre> |
| 1597 | |
| 1598 | <pre> |
| 1599 | func min(x int, y int) int { |
| 1600 | if x < y { |
| 1601 | return x; |
| 1602 | } |
| 1603 | return y; |
| 1604 | } |
| 1605 | </pre> |
| 1606 | |
| 1607 | <p> |
| 1608 | A function must be declared or forward-declared before it can be invoked (§Forward declarations). |
| 1609 | Implementation restriction: Functions can only be declared at the package level. |
| 1610 | </p> |
| 1611 | |
| 1612 | <h3>Method declarations</h3> |
| 1613 | |
| 1614 | <p> |
| 1615 | A method declaration binds an identifier to a method, |
| 1616 | which is a function with a <i>receiver</i>. |
| 1617 | </p> |
| 1618 | <pre class="grammar"> |
| 1619 | MethodDecl = "func" Receiver identifier Signature [ Block ] . |
| 1620 | Receiver = "(" [ identifier ] [ "*" ] TypeName ")" . |
| 1621 | </pre> |
| 1622 | |
| 1623 | <p> |
| 1624 | The receiver type must be a type name or a pointer to a type name, |
| 1625 | and that name is called the <i>receiver base type</i> or just <i>base type</i>. |
| 1626 | The base type must not be a pointer type and must be |
| 1627 | declared in the same source file as the method. |
| 1628 | The method is said to be <i>bound</i> to the base type |
| 1629 | and is visible only within selectors for that type |
| 1630 | (§Type declarations, §Selectors). |
| 1631 | </p> |
| 1632 | |
| 1633 | <p> |
| 1634 | All methods bound to a base type must have the same receiver type, |
| 1635 | either all pointers to the base type or all the base type itself. |
| 1636 | Given type <code>Point</code>, the declarations |
| 1637 | </p> |
| 1638 | |
| 1639 | <pre> |
| 1640 | func (p *Point) Length() float { |
| 1641 | return Math.sqrt(p.x * p.x + p.y * p.y); |
| 1642 | } |
| 1643 | |
| 1644 | func (p *Point) Scale(factor float) { |
| 1645 | p.x = p.x * factor; |
| 1646 | p.y = p.y * factor; |
| 1647 | } |
| 1648 | </pre> |
| 1649 | |
| 1650 | <p> |
| 1651 | bind the methods <code>Length</code> and <code>Scale</code> |
| 1652 | to the base type <code>Point</code>. |
| 1653 | </p> |
| 1654 | |
| 1655 | <p> |
| 1656 | If the |
| 1657 | receiver's value is not referenced inside the the body of the method, |
| 1658 | its identifier may be omitted in the declaration. The same applies in |
| 1659 | general to parameters of functions and methods. |
| 1660 | </p> |
| 1661 | |
| 1662 | <p> |
| 1663 | Methods can be declared |
| 1664 | only after their base type is declared or forward-declared, and invoked |
| 1665 | only after their own declaration or forward-declaration (§Forward declarations). |
| 1666 | Implementation restriction: They can only be declared at package level. |
| 1667 | </p> |
| 1668 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1669 | <p> |
| 1670 | The type of a method is the type of a function with the receiver as first |
| 1671 | argument. For instance, the method <code>Scale</code> has type |
| 1672 | </p> |
| 1673 | |
| 1674 | <pre> |
| 1675 | (p *Point, factor float) |
| 1676 | </pre> |
| 1677 | |
| 1678 | <p> |
| 1679 | However, a function declared this way is not a method. |
| 1680 | </p> |
| 1681 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1682 | <h3>Forward declarations</h3> |
| 1683 | |
| 1684 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1685 | Mutually-recursive types require that one be |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1686 | <i>forward declared</i> so that it may be named in the other. |
| 1687 | A forward declaration of a type omits the block containing the fields |
| 1688 | or methods of the type. |
| 1689 | </p> |
| 1690 | |
| 1691 | <pre> |
| 1692 | type List struct // forward declaration of List |
| 1693 | type Item struct { |
| 1694 | value int; |
| 1695 | next *List; |
| 1696 | } |
| 1697 | type List struct { |
| 1698 | head, tail *Item |
| 1699 | } |
| 1700 | </pre> |
| 1701 | <p> |
| 1702 | A forward-declared type is incomplete (§Types) |
| 1703 | until it is fully declared. The full declaration must follow |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1704 | before the end of the block containing the forward declaration; |
| 1705 | it cannot be contained in an inner block. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1706 | </p> |
| 1707 | <p> |
| 1708 | Functions and methods may similarly be forward-declared by omitting their body. |
| 1709 | </p> |
| 1710 | <pre> |
| 1711 | func F(a int) int // forward declaration of F |
| 1712 | func G(a, b int) int { |
| 1713 | return F(a) + F(b) |
| 1714 | } |
| 1715 | func F(a int) int { |
| 1716 | if a <= 0 { return 0 } |
| 1717 | return G(a-1, b+1) |
| 1718 | } |
| 1719 | </pre> |
| 1720 | |
| 1721 | <hr/> |
| 1722 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1723 | <h2>Expressions</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1724 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1725 | <p> |
| 1726 | An expression specifies the computation of a value by applying |
| 1727 | operators and functions to operands. An expression has a value and |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1728 | a type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1729 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1730 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1731 | <h3>Operands</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1732 | |
| 1733 | Operands denote the elementary values in an expression. |
| 1734 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1735 | <pre class="grammar"> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1736 | Operand = Literal | QualifiedIdent | "(" Expression ")" . |
| 1737 | Literal = BasicLit | CompositeLit | FunctionLit . |
| 1738 | BasicLit = int_lit | float_lit | char_lit | StringLit . |
| 1739 | StringLit = string_lit { string_lit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1740 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1741 | |
| 1742 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1743 | <h3>Constants</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1744 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1745 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1746 | A <i>constant</i> is a literal of a basic type |
| 1747 | (including the predeclared constants <code>true</code>, <code>false</code> |
| 1748 | and <code>nil</code> |
| 1749 | and values denoted by <code>iota</code>) |
| 1750 | or a constant expression (§Constant expressions). |
| 1751 | Constants have values that are known at compile time. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1752 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1753 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1754 | <h3>Qualified identifiers</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1755 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1756 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1757 | A qualified identifier is an identifier qualified by a package name prefix. |
| 1758 | </p> |
Robert Griesemer | 337af31 | 2008-11-17 18:11:36 -0800 | [diff] [blame] | 1759 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1760 | <pre class="grammar"> |
Robert Griesemer | b813ee0 | 2009-03-05 15:01:54 -0800 | [diff] [blame] | 1761 | QualifiedIdent = [ ( LocalPackageName | PackageName ) "." ] identifier . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1762 | LocalPackageName = identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1763 | PackageName = identifier . |
| 1764 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1765 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1766 | <p> |
| 1767 | A qualified identifier accesses an identifier in |
| 1768 | a separate package. The identifier must be exported by that package, which |
| 1769 | means that it must begin with a Unicode upper case letter (§Exported identifiers). |
| 1770 | </p> |
| 1771 | <p> |
| 1772 | The LocalPackageName is that of the package in which the qualified identifier |
| 1773 | appears and is only necessary to access names hidden by intervening declarations |
| 1774 | of a package-level identifier. |
| 1775 | </p> |
| 1776 | |
| 1777 | <pre> |
| 1778 | Math.Sin |
| 1779 | mypackage.hiddenName |
| 1780 | mypackage.Math.Sin // if Math is declared in an intervening scope |
| 1781 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1782 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1783 | TODO: 6g does not implement LocalPackageName. Is this new? |
| 1784 | Is it needed? |
| 1785 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1786 | <h3>Composite literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1787 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1788 | <p> |
| 1789 | Composite literals construct values for structs, arrays, slices, and maps |
| 1790 | and create a new value each time they are evaluated. |
| 1791 | They consist of the type of the value |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1792 | followed by a brace-bound list of expressions, |
Robert Griesemer | c5c577c | 2009-03-27 13:43:28 -0700 | [diff] [blame] | 1793 | or a list of key-value pairs for map literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1794 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1795 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1796 | <pre class="grammar"> |
Robert Griesemer | c5c577c | 2009-03-27 13:43:28 -0700 | [diff] [blame] | 1797 | CompositeLit = LiteralType "{" [ ( ExpressionList | KeyValueList ) [ "," ] ] "}" . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1798 | LiteralType = StructType | ArrayType | "[" "..." "]" ElementType | |
| 1799 | SliceType | MapType | TypeName . |
Robert Griesemer | c5c577c | 2009-03-27 13:43:28 -0700 | [diff] [blame] | 1800 | KeyValueList = KeyValueExpr { "," KeyValueExpr } . |
| 1801 | KeyValueExpr = Expression ":" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1802 | </pre> |
Robert Griesemer | 0976e34 | 2008-09-03 13:37:44 -0700 | [diff] [blame] | 1803 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1804 | <p> |
| 1805 | The LiteralType must be a struct, array, slice, or map type. |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 1806 | (The grammar enforces this constraint except when the type is given |
| 1807 | as a TypeName.) |
| 1808 | The types of the expressions must be assignment compatible to |
| 1809 | the respective field, element, and key types of the LiteralType; |
| 1810 | there is no additional conversion. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1811 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1812 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1813 | <pre> |
| 1814 | type Rat struct { num, den int } |
| 1815 | type Num struct { r Rat; f float; s string } |
| 1816 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1817 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1818 | <p> |
| 1819 | one may write |
| 1820 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1821 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1822 | <pre> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1823 | pi := Num{Rat{22, 7}, 3.14159, "pi"} |
| 1824 | </pre> |
| 1825 | |
| 1826 | <p> |
Rob Pike | 2a5af74 | 2009-03-20 17:03:48 -0700 | [diff] [blame] | 1827 | Taking the address of a composite literal (§Address operators) |
| 1828 | generates a unique pointer to an instance of the literal's value. |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1829 | </p> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1830 | <pre> |
| 1831 | var pi_ptr *Rat = &Rat{22, 7} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1832 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1833 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1834 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1835 | The length of an array literal is the length specified in the LiteralType. |
| 1836 | 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] | 1837 | elements are set to the zero value for the array element type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1838 | It is an error to provide more elements than specified in the type. The |
| 1839 | notation <code>...</code> specifies an array length equal |
| 1840 | to the number of elements in the literal. |
| 1841 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1842 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1843 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1844 | buffer := [10]string{}; // len(buffer) == 10 |
| 1845 | primes := [6]int{2, 3, 5, 7, 9, 11}; // len(primes) == 6 |
| 1846 | days := [...]string{"Sat", "Sun"}; // len(days) == 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1847 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1848 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1849 | <p> |
| 1850 | A slice literal describes the entire underlying array literal. |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1851 | Thus, the length and capacity of a slice literal is the number of elements |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1852 | (of the array) provided in the literal. A slice literal has the form |
| 1853 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1854 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1855 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1856 | []T{x1, x2, ... xn} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1857 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1858 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1859 | <p> |
| 1860 | and is a shortcut for a slice operation applied to an array literal: |
| 1861 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1862 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1863 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1864 | [n]T{x1, x2, ... xn}[0 : n] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1865 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1866 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1867 | <p> |
| 1868 | In map literals only, the list contains |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1869 | key-value pairs separated by a colon: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1870 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1871 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1872 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1873 | m := map[string]int{"good": 0, "bad": 1, "indifferent": 7}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1874 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1875 | |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 1876 | <p> |
| 1877 | A parsing ambiguity arises when a composite literal using the |
| 1878 | TypeName form of the LiteralType appears in the condition of an |
| 1879 | "if", "for", or "switch" statement, because the braces surrounding |
| 1880 | the expressions in the literal are confused with those introducing |
| 1881 | a block of statements. To resolve the ambiguity in this rare case, |
| 1882 | the composite literal must appear within |
| 1883 | parentheses. |
| 1884 | </p> |
| 1885 | |
| 1886 | <pre> |
| 1887 | if x == (T{a,b,c}[i]) { ... } |
| 1888 | if (x == T{a,b,c}[i]) { ... } |
| 1889 | </pre> |
| 1890 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1891 | <h3>Function literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1892 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1893 | <p> |
| 1894 | A function literal represents an anonymous function. |
| 1895 | It consists of a specification of the function type and a function body. |
| 1896 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1897 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1898 | <pre class="grammar"> |
Robert Griesemer | 62fd90a | 2009-03-25 13:58:44 -0700 | [diff] [blame] | 1899 | FunctionLit = FunctionType Block . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1900 | Block = "{" StatementList "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1901 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1902 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1903 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1904 | func (a, b int, z float) bool { return a*b < int(z) } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1905 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1906 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1907 | <p> |
| 1908 | A function literal can be assigned to a variable or invoked directly. |
| 1909 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1910 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1911 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1912 | f := func(x, y int) int { return x + y } |
| 1913 | func(ch chan int) { ch <- ACK } (reply_chan) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1914 | </pre> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1915 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1916 | <p> |
| 1917 | Function literals are <i>closures</i>: they may refer to variables |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 1918 | defined in a surrounding function. Those variables are then shared between |
| 1919 | the surrounding function and the function literal, and they survive as long |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1920 | as they are accessible. |
| 1921 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1922 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1923 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1924 | <h3>Primary expressions</h3> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1925 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1926 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1927 | PrimaryExpr = |
| 1928 | Operand | |
| 1929 | PrimaryExpr Selector | |
| 1930 | PrimaryExpr Index | |
| 1931 | PrimaryExpr Slice | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1932 | PrimaryExpr TypeAssertion | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1933 | PrimaryExpr Call . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 1934 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1935 | Selector = "." identifier . |
| 1936 | Index = "[" Expression "]" . |
| 1937 | Slice = "[" Expression ":" Expression "]" . |
| 1938 | TypeAssertion = "." "(" Type ")" . |
| 1939 | Call = "(" [ ExpressionList ] ")" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1940 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1941 | |
| 1942 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1943 | <pre> |
| 1944 | x |
| 1945 | 2 |
| 1946 | (s + ".txt") |
| 1947 | f(3.1415, true) |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1948 | Point{1, 2} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1949 | m["foo"] |
| 1950 | s[i : j + 1] |
| 1951 | obj.color |
| 1952 | Math.sin |
| 1953 | f.p[i].x() |
| 1954 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1955 | |
| 1956 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1957 | <h3>Selectors</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1958 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1959 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 1960 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1961 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1962 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1963 | <pre> |
| 1964 | x.f |
| 1965 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 1966 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1967 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1968 | denotes the field or method <code>f</code> of the value denoted by <code>x</code> |
| 1969 | (or of <code>*x</code> if |
| 1970 | <code>x</code> is of pointer type). The identifier <code>f</code> |
| 1971 | is called the (field or method) |
| 1972 | <i>selector</i>. |
| 1973 | The type of the expression is the type of <code>f</code>. |
| 1974 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1975 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1976 | A selector <code>f</code> may denote a field or method <code>f</code> of |
| 1977 | a type <code>T</code>, or it may refer |
| 1978 | to a field or method <code>f</code> of a nested anonymous field of |
| 1979 | <code>T</code>. |
| 1980 | The number of anonymous fields traversed |
| 1981 | to reach <code>f</code> is called its <i>depth</i> in <code>T</code>. |
| 1982 | The depth of a field or method <code>f</code> |
| 1983 | declared in <code>T</code> is zero. |
| 1984 | The depth of a field or method <code>f</code> declared in |
| 1985 | an anonymous field <code>A</code> in <code>T</code> is the |
| 1986 | depth of <code>f</code> in <code>A</code> plus one. |
| 1987 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1988 | <p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 1989 | The following rules apply to selectors: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1990 | </p> |
| 1991 | <ol> |
| 1992 | <li> |
| 1993 | For a value <code>x</code> of type <code>T</code> or <code>*T</code> |
| 1994 | where <code>T</code> is not an interface type, |
| 1995 | <code>x.f</code> denotes the field or method at the shallowest depth |
| 1996 | in <code>T</code> where there |
| 1997 | is such an <code>f</code>. |
| 1998 | 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] | 1999 | expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2000 | </li> |
| 2001 | <li> |
| 2002 | For a variable <code>x</code> of type <code>I</code> or <code>*I</code> |
| 2003 | where <code>I</code> is an interface type, |
| 2004 | <code>x.f</code> denotes the actual method with name <code>f</code> of the value assigned |
| 2005 | to <code>x</code> if there is such a method. |
| 2006 | If no value or <code>nil</code> was assigned to <code>x</code>, <code>x.f</code> is illegal. |
| 2007 | </li> |
| 2008 | <li> |
| 2009 | In all other cases, <code>x.f</code> is illegal. |
| 2010 | </ol> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2011 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2012 | Selectors automatically dereference pointers as necessary. |
| 2013 | If <code>x</code> is of pointer type, <code>x.y</code> |
| 2014 | is shorthand for <code>(*x).y</code>; if <code>y</code> |
| 2015 | is also of pointer type, <code>x.y.z</code> is shorthand |
| 2016 | for <code>(*(*x).y).z</code>, and so on. |
| 2017 | If <code>*x</code> is of pointer type, dereferencing |
| 2018 | must be explicit; |
| 2019 | only one level of automatic dereferencing is provided. |
| 2020 | For an <code>x</code> of type <code>T</code> containing an |
| 2021 | anonymous field declared as <code>*A</code>, |
| 2022 | <code>x.f</code> is a shortcut for <code>(*x.A).f</code>. |
| 2023 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2024 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2025 | For example, given the declarations: |
| 2026 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2027 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2028 | <pre> |
| 2029 | type T0 struct { |
| 2030 | x int; |
| 2031 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2032 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2033 | func (recv *T0) M0() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2034 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2035 | type T1 struct { |
| 2036 | y int; |
| 2037 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2038 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2039 | func (recv T1) M1() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2040 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2041 | type T2 struct { |
| 2042 | z int; |
| 2043 | T1; |
| 2044 | *T0; |
| 2045 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2046 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2047 | func (recv *T2) M2() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2048 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2049 | var p *T2; // with p != nil and p.T1 != nil |
| 2050 | </pre> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2051 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2052 | <p> |
| 2053 | one may write: |
| 2054 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2055 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2056 | <pre> |
| 2057 | p.z // (*p).z |
| 2058 | p.y // ((*p).T1).y |
| 2059 | p.x // (*(*p).T0).x |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2060 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2061 | p.M2 // (*p).M2 |
| 2062 | p.M1 // ((*p).T1).M1 |
| 2063 | p.M0 // ((*p).T0).M0 |
| 2064 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2065 | |
| 2066 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2067 | <font color=red> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2068 | TODO: Specify what happens to receivers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2069 | </font> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2070 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2071 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2072 | <h3>Indexes</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2073 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2074 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2075 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2076 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2077 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2078 | <pre> |
| 2079 | a[x] |
| 2080 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2081 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2082 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2083 | denotes the array or map element of <code>a</code> indexed by <code>x</code>. |
| 2084 | The value <code>x</code> is called the |
| 2085 | <i>array index</i> or <i>map key</i>, respectively. The following |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2086 | rules apply: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2087 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2088 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2089 | For <code>a</code> of type <code>A</code> or <code>*A</code> |
| 2090 | where <code>A</code> is an array type (§Array types): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2091 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2092 | <ul> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2093 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code> |
| 2094 | <li><code>a[x]</code> is the array element at index <code>x</code> and the type of |
| 2095 | <code>a[x]</code> is the element type of <code>A</code> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2096 | </ul> |
| 2097 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2098 | For <code>a</code> of type <code>M</code> or <code>*M</code> |
| 2099 | where <code>M</code> is a map type (§Map types): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2100 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2101 | <ul> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2102 | <li><code>x</code>'s type must be equal to the key type of <code>M</code> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2103 | and the map must contain an entry with key <code>x</code> (but see special forms below) |
| 2104 | <li><code>a[x]</code> is the map value with key <code>x</code> |
| 2105 | 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] | 2106 | </ul> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2107 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2108 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2109 | Otherwise <code>a[x]</code> is illegal. If the index or key is out of range evaluating |
| 2110 | an otherwise legal index expression, a run-time exception occurs. |
| 2111 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2112 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2113 | <p> |
| 2114 | However, if an index expression on a map <code>a</code> of type <code>map[K] V</code> |
| 2115 | is used in an assignment of one of the special forms |
| 2116 | </p> |
| 2117 | |
| 2118 | <pre> |
| 2119 | r, ok = a[x] |
| 2120 | r, ok := a[x] |
| 2121 | </pre> |
| 2122 | |
| 2123 | <p> |
| 2124 | the result of the index expression is a pair of values with types |
| 2125 | <code>(K, bool)</code>. |
| 2126 | If the key is present in the map, |
| 2127 | the expression returns the pair <code>(a[x], true)</code>; |
| 2128 | otherwise it returns <code>(Z, false)</code> where <code>Z</code> is |
| 2129 | the zero value for <code>V</code> (§The zero value). |
| 2130 | No run-time exception occurs in this case. |
| 2131 | The index expression in this construct thus acts like a function call |
| 2132 | returning a value and a boolean indicating success. (§Assignments) |
| 2133 | </p> |
| 2134 | |
| 2135 | <p> |
| 2136 | Similarly, if an assignment to a map has the special form |
| 2137 | </p> |
| 2138 | |
| 2139 | <pre> |
| 2140 | a[x] = r, ok |
| 2141 | </pre> |
| 2142 | |
| 2143 | <p> |
| 2144 | and boolean <code>ok</code> has the value <code>false</code>, |
| 2145 | the entry for key <code>x</code> is deleted from the map; if |
| 2146 | <code>ok</code> is <code>true</code>, the construct acts like |
| 2147 | a regular assignment to an element of the map. |
| 2148 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2149 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2150 | <h3>Slices</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2151 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2152 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 2153 | 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] | 2154 | of subarrays. The index expressions in the slice select which elements appear |
| 2155 | 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] | 2156 | difference in the index values in the slice. After slicing the array <code>a</code> |
| 2157 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2158 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2159 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2160 | a := [4]int{1, 2, 3, 4}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2161 | s := a[1:3]; |
| 2162 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2163 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2164 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2165 | 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] | 2166 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2167 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2168 | <pre> |
| 2169 | s[0] == 2 |
| 2170 | s[1] == 3 |
| 2171 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2172 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2173 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 2174 | The slice length must be non-negative. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2175 | For arrays or strings, the indexes |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 2176 | <code>lo</code> and <code>hi</code> must satisfy |
| 2177 | 0 <= <code>lo</code> <= <code>hi</code> <= length; |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2178 | for slices, the upper bound is the capacity rather than the length. |
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 | If the sliced operand is a string, the result of the slice operation is another, new |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 2181 | string (§String types). If the sliced operand is an array or slice, the result |
| 2182 | of the slice operation is a slice (§Slice types). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2183 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2184 | |
| 2185 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2186 | <h3>Type assertions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2187 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2188 | <p> |
| 2189 | For an expression <code>x</code> and a type <code>T</code>, the primary expression |
| 2190 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2191 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2192 | <pre> |
| 2193 | x.(T) |
| 2194 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2195 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2196 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2197 | asserts 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] | 2198 | The notation <code>x.(T)</code> is called a <i>type assertion</i>. |
| 2199 | The type of <code>x</code> must be an interface type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2200 | </p> |
| 2201 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2202 | 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] | 2203 | that the dynamic type of <code>x</code> is identical to the type <code>T</code> |
| 2204 | (§Type equality and identity). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2205 | If <code>T</code> is an interface type, <code>x.(T)</code> asserts that the dynamic type |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2206 | of <code>T</code> implements the interface <code>T</code> (§Interface types). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2207 | <font color=red>TODO: gri wants an error if x is already of type T.</font> |
| 2208 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2209 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2210 | If the type assertion holds, the value of the expression is the value |
| 2211 | 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] | 2212 | 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] | 2213 | 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] | 2214 | known to be <code>T</code> in a correct program. |
| 2215 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2216 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2217 | If a type assertion is used in an assignment of one of the special forms, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2218 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2219 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2220 | <pre> |
| 2221 | v, ok = x.(T) |
| 2222 | v, ok := x.(T) |
| 2223 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2224 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2225 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2226 | the result of the assertion is a pair of values with types <code>(T, bool)</code>. |
| 2227 | 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] | 2228 | otherwise, the expression returns <code>(Z, false)</code> where <code>Z</code> |
| 2229 | is the zero value for type <code>T</code> (§The zero value). |
| 2230 | No run-time exception occurs in this case. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2231 | The type assertion in this construct thus acts like a function call |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2232 | returning a value and a boolean indicating success. (§Assignments) |
| 2233 | </p> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2234 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2235 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2236 | <h3>Calls</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2237 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2238 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2239 | Given an expression <code>f</code> of function type |
| 2240 | <code>F</code>, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2241 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2242 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2243 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2244 | f(a1, a2, ... an) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2245 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2246 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2247 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2248 | calls <code>f</code> with arguments <code>a1, a2, ... an</code>. |
| 2249 | The arguments must be single-valued expressions |
| 2250 | assignment compatible with the parameters of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2251 | <code>F</code> and are evaluated before the function is called. |
| 2252 | The type of the expression is the result type |
| 2253 | of <code>F</code>. |
| 2254 | A method invocation is similar but the method itself |
| 2255 | is specified as a selector upon a value of the receiver type for |
| 2256 | the method. |
| 2257 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2258 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2259 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2260 | Atan2(x, y) // function call |
| 2261 | var pt *Point; |
| 2262 | pt.Scale(3.5) // method call with receiver pt |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2263 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2264 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2265 | <p> |
| 2266 | If the receiver type of the method is declared as a pointer of type <code>*T</code>, |
| 2267 | the actual receiver may be a value of type <code>T</code>; |
| 2268 | in such cases method invocation implicitly takes the |
| 2269 | receiver's address: |
| 2270 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2271 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2272 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2273 | var p Point; |
| 2274 | p.Scale(3.5) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2275 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2276 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2277 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2278 | There is no distinct method type and there are no method literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2279 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2280 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2281 | <h3>Passing arguments to <code>...</code> parameters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2282 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2283 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2284 | When a function <code>f</code> has a <code>...</code> parameter, |
| 2285 | it is always the last formal parameter. Within calls to <code>f</code>, |
| 2286 | the arguments before the <code>...</code> are treated normally. |
| 2287 | After those, an arbitrary number (including zero) of trailing |
| 2288 | arguments may appear in the call and are bound to the <code>...</code> |
| 2289 | parameter. |
| 2290 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2291 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2292 | <p> |
| 2293 | Within <code>f</code>, the <code>...</code> parameter has static |
| 2294 | type <code>interface{}</code> (the empty interface). For each call, |
| 2295 | its dynamic type is a structure whose sequential fields are the |
| 2296 | trailing arguments of the call. That is, the actual arguments |
| 2297 | provided for a <code>...</code> parameter are wrapped into a struct |
| 2298 | that is passed to the function instead of the actual arguments. |
| 2299 | Using the reflection library (TODO: reference), <code>f</code> may |
| 2300 | unpack the elements of the dynamic type to recover the actual |
| 2301 | arguments. |
| 2302 | </p> |
| 2303 | |
| 2304 | <p> |
| 2305 | Given the function and call |
| 2306 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2307 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2308 | func Fprintf(f io.Write, format string, args ...) |
| 2309 | Fprintf(os.Stdout, "%s %d", "hello", 23); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2310 | </pre> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2311 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2312 | <p> |
| 2313 | Within <code>Fprintf</code>, the dynamic type of <code>args</code> for this |
| 2314 | call will be, schematically, |
| 2315 | <code> struct { string; int }</code>. |
| 2316 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2317 | |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2318 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2319 | <p> |
| 2320 | As a special case, if a function passes its own <code>...</code> parameter as the argument |
| 2321 | for a <code>...</code> in a call to another function with a <code>...</code> parameter, |
| 2322 | the parameter is not wrapped again but passed directly. In short, a formal <code>...</code> |
| 2323 | parameter is passed unchanged as an actual <code>...</code> parameter. |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2324 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2325 | <h3>Operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2326 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2327 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2328 | Operators combine operands into expressions. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2329 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2330 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2331 | <pre class="grammar"> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2332 | Expression = UnaryExpr | Expression binary_op UnaryExpr . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2333 | UnaryExpr = PrimaryExpr | unary_op UnaryExpr . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2334 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2335 | binary_op = log_op | com_op | rel_op | add_op | mul_op . |
| 2336 | log_op = "||" | "&&" . |
| 2337 | com_op = "<-" . |
| 2338 | rel_op = "==" | "!=" | "<" | "<=" | ">" | ">=" . |
| 2339 | add_op = "+" | "-" | "|" | "^" . |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 2340 | mul_op = "*" | "/" | "%" | "<<" | ">>" | "&" | "&^" . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2341 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2342 | unary_op = "+" | "-" | "!" | "^" | "*" | "&" | "<-" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2343 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2344 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2345 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2346 | The operand types in binary operations must be equal, with the following exceptions: |
| 2347 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2348 | <ul> |
Rob Pike | 9b5d823 | 2009-03-12 18:47:49 -0700 | [diff] [blame] | 2349 | <li>Except in shift expressions, if one operand has numeric type and the other operand is |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 2350 | an ideal number, the ideal number is converted to match the type of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2351 | the other operand (§Expressions).</li> |
Robert Griesemer | c8e1876 | 2008-09-12 12:26:22 -0700 | [diff] [blame] | 2352 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2353 | <li>If both operands are ideal numbers, the conversion is to ideal floats |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2354 | if one of the operands is an ideal float |
| 2355 | (relevant for <code>/</code> and <code>%</code>).</li> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2356 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2357 | <li>The right operand in a shift operation must be always be of unsigned integer type |
| 2358 | or an ideal number that can be safely converted into an unsigned integer type |
| 2359 | (§Arithmetic operators).</li> |
| 2360 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2361 | <li>The operands in channel sends differ in type: one is always a channel and the |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2362 | other is a variable or value of the channel's element type.</li> |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 2363 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2364 | <li>When comparing two operands of channel type, the channel value types |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2365 | must be equal but the channel direction is ignored.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2366 | </ul> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2367 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2368 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2369 | Unary operators have the highest precedence. They are evaluated from |
| 2370 | right to left. As the <code>++</code> and <code>--</code> operators form |
| 2371 | statements, not expressions, they fall |
| 2372 | outside the unary operator hierarchy and apply |
| 2373 | to the operand on the left. |
| 2374 | As a consequence, statement <code>*p++</code> is the same as <code>(*p)++</code>. |
| 2375 | <p> |
| 2376 | There are six precedence levels for binary operators. |
| 2377 | Multiplication operators bind strongest, followed by addition |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2378 | operators, comparison operators, communication operators, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2379 | <code>&&</code> (logical and), and finally <code>||</code> (logical or): |
| 2380 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2381 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2382 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2383 | Precedence Operator |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 2384 | 6 * / % << >> & &^ |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2385 | 5 + - | ^ |
| 2386 | 4 == != < <= > >= |
| 2387 | 3 <- |
| 2388 | 2 && |
| 2389 | 1 || |
| 2390 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2391 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2392 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2393 | Binary operators of the same precedence associate from left to right. |
| 2394 | For instance, <code>x / y / z</code> is the same as <code>(x / y) / z</code>. |
| 2395 | </p> |
| 2396 | <p> |
| 2397 | Examples: |
| 2398 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2399 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2400 | <pre> |
| 2401 | +x |
| 2402 | 23 + 3*x[i] |
| 2403 | x <= f() |
| 2404 | ^a >> b |
| 2405 | f() || g() |
| 2406 | x == y + 1 && <-chan_ptr > 0 |
| 2407 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2408 | |
| 2409 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2410 | <h3>Arithmetic operators</h3> |
| 2411 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2412 | Arithmetic operators apply to numeric types and yield a result of the same |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2413 | type as the first operand. The four standard arithmetic operators (<code>+</code>, |
| 2414 | <code>-</code>, <code>*</code>, <code>/</code>) apply both to integer and |
| 2415 | floating point types, while <code>+</code> applies also |
| 2416 | to strings; all other arithmetic operators apply to integers only. |
| 2417 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2418 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2419 | <pre class="grammar"> |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2420 | + sum integers, floats, strings |
| 2421 | - difference integers, floats |
| 2422 | * product integers, floats |
| 2423 | / quotient integers, floats |
| 2424 | % remainder integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2425 | |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2426 | & bitwise and integers |
| 2427 | | bitwise or integers |
| 2428 | ^ bitwise xor integers |
| 2429 | &^ bit clear (and not) integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2430 | |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2431 | << left shift integer << unsigned integer |
| 2432 | >> right shift integer >> unsigned integer |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2433 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2434 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2435 | <p> |
| 2436 | Strings can be concatenated using the <code>+</code> operator |
| 2437 | or the <code>+=</code> assignment operator: |
| 2438 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2439 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2440 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2441 | s := "hi" + string(c); |
| 2442 | s += " and good bye"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2443 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2444 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2445 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2446 | String addition creates a new string by concatenating the operands. |
| 2447 | </p> |
| 2448 | <p> |
| 2449 | For integer values, <code>/</code> and <code>%</code> satisfy the following relationship: |
| 2450 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2451 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2452 | <pre> |
| 2453 | (a / b) * b + a % b == a |
| 2454 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2455 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2456 | <p> |
| 2457 | with <code>(a / b)</code> truncated towards zero. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2458 | Examples: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2459 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2460 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2461 | <pre> |
| 2462 | x y x / y x % y |
| 2463 | 5 3 1 2 |
| 2464 | -5 3 -1 -2 |
| 2465 | 5 -3 -1 2 |
| 2466 | -5 -3 1 -2 |
| 2467 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2468 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2469 | <p> |
| 2470 | If the dividend is positive and the divisor is a constant power of 2, |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2471 | the division may be replaced by a left shift, and computing the remainder may |
| 2472 | be replaced by a bitwise "and" operation: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2473 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2474 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2475 | <pre> |
| 2476 | x x / 4 x % 4 x >> 2 x & 3 |
| 2477 | 11 2 3 2 3 |
| 2478 | -11 -2 -3 -3 1 |
| 2479 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2480 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2481 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2482 | The shift operators shift the left operand by the shift count specified by the |
| 2483 | 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] | 2484 | integer and logical shifts if it is an unsigned integer. The shift count must |
| 2485 | be an unsigned integer. There is no upper limit on the shift count. Shifts behave |
| 2486 | as if the left operand is shifted <code>n</code> times by 1 for a shift |
| 2487 | count of <code>n</code>. |
| 2488 | As a result, <code>x << 1</code> is the same as <code>x*2</code> |
| 2489 | and <code>x >> 1</code> is the same as |
| 2490 | <code>x/2</code> truncated towards negative infinity. |
| 2491 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2492 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2493 | <p> |
| 2494 | For integer operands, the unary operators |
| 2495 | <code>+</code>, <code>-</code>, and <code>^</code> are defined as |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2496 | follows: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2497 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2498 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2499 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2500 | +x is 0 + x |
| 2501 | -x negation is 0 - x |
| 2502 | ^x bitwise complement is m ^ x with m = "all bits set to 1" |
| 2503 | </pre> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2504 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2505 | <p> |
| 2506 | For floating point numbers, |
| 2507 | <code>+x</code> is the same as <code>x</code>, |
| 2508 | while <code>-x</code> is the negation of <code>x</code>. |
| 2509 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2510 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2511 | <h3>Integer overflow</h3> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2512 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2513 | <p> |
| 2514 | For unsigned integer values, the operations <code>+</code>, |
| 2515 | <code>-</code>, <code>*</code>, and <code><<</code> are |
| 2516 | computed modulo 2<sup><i>n</i></sup>, where <i>n</i> is the bit width of |
| 2517 | the unsigned integer's type |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2518 | (§Numeric types). Loosely speaking, these unsigned integer operations |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2519 | discard high bits upon overflow, and programs may rely on ``wrap around''. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2520 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2521 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2522 | For signed integers, the operations <code>+</code>, |
| 2523 | <code>-</code>, <code>*</code>, and <code><<</code> may legally |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2524 | overflow and the resulting value exists and is deterministically defined |
| 2525 | by the signed integer representation, the operation, and its operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2526 | No exception is raised as a result of overflow. A |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2527 | compiler may not optimize code under the assumption that overflow does |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2528 | not occur. For instance, it may not assume that <code>x < x + 1</code> is always true. |
| 2529 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2530 | |
| 2531 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2532 | <h3>Comparison operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2533 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2534 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2535 | Comparison operators yield a boolean result. All comparison operators apply |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2536 | to basic types except bools. |
| 2537 | The operators <code>==</code> and <code>!=</code> apply, at least in some cases, |
| 2538 | to all types except arrays and structs. |
| 2539 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2540 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2541 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2542 | == equal |
| 2543 | != not equal |
| 2544 | < less |
| 2545 | <= less or equal |
| 2546 | > greater |
| 2547 | >= greater or equal |
| 2548 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2549 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2550 | <p> |
| 2551 | Numeric basic types are compared in the usual way. |
| 2552 | </p> |
| 2553 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 2554 | Strings are compared byte-wise (lexically). |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2555 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2556 | <p> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2557 | Booleans are equal if they are either both "true" or both "false". |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2558 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2559 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2560 | The rules for comparison of composite types are described in the |
| 2561 | section on §Comparison compatibility. |
| 2562 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 2563 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2564 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2565 | <h3>Logical operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2566 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2567 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2568 | Logical operators apply to boolean operands and yield a boolean result. |
| 2569 | The right operand is evaluated conditionally. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2570 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2571 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2572 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2573 | && conditional and p && q is "if p then q else false" |
| 2574 | || conditional or p || q is "if p then true else q" |
| 2575 | ! not !p is "not p" |
| 2576 | </pre> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2577 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2578 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2579 | <h3>Address operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2580 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2581 | <p> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2582 | The unary prefix address-of operator <code>&</code> generates the address of its operand, which must be a variable, |
| 2583 | pointer indirection, field selector, or array or slice indexing operation. It is illegal to take the address of a function |
| 2584 | result variable. |
| 2585 | Given an operand of pointer type, the unary prefix pointer indirection operator <code>*</code> retrieves the value pointed |
| 2586 | to by the operand. |
| 2587 | </p> |
| 2588 | |
| 2589 | <pre> |
| 2590 | &x |
| 2591 | &a[f(2)] |
| 2592 | *p |
| 2593 | *pf(x) |
| 2594 | </pre> |
| 2595 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2596 | <p> |
| 2597 | <font color=red>TODO: This text needs to be cleaned up and go elsewhere, there are no address |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2598 | operators involved. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2599 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2600 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2601 | <p> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2602 | Methods are a form of function and a method ``value'' has a function type. |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2603 | Consider the type T with method M: |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2604 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2605 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2606 | <pre> |
| 2607 | type T struct { |
| 2608 | a int; |
| 2609 | } |
| 2610 | func (tp *T) M(a int) int; |
| 2611 | var t *T; |
| 2612 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2613 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2614 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2615 | To construct the value of method M, one writes |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2616 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2617 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2618 | <pre> |
| 2619 | t.M |
| 2620 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2621 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2622 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2623 | using the variable t (not the type T). |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2624 | <font color=red>TODO: It makes perfect sense to be able to say T.M (in fact, it makes more |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2625 | sense then t.M, since only the type T is needed to find the method M, i.e., |
| 2626 | its address). TBD. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2627 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2628 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2629 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2630 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2631 | The expression t.M is a function value with type |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2632 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2633 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2634 | <pre> |
| 2635 | func (t *T, a int) int |
| 2636 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2637 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2638 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2639 | and may be invoked only as a function, not as a method: |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2640 | </p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2641 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2642 | <pre> |
| 2643 | var f func (t *T, a int) int; |
| 2644 | f = t.M; |
| 2645 | x := f(t, 7); |
| 2646 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2647 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2648 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2649 | Note that one does not write t.f(7); taking the value of a method demotes |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2650 | it to a function. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2651 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2652 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2653 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2654 | In general, given type T with method M and variable t of type T, |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2655 | the method invocation |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2656 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2657 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2658 | <pre> |
| 2659 | t.M(args) |
| 2660 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2661 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2662 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2663 | is equivalent to the function call |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2664 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2665 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2666 | <pre> |
| 2667 | (t.M)(t, args) |
| 2668 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2669 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2670 | <p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2671 | <font color=red> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2672 | TODO: should probably describe the effect of (t.m) under §Expressions if t.m |
| 2673 | denotes a method: Effect is as described above, converts into function. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2674 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2675 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2676 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2677 | If T is an interface type, the expression t.M does not determine which |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2678 | underlying type's M is called until the point of the call itself. Thus given |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 2679 | T1 and T2, both implementing interface I with method M, the sequence |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2680 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2681 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2682 | <pre> |
| 2683 | var t1 *T1; |
| 2684 | var t2 *T2; |
| 2685 | var i I = t1; |
| 2686 | m := i.M; |
| 2687 | m(t2, 7); |
| 2688 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2689 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2690 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2691 | will invoke t2.M() even though m was constructed with an expression involving |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2692 | t1. Effectively, the value of m is a function literal |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2693 | </p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2694 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2695 | <pre> |
| 2696 | func (recv I, a int) { |
| 2697 | recv.M(a); |
| 2698 | } |
| 2699 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2700 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2701 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2702 | that is automatically created. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2703 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2704 | <p> |
| 2705 | <font color=red> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2706 | TODO: Document implementation restriction: It is illegal to take the address |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2707 | of a result parameter (e.g.: func f() (x int, p *int) { return 2, &x }). |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2708 | (TBD: is it an implementation restriction or fact?) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2709 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2710 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2711 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2712 | <h3>Communication operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2713 | |
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 | The term <i>channel</i> means "variable of channel type" (§Channel types). |
| 2716 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2717 | <p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2718 | The send operation uses the binary operator "<-", which operates on |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2719 | a channel and a value (expression): |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2720 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2721 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2722 | <pre> |
| 2723 | ch <- 3 |
| 2724 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2725 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2726 | <p> |
| 2727 | The send operation sends the value on the channel. Both the channel |
| 2728 | and the expression are evaluated before communication begins. |
| 2729 | Communication blocks until the send can proceed, at which point the |
| 2730 | value is transmitted on the channel. A send can proceed if the |
| 2731 | channel is asynchronous and there is room in its buffer or the |
| 2732 | channel is synchronous and a receiver is ready. |
| 2733 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2734 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2735 | If the send operation appears in an expression context, the value |
| 2736 | of the expression is a boolean and the operation is non-blocking. |
| 2737 | The value of the boolean reports true if the communication succeeded, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2738 | false if it did not. (The channel and |
| 2739 | the expression to be sent are evaluated regardless.) |
| 2740 | These two examples are equivalent: |
| 2741 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2742 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2743 | <pre> |
| 2744 | ok := ch <- 3; |
| 2745 | if ok { print("sent") } else { print("not sent") } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2746 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2747 | if ch <- 3 { print("sent") } else { print("not sent") } |
| 2748 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2749 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2750 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2751 | In other words, if the program tests the value of a send operation, |
| 2752 | the send is non-blocking and the value of the expression is the |
| 2753 | success of the operation. If the program does not test the value, |
| 2754 | the operation blocks until it succeeds. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2755 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2756 | <p> |
| 2757 | The receive operation uses the prefix unary operator "<-". |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2758 | The value of the expression is the value received, whose type |
| 2759 | is the element type of the channel. |
| 2760 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2761 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2762 | <pre> |
| 2763 | <-ch |
| 2764 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2765 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2766 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2767 | The expression blocks until a value is available, which then can |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2768 | be assigned to a variable or used like any other expression. |
| 2769 | If the receive expression does not save the value, the value is |
| 2770 | discarded. |
| 2771 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2772 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2773 | <pre> |
| 2774 | v1 := <-ch |
| 2775 | v2 = <-ch |
| 2776 | f(<-ch) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2777 | <-strobe // wait until clock pulse |
| 2778 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2779 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2780 | <p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 2781 | If a receive expression is used in a tuple assignment of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2782 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2783 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2784 | <pre> |
| 2785 | x, ok = <-ch; // or: x, ok := <-ch |
| 2786 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2787 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2788 | <p> |
| 2789 | the receive operation becomes non-blocking. |
| 2790 | If the operation can proceeed, the boolean variable |
| 2791 | <code>ok</code> will be set to <code>true</code> |
| 2792 | and the value stored in <code>x</code>; otherwise |
| 2793 | <code>ok</code> is set |
| 2794 | to <code>false</code> and <code>x</code> is set to the |
| 2795 | zero value for its type (§The zero value). |
| 2796 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2797 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2798 | <p> |
| 2799 | <font color=red>TODO: Probably in a separate section, communication semantices |
| 2800 | need to be presented regarding send, receive, select, and goroutines.</font> |
| 2801 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2802 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2803 | <h3>Constant expressions</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2804 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2805 | <p> |
| 2806 | Constant expressions may contain only constants, <code>iota</code>, |
| 2807 | numeric literals, string literals, and |
| 2808 | some constant-valued built-in functions such as <code>unsafe.Sizeof</code> |
| 2809 | and <code>len</code> applied to an array. |
| 2810 | In practice, constant expressions are those that can be evaluated at compile time. |
| 2811 | <p> |
| 2812 | The type of a constant expression is determined by the type of its |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2813 | elements. If it contains only numeric literals, its type is <i>ideal |
Rob Pike | ce9417e | 2009-03-12 17:08:47 -0700 | [diff] [blame] | 2814 | integer</i> or <i>ideal float</i> (§Ideal number). Whether a literal |
| 2815 | is an integer or float depends on the syntax of the literals (123 vs. 123.0). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2816 | The nature of the arithmetic |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2817 | operations within the expression depends, elementwise, on the values; |
| 2818 | for example, 3/2 is an integer division yielding 1, while 3./2. is |
| 2819 | a floating point division yielding 1.5. Thus |
| 2820 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2821 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2822 | <pre> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2823 | const x = 3./2. + 3/2; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2824 | </pre> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2825 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2826 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2827 | yields a floating point constant of ideal float value 2.5 (1.5 + |
| 2828 | 1); its constituent expressions are evaluated using distinct rules |
| 2829 | for division. |
| 2830 | </p> |
| 2831 | |
| 2832 | <p> |
| 2833 | Intermediate values and the constants themselves |
| 2834 | may require precision significantly larger than any concrete type |
| 2835 | in the language. The following are legal declarations: |
| 2836 | </p> |
| 2837 | |
| 2838 | <pre> |
| 2839 | const Huge = 1 << 100; |
| 2840 | const Four int8 = Huge >> 98; |
| 2841 | </pre> |
| 2842 | |
| 2843 | <p> |
| 2844 | A constant expression may appear in any context, such as assignment |
| 2845 | to a variable of any numeric type, as long as the value of the |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2846 | expression can be represented accurately in that context. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2847 | It is erroneous to assign a value with a non-zero fractional part |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2848 | to an integer, or if the assignment would overflow or underflow, |
| 2849 | or in general if the value cannot be represented by the type of |
| 2850 | the variable. |
| 2851 | For |
| 2852 | instance, <code>3</code> can be assigned to any integer variable but also to any |
| 2853 | floating point variable, while <code>-1e12</code> can be assigned to a |
| 2854 | <code>float32</code>, <code>float64</code>, or even <code>int64</code> |
| 2855 | but not <code>uint64</code> or <code>string</code>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2856 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2857 | |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 2858 | <p> |
| 2859 | If a typed constant expression evaluates to a value that is not |
| 2860 | representable by that type, the compiler reports an error. |
| 2861 | </p> |
| 2862 | |
| 2863 | <pre> |
| 2864 | uint8(-1) // error, out of range |
| 2865 | uint8(100) * 100 // error, out of range |
| 2866 | </pre> |
| 2867 | |
| 2868 | <p> |
| 2869 | The size of the mask used by the unary bitwise complement |
| 2870 | operator in a typed constant expression is equal to the size of the |
| 2871 | expression's type. In an ideal constant expression, the bitwise |
| 2872 | complement operator inverts all the bits, producing a negative value. |
| 2873 | </p> |
| 2874 | |
| 2875 | <pre> |
| 2876 | ^1 // ideal constant, equal to -2 |
| 2877 | uint8(^1) // error, same as uint8(-2), out of range |
| 2878 | ^uint8(1) // typed uint8 constant, same as 0xFF ^ uint8(1) = uint8(0xFE) |
| 2879 | int8(^1) // same as int8(-2) |
| 2880 | ^int8(1) // error, same as 0xFF ^ int8(1) = int8(0xFE), out of range |
| 2881 | </pre> |
| 2882 | |
| 2883 | <p> |
| 2884 | TODO: perhaps ^ should be disallowed on non-uints instead of assuming twos complement. |
| 2885 | Also it may be possible to make typed constants more like variables, at the cost of fewer |
| 2886 | overflow etc. errors being caught. |
| 2887 | </p> |
| 2888 | |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2889 | <h3>Order of evaluation</h3> |
| 2890 | |
| 2891 | <p> |
| 2892 | When evaluating the elements of an assignment or expression, |
| 2893 | all function calls, method calls and |
| 2894 | communication operations are evaluated in lexical left-to-right |
| 2895 | order. Otherwise, the order of evaluation is unspecified. |
| 2896 | </p> |
| 2897 | |
| 2898 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2899 | For example, in the assignment |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2900 | </p> |
| 2901 | <pre> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2902 | y[f()], ok = g(h(), i() + x[j()], <-c), k() |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2903 | </pre> |
| 2904 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2905 | the function calls and communication happen in the order |
| 2906 | <code>f()</code>, <code>h()</code>, <code>i()</code>, <code>j()</code>, |
| 2907 | <code><-c</code>, <code>g()</code>, and <code>k()</code>. |
| 2908 | However, the order of those events compared to the evaluation |
| 2909 | and indexing of <code>x</code> and the evaluation |
| 2910 | of <code>y</code> is not specified. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2911 | </p> |
| 2912 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2913 | <hr/> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2914 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2915 | <h2>Statements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2916 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2917 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2918 | Statements control execution. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2919 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2920 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2921 | <pre class="grammar"> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 2922 | Statement = |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2923 | Declaration | EmptyStmt | LabeledStmt | |
| 2924 | SimpleStmt | GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt | |
| 2925 | FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt | |
| 2926 | DeferStmt . |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2927 | |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2928 | SimpleStmt = ExpressionStmt | IncDecStmt | Assignment | SimpleVarDecl . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2929 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2930 | StatementList = Statement { Separator Statement } . |
| 2931 | Separator = [ ";" ] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2932 | </pre> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 2933 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2934 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2935 | Elements of a list of statements are separated by semicolons, |
| 2936 | which may be omitted only if the previous statement: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2937 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2938 | <ul> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2939 | <li>ends with the closing parenthesis ")" of a list of declarations |
| 2940 | (§Declarations and Scope); or</li> |
Rob Pike | 736a1ae | 2009-04-02 23:03:41 -0700 | [diff] [blame] | 2941 | <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] | 2942 | </ul> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 2943 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2944 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2945 | <h3>Empty statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 2946 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2947 | <p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 2948 | The empty statement does nothing. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2949 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 2950 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2951 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2952 | EmptyStmt = . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2953 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 2954 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2955 | <p> |
| 2956 | A statement list can always in effect be terminated with a semicolon by |
| 2957 | adding an empty statement. |
| 2958 | </p> |
| 2959 | |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 2960 | |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 2961 | <h3>Labeled statements</h3> |
| 2962 | |
| 2963 | <p> |
| 2964 | A labeled statement may be the target of a <code>goto</code>, |
| 2965 | <code>break</code> or <code>continue</code> statement. |
| 2966 | </p> |
| 2967 | |
| 2968 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2969 | LabeledStmt = Label ":" Statement . |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 2970 | Label = identifier . |
| 2971 | </pre> |
| 2972 | |
| 2973 | <pre> |
| 2974 | Error: log.Fatal("error encountered") |
| 2975 | </pre> |
| 2976 | |
| 2977 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2978 | <h3>Expression statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2979 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2980 | <p> |
| 2981 | Function calls, method calls, and channel operations |
| 2982 | can appear in statement context. |
| 2983 | </p> |
| 2984 | |
| 2985 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2986 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2987 | ExpressionStmt = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2988 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2989 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2990 | <pre> |
| 2991 | f(x+y) |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2992 | <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2993 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2994 | |
| 2995 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2996 | <h3>IncDec statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2997 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2998 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 2999 | The "++" and "--" statements increment or decrement their operands |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3000 | by the ideal numeric value 1. As with an assignment, the operand |
| 3001 | must be a variable, pointer indirection, field selector or index expression. |
| 3002 | </p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3003 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3004 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3005 | IncDecStmt = Expression ( "++" | "--" ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3006 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3007 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3008 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3009 | The following assignment statements (§Assignments) are semantically |
| 3010 | equivalent: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3011 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3012 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3013 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3014 | IncDec statement Assignment |
| 3015 | x++ x += 1 |
| 3016 | x-- x -= 1 |
| 3017 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3018 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3019 | <h3>Assignments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3020 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3021 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3022 | Assignment = ExpressionList assign_op ExpressionList . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3023 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3024 | assign_op = [ add_op | mul_op ] "=" . |
| 3025 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3026 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3027 | <p> |
| 3028 | Each left-hand side operand must be a variable, pointer indirection, |
| 3029 | field selector, or index expression. |
| 3030 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3031 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3032 | <pre> |
| 3033 | x = 1 |
| 3034 | *p = f() |
| 3035 | a[i] = 23 |
| 3036 | k = <-ch |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 3037 | i &^= 1<<n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3038 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3039 | |
| 3040 | <p> |
| 3041 | An <i>assignment operation</i> <code>x</code> <i>op</i><code>=</code> |
| 3042 | <code>y</code> where <i>op</i> is a binary arithmetic operation is equivalent |
| 3043 | to <code>x</code> <code>=</code> <code>x</code> <i>op</i> |
| 3044 | <code>y</code> but evalutates <code>x</code> |
| 3045 | only once. The <i>op</i><code>=</code> construct is a single token. |
| 3046 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3047 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3048 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3049 | a[i] <<= 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3050 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3051 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3052 | <p> |
| 3053 | A tuple assignment assigns the individual elements of a multi-valued |
| 3054 | operation to a list of variables. There are two forms. In the |
| 3055 | first, the right hand operand is a single multi-valued expression |
| 3056 | such as a function evaluation or channel or map operation (§Channel |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3057 | operations, §Map operations) or a type assertion (§Type assertions). |
| 3058 | The number of operands on the left |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3059 | hand side must match the number of values. For instance, If |
| 3060 | <code>f</code> is a function returning two values, |
| 3061 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3062 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3063 | <pre> |
| 3064 | x, y = f() |
| 3065 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3066 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3067 | <p> |
| 3068 | assigns the first value to <code>x</code> and the second to <code>y</code>. |
| 3069 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3070 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3071 | <p> |
| 3072 | In the second form, the number of operands on the left must equal the number |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3073 | of expressions on the right, each of which must be single-valued. |
| 3074 | The expressions on the right are evaluated before assigning to |
| 3075 | any of the operands on the left, but otherwise the evaluation |
| 3076 | order is unspecified. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3077 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3078 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3079 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3080 | a, b = b, a // exchange a and b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3081 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3082 | |
| 3083 | <p> |
| 3084 | In assignments, the type of each value must be assignment compatible |
| 3085 | (§Assignment compatibility) with the type of the |
| 3086 | operand to which it is assigned. |
| 3087 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3088 | |
| 3089 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3090 | <h3>If statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3091 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3092 | <p> |
| 3093 | "If" statements specify the conditional execution of two branches |
| 3094 | according to the value of a boolean expression. If the expression |
| 3095 | evaluates to true, the "if" branch is executed, otherwise, if |
| 3096 | present, the "else" branch is executed. A missing condition |
| 3097 | is equivalent to <code>true</code>. |
| 3098 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3099 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3100 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3101 | IfStmt = "if" [ [ SimpleStmt ] ";" ] [ Expression ] Block [ "else" Statement ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3102 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3103 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3104 | <pre> |
| 3105 | if x > 0 { |
| 3106 | return true; |
| 3107 | } |
| 3108 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3109 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3110 | <p> |
| 3111 | An "if" statement may include a simple statement before the expression. |
| 3112 | The scope of any variables declared by that statement |
| 3113 | extends to the end of the "if" statement |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3114 | and the variables are initialized once before the statement is entered. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3115 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3116 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3117 | <pre> |
| 3118 | if x := f(); x < y { |
| 3119 | return x; |
| 3120 | } else if x > z { |
| 3121 | return z; |
| 3122 | } else { |
| 3123 | return y; |
| 3124 | } |
| 3125 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3126 | |
| 3127 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3128 | <h3>Switch statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3129 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3130 | <p> |
| 3131 | "Switch" statements provide multi-way execution. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3132 | An expression or type specifier is compared to the "cases" |
| 3133 | inside the "switch" to determine which branch |
| 3134 | to execute. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3135 | </p> |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3136 | |
| 3137 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3138 | SwitchStmt = ExprSwitchStmt | TypeSwitchStmt . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3139 | </pre> |
| 3140 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3141 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3142 | There are two forms: expression switches and type switches. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3143 | In an expression switch, the cases contain expressions that are compared |
| 3144 | against the value of the switch expression. |
| 3145 | In a type switch, the cases contain types that are compared against the |
| 3146 | type of a specially annotated switch expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3147 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3148 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3149 | <h4>Expression switches</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3150 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3151 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3152 | In an expression switch, |
| 3153 | the switch expression is evaluated and |
| 3154 | the case expressions, which need not be constants, |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3155 | 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] | 3156 | switch expression |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3157 | triggers execution of the statements of the associated case; |
| 3158 | the other cases are skipped. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3159 | If no case matches and there is a "default" case, |
| 3160 | its statements are executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3161 | There can be at most one default case and it may appear anywhere in the |
| 3162 | "switch" statement. |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3163 | A missing expression is equivalent to |
| 3164 | the expression <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3165 | </p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3166 | |
| 3167 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3168 | ExprSwitchStmt = "switch" [ [ SimpleStmt ] ";" ] [ Expression ] "{" { ExprCaseClause } "}" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3169 | ExprCaseClause = ExprSwitchCase ":" [ StatementList ] . |
| 3170 | ExprSwitchCase = "case" ExpressionList | "default" . |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3171 | </pre> |
| 3172 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3173 | <p> |
| 3174 | In a case or default clause, |
| 3175 | the last statement only may be a "fallthrough" statement |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3176 | (§Fallthrough statement) to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3177 | indicate that control should flow from the end of this clause to |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3178 | the first statement of the next clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3179 | Otherwise control flows to the end of the "switch" statement. |
| 3180 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3181 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3182 | Each case clause acts as a block for scoping purposes |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3183 | (§Declarations and scope rules). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3184 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3185 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3186 | A "switch" statement may include a simple statement before the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3187 | expression. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3188 | The scope of any variables declared by that statement |
| 3189 | extends to the end of the "switch" statement |
| 3190 | and the variables are initialized once before the statement is entered. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3191 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3192 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3193 | <pre> |
| 3194 | switch tag { |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3195 | default: s3() |
| 3196 | case 0, 1, 2, 3: s1() |
| 3197 | case 4, 5, 6, 7: s2() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3198 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3199 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3200 | switch x := f(); { |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3201 | case x < 0: return -x |
| 3202 | default: return x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3203 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3204 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3205 | switch { // missing expression means "true" |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3206 | case x < y: f1(); |
| 3207 | case x < z: f2(); |
| 3208 | case x == 4: f3(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3209 | } |
| 3210 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3211 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3212 | <h4>Type switches</h4> |
| 3213 | |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3214 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3215 | A type switch compares types rather than values. It is otherwise similar |
| 3216 | to an expression switch. It is introduced by special |
| 3217 | notation in the form of a simple declaration whose right hand side |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 3218 | has the form of a type assertion (§Type assertions) |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3219 | using the reserved word <code>type</code> rather than an actual type. |
| 3220 | Cases then match literal types against the dynamic type of the expression |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 3221 | in the type assertion. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3222 | </p> |
| 3223 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3224 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3225 | TypeSwitchStmt = "switch" [ [ SimpleStmt ] ";" ] TypeSwitchGuard "{" { TypeCaseClause } "}" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3226 | TypeSwitchGuard = identifier ":=" Expression "." "(" "type" ")" . |
| 3227 | TypeCaseClause = TypeSwitchCase ":" [ StatementList ] . |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3228 | TypeSwitchCase = "case" ( type | "nil" ) | "default" . |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3229 | </pre> |
| 3230 | |
| 3231 | <p> |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3232 | If the interface value equals <code>nil</code>, |
| 3233 | only an explict <code>nil</code> case or "default" |
| 3234 | case will execute. |
| 3235 | </p> |
| 3236 | |
| 3237 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3238 | Given a function <code>f</code> |
| 3239 | that returns a value of interface type, |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3240 | the following type switch: |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3241 | </p> |
| 3242 | |
| 3243 | <pre> |
| 3244 | switch i := f().(type) { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3245 | case nil: |
| 3246 | printString("f() returns nil"); |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3247 | case int: |
| 3248 | printInt(i); // i is an int |
| 3249 | case float: |
| 3250 | printFloat(i); // i is a float |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3251 | case func(int) float: |
| 3252 | printFunction(i); // i is a function |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3253 | default: |
| 3254 | printString("don't know the type"); |
| 3255 | } |
| 3256 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3257 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3258 | <p> |
| 3259 | could be rewritten: |
| 3260 | </p> |
| 3261 | |
| 3262 | <pre> |
| 3263 | v := f(); |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3264 | if v == nil { |
| 3265 | printString("f() returns nil"); |
| 3266 | } else if i, is_int := v.(int); is_int { |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3267 | printInt(i); // i is an int |
| 3268 | } else if i, is_float := v.(float); is_float { |
| 3269 | printFloat(i); // i is a float |
| 3270 | } else if i, is_func := v.(func(int) float); is_func { |
| 3271 | printFunction(i); // i is a function |
| 3272 | } else { |
| 3273 | printString("don't know the type"); |
| 3274 | } |
| 3275 | </pre> |
| 3276 | |
| 3277 | <p> |
| 3278 | In a type switch, the guard is mandatory, |
| 3279 | there can be only one type per "case", and |
| 3280 | the "fallthrough" statement is not allowed. |
| 3281 | </p> |
| 3282 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3283 | <h3>For statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3284 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3285 | <p> |
| 3286 | A "for" statement specifies repeated execution of a block. The iteration is |
| 3287 | controlled by a condition, a "for" clause, or a "range" clause. |
| 3288 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3289 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3290 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3291 | ForStmt = "for" [ Condition | ForClause | RangeClause ] Block . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3292 | Condition = Expression . |
| 3293 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3294 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3295 | <p> |
| 3296 | In its simplest form, a "for" statement specifies the repeated execution of |
| 3297 | a block as long as a boolean condition evaluates to true. |
| 3298 | The condition is evaluated before each iteration. |
| 3299 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3300 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3301 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3302 | <pre> |
| 3303 | for a < b { |
| 3304 | a *= 2 |
| 3305 | } |
| 3306 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3307 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3308 | <p> |
| 3309 | A "for" statement with a "for" clause is also controlled by its condition, but |
| 3310 | additionally it may specify an <i>init</i> |
| 3311 | and a <i>post</i> statement, such as an assignment, |
| 3312 | an increment or decrement statement. The init statement (but not the post |
| 3313 | statement) may also be a short variable declaration; the scope of the variables |
| 3314 | it declares ends at the end of the statement |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3315 | (§Declarations and scope rules). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3316 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3317 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3318 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3319 | ForClause = [ InitStmt ] ";" [ Condition ] ";" [ PostStmt ] . |
| 3320 | InitStmt = SimpleStmt . |
| 3321 | PostStmt = SimpleStmt . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3322 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3323 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3324 | <pre> |
| 3325 | for i := 0; i < 10; i++ { |
| 3326 | f(i) |
| 3327 | } |
| 3328 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3329 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3330 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3331 | If non-empty, the init statement is executed once before evaluating the |
| 3332 | condition for the first iteration; |
| 3333 | the post statement is executed after each execution of the block (and |
| 3334 | only if the block was executed). |
| 3335 | Any element of the "for" clause may be empty but the semicolons are |
| 3336 | required unless there is only a condition. |
| 3337 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3338 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3339 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3340 | <pre> |
| 3341 | for ; cond ; { S() } is the same as for cond { S() } |
| 3342 | for true { S() } is the same as for { S() } |
| 3343 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3344 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3345 | <p> |
| 3346 | A "for" statement with a "range" clause |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3347 | iterates through all entries of an array, slice, string or map, |
| 3348 | or values received on a channel. |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3349 | For each entry it first assigns the current index or key to an iteration |
| 3350 | 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] | 3351 | of iteration variables - and then executes the block. |
| 3352 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3353 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3354 | <pre class="grammar"> |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3355 | RangeClause = ExpressionList ( "=" | ":=" ) "range" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3356 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3357 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3358 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3359 | The type of the right-hand expression in the "range" clause must be an |
| 3360 | array, slice, string or map, or a pointer to an array, slice, string or map; |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3361 | or it may be a channel. |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3362 | Except for channels, |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3363 | the identifier list must contain one or two expressions |
| 3364 | (as in assignments, these must be a |
| 3365 | variable, pointer indirection, field selector, or index expression) |
| 3366 | denoting the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3367 | iteration variables. On each iteration, |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3368 | 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] | 3369 | 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] | 3370 | string or array element or map value. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3371 | The types of the array or slice index (always <code>int</code>) |
| 3372 | and element, or of the map key and value respectively, |
| 3373 | must be assignment compatible to the iteration variables. |
| 3374 | </p> |
| 3375 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3376 | For strings, the "range" clause iterates over the Unicode code points |
| 3377 | in the string. On successive iterations, the index variable will be the |
Rob Pike | 55faa5f | 2009-04-15 21:49:50 -0700 | [diff] [blame] | 3378 | index of successive UTF-8-encoded code points in the string, and |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3379 | the second variable, of type <code>int</code>, will be the value of |
| 3380 | the corresponding code point. If the iteration encounters an invalid |
| 3381 | UTF-8 sequence, the second variable will be <code>0xFFFD</code>, |
| 3382 | the Unicode replacement character, and the next iteration will advance |
| 3383 | a single byte in the string. |
| 3384 | </p> |
| 3385 | <p> |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3386 | For channels, the identifier list must contain one identifier. |
Robert Griesemer | ce9fbdb | 2009-04-29 11:45:08 -0700 | [diff] [blame] | 3387 | 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] | 3388 | it does not process the zero value sent before the channel is closed. |
| 3389 | </p> |
| 3390 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3391 | The iteration variables may be declared by the "range" clause (":="), in which |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3392 | case their scope ends at the end of the "for" statement (§Declarations and |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3393 | scope rules). In this case their types are set to |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3394 | <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] | 3395 | If the iteration variables are declared outside the "for" statement, |
| 3396 | after execution their values will be those of the last iteration. |
| 3397 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3398 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3399 | <pre> |
| 3400 | var a [10]string; |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 3401 | 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] | 3402 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3403 | for i, s := range a { |
| 3404 | // type of i is int |
| 3405 | // type of s is string |
| 3406 | // s == a[i] |
| 3407 | g(i, s) |
| 3408 | } |
| 3409 | |
| 3410 | var key string; |
| 3411 | var val interface {}; // value type of m is assignment-compatible to val |
| 3412 | for key, value = range m { |
| 3413 | h(key, value) |
| 3414 | } |
| 3415 | // key == last map key encountered in iteration |
| 3416 | // val == map[key] |
| 3417 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3418 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3419 | <p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3420 | If map entries that have not yet been processed are deleted during iteration, |
| 3421 | 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] | 3422 | 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] | 3423 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3424 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3425 | <h3>Go statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3426 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3427 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3428 | A "go" statement starts the execution of a function or method call |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3429 | as an independent concurrent thread of control, or <i>goroutine</i>, |
| 3430 | within the same address space. |
| 3431 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3432 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3433 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3434 | GoStmt = "go" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3435 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3436 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3437 | <p> |
| 3438 | The expression must be a call, and |
| 3439 | unlike with a regular call, program execution does not wait |
Robert Griesemer | b9f8b9c | 2008-09-26 13:38:38 -0700 | [diff] [blame] | 3440 | for the invoked function to complete. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3441 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3442 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3443 | <pre> |
| 3444 | go Server() |
| 3445 | go func(ch chan <- bool) { for { sleep(10); ch <- true; }} (c) |
| 3446 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3447 | |
| 3448 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3449 | <h3>Select statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3450 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3451 | <p> |
| 3452 | A "select" statement chooses which of a set of possible communications |
| 3453 | will proceed. It looks similar to a "switch" statement but with the |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3454 | cases all referring to communication operations. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3455 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3456 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3457 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3458 | SelectStmt = "select" "{" { CommClause } "}" . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3459 | CommClause = CommCase ":" StatementList . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3460 | CommCase = "case" ( SendExpr | RecvExpr) | "default" . |
| 3461 | SendExpr = Expression "<-" Expression . |
| 3462 | RecvExpr = [ Expression ( "=" | ":=" ) ] "<-" Expression . |
| 3463 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3464 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3465 | <p> |
Robert Griesemer | 347cf67 | 2008-10-03 14:04:28 -0700 | [diff] [blame] | 3466 | Each communication clause acts as a block for the purpose of scoping |
| 3467 | (§Declarations and scope rules). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3468 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3469 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3470 | For all the send and receive expressions in the "select" |
| 3471 | statement, the channel expression is evaluated. Any expressions |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3472 | that appear on the right hand side of send expressions are also |
| 3473 | evaluated. If any of the resulting channels can proceed, one is |
| 3474 | chosen and the corresponding communication and statements are |
| 3475 | evaluated. Otherwise, if there is a default case, that executes; |
Rob Pike | cd368a2 | 2008-10-02 10:37:12 -0700 | [diff] [blame] | 3476 | if not, the statement blocks until one of the communications can |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3477 | complete. The channels and send expressions are not re-evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3478 | A channel pointer may be <code>nil</code>, |
| 3479 | which is equivalent to that case not |
| 3480 | being present in the select statement |
| 3481 | except, if a send, its expression is still evaluated. |
| 3482 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3483 | <p> |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3484 | Since all the channels and send expressions are evaluated, any side |
| 3485 | effects in that evaluation will occur for all the communications |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3486 | in the "select" statement. |
| 3487 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3488 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3489 | 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] | 3490 | which single communication will execute. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3491 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3492 | The receive case may declare a new variable using a short variable declaration |
| 3493 | (§Short variable declarations). |
| 3494 | The scope of such variables continues to the end of the |
| 3495 | respective case's statements. |
| 3496 | </p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 3497 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3498 | <pre> |
| 3499 | var c, c1, c2 chan int; |
| 3500 | var i1, i2 int; |
| 3501 | select { |
| 3502 | case i1 = <-c1: |
| 3503 | print("received ", i1, " from c1\n"); |
| 3504 | case c2 <- i2: |
| 3505 | print("sent ", i2, " to c2\n"); |
| 3506 | default: |
| 3507 | print("no communication\n"); |
| 3508 | } |
| 3509 | |
| 3510 | for { // send random sequence of bits to c |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3511 | select { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3512 | case c <- 0: // note: no statement, no fallthrough, no folding of cases |
| 3513 | case c <- 1: |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3514 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3515 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3516 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3517 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3518 | <font color=red> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 3519 | TODO: Make semantics more precise. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3520 | </font> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3521 | |
| 3522 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3523 | <h3>Return statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3524 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3525 | <p> |
| 3526 | A "return" statement terminates execution of the containing function |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3527 | and optionally provides a result value or values to the caller. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3528 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3529 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3530 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3531 | ReturnStmt = "return" [ ExpressionList ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3532 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3533 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3534 | <pre> |
| 3535 | func procedure() { |
| 3536 | return |
| 3537 | } |
| 3538 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3539 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3540 | <p> |
| 3541 | There are two ways to return values from a function with a result |
| 3542 | type. The first is to explicitly list the return value or values |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3543 | in the "return" statement. |
| 3544 | Normally, the expressions |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3545 | must be single-valued and assignment-compatible to the elements of |
| 3546 | the result type of the function. |
| 3547 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3548 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3549 | <pre> |
| 3550 | func simple_f() int { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3551 | return 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3552 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3553 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3554 | func complex_f1() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3555 | return -7.0, -4.0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3556 | } |
| 3557 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3558 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3559 | <p> |
| 3560 | However, if the expression list in the "return" statement is a single call |
| 3561 | to a multi-valued function, the values returned from the called function |
| 3562 | will be returned from this one. The result types of the current function |
| 3563 | and the called function must match. |
| 3564 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3565 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3566 | <pre> |
| 3567 | func complex_f2() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3568 | return complex_f1() |
| 3569 | } |
| 3570 | </pre> |
| 3571 | |
| 3572 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3573 | The second way to return values is to use the elements of the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3574 | result list of the function as variables. When the function begins |
| 3575 | execution, these variables are initialized to the zero values for |
| 3576 | their type (§The zero value). The function can assign them as |
| 3577 | necessary; if the "return" provides no values, those of the variables |
| 3578 | will be returned to the caller. |
| 3579 | </p> |
| 3580 | |
| 3581 | <pre> |
| 3582 | func complex_f3() (re float, im float) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3583 | re = 7.0; |
| 3584 | im = 4.0; |
| 3585 | return; |
| 3586 | } |
| 3587 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3588 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3589 | <p> |
| 3590 | TODO: Define when return is required. |
| 3591 | </p> |
| 3592 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3593 | <h3>Break statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3594 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3595 | <p> |
| 3596 | A "break" statement terminates execution of the innermost |
| 3597 | "for", "switch" or "select" statement. |
| 3598 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3599 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3600 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3601 | BreakStmt = "break" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3602 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3603 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3604 | <p> |
| 3605 | If there is a label, it must be that of an enclosing |
| 3606 | "for", "switch" or "select" statement, and that is the one whose execution |
| 3607 | terminates |
| 3608 | (§For statements, §Switch statements, §Select statements). |
| 3609 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3610 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3611 | <pre> |
| 3612 | L: for i < n { |
| 3613 | switch i { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3614 | case 5: break L |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3615 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3616 | } |
| 3617 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3618 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3619 | <h3>Continue statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3620 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3621 | <p> |
| 3622 | A "continue" statement begins the next iteration of the |
| 3623 | innermost "for" loop at the post statement (§For statements). |
| 3624 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3625 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3626 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3627 | ContinueStmt = "continue" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3628 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3629 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3630 | <p> |
| 3631 | The optional label is analogous to that of a "break" statement. |
| 3632 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3633 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3634 | <h3>Goto statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3635 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3636 | <p> |
| 3637 | A "goto" statement transfers control to the statement with the corresponding label. |
| 3638 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3639 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3640 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3641 | GotoStmt = "goto" Label . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3642 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3643 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3644 | <pre> |
| 3645 | goto Error |
| 3646 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3647 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3648 | <p> |
| 3649 | Executing the "goto" statement must not cause any variables to come into |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3650 | scope that were not already in scope at the point of the goto. For |
| 3651 | instance, this example: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3652 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3653 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3654 | <pre> |
| 3655 | goto L; // BAD |
| 3656 | v := 3; |
| 3657 | L: |
| 3658 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3659 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3660 | <p> |
| 3661 | is erroneous because the jump to label <code>L</code> skips |
| 3662 | the creation of <code>v</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3663 | (TODO: Eliminate in favor of used and not set errors?) |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3664 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3665 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3666 | <h3>Fallthrough statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3667 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3668 | <p> |
| 3669 | A "fallthrough" statement transfers control to the first statement of the |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3670 | next case clause in a expression "switch" statement (§Expression switches). It may |
| 3671 | be used only as the final non-empty statement in a case or default clause in an |
| 3672 | expression "switch" statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3673 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3674 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3675 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3676 | FallthroughStmt = "fallthrough" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3677 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3678 | |
| 3679 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3680 | <h3>Defer statements</h3> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3681 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3682 | <p> |
| 3683 | A "defer" statement invokes a function whose execution is deferred to the moment |
| 3684 | the surrounding function returns. |
| 3685 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3686 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3687 | <pre class="grammar"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3688 | DeferStmt = "defer" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3689 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3690 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3691 | <p> |
| 3692 | The expression must be a function or method call. |
| 3693 | Each time the "defer" statement |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 3694 | executes, the parameters to the function call are evaluated and saved anew but the |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3695 | function is not invoked. Immediately before the innermost function surrounding |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3696 | the "defer" statement returns, but after its return value (if any) is evaluated, |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3697 | each deferred function is executed with its saved parameters. Deferred functions |
| 3698 | are executed in LIFO order. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3699 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3700 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3701 | <pre> |
| 3702 | lock(l); |
| 3703 | defer unlock(l); // unlocking happens before surrounding function returns |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3704 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3705 | // prints 3 2 1 0 before surrounding function returns |
| 3706 | for i := 0; i <= 3; i++ { |
| 3707 | defer fmt.Print(i); |
| 3708 | } |
| 3709 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3710 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3711 | <hr/> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3712 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3713 | <h2>Predeclared functions</h2> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3714 | <ul> |
| 3715 | <li>cap |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3716 | <li>close |
| 3717 | <li>closed |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3718 | <li>len |
| 3719 | <li>make |
| 3720 | <li>new |
| 3721 | <li>panic |
| 3722 | <li>panicln |
| 3723 | <li>print |
| 3724 | <li>println |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3725 | </ul> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3726 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3727 | <h3>Length and capacity</h3> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3728 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3729 | <pre class="grammar"> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3730 | Call Argument type Result |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3731 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3732 | len(s) string, *string string length (in bytes) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3733 | [n]T, *[n]T array length (== n) |
| 3734 | []T, *[]T slice length |
| 3735 | map[K]T, *map[K]T map length |
| 3736 | chan T number of elements in channel buffer |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3737 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3738 | cap(s) []T, *[]T capacity of s |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3739 | map[K]T, *map[K]T capacity of s |
| 3740 | chan T channel buffer capacity |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3741 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3742 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3743 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3744 | The type of the result is always <code>int</code> and the |
| 3745 | implementation guarantees that |
| 3746 | the result always fits into an <code>int</code>. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3747 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3748 | The capacity of a slice or map is the number of elements for which there is |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3749 | space allocated in the underlying array (for a slice) or map. For a slice |
| 3750 | <code>s</code>, at any time the following relationship holds: |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3751 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3752 | <pre> |
| 3753 | 0 <= len(s) <= cap(s) |
| 3754 | </pre> |
Robert Griesemer | 667ef6c | 2008-09-10 13:00:32 -0700 | [diff] [blame] | 3755 | |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3756 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3757 | <h3>Conversions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3758 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3759 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3760 | Conversions look like function calls of the form |
| 3761 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3762 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3763 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3764 | T(value) |
| 3765 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3766 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3767 | <p> |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3768 | where <code>T</code> is a type |
| 3769 | and <code>value</code> is an expression |
| 3770 | that can be converted to a value |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3771 | of result type <code>T</code>. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3772 | <p> |
Robert Griesemer | 133c68e | 2008-09-26 14:04:21 -0700 | [diff] [blame] | 3773 | The following conversion rules apply: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3774 | </p> |
| 3775 | <ul> |
| 3776 | <li> |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 3777 | 1) Between equal types (§Type equality and identity). |
| 3778 | The conversion always succeeds. |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3779 | </li> |
| 3780 | <li> |
| 3781 | 2) Between integer types. If the value is a signed quantity, it is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3782 | sign extended to implicit infinite precision; otherwise it is zero |
| 3783 | extended. It is then truncated to fit in the result type size. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3784 | For example, <code>uint32(int8(0xFF))</code> is <code>0xFFFFFFFF</code>. |
| 3785 | The conversion always yields a valid value; there is no signal for overflow. |
| 3786 | </li> |
| 3787 | <li> |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3788 | 3) Between integer and floating point types, or between floating point |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3789 | types. To avoid overdefining the properties of the conversion, for |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3790 | now it is defined as a ``best effort'' conversion. The conversion |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3791 | always succeeds but the value may be a NaN or other problematic |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3792 | result. <font color=red>TODO: clarify?</font> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3793 | </li> |
| 3794 | <li> |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 3795 | 4) Strings permit three special conversions: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3796 | </li> |
| 3797 | <li> |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3798 | 4a) Converting an integer value yields a string containing the UTF-8 |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3799 | representation of the integer. |
| 3800 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3801 | <pre> |
| 3802 | string(0x65e5) // "\u65e5" |
| 3803 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3804 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3805 | </li> |
| 3806 | <li> |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 3807 | 4b) Converting a slice of integers yields a string that is the |
| 3808 | concatenation of the individual integers converted to strings. |
| 3809 | If the slice value is <code>nil</code>, the result is the empty string. |
| 3810 | <pre> |
| 3811 | string([]int{0x65e5, 0x672c, 0x8a9e}) // "\u65e5\u672c\u8a9e" |
| 3812 | </pre> |
| 3813 | </li> |
| 3814 | <li> |
| 3815 | 4c) Converting a slice of bytes yields a string whose successive |
| 3816 | bytes are those of the slice. If the slice value is <code>nil</code>, |
| 3817 | the result is the empty string. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3818 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3819 | <pre> |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 3820 | string([]byte{'h', 'e', 'l', 'l', 'o'}) // "hello" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3821 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3822 | </li> |
| 3823 | </ul> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3824 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3825 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3826 | There is no linguistic mechanism to convert between pointers and integers. |
| 3827 | The <code>unsafe</code> package |
| 3828 | implements this functionality under |
| 3829 | restricted circumstances (§Package <code>unsafe</code>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3830 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3831 | |
| 3832 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3833 | <h3>Allocation</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 | The built-in function <code>new</code> takes a type <code>T</code> and |
| 3837 | returns a value of type <code>*T</code>. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 3838 | The memory is initialized as described in the section on initial values |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 3839 | (§The zero value). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3840 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3841 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3842 | <pre> |
| 3843 | new(T) |
| 3844 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3845 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3846 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3847 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3848 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3849 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3850 | <pre> |
| 3851 | type S struct { a int; b float } |
| 3852 | new(S) |
| 3853 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3854 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3855 | <p> |
| 3856 | dynamically allocates memory for a variable of type <code>S</code>, |
| 3857 | initializes it (<code>a=0</code>, <code>b=0.0</code>), |
| 3858 | and returns a value of type <code>*S</code> containing the address |
| 3859 | of the memory. |
| 3860 | </p> |
| 3861 | |
| 3862 | <h3>Making slices, maps and channels</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3863 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3864 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3865 | Slices, maps and channels are reference types that do not require the |
| 3866 | extra indirection of an allocation with <code>new</code>. |
| 3867 | The built-in function <code>make</code> takes a type <code>T</code>, |
| 3868 | which must be a slice, map or channel type, |
| 3869 | optionally followed by a type-specific list of expressions. |
| 3870 | 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] | 3871 | The memory is initialized as described in the section on initial values |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 3872 | (§The zero value). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3873 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3874 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3875 | <pre> |
| 3876 | make(T [, optional list of expressions]) |
| 3877 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3878 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3879 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3880 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3881 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3882 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3883 | <pre> |
| 3884 | make(map[string] int) |
| 3885 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3886 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3887 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3888 | creates a new map value and initializes it to an empty map. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3889 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3890 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3891 | <p> |
| 3892 | The parameters affect sizes for allocating slices, maps, and |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3893 | buffered channels: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3894 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3895 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3896 | <pre> |
| 3897 | s := make([]int, 10, 100); # slice with len(s) == 10, cap(s) == 100 |
| 3898 | c := make(chan int, 10); # channel with a buffer size of 10 |
| 3899 | m := make(map[string] int, 100); # map with initial space for 100 elements |
| 3900 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3901 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3902 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3903 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3904 | <h2>Packages</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3905 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3906 | <p> |
| 3907 | Go programs are constructed by linking together <i>packages</i>. |
| 3908 | A package is in turn constructed from one or more source files that |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 3909 | together provide access to a set of types, constants, functions, |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3910 | and variables. Those elements may be <i>imported</i> and used in |
| 3911 | another package. |
| 3912 | </p> |
| 3913 | |
| 3914 | <h3>Source file organization</h3> |
| 3915 | |
| 3916 | <p> |
| 3917 | Each source file consists of a package clause defining the package |
| 3918 | to which it belongs, followed by a possibly empty set of import |
| 3919 | declarations that declare packages whose contents it wishes to use, |
| 3920 | followed by a possibly empty set of declarations of functions, |
| 3921 | types, variables, and constants. The source text following the |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3922 | package clause acts as a block for scoping (§Declarations and scope |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3923 | rules). |
| 3924 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3925 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3926 | <pre class="grammar"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3927 | SourceFile = PackageClause { ImportDecl [ ";" ] } { Declaration [ ";" ] } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3928 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3929 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3930 | <h3>Package clause</h3> |
| 3931 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3932 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3933 | A package clause begins each source file and defines the package |
| 3934 | to which the file belongs. |
| 3935 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3936 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3937 | <pre class="grammar"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3938 | PackageClause = "package" PackageName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3939 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3940 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3941 | <pre> |
| 3942 | package math |
| 3943 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3944 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3945 | <p> |
| 3946 | A set of files sharing the same PackageName form the implementation of a package. |
| 3947 | An implementation may require that all source files for a package inhabit the same directory. |
| 3948 | </p> |
| 3949 | |
| 3950 | <h3>Import</h3> |
| 3951 | |
| 3952 | <p> |
| 3953 | A source file gains access to exported identifiers (§Exported |
| 3954 | identifiers) from another package through an import declaration. |
| 3955 | In the general form, an import declaration provides an identifier |
| 3956 | that code in the source file may use to access the imported package's |
| 3957 | contents and a file name referring to the (compiled) implementation of |
| 3958 | the package. The file name may be relative to a repository of |
| 3959 | installed packages. |
| 3960 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3961 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3962 | <pre class="grammar"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3963 | ImportDecl = "import" ( ImportSpec | "(" [ ImportSpecList ] ")" ) . |
| 3964 | ImportSpecList = ImportSpec { ";" ImportSpec } [ ";" ] . |
| 3965 | ImportSpec = [ "." | PackageName ] PackageFileName . |
| 3966 | PackageFileName = StringLit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3967 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3968 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3969 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3970 | After an import, in the usual case an exported name <i>N</i> from the imported |
| 3971 | package <i>P</i> may be accessed by the qualified identifier |
| 3972 | <i>P</i><code>.</code><i>N</i> (§Qualified identifiers). The actual |
| 3973 | name <i>P</i> depends on the form of the import declaration. If |
| 3974 | an explicit package name <code>p1</code> is provided, the qualified |
| 3975 | identifer will have the form <code>p1.</code><i>N</i>. If no name |
| 3976 | is provided in the import declaration, <i>P</i> will be the package |
| 3977 | name declared within the source files of the imported package. |
| 3978 | Finally, if the import declaration uses an explicit period |
| 3979 | (<code>.</code>) for the package name, <i>N</i> will appear |
| 3980 | in the package-level scope of the current file and the qualified name is |
| 3981 | unnecessary and erroneous. In this form, it is an error if the import introduces |
| 3982 | a name conflict. |
| 3983 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3984 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3985 | In this table, assume we have compiled a package named |
| 3986 | <code>math</code>, which exports function <code>Sin</code>, and |
| 3987 | installed the compiled package in file |
| 3988 | <code>"lib/math"</code>. |
| 3989 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3990 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 3991 | <pre class="grammar"> |
| 3992 | Import syntax Local name of Sin |
| 3993 | |
| 3994 | import M "lib/math" M.Sin |
| 3995 | import "lib/math" math.Sin |
| 3996 | import . "lib/math" Sin |
| 3997 | </pre> |
| 3998 | |
| 3999 | <h3>Multi-file packages</h3> |
| 4000 | |
| 4001 | <p> |
| 4002 | If a package is constructed from multiple source files, all names |
| 4003 | at package-level scope, not just exported names, are visible to all the |
| 4004 | files in the package. An import declaration is still necessary to |
| 4005 | declare intention to use the names, |
| 4006 | but the imported names do not need a qualified identifer to be |
| 4007 | accessed. |
| 4008 | </p> |
| 4009 | |
| 4010 | <p> |
| 4011 | The compilation of a multi-file package may require |
| 4012 | that the files be compiled and installed in an order that satisfies |
| 4013 | the resolution of names imported within the package. |
| 4014 | </p> |
| 4015 | |
| 4016 | <p> |
| 4017 | If source file <code>math1.go</code> contains |
| 4018 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4019 | <pre> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4020 | package math |
| 4021 | |
| 4022 | const twoPi = 6.283185307179586 |
| 4023 | |
| 4024 | function Sin(x float) float { return ... } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4025 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4026 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4027 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4028 | and file <code>"math2.go"</code> begins |
| 4029 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4030 | <pre> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4031 | package math |
| 4032 | |
| 4033 | import "lib/math" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4034 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4035 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4036 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4037 | then, provided <code>"math1.go"</code> is compiled first and |
| 4038 | installed in <code>"lib/math"</code>, <code>math2.go</code> |
| 4039 | may refer directly to <code>Sin</code> and <code>twoPi</code> |
| 4040 | without a qualified identifier. |
| 4041 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4042 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4043 | <h3>An example package</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4044 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4045 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4046 | Here is a complete Go package that implements a concurrent prime sieve. |
| 4047 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4048 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4049 | <pre> |
| 4050 | package main |
| 4051 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4052 | import "fmt" |
| 4053 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4054 | // Send the sequence 2, 3, 4, ... to channel 'ch'. |
| 4055 | func generate(ch chan <- int) { |
| 4056 | for i := 2; ; i++ { |
| 4057 | ch <- i // Send 'i' to channel 'ch'. |
| 4058 | } |
| 4059 | } |
| 4060 | |
| 4061 | // Copy the values from channel 'in' to channel 'out', |
| 4062 | // removing those divisible by 'prime'. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4063 | func filter(src chan <- int, dst <-chan int, prime int) { |
| 4064 | for i := range src { // Loop over values received from 'src'. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4065 | if i % prime != 0 { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4066 | dst <- i // Send 'i' to channel 'dst'. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4067 | } |
| 4068 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4069 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4070 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4071 | // The prime sieve: Daisy-chain filter processes together. |
| 4072 | func sieve() { |
| 4073 | ch := make(chan int); // Create a new channel. |
| 4074 | go generate(ch); // Start generate() as a subprocess. |
| 4075 | for { |
| 4076 | prime := <-ch; |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4077 | fmt.Print(prime, "\n"); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4078 | ch1 := make(chan int); |
| 4079 | go filter(ch, ch1, prime); |
| 4080 | ch = ch1 |
| 4081 | } |
| 4082 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4083 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4084 | func main() { |
| 4085 | sieve() |
| 4086 | } |
| 4087 | </pre> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 4088 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4089 | <hr/> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4090 | |
| 4091 | <h2>Program initialization and execution</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4092 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4093 | <h3>The zero value</h3> |
| 4094 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4095 | When memory is allocated to store a value, either through a declaration |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4096 | or <code>new()</code>, and no explicit initialization is provided, the memory is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4097 | given a default initialization. Each element of such a value is |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4098 | set to the zero value for its type: <code>false</code> for booleans, |
| 4099 | <code>0</code> for integers, <code>0.0</code> for floats, <code>""</code> |
| 4100 | for strings, and <code>nil</code> for pointers and interfaces. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4101 | This initialization is done recursively, so for instance each element of an |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4102 | array of structs will have its fields zeroed if no value is specified. |
| 4103 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4104 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4105 | These two simple declarations are equivalent: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4106 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4107 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4108 | <pre> |
| 4109 | var i int; |
| 4110 | var i int = 0; |
| 4111 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4112 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4113 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4114 | After |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4115 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4116 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4117 | <pre> |
| 4118 | type T struct { i int; f float; next *T }; |
| 4119 | t := new(T); |
| 4120 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4121 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4122 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4123 | the following holds: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4124 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4125 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4126 | <pre> |
| 4127 | t.i == 0 |
| 4128 | t.f == 0.0 |
| 4129 | t.next == nil |
| 4130 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4131 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4132 | <p> |
| 4133 | The same would also be true after |
| 4134 | </p> |
| 4135 | |
| 4136 | <pre> |
| 4137 | var t T |
| 4138 | </pre> |
| 4139 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4140 | <h3>Program execution</h3> |
| 4141 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4142 | A package with no imports is initialized by assigning initial values to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4143 | all its package-level variables in declaration order and then calling any |
| 4144 | package-level function with the name and signature of |
| 4145 | </p> |
| 4146 | <pre> |
| 4147 | func init() |
| 4148 | </pre> |
| 4149 | <p> |
| 4150 | defined in its source. Since a package may contain more |
| 4151 | than one source file, there may be more than one |
| 4152 | <code>init()</code> function in a package, but |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4153 | only one per source file. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4154 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4155 | <p> |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4156 | Initialization code may contain "go" statements, but the functions |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 4157 | they invoke do not begin execution until initialization of the entire |
| 4158 | program is complete. Therefore, all initialization code is run in a single |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4159 | goroutine. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4160 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4161 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4162 | An <code>init()</code> function cannot be referred to from anywhere |
| 4163 | in a program. In particular, <code>init()</code> cannot be called explicitly, |
| 4164 | 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] | 4165 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4166 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4167 | If a package has imports, the imported packages are initialized |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4168 | before initializing the package itself. If multiple packages import |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4169 | 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] | 4170 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4171 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4172 | The importing of packages, by construction, guarantees that there can |
| 4173 | be no cyclic dependencies in initialization. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4174 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4175 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4176 | A complete program, possibly created by linking multiple packages, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4177 | must have one package called <code>main</code>, with a function |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4178 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4179 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4180 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4181 | func main() { ... } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4182 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4183 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4184 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4185 | defined. |
| 4186 | 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] | 4187 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4188 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4189 | Program execution begins by initializing the <code>main</code> package and then |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4190 | invoking <code>main.main()</code>. |
| 4191 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4192 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4193 | When <code>main.main()</code> returns, the program exits. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4194 | </p> |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4195 | <p> |
| 4196 | Implementation restriction: The compiler assumes package <code>main</code> |
| 4197 | is created by a single source file and that it is not imported by any other package. |
| 4198 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4199 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4200 | <hr/> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4201 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4202 | <h2>System considerations</h2> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4203 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4204 | <h3>Package <code>unsafe</code></h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4205 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4206 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4207 | The built-in package <code>unsafe</code>, known to the compiler, |
| 4208 | provides facilities for low-level programming including operations |
| 4209 | that violate the type system. A package using <code>unsafe</code> |
| 4210 | must be vetted manually for type safety. The package provides the |
| 4211 | following interface: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4212 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4213 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4214 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4215 | package unsafe |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4216 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4217 | const Maxalign int |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4218 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4219 | type Pointer *any // "any" is shorthand for any Go type; it is not a real type. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4220 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4221 | func Alignof(variable any) int |
| 4222 | func Offsetof(selector any) int |
| 4223 | func Sizeof(variable any) int |
| 4224 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4225 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4226 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4227 | Any pointer or value of type <code>uintptr</code> can be converted into |
| 4228 | a <code>Pointer</code> and vice versa. |
| 4229 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4230 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4231 | The function <code>Sizeof</code> takes an expression denoting a |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 4232 | variable of any (complete) type and returns the size of the variable in bytes. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4233 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4234 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4235 | The function <code>Offsetof</code> takes a selector (§Selectors) denoting a struct |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4236 | field of any type and returns the field offset in bytes relative to the |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4237 | struct's address. For a struct <code>s</code> with field <code>f</code>: |
| 4238 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4239 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4240 | <pre> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4241 | 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] | 4242 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4243 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4244 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4245 | Computer architectures may require memory addresses to be <i>aligned</i>; |
| 4246 | that is, for addresses of a variable to be a multiple of a factor, |
| 4247 | the variable's type's <i>alignment</i>. The function <code>Alignof</code> |
| 4248 | takes an expression denoting a variable of any type and returns the |
| 4249 | alignment of the (type of the) variable in bytes. For a variable |
| 4250 | <code>x</code>: |
| 4251 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4252 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4253 | <pre> |
| 4254 | uintptr(unsafe.Pointer(&x)) % uintptr(unsafe.Alignof(x)) == 0 |
| 4255 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4256 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4257 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4258 | The maximum alignment is given by the constant <code>Maxalign</code>. |
| 4259 | It usually corresponds to the value of <code>Sizeof(x)</code> for |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4260 | a variable <code>x</code> of the largest numeric type (8 for a |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4261 | <code>float64</code>), but may |
| 4262 | be smaller on systems with weaker alignment restrictions. |
| 4263 | </p> |
| 4264 | <p> |
| 4265 | Calls to <code>Alignof</code>, <code>Offsetof</code>, and |
| 4266 | <code>Sizeof</code> are constant expressions of type <code>int</code>. |
| 4267 | </p> |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 4268 | |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4269 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4270 | <h3>Size and alignment guarantees</h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4271 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4272 | For the numeric types (§Numeric types), the following sizes are guaranteed: |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4273 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4274 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4275 | type size in bytes |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4276 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4277 | byte, uint8, int8 1 |
| 4278 | uint16, int16 2 |
| 4279 | uint32, int32, float32 4 |
| 4280 | uint64, int64, float64 8 |
| 4281 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4282 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4283 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4284 | The following minimal alignment properties are guaranteed: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 4285 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4286 | <ol> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4287 | <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] | 4288 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4289 | <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] | 4290 | 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] | 4291 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4292 | <li>For a variable <code>x</code> of struct type: <code>unsafe.Alignof(x)</code> is the largest of |
| 4293 | 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] | 4294 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4295 | <li>For a variable <code>x</code> of array type: <code>unsafe.Alignof(x)</code> is the same as |
| 4296 | <code>unsafe.Alignof(x[0])</code>, but at least 1. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4297 | </ol> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4298 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4299 | <hr/> |
| 4300 | |
| 4301 | <h2><font color=red>Differences between this doc and implementation - TODO</font></h2> |
| 4302 | <p> |
| 4303 | <font color=red> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 4304 | Implementation accepts only ASCII digits for digits; doc says Unicode. |
| 4305 | <br/> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 4306 | Implementation does not honor the restriction on goto statements and targets (no intervening declarations). |
| 4307 | <br/> |
| 4308 | cap() does not work on maps or chans. |
| 4309 | <br/> |
| 4310 | len() does not work on chans. |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame^] | 4311 | <br> |
| 4312 | string([]int{...}) conversion is not yet implemented. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4313 | </font> |
| 4314 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4315 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4316 | </div> |
| 4317 | </body> |
| 4318 | </html> |