Robert Griesemer | e8e4987 | 2010-03-30 17:37:42 -0700 | [diff] [blame] | 1 | <!-- title The Go Programming Language Specification --> |
Robert Griesemer | 38a53c7 | 2011-07-14 15:58:37 -0700 | [diff] [blame] | 2 | <!-- subtitle Version of July 14, 2011 --> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3 | |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 4 | <!-- |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 5 | TODO |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 6 | [ ] need language about function/method calls and parameter passing rules |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 7 | [ ] last paragraph of #Assignments (constant promotion) should be elsewhere |
| 8 | and mention assignment to empty interface. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 9 | [ ] need to say something about "scope" of selectors? |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 10 | [ ] clarify what a field name is in struct declarations |
| 11 | (struct{T} vs struct {T T} vs struct {t T}) |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 12 | [ ] need explicit language about the result type of operations |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 13 | [ ] should probably write something about evaluation order of statements even |
| 14 | though obvious |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 15 | [ ] review language on implicit dereferencing |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 16 | [ ] clarify what it means for two functions to be "the same" when comparing them |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 17 | --> |
| 18 | |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 19 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 20 | <h2 id="Introduction">Introduction</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 21 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 22 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 23 | This is a reference manual for the Go programming language. For |
Rob Pike | 9339e07 | 2009-11-02 15:28:41 -0800 | [diff] [blame] | 24 | more information and other documents, see <a href="http://golang.org/">http://golang.org</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 25 | </p> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 26 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 27 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 28 | Go is a general-purpose language designed with systems programming |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 29 | in mind. It is strongly typed and garbage-collected and has explicit |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 30 | support for concurrent programming. Programs are constructed from |
| 31 | <i>packages</i>, whose properties allow efficient management of |
| 32 | dependencies. The existing implementations use a traditional |
| 33 | compile/link model to generate executable binaries. |
| 34 | </p> |
| 35 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 36 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 37 | The grammar is compact and regular, allowing for easy analysis by |
| 38 | automatic tools such as integrated development environments. |
| 39 | </p> |
Larry Hosken | 698c6c0 | 2009-09-17 08:05:12 -0700 | [diff] [blame] | 40 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 41 | <h2 id="Notation">Notation</h2> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 42 | <p> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 43 | The syntax is specified using Extended Backus-Naur Form (EBNF): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 44 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 45 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 46 | <pre class="grammar"> |
Robert Griesemer | 32b822f | 2011-05-13 12:54:51 -0700 | [diff] [blame] | 47 | Production = production_name "=" [ Expression ] "." . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 48 | Expression = Alternative { "|" Alternative } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 49 | Alternative = Term { Term } . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 50 | Term = production_name | token [ "…" token ] | Group | Option | Repetition . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 51 | Group = "(" Expression ")" . |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 52 | Option = "[" Expression "]" . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 53 | Repetition = "{" Expression "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 54 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 55 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 56 | <p> |
| 57 | Productions are expressions constructed from terms and the following |
| 58 | operators, in increasing precedence: |
| 59 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 60 | <pre class="grammar"> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 61 | | alternation |
| 62 | () grouping |
| 63 | [] option (0 or 1 times) |
| 64 | {} repetition (0 to n times) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 65 | </pre> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 66 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 67 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 68 | Lower-case production names are used to identify lexical tokens. |
| 69 | Non-terminals are in CamelCase. Lexical symbols are enclosed in |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 70 | double quotes <code>""</code> or back quotes <code>``</code>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 71 | </p> |
| 72 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 73 | <p> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 74 | The form <code>a … b</code> represents the set of characters from |
| 75 | <code>a</code> through <code>b</code> as alternatives. The horizontal |
| 76 | ellipis … is also used elsewhere in the spec to informally denote various |
| 77 | enumerations or code snippets that are not further specified. The character … |
| 78 | (as opposed to the three characters <code>...</code>) is not a token of the Go |
| 79 | language. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 80 | </p> |
| 81 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 82 | <h2 id="Source_code_representation">Source code representation</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 83 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 84 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 85 | Source code is Unicode text encoded in |
| 86 | <a href="http://en.wikipedia.org/wiki/UTF-8">UTF-8</a>. The text is not |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 87 | canonicalized, so a single accented code point is distinct from the |
| 88 | same character constructed from combining an accent and a letter; |
| 89 | those are treated as two code points. For simplicity, this document |
| 90 | will use the term <i>character</i> to refer to a Unicode code point. |
| 91 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 92 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 93 | Each code point is distinct; for instance, upper and lower case letters |
| 94 | are different characters. |
| 95 | </p> |
Russ Cox | b7d9ffe | 2010-02-16 16:47:18 -0800 | [diff] [blame] | 96 | <p> |
Robert Griesemer | f42e883 | 2010-02-17 15:50:34 -0800 | [diff] [blame] | 97 | Implementation restriction: For compatibility with other tools, a |
| 98 | compiler may disallow the NUL character (U+0000) in the source text. |
Russ Cox | b7d9ffe | 2010-02-16 16:47:18 -0800 | [diff] [blame] | 99 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 100 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 101 | <h3 id="Characters">Characters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 102 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 103 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 104 | The following terms are used to denote specific Unicode character classes: |
| 105 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 106 | <pre class="ebnf"> |
Robert Griesemer | 0e8032c | 2011-05-05 09:03:00 -0700 | [diff] [blame] | 107 | newline = /* the Unicode code point U+000A */ . |
| 108 | unicode_char = /* an arbitrary Unicode code point except newline */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 109 | unicode_letter = /* a Unicode code point classified as "Letter" */ . |
Robert Griesemer | 838b5ad | 2011-02-03 12:27:41 -0800 | [diff] [blame] | 110 | unicode_digit = /* a Unicode code point classified as "Decimal Digit" */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 111 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 112 | |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 113 | <p> |
Robert Griesemer | 838b5ad | 2011-02-03 12:27:41 -0800 | [diff] [blame] | 114 | In <a href="http://www.unicode.org/versions/Unicode6.0.0/">The Unicode Standard 6.0</a>, |
| 115 | Section 4.5 "General Category" |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 116 | defines a set of character categories. Go treats |
| 117 | those characters in category Lu, Ll, Lt, Lm, or Lo as Unicode letters, |
| 118 | and those in category Nd as Unicode digits. |
| 119 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 120 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 121 | <h3 id="Letters_and_digits">Letters and digits</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 122 | |
| 123 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 124 | The underscore character <code>_</code> (U+005F) is considered a letter. |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 125 | </p> |
| 126 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 127 | letter = unicode_letter | "_" . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 128 | decimal_digit = "0" … "9" . |
| 129 | octal_digit = "0" … "7" . |
| 130 | hex_digit = "0" … "9" | "A" … "F" | "a" … "f" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 131 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 132 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 133 | <h2 id="Lexical_elements">Lexical elements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 134 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 135 | <h3 id="Comments">Comments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 136 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 137 | <p> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 138 | There are two forms of comments: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 139 | </p> |
| 140 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 141 | <ol> |
| 142 | <li> |
| 143 | <i>Line comments</i> start with the character sequence <code>//</code> |
Robert Griesemer | d73d1c5 | 2010-11-04 13:48:32 -0700 | [diff] [blame] | 144 | and stop at the end of the line. A line comment acts like a newline. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 145 | </li> |
| 146 | <li> |
| 147 | <i>General comments</i> start with the character sequence <code>/*</code> |
| 148 | and continue through the character sequence <code>*/</code>. A general |
| 149 | comment that spans multiple lines acts like a newline, otherwise it acts |
| 150 | like a space. |
| 151 | </li> |
| 152 | </ol> |
| 153 | |
| 154 | <p> |
| 155 | Comments do not nest. |
| 156 | </p> |
| 157 | |
| 158 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 159 | <h3 id="Tokens">Tokens</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 160 | |
| 161 | <p> |
| 162 | Tokens form the vocabulary of the Go language. |
Robert Griesemer | eb109a7 | 2009-12-28 14:40:42 -0800 | [diff] [blame] | 163 | There are four classes: <i>identifiers</i>, <i>keywords</i>, <i>operators |
| 164 | and delimiters</i>, and <i>literals</i>. <i>White space</i>, formed from |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 165 | spaces (U+0020), horizontal tabs (U+0009), |
| 166 | carriage returns (U+000D), and newlines (U+000A), |
| 167 | is ignored except as it separates tokens |
Robert Griesemer | 0e66a13 | 2010-09-27 18:59:11 -0700 | [diff] [blame] | 168 | that would otherwise combine into a single token. Also, a newline or end of file |
Robert Griesemer | eb109a7 | 2009-12-28 14:40:42 -0800 | [diff] [blame] | 169 | may trigger the insertion of a <a href="#Semicolons">semicolon</a>. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 170 | While breaking the input into tokens, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 171 | the next token is the longest sequence of characters that form a |
| 172 | valid token. |
| 173 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 174 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 175 | <h3 id="Semicolons">Semicolons</h3> |
| 176 | |
| 177 | <p> |
| 178 | The formal grammar uses semicolons <code>";"</code> as terminators in |
| 179 | a number of productions. Go programs may omit most of these semicolons |
| 180 | using the following two rules: |
| 181 | </p> |
| 182 | |
| 183 | <ol> |
| 184 | <li> |
| 185 | <p> |
| 186 | When the input is broken into tokens, a semicolon is automatically inserted |
| 187 | into the token stream at the end of a non-blank line if the line's final |
| 188 | token is |
| 189 | </p> |
| 190 | <ul> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 191 | <li>an |
| 192 | <a href="#Identifiers">identifier</a> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 193 | </li> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 194 | |
| 195 | <li>an |
| 196 | <a href="#Integer_literals">integer</a>, |
| 197 | <a href="#Floating-point_literals">floating-point</a>, |
| 198 | <a href="#Imaginary_literals">imaginary</a>, |
| 199 | <a href="#Character_literals">character</a>, or |
| 200 | <a href="#String_literals">string</a> literal |
| 201 | </li> |
| 202 | |
| 203 | <li>one of the <a href="#Keywords">keywords</a> |
| 204 | <code>break</code>, |
| 205 | <code>continue</code>, |
| 206 | <code>fallthrough</code>, or |
| 207 | <code>return</code> |
| 208 | </li> |
| 209 | |
| 210 | <li>one of the <a href="#Operators_and_Delimiters">operators and delimiters</a> |
| 211 | <code>++</code>, |
| 212 | <code>--</code>, |
| 213 | <code>)</code>, |
| 214 | <code>]</code>, or |
| 215 | <code>}</code> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 216 | </li> |
| 217 | </ul> |
| 218 | </li> |
| 219 | |
| 220 | <li> |
| 221 | To allow complex statements to occupy a single line, a semicolon |
| 222 | may be omitted before a closing <code>")"</code> or <code>"}"</code>. |
| 223 | </li> |
| 224 | </ol> |
| 225 | |
| 226 | <p> |
| 227 | To reflect idiomatic use, code examples in this document elide semicolons |
| 228 | using these rules. |
| 229 | </p> |
| 230 | |
| 231 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 232 | <h3 id="Identifiers">Identifiers</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 233 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 234 | <p> |
| 235 | Identifiers name program entities such as variables and types. |
| 236 | An identifier is a sequence of one or more letters and digits. |
| 237 | The first character in an identifier must be a letter. |
| 238 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 239 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 240 | identifier = letter { letter | unicode_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 241 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 242 | <pre> |
| 243 | a |
| 244 | _x9 |
| 245 | ThisVariableIsExported |
| 246 | αβ |
| 247 | </pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 248 | |
| 249 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 250 | Some identifiers are <a href="#Predeclared_identifiers">predeclared</a>. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 251 | </p> |
| 252 | |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 253 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 254 | <h3 id="Keywords">Keywords</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 255 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 256 | <p> |
| 257 | The following keywords are reserved and may not be used as identifiers. |
| 258 | </p> |
| 259 | <pre class="grammar"> |
| 260 | break default func interface select |
| 261 | case defer go map struct |
| 262 | chan else goto package switch |
| 263 | const fallthrough if range type |
| 264 | continue for import return var |
| 265 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 266 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 267 | <h3 id="Operators_and_Delimiters">Operators and Delimiters</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 268 | |
| 269 | <p> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 270 | The following character sequences represent <a href="#Operators">operators</a>, delimiters, and other special tokens: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 271 | </p> |
| 272 | <pre class="grammar"> |
| 273 | + & += &= && == != ( ) |
| 274 | - | -= |= || < <= [ ] |
| 275 | * ^ *= ^= <- > >= { } |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 276 | / << /= <<= ++ = := , ; |
| 277 | % >> %= >>= -- ! ... . : |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 278 | &^ &^= |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 279 | </pre> |
| 280 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 281 | <h3 id="Integer_literals">Integer literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 282 | |
| 283 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 284 | An integer literal is a sequence of digits representing an |
| 285 | <a href="#Constants">integer constant</a>. |
| 286 | An optional prefix sets a non-decimal base: <code>0</code> for octal, <code>0x</code> or |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 287 | <code>0X</code> for hexadecimal. In hexadecimal literals, letters |
| 288 | <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] | 289 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 290 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 291 | int_lit = decimal_lit | octal_lit | hex_lit . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 292 | decimal_lit = ( "1" … "9" ) { decimal_digit } . |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 293 | octal_lit = "0" { octal_digit } . |
| 294 | hex_lit = "0" ( "x" | "X" ) hex_digit { hex_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 295 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 296 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 297 | <pre> |
| 298 | 42 |
| 299 | 0600 |
| 300 | 0xBadFace |
| 301 | 170141183460469231731687303715884105727 |
| 302 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 303 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 304 | <h3 id="Floating-point_literals">Floating-point literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 305 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 306 | A floating-point literal is a decimal representation of a |
| 307 | <a href="#Constants">floating-point constant</a>. |
| 308 | It has an integer part, a decimal point, a fractional part, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 309 | and an exponent part. The integer and fractional part comprise |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 310 | 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] | 311 | followed by an optionally signed decimal exponent. One of the |
| 312 | integer part or the fractional part may be elided; one of the decimal |
| 313 | point or the exponent may be elided. |
| 314 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 315 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 316 | float_lit = decimals "." [ decimals ] [ exponent ] | |
| 317 | decimals exponent | |
| 318 | "." decimals [ exponent ] . |
| 319 | decimals = decimal_digit { decimal_digit } . |
| 320 | exponent = ( "e" | "E" ) [ "+" | "-" ] decimals . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 321 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 322 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 323 | <pre> |
| 324 | 0. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 325 | 72.40 |
| 326 | 072.40 // == 72.40 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 327 | 2.71828 |
| 328 | 1.e+0 |
| 329 | 6.67428e-11 |
| 330 | 1E6 |
| 331 | .25 |
| 332 | .12345E+5 |
| 333 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 334 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 335 | <h3 id="Imaginary_literals">Imaginary literals</h3> |
| 336 | <p> |
| 337 | An imaginary literal is a decimal representation of the imaginary part of a |
| 338 | <a href="#Constants">complex constant</a>. |
| 339 | It consists of a |
| 340 | <a href="#Floating-point_literals">floating-point literal</a> |
| 341 | or decimal integer followed |
| 342 | by the lower-case letter <code>i</code>. |
| 343 | </p> |
| 344 | <pre class="ebnf"> |
| 345 | imaginary_lit = (decimals | float_lit) "i" . |
| 346 | </pre> |
| 347 | |
| 348 | <pre> |
| 349 | 0i |
| 350 | 011i // == 11i |
| 351 | 0.i |
| 352 | 2.71828i |
| 353 | 1.e+0i |
| 354 | 6.67428e-11i |
| 355 | 1E6i |
| 356 | .25i |
| 357 | .12345E+5i |
| 358 | </pre> |
| 359 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 360 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 361 | <h3 id="Character_literals">Character literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 362 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 363 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 364 | A character literal represents an <a href="#Constants">integer constant</a>, |
| 365 | typically a Unicode code point, as one or more characters enclosed in single |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 366 | quotes. Within the quotes, any character may appear except single |
| 367 | quote and newline. A single quoted character represents itself, |
| 368 | while multi-character sequences beginning with a backslash encode |
| 369 | values in various formats. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 370 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 371 | <p> |
| 372 | The simplest form represents the single character within the quotes; |
| 373 | since Go source text is Unicode characters encoded in UTF-8, multiple |
| 374 | UTF-8-encoded bytes may represent a single integer value. For |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 375 | instance, the literal <code>'a'</code> holds a single byte representing |
| 376 | a literal <code>a</code>, Unicode U+0061, value <code>0x61</code>, while |
| 377 | <code>'ä'</code> holds two bytes (<code>0xc3</code> <code>0xa4</code>) representing |
| 378 | a literal <code>a</code>-dieresis, U+00E4, value <code>0xe4</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 379 | </p> |
| 380 | <p> |
| 381 | Several backslash escapes allow arbitrary values to be represented |
| 382 | as ASCII text. There are four ways to represent the integer value |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 383 | as a numeric constant: <code>\x</code> followed by exactly two hexadecimal |
| 384 | digits; <code>\u</code> followed by exactly four hexadecimal digits; |
| 385 | <code>\U</code> followed by exactly eight hexadecimal digits, and a |
| 386 | plain backslash <code>\</code> followed by exactly three octal digits. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 387 | In each case the value of the literal is the value represented by |
| 388 | the digits in the corresponding base. |
| 389 | </p> |
| 390 | <p> |
| 391 | Although these representations all result in an integer, they have |
| 392 | different valid ranges. Octal escapes must represent a value between |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 393 | 0 and 255 inclusive. Hexadecimal escapes satisfy this condition |
| 394 | by construction. The escapes <code>\u</code> and <code>\U</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 395 | represent Unicode code points so within them some values are illegal, |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 396 | in particular those above <code>0x10FFFF</code> and surrogate halves. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 397 | </p> |
| 398 | <p> |
| 399 | After a backslash, certain single-character escapes represent special values: |
| 400 | </p> |
| 401 | <pre class="grammar"> |
| 402 | \a U+0007 alert or bell |
| 403 | \b U+0008 backspace |
| 404 | \f U+000C form feed |
| 405 | \n U+000A line feed or newline |
| 406 | \r U+000D carriage return |
| 407 | \t U+0009 horizontal tab |
| 408 | \v U+000b vertical tab |
| 409 | \\ U+005c backslash |
| 410 | \' U+0027 single quote (valid escape only within character literals) |
| 411 | \" U+0022 double quote (valid escape only within string literals) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 412 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 413 | <p> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 414 | All other sequences starting with a backslash are illegal inside character literals. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 415 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 416 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 417 | char_lit = "'" ( unicode_value | byte_value ) "'" . |
| 418 | unicode_value = unicode_char | little_u_value | big_u_value | escaped_char . |
| 419 | byte_value = octal_byte_value | hex_byte_value . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 420 | octal_byte_value = `\` octal_digit octal_digit octal_digit . |
| 421 | hex_byte_value = `\` "x" hex_digit hex_digit . |
| 422 | little_u_value = `\` "u" hex_digit hex_digit hex_digit hex_digit . |
| 423 | big_u_value = `\` "U" hex_digit hex_digit hex_digit hex_digit |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 424 | hex_digit hex_digit hex_digit hex_digit . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 425 | escaped_char = `\` ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | `\` | "'" | `"` ) . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 426 | </pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 427 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 428 | <pre> |
| 429 | 'a' |
| 430 | 'ä' |
| 431 | '本' |
| 432 | '\t' |
| 433 | '\000' |
| 434 | '\007' |
| 435 | '\377' |
| 436 | '\x07' |
| 437 | '\xff' |
| 438 | '\u12e4' |
| 439 | '\U00101234' |
| 440 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 441 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 442 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 443 | <h3 id="String_literals">String literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 444 | |
| 445 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 446 | A string literal represents a <a href="#Constants">string constant</a> |
| 447 | obtained from concatenating a sequence of characters. There are two forms: |
| 448 | raw string literals and interpreted string literals. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 449 | </p> |
| 450 | <p> |
| 451 | Raw string literals are character sequences between back quotes |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 452 | <code>``</code>. Within the quotes, any character is legal except |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 453 | back quote. The value of a raw string literal is the |
| 454 | string composed of the uninterpreted characters between the quotes; |
| 455 | in particular, backslashes have no special meaning and the string may |
| 456 | span multiple lines. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 457 | </p> |
| 458 | <p> |
| 459 | Interpreted string literals are character sequences between double |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 460 | quotes <code>""</code>. The text between the quotes, |
| 461 | which may not span multiple lines, forms the |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 462 | value of the literal, with backslash escapes interpreted as they |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 463 | are in character literals (except that <code>\'</code> is illegal and |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 464 | <code>\"</code> is legal). The three-digit octal (<code>\</code><i>nnn</i>) |
| 465 | and two-digit hexadecimal (<code>\x</code><i>nn</i>) escapes represent individual |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 466 | <i>bytes</i> of the resulting string; all other escapes represent |
| 467 | the (possibly multi-byte) UTF-8 encoding of individual <i>characters</i>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 468 | Thus inside a string literal <code>\377</code> and <code>\xFF</code> represent |
| 469 | a single byte of value <code>0xFF</code>=255, while <code>ÿ</code>, |
| 470 | <code>\u00FF</code>, <code>\U000000FF</code> and <code>\xc3\xbf</code> represent |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 471 | the two bytes <code>0xc3</code> <code>0xbf</code> of the UTF-8 encoding of character |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 472 | U+00FF. |
| 473 | </p> |
| 474 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 475 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 476 | string_lit = raw_string_lit | interpreted_string_lit . |
Robert Griesemer | 0e8032c | 2011-05-05 09:03:00 -0700 | [diff] [blame] | 477 | raw_string_lit = "`" { unicode_char | newline } "`" . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 478 | interpreted_string_lit = `"` { unicode_value | byte_value } `"` . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 479 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 480 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 481 | <pre> |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 482 | `abc` // same as "abc" |
| 483 | `\n |
| 484 | \n` // same as "\\n\n\\n" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 485 | "\n" |
| 486 | "" |
| 487 | "Hello, world!\n" |
| 488 | "日本語" |
| 489 | "\u65e5本\U00008a9e" |
| 490 | "\xff\u00FF" |
| 491 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 492 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 493 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 494 | These examples all represent the same string: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 495 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 496 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 497 | <pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 498 | "日本語" // UTF-8 input text |
| 499 | `日本語` // UTF-8 input text as a raw literal |
| 500 | "\u65e5\u672c\u8a9e" // The explicit Unicode code points |
| 501 | "\U000065e5\U0000672c\U00008a9e" // The explicit Unicode code points |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 502 | "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e" // The explicit UTF-8 bytes |
| 503 | </pre> |
Robert Griesemer | cd49927 | 2008-09-29 12:09:00 -0700 | [diff] [blame] | 504 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 505 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 506 | If the source code represents a character as two code points, such as |
| 507 | a combining form involving an accent and a letter, the result will be |
| 508 | an error if placed in a character literal (it is not a single code |
| 509 | point), and will appear as two code points if placed in a string |
| 510 | literal. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 511 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 512 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 513 | |
| 514 | <h2 id="Constants">Constants</h2> |
| 515 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 516 | <p>There are <i>boolean constants</i>, <i>integer constants</i>, |
| 517 | <i>floating-point constants</i>, <i>complex constants</i>, |
| 518 | and <i>string constants</i>. Integer, floating-point, |
| 519 | and complex constants are |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 520 | collectively called <i>numeric constants</i>. |
| 521 | </p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 522 | |
| 523 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 524 | A constant value is represented by an |
| 525 | <a href="#Integer_literals">integer</a>, |
| 526 | <a href="#Floating-point_literals">floating-point</a>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 527 | <a href="#Imaginary_literals">imaginary</a>, |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 528 | <a href="#Character_literals">character</a>, or |
| 529 | <a href="#String_literals">string</a> literal, |
| 530 | an identifier denoting a constant, |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 531 | a <a href="#Constant_expressions">constant expression</a>, |
| 532 | a <a href="#Conversions">conversion</a> with a result that is a constant, or |
Russ Cox | f442918 | 2010-07-01 17:49:47 -0700 | [diff] [blame] | 533 | the result value of some built-in functions such as |
| 534 | <code>unsafe.Sizeof</code> applied to any value, |
| 535 | <code>cap</code> or <code>len</code> applied to |
| 536 | <a href="#Length_and_capacity">some expressions</a>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 537 | <code>real</code> and <code>imag</code> applied to a complex constant |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 538 | and <code>complex</code> applied to numeric constants. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 539 | The boolean truth values are represented by the predeclared constants |
| 540 | <code>true</code> and <code>false</code>. The predeclared identifier |
| 541 | <a href="#Iota">iota</a> denotes an integer constant. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 542 | </p> |
| 543 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 544 | <p> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 545 | In general, complex constants are a form of |
| 546 | <a href="#Constant_expressions">constant expression</a> |
| 547 | and are discussed in that section. |
| 548 | </p> |
| 549 | |
| 550 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 551 | Numeric constants represent values of arbitrary precision and do not overflow. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 552 | </p> |
| 553 | |
| 554 | <p> |
| 555 | Constants may be <a href="#Types">typed</a> or untyped. |
| 556 | Literal constants, <code>true</code>, <code>false</code>, <code>iota</code>, |
| 557 | and certain <a href="#Constant_expressions">constant expressions</a> |
| 558 | containing only untyped constant operands are untyped. |
| 559 | </p> |
| 560 | |
| 561 | <p> |
| 562 | A constant may be given a type explicitly by a <a href="#Constant_declarations">constant declaration</a> |
| 563 | or <a href="#Conversions">conversion</a>, or implicitly when used in a |
| 564 | <a href="#Variable_declarations">variable declaration</a> or an |
| 565 | <a href="#Assignments">assignment</a> or as an |
| 566 | operand in an <a href="#Expressions">expression</a>. |
| 567 | It is an error if the constant value |
Robert Griesemer | dfc5bb5 | 2011-01-19 10:33:41 -0800 | [diff] [blame] | 568 | cannot be represented as a value of the respective type. |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 569 | For instance, <code>3.0</code> can be given any integer or any |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 570 | floating-point type, while <code>2147483648.0</code> (equal to <code>1<<31</code>) |
| 571 | can be given the types <code>float32</code>, <code>float64</code>, or <code>uint32</code> but |
| 572 | not <code>int32</code> or <code>string</code>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 573 | </p> |
| 574 | |
| 575 | <p> |
Russ Cox | 16205a3 | 2010-01-18 15:59:14 -0800 | [diff] [blame] | 576 | There are no constants denoting the IEEE-754 infinity and not-a-number values, |
| 577 | but the <a href="/pkg/math/"><code>math</code> package</a>'s |
| 578 | <a href="/pkg/math/#Inf">Inf</a>, |
| 579 | <a href="/pkg/math/#NaN">NaN</a>, |
| 580 | <a href="/pkg/math/#IsInf">IsInf</a>, and |
| 581 | <a href="/pkg/math/#IsNaN">IsNaN</a> |
| 582 | functions return and test for those values at run time. |
| 583 | </p> |
| 584 | |
| 585 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 586 | Implementation restriction: A compiler may implement numeric constants by choosing |
| 587 | an internal representation with at least twice as many bits as any machine type; |
| 588 | for floating-point values, both the mantissa and exponent must be twice as large. |
| 589 | </p> |
| 590 | |
| 591 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 592 | <h2 id="Types">Types</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 593 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 594 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 595 | A type determines the set of values and operations specific to values of that |
| 596 | type. A type may be specified by a (possibly qualified) <i>type name</i> |
Robert Griesemer | 947e218 | 2010-09-07 11:14:36 -0700 | [diff] [blame] | 597 | (§<a href="#Qualified_identifiers">Qualified identifier</a>, §<a href="#Type_declarations">Type declarations</a>) or a <i>type literal</i>, |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 598 | which composes a new type from previously declared types. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 599 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 600 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 601 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 602 | Type = TypeName | TypeLit | "(" Type ")" . |
Anthony Martin | 11a0161 | 2010-12-13 22:19:41 -0800 | [diff] [blame] | 603 | TypeName = QualifiedIdent . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 604 | TypeLit = ArrayType | StructType | PointerType | FunctionType | InterfaceType | |
| 605 | SliceType | MapType | ChannelType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 606 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 607 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 608 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 609 | Named instances of the boolean, numeric, and string types are |
| 610 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 611 | <i>Composite types</i>—array, struct, pointer, function, |
| 612 | interface, slice, map, and channel types—may be constructed using |
| 613 | type literals. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 614 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 615 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 616 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 617 | The <i>static type</i> (or just <i>type</i>) of a variable is the |
| 618 | type defined by its declaration. Variables of interface type |
| 619 | also have a distinct <i>dynamic type</i>, which |
| 620 | is the actual type of the value stored in the variable at run-time. |
| 621 | The dynamic type may vary during execution but is always |
| 622 | <a href="#Assignability">assignable</a> |
| 623 | to the static type of the interface variable. For non-interface |
| 624 | types, the dynamic type is always the static type. |
| 625 | </p> |
| 626 | |
| 627 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 628 | Each type <code>T</code> has an <i>underlying type</i>: If <code>T</code> |
| 629 | is a predeclared type or a type literal, the corresponding underlying |
| 630 | type is <code>T</code> itself. Otherwise, <code>T</code>'s underlying type |
| 631 | is the underlying type of the type to which <code>T</code> refers in its |
| 632 | <a href="#Type_declarations">type declaration</a>. |
| 633 | </p> |
| 634 | |
| 635 | <pre> |
| 636 | type T1 string |
| 637 | type T2 T1 |
| 638 | type T3 []T1 |
| 639 | type T4 T3 |
| 640 | </pre> |
| 641 | |
| 642 | <p> |
| 643 | The underlying type of <code>string</code>, <code>T1</code>, and <code>T2</code> |
| 644 | is <code>string</code>. The underlying type of <code>[]T1</code>, <code>T3</code>, |
| 645 | and <code>T4</code> is <code>[]T1</code>. |
| 646 | </p> |
| 647 | |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 648 | <h3 id="Method_sets">Method sets</h3> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 649 | <p> |
Robert Griesemer | 3b576a7 | 2009-06-17 14:31:33 -0700 | [diff] [blame] | 650 | A type may have a <i>method set</i> associated with it |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 651 | (§<a href="#Interface_types">Interface types</a>, §<a href="#Method_declarations">Method declarations</a>). |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 652 | The method set of an <a href="#Interface_types">interface type</a> is its interface. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 653 | The method set of any other named type <code>T</code> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 654 | consists of all methods with receiver type <code>T</code>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 655 | The method set of the corresponding pointer type <code>*T</code> |
| 656 | is the set of all methods with receiver <code>*T</code> or <code>T</code> |
| 657 | (that is, it also contains the method set of <code>T</code>). |
| 658 | Any other type has an empty method set. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 659 | In a method set, each method must have a unique name. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 660 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 661 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 662 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 663 | <h3 id="Boolean_types">Boolean types</h3> |
| 664 | |
| 665 | A <i>boolean type</i> represents the set of Boolean truth values |
| 666 | denoted by the predeclared constants <code>true</code> |
| 667 | and <code>false</code>. The predeclared boolean type is <code>bool</code>. |
| 668 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 669 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 670 | <h3 id="Numeric_types">Numeric types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 671 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 672 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 673 | A <i>numeric type</i> represents sets of integer or floating-point values. |
| 674 | The predeclared architecture-independent numeric types are: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 675 | </p> |
Robert Griesemer | ebf14c6 | 2008-10-30 14:50:23 -0700 | [diff] [blame] | 676 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 677 | <pre class="grammar"> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 678 | uint8 the set of all unsigned 8-bit integers (0 to 255) |
| 679 | uint16 the set of all unsigned 16-bit integers (0 to 65535) |
| 680 | uint32 the set of all unsigned 32-bit integers (0 to 4294967295) |
| 681 | uint64 the set of all unsigned 64-bit integers (0 to 18446744073709551615) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 682 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 683 | int8 the set of all signed 8-bit integers (-128 to 127) |
| 684 | int16 the set of all signed 16-bit integers (-32768 to 32767) |
| 685 | int32 the set of all signed 32-bit integers (-2147483648 to 2147483647) |
| 686 | int64 the set of all signed 64-bit integers (-9223372036854775808 to 9223372036854775807) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 687 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 688 | float32 the set of all IEEE-754 32-bit floating-point numbers |
| 689 | float64 the set of all IEEE-754 64-bit floating-point numbers |
| 690 | |
| 691 | complex64 the set of all complex numbers with float32 real and imaginary parts |
| 692 | complex128 the set of all complex numbers with float64 real and imaginary parts |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 693 | |
Robert Griesemer | ef4c2b8 | 2010-03-10 15:29:36 -0800 | [diff] [blame] | 694 | byte familiar alias for uint8 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 695 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 696 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 697 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 698 | The value of an <i>n</i>-bit integer is <i>n</i> bits wide and represented using |
| 699 | <a href="http://en.wikipedia.org/wiki/Two's_complement">two's complement arithmetic</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 700 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 701 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 702 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 703 | There is also a set of predeclared numeric types with implementation-specific sizes: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 704 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 705 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 706 | <pre class="grammar"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 707 | uint either 32 or 64 bits |
Robert Griesemer | 97025eb | 2011-01-13 10:24:04 -0800 | [diff] [blame] | 708 | int same size as uint |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 709 | uintptr an unsigned integer large enough to store the uninterpreted bits of a pointer value |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 710 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 711 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 712 | <p> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 713 | To avoid portability issues all numeric types are distinct except |
| 714 | <code>byte</code>, which is an alias for <code>uint8</code>. |
| 715 | Conversions |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 716 | are required when different numeric types are mixed in an expression |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 717 | or assignment. For instance, <code>int32</code> and <code>int</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 718 | 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] | 719 | particular architecture. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 720 | |
| 721 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 722 | <h3 id="String_types">String types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 723 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 724 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 725 | A <i>string type</i> represents the set of string values. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 726 | Strings behave like arrays of bytes but are immutable: once created, |
| 727 | it is impossible to change the contents of a string. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 728 | The predeclared string type is <code>string</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 729 | |
| 730 | <p> |
| 731 | The elements of strings have type <code>byte</code> and may be |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 732 | accessed using the usual <a href="#Indexes">indexing operations</a>. It is |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 733 | illegal to take the address of such an element; if |
| 734 | <code>s[i]</code> is the <i>i</i>th byte of a |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 735 | string, <code>&s[i]</code> is invalid. The length of string |
| 736 | <code>s</code> can be discovered using the built-in function |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 737 | <code>len</code>. The length is a compile-time constant if <code>s</code> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 738 | is a string literal. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 739 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 740 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 741 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 742 | <h3 id="Array_types">Array types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 743 | |
| 744 | <p> |
| 745 | An array is a numbered sequence of elements of a single |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 746 | type, called the element type. |
| 747 | The number of elements is called the length and is never |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 748 | negative. |
| 749 | </p> |
| 750 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 751 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 752 | ArrayType = "[" ArrayLength "]" ElementType . |
| 753 | ArrayLength = Expression . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 754 | ElementType = Type . |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 755 | </pre> |
| 756 | |
| 757 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 758 | The length is part of the array's type and must be a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 759 | <a href="#Constant_expressions">constant expression</a> that evaluates to a non-negative |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 760 | integer value. The length of array <code>a</code> can be discovered |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 761 | using the built-in function <a href="#Length_and_capacity"><code>len(a)</code></a>. |
| 762 | The elements can be indexed by integer |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 763 | indices 0 through the <code>len(a)-1</code> (§<a href="#Indexes">Indexes</a>). |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 764 | Array types are always one-dimensional but may be composed to form |
| 765 | multi-dimensional types. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 766 | </p> |
| 767 | |
| 768 | <pre> |
| 769 | [32]byte |
| 770 | [2*N] struct { x, y int32 } |
| 771 | [1000]*float64 |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 772 | [3][5]int |
| 773 | [2][2][2]float64 // same as [2]([2]([2]float64)) |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 774 | </pre> |
| 775 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 776 | <h3 id="Slice_types">Slice types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 777 | |
| 778 | <p> |
| 779 | A slice is a reference to a contiguous segment of an array and |
| 780 | contains a numbered sequence of elements from that array. A slice |
| 781 | type denotes the set of all slices of arrays of its element type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 782 | The value of an uninitialized slice is <code>nil</code>. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 783 | </p> |
| 784 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 785 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 786 | SliceType = "[" "]" ElementType . |
| 787 | </pre> |
| 788 | |
| 789 | <p> |
| 790 | Like arrays, slices are indexable and have a length. The length of a |
| 791 | slice <code>s</code> can be discovered by the built-in function |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 792 | <a href="#Length_and_capacity"><code>len(s)</code></a>; unlike with arrays it may change during |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 793 | execution. The elements can be addressed by integer indices 0 |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 794 | through <code>len(s)-1</code> (§<a href="#Indexes">Indexes</a>). The slice index of a |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 795 | given element may be less than the index of the same element in the |
| 796 | underlying array. |
| 797 | </p> |
| 798 | <p> |
| 799 | A slice, once initialized, is always associated with an underlying |
Rob Pike | 7ec0856 | 2010-01-09 07:32:26 +1100 | [diff] [blame] | 800 | array that holds its elements. A slice therefore shares storage |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 801 | with its array and with other slices of the same array; by contrast, |
| 802 | distinct arrays always represent distinct storage. |
| 803 | </p> |
| 804 | <p> |
| 805 | 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] | 806 | 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] | 807 | the length of the slice and the length of the array beyond the slice; |
| 808 | a slice of length up to that capacity can be created by `slicing' a new |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 809 | one from the original slice (§<a href="#Slices">Slices</a>). |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 810 | The capacity of a slice <code>a</code> can be discovered using the |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 811 | built-in function <a href="#Length_and_capacity"><code>cap(a)</code></a>. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 812 | </p> |
| 813 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 814 | <p> |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 815 | A new, initialized slice value for a given element type <code>T</code> is |
| 816 | made using the built-in function |
| 817 | <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
| 818 | which takes a slice type |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 819 | and parameters specifying the length and optionally the capacity: |
| 820 | </p> |
| 821 | |
| 822 | <pre> |
| 823 | make([]T, length) |
| 824 | make([]T, length, capacity) |
| 825 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 826 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 827 | <p> |
Rob Pike | 46f482a | 2011-05-25 06:44:09 +1000 | [diff] [blame] | 828 | A call to <code>make</code> allocates a new, hidden array to which the returned |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 829 | slice value refers. That is, executing |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 830 | </p> |
| 831 | |
| 832 | <pre> |
| 833 | make([]T, length, capacity) |
| 834 | </pre> |
| 835 | |
| 836 | <p> |
| 837 | produces the same slice as allocating an array and slicing it, so these two examples |
| 838 | result in the same slice: |
| 839 | </p> |
| 840 | |
| 841 | <pre> |
| 842 | make([]int, 50, 100) |
| 843 | new([100]int)[0:50] |
| 844 | </pre> |
| 845 | |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 846 | <p> |
| 847 | Like arrays, slices are always one-dimensional but may be composed to construct |
| 848 | higher-dimensional objects. |
| 849 | With arrays of arrays, the inner arrays are, by construction, always the same length; |
| 850 | however with slices of slices (or arrays of slices), the lengths may vary dynamically. |
| 851 | Moreover, the inner slices must be allocated individually (with <code>make</code>). |
| 852 | </p> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 853 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 854 | <h3 id="Struct_types">Struct types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 855 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 856 | <p> |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 857 | A struct is a sequence of named elements, called fields, each of which has a |
| 858 | name and a type. Field names may be specified explicitly (IdentifierList) or |
| 859 | implicitly (AnonymousField). |
| 860 | Within a struct, non-<a href="#Blank_identifier">blank</a> field names must |
| 861 | be unique. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 862 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 863 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 864 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 865 | StructType = "struct" "{" { FieldDecl ";" } "}" . |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 866 | FieldDecl = (IdentifierList Type | AnonymousField) [ Tag ] . |
| 867 | AnonymousField = [ "*" ] TypeName . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 868 | Tag = string_lit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 869 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 870 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 871 | <pre> |
| 872 | // An empty struct. |
| 873 | struct {} |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 874 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 875 | // A struct with 6 fields. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 876 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 877 | x, y int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 878 | u float32 |
| 879 | _ float32 // padding |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 880 | A *[]int |
| 881 | F func() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 882 | } |
| 883 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 884 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 885 | <p> |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 886 | A field declared with a type but no explicit field name is an <i>anonymous field</i> |
| 887 | (colloquially called an embedded field). |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 888 | Such a field type must be specified as |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 889 | a type name <code>T</code> or as a pointer to a non-interface type name <code>*T</code>, |
Ian Lance Taylor | 3e804ba | 2009-08-17 11:40:57 -0700 | [diff] [blame] | 890 | and <code>T</code> itself may not be |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 891 | a pointer type. The unqualified type name acts as the field name. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 892 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 893 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 894 | <pre> |
| 895 | // A struct with four anonymous fields of type T1, *T2, P.T3 and *P.T4 |
| 896 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 897 | T1 // field name is T1 |
| 898 | *T2 // field name is T2 |
| 899 | P.T3 // field name is T3 |
| 900 | *P.T4 // field name is T4 |
| 901 | x, y int // field names are x and y |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 902 | } |
| 903 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 904 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 905 | <p> |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 906 | The following declaration is illegal because field names must be unique |
| 907 | in a struct type: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 908 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 909 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 910 | <pre> |
| 911 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 912 | T // conflicts with anonymous field *T and *P.T |
| 913 | *T // conflicts with anonymous field T and *P.T |
| 914 | *P.T // conflicts with anonymous field T and *T |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 915 | } |
| 916 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 917 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 918 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 919 | Fields and methods (§<a href="#Method_declarations">Method declarations</a>) of an anonymous field are |
| 920 | promoted to be ordinary fields and methods of the struct (§<a href="#Selectors">Selectors</a>). |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 921 | The following rules apply for a struct type named <code>S</code> and |
| 922 | a type named <code>T</code>: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 923 | </p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 924 | <ul> |
| 925 | <li>If <code>S</code> contains an anonymous field <code>T</code>, the |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 926 | <a href="#Method_sets">method set</a> of <code>S</code> includes the |
| 927 | method set of <code>T</code>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 928 | </li> |
| 929 | |
| 930 | <li>If <code>S</code> contains an anonymous field <code>*T</code>, the |
| 931 | method set of <code>S</code> includes the method set of <code>*T</code> |
| 932 | (which itself includes the method set of <code>T</code>). |
| 933 | </li> |
| 934 | |
| 935 | <li>If <code>S</code> contains an anonymous field <code>T</code> or |
| 936 | <code>*T</code>, the method set of <code>*S</code> includes the |
| 937 | method set of <code>*T</code> (which itself includes the method |
| 938 | set of <code>T</code>). |
| 939 | </li> |
| 940 | </ul> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 941 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 942 | A field declaration may be followed by an optional string literal <i>tag</i>, |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 943 | which becomes an attribute for all the fields in the corresponding |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 944 | field declaration. The tags are made |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 945 | visible through a <a href="#Package_unsafe">reflection interface</a> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 946 | but are otherwise ignored. |
| 947 | </p> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 948 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 949 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 950 | // A struct corresponding to the TimeStamp protocol buffer. |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 951 | // The tag strings define the protocol buffer field numbers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 952 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 953 | microsec uint64 "field 1" |
| 954 | serverIP6 uint64 "field 2" |
| 955 | process string "field 3" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 956 | } |
| 957 | </pre> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 958 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 959 | <h3 id="Pointer_types">Pointer types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 960 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 961 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 962 | 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] | 963 | type, called the <i>base type</i> of the pointer. |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 964 | The value of an uninitialized pointer is <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 965 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 966 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 967 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 968 | PointerType = "*" BaseType . |
| 969 | BaseType = Type . |
| 970 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 971 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 972 | <pre> |
| 973 | *int |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 974 | *map[string] *chan int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 975 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 976 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 977 | <h3 id="Function_types">Function types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 978 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 979 | <p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 980 | A function type denotes the set of all functions with the same parameter |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 981 | and result types. The value of an uninitialized variable of function type |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 982 | is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 983 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 984 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 985 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 986 | FunctionType = "func" Signature . |
| 987 | Signature = Parameters [ Result ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 988 | Result = Parameters | Type . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 989 | Parameters = "(" [ ParameterList [ "," ] ] ")" . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 990 | ParameterList = ParameterDecl { "," ParameterDecl } . |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 991 | ParameterDecl = [ IdentifierList ] [ "..." ] Type . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 992 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 993 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 994 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 995 | Within a list of parameters or results, the names (IdentifierList) |
| 996 | must either all be present or all be absent. If present, each name |
| 997 | stands for one item (parameter or result) of the specified type; if absent, each |
| 998 | type stands for one item of that type. Parameter and result |
| 999 | lists are always parenthesized except that if there is exactly |
Robert Griesemer | 73ca127 | 2010-07-09 13:02:54 -0700 | [diff] [blame] | 1000 | one unnamed result it may be written as an unparenthesized type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1001 | </p> |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 1002 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 1003 | <p> |
| 1004 | The final parameter in a function signature may have |
| 1005 | a type prefixed with <code>...</code>. |
| 1006 | A function with such a parameter is called <i>variadic</i> and |
| 1007 | may be invoked with zero or more arguments for that parameter. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1008 | </p> |
Robert Griesemer | 2bfa957 | 2008-10-24 13:13:12 -0700 | [diff] [blame] | 1009 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1010 | <pre> |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 1011 | func() |
| 1012 | func(x int) |
| 1013 | func() int |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 1014 | func(prefix string, values ...int) |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1015 | func(a, b int, z float32) bool |
| 1016 | func(a, b int, z float32) (bool) |
| 1017 | func(a, b int, z float64, opt ...interface{}) (success bool) |
| 1018 | func(int, int, float64) (float64, *[]int) |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 1019 | func(n int) func(p *T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1020 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 1021 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1022 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1023 | <h3 id="Interface_types">Interface types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1024 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1025 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 1026 | An interface type specifies a <a href="#Method_sets">method set</a> called its <i>interface</i>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1027 | A variable of interface type can store a value of any type with a method set |
| 1028 | that is any superset of the interface. Such a type is said to |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1029 | <i>implement the interface</i>. |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 1030 | The value of an uninitialized variable of interface type is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1031 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1032 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1033 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1034 | InterfaceType = "interface" "{" { MethodSpec ";" } "}" . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1035 | MethodSpec = MethodName Signature | InterfaceTypeName . |
| 1036 | MethodName = identifier . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1037 | InterfaceTypeName = TypeName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1038 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1039 | |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1040 | <p> |
| 1041 | As with all method sets, in an interface type, each method must have a unique name. |
| 1042 | </p> |
| 1043 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1044 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1045 | // A simple File interface |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1046 | interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1047 | Read(b Buffer) bool |
| 1048 | Write(b Buffer) bool |
| 1049 | Close() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1050 | } |
| 1051 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1052 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1053 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1054 | More than one type may implement an interface. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1055 | For instance, if two types <code>S1</code> and <code>S2</code> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1056 | have the method set |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1057 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1058 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1059 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 1060 | func (p T) Read(b Buffer) bool { return … } |
| 1061 | func (p T) Write(b Buffer) bool { return … } |
| 1062 | func (p T) Close() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1063 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1064 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1065 | <p> |
| 1066 | (where <code>T</code> stands for either <code>S1</code> or <code>S2</code>) |
| 1067 | then the <code>File</code> interface is implemented by both <code>S1</code> and |
| 1068 | <code>S2</code>, regardless of what other methods |
| 1069 | <code>S1</code> and <code>S2</code> may have or share. |
| 1070 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1071 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1072 | <p> |
| 1073 | A type implements any interface comprising any subset of its methods |
| 1074 | and may therefore implement several distinct interfaces. For |
| 1075 | instance, all types implement the <i>empty interface</i>: |
| 1076 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1077 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1078 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1079 | interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1080 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1081 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1082 | <p> |
| 1083 | Similarly, consider this interface specification, |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1084 | which appears within a <a href="#Type_declarations">type declaration</a> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1085 | to define an interface called <code>Lock</code>: |
| 1086 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1087 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1088 | <pre> |
| 1089 | type Lock interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1090 | Lock() |
| 1091 | Unlock() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1092 | } |
| 1093 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1094 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1095 | <p> |
| 1096 | If <code>S1</code> and <code>S2</code> also implement |
| 1097 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1098 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1099 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 1100 | func (p T) Lock() { … } |
| 1101 | func (p T) Unlock() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1102 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1103 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1104 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1105 | they implement the <code>Lock</code> interface as well |
| 1106 | as the <code>File</code> interface. |
| 1107 | </p> |
| 1108 | <p> |
| 1109 | An interface may contain an interface type name <code>T</code> |
| 1110 | in place of a method specification. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1111 | The effect is equivalent to enumerating the methods of <code>T</code> explicitly |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1112 | in the interface. |
| 1113 | </p> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1114 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1115 | <pre> |
| 1116 | type ReadWrite interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1117 | Read(b Buffer) bool |
| 1118 | Write(b Buffer) bool |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1119 | } |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1120 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1121 | type File interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1122 | ReadWrite // same as enumerating the methods in ReadWrite |
| 1123 | Lock // same as enumerating the methods in Lock |
| 1124 | Close() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1125 | } |
| 1126 | </pre> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1127 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1128 | <h3 id="Map_types">Map types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1129 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1130 | <p> |
| 1131 | A map is an unordered group of elements of one type, called the |
Robert Griesemer | 0660d24 | 2009-11-15 17:42:27 -0800 | [diff] [blame] | 1132 | element type, indexed by a set of unique <i>keys</i> of another type, |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1133 | called the key type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1134 | The value of an uninitialized map is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1135 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1136 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1137 | <pre class="ebnf"> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1138 | MapType = "map" "[" KeyType "]" ElementType . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1139 | KeyType = Type . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1140 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1141 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1142 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1143 | The comparison operators <code>==</code> and <code>!=</code> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 1144 | (§<a href="#Comparison_operators">Comparison operators</a>) must be fully defined |
| 1145 | for operands of the key type; thus the key type must not be a struct, array or slice. |
| 1146 | If the key type is an interface type, these |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1147 | comparison operators must be defined for the dynamic key values; |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 1148 | failure will cause a <a href="#Run_time_panics">run-time panic</a>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1149 | |
| 1150 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1151 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1152 | <pre> |
| 1153 | map [string] int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1154 | map [*T] struct { x, y float64 } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1155 | map [string] interface {} |
| 1156 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1157 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1158 | <p> |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 1159 | The number of map elements is called its length. |
| 1160 | For a map <code>m</code>, it can be discovered using the |
| 1161 | built-in function <a href="#Length_and_capacity"><code>len(m)</code></a> |
Robert Griesemer | 1bdb180 | 2011-04-22 16:26:51 -0700 | [diff] [blame] | 1162 | and may change during execution. Elements may be added and removed |
| 1163 | during execution using special forms of <a href="#Assignments">assignment</a>; |
| 1164 | and they may be accessed with <a href="#Indexes">index</a> expressions. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1165 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1166 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1167 | A new, empty map value is made using the built-in |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 1168 | function <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
| 1169 | which takes the map type and an optional capacity hint as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1170 | </p> |
| 1171 | |
| 1172 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1173 | make(map[string] int) |
| 1174 | make(map[string] int, 100) |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1175 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1176 | |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1177 | <p> |
| 1178 | The initial capacity does not bound its size: |
| 1179 | maps grow to accommodate the number of items |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 1180 | stored in them, with the exception of <code>nil</code> maps. |
| 1181 | A <code>nil</code> map is equivalent to an empty map except that no elements |
| 1182 | may be added. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1183 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1184 | <h3 id="Channel_types">Channel types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1185 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1186 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1187 | A channel provides a mechanism for two concurrently executing functions |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1188 | to synchronize execution and communicate by passing a value of a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1189 | specified element type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1190 | The value of an uninitialized channel is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1191 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1192 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1193 | <pre class="ebnf"> |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1194 | ChannelType = ( "chan" [ "<-" ] | "<-" "chan" ) ElementType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1195 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1196 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1197 | <p> |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1198 | The <code><-</code> operator specifies the channel <i>direction</i>, |
| 1199 | <i>send</i> or <i>receive</i>. If no direction is given, the channel is |
| 1200 | <i>bi-directional</i>. |
| 1201 | A channel may be constrained only to send or only to receive by |
| 1202 | <a href="#Conversions">conversion</a> or <a href="#Assignments">assignment</a>. |
| 1203 | </p> |
| 1204 | |
| 1205 | <pre> |
| 1206 | chan T // can be used to send and receive values of type T |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1207 | chan<- float64 // can only be used to send float64s |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1208 | <-chan int // can only be used to receive ints |
| 1209 | </pre> |
| 1210 | |
| 1211 | <p> |
| 1212 | The <code><-</code> operator associates with the leftmost <code>chan</code> |
| 1213 | possible: |
Robert Griesemer | 1c369bd | 2010-01-27 09:35:39 -0800 | [diff] [blame] | 1214 | </p> |
| 1215 | |
| 1216 | <pre> |
| 1217 | chan<- chan int // same as chan<- (chan int) |
| 1218 | chan<- <-chan int // same as chan<- (<-chan int) |
| 1219 | <-chan <-chan int // same as <-chan (<-chan int) |
| 1220 | chan (<-chan int) |
| 1221 | </pre> |
| 1222 | |
| 1223 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1224 | A new, initialized channel |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1225 | value can be made using the built-in function |
| 1226 | <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 1227 | which takes the channel type and an optional capacity as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1228 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1229 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1230 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1231 | make(chan int, 100) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1232 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1233 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1234 | <p> |
| 1235 | The capacity, in number of elements, sets the size of the buffer in the channel. If the |
Robert Griesemer | f14c29a | 2011-02-15 11:33:12 -0800 | [diff] [blame] | 1236 | capacity is greater than zero, the channel is asynchronous: communication operations |
| 1237 | succeed without blocking if the buffer is not full (sends) or not empty (receives), |
| 1238 | and elements are received in the order they are sent. |
| 1239 | If the capacity is zero or absent, the communication succeeds only when both a sender and |
| 1240 | receiver are ready. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 1241 | A <code>nil</code> channel is never ready for communication. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1242 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1243 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1244 | <p> |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 1245 | A channel may be closed with the built-in function |
| 1246 | <a href="#Close"><code>close</code></a>; the |
| 1247 | multi-valued assignment form of the |
| 1248 | <a href="#Receive_operator">receive operator</a> |
| 1249 | tests whether a channel has been closed. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1250 | </p> |
| 1251 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1252 | <h2 id="Properties_of_types_and_values">Properties of types and values</h2> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1253 | |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1254 | <h3 id="Type_identity">Type identity</h3> |
| 1255 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1256 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1257 | Two types are either <i>identical</i> or <i>different</i>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1258 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1259 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1260 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1261 | Two named types are identical if their type names originate in the same |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1262 | type <a href="#Declarations_and_scope">declaration</a>. |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 1263 | A named and an unnamed type are always different. Two unnamed types are identical |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1264 | if the corresponding type literals are identical, that is, if they have the same |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 1265 | literal structure and corresponding components have identical types. In detail: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1266 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1267 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1268 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1269 | <li>Two array types are identical if they have identical element types and |
| 1270 | the same array length.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1271 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1272 | <li>Two slice types are identical if they have identical element types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1273 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1274 | <li>Two struct types are identical if they have the same sequence of fields, |
Russ Cox | e495351 | 2010-06-21 12:42:33 -0700 | [diff] [blame] | 1275 | and if corresponding fields have the same names, and identical types, |
| 1276 | and identical tags. |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 1277 | Two anonymous fields are considered to have the same name. Lower-case field |
| 1278 | names from different packages are always different.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1279 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1280 | <li>Two pointer types are identical if they have identical base types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1281 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1282 | <li>Two function types are identical if they have the same number of parameters |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 1283 | and result values, corresponding parameter and result types are |
| 1284 | identical, and either both functions are variadic or neither is. |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1285 | Parameter and result names are not required to match.</li> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1286 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1287 | <li>Two interface types are identical if they have the same set of methods |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 1288 | with the same names and identical function types. Lower-case method names from |
| 1289 | different packages are always different. The order of the methods is irrelevant.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1290 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1291 | <li>Two map types are identical if they have identical key and value types.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1292 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1293 | <li>Two channel types are identical if they have identical value types and |
| 1294 | the same direction.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1295 | </ul> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1296 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1297 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1298 | Given the declarations |
| 1299 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1300 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1301 | <pre> |
| 1302 | type ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1303 | T0 []string |
| 1304 | T1 []string |
| 1305 | T2 struct { a, b int } |
| 1306 | T3 struct { a, c int } |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1307 | T4 func(int, float64) *T0 |
| 1308 | T5 func(x int, y float64) *[]string |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1309 | ) |
| 1310 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1311 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1312 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1313 | these types are identical: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1314 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1315 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1316 | <pre> |
| 1317 | T0 and T0 |
| 1318 | []int and []int |
| 1319 | struct { a, b *T5 } and struct { a, b *T5 } |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1320 | func(x int, y float64) *[]string and func(int, float64) (result *[]string) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1321 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1322 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1323 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1324 | <code>T0</code> and <code>T1</code> are different because they are named types |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1325 | with distinct declarations; <code>func(int, float64) *T0</code> and |
| 1326 | <code>func(x int, y float64) *[]string</code> are different because <code>T0</code> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1327 | is different from <code>[]string</code>. |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1328 | </p> |
| 1329 | |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1330 | |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1331 | <h3 id="Assignability">Assignability</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1332 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1333 | <p> |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1334 | A value <code>x</code> is <i>assignable</i> to a variable of type <code>T</code> |
| 1335 | ("<code>x</code> is assignable to <code>T</code>") in any of these cases: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1336 | </p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1337 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1338 | <ul> |
| 1339 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1340 | <code>x</code>'s type is identical to <code>T</code>. |
| 1341 | </li> |
| 1342 | <li> |
Rob Pike | 68f1609 | 2010-09-01 10:40:50 +1000 | [diff] [blame] | 1343 | <code>x</code>'s type <code>V</code> and <code>T</code> have identical |
| 1344 | <a href="#Types">underlying types</a> and at least one of <code>V</code> |
| 1345 | or <code>T</code> is not a named type. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1346 | </li> |
| 1347 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1348 | <code>T</code> is an interface type and |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1349 | <code>x</code> <a href="#Interface_types">implements</a> <code>T</code>. |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 1350 | </li> |
| 1351 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1352 | <code>x</code> is a bidirectional channel value, <code>T</code> is a channel type, |
| 1353 | <code>x</code>'s type <code>V</code> and <code>T</code> have identical element types, |
Rob Pike | 68f1609 | 2010-09-01 10:40:50 +1000 | [diff] [blame] | 1354 | and at least one of <code>V</code> or <code>T</code> is not a named type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1355 | </li> |
| 1356 | <li> |
| 1357 | <code>x</code> is the predeclared identifier <code>nil</code> and <code>T</code> |
| 1358 | is a pointer, function, slice, map, channel, or interface type. |
| 1359 | </li> |
| 1360 | <li> |
| 1361 | <code>x</code> is an untyped <a href="#Constants">constant</a> representable |
| 1362 | by a value of type <code>T</code>. |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1363 | </li> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1364 | </ul> |
| 1365 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1366 | <p> |
Robert Griesemer | fa3d0d7 | 2011-02-03 10:53:31 -0800 | [diff] [blame] | 1367 | If <code>T</code> is a struct type with non-<a href="#Exported_identifiers">exported</a> |
| 1368 | fields, the assignment must be in the same package in which <code>T</code> is declared, |
| 1369 | or <code>x</code> must be the receiver of a method call. |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 1370 | In other words, a struct value can be assigned to a struct variable only if |
Robert Griesemer | fa3d0d7 | 2011-02-03 10:53:31 -0800 | [diff] [blame] | 1371 | every field of the struct may be legally assigned individually by the program, |
| 1372 | or if the assignment is initializing the receiver of a method of the struct type. |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 1373 | </p> |
| 1374 | |
| 1375 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1376 | Any value may be assigned to the <a href="#Blank_identifier">blank identifier</a>. |
| 1377 | </p> |
| 1378 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1379 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1380 | <h2 id="Blocks">Blocks</h2> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1381 | |
| 1382 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1383 | A <i>block</i> is a sequence of declarations and statements within matching |
| 1384 | brace brackets. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1385 | </p> |
| 1386 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1387 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1388 | Block = "{" { Statement ";" } "}" . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1389 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1390 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1391 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1392 | In addition to explicit blocks in the source code, there are implicit blocks: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1393 | </p> |
| 1394 | |
| 1395 | <ol> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1396 | <li>The <i>universe block</i> encompasses all Go source text.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1397 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1398 | <li>Each <a href="#Packages">package</a> has a <i>package block</i> containing all |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1399 | Go source text for that package.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1400 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1401 | <li>Each file has a <i>file block</i> containing all Go source text |
| 1402 | in that file.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1403 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1404 | <li>Each <code>if</code>, <code>for</code>, and <code>switch</code> |
| 1405 | statement is considered to be in its own implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1406 | |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1407 | <li>Each clause in a <code>switch</code> or <code>select</code> statement |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1408 | acts as an implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1409 | </ol> |
| 1410 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1411 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1412 | Blocks nest and influence <a href="#Declarations_and_scope">scoping</a>. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1413 | </p> |
| 1414 | |
| 1415 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1416 | <h2 id="Declarations_and_scope">Declarations and scope</h2> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1417 | |
| 1418 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1419 | A declaration binds a non-<a href="#Blank_identifier">blank</a> |
| 1420 | identifier to a constant, type, variable, function, or package. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1421 | Every identifier in a program must be declared. |
| 1422 | No identifier may be declared twice in the same block, and |
| 1423 | no identifier may be declared in both the file and package block. |
| 1424 | </p> |
| 1425 | |
| 1426 | <pre class="ebnf"> |
| 1427 | Declaration = ConstDecl | TypeDecl | VarDecl . |
| 1428 | TopLevelDecl = Declaration | FunctionDecl | MethodDecl . |
| 1429 | </pre> |
| 1430 | |
| 1431 | <p> |
| 1432 | The <i>scope</i> of a declared identifier is the extent of source text in which |
| 1433 | the identifier denotes the specified constant, type, variable, function, or package. |
| 1434 | </p> |
| 1435 | |
| 1436 | <p> |
| 1437 | Go is lexically scoped using blocks: |
| 1438 | </p> |
| 1439 | |
| 1440 | <ol> |
| 1441 | <li>The scope of a predeclared identifier is the universe block.</li> |
| 1442 | |
| 1443 | <li>The scope of an identifier denoting a constant, type, variable, |
Robert Griesemer | 967a2b3 | 2011-03-03 15:24:28 -0800 | [diff] [blame] | 1444 | or function (but not method) declared at top level (outside any |
| 1445 | function) is the package block.</li> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1446 | |
| 1447 | <li>The scope of an imported package identifier is the file block |
| 1448 | of the file containing the import declaration.</li> |
| 1449 | |
| 1450 | <li>The scope of an identifier denoting a function parameter or |
| 1451 | result variable is the function body.</li> |
| 1452 | |
| 1453 | <li>The scope of a constant or variable identifier declared |
| 1454 | inside a function begins at the end of the ConstSpec or VarSpec |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 1455 | (ShortVarDecl for short variable declarations) |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1456 | and ends at the end of the innermost containing block.</li> |
| 1457 | |
| 1458 | <li>The scope of a type identifier declared inside a function |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1459 | begins at the identifier in the TypeSpec |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1460 | and ends at the end of the innermost containing block.</li> |
| 1461 | </ol> |
| 1462 | |
| 1463 | <p> |
| 1464 | An identifier declared in a block may be redeclared in an inner block. |
| 1465 | While the identifier of the inner declaration is in scope, it denotes |
| 1466 | the entity declared by the inner declaration. |
| 1467 | </p> |
| 1468 | |
| 1469 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1470 | The <a href="#Package_clause">package clause</a> is not a declaration; the package name |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1471 | does not appear in any scope. Its purpose is to identify the files belonging |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1472 | to the same <a href="#Packages">package</a> and to specify the default package name for import |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1473 | declarations. |
| 1474 | </p> |
| 1475 | |
| 1476 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1477 | <h3 id="Label_scopes">Label scopes</h3> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1478 | |
| 1479 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1480 | Labels are declared by <a href="#Labeled_statements">labeled statements</a> and are |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1481 | used in the <code>break</code>, <code>continue</code>, and <code>goto</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1482 | statements (§<a href="#Break_statements">Break statements</a>, §<a href="#Continue_statements">Continue statements</a>, §<a href="#Goto_statements">Goto statements</a>). |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 1483 | It is illegal to define a label that is never used. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1484 | In contrast to other identifiers, labels are not block scoped and do |
| 1485 | not conflict with identifiers that are not labels. The scope of a label |
| 1486 | is the body of the function in which it is declared and excludes |
| 1487 | the body of any nested function. |
| 1488 | </p> |
| 1489 | |
| 1490 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1491 | <h3 id="Predeclared_identifiers">Predeclared identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1492 | |
| 1493 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1494 | The following identifiers are implicitly declared in the universe block: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1495 | </p> |
| 1496 | <pre class="grammar"> |
| 1497 | Basic types: |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1498 | bool byte complex64 complex128 float32 float64 |
| 1499 | int8 int16 int32 int64 string uint8 uint16 uint32 uint64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1500 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1501 | Architecture-specific convenience types: |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1502 | int uint uintptr |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1503 | |
| 1504 | Constants: |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1505 | true false iota |
| 1506 | |
| 1507 | Zero value: |
| 1508 | nil |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1509 | |
| 1510 | Functions: |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 1511 | append cap close complex copy imag len |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 1512 | make new panic print println real recover |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1513 | </pre> |
| 1514 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1515 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1516 | <h3 id="Exported_identifiers">Exported identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1517 | |
| 1518 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1519 | An identifier may be <i>exported</i> to permit access to it from another package |
| 1520 | using a <a href="#Qualified_identifiers">qualified identifier</a>. An identifier |
| 1521 | is exported if both: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1522 | </p> |
| 1523 | <ol> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 1524 | <li>the first character of the identifier's name is a Unicode upper case letter (Unicode class "Lu"); and</li> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1525 | <li>the identifier is declared in the <a href="#Blocks">package block</a> or denotes a field or method of a type |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 1526 | declared in that block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1527 | </ol> |
| 1528 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1529 | All other identifiers are not exported. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1530 | </p> |
| 1531 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1532 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1533 | <h3 id="Blank_identifier">Blank identifier</h3> |
| 1534 | |
| 1535 | <p> |
| 1536 | The <i>blank identifier</i>, represented by the underscore character <code>_</code>, may be used in a declaration like |
| 1537 | any other identifier but the declaration does not introduce a new binding. |
| 1538 | </p> |
| 1539 | |
| 1540 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1541 | <h3 id="Constant_declarations">Constant declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1542 | |
| 1543 | <p> |
| 1544 | A constant declaration binds a list of identifiers (the names of |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1545 | the constants) to the values of a list of <a href="#Constant_expressions">constant expressions</a>. |
| 1546 | The number of identifiers must be equal |
| 1547 | to the number of expressions, and the <i>n</i>th identifier on |
| 1548 | the left is bound to the value of the <i>n</i>th expression on the |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1549 | right. |
| 1550 | </p> |
| 1551 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1552 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1553 | ConstDecl = "const" ( ConstSpec | "(" { ConstSpec ";" } ")" ) . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1554 | ConstSpec = IdentifierList [ [ Type ] "=" ExpressionList ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1555 | |
| 1556 | IdentifierList = identifier { "," identifier } . |
| 1557 | ExpressionList = Expression { "," Expression } . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1558 | </pre> |
| 1559 | |
| 1560 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1561 | If the type is present, all constants take the type specified, and |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1562 | the expressions must be <a href="#Assignability">assignable</a> to that type. |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1563 | If the type is omitted, the constants take the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1564 | individual types of the corresponding expressions. |
| 1565 | If the expression values are untyped <a href="#Constants">constants</a>, |
| 1566 | the declared constants remain untyped and the constant identifiers |
| 1567 | denote the constant values. For instance, if the expression is a |
| 1568 | floating-point literal, the constant identifier denotes a floating-point |
| 1569 | constant, even if the literal's fractional part is zero. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1570 | </p> |
| 1571 | |
| 1572 | <pre> |
| 1573 | const Pi float64 = 3.14159265358979323846 |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1574 | const zero = 0.0 // untyped floating-point constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1575 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1576 | size int64 = 1024 |
| 1577 | eof = -1 // untyped integer constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1578 | ) |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1579 | const a, b, c = 3, 4, "foo" // a = 3, b = 4, c = "foo", untyped integer and string constants |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1580 | const u, v float32 = 0, 3 // u = 0.0, v = 3.0 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1581 | </pre> |
| 1582 | |
| 1583 | <p> |
| 1584 | Within a parenthesized <code>const</code> declaration list the |
| 1585 | expression list may be omitted from any but the first declaration. |
| 1586 | Such an empty list is equivalent to the textual substitution of the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1587 | first preceding non-empty expression list and its type if any. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1588 | Omitting the list of expressions is therefore equivalent to |
| 1589 | repeating the previous list. The number of identifiers must be equal |
| 1590 | to the number of expressions in the previous list. |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1591 | Together with the <a href="#Iota"><code>iota</code> constant generator</a> |
| 1592 | this mechanism permits light-weight declaration of sequential values: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1593 | </p> |
| 1594 | |
| 1595 | <pre> |
| 1596 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1597 | Sunday = iota |
| 1598 | Monday |
| 1599 | Tuesday |
| 1600 | Wednesday |
| 1601 | Thursday |
| 1602 | Friday |
| 1603 | Partyday |
| 1604 | numberOfDays // this constant is not exported |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1605 | ) |
| 1606 | </pre> |
| 1607 | |
| 1608 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1609 | <h3 id="Iota">Iota</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1610 | |
| 1611 | <p> |
Robert Griesemer | 39f009c | 2010-04-29 10:57:27 -0700 | [diff] [blame] | 1612 | Within a <a href="#Constant_declarations">constant declaration</a>, the predeclared identifier |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1613 | <code>iota</code> represents successive untyped integer <a href="#Constants"> |
| 1614 | constants</a>. It is reset to 0 whenever the reserved word <code>const</code> |
Robert Griesemer | 39f009c | 2010-04-29 10:57:27 -0700 | [diff] [blame] | 1615 | appears in the source and increments after each <a href="#ConstSpec">ConstSpec</a>. |
| 1616 | It can be used to construct a set of related constants: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1617 | </p> |
| 1618 | |
| 1619 | <pre> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1620 | const ( // iota is reset to 0 |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1621 | c0 = iota // c0 == 0 |
| 1622 | c1 = iota // c1 == 1 |
| 1623 | c2 = iota // c2 == 2 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1624 | ) |
| 1625 | |
| 1626 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1627 | a = 1 << iota // a == 1 (iota has been reset) |
| 1628 | b = 1 << iota // b == 2 |
| 1629 | c = 1 << iota // c == 4 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1630 | ) |
| 1631 | |
| 1632 | const ( |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1633 | u = iota * 42 // u == 0 (untyped integer constant) |
| 1634 | v float64 = iota * 42 // v == 42.0 (float64 constant) |
| 1635 | w = iota * 42 // w == 84 (untyped integer constant) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1636 | ) |
| 1637 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1638 | const x = iota // x == 0 (iota has been reset) |
| 1639 | const y = iota // y == 0 (iota has been reset) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1640 | </pre> |
| 1641 | |
| 1642 | <p> |
| 1643 | Within an ExpressionList, the value of each <code>iota</code> is the same because |
Robert Griesemer | 39f009c | 2010-04-29 10:57:27 -0700 | [diff] [blame] | 1644 | it is only incremented after each ConstSpec: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1645 | </p> |
| 1646 | |
| 1647 | <pre> |
| 1648 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1649 | bit0, mask0 = 1 << iota, 1 << iota - 1 // bit0 == 1, mask0 == 0 |
| 1650 | bit1, mask1 // bit1 == 2, mask1 == 1 |
| 1651 | _, _ // skips iota == 2 |
| 1652 | bit3, mask3 // bit3 == 8, mask3 == 7 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1653 | ) |
| 1654 | </pre> |
| 1655 | |
| 1656 | <p> |
| 1657 | This last example exploits the implicit repetition of the |
| 1658 | last non-empty expression list. |
| 1659 | </p> |
| 1660 | |
| 1661 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1662 | <h3 id="Type_declarations">Type declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1663 | |
| 1664 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1665 | A type declaration binds an identifier, the <i>type name</i>, to a new type |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1666 | that has the same <a href="#Types">underlying type</a> as |
| 1667 | an existing type. The new type is <a href="#Type_identity">different</a> from |
| 1668 | the existing type. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1669 | </p> |
| 1670 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1671 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1672 | TypeDecl = "type" ( TypeSpec | "(" { TypeSpec ";" } ")" ) . |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1673 | TypeSpec = identifier Type . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1674 | </pre> |
| 1675 | |
| 1676 | <pre> |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1677 | type IntArray [16]int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1678 | |
| 1679 | type ( |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 1680 | Point struct { x, y float64 } |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1681 | Polar Point |
| 1682 | ) |
| 1683 | |
| 1684 | type TreeNode struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1685 | left, right *TreeNode |
| 1686 | value *Comparable |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1687 | } |
| 1688 | |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1689 | type Cipher interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1690 | BlockSize() int |
| 1691 | Encrypt(src, dst []byte) |
| 1692 | Decrypt(src, dst []byte) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1693 | } |
| 1694 | </pre> |
| 1695 | |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1696 | <p> |
| 1697 | The declared type does not inherit any <a href="#Method_declarations">methods</a> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 1698 | bound to the existing type, but the <a href="#Method_sets">method set</a> |
Robert Griesemer | d4a1619 | 2010-04-01 12:48:34 -0700 | [diff] [blame] | 1699 | of an interface type or of elements of a composite type remains unchanged: |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1700 | </p> |
| 1701 | |
| 1702 | <pre> |
Rob Pike | bdbe0de | 2011-05-25 06:00:07 +1000 | [diff] [blame] | 1703 | // A Mutex is a data type with two methods, Lock and Unlock. |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1704 | type Mutex struct { /* Mutex fields */ } |
| 1705 | func (m *Mutex) Lock() { /* Lock implementation */ } |
| 1706 | func (m *Mutex) Unlock() { /* Unlock implementation */ } |
| 1707 | |
| 1708 | // NewMutex has the same composition as Mutex but its method set is empty. |
| 1709 | type NewMutex Mutex |
| 1710 | |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 1711 | // The method set of the <a href="#Pointer_types">base type</a> of PtrMutex remains unchanged, |
| 1712 | // but the method set of PtrMutex is empty. |
| 1713 | type PtrMutex *Mutex |
| 1714 | |
Robert Griesemer | f5b3c14 | 2010-04-27 17:52:44 -0700 | [diff] [blame] | 1715 | // The method set of *PrintableMutex contains the methods |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 1716 | // Lock and Unlock bound to its anonymous field Mutex. |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1717 | type PrintableMutex struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1718 | Mutex |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1719 | } |
Robert Griesemer | 735e00d | 2010-03-31 16:37:22 -0700 | [diff] [blame] | 1720 | |
Robert Griesemer | d4a1619 | 2010-04-01 12:48:34 -0700 | [diff] [blame] | 1721 | // MyCipher is an interface type that has the same method set as Cipher. |
Robert Griesemer | 735e00d | 2010-03-31 16:37:22 -0700 | [diff] [blame] | 1722 | type MyCipher Cipher |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1723 | </pre> |
| 1724 | |
| 1725 | <p> |
| 1726 | A type declaration may be used to define a different boolean, numeric, or string |
| 1727 | type and attach methods to it: |
| 1728 | </p> |
| 1729 | |
| 1730 | <pre> |
| 1731 | type TimeZone int |
| 1732 | |
| 1733 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1734 | EST TimeZone = -(5 + iota) |
| 1735 | CST |
| 1736 | MST |
| 1737 | PST |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1738 | ) |
| 1739 | |
| 1740 | func (tz TimeZone) String() string { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1741 | return fmt.Sprintf("GMT+%dh", tz) |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1742 | } |
| 1743 | </pre> |
| 1744 | |
| 1745 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1746 | <h3 id="Variable_declarations">Variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1747 | |
| 1748 | <p> |
| 1749 | A variable declaration creates a variable, binds an identifier to it and |
| 1750 | gives it a type and optionally an initial value. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1751 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1752 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1753 | VarDecl = "var" ( VarSpec | "(" { VarSpec ";" } ")" ) . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1754 | VarSpec = IdentifierList ( Type [ "=" ExpressionList ] | "=" ExpressionList ) . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1755 | </pre> |
| 1756 | |
| 1757 | <pre> |
| 1758 | var i int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1759 | var U, V, W float64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1760 | var k = 0 |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1761 | var x, y float32 = -1, -2 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1762 | var ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1763 | i int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1764 | u, v, s = 2.0, 3.0, "bar" |
| 1765 | ) |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1766 | var re, im = complexSqrt(-1) |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1767 | var _, found = entries[name] // map lookup; only interested in "found" |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1768 | </pre> |
| 1769 | |
| 1770 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1771 | If a list of expressions is given, the variables are initialized |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1772 | by assigning the expressions to the variables (§<a href="#Assignments">Assignments</a>) |
| 1773 | in order; all expressions must be consumed and all variables initialized from them. |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 1774 | Otherwise, each variable is initialized to its <a href="#The_zero_value">zero value</a>. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1775 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1776 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1777 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1778 | If the type is present, each variable is given that type. |
| 1779 | Otherwise, the types are deduced from the assignment |
| 1780 | of the expression list. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1781 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1782 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1783 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1784 | If the type is absent and the corresponding expression evaluates to an |
| 1785 | untyped <a href="#Constants">constant</a>, the type of the declared variable |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1786 | is <code>bool</code>, <code>int</code>, <code>float64</code>, or <code>string</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1787 | respectively, depending on whether the value is a boolean, integer, |
| 1788 | floating-point, or string constant: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1789 | </p> |
| 1790 | |
| 1791 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1792 | var b = true // t has type bool |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1793 | var i = 0 // i has type int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1794 | var f = 3.0 // f has type float64 |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1795 | var s = "OMDB" // s has type string |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1796 | </pre> |
| 1797 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1798 | <h3 id="Short_variable_declarations">Short variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1799 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1800 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1801 | A <i>short variable declaration</i> uses the syntax: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1802 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1803 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1804 | <pre class="ebnf"> |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 1805 | ShortVarDecl = IdentifierList ":=" ExpressionList . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1806 | </pre> |
| 1807 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1808 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1809 | It is a shorthand for a regular variable declaration with |
| 1810 | initializer expressions but no types: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1811 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1812 | |
| 1813 | <pre class="grammar"> |
| 1814 | "var" IdentifierList = ExpressionList . |
| 1815 | </pre> |
| 1816 | |
| 1817 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1818 | i, j := 0, 10 |
| 1819 | f := func() int { return 7 } |
| 1820 | ch := make(chan int) |
| 1821 | r, w := os.Pipe(fd) // os.Pipe() returns two values |
| 1822 | _, y, _ := coord(p) // coord() returns three values; only interested in y coordinate |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1823 | </pre> |
| 1824 | |
| 1825 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1826 | Unlike regular variable declarations, a short variable declaration may redeclare variables provided they |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1827 | were originally declared in the same block with the same type, and at |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1828 | least one of the non-<a href="#Blank_identifier">blank</a> variables is new. As a consequence, redeclaration |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1829 | can only appear in a multi-variable short declaration. |
| 1830 | Redeclaration does not introduce a new |
| 1831 | variable; it just assigns a new value to the original. |
| 1832 | </p> |
| 1833 | |
| 1834 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1835 | field1, offset := nextField(str, 0) |
| 1836 | field2, offset := nextField(str, offset) // redeclares offset |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1837 | </pre> |
| 1838 | |
| 1839 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1840 | Short variable declarations may appear only inside functions. |
| 1841 | In some contexts such as the initializers for <code>if</code>, |
| 1842 | <code>for</code>, or <code>switch</code> statements, |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1843 | they can be used to declare local temporary variables (§<a href="#Statements">Statements</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1844 | </p> |
| 1845 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1846 | <h3 id="Function_declarations">Function declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1847 | |
| 1848 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1849 | A function declaration binds an identifier to a function (§<a href="#Function_types">Function types</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1850 | </p> |
| 1851 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1852 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1853 | FunctionDecl = "func" identifier Signature [ Body ] . |
Anthony Martin | 11a0161 | 2010-12-13 22:19:41 -0800 | [diff] [blame] | 1854 | Body = Block . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1855 | </pre> |
| 1856 | |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1857 | <p> |
| 1858 | A function declaration may omit the body. Such a declaration provides the |
| 1859 | signature for a function implemented outside Go, such as an assembly routine. |
| 1860 | </p> |
| 1861 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1862 | <pre> |
| 1863 | func min(x int, y int) int { |
| 1864 | if x < y { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1865 | return x |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1866 | } |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1867 | return y |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1868 | } |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1869 | |
| 1870 | func flushICache(begin, end uintptr) // implemented externally |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1871 | </pre> |
| 1872 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1873 | <h3 id="Method_declarations">Method declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1874 | |
| 1875 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 1876 | A method is a function with a <i>receiver</i>. |
| 1877 | A method declaration binds an identifier to a method. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1878 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1879 | <pre class="ebnf"> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 1880 | MethodDecl = "func" Receiver MethodName Signature [ Body ] . |
| 1881 | Receiver = "(" [ identifier ] [ "*" ] BaseTypeName ")" . |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1882 | BaseTypeName = identifier . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1883 | </pre> |
| 1884 | |
| 1885 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1886 | The receiver type must be of the form <code>T</code> or <code>*T</code> where |
| 1887 | <code>T</code> is a type name. <code>T</code> is called the |
| 1888 | <i>receiver base type</i> or just <i>base type</i>. |
| 1889 | The base type must not be a pointer or interface type and must be |
Stephen Ma | 5db1d38 | 2009-09-02 20:09:25 -0700 | [diff] [blame] | 1890 | declared in the same package as the method. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1891 | The method is said to be <i>bound</i> to the base type |
| 1892 | and is visible only within selectors for that type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1893 | (§<a href="#Type_declarations">Type declarations</a>, §<a href="#Selectors">Selectors</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1894 | </p> |
| 1895 | |
| 1896 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1897 | Given type <code>Point</code>, the declarations |
| 1898 | </p> |
| 1899 | |
| 1900 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 1901 | func (p *Point) Length() float64 { |
| 1902 | return math.Sqrt(p.x * p.x + p.y * p.y) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1903 | } |
| 1904 | |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 1905 | func (p *Point) Scale(factor float64) { |
| 1906 | p.x *= factor |
| 1907 | p.y *= factor |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1908 | } |
| 1909 | </pre> |
| 1910 | |
| 1911 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1912 | bind the methods <code>Length</code> and <code>Scale</code>, |
| 1913 | with receiver type <code>*Point</code>, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1914 | to the base type <code>Point</code>. |
| 1915 | </p> |
| 1916 | |
| 1917 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 1918 | If the receiver's value is not referenced inside the body of the method, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1919 | its identifier may be omitted in the declaration. The same applies in |
| 1920 | general to parameters of functions and methods. |
| 1921 | </p> |
| 1922 | |
| 1923 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1924 | The type of a method is the type of a function with the receiver as first |
| 1925 | argument. For instance, the method <code>Scale</code> has type |
| 1926 | </p> |
| 1927 | |
| 1928 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 1929 | func(p *Point, factor float64) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1930 | </pre> |
| 1931 | |
| 1932 | <p> |
| 1933 | However, a function declared this way is not a method. |
| 1934 | </p> |
| 1935 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1936 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1937 | <h2 id="Expressions">Expressions</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1938 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1939 | <p> |
| 1940 | An expression specifies the computation of a value by applying |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1941 | operators and functions to operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1942 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1943 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1944 | <h3 id="Operands">Operands</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1945 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1946 | <p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1947 | Operands denote the elementary values in an expression. |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1948 | </p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1949 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1950 | <pre class="ebnf"> |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 1951 | Operand = Literal | QualifiedIdent | MethodExpr | "(" Expression ")" . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1952 | Literal = BasicLit | CompositeLit | FunctionLit . |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 1953 | BasicLit = int_lit | float_lit | imaginary_lit | char_lit | string_lit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1954 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1955 | |
| 1956 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1957 | <h3 id="Qualified_identifiers">Qualified identifiers</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1958 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1959 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1960 | A qualified identifier is a non-<a href="#Blank_identifier">blank</a> identifier qualified by a package name prefix. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1961 | </p> |
Robert Griesemer | 337af31 | 2008-11-17 18:11:36 -0800 | [diff] [blame] | 1962 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1963 | <pre class="ebnf"> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1964 | QualifiedIdent = [ PackageName "." ] identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1965 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1966 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1967 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1968 | A qualified identifier accesses an identifier in a separate package. |
| 1969 | The identifier must be <a href="#Exported_identifiers">exported</a> by that |
| 1970 | package, which means that it must begin with a Unicode upper case letter. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1971 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1972 | |
| 1973 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1974 | math.Sin |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1975 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1976 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 1977 | <!-- |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1978 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 1979 | <span class="alert">TODO: Unify this section with Selectors - it's the same syntax.</span> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1980 | </p> |
Rob Pike | 38d7bcf | 2011-05-08 14:05:18 -0700 | [diff] [blame] | 1981 | --> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1982 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1983 | <h3 id="Composite_literals">Composite literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1984 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1985 | <p> |
| 1986 | Composite literals construct values for structs, arrays, slices, and maps |
| 1987 | and create a new value each time they are evaluated. |
| 1988 | They consist of the type of the value |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1989 | followed by a brace-bound list of composite elements. An element may be |
| 1990 | a single expression or a key-value pair. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1991 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1992 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1993 | <pre class="ebnf"> |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 1994 | CompositeLit = LiteralType LiteralValue . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1995 | LiteralType = StructType | ArrayType | "[" "..." "]" ElementType | |
Robert Griesemer | 07cc644 | 2010-07-29 18:13:41 -0700 | [diff] [blame] | 1996 | SliceType | MapType | TypeName . |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 1997 | LiteralValue = "{" [ ElementList [ "," ] ] "}" . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1998 | ElementList = Element { "," Element } . |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1999 | Element = [ Key ":" ] Value . |
Robert Griesemer | fb5fce5 | 2009-11-09 12:35:56 -0800 | [diff] [blame] | 2000 | Key = FieldName | ElementIndex . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2001 | FieldName = identifier . |
Robert Griesemer | fb5fce5 | 2009-11-09 12:35:56 -0800 | [diff] [blame] | 2002 | ElementIndex = Expression . |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2003 | Value = Expression | LiteralValue . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2004 | </pre> |
Robert Griesemer | 0976e34 | 2008-09-03 13:37:44 -0700 | [diff] [blame] | 2005 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2006 | <p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2007 | The LiteralType must be a struct, array, slice, or map type |
| 2008 | (the grammar enforces this constraint except when the type is given |
| 2009 | as a TypeName). |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 2010 | The types of the expressions must be <a href="#Assignability">assignable</a> |
| 2011 | to the respective field, element, and key types of the LiteralType; |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2012 | there is no additional conversion. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2013 | The key is interpreted as a field name for struct literals, |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2014 | an index expression for array and slice literals, and a key for map literals. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2015 | For map literals, all elements must have a key. It is an error |
| 2016 | to specify multiple elements with the same field name or |
| 2017 | constant key value. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2018 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2019 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2020 | <p> |
| 2021 | For struct literals the following rules apply: |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 2022 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2023 | <ul> |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 2024 | <li>A key must be a field name declared in the LiteralType. |
| 2025 | </li> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2026 | <li>A literal that does not contain any keys must |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2027 | list an element for each struct field in the |
| 2028 | order in which the fields are declared. |
| 2029 | </li> |
| 2030 | <li>If any element has a key, every element must have a key. |
| 2031 | </li> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2032 | <li>A literal that contains keys does not need to |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2033 | have an element for each struct field. Omitted fields |
| 2034 | get the zero value for that field. |
| 2035 | </li> |
| 2036 | <li>A literal may omit the element list; such a literal evaluates |
| 2037 | to the zero value for its type. |
| 2038 | </li> |
| 2039 | <li>It is an error to specify an element for a non-exported |
| 2040 | field of a struct belonging to a different package. |
| 2041 | </li> |
| 2042 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2043 | |
| 2044 | <p> |
| 2045 | Given the declarations |
| 2046 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2047 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2048 | type Point3D struct { x, y, z float64 } |
| 2049 | type Line struct { p, q Point3D } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2050 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2051 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2052 | <p> |
| 2053 | one may write |
| 2054 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2055 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2056 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2057 | origin := Point3D{} // zero value for Point3D |
| 2058 | line := Line{origin, Point3D{y: -4, z: 12.3}} // zero value for line.q.x |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2059 | </pre> |
| 2060 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 2061 | <p> |
| 2062 | For array and slice literals the following rules apply: |
| 2063 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2064 | <ul> |
| 2065 | <li>Each element has an associated integer index marking |
| 2066 | its position in the array. |
| 2067 | </li> |
| 2068 | <li>An element with a key uses the key as its index; the |
| 2069 | key must be a constant integer expression. |
| 2070 | </li> |
| 2071 | <li>An element without a key uses the previous element's index plus one. |
| 2072 | If the first element has no key, its index is zero. |
| 2073 | </li> |
| 2074 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2075 | |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2076 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2077 | Taking the address of a composite literal (§<a href="#Address_operators">Address operators</a>) |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 2078 | generates a pointer to a unique instance of the literal's value. |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2079 | </p> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2080 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2081 | var pointer *Point3D = &Point3D{y: 1000} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2082 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2083 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2084 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 2085 | The length of an array literal is the length specified in the LiteralType. |
| 2086 | 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] | 2087 | elements are set to the zero value for the array element type. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2088 | It is an error to provide elements with index values outside the index range |
| 2089 | of the array. The notation <code>...</code> specifies an array length equal |
| 2090 | to the maximum element index plus one. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2091 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2092 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2093 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2094 | buffer := [10]string{} // len(buffer) == 10 |
| 2095 | intSet := [6]int{1, 2, 3, 5} // len(intSet) == 6 |
| 2096 | days := [...]string{"Sat", "Sun"} // len(days) == 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2097 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2098 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2099 | <p> |
| 2100 | A slice literal describes the entire underlying array literal. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2101 | Thus, the length and capacity of a slice literal are the maximum |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2102 | element index plus one. A slice literal has the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2103 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2104 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2105 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2106 | []T{x1, x2, … xn} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2107 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2108 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2109 | <p> |
| 2110 | and is a shortcut for a slice operation applied to an array literal: |
| 2111 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2112 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2113 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2114 | [n]T{x1, x2, … xn}[0 : n] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2115 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2116 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2117 | <p> |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2118 | Within a composite literal of array, slice, or map type <code>T</code>, |
| 2119 | elements that are themselves composite literals may elide the respective |
| 2120 | literal type if it is identical to the element type of <code>T</code>. |
| 2121 | </p> |
| 2122 | |
| 2123 | <pre> |
| 2124 | [...]Point{{1.5, -3.5}, {0, 0}} // same as [...]Point{Point{1.5, -3.5}, Point{0, 0}} |
| 2125 | [][]int{{1, 2, 3}, {4, 5}} // same as [][]int{[]int{1, 2, 3}, []int{4, 5}} |
| 2126 | </pre> |
| 2127 | |
| 2128 | <p> |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2129 | A parsing ambiguity arises when a composite literal using the |
Robert Griesemer | 07cc644 | 2010-07-29 18:13:41 -0700 | [diff] [blame] | 2130 | TypeName form of the LiteralType appears between the |
| 2131 | <a href="#Keywords">keyword</a> and the opening brace of the block of an |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2132 | "if", "for", or "switch" statement, because the braces surrounding |
| 2133 | the expressions in the literal are confused with those introducing |
Robert Griesemer | 07cc644 | 2010-07-29 18:13:41 -0700 | [diff] [blame] | 2134 | the block of statements. To resolve the ambiguity in this rare case, |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2135 | the composite literal must appear within |
| 2136 | parentheses. |
| 2137 | </p> |
| 2138 | |
| 2139 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2140 | if x == (T{a,b,c}[i]) { … } |
| 2141 | if (x == T{a,b,c}[i]) { … } |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2142 | </pre> |
| 2143 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2144 | <p> |
| 2145 | Examples of valid array, slice, and map literals: |
| 2146 | </p> |
| 2147 | |
| 2148 | <pre> |
| 2149 | // list of prime numbers |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2150 | primes := []int{2, 3, 5, 7, 9, 11, 13, 17, 19, 991} |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2151 | |
| 2152 | // vowels[ch] is true if ch is a vowel |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2153 | vowels := [128]bool{'a': true, 'e': true, 'i': true, 'o': true, 'u': true, 'y': true} |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2154 | |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2155 | // the array [10]float32{-1, 0, 0, 0, -0.1, -0.1, 0, 0, 0, -1} |
| 2156 | filter := [10]float32{-1, 4: -0.1, -0.1, 9: -1} |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2157 | |
| 2158 | // frequencies in Hz for equal-tempered scale (A4 = 440Hz) |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2159 | noteFrequency := map[string]float32{ |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2160 | "C0": 16.35, "D0": 18.35, "E0": 20.60, "F0": 21.83, |
| 2161 | "G0": 24.50, "A0": 27.50, "B0": 30.87, |
| 2162 | } |
| 2163 | </pre> |
| 2164 | |
| 2165 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2166 | <h3 id="Function_literals">Function literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2167 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2168 | <p> |
| 2169 | A function literal represents an anonymous function. |
| 2170 | It consists of a specification of the function type and a function body. |
| 2171 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2172 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2173 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 2174 | FunctionLit = FunctionType Body . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2175 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2176 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2177 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2178 | func(a, b int, z float64) bool { return a*b < int(z) } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2179 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2180 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2181 | <p> |
| 2182 | A function literal can be assigned to a variable or invoked directly. |
| 2183 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2184 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2185 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2186 | f := func(x, y int) int { return x + y } |
| 2187 | func(ch chan int) { ch <- ACK } (reply_chan) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2188 | </pre> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2189 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2190 | <p> |
| 2191 | Function literals are <i>closures</i>: they may refer to variables |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 2192 | defined in a surrounding function. Those variables are then shared between |
| 2193 | the surrounding function and the function literal, and they survive as long |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2194 | as they are accessible. |
| 2195 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2196 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2197 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2198 | <h3 id="Primary_expressions">Primary expressions</h3> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2199 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 2200 | <p> |
| 2201 | Primary expressions are the operands for unary and binary expressions. |
| 2202 | </p> |
| 2203 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2204 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2205 | PrimaryExpr = |
| 2206 | Operand | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 2207 | Conversion | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 2208 | BuiltinCall | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2209 | PrimaryExpr Selector | |
| 2210 | PrimaryExpr Index | |
| 2211 | PrimaryExpr Slice | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2212 | PrimaryExpr TypeAssertion | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2213 | PrimaryExpr Call . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2214 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2215 | Selector = "." identifier . |
| 2216 | Index = "[" Expression "]" . |
Scott Lawrence | 0c1695b | 2010-09-07 14:30:17 -0700 | [diff] [blame] | 2217 | Slice = "[" [ Expression ] ":" [ Expression ] "]" . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2218 | TypeAssertion = "." "(" Type ")" . |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2219 | Call = "(" [ ArgumentList [ "," ] ] ")" . |
| 2220 | ArgumentList = ExpressionList [ "..." ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2221 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2222 | |
| 2223 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2224 | <pre> |
| 2225 | x |
| 2226 | 2 |
| 2227 | (s + ".txt") |
| 2228 | f(3.1415, true) |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2229 | Point{1, 2} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2230 | m["foo"] |
| 2231 | s[i : j + 1] |
| 2232 | obj.color |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2233 | math.Sin |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2234 | f.p[i].x() |
| 2235 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2236 | |
| 2237 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2238 | <h3 id="Selectors">Selectors</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2239 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2240 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2241 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2242 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2243 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2244 | <pre> |
| 2245 | x.f |
| 2246 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2247 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2248 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2249 | denotes the field or method <code>f</code> of the value denoted by <code>x</code> |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 2250 | (or sometimes <code>*x</code>; see below). The identifier <code>f</code> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2251 | is called the (field or method) |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 2252 | <i>selector</i>; it must not be the <a href="#Blank_identifier">blank identifier</a>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2253 | The type of the expression is the type of <code>f</code>. |
| 2254 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2255 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2256 | A selector <code>f</code> may denote a field or method <code>f</code> of |
| 2257 | a type <code>T</code>, or it may refer |
| 2258 | to a field or method <code>f</code> of a nested anonymous field of |
| 2259 | <code>T</code>. |
| 2260 | The number of anonymous fields traversed |
| 2261 | to reach <code>f</code> is called its <i>depth</i> in <code>T</code>. |
| 2262 | The depth of a field or method <code>f</code> |
| 2263 | declared in <code>T</code> is zero. |
| 2264 | The depth of a field or method <code>f</code> declared in |
| 2265 | an anonymous field <code>A</code> in <code>T</code> is the |
| 2266 | depth of <code>f</code> in <code>A</code> plus one. |
| 2267 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2268 | <p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2269 | The following rules apply to selectors: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2270 | </p> |
| 2271 | <ol> |
| 2272 | <li> |
| 2273 | For a value <code>x</code> of type <code>T</code> or <code>*T</code> |
| 2274 | where <code>T</code> is not an interface type, |
| 2275 | <code>x.f</code> denotes the field or method at the shallowest depth |
| 2276 | in <code>T</code> where there |
| 2277 | is such an <code>f</code>. |
| 2278 | 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] | 2279 | expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2280 | </li> |
| 2281 | <li> |
Rob Pike | e041b99 | 2011-02-19 15:04:56 -0800 | [diff] [blame] | 2282 | For a variable <code>x</code> of type <code>I</code> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2283 | where <code>I</code> is an interface type, |
| 2284 | <code>x.f</code> denotes the actual method with name <code>f</code> of the value assigned |
| 2285 | to <code>x</code> if there is such a method. |
| 2286 | If no value or <code>nil</code> was assigned to <code>x</code>, <code>x.f</code> is illegal. |
| 2287 | </li> |
| 2288 | <li> |
| 2289 | In all other cases, <code>x.f</code> is illegal. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 2290 | </li> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2291 | </ol> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2292 | <p> |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 2293 | Selectors automatically dereference pointers to structs. |
| 2294 | If <code>x</code> is a pointer to a struct, <code>x.y</code> |
| 2295 | is shorthand for <code>(*x).y</code>; if the field <code>y</code> |
| 2296 | is also a pointer to a struct, <code>x.y.z</code> is shorthand |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2297 | for <code>(*(*x).y).z</code>, and so on. |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 2298 | If <code>x</code> contains an anonymous field of type <code>*A</code>, |
| 2299 | where <code>A</code> is also a struct type, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2300 | <code>x.f</code> is a shortcut for <code>(*x.A).f</code>. |
| 2301 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2302 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2303 | For example, given the declarations: |
| 2304 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2305 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2306 | <pre> |
| 2307 | type T0 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2308 | x int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2309 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2310 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2311 | func (recv *T0) M0() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2312 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2313 | type T1 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2314 | y int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2315 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2316 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2317 | func (recv T1) M1() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2318 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2319 | type T2 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2320 | z int |
| 2321 | T1 |
| 2322 | *T0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2323 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2324 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2325 | func (recv *T2) M2() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2326 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2327 | var p *T2 // with p != nil and p.T1 != nil |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2328 | </pre> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2329 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2330 | <p> |
| 2331 | one may write: |
| 2332 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2333 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2334 | <pre> |
| 2335 | p.z // (*p).z |
| 2336 | p.y // ((*p).T1).y |
| 2337 | p.x // (*(*p).T0).x |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2338 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2339 | p.M2 // (*p).M2 |
| 2340 | p.M1 // ((*p).T1).M1 |
| 2341 | p.M0 // ((*p).T0).M0 |
| 2342 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2343 | |
| 2344 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2345 | <!-- |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2346 | <span class="alert"> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2347 | TODO: Specify what happens to receivers. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 2348 | </span> |
Rob Pike | 38d7bcf | 2011-05-08 14:05:18 -0700 | [diff] [blame] | 2349 | --> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2350 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2351 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2352 | <h3 id="Indexes">Indexes</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2353 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2354 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2355 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2356 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2357 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2358 | <pre> |
| 2359 | a[x] |
| 2360 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2361 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2362 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2363 | denotes the element of the array, slice, string or map <code>a</code> indexed by <code>x</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2364 | The value <code>x</code> is called the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2365 | <i>index</i> or <i>map key</i>, respectively. The following |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2366 | rules apply: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2367 | </p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2368 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2369 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2370 | For <code>a</code> of type <code>A</code> or <code>*A</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2371 | where <code>A</code> is an <a href="#Array_types">array type</a>, |
| 2372 | or for <code>a</code> of type <code>S</code> where <code>S</code> is a <a href="#Slice_types">slice type</a>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2373 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2374 | <ul> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2375 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code></li> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2376 | <li><code>a[x]</code> is the array element at index <code>x</code> and the type of |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2377 | <code>a[x]</code> is the element type of <code>A</code></li> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2378 | <li>if <code>a</code> is <code>nil</code> or if the index <code>x</code> is out of range, |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 2379 | a <a href="#Run_time_panics">run-time panic</a> occurs</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2380 | </ul> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2381 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2382 | <p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2383 | For <code>a</code> of type <code>T</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2384 | where <code>T</code> is a <a href="#String_types">string type</a>: |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2385 | </p> |
| 2386 | <ul> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2387 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code></li> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2388 | <li><code>a[x]</code> is the byte at index <code>x</code> and the type of |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2389 | <code>a[x]</code> is <code>byte</code></li> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 2390 | <li><code>a[x]</code> may not be assigned to</li> |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 2391 | <li>if the index <code>x</code> is out of range, |
| 2392 | a <a href="#Run_time_panics">run-time panic</a> occurs</li> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2393 | </ul> |
| 2394 | |
| 2395 | <p> |
| 2396 | For <code>a</code> of type <code>M</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2397 | where <code>M</code> is a <a href="#Map_types">map type</a>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2398 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2399 | <ul> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2400 | <li><code>x</code>'s type must be |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 2401 | <a href="#Assignability">assignable</a> |
| 2402 | to the key type of <code>M</code></li> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2403 | <li>if the map contains an entry with key <code>x</code>, |
| 2404 | <code>a[x]</code> is the map value with key <code>x</code> |
| 2405 | and the type of <code>a[x]</code> is the value type of <code>M</code></li> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2406 | <li>if the map is <code>nil</code> or does not contain such an entry, |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2407 | <code>a[x]</code> is the <a href="#The_zero_value">zero value</a> |
| 2408 | for the value type of <code>M</code></li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2409 | </ul> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2410 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2411 | <p> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2412 | Otherwise <code>a[x]</code> is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2413 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2414 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2415 | <p> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2416 | An index expression on a map <code>a</code> of type <code>map[K]V</code> |
| 2417 | may be used in an assignment or initialization of the special form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2418 | </p> |
| 2419 | |
| 2420 | <pre> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2421 | v, ok = a[x] |
| 2422 | v, ok := a[x] |
| 2423 | var v, ok = a[x] |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2424 | </pre> |
| 2425 | |
| 2426 | <p> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2427 | where the result of the index expression is a pair of values with types |
| 2428 | <code>(V, bool)</code>. In this form, the value of <code>ok</code> is |
| 2429 | <code>true</code> if the key <code>x</code> is present in the map, and |
| 2430 | <code>false</code> otherwise. The value of <code>v</code> is the value |
| 2431 | <code>a[x]</code> as in the single-result form. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2432 | </p> |
| 2433 | |
| 2434 | <p> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2435 | Similarly, if an assignment to a map element has the special form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2436 | </p> |
| 2437 | |
| 2438 | <pre> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2439 | a[x] = v, ok |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2440 | </pre> |
| 2441 | |
| 2442 | <p> |
| 2443 | and boolean <code>ok</code> has the value <code>false</code>, |
| 2444 | the entry for key <code>x</code> is deleted from the map; if |
| 2445 | <code>ok</code> is <code>true</code>, the construct acts like |
| 2446 | a regular assignment to an element of the map. |
| 2447 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2448 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2449 | <p> |
| 2450 | Assigning to an element of a <code>nil</code> map causes a |
| 2451 | <a href="#Run_time_panics">run-time panic</a>. |
| 2452 | </p> |
| 2453 | |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2454 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2455 | <h3 id="Slices">Slices</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2456 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2457 | <p> |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2458 | For a string, array, or slice <code>a</code>, the primary expression |
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> |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2462 | a[low : high] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2463 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2464 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2465 | <p> |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2466 | constructs a substring or slice. The index expressions <code>low</code> and |
| 2467 | <code>high</code> select which elements appear in the result. The result has |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2468 | indexes starting at 0 and length equal to |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2469 | <code>high</code> - <code>low</code>. |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2470 | After slicing the array <code>a</code> |
| 2471 | </p> |
| 2472 | |
| 2473 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2474 | a := [5]int{1, 2, 3, 4, 5} |
| 2475 | s := a[1:4] |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2476 | </pre> |
| 2477 | |
| 2478 | <p> |
| 2479 | the slice <code>s</code> has type <code>[]int</code>, length 3, capacity 4, and elements |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2480 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2481 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2482 | <pre> |
| 2483 | s[0] == 2 |
| 2484 | s[1] == 3 |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2485 | s[2] == 4 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2486 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2487 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2488 | <p> |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2489 | For convenience, any of the index expressions may be omitted. A missing <code>low</code> |
| 2490 | index defaults to zero; a missing <code>high</code> index defaults to the length of the |
| 2491 | sliced operand: |
Scott Lawrence | 0c1695b | 2010-09-07 14:30:17 -0700 | [diff] [blame] | 2492 | </p> |
| 2493 | |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2494 | <pre> |
| 2495 | a[2:] // same a[2 : len(a)] |
| 2496 | a[:3] // same as a[0 : 3] |
| 2497 | a[:] // same as a[0 : len(a)] |
| 2498 | </pre> |
| 2499 | |
Scott Lawrence | 0c1695b | 2010-09-07 14:30:17 -0700 | [diff] [blame] | 2500 | <p> |
| 2501 | For arrays or strings, the indexes <code>low</code> and <code>high</code> must |
| 2502 | satisfy 0 <= <code>low</code> <= <code>high</code> <= length; for |
| 2503 | slices, the upper bound is the capacity rather than the length. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2504 | </p> |
| 2505 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2506 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2507 | If the sliced operand is a string or slice, the result of the slice operation |
| 2508 | is a string or slice of the same type. |
Robert Griesemer | c423e95 | 2010-09-02 10:16:31 -0700 | [diff] [blame] | 2509 | If the sliced operand is an array, it must be <a href="#Address_operators">addressable</a> |
| 2510 | and the result of the slice operation is a slice with the same element type as the array. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2511 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2512 | |
| 2513 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2514 | <h3 id="Type_assertions">Type assertions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2515 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2516 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 2517 | For an expression <code>x</code> of <a href="#Interface_types">interface type</a> |
| 2518 | and a type <code>T</code>, the primary expression |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2519 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2520 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2521 | <pre> |
| 2522 | x.(T) |
| 2523 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2524 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2525 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 2526 | asserts that <code>x</code> is not <code>nil</code> |
Russ Cox | b89a54e | 2009-05-20 18:16:04 -0700 | [diff] [blame] | 2527 | and that the value stored in <code>x</code> is of type <code>T</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2528 | The notation <code>x.(T)</code> is called a <i>type assertion</i>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2529 | </p> |
| 2530 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2531 | More precisely, if <code>T</code> is not an interface type, <code>x.(T)</code> asserts |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 2532 | that the dynamic type of <code>x</code> is <a href="#Type_identity">identical</a> |
| 2533 | to the type <code>T</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2534 | If <code>T</code> is an interface type, <code>x.(T)</code> asserts that the dynamic type |
Rob Pike | 632a985 | 2010-01-13 12:06:33 +1100 | [diff] [blame] | 2535 | of <code>x</code> implements the interface <code>T</code> (§<a href="#Interface_types">Interface types</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2536 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2537 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2538 | If the type assertion holds, the value of the expression is the value |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 2539 | stored in <code>x</code> and its type is <code>T</code>. If the type assertion is false, |
| 2540 | a <a href="#Run_time_panics">run-time panic</a> occurs. |
| 2541 | In other words, even though the dynamic type of <code>x</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2542 | 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] | 2543 | known to be <code>T</code> in a correct program. |
| 2544 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2545 | <p> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2546 | If a type assertion is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2547 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2548 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2549 | <pre> |
| 2550 | v, ok = x.(T) |
| 2551 | v, ok := x.(T) |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2552 | var v, ok = x.(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2553 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2554 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2555 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2556 | the result of the assertion is a pair of values with types <code>(T, bool)</code>. |
| 2557 | 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] | 2558 | otherwise, the expression returns <code>(Z, false)</code> where <code>Z</code> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 2559 | is the <a href="#The_zero_value">zero value</a> for type <code>T</code>. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 2560 | No run-time panic occurs in this case. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2561 | The type assertion in this construct thus acts like a function call |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2562 | returning a value and a boolean indicating success. (§<a href="#Assignments">Assignments</a>) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2563 | </p> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2564 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2565 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2566 | <h3 id="Calls">Calls</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2567 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2568 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2569 | Given an expression <code>f</code> of function type |
| 2570 | <code>F</code>, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2571 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2572 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2573 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2574 | f(a1, a2, … an) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2575 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2576 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2577 | <p> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2578 | calls <code>f</code> with arguments <code>a1, a2, … an</code>. |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 2579 | Except for one special case, arguments must be single-valued expressions |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 2580 | <a href="#Assignability">assignable</a> to the parameter types of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2581 | <code>F</code> and are evaluated before the function is called. |
| 2582 | The type of the expression is the result type |
| 2583 | of <code>F</code>. |
| 2584 | A method invocation is similar but the method itself |
| 2585 | is specified as a selector upon a value of the receiver type for |
| 2586 | the method. |
| 2587 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2588 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2589 | <pre> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 2590 | math.Atan2(x, y) // function call |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2591 | var pt *Point |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2592 | pt.Scale(3.5) // method call with receiver pt |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2593 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2594 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2595 | <p> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 2596 | As a special case, if the return parameters of a function or method |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 2597 | <code>g</code> are equal in number and individually |
| 2598 | assignable to the parameters of another function or method |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 2599 | <code>f</code>, then the call <code>f(g(<i>parameters_of_g</i>))</code> |
| 2600 | will invoke <code>f</code> after binding the return values of |
| 2601 | <code>g</code> to the parameters of <code>f</code> in order. The call |
| 2602 | of <code>f</code> must contain no parameters other than the call of <code>g</code>. |
| 2603 | If <code>f</code> has a final <code>...</code> parameter, it is |
| 2604 | assigned the return values of <code>g</code> that remain after |
| 2605 | assignment of regular parameters. |
| 2606 | </p> |
| 2607 | |
| 2608 | <pre> |
| 2609 | func Split(s string, pos int) (string, string) { |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2610 | return s[0:pos], s[pos:] |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 2611 | } |
| 2612 | |
| 2613 | func Join(s, t string) string { |
| 2614 | return s + t |
| 2615 | } |
| 2616 | |
| 2617 | if Join(Split(value, len(value)/2)) != value { |
Robert Griesemer | 7fc4e37 | 2011-02-01 12:51:10 -0800 | [diff] [blame] | 2618 | log.Panic("test fails") |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 2619 | } |
| 2620 | </pre> |
| 2621 | |
| 2622 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 2623 | A method call <code>x.m()</code> is valid if the <a href="#Method_sets">method set</a> |
| 2624 | of (the type of) <code>x</code> contains <code>m</code> and the |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 2625 | argument list can be assigned to the parameter list of <code>m</code>. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2626 | If <code>x</code> is <a href="#Address_operators">addressable</a> and <code>&x</code>'s method |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 2627 | set contains <code>m</code>, <code>x.m()</code> is shorthand |
| 2628 | for <code>(&x).m()</code>: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2629 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2630 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2631 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2632 | var p Point |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2633 | p.Scale(3.5) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2634 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2635 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2636 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2637 | There is no distinct method type and there are no method literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2638 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2639 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2640 | <h3 id="Passing_arguments_to_..._parameters">Passing arguments to <code>...</code> parameters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2641 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2642 | <p> |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 2643 | If <code>f</code> is variadic with final parameter type <code>...T</code>, |
| 2644 | then within the function the argument is equivalent to a parameter of type |
| 2645 | <code>[]T</code>. At each call of <code>f</code>, the argument |
| 2646 | passed to the final parameter is |
| 2647 | a new slice of type <code>[]T</code> whose successive elements are |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2648 | the actual arguments, which all must be <a href="#Assignability">assignable</a> |
| 2649 | to the type <code>T</code>. The length of the slice is therefore the number of |
| 2650 | arguments bound to the final parameter and may differ for each call site. |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2651 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2652 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2653 | <p> |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2654 | Given the function and call |
| 2655 | </p> |
| 2656 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2657 | func Greeting(prefix string, who ...string) |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2658 | Greeting("hello:", "Joe", "Anna", "Eileen") |
| 2659 | </pre> |
| 2660 | |
| 2661 | <p> |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2662 | within <code>Greeting</code>, <code>who</code> will have the value |
Joe Poirier | d4c8a54 | 2010-09-20 10:51:05 -0700 | [diff] [blame] | 2663 | <code>[]string{"Joe", "Anna", "Eileen"}</code> |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2664 | </p> |
| 2665 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2666 | <p> |
Robert Griesemer | 904adfd | 2010-10-27 10:44:31 -0700 | [diff] [blame] | 2667 | If the final argument is assignable to a slice type <code>[]T</code>, it may be |
| 2668 | passed unchanged as the value for a <code>...T</code> parameter if the argument |
| 2669 | is followed by <code>...</code>. In this case no new slice is created. |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2670 | </p> |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2671 | |
| 2672 | <p> |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2673 | Given the slice <code>s</code> and call |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 2674 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2675 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 2676 | <pre> |
| 2677 | s := []string{"James", "Jasmine"} |
| 2678 | Greeting("goodbye:", s...) |
| 2679 | </pre> |
| 2680 | |
| 2681 | <p> |
| 2682 | within <code>Greeting</code>, <code>who</code> will have the same value as <code>s</code> |
| 2683 | with the same underlying array. |
| 2684 | </p> |
| 2685 | |
| 2686 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2687 | <h3 id="Operators">Operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2688 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2689 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2690 | Operators combine operands into expressions. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2691 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2692 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2693 | <pre class="ebnf"> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2694 | Expression = UnaryExpr | Expression binary_op UnaryExpr . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2695 | UnaryExpr = PrimaryExpr | unary_op UnaryExpr . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2696 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 2697 | binary_op = "||" | "&&" | rel_op | add_op | mul_op . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2698 | rel_op = "==" | "!=" | "<" | "<=" | ">" | ">=" . |
| 2699 | add_op = "+" | "-" | "|" | "^" . |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2700 | mul_op = "*" | "/" | "%" | "<<" | ">>" | "&" | "&^" . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2701 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2702 | unary_op = "+" | "-" | "!" | "^" | "*" | "&" | "<-" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2703 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2704 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2705 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2706 | Comparisons are discussed <a href="#Comparison_operators">elsewhere</a>. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 2707 | For other binary operators, the operand types must be <a href="#Type_identity">identical</a> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2708 | unless the operation involves shifts or untyped <a href="#Constants">constants</a>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2709 | For operations involving constants only, see the section on |
| 2710 | <a href="#Constant_expressions">constant expressions</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2711 | </p> |
Robert Griesemer | c8e1876 | 2008-09-12 12:26:22 -0700 | [diff] [blame] | 2712 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2713 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2714 | Except for shift operations, if one operand is an untyped <a href="#Constants">constant</a> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2715 | and the other operand is not, the constant is <a href="#Conversions">converted</a> |
| 2716 | to the type of the other operand. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2717 | </p> |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 2718 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2719 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2720 | The right operand in a shift expression must have unsigned integer type |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2721 | or be an untyped constant that can be converted to unsigned integer type. |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2722 | If the left operand of a non-constant shift expression is an untyped constant, |
| 2723 | the type of the constant is what it would be if the shift expression were |
Robert Griesemer | 636c5fa | 2011-06-08 09:11:18 -0700 | [diff] [blame] | 2724 | replaced by its left operand alone; the type is <code>int</code> if it cannot |
| 2725 | be determined from the context (for instance, if the shift expression is an |
| 2726 | operand in a comparison against an untyped constant). |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2727 | </p> |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 2728 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2729 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2730 | var s uint = 33 |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2731 | var i = 1<<s // 1 has type int |
| 2732 | var j int32 = 1<<s // 1 has type int32; j == 0 |
| 2733 | var k = uint64(1<<s) // 1 has type uint64; k == 1<<33 |
| 2734 | var m int = 1.0<<s // legal: 1.0 has type int |
Robert Griesemer | 636c5fa | 2011-06-08 09:11:18 -0700 | [diff] [blame] | 2735 | var n = 1.0<<s != 0 // legal: 1.0 has type int; n == false if ints are 32bits in size |
| 2736 | var o = 1<<s == 2<<s // legal: 1 and 2 have type int; o == true if ints are 32bits in size |
| 2737 | var p = 1<<s == 1<<33 // illegal if ints are 32bits in size: 1 has type int, but 1<<33 overflows int |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2738 | var u = 1.0<<s // illegal: 1.0 has type float64, cannot shift |
| 2739 | var v float32 = 1<<s // illegal: 1 has type float32, cannot shift |
| 2740 | var w int64 = 1.0<<33 // legal: 1.0<<33 is a constant shift expression |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2741 | </pre> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2742 | |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2743 | <h3 id="Operator_precedence">Operator precedence</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2744 | <p> |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2745 | Unary operators have the highest precedence. |
| 2746 | As the <code>++</code> and <code>--</code> operators form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2747 | statements, not expressions, they fall |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2748 | outside the operator hierarchy. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2749 | As a consequence, statement <code>*p++</code> is the same as <code>(*p)++</code>. |
| 2750 | <p> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 2751 | There are five precedence levels for binary operators. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2752 | Multiplication operators bind strongest, followed by addition |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 2753 | operators, comparison operators, <code>&&</code> (logical and), |
| 2754 | and finally <code>||</code> (logical or): |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2755 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2756 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2757 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2758 | Precedence Operator |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 2759 | 5 * / % << >> & &^ |
| 2760 | 4 + - | ^ |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 2761 | 3 == != < <= > >= |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2762 | 2 && |
| 2763 | 1 || |
| 2764 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2765 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2766 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2767 | Binary operators of the same precedence associate from left to right. |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 2768 | For instance, <code>x / y * z</code> is the same as <code>(x / y) * z</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2769 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2770 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2771 | <pre> |
| 2772 | +x |
| 2773 | 23 + 3*x[i] |
| 2774 | x <= f() |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2775 | ^a >> b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2776 | f() || g() |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 2777 | x == y+1 && <-chan_ptr > 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2778 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2779 | |
| 2780 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2781 | <h3 id="Arithmetic_operators">Arithmetic operators</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2782 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2783 | Arithmetic operators apply to numeric values and yield a result of the same |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2784 | type as the first operand. The four standard arithmetic operators (<code>+</code>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 2785 | <code>-</code>, <code>*</code>, <code>/</code>) apply to integer, |
| 2786 | floating-point, and complex types; <code>+</code> also applies |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2787 | to strings. All other arithmetic operators apply to integers only. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2788 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2789 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2790 | <pre class="grammar"> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 2791 | + sum integers, floats, complex values, strings |
| 2792 | - difference integers, floats, complex values |
| 2793 | * product integers, floats, complex values |
| 2794 | / quotient integers, floats, complex values |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2795 | % remainder integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2796 | |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2797 | & bitwise and integers |
| 2798 | | bitwise or integers |
| 2799 | ^ bitwise xor integers |
| 2800 | &^ bit clear (and not) integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2801 | |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2802 | << left shift integer << unsigned integer |
| 2803 | >> right shift integer >> unsigned integer |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2804 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2805 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2806 | <p> |
| 2807 | Strings can be concatenated using the <code>+</code> operator |
| 2808 | or the <code>+=</code> assignment operator: |
| 2809 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2810 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2811 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2812 | s := "hi" + string(c) |
| 2813 | s += " and good bye" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2814 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2815 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2816 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2817 | String addition creates a new string by concatenating the operands. |
| 2818 | </p> |
| 2819 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 2820 | For two integer values <code>x</code> and <code>y</code>, the integer quotient |
| 2821 | <code>q = x / y</code> and remainder <code>r = x % y</code> satisfy the following |
| 2822 | relationships: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2823 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2824 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2825 | <pre> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 2826 | x = q*y + r and |r| < |y| |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2827 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2828 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2829 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 2830 | with <code>x / y</code> truncated towards zero |
| 2831 | (<a href="http://en.wikipedia.org/wiki/Modulo_operation">"truncated division"</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2832 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2833 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2834 | <pre> |
| 2835 | x y x / y x % y |
| 2836 | 5 3 1 2 |
| 2837 | -5 3 -1 -2 |
| 2838 | 5 -3 -1 2 |
| 2839 | -5 -3 1 -2 |
| 2840 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2841 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2842 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 2843 | As an exception to this rule, if the dividend <code>x</code> is the most |
| 2844 | negative value for the int type of <code>x</code>, the quotient |
| 2845 | <code>q = x / -1</code> is equal to <code>x</code> (and <code>r = 0</code>). |
| 2846 | </p> |
| 2847 | |
| 2848 | <pre> |
| 2849 | x, q |
| 2850 | int8 -128 |
| 2851 | int16 -32768 |
| 2852 | int32 -2147483648 |
| 2853 | int64 -9223372036854775808 |
| 2854 | </pre> |
| 2855 | |
| 2856 | <p> |
Robert Griesemer | df674ff | 2010-05-04 17:31:40 -0700 | [diff] [blame] | 2857 | If the divisor is zero, a <a href="#Run_time_panics">run-time panic</a> occurs. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2858 | If the dividend is positive and the divisor is a constant power of 2, |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 2859 | the division may be replaced by a right shift, and computing the remainder may |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2860 | be replaced by a bitwise "and" operation: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2861 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2862 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2863 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2864 | x x / 4 x % 4 x >> 2 x & 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2865 | 11 2 3 2 3 |
| 2866 | -11 -2 -3 -3 1 |
| 2867 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2868 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2869 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2870 | The shift operators shift the left operand by the shift count specified by the |
| 2871 | right operand. They implement arithmetic shifts if the left operand is a signed |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 2872 | integer and logical shifts if it is an unsigned integer. |
| 2873 | There is no upper limit on the shift count. Shifts behave |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2874 | as if the left operand is shifted <code>n</code> times by 1 for a shift |
| 2875 | count of <code>n</code>. |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2876 | As a result, <code>x << 1</code> is the same as <code>x*2</code> |
| 2877 | and <code>x >> 1</code> is the same as |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 2878 | <code>x/2</code> but truncated towards negative infinity. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2879 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2880 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2881 | <p> |
| 2882 | For integer operands, the unary operators |
| 2883 | <code>+</code>, <code>-</code>, and <code>^</code> are defined as |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2884 | follows: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2885 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2886 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2887 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2888 | +x is 0 + x |
| 2889 | -x negation is 0 - x |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 2890 | ^x bitwise complement is m ^ x with m = "all bits set to 1" for unsigned x |
| 2891 | and m = -1 for signed x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2892 | </pre> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2893 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2894 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2895 | For floating-point numbers, |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2896 | <code>+x</code> is the same as <code>x</code>, |
| 2897 | while <code>-x</code> is the negation of <code>x</code>. |
Robert Griesemer | df674ff | 2010-05-04 17:31:40 -0700 | [diff] [blame] | 2898 | The result of a floating-point division by zero is not specified beyond the |
| 2899 | IEEE-754 standard; whether a <a href="#Run_time_panics">run-time panic</a> |
| 2900 | occurs is implementation-specific. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2901 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2902 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2903 | <h3 id="Integer_overflow">Integer overflow</h3> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2904 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2905 | <p> |
| 2906 | For unsigned integer values, the operations <code>+</code>, |
| 2907 | <code>-</code>, <code>*</code>, and <code><<</code> are |
| 2908 | computed modulo 2<sup><i>n</i></sup>, where <i>n</i> is the bit width of |
| 2909 | the unsigned integer's type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2910 | (§<a href="#Numeric_types">Numeric types</a>). Loosely speaking, these unsigned integer operations |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2911 | discard high bits upon overflow, and programs may rely on ``wrap around''. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2912 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2913 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2914 | For signed integers, the operations <code>+</code>, |
| 2915 | <code>-</code>, <code>*</code>, and <code><<</code> may legally |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2916 | overflow and the resulting value exists and is deterministically defined |
| 2917 | by the signed integer representation, the operation, and its operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2918 | No exception is raised as a result of overflow. A |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2919 | compiler may not optimize code under the assumption that overflow does |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2920 | not occur. For instance, it may not assume that <code>x < x + 1</code> is always true. |
| 2921 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2922 | |
| 2923 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2924 | <h3 id="Comparison_operators">Comparison operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2925 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2926 | <p> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2927 | Comparison operators compare two operands and yield a value of type <code>bool</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2928 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2929 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2930 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2931 | == equal |
| 2932 | != not equal |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 2933 | < less |
| 2934 | <= less or equal |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2935 | > greater |
| 2936 | >= greater or equal |
| 2937 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2938 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2939 | <p> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2940 | The operands must be <i>comparable</i>; that is, the first operand |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 2941 | must be <a href="#Assignability">assignable</a> |
| 2942 | to the type of the second operand, or vice versa. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2943 | </p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 2944 | <p> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2945 | The operators <code>==</code> and <code>!=</code> apply |
| 2946 | to operands of all types except arrays and structs. |
| 2947 | All other comparison operators apply only to integer, floating-point |
| 2948 | and string values. The result of a comparison is defined as follows: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2949 | </p> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2950 | |
| 2951 | <ul> |
| 2952 | <li> |
| 2953 | Integer values are compared in the usual way. |
| 2954 | </li> |
| 2955 | <li> |
| 2956 | Floating point values are compared as defined by the IEEE-754 |
| 2957 | standard. |
| 2958 | </li> |
| 2959 | <li> |
| 2960 | Two complex values <code>u</code>, <code>v</code> are |
| 2961 | equal if both <code>real(u) == real(v)</code> and |
| 2962 | <code>imag(u) == imag(v)</code>. |
| 2963 | </li> |
| 2964 | <li> |
| 2965 | String values are compared byte-wise (lexically). |
| 2966 | </li> |
| 2967 | <li> |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 2968 | Boolean values are equal if they are either both |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2969 | <code>true</code> or both <code>false</code>. |
| 2970 | </li> |
| 2971 | <li> |
| 2972 | Pointer values are equal if they point to the same location |
| 2973 | or if both are <code>nil</code>. |
| 2974 | </li> |
| 2975 | <li> |
| 2976 | Function values are equal if they refer to the same function |
| 2977 | or if both are <code>nil</code>. |
| 2978 | </li> |
| 2979 | <li> |
| 2980 | A slice value may only be compared to <code>nil</code>. |
| 2981 | </li> |
| 2982 | <li> |
| 2983 | Channel and map values are equal if they were created by the same call to <code>make</code> |
| 2984 | (§<a href="#Making_slices_maps_and_channels">Making slices, maps, and channels</a>) |
| 2985 | or if both are <code>nil</code>. |
| 2986 | </li> |
| 2987 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 2988 | Interface values are equal if they have <a href="#Type_identity">identical</a> dynamic types and |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 2989 | equal dynamic values or if both are <code>nil</code>. |
| 2990 | </li> |
| 2991 | <li> |
| 2992 | An interface value <code>x</code> is equal to a non-interface value |
| 2993 | <code>y</code> if the dynamic type of <code>x</code> is identical to |
| 2994 | the static type of <code>y</code> and the dynamic value of <code>x</code> |
| 2995 | is equal to <code>y</code>. |
| 2996 | </li> |
| 2997 | <li> |
| 2998 | A pointer, function, slice, channel, map, or interface value is equal |
| 2999 | to <code>nil</code> if it has been assigned the explicit value |
| 3000 | <code>nil</code>, if it is uninitialized, or if it has been assigned |
| 3001 | another value equal to <code>nil</code>. |
| 3002 | </li> |
| 3003 | </ul> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 3004 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3005 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3006 | <h3 id="Logical_operators">Logical operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3007 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3008 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3009 | Logical operators apply to <a href="#Boolean_types">boolean</a> values |
| 3010 | and yield a result of the same type as the operands. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3011 | The right operand is evaluated conditionally. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3012 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3013 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3014 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3015 | && conditional and p && q is "if p then q else false" |
| 3016 | || conditional or p || q is "if p then true else q" |
| 3017 | ! not !p is "not p" |
| 3018 | </pre> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3019 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3020 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3021 | <h3 id="Address_operators">Address operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3022 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3023 | <p> |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3024 | For an operand <code>x</code> of type <code>T</code>, the address operation |
| 3025 | <code>&x</code> generates a pointer of type <code>*T</code> to <code>x</code>. |
| 3026 | The operand must be <i>addressable</i>, |
Russ Cox | e7561de | 2010-05-24 14:31:43 -0700 | [diff] [blame] | 3027 | that is, either a variable, pointer indirection, or slice indexing |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3028 | operation; or a field selector of an addressable struct operand; |
Russ Cox | e7561de | 2010-05-24 14:31:43 -0700 | [diff] [blame] | 3029 | or an array indexing operation of an addressable array. |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3030 | As an exception to the addressability requirement, <code>x</code> may also be a |
| 3031 | <a href="#Composite_literals">composite literal</a>. |
| 3032 | </p> |
| 3033 | <p> |
| 3034 | For an operand <code>x</code> of pointer type <code>*T</code>, the pointer |
| 3035 | indirection <code>*x</code> denotes the value of type <code>T</code> pointed |
| 3036 | to by <code>x</code>. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3037 | </p> |
| 3038 | |
| 3039 | <pre> |
| 3040 | &x |
| 3041 | &a[f(2)] |
| 3042 | *p |
| 3043 | *pf(x) |
| 3044 | </pre> |
| 3045 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3046 | |
| 3047 | <h3 id="Receive_operator">Receive operator</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3048 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3049 | <p> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3050 | For an operand <code>ch</code> of <a href="#Channel_types">channel type</a>, |
| 3051 | the value of the receive operation <code><-ch</code> is the value received |
| 3052 | from the channel <code>ch</code>. The type of the value is the element type of |
| 3053 | the channel. The expression blocks until a value is available. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 3054 | Receiving from a <code>nil</code> channel blocks forever. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3055 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3056 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3057 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3058 | v1 := <-ch |
| 3059 | v2 = <-ch |
| 3060 | f(<-ch) |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3061 | <-strobe // wait until clock pulse and discard received value |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3062 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3063 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3064 | <p> |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 3065 | A receive expression used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3066 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3067 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3068 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3069 | x, ok = <-ch |
| 3070 | x, ok := <-ch |
| 3071 | var x, ok = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3072 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3073 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3074 | <p> |
Russ Cox | 19d9a40 | 2011-01-27 15:34:28 -0500 | [diff] [blame] | 3075 | yields an additional result. |
| 3076 | The boolean variable <code>ok</code> indicates whether |
| 3077 | the received value was sent on the channel (<code>true</code>) |
| 3078 | or is a <a href="#The_zero_value">zero value</a> returned |
| 3079 | because the channel is closed and empty (<code>false</code>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3080 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3081 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 3082 | <!-- |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3083 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3084 | <span class="alert">TODO: Probably in a separate section, communication semantics |
| 3085 | need to be presented regarding send, receive, select, and goroutines.</span> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3086 | </p> |
Rob Pike | 38d7bcf | 2011-05-08 14:05:18 -0700 | [diff] [blame] | 3087 | --> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3088 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3089 | |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3090 | <h3 id="Method_expressions">Method expressions</h3> |
| 3091 | |
| 3092 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 3093 | If <code>M</code> is in the <a href="#Method_sets">method set</a> of type <code>T</code>, |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3094 | <code>T.M</code> is a function that is callable as a regular function |
| 3095 | with the same arguments as <code>M</code> prefixed by an additional |
| 3096 | argument that is the receiver of the method. |
| 3097 | </p> |
| 3098 | |
Robert Griesemer | da96188 | 2009-09-17 11:01:50 -0700 | [diff] [blame] | 3099 | <pre class="ebnf"> |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3100 | MethodExpr = ReceiverType "." MethodName . |
| 3101 | ReceiverType = TypeName | "(" "*" TypeName ")" . |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3102 | </pre> |
| 3103 | |
| 3104 | <p> |
| 3105 | Consider a struct type <code>T</code> with two methods, |
| 3106 | <code>Mv</code>, whose receiver is of type <code>T</code>, and |
| 3107 | <code>Mp</code>, whose receiver is of type <code>*T</code>. |
| 3108 | </p> |
| 3109 | |
| 3110 | <pre> |
| 3111 | type T struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3112 | a int |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3113 | } |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3114 | func (tv T) Mv(a int) int { return 0 } // value receiver |
| 3115 | func (tp *T) Mp(f float32) float32 { return 1 } // pointer receiver |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3116 | var t T |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3117 | </pre> |
| 3118 | |
| 3119 | <p> |
| 3120 | The expression |
| 3121 | </p> |
| 3122 | |
| 3123 | <pre> |
| 3124 | T.Mv |
| 3125 | </pre> |
| 3126 | |
| 3127 | <p> |
| 3128 | yields a function equivalent to <code>Mv</code> but |
| 3129 | with an explicit receiver as its first argument; it has signature |
| 3130 | </p> |
| 3131 | |
| 3132 | <pre> |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 3133 | func(tv T, a int) int |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3134 | </pre> |
| 3135 | |
| 3136 | <p> |
| 3137 | That function may be called normally with an explicit receiver, so |
| 3138 | these three invocations are equivalent: |
| 3139 | </p> |
| 3140 | |
| 3141 | <pre> |
| 3142 | t.Mv(7) |
| 3143 | T.Mv(t, 7) |
| 3144 | f := T.Mv; f(t, 7) |
| 3145 | </pre> |
| 3146 | |
| 3147 | <p> |
| 3148 | Similarly, the expression |
| 3149 | </p> |
| 3150 | |
| 3151 | <pre> |
| 3152 | (*T).Mp |
| 3153 | </pre> |
| 3154 | |
| 3155 | <p> |
| 3156 | yields a function value representing <code>Mp</code> with signature |
| 3157 | </p> |
| 3158 | |
| 3159 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3160 | func(tp *T, f float32) float32 |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3161 | </pre> |
| 3162 | |
| 3163 | <p> |
| 3164 | For a method with a value receiver, one can derive a function |
| 3165 | with an explicit pointer receiver, so |
| 3166 | </p> |
| 3167 | |
| 3168 | <pre> |
| 3169 | (*T).Mv |
| 3170 | </pre> |
| 3171 | |
| 3172 | <p> |
| 3173 | yields a function value representing <code>Mv</code> with signature |
| 3174 | </p> |
| 3175 | |
| 3176 | <pre> |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 3177 | func(tv *T, a int) int |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3178 | </pre> |
| 3179 | |
| 3180 | <p> |
| 3181 | Such a function indirects through the receiver to create a value |
| 3182 | to pass as the receiver to the underlying method; |
| 3183 | the method does not overwrite the value whose address is passed in |
| 3184 | the function call. |
| 3185 | </p> |
| 3186 | |
| 3187 | <p> |
| 3188 | The final case, a value-receiver function for a pointer-receiver method, |
| 3189 | is illegal because pointer-receiver methods are not in the method set |
| 3190 | of the value type. |
| 3191 | </p> |
| 3192 | |
| 3193 | <p> |
| 3194 | Function values derived from methods are called with function call syntax; |
| 3195 | the receiver is provided as the first argument to the call. |
| 3196 | That is, given <code>f := T.Mv</code>, <code>f</code> is invoked |
| 3197 | as <code>f(t, 7)</code> not <code>t.f(7)</code>. |
| 3198 | To construct a function that binds the receiver, use a |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 3199 | <a href="#Function_literals">closure</a>. |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 3200 | </p> |
| 3201 | |
| 3202 | <p> |
| 3203 | It is legal to derive a function value from a method of an interface type. |
| 3204 | The resulting function takes an explicit receiver of that interface type. |
| 3205 | </p> |
| 3206 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3207 | <h3 id="Conversions">Conversions</h3> |
| 3208 | |
| 3209 | <p> |
| 3210 | Conversions are expressions of the form <code>T(x)</code> |
| 3211 | where <code>T</code> is a type and <code>x</code> is an expression |
| 3212 | that can be converted to type <code>T</code>. |
| 3213 | </p> |
| 3214 | |
| 3215 | <pre class="ebnf"> |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3216 | Conversion = Type "(" Expression ")" . |
| 3217 | </pre> |
| 3218 | |
| 3219 | <p> |
| 3220 | If the type starts with an operator it must be parenthesized: |
| 3221 | </p> |
| 3222 | |
| 3223 | <pre> |
| 3224 | *Point(p) // same as *(Point(p)) |
| 3225 | (*Point)(p) // p is converted to (*Point) |
| 3226 | <-chan int(c) // same as <-(chan int(c)) |
| 3227 | (<-chan int)(c) // c is converted to (<-chan int) |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3228 | </pre> |
| 3229 | |
| 3230 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3231 | A <a href="#Constants">constant</a> value <code>x</code> can be converted to |
| 3232 | type <code>T</code> in any of these cases: |
| 3233 | </p> |
| 3234 | |
| 3235 | <ul> |
| 3236 | <li> |
| 3237 | <code>x</code> is representable by a value of type <code>T</code>. |
| 3238 | </li> |
| 3239 | <li> |
| 3240 | <code>x</code> is an integer constant and <code>T</code> is a |
| 3241 | <a href="#String_types">string type</a>. |
| 3242 | The same rule as for non-constant <code>x</code> applies in this case |
| 3243 | (§<a href="#Conversions_to_and_from_a_string_type">Conversions to and from a string type</a>). |
| 3244 | </li> |
| 3245 | </ul> |
| 3246 | |
| 3247 | <p> |
| 3248 | Converting a constant yields a typed constant as result. |
| 3249 | </p> |
| 3250 | |
| 3251 | <pre> |
| 3252 | uint(iota) // iota value of type uint |
| 3253 | float32(2.718281828) // 2.718281828 of type float32 |
| 3254 | complex128(1) // 1.0 + 0.0i of type complex128 |
| 3255 | string('x') // "x" of type string |
| 3256 | string(0x266c) // "♬" of type string |
| 3257 | MyString("foo" + "bar") // "foobar" of type MyString |
| 3258 | string([]byte{'a'}) // not a constant: []byte{'a'} is not a constant |
| 3259 | (*int)(nil) // not a constant: nil is not a constant, *int is not a boolean, numeric, or string type |
| 3260 | int(1.2) // illegal: 1.2 cannot be represented as an int |
| 3261 | string(65.0) // illegal: 65.0 is not an integer constant |
| 3262 | </pre> |
| 3263 | |
| 3264 | <p> |
| 3265 | A non-constant value <code>x</code> can be converted to type <code>T</code> |
| 3266 | in any of these cases: |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 3267 | </p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3268 | |
| 3269 | <ul> |
| 3270 | <li> |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3271 | <code>x</code> is <a href="#Assignability">assignable</a> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3272 | to <code>T</code>. |
| 3273 | </li> |
| 3274 | <li> |
| 3275 | <code>x</code>'s type and <code>T</code> have identical |
| 3276 | <a href="#Types">underlying types</a>. |
| 3277 | </li> |
| 3278 | <li> |
| 3279 | <code>x</code>'s type and <code>T</code> are unnamed pointer types |
| 3280 | and their pointer base types have identical underlying types. |
| 3281 | </li> |
| 3282 | <li> |
| 3283 | <code>x</code>'s type and <code>T</code> are both integer or floating |
| 3284 | point types. |
| 3285 | </li> |
| 3286 | <li> |
| 3287 | <code>x</code>'s type and <code>T</code> are both complex types. |
| 3288 | </li> |
| 3289 | <li> |
| 3290 | <code>x</code> is an integer or has type <code>[]byte</code> or |
| 3291 | <code>[]int</code> and <code>T</code> is a string type. |
| 3292 | </li> |
| 3293 | <li> |
| 3294 | <code>x</code> is a string and <code>T</code> is <code>[]byte</code> or |
| 3295 | <code>[]int</code>. |
| 3296 | </li> |
| 3297 | </ul> |
| 3298 | |
| 3299 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3300 | Specific rules apply to (non-constant) conversions between numeric types or |
| 3301 | to and from a string type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3302 | These conversions may change the representation of <code>x</code> |
| 3303 | and incur a run-time cost. |
| 3304 | All other conversions only change the type but not the representation |
| 3305 | of <code>x</code>. |
| 3306 | </p> |
| 3307 | |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3308 | <p> |
| 3309 | There is no linguistic mechanism to convert between pointers and integers. |
| 3310 | The package <a href="#Package_unsafe"><code>unsafe</code></a> |
| 3311 | implements this functionality under |
| 3312 | restricted circumstances. |
| 3313 | </p> |
| 3314 | |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3315 | <h4>Conversions between numeric types</h4> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3316 | |
| 3317 | <p> |
| 3318 | For the conversion of non-constant numeric values, the following rules apply: |
| 3319 | </p> |
| 3320 | |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 3321 | <ol> |
| 3322 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3323 | When converting between integer types, if the value is a signed integer, it is |
| 3324 | sign extended to implicit infinite precision; otherwise it is zero extended. |
| 3325 | It is then truncated to fit in the result type's size. |
| 3326 | For example, if <code>v := uint16(0x10F0)</code>, then <code>uint32(int8(v)) == 0xFFFFFFF0</code>. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3327 | The conversion always yields a valid value; there is no indication of overflow. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3328 | </li> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3329 | <li> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3330 | When converting a floating-point number to an integer, the fraction is discarded |
| 3331 | (truncation towards zero). |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3332 | </li> |
| 3333 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3334 | When converting an integer or floating-point number to a floating-point type, |
| 3335 | or a complex number to another complex type, the result value is rounded |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3336 | to the precision specified by the destination type. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3337 | For instance, the value of a variable <code>x</code> of type <code>float32</code> |
| 3338 | may be stored using additional precision beyond that of an IEEE-754 32-bit number, |
| 3339 | but float32(x) represents the result of rounding <code>x</code>'s value to |
| 3340 | 32-bit precision. Similarly, <code>x + 0.1</code> may use more than 32 bits |
Evan Shaw | cb4e9f8 | 2010-05-23 11:21:47 -0700 | [diff] [blame] | 3341 | of precision, but <code>float32(x + 0.1)</code> does not. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3342 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3343 | </ol> |
| 3344 | |
| 3345 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3346 | In all non-constant conversions involving floating-point or complex values, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3347 | if the result type cannot represent the value the conversion |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3348 | succeeds but the result value is implementation-dependent. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3349 | </p> |
| 3350 | |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3351 | <h4 id="Conversions_to_and_from_a_string_type">Conversions to and from a string type</h4> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3352 | |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3353 | <ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3354 | <li> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3355 | Converting a signed or unsigned integer value to a string type yields a |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3356 | string containing the UTF-8 representation of the integer. Values outside |
| 3357 | the range of valid Unicode code points are converted to <code>"\uFFFD"</code>. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3358 | |
| 3359 | <pre> |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3360 | string('a') // "a" |
| 3361 | string(-1) // "\ufffd" == "\xef\xbf\xbd " |
| 3362 | string(0xf8) // "\u00f8" == "ø" == "\xc3\xb8" |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3363 | type MyString string |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3364 | MyString(0x65e5) // "\u65e5" == "日" == "\xe6\x97\xa5" |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3365 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3366 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3367 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3368 | <li> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3369 | Converting a value of type <code>[]byte</code> (or |
| 3370 | the equivalent <code>[]uint8</code>) to a string type yields a |
| 3371 | string whose successive bytes are the elements of the slice. If |
| 3372 | the slice value is <code>nil</code>, the result is the empty string. |
| 3373 | |
| 3374 | <pre> |
| 3375 | string([]byte{'h', 'e', 'l', 'l', '\xc3', '\xb8'}) // "hellø" |
| 3376 | </pre> |
| 3377 | </li> |
| 3378 | |
| 3379 | <li> |
| 3380 | Converting a value of type <code>[]int</code> to a string type yields |
| 3381 | a string that is the concatenation of the individual integers |
| 3382 | converted to strings. If the slice value is <code>nil</code>, the |
| 3383 | result is the empty string. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3384 | <pre> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3385 | string([]int{0x767d, 0x9d6c, 0x7fd4}) // "\u767d\u9d6c\u7fd4" == "白鵬翔" |
| 3386 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3387 | </li> |
| 3388 | |
| 3389 | <li> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3390 | Converting a value of a string type to <code>[]byte</code> (or <code>[]uint8</code>) |
| 3391 | yields a slice whose successive elements are the bytes of the string. |
| 3392 | If the string is empty, the result is <code>[]byte(nil)</code>. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3393 | |
| 3394 | <pre> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3395 | []byte("hellø") // []byte{'h', 'e', 'l', 'l', '\xc3', '\xb8'} |
| 3396 | </pre> |
| 3397 | </li> |
| 3398 | |
| 3399 | <li> |
| 3400 | Converting a value of a string type to <code>[]int</code> yields a |
| 3401 | slice containing the individual Unicode code points of the string. |
| 3402 | If the string is empty, the result is <code>[]int(nil)</code>. |
| 3403 | <pre> |
| 3404 | []int(MyString("白鵬翔")) // []int{0x767d, 0x9d6c, 0x7fd4} |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3405 | </pre> |
| 3406 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3407 | </ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3408 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3409 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3410 | <h3 id="Constant_expressions">Constant expressions</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 3411 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3412 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3413 | Constant expressions may contain only <a href="#Constants">constant</a> |
| 3414 | operands and are evaluated at compile-time. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3415 | </p> |
| 3416 | |
| 3417 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3418 | Untyped boolean, numeric, and string constants may be used as operands |
| 3419 | wherever it is legal to use an operand of boolean, numeric, or string type, |
| 3420 | respectively. Except for shift operations, if the operands of a binary operation |
| 3421 | are an untyped integer constant and an untyped floating-point constant, |
| 3422 | the integer constant is converted to an untyped floating-point constant |
| 3423 | (relevant for <code>/</code> and <code>%</code>). |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3424 | Similarly, untyped integer or floating-point constants may be used as operands |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3425 | wherever it is legal to use an operand of complex type; |
| 3426 | the integer or floating point constant is converted to a |
| 3427 | complex constant with a zero imaginary part. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3428 | </p> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 3429 | |
| 3430 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3431 | A constant <a href="#Comparison_operators">comparison</a> always yields |
| 3432 | a constant of type <code>bool</code>. If the left operand of a constant |
| 3433 | <a href="#Operators">shift expression</a> is an untyped constant, the |
| 3434 | result is an integer constant; otherwise it is a constant of the same |
| 3435 | type as the left operand, which must be of integer type |
| 3436 | (§<a href="#Arithmetic_operators">Arithmetic operators</a>). |
| 3437 | Applying all other operators to untyped constants results in an untyped |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3438 | constant of the same kind (that is, a boolean, integer, floating-point, |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3439 | complex, or string constant). |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3440 | </p> |
| 3441 | |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3442 | <pre> |
| 3443 | const a = 2 + 3.0 // a == 5.0 (floating-point constant) |
| 3444 | const b = 15 / 4 // b == 3 (integer constant) |
| 3445 | const c = 15 / 4.0 // c == 3.75 (floating-point constant) |
| 3446 | const d = 1 << 3.0 // d == 8 (integer constant) |
| 3447 | const e = 1.0 << 3 // e == 8 (integer constant) |
| 3448 | const f = int32(1) << 33 // f == 0 (type int32) |
| 3449 | const g = float64(2) >> 1 // illegal (float64(2) is a typed floating-point constant) |
| 3450 | const h = "foo" > "bar" // h == true (type bool) |
| 3451 | </pre> |
| 3452 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3453 | <p> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3454 | Imaginary literals are untyped complex constants (with zero real part) |
| 3455 | and may be combined in binary |
| 3456 | operations with untyped integer and floating-point constants; the |
| 3457 | result is an untyped complex constant. |
| 3458 | Complex constants are always constructed from |
| 3459 | constant expressions involving imaginary |
Robert Griesemer | ef4c2b8 | 2010-03-10 15:29:36 -0800 | [diff] [blame] | 3460 | literals or constants derived from them, or calls of the built-in function |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3461 | <a href="#Complex_numbers"><code>complex</code></a>. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3462 | </p> |
| 3463 | |
| 3464 | <pre> |
| 3465 | const Σ = 1 - 0.707i |
Robert Griesemer | ef4c2b8 | 2010-03-10 15:29:36 -0800 | [diff] [blame] | 3466 | const Δ = Σ + 2.0e-4 - 1/1i |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3467 | const Φ = iota * 1i |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3468 | const iΓ = complex(0, Γ) |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3469 | </pre> |
| 3470 | |
| 3471 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3472 | Constant expressions are always evaluated exactly; intermediate values and the |
| 3473 | constants themselves may require precision significantly larger than supported |
| 3474 | by any predeclared type in the language. The following are legal declarations: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3475 | </p> |
| 3476 | |
| 3477 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3478 | const Huge = 1 << 100 |
| 3479 | const Four int8 = Huge >> 98 |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3480 | </pre> |
| 3481 | |
| 3482 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3483 | The values of <i>typed</i> constants must always be accurately representable as values |
| 3484 | of the constant type. The following constant expressions are illegal: |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3485 | </p> |
| 3486 | |
| 3487 | <pre> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3488 | uint(-1) // -1 cannot be represented as a uint |
| 3489 | int(3.14) // 3.14 cannot be represented as an int |
| 3490 | int64(Huge) // 1<<100 cannot be represented as an int64 |
| 3491 | Four * 300 // 300 cannot be represented as an int8 |
| 3492 | Four * 100 // 400 cannot be represented as an int8 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3493 | </pre> |
| 3494 | |
| 3495 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3496 | The mask used by the unary bitwise complement operator <code>^</code> matches |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3497 | the rule for non-constants: the mask is all 1s for unsigned constants |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3498 | and -1 for signed and untyped constants. |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3499 | </p> |
| 3500 | |
| 3501 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3502 | ^1 // untyped integer constant, equal to -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3503 | uint8(^1) // error, same as uint8(-2), out of range |
| 3504 | ^uint8(1) // typed uint8 constant, same as 0xFF ^ uint8(1) = uint8(0xFE) |
| 3505 | int8(^1) // same as int8(-2) |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 3506 | ^int8(1) // same as -1 ^ int8(1) = -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3507 | </pre> |
| 3508 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 3509 | <!-- |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3510 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3511 | <span class="alert"> |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3512 | TODO: perhaps ^ should be disallowed on non-uints instead of assuming twos complement. |
| 3513 | Also it may be possible to make typed constants more like variables, at the cost of fewer |
| 3514 | overflow etc. errors being caught. |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 3515 | </span> |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 3516 | </p> |
Rob Pike | 38d7bcf | 2011-05-08 14:05:18 -0700 | [diff] [blame] | 3517 | --> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3518 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3519 | <h3 id="Order_of_evaluation">Order of evaluation</h3> |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3520 | |
| 3521 | <p> |
| 3522 | When evaluating the elements of an assignment or expression, |
| 3523 | all function calls, method calls and |
| 3524 | communication operations are evaluated in lexical left-to-right |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3525 | order. |
| 3526 | </p> |
| 3527 | |
| 3528 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3529 | For example, in the assignment |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3530 | </p> |
| 3531 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3532 | y[f()], ok = g(h(), i() + x[j()], <-c), k() |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3533 | </pre> |
| 3534 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3535 | the function calls and communication happen in the order |
| 3536 | <code>f()</code>, <code>h()</code>, <code>i()</code>, <code>j()</code>, |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3537 | <code><-c</code>, <code>g()</code>, and <code>k()</code>. |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3538 | However, the order of those events compared to the evaluation |
| 3539 | and indexing of <code>x</code> and the evaluation |
| 3540 | of <code>y</code> is not specified. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 3541 | </p> |
| 3542 | |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3543 | <p> |
| 3544 | Floating-point operations within a single expression are evaluated according to |
| 3545 | the associativity of the operators. Explicit parentheses affect the evaluation |
| 3546 | by overriding the default associativity. |
| 3547 | In the expression <code>x + (y + z)</code> the addition <code>y + z</code> |
| 3548 | is performed before adding <code>x</code>. |
| 3549 | </p> |
| 3550 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3551 | <h2 id="Statements">Statements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3552 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3553 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3554 | Statements control execution. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3555 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3556 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3557 | <pre class="ebnf"> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3558 | Statement = |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3559 | Declaration | LabeledStmt | SimpleStmt | |
| 3560 | GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt | |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3561 | FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt | |
| 3562 | DeferStmt . |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 3563 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3564 | SimpleStmt = EmptyStmt | ExpressionStmt | SendStmt | IncDecStmt | Assignment | ShortVarDecl . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3565 | </pre> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 3566 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3567 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3568 | <h3 id="Empty_statements">Empty statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3569 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3570 | <p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3571 | The empty statement does nothing. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3572 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3573 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3574 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3575 | EmptyStmt = . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3576 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3577 | |
| 3578 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3579 | <h3 id="Labeled_statements">Labeled statements</h3> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3580 | |
| 3581 | <p> |
| 3582 | A labeled statement may be the target of a <code>goto</code>, |
| 3583 | <code>break</code> or <code>continue</code> statement. |
| 3584 | </p> |
| 3585 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3586 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3587 | LabeledStmt = Label ":" Statement . |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3588 | Label = identifier . |
| 3589 | </pre> |
| 3590 | |
| 3591 | <pre> |
Robert Griesemer | 7fc4e37 | 2011-02-01 12:51:10 -0800 | [diff] [blame] | 3592 | Error: log.Panic("error encountered") |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3593 | </pre> |
| 3594 | |
| 3595 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3596 | <h3 id="Expression_statements">Expression statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3597 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3598 | <p> |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 3599 | Function calls, method calls, and receive operations |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 3600 | can appear in statement context. Such statements may be parenthesized. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3601 | </p> |
| 3602 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3603 | <pre class="ebnf"> |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 3604 | ExpressionStmt = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3605 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3606 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3607 | <pre> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3608 | h(x+y) |
| 3609 | f.Close() |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3610 | <-ch |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 3611 | (<-ch) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3612 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3613 | |
| 3614 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3615 | <h3 id="Send_statements">Send statements</h3> |
| 3616 | |
| 3617 | <p> |
| 3618 | A send statement sends a value on a channel. |
| 3619 | The channel expression must be of <a href="#Channel_types">channel type</a> |
| 3620 | and the type of the value must be <a href="#Assignability">assignable</a> |
| 3621 | to the channel's element type. |
| 3622 | </p> |
| 3623 | |
| 3624 | <pre class="ebnf"> |
| 3625 | SendStmt = Channel "<-" Expression . |
| 3626 | Channel = Expression . |
| 3627 | </pre> |
| 3628 | |
| 3629 | <p> |
| 3630 | Both the channel and the value expression are evaluated before communication |
| 3631 | begins. Communication blocks until the send can proceed, at which point the |
| 3632 | value is transmitted on the channel. |
| 3633 | A send on an unbuffered channel can proceed if a receiver is ready. |
| 3634 | A send on a buffered channel can proceed if there is room in the buffer. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 3635 | A send on a <code>nil</code> channel blocks forever. |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3636 | </p> |
| 3637 | |
| 3638 | <pre> |
| 3639 | ch <- 3 |
| 3640 | </pre> |
| 3641 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3642 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3643 | <h3 id="IncDec_statements">IncDec statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3644 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3645 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3646 | The "++" and "--" statements increment or decrement their operands |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3647 | by the untyped <a href="#Constants">constant</a> <code>1</code>. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 3648 | As with an assignment, the operand must be <a href="#Address_operators">addressable</a> |
| 3649 | or a map index expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3650 | </p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3651 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3652 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3653 | IncDecStmt = Expression ( "++" | "--" ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3654 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3655 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3656 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 3657 | The following <a href="#Assignments">assignment statements</a> are semantically |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3658 | equivalent: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3659 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3660 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3661 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3662 | IncDec statement Assignment |
| 3663 | x++ x += 1 |
| 3664 | x-- x -= 1 |
| 3665 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3666 | |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 3667 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3668 | <h3 id="Assignments">Assignments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3669 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3670 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3671 | Assignment = ExpressionList assign_op ExpressionList . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3672 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3673 | assign_op = [ add_op | mul_op ] "=" . |
| 3674 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3675 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3676 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3677 | Each left-hand side operand must be <a href="#Address_operators">addressable</a>, |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 3678 | a map index expression, or the <a href="#Blank_identifier">blank identifier</a>. |
| 3679 | Operands may be parenthesized. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3680 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3681 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3682 | <pre> |
| 3683 | x = 1 |
| 3684 | *p = f() |
| 3685 | a[i] = 23 |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 3686 | (k) = <-ch // same as: k = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3687 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3688 | |
| 3689 | <p> |
| 3690 | An <i>assignment operation</i> <code>x</code> <i>op</i><code>=</code> |
| 3691 | <code>y</code> where <i>op</i> is a binary arithmetic operation is equivalent |
| 3692 | to <code>x</code> <code>=</code> <code>x</code> <i>op</i> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3693 | <code>y</code> but evaluates <code>x</code> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3694 | only once. The <i>op</i><code>=</code> construct is a single token. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3695 | In assignment operations, both the left- and right-hand expression lists |
| 3696 | must contain exactly one single-valued expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3697 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3698 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3699 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3700 | a[i] <<= 2 |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3701 | i &^= 1<<n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3702 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3703 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3704 | <p> |
| 3705 | A tuple assignment assigns the individual elements of a multi-valued |
| 3706 | operation to a list of variables. There are two forms. In the |
| 3707 | first, the right hand operand is a single multi-valued expression |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 3708 | such as a function evaluation or <a href="#Channel_types">channel</a> or |
| 3709 | <a href="#Map_types">map</a> operation or a <a href="#Type_assertions">type assertion</a>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3710 | The number of operands on the left |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3711 | hand side must match the number of values. For instance, if |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3712 | <code>f</code> is a function returning two values, |
| 3713 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3714 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3715 | <pre> |
| 3716 | x, y = f() |
| 3717 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3718 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3719 | <p> |
| 3720 | assigns the first value to <code>x</code> and the second to <code>y</code>. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3721 | The <a href="#Blank_identifier">blank identifier</a> provides a |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3722 | way to ignore values returned by a multi-valued expression: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3723 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3724 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 3725 | <pre> |
| 3726 | x, _ = f() // ignore second value returned by f() |
| 3727 | </pre> |
| 3728 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3729 | <p> |
| 3730 | In the second form, the number of operands on the left must equal the number |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 3731 | of expressions on the right, each of which must be single-valued, and the |
| 3732 | <i>n</i>th expression on the right is assigned to the <i>n</i>th |
| 3733 | operand on the left. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3734 | The expressions on the right are evaluated before assigning to |
| 3735 | any of the operands on the left, but otherwise the evaluation |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3736 | order is unspecified beyond <a href="#Order_of_evaluation">the usual rules</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3737 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3738 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3739 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3740 | a, b = b, a // exchange a and b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3741 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3742 | |
| 3743 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3744 | In assignments, each value must be |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3745 | <a href="#Assignability">assignable</a> to the type of the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3746 | operand to which it is assigned. If an untyped <a href="#Constants">constant</a> |
| 3747 | is assigned to a variable of interface type, the constant is <a href="#Conversions">converted</a> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3748 | to type <code>bool</code>, <code>int</code>, <code>float64</code>, |
| 3749 | <code>complex128</code> or <code>string</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3750 | respectively, depending on whether the value is a boolean, integer, floating-point, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3751 | complex, or string constant. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3752 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3753 | |
| 3754 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3755 | <h3 id="If_statements">If statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3756 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3757 | <p> |
| 3758 | "If" statements specify the conditional execution of two branches |
| 3759 | according to the value of a boolean expression. If the expression |
| 3760 | evaluates to true, the "if" branch is executed, otherwise, if |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 3761 | present, the "else" branch is executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3762 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3763 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3764 | <pre class="ebnf"> |
Russ Cox | 58e19aa | 2011-07-14 17:15:52 -0400 | [diff] [blame] | 3765 | IfStmt = "if" [ SimpleStmt ";" ] Expression Block [ "else" ( IfStmt | Block ) ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3766 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3767 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3768 | <pre> |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 3769 | if x > max { |
| 3770 | x = max |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3771 | } |
| 3772 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3773 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3774 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3775 | The expression may be preceded by a simple statement, which |
| 3776 | executes before the expression is evaluated. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3777 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3778 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3779 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3780 | if x := f(); x < y { |
| 3781 | return x |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 3782 | } else if x > z { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3783 | return z |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3784 | } else { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3785 | return y |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3786 | } |
| 3787 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3788 | |
| 3789 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3790 | <h3 id="Switch_statements">Switch statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3791 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3792 | <p> |
| 3793 | "Switch" statements provide multi-way execution. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3794 | An expression or type specifier is compared to the "cases" |
| 3795 | inside the "switch" to determine which branch |
| 3796 | to execute. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3797 | </p> |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3798 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3799 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3800 | SwitchStmt = ExprSwitchStmt | TypeSwitchStmt . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3801 | </pre> |
| 3802 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3803 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3804 | There are two forms: expression switches and type switches. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3805 | In an expression switch, the cases contain expressions that are compared |
| 3806 | against the value of the switch expression. |
| 3807 | In a type switch, the cases contain types that are compared against the |
| 3808 | type of a specially annotated switch expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3809 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3810 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3811 | <h4 id="Expression_switches">Expression switches</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3812 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3813 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3814 | In an expression switch, |
| 3815 | the switch expression is evaluated and |
| 3816 | the case expressions, which need not be constants, |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3817 | 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] | 3818 | switch expression |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3819 | triggers execution of the statements of the associated case; |
| 3820 | the other cases are skipped. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3821 | If no case matches and there is a "default" case, |
| 3822 | its statements are executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3823 | There can be at most one default case and it may appear anywhere in the |
| 3824 | "switch" statement. |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3825 | A missing switch expression is equivalent to |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3826 | the expression <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3827 | </p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3828 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3829 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3830 | ExprSwitchStmt = "switch" [ SimpleStmt ";" ] [ Expression ] "{" { ExprCaseClause } "}" . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3831 | ExprCaseClause = ExprSwitchCase ":" { Statement ";" } . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3832 | ExprSwitchCase = "case" ExpressionList | "default" . |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3833 | </pre> |
| 3834 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3835 | <p> |
| 3836 | In a case or default clause, |
| 3837 | the last statement only may be a "fallthrough" statement |
Evan Shaw | 67d30bb | 2010-05-25 18:24:07 -0700 | [diff] [blame] | 3838 | (§<a href="#Fallthrough_statements">Fallthrough statement</a>) to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3839 | indicate that control should flow from the end of this clause to |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3840 | the first statement of the next clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3841 | Otherwise control flows to the end of the "switch" statement. |
| 3842 | </p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 3843 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3844 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3845 | The expression may be preceded by a simple statement, which |
| 3846 | executes before the expression is evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3847 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3848 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3849 | <pre> |
| 3850 | switch tag { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3851 | default: s3() |
| 3852 | case 0, 1, 2, 3: s1() |
| 3853 | case 4, 5, 6, 7: s2() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3854 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3855 | |
Andrew Gerrand | 10b77f7 | 2010-03-29 13:12:08 +1100 | [diff] [blame] | 3856 | switch x := f(); { // missing switch expression means "true" |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3857 | case x < 0: return -x |
| 3858 | default: return x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3859 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3860 | |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3861 | switch { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3862 | case x < y: f1() |
| 3863 | case x < z: f2() |
| 3864 | case x == 4: f3() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3865 | } |
| 3866 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3867 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3868 | <h4 id="Type_switches">Type switches</h4> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3869 | |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3870 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3871 | A type switch compares types rather than values. It is otherwise similar |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3872 | to an expression switch. It is marked by a special switch expression that |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3873 | has the form of a <a href="#Type_assertions">type assertion</a> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3874 | using the reserved word <code>type</code> rather than an actual type. |
| 3875 | Cases then match literal types against the dynamic type of the expression |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 3876 | in the type assertion. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3877 | </p> |
| 3878 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3879 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3880 | TypeSwitchStmt = "switch" [ SimpleStmt ";" ] TypeSwitchGuard "{" { TypeCaseClause } "}" . |
Russ Cox | c1045db | 2009-12-23 13:48:44 -0800 | [diff] [blame] | 3881 | TypeSwitchGuard = [ identifier ":=" ] PrimaryExpr "." "(" "type" ")" . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3882 | TypeCaseClause = TypeSwitchCase ":" { Statement ";" } . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3883 | TypeSwitchCase = "case" TypeList | "default" . |
| 3884 | TypeList = Type { "," Type } . |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3885 | </pre> |
| 3886 | |
| 3887 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3888 | The TypeSwitchGuard may include a |
| 3889 | <a href="#Short_variable_declarations">short variable declaration</a>. |
| 3890 | When that form is used, the variable is declared in each clause. |
| 3891 | In clauses with a case listing exactly one type, the variable |
| 3892 | has that type; otherwise, the variable has the type of the expression |
| 3893 | in the TypeSwitchGuard. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3894 | </p> |
| 3895 | |
| 3896 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3897 | The type in a case may be <code>nil</code> |
| 3898 | (§<a href="#Predeclared_identifiers">Predeclared identifiers</a>); |
| 3899 | that case is used when the expression in the TypeSwitchGuard |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3900 | is a <code>nil</code> interface value. |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3901 | </p> |
| 3902 | |
| 3903 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3904 | Given an expression <code>x</code> of type <code>interface{}</code>, |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3905 | the following type switch: |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3906 | </p> |
| 3907 | |
| 3908 | <pre> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3909 | switch i := x.(type) { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3910 | case nil: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3911 | printString("x is nil") |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3912 | case int: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3913 | printInt(i) // i is an int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3914 | case float64: |
| 3915 | printFloat64(i) // i is a float64 |
| 3916 | case func(int) float64: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3917 | printFunction(i) // i is a function |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3918 | case bool, string: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3919 | printString("type is bool or string") // i is an interface{} |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3920 | default: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3921 | printString("don't know the type") |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3922 | } |
| 3923 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3924 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3925 | <p> |
| 3926 | could be rewritten: |
| 3927 | </p> |
| 3928 | |
| 3929 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3930 | v := x // x is evaluated exactly once |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3931 | if v == nil { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3932 | printString("x is nil") |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3933 | } else if i, is_int := v.(int); is_int { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3934 | printInt(i) // i is an int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 3935 | } else if i, is_float64 := v.(float64); is_float64 { |
| 3936 | printFloat64(i) // i is a float64 |
| 3937 | } else if i, is_func := v.(func(int) float64); is_func { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3938 | printFunction(i) // i is a function |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3939 | } else { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3940 | i1, is_bool := v.(bool) |
| 3941 | i2, is_string := v.(string) |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3942 | if is_bool || is_string { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3943 | i := v |
| 3944 | printString("type is bool or string") // i is an interface{} |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3945 | } else { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3946 | i := v |
| 3947 | printString("don't know the type") // i is an interface{} |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3948 | } |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3949 | } |
| 3950 | </pre> |
| 3951 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 3952 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3953 | The type switch guard may be preceded by a simple statement, which |
| 3954 | executes before the guard is evaluated. |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3955 | </p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3956 | |
| 3957 | <p> |
| 3958 | The "fallthrough" statement is not permitted in a type switch. |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3959 | </p> |
| 3960 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3961 | <h3 id="For_statements">For statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3962 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3963 | <p> |
| 3964 | A "for" statement specifies repeated execution of a block. The iteration is |
| 3965 | controlled by a condition, a "for" clause, or a "range" clause. |
| 3966 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3967 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3968 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3969 | ForStmt = "for" [ Condition | ForClause | RangeClause ] Block . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3970 | Condition = Expression . |
| 3971 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3972 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3973 | <p> |
| 3974 | In its simplest form, a "for" statement specifies the repeated execution of |
| 3975 | a block as long as a boolean condition evaluates to true. |
| 3976 | The condition is evaluated before each iteration. |
| 3977 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3978 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3979 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3980 | <pre> |
| 3981 | for a < b { |
| 3982 | a *= 2 |
| 3983 | } |
| 3984 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3985 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3986 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 3987 | A "for" statement with a ForClause is also controlled by its condition, but |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3988 | additionally it may specify an <i>init</i> |
| 3989 | and a <i>post</i> statement, such as an assignment, |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3990 | an increment or decrement statement. The init statement may be a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3991 | <a href="#Short_variable_declarations">short variable declaration</a>, but the post statement must not. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3992 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3993 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3994 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3995 | ForClause = [ InitStmt ] ";" [ Condition ] ";" [ PostStmt ] . |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3996 | InitStmt = SimpleStmt . |
| 3997 | PostStmt = SimpleStmt . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3998 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3999 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4000 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4001 | for i := 0; i < 10; i++ { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4002 | f(i) |
| 4003 | } |
| 4004 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4005 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4006 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4007 | If non-empty, the init statement is executed once before evaluating the |
| 4008 | condition for the first iteration; |
| 4009 | the post statement is executed after each execution of the block (and |
| 4010 | only if the block was executed). |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4011 | Any element of the ForClause may be empty but the |
| 4012 | <a href="#Semicolons">semicolons</a> are |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4013 | required unless there is only a condition. |
| 4014 | If the condition is absent, it is equivalent to <code>true</code>. |
| 4015 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4016 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4017 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4018 | for cond { S() } is the same as for ; cond ; { S() } |
| 4019 | for { S() } is the same as for true { S() } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4020 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4021 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4022 | <p> |
| 4023 | A "for" statement with a "range" clause |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4024 | iterates through all entries of an array, slice, string or map, |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4025 | or values received on a channel. For each entry it assigns <i>iteration values</i> |
| 4026 | to corresponding <i>iteration variables</i> and then executes the block. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4027 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4028 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4029 | <pre class="ebnf"> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4030 | RangeClause = Expression [ "," Expression ] ( "=" | ":=" ) "range" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4031 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4032 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4033 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4034 | The expression on the right in the "range" clause is called the <i>range expression</i>, |
| 4035 | which may be an array, pointer to an array, slice, string, map, or channel. |
| 4036 | As with an assignment, the operands on the left must be |
| 4037 | <a href="#Address_operators">addressable</a> or map index expressions; they |
| 4038 | denote the iteration variables. If the range expression is a channel, only |
| 4039 | one iteration variable is permitted, otherwise there may be one or two. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4040 | If the second iteration variable is the <a href="#Blank_identifier">blank identifier</a>, |
| 4041 | the range clause is equivalent to the same clause with only the first variable present. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4042 | </p> |
Rob Pike | 29d0f02 | 2011-01-05 11:39:57 -0800 | [diff] [blame] | 4043 | |
| 4044 | <p> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4045 | The range expression is evaluated once before beginning the loop |
| 4046 | except if the expression is an array, in which case, depending on |
| 4047 | the expression, it might not be evaluated (see below). |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4048 | Function calls on the left are evaluated once per iteration. |
| 4049 | For each iteration, iteration values are produced as follows: |
| 4050 | </p> |
| 4051 | |
| 4052 | <pre class="grammar"> |
| 4053 | Range expression 1st value 2nd value (if 2nd variable is present) |
| 4054 | |
| 4055 | array or slice a [n]E, *[n]E, or []E index i int a[i] E |
| 4056 | string s string type index i int see below int |
| 4057 | map m map[K]V key k K m[k] V |
| 4058 | channel c chan E element e E |
| 4059 | </pre> |
| 4060 | |
| 4061 | <ol> |
| 4062 | <li> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4063 | For an array, pointer to array, or slice value <code>a</code>, the index iteration |
| 4064 | values are produced in increasing order, starting at element index 0. As a special |
| 4065 | case, if only the first iteration variable is present, the range loop produces |
| 4066 | iteration values from 0 up to <code>len(a)</code> and does not index into the array |
| 4067 | or slice itself. For a <code>nil</code> slice, the number of iterations is 0. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4068 | </li> |
| 4069 | |
| 4070 | <li> |
| 4071 | For a string value, the "range" clause iterates over the Unicode code points |
| 4072 | in the string starting at byte index 0. On successive iterations, the index value will be the |
| 4073 | index of the first byte of successive UTF-8-encoded code points in the string, |
| 4074 | and the second value, of type <code>int</code>, will be the value of |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4075 | the corresponding code point. If the iteration encounters an invalid |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4076 | UTF-8 sequence, the second value will be <code>0xFFFD</code>, |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4077 | the Unicode replacement character, and the next iteration will advance |
| 4078 | a single byte in the string. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4079 | </li> |
| 4080 | |
| 4081 | <li> |
| 4082 | The iteration order over maps is not specified. |
| 4083 | If map entries that have not yet been reached are deleted during iteration, |
| 4084 | the corresponding iteration values will not be produced. If map entries are |
| 4085 | inserted during iteration, the behavior is implementation-dependent, but the |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4086 | iteration values for each entry will be produced at most once. If the map |
| 4087 | is <code>nil</code>, the number of iterations is 0. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4088 | </li> |
| 4089 | |
| 4090 | <li> |
| 4091 | For channels, the iteration values produced are the successive values sent on |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4092 | the channel until the channel is <a href="#Close">closed</a>. If the channel |
| 4093 | is <code>nil</code>, the range expression blocks forever. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4094 | </li> |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 4095 | </ol> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4096 | |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4097 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4098 | The iteration values are assigned to the respective |
| 4099 | iteration variables as in an <a href="#Assignments">assignment statement</a>. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4100 | </p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4101 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4102 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4103 | The iteration variables may be declared by the "range" clause (<code>:=</code>). |
| 4104 | In this case their types are set to the types of the respective iteration values |
| 4105 | and their <a href="#Declarations_and_scope">scope</a> ends at the end of the "for" |
| 4106 | statement; they are re-used in each iteration. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4107 | If the iteration variables are declared outside the "for" statement, |
| 4108 | after execution their values will be those of the last iteration. |
| 4109 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4110 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4111 | <pre> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4112 | var testdata *struct { |
| 4113 | a *[7]int |
| 4114 | } |
| 4115 | for i, _ := range testdata.a { |
| 4116 | // testdata.a is never evaluated; len(testdata.a) is constant |
| 4117 | // i ranges from 0 to 6 |
| 4118 | f(i) |
| 4119 | } |
| 4120 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4121 | var a [10]string |
| 4122 | m := map[string]int{"mon":0, "tue":1, "wed":2, "thu":3, "fri":4, "sat":5, "sun":6} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4123 | for i, s := range a { |
| 4124 | // type of i is int |
| 4125 | // type of s is string |
| 4126 | // s == a[i] |
| 4127 | g(i, s) |
| 4128 | } |
| 4129 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4130 | var key string |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 4131 | var val interface {} // value type of m is assignable to val |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4132 | for key, val = range m { |
| 4133 | h(key, val) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4134 | } |
| 4135 | // key == last map key encountered in iteration |
| 4136 | // val == map[key] |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4137 | |
| 4138 | var ch chan Work = producer() |
| 4139 | for w := range ch { |
| 4140 | doWork(w) |
| 4141 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4142 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4143 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4144 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4145 | <h3 id="Go_statements">Go statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4146 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4147 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4148 | A "go" statement starts the execution of a function or method call |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4149 | as an independent concurrent thread of control, or <i>goroutine</i>, |
| 4150 | within the same address space. |
| 4151 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4152 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4153 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4154 | GoStmt = "go" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4155 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4156 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4157 | <p> |
| 4158 | The expression must be a call, and |
| 4159 | unlike with a regular call, program execution does not wait |
Robert Griesemer | b9f8b9c | 2008-09-26 13:38:38 -0700 | [diff] [blame] | 4160 | for the invoked function to complete. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4161 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4162 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4163 | <pre> |
| 4164 | go Server() |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4165 | go func(ch chan<- bool) { for { sleep(10); ch <- true; }} (c) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4166 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4167 | |
| 4168 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4169 | <h3 id="Select_statements">Select statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4170 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4171 | <p> |
| 4172 | A "select" statement chooses which of a set of possible communications |
| 4173 | will proceed. It looks similar to a "switch" statement but with the |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4174 | cases all referring to communication operations. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4175 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4176 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4177 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4178 | SelectStmt = "select" "{" { CommClause } "}" . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4179 | CommClause = CommCase ":" { Statement ";" } . |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4180 | CommCase = "case" ( SendStmt | RecvStmt ) | "default" . |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 4181 | RecvStmt = [ Expression [ "," Expression ] ( "=" | ":=" ) ] RecvExpr . |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 4182 | RecvExpr = Expression . |
Russ Cox | 6143918 | 2011-01-31 17:42:10 -0500 | [diff] [blame] | 4183 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4184 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4185 | <p> |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 4186 | RecvExpr must be a <a href="#Receive_operator">receive operation</a>. |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4187 | For all the cases in the "select" |
Rob Pike | 041d116 | 2010-07-13 16:23:54 -0700 | [diff] [blame] | 4188 | statement, the channel expressions are evaluated in top-to-bottom order, along with |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4189 | any expressions that appear on the right hand side of send statements. |
Rob Pike | 132d2f1 | 2010-08-16 06:42:41 +1000 | [diff] [blame] | 4190 | A channel may be <code>nil</code>, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4191 | which is equivalent to that case not |
| 4192 | being present in the select statement |
| 4193 | except, if a send, its expression is still evaluated. |
Rob Pike | 041d116 | 2010-07-13 16:23:54 -0700 | [diff] [blame] | 4194 | If any of the resulting operations can proceed, one of those is |
| 4195 | chosen and the corresponding communication and statements are |
| 4196 | evaluated. Otherwise, if there is a default case, that executes; |
| 4197 | if there is no default case, the statement blocks until one of the communications can |
| 4198 | complete. |
| 4199 | If there are no cases with non-<code>nil</code> channels, |
| 4200 | the statement blocks forever. |
| 4201 | Even if the statement blocks, |
| 4202 | the channel and send expressions are evaluated only once, |
| 4203 | upon entering the select statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4204 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4205 | <p> |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 4206 | Since all the channels and send expressions are evaluated, any side |
| 4207 | effects in that evaluation will occur for all the communications |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4208 | in the "select" statement. |
| 4209 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4210 | <p> |
Rob Pike | 041d116 | 2010-07-13 16:23:54 -0700 | [diff] [blame] | 4211 | If multiple cases can proceed, a pseudo-random fair choice is made to decide |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4212 | which single communication will execute. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4213 | <p> |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 4214 | The receive case may declare one or two new variables using a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 4215 | <a href="#Short_variable_declarations">short variable declaration</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4216 | </p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 4217 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4218 | <pre> |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 4219 | var c, c1, c2, c3 chan int |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4220 | var i1, i2 int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4221 | select { |
| 4222 | case i1 = <-c1: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4223 | print("received ", i1, " from c1\n") |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4224 | case c2 <- i2: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4225 | print("sent ", i2, " to c2\n") |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 4226 | case i3, ok := (<-c3): // same as: i3, ok := <-c3 |
Russ Cox | 19d9a40 | 2011-01-27 15:34:28 -0500 | [diff] [blame] | 4227 | if ok { |
| 4228 | print("received ", i3, " from c3\n") |
| 4229 | } else { |
| 4230 | print("c3 is closed\n") |
| 4231 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4232 | default: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4233 | print("no communication\n") |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4234 | } |
| 4235 | |
| 4236 | for { // send random sequence of bits to c |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4237 | select { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4238 | case c <- 0: // note: no statement, no fallthrough, no folding of cases |
| 4239 | case c <- 1: |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4240 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4241 | } |
Rob Pike | 041d116 | 2010-07-13 16:23:54 -0700 | [diff] [blame] | 4242 | |
| 4243 | select { } // block forever |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4244 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4245 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4246 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4247 | <h3 id="Return_statements">Return statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4248 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4249 | <p> |
| 4250 | A "return" statement terminates execution of the containing function |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4251 | and optionally provides a result value or values to the caller. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4252 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4253 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4254 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4255 | ReturnStmt = "return" [ ExpressionList ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4256 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4257 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4258 | <p> |
| 4259 | In a function without a result type, a "return" statement must not |
| 4260 | specify any result values. |
| 4261 | </p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4262 | <pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4263 | func no_result() { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4264 | return |
| 4265 | } |
| 4266 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4267 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4268 | <p> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4269 | There are three ways to return values from a function with a result |
| 4270 | type: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4271 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4272 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4273 | <ol> |
| 4274 | <li>The return value or values may be explicitly listed |
| 4275 | in the "return" statement. Each expression must be single-valued |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 4276 | and <a href="#Assignability">assignable</a> |
| 4277 | to the corresponding element of the function's result type. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4278 | <pre> |
| 4279 | func simple_f() int { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4280 | return 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4281 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4282 | |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4283 | func complex_f1() (re float64, im float64) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4284 | return -7.0, -4.0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4285 | } |
| 4286 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4287 | </li> |
| 4288 | <li>The expression list in the "return" statement may be a single |
| 4289 | call to a multi-valued function. The effect is as if each value |
| 4290 | returned from that function were assigned to a temporary |
| 4291 | variable with the type of the respective value, followed by a |
| 4292 | "return" statement listing these variables, at which point the |
| 4293 | rules of the previous case apply. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4294 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4295 | func complex_f2() (re float64, im float64) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4296 | return complex_f1() |
| 4297 | } |
| 4298 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4299 | </li> |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 4300 | <li>The expression list may be empty if the function's result |
Robert Griesemer | fb64e0d | 2011-03-07 16:29:07 -0800 | [diff] [blame] | 4301 | type specifies names for its result parameters (§<a href="#Function_types">Function Types</a>). |
Rob Pike | db8c2b18 | 2010-06-11 21:30:03 -0700 | [diff] [blame] | 4302 | The result parameters act as ordinary local variables |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4303 | and the function may assign values to them as necessary. |
| 4304 | The "return" statement returns the values of these variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4305 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4306 | func complex_f3() (re float64, im float64) { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4307 | re = 7.0 |
| 4308 | im = 4.0 |
| 4309 | return |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4310 | } |
Robert Griesemer | fb64e0d | 2011-03-07 16:29:07 -0800 | [diff] [blame] | 4311 | |
| 4312 | func (devnull) Write(p []byte) (n int, _ os.Error) { |
| 4313 | n = len(p) |
| 4314 | return |
| 4315 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4316 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4317 | </li> |
| 4318 | </ol> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4319 | |
Rob Pike | db8c2b18 | 2010-06-11 21:30:03 -0700 | [diff] [blame] | 4320 | <p> |
| 4321 | Regardless of how they are declared, all the result values are initialized to the zero values for their type (§<a href="#The_zero_value">The zero value</a>) upon entry to the function. |
| 4322 | </p> |
| 4323 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4324 | <!-- |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4325 | <p> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 4326 | <span class="alert"> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 4327 | TODO: Define when return is required.<br /> |
| 4328 | TODO: Language about result parameters needs to go into a section on |
| 4329 | function/method invocation<br /> |
Robert Griesemer | 90cc4a5 | 2009-10-22 09:41:38 -0700 | [diff] [blame] | 4330 | </span> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4331 | </p> |
Rob Pike | 38d7bcf | 2011-05-08 14:05:18 -0700 | [diff] [blame] | 4332 | --> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4333 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4334 | <h3 id="Break_statements">Break statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4335 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4336 | <p> |
| 4337 | A "break" statement terminates execution of the innermost |
| 4338 | "for", "switch" or "select" statement. |
| 4339 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4340 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4341 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4342 | BreakStmt = "break" [ Label ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4343 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4344 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4345 | <p> |
| 4346 | If there is a label, it must be that of an enclosing |
| 4347 | "for", "switch" or "select" statement, and that is the one whose execution |
| 4348 | terminates |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4349 | (§<a href="#For_statements">For statements</a>, §<a href="#Switch_statements">Switch statements</a>, §<a href="#Select_statements">Select statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4350 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4351 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4352 | <pre> |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 4353 | L: |
| 4354 | for i < n { |
| 4355 | switch i { |
| 4356 | case 5: |
| 4357 | break L |
| 4358 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4359 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4360 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4361 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4362 | <h3 id="Continue_statements">Continue statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4363 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4364 | <p> |
| 4365 | A "continue" statement begins the next iteration of the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4366 | innermost "for" loop at its post statement (§<a href="#For_statements">For statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4367 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4368 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4369 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4370 | ContinueStmt = "continue" [ Label ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4371 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4372 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4373 | <p> |
Rob Pike | de921996 | 2010-04-28 13:18:40 -0700 | [diff] [blame] | 4374 | If there is a label, it must be that of an enclosing |
| 4375 | "for" statement, and that is the one whose execution |
| 4376 | advances |
| 4377 | (§<a href="#For_statements">For statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4378 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4379 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4380 | <h3 id="Goto_statements">Goto statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4381 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4382 | <p> |
| 4383 | A "goto" statement transfers control to the statement with the corresponding label. |
| 4384 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4385 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4386 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4387 | GotoStmt = "goto" Label . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4388 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4389 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4390 | <pre> |
| 4391 | goto Error |
| 4392 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4393 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4394 | <p> |
| 4395 | Executing the "goto" statement must not cause any variables to come into |
Russ Cox | f4c7db0 | 2011-06-17 12:49:04 -0400 | [diff] [blame] | 4396 | <a href="#Declarations_and_scope">scope</a> that were not already in scope at the point of the goto. |
| 4397 | For instance, this example: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4398 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4399 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4400 | <pre> |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 4401 | goto L // BAD |
| 4402 | v := 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4403 | L: |
| 4404 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4405 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4406 | <p> |
| 4407 | is erroneous because the jump to label <code>L</code> skips |
| 4408 | the creation of <code>v</code>. |
Russ Cox | f4c7db0 | 2011-06-17 12:49:04 -0400 | [diff] [blame] | 4409 | </p> |
| 4410 | |
| 4411 | <p> |
| 4412 | A "goto" statement outside a <a href="#Blocks">block</a> cannot jump to a label inside that block. |
| 4413 | For instance, this example: |
| 4414 | </p> |
| 4415 | |
| 4416 | <pre> |
| 4417 | if n%2 == 1 { |
| 4418 | goto L1 |
| 4419 | } |
| 4420 | for n > 0 { |
| 4421 | f() |
| 4422 | n-- |
| 4423 | L1: |
| 4424 | f() |
| 4425 | n-- |
| 4426 | } |
| 4427 | </pre> |
| 4428 | |
| 4429 | <p> |
| 4430 | is erroneous because the label <code>L1</code> is inside |
| 4431 | the "for" statement's block but the <code>goto</code> is not. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4432 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4433 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4434 | <h3 id="Fallthrough_statements">Fallthrough statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4435 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4436 | <p> |
| 4437 | A "fallthrough" statement transfers control to the first statement of the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4438 | next case clause in a expression "switch" statement (§<a href="#Expression_switches">Expression switches</a>). It may |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 4439 | be used only as the final non-empty statement in a case or default clause in an |
| 4440 | expression "switch" statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4441 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4442 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4443 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4444 | FallthroughStmt = "fallthrough" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4445 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4446 | |
| 4447 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4448 | <h3 id="Defer_statements">Defer statements</h3> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4449 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4450 | <p> |
| 4451 | A "defer" statement invokes a function whose execution is deferred to the moment |
| 4452 | the surrounding function returns. |
| 4453 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4454 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4455 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4456 | DeferStmt = "defer" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4457 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4458 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4459 | <p> |
| 4460 | The expression must be a function or method call. |
| 4461 | Each time the "defer" statement |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 4462 | executes, the parameters to the function call are evaluated and saved anew but the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4463 | function is not invoked. |
| 4464 | Deferred function calls are executed in LIFO order |
| 4465 | immediately before the surrounding function returns, |
Robert Griesemer | 48f0cd2 | 2010-03-23 17:30:14 -0700 | [diff] [blame] | 4466 | after the return values, if any, have been evaluated, but before they |
| 4467 | are returned to the caller. For instance, if the deferred function is |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4468 | a <a href="#Function_literals">function literal</a> and the surrounding |
Robert Griesemer | 48f0cd2 | 2010-03-23 17:30:14 -0700 | [diff] [blame] | 4469 | function has <a href="#Function_types">named result parameters</a> that |
| 4470 | are in scope within the literal, the deferred function may access and modify |
| 4471 | the result parameters before they are returned. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4472 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4473 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4474 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4475 | lock(l) |
| 4476 | defer unlock(l) // unlocking happens before surrounding function returns |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4477 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4478 | // prints 3 2 1 0 before surrounding function returns |
| 4479 | for i := 0; i <= 3; i++ { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4480 | defer fmt.Print(i) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4481 | } |
Robert Griesemer | 48f0cd2 | 2010-03-23 17:30:14 -0700 | [diff] [blame] | 4482 | |
| 4483 | // f returns 1 |
| 4484 | func f() (result int) { |
| 4485 | defer func() { |
| 4486 | result++ |
| 4487 | }() |
| 4488 | return 0 |
| 4489 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4490 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 4491 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4492 | <h2 id="Built-in_functions">Built-in functions</h2> |
| 4493 | |
| 4494 | <p> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4495 | Built-in functions are |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4496 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 4497 | They are called like any other function but some of them |
| 4498 | accept a type instead of an expression as the first argument. |
| 4499 | </p> |
| 4500 | |
Russ Cox | 2a5f0c6 | 2009-12-04 10:23:12 -0800 | [diff] [blame] | 4501 | <p> |
| 4502 | The built-in functions do not have standard Go types, |
| 4503 | so they can only appear in <a href="#Calls">call expressions</a>; |
| 4504 | they cannot be used as function values. |
| 4505 | </p> |
| 4506 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4507 | <pre class="ebnf"> |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 4508 | BuiltinCall = identifier "(" [ BuiltinArgs [ "," ] ] ")" . |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4509 | BuiltinArgs = Type [ "," ExpressionList ] | ExpressionList . |
| 4510 | </pre> |
| 4511 | |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 4512 | <h3 id="Close">Close</h3> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4513 | |
| 4514 | <p> |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 4515 | For a channel <code>c</code>, the built-in function <code>close(c)</code> |
| 4516 | marks the channel as unable to accept more values through a send operation; |
Russ Cox | 27c74d3 | 2011-01-21 15:07:13 -0500 | [diff] [blame] | 4517 | sending to or closing a closed channel causes a <a href="#Run_time_panics">run-time panic</a>. |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 4518 | After calling <code>close</code>, and after any previously |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4519 | sent values have been received, receive operations will return |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 4520 | the zero value for the channel's type without blocking. |
Russ Cox | 19d9a40 | 2011-01-27 15:34:28 -0500 | [diff] [blame] | 4521 | |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 4522 | The multi-valued <a href="#Receive_operator">receive operation</a> |
| 4523 | returns a received value along with an indication of whether the channel is closed. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4524 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4525 | |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 4526 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4527 | <h3 id="Length_and_capacity">Length and capacity</h3> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 4528 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4529 | <p> |
| 4530 | The built-in functions <code>len</code> and <code>cap</code> take arguments |
| 4531 | of various types and return a result of type <code>int</code>. |
| 4532 | The implementation guarantees that the result always fits into an <code>int</code>. |
| 4533 | </p> |
| 4534 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4535 | <pre class="grammar"> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4536 | Call Argument type Result |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 4537 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4538 | len(s) string type string length in bytes |
| 4539 | [n]T, *[n]T array length (== n) |
| 4540 | []T slice length |
| 4541 | map[K]T map length (number of defined keys) |
| 4542 | chan T number of elements queued in channel buffer |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4543 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4544 | cap(s) [n]T, *[n]T array length (== n) |
| 4545 | []T slice capacity |
| 4546 | chan T channel buffer capacity |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4547 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4548 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4549 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4550 | The capacity of a slice is the number of elements for which there is |
| 4551 | space allocated in the underlying array. |
| 4552 | At any time the following relationship holds: |
| 4553 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4554 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4555 | <pre> |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 4556 | 0 <= len(s) <= cap(s) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4557 | </pre> |
Robert Griesemer | 667ef6c | 2008-09-10 13:00:32 -0700 | [diff] [blame] | 4558 | |
Russ Cox | f442918 | 2010-07-01 17:49:47 -0700 | [diff] [blame] | 4559 | <p> |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 4560 | The length and capacity of a <code>nil</code> slice, map, or channel are 0. |
| 4561 | </p> |
| 4562 | |
| 4563 | <p> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4564 | The expression <code>len(s)</code> is <a href="#Constants">constant</a> if |
| 4565 | <code>s</code> is a string constant. The expressions <code>len(s)</code> and |
| 4566 | <code>cap(s)</code> are constants if the type of <code>s</code> is an array |
| 4567 | or pointer to an array and the expression <code>s</code> does not contain |
| 4568 | <a href="#Receive_operator">channel receives</a> or |
| 4569 | <a href="#Calls">function calls</a>; in this case <code>s</code> is not evaluated. |
| 4570 | Otherwise, invocations of <code>len</code> and <code>cap</code> are not |
| 4571 | constant and <code>s</code> is evaluated. |
Russ Cox | f442918 | 2010-07-01 17:49:47 -0700 | [diff] [blame] | 4572 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4573 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4574 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4575 | <h3 id="Allocation">Allocation</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4576 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4577 | <p> |
| 4578 | The built-in function <code>new</code> takes a type <code>T</code> and |
| 4579 | returns a value of type <code>*T</code>. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 4580 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4581 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4582 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4583 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4584 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4585 | new(T) |
| 4586 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4587 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4588 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4589 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4590 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4591 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4592 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4593 | type S struct { a int; b float64 } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4594 | new(S) |
| 4595 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4596 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4597 | <p> |
| 4598 | dynamically allocates memory for a variable of type <code>S</code>, |
| 4599 | initializes it (<code>a=0</code>, <code>b=0.0</code>), |
| 4600 | and returns a value of type <code>*S</code> containing the address |
| 4601 | of the memory. |
| 4602 | </p> |
| 4603 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4604 | <h3 id="Making_slices_maps_and_channels">Making slices, maps and channels</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4605 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4606 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4607 | Slices, maps and channels are reference types that do not require the |
| 4608 | extra indirection of an allocation with <code>new</code>. |
| 4609 | The built-in function <code>make</code> takes a type <code>T</code>, |
| 4610 | which must be a slice, map or channel type, |
| 4611 | optionally followed by a type-specific list of expressions. |
| 4612 | 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] | 4613 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4614 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4615 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4616 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4617 | <pre class="grammar"> |
Robert Griesemer | df674ff | 2010-05-04 17:31:40 -0700 | [diff] [blame] | 4618 | Call Type T Result |
| 4619 | |
| 4620 | make(T, n) slice slice of type T with length n and capacity n |
| 4621 | make(T, n, m) slice slice of type T with length n and capacity m |
| 4622 | |
| 4623 | make(T) map map of type T |
| 4624 | make(T, n) map map of type T with initial space for n elements |
| 4625 | |
| 4626 | make(T) channel synchronous channel of type T |
| 4627 | make(T, n) channel asynchronous channel of type T, buffer size n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4628 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4629 | |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4630 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4631 | <p> |
Robert Griesemer | df674ff | 2010-05-04 17:31:40 -0700 | [diff] [blame] | 4632 | The arguments <code>n</code> and <code>m</code> must be of integer type. |
| 4633 | A <a href="#Run_time_panics">run-time panic</a> occurs if <code>n</code> |
| 4634 | is negative or larger than <code>m</code>, or if <code>n</code> or |
| 4635 | <code>m</code> cannot be represented by an <code>int</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4636 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4637 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4638 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4639 | s := make([]int, 10, 100) // slice with len(s) == 10, cap(s) == 100 |
| 4640 | s := make([]int, 10) // slice with len(s) == cap(s) == 10 |
| 4641 | c := make(chan int, 10) // channel with a buffer size of 10 |
| 4642 | m := make(map[string] int, 100) // map with initial space for 100 elements |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4643 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 4644 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4645 | |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 4646 | <h3 id="Appending_and_copying_slices">Appending to and copying slices</h3> |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4647 | |
| 4648 | <p> |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 4649 | Two built-in functions assist in common slice operations. |
| 4650 | </p> |
| 4651 | |
| 4652 | <p> |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 4653 | The <a href="#Function_types">variadic</a> function <code>append</code> |
| 4654 | appends zero or more values <code>x</code> |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 4655 | to <code>s</code> of type <code>S</code>, which must be a slice type, and |
| 4656 | returns the resulting slice, also of type <code>S</code>. |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 4657 | The values <code>x</code> are passed to a parameter of type <code>...T</code> |
| 4658 | where <code>T</code> is the <a href="#Slice_types">element type</a> of |
| 4659 | <code>S</code> and the respective |
| 4660 | <a href="#Passing_arguments_to_..._parameters">parameter passing rules</a> apply. |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 4661 | </p> |
| 4662 | |
| 4663 | <pre class="grammar"> |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 4664 | append(s S, x ...T) S // T is the element type of S |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 4665 | </pre> |
| 4666 | |
| 4667 | <p> |
| 4668 | If the capacity of <code>s</code> is not large enough to fit the additional |
| 4669 | values, <code>append</code> allocates a new, sufficiently large slice that fits |
| 4670 | both the existing slice elements and the additional values. Thus, the returned |
| 4671 | slice may refer to a different underlying array. |
| 4672 | </p> |
| 4673 | |
| 4674 | <pre> |
| 4675 | s0 := []int{0, 0} |
| 4676 | s1 := append(s0, 2) // append a single element s1 == []int{0, 0, 2} |
| 4677 | s2 := append(s1, 3, 5, 7) // append multiple elements s2 == []int{0, 0, 2, 3, 5, 7} |
| 4678 | s3 := append(s2, s0...) // append a slice s3 == []int{0, 0, 2, 3, 5, 7, 0, 0} |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 4679 | |
| 4680 | var t []interface{} |
| 4681 | t = append(t, 42, 3.1415, "foo") t == []interface{}{42, 3.1415, "foo"} |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 4682 | </pre> |
| 4683 | |
| 4684 | <p> |
| 4685 | The function <code>copy</code> copies slice elements from |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4686 | a source <code>src</code> to a destination <code>dst</code> and returns the |
| 4687 | number of elements copied. Source and destination may overlap. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 4688 | Both arguments must have <a href="#Type_identity">identical</a> element type <code>T</code> and must be |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 4689 | <a href="#Assignability">assignable</a> to a slice of type <code>[]T</code>. |
Nigel Tao | 703b092 | 2011-05-15 16:04:37 -0700 | [diff] [blame] | 4690 | The number of elements copied is the minimum of |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4691 | <code>len(src)</code> and <code>len(dst)</code>. |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 4692 | As a special case, <code>copy</code> also accepts a destination argument assignable |
| 4693 | to type <code>[]byte</code> with a source argument of a string type. |
| 4694 | This form copies the bytes from the string into the byte slice. |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4695 | </p> |
| 4696 | |
| 4697 | <pre class="grammar"> |
| 4698 | copy(dst, src []T) int |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 4699 | copy(dst []byte, src string) int |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4700 | </pre> |
| 4701 | |
| 4702 | <p> |
| 4703 | Examples: |
| 4704 | </p> |
| 4705 | |
| 4706 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4707 | var a = [...]int{0, 1, 2, 3, 4, 5, 6, 7} |
| 4708 | var s = make([]int, 6) |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 4709 | var b = make([]byte, 5) |
| 4710 | n1 := copy(s, a[0:]) // n1 == 6, s == []int{0, 1, 2, 3, 4, 5} |
| 4711 | n2 := copy(s, s[2:]) // n2 == 4, s == []int{2, 3, 4, 5, 4, 5} |
| 4712 | n3 := copy(b, "Hello, World!") // n3 == 5, b == []byte("Hello") |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4713 | </pre> |
| 4714 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4715 | <h3 id="Complex_numbers">Assembling and disassembling complex numbers</h3> |
| 4716 | |
| 4717 | <p> |
| 4718 | Three functions assemble and disassemble complex numbers. |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4719 | The built-in function <code>complex</code> constructs a complex |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4720 | value from a floating-point real and imaginary part, while |
| 4721 | <code>real</code> and <code>imag</code> |
| 4722 | extract the real and imaginary parts of a complex value. |
| 4723 | </p> |
| 4724 | |
| 4725 | <pre class="grammar"> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4726 | complex(realPart, imaginaryPart floatT) complexT |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4727 | real(complexT) floatT |
| 4728 | imag(complexT) floatT |
| 4729 | </pre> |
| 4730 | |
| 4731 | <p> |
| 4732 | The type of the arguments and return value correspond. |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4733 | For <code>complex</code>, the two arguments must be of the same |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4734 | floating-point type and the return type is the complex type |
| 4735 | with the corresponding floating-point constituents: |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4736 | <code>complex64</code> for <code>float32</code>, |
| 4737 | <code>complex128</code> for <code>float64</code>. |
| 4738 | The <code>real</code> and <code>imag</code> functions |
| 4739 | together form the inverse, so for a complex value <code>z</code>, |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4740 | <code>z</code> <code>==</code> <code>complex(real(z),</code> <code>imag(z))</code>. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4741 | </p> |
| 4742 | |
| 4743 | <p> |
| 4744 | If the operands of these functions are all constants, the return |
| 4745 | value is a constant. |
| 4746 | </p> |
| 4747 | |
| 4748 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4749 | var a = complex(2, -2) // complex128 |
| 4750 | var b = complex(1.0, -1.4) // complex128 |
| 4751 | x := float32(math.Cos(math.Pi/2)) // float32 |
| 4752 | var c64 = complex(5, -x) // complex64 |
| 4753 | var im = imag(b) // float64 |
| 4754 | var rl = real(c64) // float32 |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4755 | </pre> |
| 4756 | |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4757 | <h3 id="Handling_panics">Handling panics</h3> |
| 4758 | |
| 4759 | <p> Two built-in functions, <code>panic</code> and <code>recover</code>, |
| 4760 | assist in reporting and handling <a href="#Run_time_panics">run-time panics</a> |
| 4761 | and program-defined error conditions. |
| 4762 | </p> |
| 4763 | |
| 4764 | <pre class="grammar"> |
| 4765 | func panic(interface{}) |
| 4766 | func recover() interface{} |
| 4767 | </pre> |
| 4768 | |
| 4769 | <p> |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4770 | When a function <code>F</code> calls <code>panic</code>, normal |
| 4771 | execution of <code>F</code> stops immediately. Any functions whose |
| 4772 | execution was <a href="#Defer_statements">deferred</a> by the |
| 4773 | invocation of <code>F</code> are run in the usual way, and then |
| 4774 | <code>F</code> returns to its caller. To the caller, <code>F</code> |
| 4775 | then behaves like a call to <code>panic</code>, terminating its own |
| 4776 | execution and running deferred functions. This continues until all |
| 4777 | functions in the goroutine have ceased execution, in reverse order. |
| 4778 | At that point, the program is |
| 4779 | terminated and the error condition is reported, including the value of |
| 4780 | the argument to <code>panic</code>. This termination sequence is |
| 4781 | called <i>panicking</i>. |
| 4782 | </p> |
| 4783 | |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4784 | <pre> |
| 4785 | panic(42) |
| 4786 | panic("unreachable") |
| 4787 | panic(Error("cannot parse")) |
| 4788 | </pre> |
| 4789 | |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4790 | <p> |
| 4791 | The <code>recover</code> function allows a program to manage behavior |
| 4792 | of a panicking goroutine. Executing a <code>recover</code> call |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4793 | <i>inside</i> a deferred function (but not any function called by it) stops |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4794 | the panicking sequence by restoring normal execution, and retrieves |
| 4795 | the error value passed to the call of <code>panic</code>. If |
| 4796 | <code>recover</code> is called outside the deferred function it will |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4797 | not stop a panicking sequence. In this case, or when the goroutine |
| 4798 | is not panicking, or if the argument supplied to <code>panic</code> |
| 4799 | was <code>nil</code>, <code>recover</code> returns <code>nil</code>. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4800 | </p> |
| 4801 | |
| 4802 | <p> |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4803 | The <code>protect</code> function in the example below invokes |
| 4804 | the function argument <code>g</code> and protects callers from |
| 4805 | run-time panics raised by <code>g</code>. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4806 | </p> |
| 4807 | |
| 4808 | <pre> |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4809 | func protect(g func()) { |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4810 | defer func() { |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4811 | log.Println("done") // Println executes normally even in there is a panic |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4812 | if x := recover(); x != nil { |
Rob Pike | 966bf71 | 2011-03-01 13:54:22 -0800 | [diff] [blame] | 4813 | log.Printf("run time panic: %v", x) |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4814 | } |
Rob Pike | e6b1d42 | 2011-04-05 11:01:25 -0700 | [diff] [blame] | 4815 | }() |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 4816 | log.Println("start") |
| 4817 | g() |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 4818 | } |
| 4819 | </pre> |
| 4820 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 4821 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4822 | <h3 id="Bootstrapping">Bootstrapping</h3> |
| 4823 | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 4824 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4825 | Current implementations provide several built-in functions useful during |
| 4826 | bootstrapping. These functions are documented for completeness but are not |
| 4827 | guaranteed to stay in the language. They do not return a result. |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 4828 | </p> |
| 4829 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4830 | <pre class="grammar"> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 4831 | Function Behavior |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4832 | |
| 4833 | print prints all arguments; formatting of arguments is implementation-specific |
| 4834 | println like print but prints spaces between arguments and a newline at the end |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 4835 | </pre> |
| 4836 | |
| 4837 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4838 | <h2 id="Packages">Packages</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4839 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4840 | <p> |
| 4841 | Go programs are constructed by linking together <i>packages</i>. |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 4842 | A package in turn is constructed from one or more source files |
| 4843 | that together declare constants, types, variables and functions |
| 4844 | belonging to the package and which are accessible in all files |
| 4845 | of the same package. Those elements may be |
| 4846 | <a href="#Exported_identifiers">exported</a> and used in another package. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4847 | </p> |
| 4848 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4849 | <h3 id="Source_file_organization">Source file organization</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4850 | |
| 4851 | <p> |
| 4852 | Each source file consists of a package clause defining the package |
| 4853 | to which it belongs, followed by a possibly empty set of import |
| 4854 | declarations that declare packages whose contents it wishes to use, |
| 4855 | followed by a possibly empty set of declarations of functions, |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4856 | types, variables, and constants. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4857 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4858 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4859 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4860 | SourceFile = PackageClause ";" { ImportDecl ";" } { TopLevelDecl ";" } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4861 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4862 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4863 | <h3 id="Package_clause">Package clause</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4864 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4865 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4866 | A package clause begins each source file and defines the package |
| 4867 | to which the file belongs. |
| 4868 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4869 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4870 | <pre class="ebnf"> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 4871 | PackageClause = "package" PackageName . |
| 4872 | PackageName = identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4873 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4874 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 4875 | <p> |
| 4876 | The PackageName must not be the <a href="#Blank_identifier">blank identifier</a>. |
| 4877 | </p> |
| 4878 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4879 | <pre> |
| 4880 | package math |
| 4881 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4882 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4883 | <p> |
| 4884 | A set of files sharing the same PackageName form the implementation of a package. |
| 4885 | An implementation may require that all source files for a package inhabit the same directory. |
| 4886 | </p> |
| 4887 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4888 | <h3 id="Import_declarations">Import declarations</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4889 | |
| 4890 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4891 | An import declaration states that the source file containing the |
| 4892 | declaration uses identifiers |
| 4893 | <a href="#Exported_identifiers">exported</a> by the <i>imported</i> |
| 4894 | package and enables access to them. The import names an |
| 4895 | identifier (PackageName) to be used for access and an ImportPath |
| 4896 | that specifies the package to be imported. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4897 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4898 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4899 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4900 | ImportDecl = "import" ( ImportSpec | "(" { ImportSpec ";" } ")" ) . |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4901 | ImportSpec = [ "." | PackageName ] ImportPath . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4902 | ImportPath = string_lit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4903 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4904 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4905 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4906 | The PackageName is used in <a href="#Qualified_identifiers">qualified identifiers</a> |
| 4907 | to access the exported identifiers of the package within the importing source file. |
| 4908 | It is declared in the <a href="#Blocks">file block</a>. |
| 4909 | If the PackageName is omitted, it defaults to the identifier specified in the |
Robert Griesemer | 556506e | 2011-02-22 09:34:13 -0800 | [diff] [blame] | 4910 | <a href="#Package_clause">package clause</a> of the imported package. |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4911 | If an explicit period (<code>.</code>) appears instead of a name, all the |
| 4912 | package's exported identifiers will be declared in the current file's |
| 4913 | file block and can be accessed without a qualifier. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4914 | </p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4915 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4916 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4917 | The interpretation of the ImportPath is implementation-dependent but |
| 4918 | it is typically a substring of the full file name of the compiled |
| 4919 | package and may be relative to a repository of installed packages. |
| 4920 | </p> |
| 4921 | |
| 4922 | <p> |
| 4923 | Assume we have compiled a package containing the package clause |
| 4924 | <code>package math</code>, which exports function <code>Sin</code>, and |
| 4925 | installed the compiled package in the file identified by |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4926 | <code>"lib/math"</code>. |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4927 | This table illustrates how <code>Sin</code> may be accessed in files |
| 4928 | that import the package after the |
| 4929 | various types of import declaration. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4930 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4931 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4932 | <pre class="grammar"> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4933 | Import declaration Local name of Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4934 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4935 | import "lib/math" math.Sin |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4936 | import M "lib/math" M.Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4937 | import . "lib/math" Sin |
| 4938 | </pre> |
| 4939 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4940 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 4941 | An import declaration declares a dependency relation between |
| 4942 | the importing and imported package. |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4943 | It is illegal for a package to import itself or to import a package without |
| 4944 | referring to any of its exported identifiers. To import a package solely for |
| 4945 | its side-effects (initialization), use the <a href="#Blank_identifier">blank</a> |
| 4946 | identifier as explicit package name: |
| 4947 | </p> |
| 4948 | |
| 4949 | <pre> |
| 4950 | import _ "lib/math" |
| 4951 | </pre> |
| 4952 | |
| 4953 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4954 | <h3 id="An_example_package">An example package</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4955 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4956 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4957 | Here is a complete Go package that implements a concurrent prime sieve. |
| 4958 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4959 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4960 | <pre> |
| 4961 | package main |
| 4962 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4963 | import "fmt" |
| 4964 | |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 4965 | // Send the sequence 2, 3, 4, … to channel 'ch'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4966 | func generate(ch chan<- int) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4967 | for i := 2; ; i++ { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4968 | ch <- i // Send 'i' to channel 'ch'. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4969 | } |
| 4970 | } |
| 4971 | |
Fazlul Shahriar | 330139e | 2009-11-30 21:23:58 -0800 | [diff] [blame] | 4972 | // Copy the values from channel 'src' to channel 'dst', |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4973 | // removing those divisible by 'prime'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4974 | func filter(src <-chan int, dst chan<- int, prime int) { |
| 4975 | for i := range src { // Loop over values received from 'src'. |
| 4976 | if i%prime != 0 { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4977 | dst <- i // Send 'i' to channel 'dst'. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4978 | } |
| 4979 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4980 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4981 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4982 | // The prime sieve: Daisy-chain filter processes together. |
| 4983 | func sieve() { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4984 | ch := make(chan int) // Create a new channel. |
| 4985 | go generate(ch) // Start generate() as a subprocess. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4986 | for { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4987 | prime := <-ch |
| 4988 | fmt.Print(prime, "\n") |
| 4989 | ch1 := make(chan int) |
| 4990 | go filter(ch, ch1, prime) |
| 4991 | ch = ch1 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4992 | } |
| 4993 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4994 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4995 | func main() { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4996 | sieve() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4997 | } |
| 4998 | </pre> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 4999 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5000 | <h2 id="Program_initialization_and_execution">Program initialization and execution</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5001 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5002 | <h3 id="The_zero_value">The zero value</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5003 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5004 | When memory is allocated to store a value, either through a declaration |
Rob Pike | 46f482a | 2011-05-25 06:44:09 +1000 | [diff] [blame] | 5005 | or a call of <code>make</code> or <code>new</code>, |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5006 | and no explicit initialization is provided, the memory is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5007 | given a default initialization. Each element of such a value is |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 5008 | set to the <i>zero value</i> for its type: <code>false</code> for booleans, |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5009 | <code>0</code> for integers, <code>0.0</code> for floats, <code>""</code> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 5010 | for strings, and <code>nil</code> for pointers, functions, interfaces, slices, channels, and maps. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 5011 | This initialization is done recursively, so for instance each element of an |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5012 | array of structs will have its fields zeroed if no value is specified. |
| 5013 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5014 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5015 | These two simple declarations are equivalent: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5016 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5017 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5018 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5019 | var i int |
| 5020 | var i int = 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5021 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5022 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5023 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5024 | After |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5025 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5026 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5027 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5028 | type T struct { i int; f float64; next *T } |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5029 | t := new(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5030 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5031 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5032 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5033 | the following holds: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5034 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5035 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5036 | <pre> |
| 5037 | t.i == 0 |
| 5038 | t.f == 0.0 |
| 5039 | t.next == nil |
| 5040 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5041 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5042 | <p> |
| 5043 | The same would also be true after |
| 5044 | </p> |
| 5045 | |
| 5046 | <pre> |
| 5047 | var t T |
| 5048 | </pre> |
| 5049 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5050 | <h3 id="Program_execution">Program execution</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5051 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5052 | A package with no imports is initialized by assigning initial values to |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 5053 | all its package-level variables |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5054 | and then calling any |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5055 | package-level function with the name and signature of |
| 5056 | </p> |
| 5057 | <pre> |
| 5058 | func init() |
| 5059 | </pre> |
| 5060 | <p> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 5061 | defined in its source. |
| 5062 | A package may contain multiple |
Rob Pike | 46f482a | 2011-05-25 06:44:09 +1000 | [diff] [blame] | 5063 | <code>init</code> functions, even |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 5064 | within a single source file; they execute |
| 5065 | in unspecified order. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5066 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5067 | <p> |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 5068 | Within a package, package-level variables are initialized, |
| 5069 | and constant values are determined, in |
| 5070 | data-dependent order: if the initializer of <code>A</code> |
| 5071 | depends on the value of <code>B</code>, <code>A</code> |
| 5072 | will be set after <code>B</code>. |
| 5073 | It is an error if such dependencies form a cycle. |
| 5074 | Dependency analysis is done lexically: <code>A</code> |
| 5075 | depends on <code>B</code> if the value of <code>A</code> |
| 5076 | contains a mention of <code>B</code>, contains a value |
| 5077 | whose initializer |
| 5078 | mentions <code>B</code>, or mentions a function that |
| 5079 | mentions <code>B</code>, recursively. |
| 5080 | If two items are not interdependent, they will be initialized |
| 5081 | in the order they appear in the source. |
Rob Pike | 01cadde | 2009-09-15 15:56:44 -0700 | [diff] [blame] | 5082 | Since the dependency analysis is done per package, it can produce |
| 5083 | unspecified results if <code>A</code>'s initializer calls a function defined |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 5084 | in another package that refers to <code>B</code>. |
| 5085 | </p> |
| 5086 | <p> |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 5087 | Initialization code may contain "go" statements, but the functions |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 5088 | they invoke do not begin execution until initialization of the entire |
| 5089 | program is complete. Therefore, all initialization code is run in a single |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5090 | goroutine. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5091 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5092 | <p> |
Rob Pike | 46f482a | 2011-05-25 06:44:09 +1000 | [diff] [blame] | 5093 | An <code>init</code> function cannot be referred to from anywhere |
| 5094 | in a program. In particular, <code>init</code> cannot be called explicitly, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5095 | 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] | 5096 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5097 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5098 | If a package has imports, the imported packages are initialized |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 5099 | before initializing the package itself. If multiple packages import |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5100 | 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] | 5101 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5102 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5103 | The importing of packages, by construction, guarantees that there can |
| 5104 | be no cyclic dependencies in initialization. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5105 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5106 | <p> |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 5107 | A complete program is created by linking a single, unimported package |
| 5108 | called the <i>main package</i> with all the packages it imports, transitively. |
| 5109 | The main package must |
| 5110 | have package name <code>main</code> and |
| 5111 | declare a function <code>main</code> that takes no |
| 5112 | arguments and returns no value. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5113 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5114 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5115 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 5116 | func main() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5117 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5118 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5119 | <p> |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 5120 | Program execution begins by initializing the main package and then |
| 5121 | invoking the function <code>main</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 5122 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5123 | <p> |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 5124 | When the function <code>main</code> returns, the program exits. |
| 5125 | It does not wait for other (non-<code>main</code>) goroutines to complete. |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 5126 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5127 | |
Evan Shaw | 21110c7 | 2010-04-22 10:14:53 -0700 | [diff] [blame] | 5128 | <h2 id="Run_time_panics">Run-time panics</h2> |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5129 | |
| 5130 | <p> |
| 5131 | Execution errors such as attempting to index an array out |
| 5132 | of bounds trigger a <i>run-time panic</i> equivalent to a call of |
| 5133 | the built-in function <a href="#Handling_panics"><code>panic</code></a> |
| 5134 | with a value of the implementation-defined interface type <code>runtime.Error</code>. |
| 5135 | That type defines at least the method |
| 5136 | <code>String() string</code>. The exact error values that |
| 5137 | represent distinct run-time error conditions are unspecified, |
| 5138 | at least for now. |
| 5139 | </p> |
| 5140 | |
| 5141 | <pre> |
| 5142 | package runtime |
| 5143 | |
| 5144 | type Error interface { |
| 5145 | String() string |
| 5146 | // and perhaps others |
| 5147 | } |
| 5148 | </pre> |
| 5149 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5150 | <h2 id="System_considerations">System considerations</h2> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5151 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5152 | <h3 id="Package_unsafe">Package <code>unsafe</code></h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5153 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5154 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5155 | The built-in package <code>unsafe</code>, known to the compiler, |
| 5156 | provides facilities for low-level programming including operations |
| 5157 | that violate the type system. A package using <code>unsafe</code> |
| 5158 | must be vetted manually for type safety. The package provides the |
| 5159 | following interface: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5160 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5161 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 5162 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5163 | package unsafe |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5164 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 5165 | type ArbitraryType int // shorthand for an arbitrary Go type; it is not a real type |
| 5166 | type Pointer *ArbitraryType |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5167 | |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5168 | func Alignof(variable ArbitraryType) uintptr |
| 5169 | func Offsetof(selector ArbitraryType) uinptr |
| 5170 | func Sizeof(variable ArbitraryType) uintptr |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5171 | |
Gustavo Niemeyer | f8404ee | 2011-02-04 09:29:08 -0800 | [diff] [blame] | 5172 | func Reflect(val interface{}) (typ runtime.Type, addr uintptr) |
| 5173 | func Typeof(val interface{}) (typ interface{}) |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5174 | func Unreflect(typ runtime.Type, addr uintptr) interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5175 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5176 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5177 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5178 | Any pointer or value of type <code>uintptr</code> can be converted into |
| 5179 | a <code>Pointer</code> and vice versa. |
| 5180 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5181 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5182 | The function <code>Sizeof</code> takes an expression denoting a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 5183 | variable of any type and returns the size of the variable in bytes. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5184 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5185 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5186 | The function <code>Offsetof</code> takes a selector (§<a href="#Selectors">Selectors</a>) denoting a struct |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5187 | field of any type and returns the field offset in bytes relative to the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5188 | struct's address. |
| 5189 | For a struct <code>s</code> with field <code>f</code>: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5190 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5191 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5192 | <pre> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5193 | uintptr(unsafe.Pointer(&s)) + unsafe.Offsetof(s.f) == uintptr(unsafe.Pointer(&s.f)) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5194 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5195 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5196 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5197 | Computer architectures may require memory addresses to be <i>aligned</i>; |
| 5198 | that is, for addresses of a variable to be a multiple of a factor, |
| 5199 | the variable's type's <i>alignment</i>. The function <code>Alignof</code> |
| 5200 | takes an expression denoting a variable of any type and returns the |
| 5201 | alignment of the (type of the) variable in bytes. For a variable |
| 5202 | <code>x</code>: |
| 5203 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5204 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5205 | <pre> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5206 | uintptr(unsafe.Pointer(&x)) % unsafe.Alignof(x) == 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5207 | </pre> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 5208 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5209 | <p> |
| 5210 | Calls to <code>Alignof</code>, <code>Offsetof</code>, and |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5211 | <code>Sizeof</code> are compile-time constant expressions of type <code>uintptr</code>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5212 | </p> |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 5213 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5214 | The functions <code>unsafe.Typeof</code>, |
| 5215 | <code>unsafe.Reflect</code>, |
Russ Cox | 13dac65 | 2009-09-28 14:16:33 -0700 | [diff] [blame] | 5216 | and <code>unsafe.Unreflect</code> allow access at run time to the dynamic |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5217 | types and values stored in interfaces. |
| 5218 | <code>Typeof</code> returns a representation of |
| 5219 | <code>val</code>'s |
| 5220 | dynamic type as a <code>runtime.Type</code>. |
| 5221 | <code>Reflect</code> allocates a copy of |
| 5222 | <code>val</code>'s dynamic |
| 5223 | value and returns both the type and the address of the copy. |
| 5224 | <code>Unreflect</code> inverts <code>Reflect</code>, |
| 5225 | creating an |
| 5226 | interface value from a type and address. |
Russ Cox | 16205a3 | 2010-01-18 15:59:14 -0800 | [diff] [blame] | 5227 | The <a href="/pkg/reflect/"><code>reflect</code> package</a> built on these primitives |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 5228 | provides a safe, more convenient way to inspect interface values. |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 5229 | </p> |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 5230 | |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5231 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5232 | <h3 id="Size_and_alignment_guarantees">Size and alignment guarantees</h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5233 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5234 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5235 | For the numeric types (§<a href="#Numeric_types">Numeric types</a>), the following sizes are guaranteed: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5236 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5237 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 5238 | <pre class="grammar"> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 5239 | type size in bytes |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5240 | |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 5241 | byte, uint8, int8 1 |
| 5242 | uint16, int16 2 |
| 5243 | uint32, int32, float32 4 |
| 5244 | uint64, int64, float64, complex64 8 |
| 5245 | complex128 16 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5246 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5247 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5248 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5249 | The following minimal alignment properties are guaranteed: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 5250 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5251 | <ol> |
Robert Griesemer | dd916be | 2011-01-10 14:25:17 -0800 | [diff] [blame] | 5252 | <li>For a variable <code>x</code> of any type: <code>unsafe.Alignof(x)</code> is at least 1. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 5253 | </li> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5254 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5255 | <li>For a variable <code>x</code> of struct type: <code>unsafe.Alignof(x)</code> is the largest of |
Robert Griesemer | dd916be | 2011-01-10 14:25:17 -0800 | [diff] [blame] | 5256 | all the values <code>unsafe.Alignof(x.f)</code> for each field <code>f</code> of <code>x</code>, but at least 1. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 5257 | </li> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5258 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 5259 | <li>For a variable <code>x</code> of array type: <code>unsafe.Alignof(x)</code> is the same as |
| 5260 | <code>unsafe.Alignof(x[0])</code>, but at least 1. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 5261 | </li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5262 | </ol> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 5263 | |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5264 | <span class="alert"> |
| 5265 | <h2 id="Implementation_differences">Implementation differences - TODO</h2> |
Robert Griesemer | 237c8ab | 2009-09-01 14:07:30 -0700 | [diff] [blame] | 5266 | <ul> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5267 | <li><code>len(a)</code> is only a constant if <code>a</code> is a (qualified) identifier denoting an array or pointer to an array.</li> |
| 5268 | <li><code>nil</code> maps are not treated like empty maps.</li> |
| 5269 | <li>Trying to send/receive from a <code>nil</code> channel causes a run-time panic.</li> |
| 5270 | <li><code>unsafe.Alignof</code>, <code>unsafe.Offsetof</code>, and <code>unsafe.Sizeof</code> return an <code>int</code>.</li> |
Robert Griesemer | 237c8ab | 2009-09-01 14:07:30 -0700 | [diff] [blame] | 5271 | </ul> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 5272 | </span> |