Andrew Gerrand | 7cb21a7 | 2012-01-19 11:24:54 +1100 | [diff] [blame] | 1 | <!--{ |
| 2 | "Title": "The Go Programming Language Specification", |
Robert Griesemer | 57c81ef | 2015-12-15 13:13:38 -0800 | [diff] [blame] | 3 | "Subtitle": "Version of December 15, 2015", |
Andrew Gerrand | 48ba6fe | 2013-10-04 09:45:06 +1000 | [diff] [blame] | 4 | "Path": "/ref/spec" |
Andrew Gerrand | 7cb21a7 | 2012-01-19 11:24:54 +1100 | [diff] [blame] | 5 | }--> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 7 | <h2 id="Introduction">Introduction</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 8 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 9 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 10 | This is a reference manual for the Go programming language. For |
Andrew Gerrand | 43ad89d | 2014-07-25 10:28:39 +1000 | [diff] [blame] | 11 | more information and other documents, see <a href="/">golang.org</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 12 | </p> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 13 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 14 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 15 | Go is a general-purpose language designed with systems programming |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 16 | in mind. It is strongly typed and garbage-collected and has explicit |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 17 | support for concurrent programming. Programs are constructed from |
| 18 | <i>packages</i>, whose properties allow efficient management of |
| 19 | dependencies. The existing implementations use a traditional |
| 20 | compile/link model to generate executable binaries. |
| 21 | </p> |
| 22 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 23 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 24 | The grammar is compact and regular, allowing for easy analysis by |
| 25 | automatic tools such as integrated development environments. |
| 26 | </p> |
Larry Hosken | 698c6c0 | 2009-09-17 08:05:12 -0700 | [diff] [blame] | 27 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 28 | <h2 id="Notation">Notation</h2> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 29 | <p> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 30 | The syntax is specified using Extended Backus-Naur Form (EBNF): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 31 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 32 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 33 | <pre class="grammar"> |
Robert Griesemer | 32b822f | 2011-05-13 12:54:51 -0700 | [diff] [blame] | 34 | Production = production_name "=" [ Expression ] "." . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 35 | Expression = Alternative { "|" Alternative } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 36 | Alternative = Term { Term } . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 37 | Term = production_name | token [ "…" token ] | Group | Option | Repetition . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 38 | Group = "(" Expression ")" . |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 39 | Option = "[" Expression "]" . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 40 | Repetition = "{" Expression "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 41 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 42 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 43 | <p> |
| 44 | Productions are expressions constructed from terms and the following |
| 45 | operators, in increasing precedence: |
| 46 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 47 | <pre class="grammar"> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 48 | | alternation |
| 49 | () grouping |
| 50 | [] option (0 or 1 times) |
| 51 | {} repetition (0 to n times) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 52 | </pre> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 53 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 54 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 55 | Lower-case production names are used to identify lexical tokens. |
Robert Griesemer | 7c1cb37 | 2012-02-29 10:39:20 -0800 | [diff] [blame] | 56 | Non-terminals are in CamelCase. Lexical tokens are enclosed in |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 57 | double quotes <code>""</code> or back quotes <code>``</code>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 58 | </p> |
| 59 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 60 | <p> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 61 | The form <code>a … b</code> represents the set of characters from |
| 62 | <code>a</code> through <code>b</code> as alternatives. The horizontal |
Jeremy Jackins | 7e05426 | 2012-03-19 08:26:36 +1100 | [diff] [blame] | 63 | ellipsis <code>…</code> is also used elsewhere in the spec to informally denote various |
Rob Pike | 8040f9b | 2012-02-13 14:38:31 +1100 | [diff] [blame] | 64 | enumerations or code snippets that are not further specified. The character <code>…</code> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 65 | (as opposed to the three characters <code>...</code>) is not a token of the Go |
| 66 | language. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 67 | </p> |
| 68 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 69 | <h2 id="Source_code_representation">Source code representation</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 70 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 71 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 72 | Source code is Unicode text encoded in |
| 73 | <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] | 74 | canonicalized, so a single accented code point is distinct from the |
| 75 | same character constructed from combining an accent and a letter; |
| 76 | those are treated as two code points. For simplicity, this document |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 77 | will use the unqualified term <i>character</i> to refer to a Unicode code point |
| 78 | in the source text. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 79 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 80 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 81 | Each code point is distinct; for instance, upper and lower case letters |
| 82 | are different characters. |
| 83 | </p> |
Russ Cox | b7d9ffe | 2010-02-16 16:47:18 -0800 | [diff] [blame] | 84 | <p> |
Robert Griesemer | f42e883 | 2010-02-17 15:50:34 -0800 | [diff] [blame] | 85 | Implementation restriction: For compatibility with other tools, a |
| 86 | compiler may disallow the NUL character (U+0000) in the source text. |
Russ Cox | b7d9ffe | 2010-02-16 16:47:18 -0800 | [diff] [blame] | 87 | </p> |
Rob Pike | afac01d | 2012-09-06 10:37:13 -0700 | [diff] [blame] | 88 | <p> |
| 89 | Implementation restriction: For compatibility with other tools, a |
Rob Pike | 488350a | 2012-09-07 10:28:24 -0700 | [diff] [blame] | 90 | compiler may ignore a UTF-8-encoded byte order mark |
| 91 | (U+FEFF) if it is the first Unicode code point in the source text. |
Rob Pike | 548c65a | 2013-04-11 11:33:25 -0700 | [diff] [blame] | 92 | A byte order mark may be disallowed anywhere else in the source. |
Rob Pike | afac01d | 2012-09-06 10:37:13 -0700 | [diff] [blame] | 93 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 94 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 95 | <h3 id="Characters">Characters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 96 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 97 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 98 | The following terms are used to denote specific Unicode character classes: |
| 99 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 100 | <pre class="ebnf"> |
Robert Griesemer | 0e8032c | 2011-05-05 09:03:00 -0700 | [diff] [blame] | 101 | newline = /* the Unicode code point U+000A */ . |
| 102 | unicode_char = /* an arbitrary Unicode code point except newline */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 103 | unicode_letter = /* a Unicode code point classified as "Letter" */ . |
Robert Griesemer | 838b5ad | 2011-02-03 12:27:41 -0800 | [diff] [blame] | 104 | unicode_digit = /* a Unicode code point classified as "Decimal Digit" */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 105 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 106 | |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 107 | <p> |
Rob Pike | e6863e7 | 2014-02-25 14:15:49 -0800 | [diff] [blame] | 108 | In <a href="http://www.unicode.org/versions/Unicode6.3.0/">The Unicode Standard 6.3</a>, |
Robert Griesemer | 838b5ad | 2011-02-03 12:27:41 -0800 | [diff] [blame] | 109 | Section 4.5 "General Category" |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 110 | defines a set of character categories. Go treats |
| 111 | those characters in category Lu, Ll, Lt, Lm, or Lo as Unicode letters, |
| 112 | and those in category Nd as Unicode digits. |
| 113 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 114 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 115 | <h3 id="Letters_and_digits">Letters and digits</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 116 | |
| 117 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 118 | The underscore character <code>_</code> (U+005F) is considered a letter. |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 119 | </p> |
| 120 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 121 | letter = unicode_letter | "_" . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 122 | decimal_digit = "0" … "9" . |
| 123 | octal_digit = "0" … "7" . |
| 124 | hex_digit = "0" … "9" | "A" … "F" | "a" … "f" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 125 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 126 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 127 | <h2 id="Lexical_elements">Lexical elements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 128 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 129 | <h3 id="Comments">Comments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 130 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 131 | <p> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 132 | Comments serve as program documentation. There are two forms: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 133 | </p> |
| 134 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 135 | <ol> |
| 136 | <li> |
| 137 | <i>Line comments</i> start with the character sequence <code>//</code> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 138 | and stop at the end of the line. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 139 | </li> |
| 140 | <li> |
| 141 | <i>General comments</i> start with the character sequence <code>/*</code> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 142 | and stop with the first subsequent character sequence <code>*/</code>. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 143 | </li> |
| 144 | </ol> |
| 145 | |
| 146 | <p> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 147 | A comment cannot start inside a <a href="#Rune_literals">rune</a> or |
| 148 | <a href="#String_literals">string literal</a>, or inside a comment. |
| 149 | A general comment containing no newlines acts like a space. |
| 150 | Any other comment acts like a newline. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 151 | </p> |
| 152 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 153 | <h3 id="Tokens">Tokens</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 154 | |
| 155 | <p> |
| 156 | Tokens form the vocabulary of the Go language. |
Robert Griesemer | eb109a7 | 2009-12-28 14:40:42 -0800 | [diff] [blame] | 157 | There are four classes: <i>identifiers</i>, <i>keywords</i>, <i>operators |
| 158 | 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] | 159 | spaces (U+0020), horizontal tabs (U+0009), |
| 160 | carriage returns (U+000D), and newlines (U+000A), |
| 161 | is ignored except as it separates tokens |
Robert Griesemer | 0e66a13 | 2010-09-27 18:59:11 -0700 | [diff] [blame] | 162 | 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] | 163 | may trigger the insertion of a <a href="#Semicolons">semicolon</a>. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 164 | While breaking the input into tokens, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 165 | the next token is the longest sequence of characters that form a |
| 166 | valid token. |
| 167 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 168 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 169 | <h3 id="Semicolons">Semicolons</h3> |
| 170 | |
| 171 | <p> |
| 172 | The formal grammar uses semicolons <code>";"</code> as terminators in |
| 173 | a number of productions. Go programs may omit most of these semicolons |
| 174 | using the following two rules: |
| 175 | </p> |
| 176 | |
| 177 | <ol> |
| 178 | <li> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 179 | When the input is broken into tokens, a semicolon is automatically inserted |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 180 | into the token stream immediately after a line's final token if that token is |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 181 | <ul> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 182 | <li>an |
| 183 | <a href="#Identifiers">identifier</a> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 184 | </li> |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 185 | |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 186 | <li>an |
| 187 | <a href="#Integer_literals">integer</a>, |
| 188 | <a href="#Floating-point_literals">floating-point</a>, |
| 189 | <a href="#Imaginary_literals">imaginary</a>, |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 190 | <a href="#Rune_literals">rune</a>, or |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 191 | <a href="#String_literals">string</a> literal |
| 192 | </li> |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 193 | |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 194 | <li>one of the <a href="#Keywords">keywords</a> |
| 195 | <code>break</code>, |
| 196 | <code>continue</code>, |
| 197 | <code>fallthrough</code>, or |
| 198 | <code>return</code> |
| 199 | </li> |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 200 | |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 201 | <li>one of the <a href="#Operators_and_Delimiters">operators and delimiters</a> |
| 202 | <code>++</code>, |
| 203 | <code>--</code>, |
| 204 | <code>)</code>, |
| 205 | <code>]</code>, or |
| 206 | <code>}</code> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 207 | </li> |
| 208 | </ul> |
| 209 | </li> |
| 210 | |
| 211 | <li> |
| 212 | To allow complex statements to occupy a single line, a semicolon |
| 213 | may be omitted before a closing <code>")"</code> or <code>"}"</code>. |
| 214 | </li> |
| 215 | </ol> |
| 216 | |
| 217 | <p> |
| 218 | To reflect idiomatic use, code examples in this document elide semicolons |
| 219 | using these rules. |
| 220 | </p> |
| 221 | |
| 222 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 223 | <h3 id="Identifiers">Identifiers</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 224 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 225 | <p> |
| 226 | Identifiers name program entities such as variables and types. |
| 227 | An identifier is a sequence of one or more letters and digits. |
| 228 | The first character in an identifier must be a letter. |
| 229 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 230 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 231 | identifier = letter { letter | unicode_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 232 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 233 | <pre> |
| 234 | a |
| 235 | _x9 |
| 236 | ThisVariableIsExported |
| 237 | αβ |
| 238 | </pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 239 | |
| 240 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 241 | Some identifiers are <a href="#Predeclared_identifiers">predeclared</a>. |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 242 | </p> |
| 243 | |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 244 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 245 | <h3 id="Keywords">Keywords</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 246 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 247 | <p> |
| 248 | The following keywords are reserved and may not be used as identifiers. |
| 249 | </p> |
| 250 | <pre class="grammar"> |
| 251 | break default func interface select |
| 252 | case defer go map struct |
| 253 | chan else goto package switch |
| 254 | const fallthrough if range type |
| 255 | continue for import return var |
| 256 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 257 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 258 | <h3 id="Operators_and_Delimiters">Operators and Delimiters</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 259 | |
| 260 | <p> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 261 | 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] | 262 | </p> |
| 263 | <pre class="grammar"> |
| 264 | + & += &= && == != ( ) |
| 265 | - | -= |= || < <= [ ] |
| 266 | * ^ *= ^= <- > >= { } |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 267 | / << /= <<= ++ = := , ; |
| 268 | % >> %= >>= -- ! ... . : |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 269 | &^ &^= |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 270 | </pre> |
| 271 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 272 | <h3 id="Integer_literals">Integer literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 273 | |
| 274 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 275 | An integer literal is a sequence of digits representing an |
| 276 | <a href="#Constants">integer constant</a>. |
| 277 | 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] | 278 | <code>0X</code> for hexadecimal. In hexadecimal literals, letters |
| 279 | <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] | 280 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 281 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 282 | int_lit = decimal_lit | octal_lit | hex_lit . |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 283 | decimal_lit = ( "1" … "9" ) { decimal_digit } . |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 284 | octal_lit = "0" { octal_digit } . |
| 285 | hex_lit = "0" ( "x" | "X" ) hex_digit { hex_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 286 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 287 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 288 | <pre> |
| 289 | 42 |
| 290 | 0600 |
| 291 | 0xBadFace |
| 292 | 170141183460469231731687303715884105727 |
| 293 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 294 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 295 | <h3 id="Floating-point_literals">Floating-point literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 296 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 297 | A floating-point literal is a decimal representation of a |
| 298 | <a href="#Constants">floating-point constant</a>. |
| 299 | It has an integer part, a decimal point, a fractional part, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 300 | and an exponent part. The integer and fractional part comprise |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 301 | 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] | 302 | followed by an optionally signed decimal exponent. One of the |
| 303 | integer part or the fractional part may be elided; one of the decimal |
| 304 | point or the exponent may be elided. |
| 305 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 306 | <pre class="ebnf"> |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 307 | float_lit = decimals "." [ decimals ] [ exponent ] | |
| 308 | decimals exponent | |
| 309 | "." decimals [ exponent ] . |
| 310 | decimals = decimal_digit { decimal_digit } . |
| 311 | exponent = ( "e" | "E" ) [ "+" | "-" ] decimals . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 312 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 313 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 314 | <pre> |
| 315 | 0. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 316 | 72.40 |
| 317 | 072.40 // == 72.40 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 318 | 2.71828 |
| 319 | 1.e+0 |
| 320 | 6.67428e-11 |
| 321 | 1E6 |
| 322 | .25 |
| 323 | .12345E+5 |
| 324 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 325 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 326 | <h3 id="Imaginary_literals">Imaginary literals</h3> |
| 327 | <p> |
| 328 | An imaginary literal is a decimal representation of the imaginary part of a |
| 329 | <a href="#Constants">complex constant</a>. |
| 330 | It consists of a |
| 331 | <a href="#Floating-point_literals">floating-point literal</a> |
| 332 | or decimal integer followed |
| 333 | by the lower-case letter <code>i</code>. |
| 334 | </p> |
| 335 | <pre class="ebnf"> |
| 336 | imaginary_lit = (decimals | float_lit) "i" . |
| 337 | </pre> |
| 338 | |
| 339 | <pre> |
| 340 | 0i |
| 341 | 011i // == 11i |
| 342 | 0.i |
| 343 | 2.71828i |
| 344 | 1.e+0i |
| 345 | 6.67428e-11i |
| 346 | 1E6i |
| 347 | .25i |
| 348 | .12345E+5i |
| 349 | </pre> |
| 350 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 351 | |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 352 | <h3 id="Rune_literals">Rune literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 353 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 354 | <p> |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 355 | A rune literal represents a <a href="#Constants">rune constant</a>, |
| 356 | an integer value identifying a Unicode code point. |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 357 | A rune literal is expressed as one or more characters enclosed in single quotes, |
| 358 | as in <code>'x'</code> or <code>'\n'</code>. |
| 359 | Within the quotes, any character may appear except newline and unescaped single |
| 360 | quote. A single quoted character represents the Unicode value |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 361 | of the character itself, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 362 | while multi-character sequences beginning with a backslash encode |
| 363 | values in various formats. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 364 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 365 | <p> |
| 366 | The simplest form represents the single character within the quotes; |
| 367 | since Go source text is Unicode characters encoded in UTF-8, multiple |
| 368 | UTF-8-encoded bytes may represent a single integer value. For |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 369 | instance, the literal <code>'a'</code> holds a single byte representing |
| 370 | a literal <code>a</code>, Unicode U+0061, value <code>0x61</code>, while |
| 371 | <code>'ä'</code> holds two bytes (<code>0xc3</code> <code>0xa4</code>) representing |
| 372 | a literal <code>a</code>-dieresis, U+00E4, value <code>0xe4</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 373 | </p> |
| 374 | <p> |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 375 | Several backslash escapes allow arbitrary values to be encoded as |
Oling Cat | 845f4d6 | 2012-09-05 14:53:13 +1000 | [diff] [blame] | 376 | ASCII text. There are four ways to represent the integer value |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 377 | as a numeric constant: <code>\x</code> followed by exactly two hexadecimal |
| 378 | digits; <code>\u</code> followed by exactly four hexadecimal digits; |
| 379 | <code>\U</code> followed by exactly eight hexadecimal digits, and a |
| 380 | plain backslash <code>\</code> followed by exactly three octal digits. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 381 | In each case the value of the literal is the value represented by |
| 382 | the digits in the corresponding base. |
| 383 | </p> |
| 384 | <p> |
| 385 | Although these representations all result in an integer, they have |
| 386 | different valid ranges. Octal escapes must represent a value between |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 387 | 0 and 255 inclusive. Hexadecimal escapes satisfy this condition |
| 388 | by construction. The escapes <code>\u</code> and <code>\U</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 389 | represent Unicode code points so within them some values are illegal, |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 390 | in particular those above <code>0x10FFFF</code> and surrogate halves. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 391 | </p> |
| 392 | <p> |
| 393 | After a backslash, certain single-character escapes represent special values: |
| 394 | </p> |
| 395 | <pre class="grammar"> |
| 396 | \a U+0007 alert or bell |
| 397 | \b U+0008 backspace |
| 398 | \f U+000C form feed |
| 399 | \n U+000A line feed or newline |
| 400 | \r U+000D carriage return |
| 401 | \t U+0009 horizontal tab |
| 402 | \v U+000b vertical tab |
| 403 | \\ U+005c backslash |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 404 | \' U+0027 single quote (valid escape only within rune literals) |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 405 | \" U+0022 double quote (valid escape only within string literals) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 406 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 407 | <p> |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 408 | All other sequences starting with a backslash are illegal inside rune literals. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 409 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 410 | <pre class="ebnf"> |
Robert Griesemer | c863db4 | 2013-01-07 18:02:58 -0800 | [diff] [blame] | 411 | rune_lit = "'" ( unicode_value | byte_value ) "'" . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 412 | unicode_value = unicode_char | little_u_value | big_u_value | escaped_char . |
| 413 | byte_value = octal_byte_value | hex_byte_value . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 414 | octal_byte_value = `\` octal_digit octal_digit octal_digit . |
| 415 | hex_byte_value = `\` "x" hex_digit hex_digit . |
| 416 | little_u_value = `\` "u" hex_digit hex_digit hex_digit hex_digit . |
| 417 | big_u_value = `\` "U" hex_digit hex_digit hex_digit hex_digit |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 418 | hex_digit hex_digit hex_digit hex_digit . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 419 | escaped_char = `\` ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | `\` | "'" | `"` ) . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 420 | </pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 421 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 422 | <pre> |
| 423 | 'a' |
| 424 | 'ä' |
| 425 | '本' |
| 426 | '\t' |
| 427 | '\000' |
| 428 | '\007' |
| 429 | '\377' |
| 430 | '\x07' |
| 431 | '\xff' |
| 432 | '\u12e4' |
| 433 | '\U00101234' |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 434 | '\'' // rune literal containing single quote character |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 435 | 'aa' // illegal: too many characters |
| 436 | '\xa' // illegal: too few hexadecimal digits |
| 437 | '\0' // illegal: too few octal digits |
| 438 | '\uDFFF' // illegal: surrogate half |
| 439 | '\U00110000' // illegal: invalid Unicode code point |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 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> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 451 | Raw string literals are character sequences between back quotes, as in |
| 452 | <code>`foo`</code>. Within the quotes, any character may appear 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 |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 454 | string composed of the uninterpreted (implicitly UTF-8-encoded) characters |
| 455 | between the quotes; |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 456 | in particular, backslashes have no special meaning and the string may |
Robert Griesemer | 11b7c89 | 2011-12-15 10:51:51 -0800 | [diff] [blame] | 457 | contain newlines. |
Ian Lance Taylor | 2a627da | 2014-05-16 12:20:03 -0700 | [diff] [blame] | 458 | Carriage return characters ('\r') inside raw string literals |
Rob Pike | c26ca91 | 2011-12-14 21:52:41 -0800 | [diff] [blame] | 459 | are discarded from the raw string value. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 460 | </p> |
| 461 | <p> |
| 462 | Interpreted string literals are character sequences between double |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 463 | quotes, as in <code>"bar"</code>. |
| 464 | Within the quotes, any character may appear except newline and unescaped double quote. |
| 465 | The text between the quotes forms the |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 466 | value of the literal, with backslash escapes interpreted as they |
Robin Eklind | f82097f | 2014-09-03 10:44:33 -0700 | [diff] [blame] | 467 | are in <a href="#Rune_literals">rune literals</a> (except that <code>\'</code> is illegal and |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 468 | <code>\"</code> is legal), with the same restrictions. |
| 469 | The three-digit octal (<code>\</code><i>nnn</i>) |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 470 | 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] | 471 | <i>bytes</i> of the resulting string; all other escapes represent |
| 472 | the (possibly multi-byte) UTF-8 encoding of individual <i>characters</i>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 473 | Thus inside a string literal <code>\377</code> and <code>\xFF</code> represent |
| 474 | a single byte of value <code>0xFF</code>=255, while <code>ÿ</code>, |
| 475 | <code>\u00FF</code>, <code>\U000000FF</code> and <code>\xc3\xbf</code> represent |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 476 | 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] | 477 | U+00FF. |
| 478 | </p> |
| 479 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 480 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 481 | string_lit = raw_string_lit | interpreted_string_lit . |
Robert Griesemer | 0e8032c | 2011-05-05 09:03:00 -0700 | [diff] [blame] | 482 | raw_string_lit = "`" { unicode_char | newline } "`" . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 483 | interpreted_string_lit = `"` { unicode_value | byte_value } `"` . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 484 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 485 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 486 | <pre> |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 487 | `abc` // same as "abc" |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 488 | `\n |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 489 | \n` // same as "\\n\n\\n" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 490 | "\n" |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 491 | "\"" // same as `"` |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 492 | "Hello, world!\n" |
| 493 | "日本語" |
| 494 | "\u65e5本\U00008a9e" |
| 495 | "\xff\u00FF" |
Robert Griesemer | 37a0975 | 2015-05-29 17:36:26 -0700 | [diff] [blame] | 496 | "\uD800" // illegal: surrogate half |
| 497 | "\U00110000" // illegal: invalid Unicode code point |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 498 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 499 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 500 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 501 | These examples all represent the same string: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 502 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 503 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 504 | <pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 505 | "日本語" // UTF-8 input text |
| 506 | `日本語` // UTF-8 input text as a raw literal |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 507 | "\u65e5\u672c\u8a9e" // the explicit Unicode code points |
| 508 | "\U000065e5\U0000672c\U00008a9e" // the explicit Unicode code points |
| 509 | "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e" // the explicit UTF-8 bytes |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 510 | </pre> |
Robert Griesemer | cd49927 | 2008-09-29 12:09:00 -0700 | [diff] [blame] | 511 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 512 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 513 | If the source code represents a character as two code points, such as |
| 514 | a combining form involving an accent and a letter, the result will be |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 515 | an error if placed in a rune literal (it is not a single code |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 516 | point), and will appear as two code points if placed in a string |
| 517 | literal. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 518 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 519 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 520 | |
| 521 | <h2 id="Constants">Constants</h2> |
| 522 | |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 523 | <p>There are <i>boolean constants</i>, |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 524 | <i>rune constants</i>, |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 525 | <i>integer constants</i>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 526 | <i>floating-point constants</i>, <i>complex constants</i>, |
Robert Griesemer | f331012 | 2013-07-25 09:35:55 -0700 | [diff] [blame] | 527 | and <i>string constants</i>. Rune, integer, floating-point, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 528 | and complex constants are |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 529 | collectively called <i>numeric constants</i>. |
| 530 | </p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 531 | |
| 532 | <p> |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 533 | A constant value is represented by a |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 534 | <a href="#Rune_literals">rune</a>, |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 535 | <a href="#Integer_literals">integer</a>, |
| 536 | <a href="#Floating-point_literals">floating-point</a>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 537 | <a href="#Imaginary_literals">imaginary</a>, |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 538 | or |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 539 | <a href="#String_literals">string</a> literal, |
| 540 | an identifier denoting a constant, |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 541 | a <a href="#Constant_expressions">constant expression</a>, |
| 542 | 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] | 543 | the result value of some built-in functions such as |
| 544 | <code>unsafe.Sizeof</code> applied to any value, |
| 545 | <code>cap</code> or <code>len</code> applied to |
| 546 | <a href="#Length_and_capacity">some expressions</a>, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 547 | <code>real</code> and <code>imag</code> applied to a complex constant |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 548 | and <code>complex</code> applied to numeric constants. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 549 | The boolean truth values are represented by the predeclared constants |
| 550 | <code>true</code> and <code>false</code>. The predeclared identifier |
| 551 | <a href="#Iota">iota</a> denotes an integer constant. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 552 | </p> |
| 553 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 554 | <p> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 555 | In general, complex constants are a form of |
| 556 | <a href="#Constant_expressions">constant expression</a> |
| 557 | and are discussed in that section. |
| 558 | </p> |
| 559 | |
| 560 | <p> |
Robert Griesemer | 55ecda4 | 2015-09-17 18:10:20 -0700 | [diff] [blame] | 561 | Numeric constants represent exact values of arbitrary precision and do not overflow. |
| 562 | Consequently, there are no constants denoting the IEEE-754 negative zero, infinity, |
| 563 | and not-a-number values. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 564 | </p> |
| 565 | |
| 566 | <p> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 567 | Constants may be <a href="#Types">typed</a> or <i>untyped</i>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 568 | Literal constants, <code>true</code>, <code>false</code>, <code>iota</code>, |
| 569 | and certain <a href="#Constant_expressions">constant expressions</a> |
| 570 | containing only untyped constant operands are untyped. |
| 571 | </p> |
| 572 | |
| 573 | <p> |
| 574 | A constant may be given a type explicitly by a <a href="#Constant_declarations">constant declaration</a> |
| 575 | or <a href="#Conversions">conversion</a>, or implicitly when used in a |
| 576 | <a href="#Variable_declarations">variable declaration</a> or an |
| 577 | <a href="#Assignments">assignment</a> or as an |
| 578 | operand in an <a href="#Expressions">expression</a>. |
| 579 | It is an error if the constant value |
Robert Griesemer | dfc5bb5 | 2011-01-19 10:33:41 -0800 | [diff] [blame] | 580 | cannot be represented as a value of the respective type. |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 581 | 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] | 582 | floating-point type, while <code>2147483648.0</code> (equal to <code>1<<31</code>) |
| 583 | can be given the types <code>float32</code>, <code>float64</code>, or <code>uint32</code> but |
| 584 | not <code>int32</code> or <code>string</code>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 585 | </p> |
| 586 | |
| 587 | <p> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 588 | An untyped constant has a <i>default type</i> which is the type to which the |
| 589 | constant is implicitly converted in contexts where a typed value is required, |
| 590 | for instance, in a <a href="#Short_variable_declarations">short variable declaration</a> |
| 591 | such as <code>i := 0</code> where there is no explicit type. |
| 592 | The default type of an untyped constant is <code>bool</code>, <code>rune</code>, |
| 593 | <code>int</code>, <code>float64</code>, <code>complex128</code> or <code>string</code> |
| 594 | respectively, depending on whether it is a boolean, rune, integer, floating-point, |
| 595 | complex, or string constant. |
| 596 | </p> |
| 597 | |
| 598 | <p> |
Ian Lance Taylor | 9126c65 | 2012-02-13 11:25:56 -0800 | [diff] [blame] | 599 | Implementation restriction: Although numeric constants have arbitrary |
| 600 | precision in the language, a compiler may implement them using an |
| 601 | internal representation with limited precision. That said, every |
| 602 | implementation must: |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 603 | </p> |
Ian Lance Taylor | 9126c65 | 2012-02-13 11:25:56 -0800 | [diff] [blame] | 604 | <ul> |
| 605 | <li>Represent integer constants with at least 256 bits.</li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 606 | |
Ian Lance Taylor | 9126c65 | 2012-02-13 11:25:56 -0800 | [diff] [blame] | 607 | <li>Represent floating-point constants, including the parts of |
| 608 | a complex constant, with a mantissa of at least 256 bits |
| 609 | and a signed exponent of at least 32 bits.</li> |
| 610 | |
| 611 | <li>Give an error if unable to represent an integer constant |
| 612 | precisely.</li> |
| 613 | |
| 614 | <li>Give an error if unable to represent a floating-point or |
| 615 | complex constant due to overflow.</li> |
| 616 | |
| 617 | <li>Round to the nearest representable constant if unable to |
| 618 | represent a floating-point or complex constant due to limits |
| 619 | on precision.</li> |
| 620 | </ul> |
| 621 | <p> |
| 622 | These requirements apply both to literal constants and to the result |
| 623 | of evaluating <a href="#Constant_expressions">constant |
| 624 | expressions</a>. |
| 625 | </p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 626 | |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 627 | <h2 id="Variables">Variables</h2> |
| 628 | |
| 629 | <p> |
| 630 | A variable is a storage location for holding a <i>value</i>. |
| 631 | The set of permissible values is determined by the |
| 632 | variable's <i><a href="#Types">type</a></i>. |
| 633 | </p> |
| 634 | |
| 635 | <p> |
| 636 | A <a href="#Variable_declarations">variable declaration</a> |
| 637 | or, for function parameters and results, the signature |
| 638 | of a <a href="#Function_declarations">function declaration</a> |
| 639 | or <a href="#Function_literals">function literal</a> reserves |
| 640 | storage for a named variable. |
| 641 | |
| 642 | Calling the built-in function <a href="#Allocation"><code>new</code></a> |
| 643 | or taking the address of a <a href="#Composite_literals">composite literal</a> |
| 644 | allocates storage for a variable at run time. |
| 645 | Such an anonymous variable is referred to via a (possibly implicit) |
| 646 | <a href="#Address_operators">pointer indirection</a>. |
| 647 | </p> |
| 648 | |
| 649 | <p> |
| 650 | <i>Structured</i> variables of <a href="#Array_types">array</a>, <a href="#Slice_types">slice</a>, |
| 651 | and <a href="#Struct_types">struct</a> types have elements and fields that may |
| 652 | be <a href="#Address_operators">addressed</a> individually. Each such element |
| 653 | acts like a variable. |
| 654 | </p> |
| 655 | |
| 656 | <p> |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 657 | The <i>static type</i> (or just <i>type</i>) of a variable is the |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 658 | type given in its declaration, the type provided in the |
| 659 | <code>new</code> call or composite literal, or the type of |
| 660 | an element of a structured variable. |
| 661 | Variables of interface type also have a distinct <i>dynamic type</i>, |
| 662 | which is the concrete type of the value assigned to the variable at run time |
| 663 | (unless the value is the predeclared identifier <code>nil</code>, |
| 664 | which has no type). |
| 665 | The dynamic type may vary during execution but values stored in interface |
| 666 | variables are always <a href="#Assignability">assignable</a> |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 667 | to the static type of the variable. |
| 668 | </p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 669 | |
| 670 | <pre> |
| 671 | var x interface{} // x is nil and has static type interface{} |
| 672 | var v *T // v has value nil, static type *T |
| 673 | x = 42 // x has value 42 and dynamic type int |
| 674 | x = v // x has value (*T)(nil) and dynamic type *T |
| 675 | </pre> |
| 676 | |
| 677 | <p> |
| 678 | A variable's value is retrieved by referring to the variable in an |
| 679 | <a href="#Expressions">expression</a>; it is the most recent value |
| 680 | <a href="#Assignments">assigned</a> to the variable. |
| 681 | If a variable has not yet been assigned a value, its value is the |
| 682 | <a href="#The_zero_value">zero value</a> for its type. |
| 683 | </p> |
| 684 | |
| 685 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 686 | <h2 id="Types">Types</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 687 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 688 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 689 | A type determines the set of values and operations specific to values of that |
Robert Griesemer | 8268ead | 2013-07-09 21:12:53 -0700 | [diff] [blame] | 690 | type. Types may be <i>named</i> or <i>unnamed</i>. Named types are specified |
| 691 | by a (possibly <a href="#Qualified_identifiers">qualified</a>) |
| 692 | <a href="#Type_declarations"><i>type name</i></a>; unnamed types are specified |
| 693 | using a <i>type literal</i>, which composes a new type from existing types. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 694 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 695 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 696 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 697 | Type = TypeName | TypeLit | "(" Type ")" . |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 698 | TypeName = identifier | QualifiedIdent . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 699 | TypeLit = ArrayType | StructType | PointerType | FunctionType | InterfaceType | |
| 700 | SliceType | MapType | ChannelType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 701 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 702 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 703 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 704 | Named instances of the boolean, numeric, and string types are |
| 705 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 706 | <i>Composite types</i>—array, struct, pointer, function, |
| 707 | interface, slice, map, and channel types—may be constructed using |
| 708 | type literals. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 709 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 710 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 711 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 712 | Each type <code>T</code> has an <i>underlying type</i>: If <code>T</code> |
Robert Griesemer | 8d77d2c | 2014-03-05 19:37:44 -0800 | [diff] [blame] | 713 | is one of the predeclared boolean, numeric, or string types, or a type literal, |
| 714 | the corresponding underlying |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 715 | type is <code>T</code> itself. Otherwise, <code>T</code>'s underlying type |
| 716 | is the underlying type of the type to which <code>T</code> refers in its |
| 717 | <a href="#Type_declarations">type declaration</a>. |
| 718 | </p> |
| 719 | |
| 720 | <pre> |
| 721 | type T1 string |
| 722 | type T2 T1 |
| 723 | type T3 []T1 |
| 724 | type T4 T3 |
| 725 | </pre> |
| 726 | |
| 727 | <p> |
| 728 | The underlying type of <code>string</code>, <code>T1</code>, and <code>T2</code> |
| 729 | is <code>string</code>. The underlying type of <code>[]T1</code>, <code>T3</code>, |
| 730 | and <code>T4</code> is <code>[]T1</code>. |
| 731 | </p> |
| 732 | |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 733 | <h3 id="Method_sets">Method sets</h3> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 734 | <p> |
Robert Griesemer | 2c83f1e | 2014-05-22 12:23:25 -0700 | [diff] [blame] | 735 | A type may have a <i>method set</i> associated with it. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 736 | The method set of an <a href="#Interface_types">interface type</a> is its interface. |
Robert Griesemer | 2c83f1e | 2014-05-22 12:23:25 -0700 | [diff] [blame] | 737 | The method set of any other type <code>T</code> consists of all |
| 738 | <a href="#Method_declarations">methods</a> declared with receiver type <code>T</code>. |
| 739 | The method set of the corresponding <a href="#Pointer_types">pointer type</a> <code>*T</code> |
| 740 | is the set of all methods declared with receiver <code>*T</code> or <code>T</code> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 741 | (that is, it also contains the method set of <code>T</code>). |
Robert Griesemer | 787adb6 | 2012-06-04 14:24:10 -0700 | [diff] [blame] | 742 | Further rules apply to structs containing anonymous fields, as described |
| 743 | in the section on <a href="#Struct_types">struct types</a>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 744 | Any other type has an empty method set. |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 745 | In a method set, each method must have a |
Robert Griesemer | 2c83f1e | 2014-05-22 12:23:25 -0700 | [diff] [blame] | 746 | <a href="#Uniqueness_of_identifiers">unique</a> |
| 747 | non-<a href="#Blank_identifier">blank</a> <a href="#MethodName">method name</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 748 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 749 | |
Russ Cox | fd2a511 | 2012-02-08 14:28:51 -0500 | [diff] [blame] | 750 | <p> |
| 751 | The method set of a type determines the interfaces that the |
| 752 | type <a href="#Interface_types">implements</a> |
| 753 | and the methods that can be <a href="#Calls">called</a> |
| 754 | using a receiver of that type. |
| 755 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 756 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 757 | <h3 id="Boolean_types">Boolean types</h3> |
| 758 | |
Stefan Nilsson | c50074e | 2012-02-29 15:07:52 -0800 | [diff] [blame] | 759 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 760 | A <i>boolean type</i> represents the set of Boolean truth values |
| 761 | denoted by the predeclared constants <code>true</code> |
| 762 | and <code>false</code>. The predeclared boolean type is <code>bool</code>. |
Stefan Nilsson | c50074e | 2012-02-29 15:07:52 -0800 | [diff] [blame] | 763 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 764 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 765 | <h3 id="Numeric_types">Numeric types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 766 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 767 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 768 | A <i>numeric type</i> represents sets of integer or floating-point values. |
| 769 | The predeclared architecture-independent numeric types are: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 770 | </p> |
Robert Griesemer | ebf14c6 | 2008-10-30 14:50:23 -0700 | [diff] [blame] | 771 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 772 | <pre class="grammar"> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 773 | uint8 the set of all unsigned 8-bit integers (0 to 255) |
| 774 | uint16 the set of all unsigned 16-bit integers (0 to 65535) |
| 775 | uint32 the set of all unsigned 32-bit integers (0 to 4294967295) |
| 776 | uint64 the set of all unsigned 64-bit integers (0 to 18446744073709551615) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 777 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 778 | int8 the set of all signed 8-bit integers (-128 to 127) |
| 779 | int16 the set of all signed 16-bit integers (-32768 to 32767) |
| 780 | int32 the set of all signed 32-bit integers (-2147483648 to 2147483647) |
| 781 | int64 the set of all signed 64-bit integers (-9223372036854775808 to 9223372036854775807) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 782 | |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 783 | float32 the set of all IEEE-754 32-bit floating-point numbers |
| 784 | float64 the set of all IEEE-754 64-bit floating-point numbers |
| 785 | |
| 786 | complex64 the set of all complex numbers with float32 real and imaginary parts |
| 787 | 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] | 788 | |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 789 | byte alias for uint8 |
Russ Cox | d7f050a | 2011-12-09 00:11:43 -0500 | [diff] [blame] | 790 | rune alias for int32 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 791 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 792 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 793 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 794 | The value of an <i>n</i>-bit integer is <i>n</i> bits wide and represented using |
| 795 | <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] | 796 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 797 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 798 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 799 | 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] | 800 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 801 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 802 | <pre class="grammar"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 803 | uint either 32 or 64 bits |
Robert Griesemer | 97025eb | 2011-01-13 10:24:04 -0800 | [diff] [blame] | 804 | int same size as uint |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 805 | 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] | 806 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 807 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 808 | <p> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 809 | To avoid portability issues all numeric types are distinct except |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 810 | <code>byte</code>, which is an alias for <code>uint8</code>, and |
Russ Cox | d7f050a | 2011-12-09 00:11:43 -0500 | [diff] [blame] | 811 | <code>rune</code>, which is an alias for <code>int32</code>. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 812 | Conversions |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 813 | are required when different numeric types are mixed in an expression |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 814 | or assignment. For instance, <code>int32</code> and <code>int</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 815 | 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] | 816 | particular architecture. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 817 | |
| 818 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 819 | <h3 id="String_types">String types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 820 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 821 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 822 | A <i>string type</i> represents the set of string values. |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 823 | A string value is a (possibly empty) sequence of bytes. |
| 824 | Strings are immutable: once created, |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 825 | it is impossible to change the contents of a string. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 826 | The predeclared string type is <code>string</code>. |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 827 | </p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 828 | |
| 829 | <p> |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 830 | The length of a string <code>s</code> (its size in bytes) can be discovered using |
| 831 | the built-in function <a href="#Length_and_capacity"><code>len</code></a>. |
| 832 | The length is a compile-time constant if the string is a constant. |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 833 | A string's bytes can be accessed by integer <a href="#Index_expressions">indices</a> |
| 834 | 0 through <code>len(s)-1</code>. |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 835 | It is illegal to take the address of such an element; if |
| 836 | <code>s[i]</code> is the <code>i</code>'th byte of a |
| 837 | string, <code>&s[i]</code> is invalid. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 838 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 839 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 840 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 841 | <h3 id="Array_types">Array types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 842 | |
| 843 | <p> |
| 844 | An array is a numbered sequence of elements of a single |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 845 | type, called the element type. |
| 846 | The number of elements is called the length and is never |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 847 | negative. |
| 848 | </p> |
| 849 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 850 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 851 | ArrayType = "[" ArrayLength "]" ElementType . |
| 852 | ArrayLength = Expression . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 853 | ElementType = Type . |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 854 | </pre> |
| 855 | |
| 856 | <p> |
Robert Griesemer | 2c83f1e | 2014-05-22 12:23:25 -0700 | [diff] [blame] | 857 | The length is part of the array's type; it must evaluate to a |
| 858 | non-negative <a href="#Constants">constant</a> representable by a value |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 859 | of type <code>int</code>. |
| 860 | The length of array <code>a</code> can be discovered |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 861 | using the built-in function <a href="#Length_and_capacity"><code>len</code></a>. |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 862 | The elements can be addressed by integer <a href="#Index_expressions">indices</a> |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 863 | 0 through <code>len(a)-1</code>. |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 864 | Array types are always one-dimensional but may be composed to form |
| 865 | multi-dimensional types. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 866 | </p> |
| 867 | |
| 868 | <pre> |
| 869 | [32]byte |
| 870 | [2*N] struct { x, y int32 } |
| 871 | [1000]*float64 |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 872 | [3][5]int |
| 873 | [2][2][2]float64 // same as [2]([2]([2]float64)) |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 874 | </pre> |
| 875 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 876 | <h3 id="Slice_types">Slice types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 877 | |
| 878 | <p> |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 879 | A slice is a descriptor for a contiguous segment of an <i>underlying array</i> and |
Robert Griesemer | b34f055 | 2013-04-02 23:17:37 -0700 | [diff] [blame] | 880 | provides access to a numbered sequence of elements from that array. |
| 881 | A slice 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] | 882 | The value of an uninitialized slice is <code>nil</code>. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 883 | </p> |
| 884 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 885 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 886 | SliceType = "[" "]" ElementType . |
| 887 | </pre> |
| 888 | |
| 889 | <p> |
| 890 | Like arrays, slices are indexable and have a length. The length of a |
| 891 | slice <code>s</code> can be discovered by the built-in function |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 892 | <a href="#Length_and_capacity"><code>len</code></a>; unlike with arrays it may change during |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 893 | execution. The elements can be addressed by integer <a href="#Index_expressions">indices</a> |
| 894 | 0 through <code>len(s)-1</code>. The slice index of a |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 895 | given element may be less than the index of the same element in the |
| 896 | underlying array. |
| 897 | </p> |
| 898 | <p> |
| 899 | A slice, once initialized, is always associated with an underlying |
Rob Pike | 7ec0856 | 2010-01-09 07:32:26 +1100 | [diff] [blame] | 900 | array that holds its elements. A slice therefore shares storage |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 901 | with its array and with other slices of the same array; by contrast, |
| 902 | distinct arrays always represent distinct storage. |
| 903 | </p> |
| 904 | <p> |
| 905 | 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] | 906 | 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] | 907 | the length of the slice and the length of the array beyond the slice; |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 908 | a slice of length up to that capacity can be created by |
Robert Griesemer | e333b96 | 2013-09-11 17:18:52 -0700 | [diff] [blame] | 909 | <a href="#Slice_expressions"><i>slicing</i></a> a new one from the original slice. |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 910 | 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] | 911 | 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] | 912 | </p> |
| 913 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 914 | <p> |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 915 | A new, initialized slice value for a given element type <code>T</code> is |
| 916 | made using the built-in function |
| 917 | <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
| 918 | which takes a slice type |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 919 | and parameters specifying the length and optionally the capacity. |
| 920 | A slice created with <code>make</code> always allocates a new, hidden array |
| 921 | to which the returned slice value refers. That is, executing |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 922 | </p> |
| 923 | |
| 924 | <pre> |
| 925 | make([]T, length, capacity) |
| 926 | </pre> |
| 927 | |
| 928 | <p> |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 929 | produces the same slice as allocating an array and <a href="#Slice_expressions">slicing</a> |
| 930 | it, so these two expressions are equivalent: |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 931 | </p> |
| 932 | |
| 933 | <pre> |
| 934 | make([]int, 50, 100) |
| 935 | new([100]int)[0:50] |
| 936 | </pre> |
| 937 | |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 938 | <p> |
| 939 | Like arrays, slices are always one-dimensional but may be composed to construct |
| 940 | higher-dimensional objects. |
| 941 | With arrays of arrays, the inner arrays are, by construction, always the same length; |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 942 | however with slices of slices (or arrays of slices), the inner lengths may vary dynamically. |
| 943 | Moreover, the inner slices must be initialized individually. |
Rob Pike | ff6a8fd | 2009-11-20 15:47:15 -0800 | [diff] [blame] | 944 | </p> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 945 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 946 | <h3 id="Struct_types">Struct types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 947 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 948 | <p> |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 949 | A struct is a sequence of named elements, called fields, each of which has a |
| 950 | name and a type. Field names may be specified explicitly (IdentifierList) or |
| 951 | implicitly (AnonymousField). |
| 952 | Within a struct, non-<a href="#Blank_identifier">blank</a> field names must |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 953 | be <a href="#Uniqueness_of_identifiers">unique</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 954 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 955 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 956 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 957 | StructType = "struct" "{" { FieldDecl ";" } "}" . |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 958 | FieldDecl = (IdentifierList Type | AnonymousField) [ Tag ] . |
| 959 | AnonymousField = [ "*" ] TypeName . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 960 | Tag = string_lit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 961 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 962 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 963 | <pre> |
| 964 | // An empty struct. |
| 965 | struct {} |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 966 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 967 | // A struct with 6 fields. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 968 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 969 | x, y int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 970 | u float32 |
| 971 | _ float32 // padding |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 972 | A *[]int |
| 973 | F func() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 974 | } |
| 975 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 976 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 977 | <p> |
Russ Cox | 7c5d640 | 2012-02-08 15:37:58 -0500 | [diff] [blame] | 978 | A field declared with a type but no explicit field name is an <i>anonymous field</i>, |
| 979 | also called an <i>embedded</i> field or an embedding of the type in the struct. |
| 980 | An embedded type must be specified as |
Russ Cox | bee2d5b | 2010-09-30 14:59:41 -0400 | [diff] [blame] | 981 | 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] | 982 | and <code>T</code> itself may not be |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 983 | a pointer type. The unqualified type name acts as the field name. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 984 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 985 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 986 | <pre> |
| 987 | // A struct with four anonymous fields of type T1, *T2, P.T3 and *P.T4 |
| 988 | struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 989 | T1 // field name is T1 |
| 990 | *T2 // field name is T2 |
| 991 | P.T3 // field name is T3 |
| 992 | *P.T4 // field name is T4 |
| 993 | x, y int // field names are x and y |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 994 | } |
| 995 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 996 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 997 | <p> |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 998 | The following declaration is illegal because field names must be unique |
| 999 | in a struct type: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1000 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 1001 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1002 | <pre> |
| 1003 | struct { |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1004 | T // conflicts with anonymous field *T and *P.T |
| 1005 | *T // conflicts with anonymous field T and *P.T |
| 1006 | *P.T // conflicts with anonymous field T and *T |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1007 | } |
| 1008 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 1009 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1010 | <p> |
Robert Griesemer | 787adb6 | 2012-06-04 14:24:10 -0700 | [diff] [blame] | 1011 | A field or <a href="#Method_declarations">method</a> <code>f</code> of an |
| 1012 | anonymous field in a struct <code>x</code> is called <i>promoted</i> if |
| 1013 | <code>x.f</code> is a legal <a href="#Selectors">selector</a> that denotes |
| 1014 | that field or method <code>f</code>. |
| 1015 | </p> |
| 1016 | |
| 1017 | <p> |
| 1018 | Promoted fields act like ordinary fields |
| 1019 | of a struct except that they cannot be used as field names in |
| 1020 | <a href="#Composite_literals">composite literals</a> of the struct. |
| 1021 | </p> |
| 1022 | |
| 1023 | <p> |
| 1024 | Given a struct type <code>S</code> and a type named <code>T</code>, |
| 1025 | promoted methods are included in the method set of the struct as follows: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1026 | </p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1027 | <ul> |
Robert Griesemer | 787adb6 | 2012-06-04 14:24:10 -0700 | [diff] [blame] | 1028 | <li> |
| 1029 | If <code>S</code> contains an anonymous field <code>T</code>, |
| 1030 | the <a href="#Method_sets">method sets</a> of <code>S</code> |
| 1031 | and <code>*S</code> both include promoted methods with receiver |
| 1032 | <code>T</code>. The method set of <code>*S</code> also |
| 1033 | includes promoted methods with receiver <code>*T</code>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1034 | </li> |
Robin Eklind | 1d46fc4 | 2012-12-11 12:17:53 -0500 | [diff] [blame] | 1035 | |
Robert Griesemer | 787adb6 | 2012-06-04 14:24:10 -0700 | [diff] [blame] | 1036 | <li> |
| 1037 | If <code>S</code> contains an anonymous field <code>*T</code>, |
| 1038 | the method sets of <code>S</code> and <code>*S</code> both |
| 1039 | include promoted methods with receiver <code>T</code> or |
| 1040 | <code>*T</code>. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1041 | </li> |
| 1042 | </ul> |
Robert Griesemer | 787adb6 | 2012-06-04 14:24:10 -0700 | [diff] [blame] | 1043 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1044 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1045 | 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] | 1046 | which becomes an attribute for all the fields in the corresponding |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1047 | field declaration. The tags are made |
Robert Griesemer | 458632a2 | 2012-12-04 13:09:02 -0800 | [diff] [blame] | 1048 | visible through a <a href="/pkg/reflect/#StructTag">reflection interface</a> |
Emil Hessman | 1314131 | 2014-01-03 22:48:03 -0800 | [diff] [blame] | 1049 | and take part in <a href="#Type_identity">type identity</a> for structs |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1050 | but are otherwise ignored. |
| 1051 | </p> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 1052 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1053 | <pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1054 | struct { |
Robert Griesemer | 7305b55 | 2015-11-30 14:18:09 -0800 | [diff] [blame] | 1055 | x, y float64 "" // an empty tag string is like an absent tag |
| 1056 | name string "any string is permitted as a tag" |
| 1057 | _ [4]byte "ceci n'est pas un champ de structure" |
| 1058 | } |
| 1059 | |
| 1060 | // A struct corresponding to a TimeStamp protocol buffer. |
| 1061 | // The tag strings define the protocol buffer field numbers; |
| 1062 | // they follow the convention outlined by the reflect package. |
| 1063 | struct { |
| 1064 | microsec uint64 `protobuf:"1"` |
| 1065 | serverIP6 uint64 `protobuf:"2"` |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1066 | } |
| 1067 | </pre> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 1068 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1069 | <h3 id="Pointer_types">Pointer types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1070 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1071 | <p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 1072 | A pointer type denotes the set of all pointers to <a href="#Variables">variables</a> of a given |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1073 | type, called the <i>base type</i> of the pointer. |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 1074 | The value of an uninitialized pointer is <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1075 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1076 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1077 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1078 | PointerType = "*" BaseType . |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 1079 | BaseType = Type . |
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 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1082 | <pre> |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 1083 | *Point |
| 1084 | *[4]int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1085 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1086 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1087 | <h3 id="Function_types">Function types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1088 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1089 | <p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1090 | 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] | 1091 | and result types. The value of an uninitialized variable of function type |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1092 | is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1093 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1094 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1095 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1096 | FunctionType = "func" Signature . |
| 1097 | Signature = Parameters [ Result ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1098 | Result = Parameters | Type . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1099 | Parameters = "(" [ ParameterList [ "," ] ] ")" . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1100 | ParameterList = ParameterDecl { "," ParameterDecl } . |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 1101 | ParameterDecl = [ IdentifierList ] [ "..." ] Type . |
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 | Within a list of parameters or results, the names (IdentifierList) |
| 1106 | must either all be present or all be absent. If present, each name |
Robert Griesemer | 85e451e | 2012-11-29 14:47:47 -0800 | [diff] [blame] | 1107 | stands for one item (parameter or result) of the specified type and |
| 1108 | all non-<a href="#Blank_identifier">blank</a> names in the signature |
| 1109 | must be <a href="#Uniqueness_of_identifiers">unique</a>. |
| 1110 | If absent, each type stands for one item of that type. |
| 1111 | Parameter and result |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1112 | lists are always parenthesized except that if there is exactly |
Robert Griesemer | 73ca127 | 2010-07-09 13:02:54 -0700 | [diff] [blame] | 1113 | one unnamed result it may be written as an unparenthesized type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1114 | </p> |
Russ Cox | 9562592 | 2010-06-12 11:37:13 -0700 | [diff] [blame] | 1115 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 1116 | <p> |
Robert Griesemer | 57c81ef | 2015-12-15 13:13:38 -0800 | [diff] [blame] | 1117 | The final incoming parameter in a function signature may have |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 1118 | a type prefixed with <code>...</code>. |
| 1119 | A function with such a parameter is called <i>variadic</i> and |
| 1120 | may be invoked with zero or more arguments for that parameter. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1121 | </p> |
Robert Griesemer | 2bfa957 | 2008-10-24 13:13:12 -0700 | [diff] [blame] | 1122 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1123 | <pre> |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 1124 | func() |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 1125 | func(x int) int |
| 1126 | func(a, _ int, z float32) bool |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1127 | func(a, b int, z float32) (bool) |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 1128 | func(prefix string, values ...int) |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1129 | func(a, b int, z float64, opt ...interface{}) (success bool) |
| 1130 | func(int, int, float64) (float64, *[]int) |
Russ Cox | 4687169 | 2010-01-26 10:25:56 -0800 | [diff] [blame] | 1131 | func(n int) func(p *T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1132 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 1133 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1134 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1135 | <h3 id="Interface_types">Interface types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1136 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1137 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 1138 | 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] | 1139 | A variable of interface type can store a value of any type with a method set |
| 1140 | 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] | 1141 | <i>implement the interface</i>. |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 1142 | 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] | 1143 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1144 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1145 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1146 | InterfaceType = "interface" "{" { MethodSpec ";" } "}" . |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1147 | MethodSpec = MethodName Signature | InterfaceTypeName . |
| 1148 | MethodName = identifier . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1149 | InterfaceTypeName = TypeName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1150 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1151 | |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1152 | <p> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1153 | As with all method sets, in an interface type, each method must have a |
Robert Griesemer | 2c83f1e | 2014-05-22 12:23:25 -0700 | [diff] [blame] | 1154 | <a href="#Uniqueness_of_identifiers">unique</a> |
| 1155 | non-<a href="#Blank_identifier">blank</a> name. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 1156 | </p> |
| 1157 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1158 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1159 | // A simple File interface |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1160 | interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1161 | Read(b Buffer) bool |
| 1162 | Write(b Buffer) bool |
| 1163 | Close() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1164 | } |
| 1165 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1166 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1167 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1168 | More than one type may implement an interface. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1169 | For instance, if two types <code>S1</code> and <code>S2</code> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1170 | have the method set |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1171 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1172 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1173 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 1174 | func (p T) Read(b Buffer) bool { return … } |
| 1175 | func (p T) Write(b Buffer) bool { return … } |
| 1176 | func (p T) Close() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1177 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1178 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1179 | <p> |
| 1180 | (where <code>T</code> stands for either <code>S1</code> or <code>S2</code>) |
| 1181 | then the <code>File</code> interface is implemented by both <code>S1</code> and |
| 1182 | <code>S2</code>, regardless of what other methods |
| 1183 | <code>S1</code> and <code>S2</code> may have or share. |
| 1184 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1185 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1186 | <p> |
| 1187 | A type implements any interface comprising any subset of its methods |
| 1188 | and may therefore implement several distinct interfaces. For |
| 1189 | instance, all types implement the <i>empty interface</i>: |
| 1190 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1191 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1192 | <pre> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1193 | interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1194 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1195 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1196 | <p> |
| 1197 | Similarly, consider this interface specification, |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1198 | which appears within a <a href="#Type_declarations">type declaration</a> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1199 | to define an interface called <code>Locker</code>: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1200 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1201 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1202 | <pre> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1203 | type Locker interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1204 | Lock() |
| 1205 | Unlock() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1206 | } |
| 1207 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1208 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1209 | <p> |
| 1210 | If <code>S1</code> and <code>S2</code> also implement |
| 1211 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1212 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1213 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 1214 | func (p T) Lock() { … } |
| 1215 | func (p T) Unlock() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1216 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1217 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1218 | <p> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1219 | they implement the <code>Locker</code> interface as well |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1220 | as the <code>File</code> interface. |
| 1221 | </p> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1222 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1223 | <p> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1224 | An interface <code>T</code> may use a (possibly qualified) interface type |
| 1225 | name <code>E</code> in place of a method specification. This is called |
| 1226 | <i>embedding</i> interface <code>E</code> in <code>T</code>; it adds |
| 1227 | all (exported and non-exported) methods of <code>E</code> to the interface |
| 1228 | <code>T</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1229 | </p> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1230 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1231 | <pre> |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1232 | type ReadWriter interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1233 | Read(b Buffer) bool |
| 1234 | Write(b Buffer) bool |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1235 | } |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1236 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1237 | type File interface { |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1238 | ReadWriter // same as adding the methods of ReadWriter |
| 1239 | Locker // same as adding the methods of Locker |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1240 | Close() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1241 | } |
Robert Griesemer | bb29c5a | 2014-09-25 12:49:42 -0700 | [diff] [blame] | 1242 | |
| 1243 | type LockedFile interface { |
| 1244 | Locker |
| 1245 | File // illegal: Lock, Unlock not unique |
| 1246 | Lock() // illegal: Lock not unique |
| 1247 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1248 | </pre> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 1249 | |
Russ Cox | 388816a | 2012-02-08 14:35:00 -0500 | [diff] [blame] | 1250 | <p> |
Russ Cox | 7c5d640 | 2012-02-08 15:37:58 -0500 | [diff] [blame] | 1251 | An interface type <code>T</code> may not embed itself |
| 1252 | or any interface type that embeds <code>T</code>, recursively. |
Russ Cox | 388816a | 2012-02-08 14:35:00 -0500 | [diff] [blame] | 1253 | </p> |
| 1254 | |
| 1255 | <pre> |
| 1256 | // illegal: Bad cannot embed itself |
| 1257 | type Bad interface { |
| 1258 | Bad |
| 1259 | } |
| 1260 | |
| 1261 | // illegal: Bad1 cannot embed itself using Bad2 |
| 1262 | type Bad1 interface { |
| 1263 | Bad2 |
| 1264 | } |
| 1265 | type Bad2 interface { |
| 1266 | Bad1 |
| 1267 | } |
| 1268 | </pre> |
| 1269 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1270 | <h3 id="Map_types">Map types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1271 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1272 | <p> |
| 1273 | 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] | 1274 | 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] | 1275 | called the key type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1276 | The value of an uninitialized map is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1277 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1278 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1279 | <pre class="ebnf"> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1280 | MapType = "map" "[" KeyType "]" ElementType . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1281 | KeyType = Type . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1282 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1283 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1284 | <p> |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 1285 | The <a href="#Comparison_operators">comparison operators</a> |
| 1286 | <code>==</code> and <code>!=</code> must be fully defined |
Robert Griesemer | 9c3d876 | 2012-01-30 15:31:33 -0800 | [diff] [blame] | 1287 | for operands of the key type; thus the key type must not be a function, map, or |
| 1288 | slice. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 1289 | If the key type is an interface type, these |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1290 | comparison operators must be defined for the dynamic key values; |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 1291 | 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] | 1292 | |
| 1293 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1294 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1295 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1296 | map[string]int |
| 1297 | map[*T]struct{ x, y float64 } |
| 1298 | map[string]interface{} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1299 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1300 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1301 | <p> |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 1302 | The number of map elements is called its length. |
| 1303 | For a map <code>m</code>, it can be discovered using the |
Robert Griesemer | cc06593 | 2012-09-14 11:31:56 -0700 | [diff] [blame] | 1304 | built-in function <a href="#Length_and_capacity"><code>len</code></a> |
Robert Griesemer | 3e0c0a8 | 2011-10-17 12:53:10 -0700 | [diff] [blame] | 1305 | and may change during execution. Elements may be added during execution |
| 1306 | using <a href="#Assignments">assignments</a> and retrieved with |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 1307 | <a href="#Index_expressions">index expressions</a>; they may be removed with the |
Robert Griesemer | 3e0c0a8 | 2011-10-17 12:53:10 -0700 | [diff] [blame] | 1308 | <a href="#Deletion_of_map_elements"><code>delete</code></a> built-in function. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1309 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1310 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1311 | A new, empty map value is made using the built-in |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 1312 | function <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
| 1313 | which takes the map type and an optional capacity hint as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1314 | </p> |
| 1315 | |
| 1316 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1317 | make(map[string]int) |
| 1318 | make(map[string]int, 100) |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1319 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1320 | |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1321 | <p> |
| 1322 | The initial capacity does not bound its size: |
| 1323 | maps grow to accommodate the number of items |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 1324 | stored in them, with the exception of <code>nil</code> maps. |
| 1325 | A <code>nil</code> map is equivalent to an empty map except that no elements |
| 1326 | may be added. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1327 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1328 | <h3 id="Channel_types">Channel types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1329 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1330 | <p> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1331 | A channel provides a mechanism for |
| 1332 | <a href="#Go_statements">concurrently executing functions</a> |
| 1333 | to communicate by |
| 1334 | <a href="#Send_statements">sending</a> and |
| 1335 | <a href="#Receive_operator">receiving</a> |
| 1336 | values of a specified element type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1337 | The value of an uninitialized channel is <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1338 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1339 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1340 | <pre class="ebnf"> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1341 | ChannelType = ( "chan" | "chan" "<-" | "<-" "chan" ) ElementType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1342 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1343 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1344 | <p> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1345 | The optional <code><-</code> operator specifies the channel <i>direction</i>, |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1346 | <i>send</i> or <i>receive</i>. If no direction is given, the channel is |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1347 | <i>bidirectional</i>. |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1348 | A channel may be constrained only to send or only to receive by |
| 1349 | <a href="#Conversions">conversion</a> or <a href="#Assignments">assignment</a>. |
| 1350 | </p> |
| 1351 | |
| 1352 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1353 | chan T // can be used to send and receive values of type T |
| 1354 | chan<- float64 // can only be used to send float64s |
| 1355 | <-chan int // can only be used to receive ints |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1356 | </pre> |
| 1357 | |
| 1358 | <p> |
| 1359 | The <code><-</code> operator associates with the leftmost <code>chan</code> |
| 1360 | possible: |
Robert Griesemer | 1c369bd | 2010-01-27 09:35:39 -0800 | [diff] [blame] | 1361 | </p> |
| 1362 | |
| 1363 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1364 | chan<- chan int // same as chan<- (chan int) |
| 1365 | chan<- <-chan int // same as chan<- (<-chan int) |
| 1366 | <-chan <-chan int // same as <-chan (<-chan int) |
Robert Griesemer | 1c369bd | 2010-01-27 09:35:39 -0800 | [diff] [blame] | 1367 | chan (<-chan int) |
| 1368 | </pre> |
| 1369 | |
| 1370 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1371 | A new, initialized channel |
Robert Griesemer | 56ca697 | 2010-05-07 18:22:40 -0700 | [diff] [blame] | 1372 | value can be made using the built-in function |
| 1373 | <a href="#Making_slices_maps_and_channels"><code>make</code></a>, |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1374 | which takes the channel type and an optional <i>capacity</i> as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1375 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1376 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1377 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1378 | make(chan int, 100) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1379 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1380 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1381 | <p> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1382 | The capacity, in number of elements, sets the size of the buffer in the channel. |
| 1383 | If the capacity is zero or absent, the channel is unbuffered and communication |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 1384 | succeeds only when both a sender and receiver are ready. Otherwise, the channel |
| 1385 | is buffered and communication succeeds without blocking if the buffer |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1386 | is not full (sends) or not empty (receives). |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 1387 | A <code>nil</code> channel is never ready for communication. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1388 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1389 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1390 | <p> |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 1391 | A channel may be closed with the built-in function |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1392 | <a href="#Close"><code>close</code></a>. |
| 1393 | The multi-valued assignment form of the |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 1394 | <a href="#Receive_operator">receive operator</a> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 1395 | reports whether a received value was sent before |
| 1396 | the channel was closed. |
| 1397 | </p> |
| 1398 | |
| 1399 | <p> |
| 1400 | A single channel may be used in |
| 1401 | <a href="#Send_statements">send statements</a>, |
| 1402 | <a href="#Receive_operator">receive operations</a>, |
| 1403 | and calls to the built-in functions |
| 1404 | <a href="#Length_and_capacity"><code>cap</code></a> and |
| 1405 | <a href="#Length_and_capacity"><code>len</code></a> |
| 1406 | by any number of goroutines without further synchronization. |
| 1407 | Channels act as first-in-first-out queues. |
| 1408 | For example, if one goroutine sends values on a channel |
| 1409 | and a second goroutine receives them, the values are |
| 1410 | received in the order sent. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1411 | </p> |
| 1412 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1413 | <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] | 1414 | |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1415 | <h3 id="Type_identity">Type identity</h3> |
| 1416 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1417 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1418 | Two types are either <i>identical</i> or <i>different</i>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1419 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1420 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1421 | <p> |
Robert Griesemer | 8268ead | 2013-07-09 21:12:53 -0700 | [diff] [blame] | 1422 | Two <a href="#Types">named types</a> are identical if their type names originate in the same |
Robert Griesemer | 82fc28c | 2012-03-12 20:27:27 -0700 | [diff] [blame] | 1423 | <a href="#Type_declarations">TypeSpec</a>. |
Robert Griesemer | 8268ead | 2013-07-09 21:12:53 -0700 | [diff] [blame] | 1424 | A named and an <a href="#Types">unnamed type</a> are always different. Two unnamed types are identical |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1425 | 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] | 1426 | literal structure and corresponding components have identical types. In detail: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1427 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1428 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1429 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1430 | <li>Two array types are identical if they have identical element types and |
| 1431 | the same array length.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1432 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1433 | <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] | 1434 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1435 | <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] | 1436 | and if corresponding fields have the same names, and identical types, |
| 1437 | and identical tags. |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 1438 | Two anonymous fields are considered to have the same name. Lower-case field |
| 1439 | names from different packages are always different.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1440 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1441 | <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] | 1442 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1443 | <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] | 1444 | and result values, corresponding parameter and result types are |
| 1445 | identical, and either both functions are variadic or neither is. |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1446 | Parameter and result names are not required to match.</li> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1447 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1448 | <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] | 1449 | with the same names and identical function types. Lower-case method names from |
| 1450 | 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] | 1451 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1452 | <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] | 1453 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1454 | <li>Two channel types are identical if they have identical value types and |
| 1455 | the same direction.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1456 | </ul> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1457 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1458 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1459 | Given the declarations |
| 1460 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1461 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1462 | <pre> |
| 1463 | type ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1464 | T0 []string |
| 1465 | T1 []string |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1466 | T2 struct{ a, b int } |
| 1467 | T3 struct{ a, c int } |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1468 | T4 func(int, float64) *T0 |
| 1469 | T5 func(x int, y float64) *[]string |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1470 | ) |
| 1471 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1472 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1473 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1474 | these types are identical: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1475 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1476 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1477 | <pre> |
| 1478 | T0 and T0 |
| 1479 | []int and []int |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1480 | struct{ a, b *T5 } and struct{ a, b *T5 } |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1481 | func(x int, y float64) *[]string and func(int, float64) (result *[]string) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1482 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1483 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1484 | <p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1485 | <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] | 1486 | with distinct declarations; <code>func(int, float64) *T0</code> and |
| 1487 | <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] | 1488 | is different from <code>[]string</code>. |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1489 | </p> |
| 1490 | |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1491 | |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1492 | <h3 id="Assignability">Assignability</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1493 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1494 | <p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 1495 | A value <code>x</code> is <i>assignable</i> to a <a href="#Variables">variable</a> of type <code>T</code> |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1496 | ("<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] | 1497 | </p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1498 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1499 | <ul> |
| 1500 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1501 | <code>x</code>'s type is identical to <code>T</code>. |
| 1502 | </li> |
| 1503 | <li> |
Rob Pike | 68f1609 | 2010-09-01 10:40:50 +1000 | [diff] [blame] | 1504 | <code>x</code>'s type <code>V</code> and <code>T</code> have identical |
| 1505 | <a href="#Types">underlying types</a> and at least one of <code>V</code> |
Robert Griesemer | 8268ead | 2013-07-09 21:12:53 -0700 | [diff] [blame] | 1506 | or <code>T</code> is not a <a href="#Types">named type</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1507 | </li> |
| 1508 | <li> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1509 | <code>T</code> is an interface type and |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1510 | <code>x</code> <a href="#Interface_types">implements</a> <code>T</code>. |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 1511 | </li> |
| 1512 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 1513 | <code>x</code> is a bidirectional channel value, <code>T</code> is a channel type, |
| 1514 | <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] | 1515 | 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] | 1516 | </li> |
| 1517 | <li> |
| 1518 | <code>x</code> is the predeclared identifier <code>nil</code> and <code>T</code> |
| 1519 | is a pointer, function, slice, map, channel, or interface type. |
| 1520 | </li> |
| 1521 | <li> |
| 1522 | <code>x</code> is an untyped <a href="#Constants">constant</a> representable |
| 1523 | by a value of type <code>T</code>. |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1524 | </li> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1525 | </ul> |
| 1526 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1527 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1528 | <h2 id="Blocks">Blocks</h2> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1529 | |
| 1530 | <p> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 1531 | A <i>block</i> is a possibly empty sequence of declarations and statements |
| 1532 | within matching brace brackets. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1533 | </p> |
| 1534 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1535 | <pre class="ebnf"> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 1536 | Block = "{" StatementList "}" . |
| 1537 | StatementList = { Statement ";" } . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1538 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1539 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1540 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1541 | 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] | 1542 | </p> |
| 1543 | |
| 1544 | <ol> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1545 | <li>The <i>universe block</i> encompasses all Go source text.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1546 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1547 | <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] | 1548 | Go source text for that package.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1549 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1550 | <li>Each file has a <i>file block</i> containing all Go source text |
| 1551 | in that file.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1552 | |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 1553 | <li>Each <a href="#If_statements">"if"</a>, |
| 1554 | <a href="#For_statements">"for"</a>, and |
| 1555 | <a href="#Switch_statements">"switch"</a> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1556 | statement is considered to be in its own implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1557 | |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 1558 | <li>Each clause in a <a href="#Switch_statements">"switch"</a> |
| 1559 | or <a href="#Select_statements">"select"</a> statement |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1560 | acts as an implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1561 | </ol> |
| 1562 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1563 | <p> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1564 | Blocks nest and influence <a href="#Declarations_and_scope">scoping</a>. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1565 | </p> |
| 1566 | |
| 1567 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1568 | <h2 id="Declarations_and_scope">Declarations and scope</h2> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1569 | |
| 1570 | <p> |
Robert Griesemer | 4cc71e3 | 2013-10-03 16:38:22 -0700 | [diff] [blame] | 1571 | A <i>declaration</i> binds a non-<a href="#Blank_identifier">blank</a> identifier to a |
| 1572 | <a href="#Constant_declarations">constant</a>, |
| 1573 | <a href="#Type_declarations">type</a>, |
| 1574 | <a href="#Variable_declarations">variable</a>, |
| 1575 | <a href="#Function_declarations">function</a>, |
| 1576 | <a href="#Labeled_statements">label</a>, or |
| 1577 | <a href="#Import_declarations">package</a>. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1578 | Every identifier in a program must be declared. |
| 1579 | No identifier may be declared twice in the same block, and |
| 1580 | no identifier may be declared in both the file and package block. |
| 1581 | </p> |
| 1582 | |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 1583 | <p> |
| 1584 | The <a href="#Blank_identifier">blank identifier</a> may be used like any other identifier |
| 1585 | in a declaration, but it does not introduce a binding and thus is not declared. |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 1586 | In the package block, the identifier <code>init</code> may only be used for |
| 1587 | <a href="#Package_initialization"><code>init</code> function</a> declarations, |
| 1588 | and like the blank identifier it does not introduce a new binding. |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 1589 | </p> |
| 1590 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1591 | <pre class="ebnf"> |
| 1592 | Declaration = ConstDecl | TypeDecl | VarDecl . |
| 1593 | TopLevelDecl = Declaration | FunctionDecl | MethodDecl . |
| 1594 | </pre> |
| 1595 | |
| 1596 | <p> |
| 1597 | The <i>scope</i> of a declared identifier is the extent of source text in which |
Robert Griesemer | 4cc71e3 | 2013-10-03 16:38:22 -0700 | [diff] [blame] | 1598 | the identifier denotes the specified constant, type, variable, function, label, or package. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1599 | </p> |
| 1600 | |
| 1601 | <p> |
Robert Griesemer | 4cc71e3 | 2013-10-03 16:38:22 -0700 | [diff] [blame] | 1602 | Go is lexically scoped using <a href="#Blocks">blocks</a>: |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1603 | </p> |
| 1604 | |
| 1605 | <ol> |
Robert Griesemer | 4cc71e3 | 2013-10-03 16:38:22 -0700 | [diff] [blame] | 1606 | <li>The scope of a <a href="#Predeclared_identifiers">predeclared identifier</a> is the universe block.</li> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1607 | |
| 1608 | <li>The scope of an identifier denoting a constant, type, variable, |
Robert Griesemer | 967a2b3 | 2011-03-03 15:24:28 -0800 | [diff] [blame] | 1609 | or function (but not method) declared at top level (outside any |
| 1610 | function) is the package block.</li> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1611 | |
Robert Griesemer | e126763 | 2012-11-21 14:40:50 -0800 | [diff] [blame] | 1612 | <li>The scope of the package name of an imported package is the file block |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1613 | of the file containing the import declaration.</li> |
| 1614 | |
Robert Griesemer | 85e451e | 2012-11-29 14:47:47 -0800 | [diff] [blame] | 1615 | <li>The scope of an identifier denoting a method receiver, function parameter, |
| 1616 | or result variable is the function body.</li> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1617 | |
| 1618 | <li>The scope of a constant or variable identifier declared |
| 1619 | inside a function begins at the end of the ConstSpec or VarSpec |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 1620 | (ShortVarDecl for short variable declarations) |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1621 | and ends at the end of the innermost containing block.</li> |
| 1622 | |
| 1623 | <li>The scope of a type identifier declared inside a function |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1624 | begins at the identifier in the TypeSpec |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1625 | and ends at the end of the innermost containing block.</li> |
| 1626 | </ol> |
| 1627 | |
| 1628 | <p> |
| 1629 | An identifier declared in a block may be redeclared in an inner block. |
| 1630 | While the identifier of the inner declaration is in scope, it denotes |
| 1631 | the entity declared by the inner declaration. |
| 1632 | </p> |
| 1633 | |
| 1634 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1635 | 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] | 1636 | 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] | 1637 | 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] | 1638 | declarations. |
| 1639 | </p> |
| 1640 | |
| 1641 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1642 | <h3 id="Label_scopes">Label scopes</h3> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1643 | |
| 1644 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1645 | Labels are declared by <a href="#Labeled_statements">labeled statements</a> and are |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 1646 | used in the <a href="#Break_statements">"break"</a>, |
| 1647 | <a href="#Continue_statements">"continue"</a>, and |
| 1648 | <a href="#Goto_statements">"goto"</a> statements. |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 1649 | It is illegal to define a label that is never used. |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1650 | In contrast to other identifiers, labels are not block scoped and do |
| 1651 | not conflict with identifiers that are not labels. The scope of a label |
| 1652 | is the body of the function in which it is declared and excludes |
| 1653 | the body of any nested function. |
| 1654 | </p> |
| 1655 | |
| 1656 | |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1657 | <h3 id="Blank_identifier">Blank identifier</h3> |
| 1658 | |
| 1659 | <p> |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 1660 | The <i>blank identifier</i> is represented by the underscore character <code>_</code>. |
| 1661 | It serves as an anonymous placeholder instead of a regular (non-blank) |
| 1662 | identifier and has special meaning in <a href="#Declarations_and_scope">declarations</a>, |
| 1663 | as an <a href="#Operands">operand</a>, and in <a href="#Assignments">assignments</a>. |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1664 | </p> |
| 1665 | |
| 1666 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1667 | <h3 id="Predeclared_identifiers">Predeclared identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1668 | |
| 1669 | <p> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1670 | The following identifiers are implicitly declared in the |
| 1671 | <a href="#Blocks">universe block</a>: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1672 | </p> |
| 1673 | <pre class="grammar"> |
Russ Cox | d9877e2 | 2011-11-01 21:45:02 -0400 | [diff] [blame] | 1674 | Types: |
| 1675 | bool byte complex64 complex128 error float32 float64 |
| 1676 | int int8 int16 int32 int64 rune string |
| 1677 | uint uint8 uint16 uint32 uint64 uintptr |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1678 | |
| 1679 | Constants: |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1680 | true false iota |
| 1681 | |
| 1682 | Zero value: |
| 1683 | nil |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1684 | |
| 1685 | Functions: |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 1686 | append cap close complex copy delete imag len |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 1687 | make new panic print println real recover |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1688 | </pre> |
| 1689 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1690 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1691 | <h3 id="Exported_identifiers">Exported identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1692 | |
| 1693 | <p> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1694 | An identifier may be <i>exported</i> to permit access to it from another package. |
| 1695 | An identifier is exported if both: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1696 | </p> |
| 1697 | <ol> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1698 | <li>the first character of the identifier's name is a Unicode upper case |
| 1699 | letter (Unicode class "Lu"); and</li> |
| 1700 | <li>the identifier is declared in the <a href="#Blocks">package block</a> |
| 1701 | or it is a <a href="#Struct_types">field name</a> or |
| 1702 | <a href="#MethodName">method name</a>.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1703 | </ol> |
| 1704 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1705 | All other identifiers are not exported. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1706 | </p> |
| 1707 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1708 | |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1709 | <h3 id="Uniqueness_of_identifiers">Uniqueness of identifiers</h3> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1710 | |
| 1711 | <p> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 1712 | Given a set of identifiers, an identifier is called <i>unique</i> if it is |
| 1713 | <i>different</i> from every other in the set. |
| 1714 | Two identifiers are different if they are spelled differently, or if they |
| 1715 | appear in different <a href="#Packages">packages</a> and are not |
Shenghou Ma | 2195f1a | 2012-03-30 14:04:03 +0800 | [diff] [blame] | 1716 | <a href="#Exported_identifiers">exported</a>. Otherwise, they are the same. |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1717 | </p> |
| 1718 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1719 | <h3 id="Constant_declarations">Constant declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1720 | |
| 1721 | <p> |
| 1722 | A constant declaration binds a list of identifiers (the names of |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1723 | the constants) to the values of a list of <a href="#Constant_expressions">constant expressions</a>. |
| 1724 | The number of identifiers must be equal |
| 1725 | to the number of expressions, and the <i>n</i>th identifier on |
| 1726 | 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] | 1727 | right. |
| 1728 | </p> |
| 1729 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1730 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1731 | ConstDecl = "const" ( ConstSpec | "(" { ConstSpec ";" } ")" ) . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1732 | ConstSpec = IdentifierList [ [ Type ] "=" ExpressionList ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1733 | |
| 1734 | IdentifierList = identifier { "," identifier } . |
| 1735 | ExpressionList = Expression { "," Expression } . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1736 | </pre> |
| 1737 | |
| 1738 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1739 | If the type is present, all constants take the type specified, and |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 1740 | the expressions must be <a href="#Assignability">assignable</a> to that type. |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1741 | If the type is omitted, the constants take the |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1742 | individual types of the corresponding expressions. |
| 1743 | If the expression values are untyped <a href="#Constants">constants</a>, |
| 1744 | the declared constants remain untyped and the constant identifiers |
| 1745 | denote the constant values. For instance, if the expression is a |
| 1746 | floating-point literal, the constant identifier denotes a floating-point |
| 1747 | constant, even if the literal's fractional part is zero. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1748 | </p> |
| 1749 | |
| 1750 | <pre> |
| 1751 | const Pi float64 = 3.14159265358979323846 |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1752 | const zero = 0.0 // untyped floating-point constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1753 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1754 | size int64 = 1024 |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1755 | eof = -1 // untyped integer constant |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1756 | ) |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1757 | 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] | 1758 | const u, v float32 = 0, 3 // u = 0.0, v = 3.0 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1759 | </pre> |
| 1760 | |
| 1761 | <p> |
| 1762 | Within a parenthesized <code>const</code> declaration list the |
| 1763 | expression list may be omitted from any but the first declaration. |
| 1764 | Such an empty list is equivalent to the textual substitution of the |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 1765 | first preceding non-empty expression list and its type if any. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1766 | Omitting the list of expressions is therefore equivalent to |
| 1767 | repeating the previous list. The number of identifiers must be equal |
| 1768 | to the number of expressions in the previous list. |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 1769 | Together with the <a href="#Iota"><code>iota</code> constant generator</a> |
| 1770 | this mechanism permits light-weight declaration of sequential values: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1771 | </p> |
| 1772 | |
| 1773 | <pre> |
| 1774 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1775 | Sunday = iota |
| 1776 | Monday |
| 1777 | Tuesday |
| 1778 | Wednesday |
| 1779 | Thursday |
| 1780 | Friday |
| 1781 | Partyday |
| 1782 | numberOfDays // this constant is not exported |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1783 | ) |
| 1784 | </pre> |
| 1785 | |
| 1786 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1787 | <h3 id="Iota">Iota</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1788 | |
| 1789 | <p> |
Robert Griesemer | 39f009c | 2010-04-29 10:57:27 -0700 | [diff] [blame] | 1790 | Within a <a href="#Constant_declarations">constant declaration</a>, the predeclared identifier |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 1791 | <code>iota</code> represents successive untyped integer <a href="#Constants"> |
| 1792 | 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] | 1793 | appears in the source and increments after each <a href="#ConstSpec">ConstSpec</a>. |
| 1794 | It can be used to construct a set of related constants: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1795 | </p> |
| 1796 | |
| 1797 | <pre> |
Robert Griesemer | 09e900e | 2015-11-25 13:18:49 -0800 | [diff] [blame] | 1798 | const ( // iota is reset to 0 |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1799 | c0 = iota // c0 == 0 |
| 1800 | c1 = iota // c1 == 1 |
| 1801 | c2 = iota // c2 == 2 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1802 | ) |
| 1803 | |
Robert Griesemer | 09e900e | 2015-11-25 13:18:49 -0800 | [diff] [blame] | 1804 | const ( // iota is reset to 0 |
| 1805 | a = 1 << iota // a == 1 |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1806 | b = 1 << iota // b == 2 |
Robert Griesemer | 09e900e | 2015-11-25 13:18:49 -0800 | [diff] [blame] | 1807 | c = 3 // c == 3 (iota is not used but still incremented) |
| 1808 | d = 1 << iota // d == 8 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1809 | ) |
| 1810 | |
Robert Griesemer | 09e900e | 2015-11-25 13:18:49 -0800 | [diff] [blame] | 1811 | const ( // iota is reset to 0 |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1812 | u = iota * 42 // u == 0 (untyped integer constant) |
| 1813 | v float64 = iota * 42 // v == 42.0 (float64 constant) |
| 1814 | w = iota * 42 // w == 84 (untyped integer constant) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1815 | ) |
| 1816 | |
Robert Griesemer | 09e900e | 2015-11-25 13:18:49 -0800 | [diff] [blame] | 1817 | const x = iota // x == 0 (iota has been reset) |
| 1818 | const y = iota // y == 0 (iota has been reset) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1819 | </pre> |
| 1820 | |
| 1821 | <p> |
| 1822 | 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] | 1823 | it is only incremented after each ConstSpec: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1824 | </p> |
| 1825 | |
| 1826 | <pre> |
| 1827 | const ( |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1828 | bit0, mask0 = 1 << iota, 1<<iota - 1 // bit0 == 1, mask0 == 0 |
| 1829 | bit1, mask1 // bit1 == 2, mask1 == 1 |
| 1830 | _, _ // skips iota == 2 |
| 1831 | bit3, mask3 // bit3 == 8, mask3 == 7 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1832 | ) |
| 1833 | </pre> |
| 1834 | |
| 1835 | <p> |
| 1836 | This last example exploits the implicit repetition of the |
| 1837 | last non-empty expression list. |
| 1838 | </p> |
| 1839 | |
| 1840 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1841 | <h3 id="Type_declarations">Type declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1842 | |
| 1843 | <p> |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1844 | A type declaration binds an identifier, the <i>type name</i>, to a new type |
Robert Griesemer | 6f3b84a | 2014-05-07 08:42:08 -0700 | [diff] [blame] | 1845 | that has the same <a href="#Types">underlying type</a> as an existing type, |
| 1846 | and operations defined for the existing type are also defined for the new type. |
| 1847 | The new type is <a href="#Type_identity">different</a> from the existing type. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1848 | </p> |
| 1849 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1850 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1851 | TypeDecl = "type" ( TypeSpec | "(" { TypeSpec ";" } ")" ) . |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1852 | TypeSpec = identifier Type . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1853 | </pre> |
| 1854 | |
| 1855 | <pre> |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1856 | type IntArray [16]int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1857 | |
| 1858 | type ( |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1859 | Point struct{ x, y float64 } |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1860 | Polar Point |
| 1861 | ) |
| 1862 | |
| 1863 | type TreeNode struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1864 | left, right *TreeNode |
| 1865 | value *Comparable |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1866 | } |
| 1867 | |
Rob Pike | 217408a | 2011-11-09 14:22:44 -0800 | [diff] [blame] | 1868 | type Block interface { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1869 | BlockSize() int |
| 1870 | Encrypt(src, dst []byte) |
| 1871 | Decrypt(src, dst []byte) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1872 | } |
| 1873 | </pre> |
| 1874 | |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1875 | <p> |
| 1876 | 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] | 1877 | 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] | 1878 | 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] | 1879 | </p> |
| 1880 | |
| 1881 | <pre> |
Rob Pike | bdbe0de | 2011-05-25 06:00:07 +1000 | [diff] [blame] | 1882 | // A Mutex is a data type with two methods, Lock and Unlock. |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1883 | type Mutex struct { /* Mutex fields */ } |
| 1884 | func (m *Mutex) Lock() { /* Lock implementation */ } |
| 1885 | func (m *Mutex) Unlock() { /* Unlock implementation */ } |
| 1886 | |
| 1887 | // NewMutex has the same composition as Mutex but its method set is empty. |
| 1888 | type NewMutex Mutex |
| 1889 | |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 1890 | // The method set of the <a href="#Pointer_types">base type</a> of PtrMutex remains unchanged, |
| 1891 | // but the method set of PtrMutex is empty. |
| 1892 | type PtrMutex *Mutex |
| 1893 | |
Robert Griesemer | f5b3c14 | 2010-04-27 17:52:44 -0700 | [diff] [blame] | 1894 | // The method set of *PrintableMutex contains the methods |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 1895 | // Lock and Unlock bound to its anonymous field Mutex. |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1896 | type PrintableMutex struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1897 | Mutex |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1898 | } |
Robert Griesemer | 735e00d | 2010-03-31 16:37:22 -0700 | [diff] [blame] | 1899 | |
Rob Pike | 217408a | 2011-11-09 14:22:44 -0800 | [diff] [blame] | 1900 | // MyBlock is an interface type that has the same method set as Block. |
| 1901 | type MyBlock Block |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1902 | </pre> |
| 1903 | |
| 1904 | <p> |
| 1905 | A type declaration may be used to define a different boolean, numeric, or string |
| 1906 | type and attach methods to it: |
| 1907 | </p> |
| 1908 | |
| 1909 | <pre> |
| 1910 | type TimeZone int |
| 1911 | |
| 1912 | const ( |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1913 | EST TimeZone = -(5 + iota) |
| 1914 | CST |
| 1915 | MST |
| 1916 | PST |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1917 | ) |
| 1918 | |
| 1919 | func (tz TimeZone) String() string { |
Robert Griesemer | 02d7448 | 2015-07-31 11:15:11 -0700 | [diff] [blame] | 1920 | return fmt.Sprintf("GMT%+dh", tz) |
Robert Griesemer | fc61b77 | 2009-09-28 14:10:20 -0700 | [diff] [blame] | 1921 | } |
| 1922 | </pre> |
| 1923 | |
| 1924 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1925 | <h3 id="Variable_declarations">Variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1926 | |
| 1927 | <p> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1928 | A variable declaration creates one or more variables, binds corresponding |
| 1929 | identifiers to them, and gives each a type and an initial value. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1930 | </p> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1931 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1932 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1933 | VarDecl = "var" ( VarSpec | "(" { VarSpec ";" } ")" ) . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1934 | VarSpec = IdentifierList ( Type [ "=" ExpressionList ] | "=" ExpressionList ) . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1935 | </pre> |
| 1936 | |
| 1937 | <pre> |
| 1938 | var i int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1939 | var U, V, W float64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1940 | var k = 0 |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 1941 | var x, y float32 = -1, -2 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1942 | var ( |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 1943 | i int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1944 | u, v, s = 2.0, 3.0, "bar" |
| 1945 | ) |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 1946 | var re, im = complexSqrt(-1) |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 1947 | var _, found = entries[name] // map lookup; only interested in "found" |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1948 | </pre> |
| 1949 | |
| 1950 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1951 | If a list of expressions is given, the variables are initialized |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1952 | with the expressions following the rules for <a href="#Assignments">assignments</a>. |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 1953 | 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] | 1954 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1955 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1956 | <p> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1957 | If a type is present, each variable is given that type. |
| 1958 | Otherwise, each variable is given the type of the corresponding |
| 1959 | initialization value in the assignment. |
| 1960 | If that value is an untyped constant, it is first |
| 1961 | <a href="#Conversions">converted</a> to its <a href="#Constants">default type</a>; |
| 1962 | if it is an untyped boolean value, it is first converted to type <code>bool</code>. |
| 1963 | The predeclared value <code>nil</code> cannot be used to initialize a variable |
| 1964 | with no explicit type. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1965 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1966 | |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1967 | <pre> |
Brad Fitzpatrick | 5f029de | 2014-12-22 07:58:26 -0800 | [diff] [blame] | 1968 | var d = math.Sin(0.5) // d is float64 |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 1969 | var i = 42 // i is int |
| 1970 | var t, ok = x.(T) // t is T, ok is bool |
| 1971 | var n = nil // illegal |
| 1972 | </pre> |
Robert Griesemer | 2c9e163 | 2012-02-28 17:44:24 -0800 | [diff] [blame] | 1973 | |
| 1974 | <p> |
| 1975 | Implementation restriction: A compiler may make it illegal to declare a variable |
| 1976 | inside a <a href="#Function_declarations">function body</a> if the variable is |
| 1977 | never used. |
| 1978 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1979 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1980 | <h3 id="Short_variable_declarations">Short variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1981 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1982 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1983 | A <i>short variable declaration</i> uses the syntax: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1984 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1985 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1986 | <pre class="ebnf"> |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 1987 | ShortVarDecl = IdentifierList ":=" ExpressionList . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1988 | </pre> |
| 1989 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1990 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 1991 | It is shorthand for a regular <a href="#Variable_declarations">variable declaration</a> |
Robert Griesemer | 2c9e163 | 2012-02-28 17:44:24 -0800 | [diff] [blame] | 1992 | with initializer expressions but no types: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 1993 | </p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1994 | |
| 1995 | <pre class="grammar"> |
| 1996 | "var" IdentifierList = ExpressionList . |
| 1997 | </pre> |
| 1998 | |
| 1999 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2000 | i, j := 0, 10 |
| 2001 | f := func() int { return 7 } |
| 2002 | ch := make(chan int) |
| 2003 | r, w := os.Pipe(fd) // os.Pipe() returns two values |
| 2004 | _, y, _ := coord(p) // coord() returns three values; only interested in y coordinate |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2005 | </pre> |
| 2006 | |
| 2007 | <p> |
Robert Griesemer | 85789da | 2015-08-04 11:29:28 -0700 | [diff] [blame] | 2008 | Unlike regular variable declarations, a short variable declaration may <i>redeclare</i> |
| 2009 | variables provided they were originally declared earlier in the same block |
| 2010 | (or the parameter lists if the block is the function body) with the same type, |
| 2011 | and at least one of the non-<a href="#Blank_identifier">blank</a> variables is new. |
| 2012 | As a consequence, redeclaration can only appear in a multi-variable short declaration. |
| 2013 | Redeclaration does not introduce a new variable; it just assigns a new value to the original. |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 2014 | </p> |
| 2015 | |
| 2016 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2017 | field1, offset := nextField(str, 0) |
| 2018 | field2, offset := nextField(str, offset) // redeclares offset |
Robert Griesemer | f1cc0f4 | 2013-01-09 11:31:32 -0800 | [diff] [blame] | 2019 | a, a := 1, 2 // illegal: double declaration of a or no new variable if a was declared elsewhere |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 2020 | </pre> |
| 2021 | |
| 2022 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2023 | Short variable declarations may appear only inside functions. |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 2024 | In some contexts such as the initializers for |
| 2025 | <a href="#If_statements">"if"</a>, |
| 2026 | <a href="#For_statements">"for"</a>, or |
| 2027 | <a href="#Switch_statements">"switch"</a> statements, |
| 2028 | they can be used to declare local temporary variables. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2029 | </p> |
| 2030 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2031 | <h3 id="Function_declarations">Function declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2032 | |
| 2033 | <p> |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2034 | A function declaration binds an identifier, the <i>function name</i>, |
| 2035 | to a function. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2036 | </p> |
| 2037 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2038 | <pre class="ebnf"> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2039 | FunctionDecl = "func" FunctionName ( Function | Signature ) . |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2040 | FunctionName = identifier . |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2041 | Function = Signature FunctionBody . |
| 2042 | FunctionBody = Block . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2043 | </pre> |
| 2044 | |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 2045 | <p> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2046 | If the function's <a href="#Function_types">signature</a> declares |
| 2047 | result parameters, the function body's statement list must end in |
| 2048 | a <a href="#Terminating_statements">terminating statement</a>. |
| 2049 | </p> |
| 2050 | |
Rob Pike | d020891 | 2013-03-22 10:03:55 -0700 | [diff] [blame] | 2051 | <pre> |
Robert Griesemer | 02d7448 | 2015-07-31 11:15:11 -0700 | [diff] [blame] | 2052 | func IndexRune(s string, r rune) int { |
| 2053 | for i, c := range s { |
| 2054 | if c == r { |
| 2055 | return i |
Rob Pike | d020891 | 2013-03-22 10:03:55 -0700 | [diff] [blame] | 2056 | } |
| 2057 | } |
Robert Griesemer | 02d7448 | 2015-07-31 11:15:11 -0700 | [diff] [blame] | 2058 | // invalid: missing return statement |
Rob Pike | d020891 | 2013-03-22 10:03:55 -0700 | [diff] [blame] | 2059 | } |
| 2060 | </pre> |
| 2061 | |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2062 | <p> |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 2063 | A function declaration may omit the body. Such a declaration provides the |
| 2064 | signature for a function implemented outside Go, such as an assembly routine. |
| 2065 | </p> |
| 2066 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2067 | <pre> |
| 2068 | func min(x int, y int) int { |
| 2069 | if x < y { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2070 | return x |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2071 | } |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2072 | return y |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2073 | } |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 2074 | |
| 2075 | func flushICache(begin, end uintptr) // implemented externally |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2076 | </pre> |
| 2077 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2078 | <h3 id="Method_declarations">Method declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2079 | |
| 2080 | <p> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2081 | A method is a <a href="#Function_declarations">function</a> with a <i>receiver</i>. |
| 2082 | A method declaration binds an identifier, the <i>method name</i>, to a method, |
| 2083 | and associates the method with the receiver's <i>base type</i>. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2084 | </p> |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2085 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2086 | <pre class="ebnf"> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2087 | MethodDecl = "func" Receiver MethodName ( Function | Signature ) . |
Robert Griesemer | 187ee2c | 2014-06-24 16:25:09 -0700 | [diff] [blame] | 2088 | Receiver = Parameters . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2089 | </pre> |
| 2090 | |
| 2091 | <p> |
Paolo Martini | 3549178 | 2015-07-17 17:26:08 +0200 | [diff] [blame] | 2092 | The receiver is specified via an extra parameter section preceding the method |
Robert Griesemer | 57c81ef | 2015-12-15 13:13:38 -0800 | [diff] [blame] | 2093 | name. That parameter section must declare a single non-variadic parameter, the receiver. |
Robert Griesemer | 187ee2c | 2014-06-24 16:25:09 -0700 | [diff] [blame] | 2094 | Its type must be of the form <code>T</code> or <code>*T</code> (possibly using |
| 2095 | parentheses) where <code>T</code> is a type name. The type denoted by <code>T</code> is called |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2096 | the receiver <i>base type</i>; it must not be a pointer or interface type and |
| 2097 | it must be declared in the same package as the method. |
| 2098 | The method is said to be <i>bound</i> to the base type and the method name |
Robert Griesemer | 05614bf | 2015-08-04 11:52:01 -0700 | [diff] [blame] | 2099 | is visible only within <a href="#Selectors">selectors</a> for type <code>T</code> |
| 2100 | or <code>*T</code>. |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2101 | </p> |
| 2102 | |
| 2103 | <p> |
Robert Griesemer | 85e451e | 2012-11-29 14:47:47 -0800 | [diff] [blame] | 2104 | A non-<a href="#Blank_identifier">blank</a> receiver identifier must be |
| 2105 | <a href="#Uniqueness_of_identifiers">unique</a> in the method signature. |
| 2106 | If the receiver's value is not referenced inside the body of the method, |
| 2107 | its identifier may be omitted in the declaration. The same applies in |
| 2108 | general to parameters of functions and methods. |
| 2109 | </p> |
| 2110 | |
| 2111 | <p> |
| 2112 | For a base type, the non-blank names of methods bound to it must be unique. |
Robert Griesemer | b1d9ae9 | 2012-02-12 20:03:30 -0800 | [diff] [blame] | 2113 | If the base type is a <a href="#Struct_types">struct type</a>, |
| 2114 | the non-blank method and field names must be distinct. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2115 | </p> |
| 2116 | |
| 2117 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2118 | Given type <code>Point</code>, the declarations |
| 2119 | </p> |
| 2120 | |
| 2121 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2122 | func (p *Point) Length() float64 { |
| 2123 | return math.Sqrt(p.x * p.x + p.y * p.y) |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2124 | } |
| 2125 | |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2126 | func (p *Point) Scale(factor float64) { |
| 2127 | p.x *= factor |
| 2128 | p.y *= factor |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2129 | } |
| 2130 | </pre> |
| 2131 | |
| 2132 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2133 | bind the methods <code>Length</code> and <code>Scale</code>, |
| 2134 | with receiver type <code>*Point</code>, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2135 | to the base type <code>Point</code>. |
| 2136 | </p> |
| 2137 | |
| 2138 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2139 | The type of a method is the type of a function with the receiver as first |
| 2140 | argument. For instance, the method <code>Scale</code> has type |
| 2141 | </p> |
| 2142 | |
| 2143 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2144 | func(p *Point, factor float64) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2145 | </pre> |
| 2146 | |
| 2147 | <p> |
| 2148 | However, a function declared this way is not a method. |
| 2149 | </p> |
| 2150 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 2151 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2152 | <h2 id="Expressions">Expressions</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2153 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2154 | <p> |
| 2155 | An expression specifies the computation of a value by applying |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 2156 | operators and functions to operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2157 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2158 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2159 | <h3 id="Operands">Operands</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2160 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 2161 | <p> |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 2162 | Operands denote the elementary values in an expression. An operand may be a |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 2163 | literal, a (possibly <a href="#Qualified_identifiers">qualified</a>) |
| 2164 | non-<a href="#Blank_identifier">blank</a> identifier denoting a |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 2165 | <a href="#Constant_declarations">constant</a>, |
| 2166 | <a href="#Variable_declarations">variable</a>, or |
| 2167 | <a href="#Function_declarations">function</a>, |
| 2168 | a <a href="#Method_expressions">method expression</a> yielding a function, |
| 2169 | or a parenthesized expression. |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 2170 | </p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2171 | |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 2172 | <p> |
| 2173 | The <a href="#Blank_identifier">blank identifier</a> may appear as an |
| 2174 | operand only on the left-hand side of an <a href="#Assignments">assignment</a>. |
| 2175 | </p> |
| 2176 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2177 | <pre class="ebnf"> |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 2178 | Operand = Literal | OperandName | MethodExpr | "(" Expression ")" . |
| 2179 | Literal = BasicLit | CompositeLit | FunctionLit . |
| 2180 | BasicLit = int_lit | float_lit | imaginary_lit | rune_lit | string_lit . |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 2181 | OperandName = identifier | QualifiedIdent. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2182 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2183 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2184 | <h3 id="Qualified_identifiers">Qualified identifiers</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2185 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2186 | <p> |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 2187 | A qualified identifier is an identifier qualified with a package name prefix. |
| 2188 | Both the package name and the identifier must not be |
| 2189 | <a href="#Blank_identifier">blank</a>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2190 | </p> |
Robert Griesemer | 337af31 | 2008-11-17 18:11:36 -0800 | [diff] [blame] | 2191 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2192 | <pre class="ebnf"> |
Robert Griesemer | 809e06b | 2012-06-26 11:49:19 -0700 | [diff] [blame] | 2193 | QualifiedIdent = PackageName "." identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2194 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2195 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2196 | <p> |
Robert Griesemer | da63371 | 2012-02-29 09:06:05 -0800 | [diff] [blame] | 2197 | A qualified identifier accesses an identifier in a different package, which |
| 2198 | must be <a href="#Import_declarations">imported</a>. |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 2199 | The identifier must be <a href="#Exported_identifiers">exported</a> and |
| 2200 | declared in the <a href="#Blocks">package block</a> of that package. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2201 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2202 | |
| 2203 | <pre> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 2204 | math.Sin // denotes the Sin function in package math |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2205 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2206 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2207 | <h3 id="Composite_literals">Composite literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2208 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2209 | <p> |
| 2210 | Composite literals construct values for structs, arrays, slices, and maps |
| 2211 | and create a new value each time they are evaluated. |
Robert Griesemer | c720875 | 2015-09-22 17:47:38 -0700 | [diff] [blame] | 2212 | They consist of the type of the literal followed by a brace-bound list of elements. |
Robert Griesemer | 3b02242 | 2015-09-11 16:20:23 -0700 | [diff] [blame] | 2213 | Each element may optionally be preceded by a corresponding key. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2214 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2215 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2216 | <pre class="ebnf"> |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2217 | CompositeLit = LiteralType LiteralValue . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2218 | LiteralType = StructType | ArrayType | "[" "..." "]" ElementType | |
Robert Griesemer | 07cc644 | 2010-07-29 18:13:41 -0700 | [diff] [blame] | 2219 | SliceType | MapType | TypeName . |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2220 | LiteralValue = "{" [ ElementList [ "," ] ] "}" . |
Robert Griesemer | 3b02242 | 2015-09-11 16:20:23 -0700 | [diff] [blame] | 2221 | ElementList = KeyedElement { "," KeyedElement } . |
| 2222 | KeyedElement = [ Key ":" ] Element . |
Robert Griesemer | 7727dee | 2015-01-08 16:01:31 -0800 | [diff] [blame] | 2223 | Key = FieldName | Expression | LiteralValue . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2224 | FieldName = identifier . |
Robert Griesemer | 3b02242 | 2015-09-11 16:20:23 -0700 | [diff] [blame] | 2225 | Element = Expression | LiteralValue . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2226 | </pre> |
Robert Griesemer | 0976e34 | 2008-09-03 13:37:44 -0700 | [diff] [blame] | 2227 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2228 | <p> |
Robert Griesemer | c720875 | 2015-09-22 17:47:38 -0700 | [diff] [blame] | 2229 | The LiteralType's underlying type must be a struct, array, slice, or map type |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2230 | (the grammar enforces this constraint except when the type is given |
| 2231 | as a TypeName). |
Robert Griesemer | 3b02242 | 2015-09-11 16:20:23 -0700 | [diff] [blame] | 2232 | The types of the elements and keys must be <a href="#Assignability">assignable</a> |
Robert Griesemer | c720875 | 2015-09-22 17:47:38 -0700 | [diff] [blame] | 2233 | to the respective field, element, and key types of the literal type; |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2234 | there is no additional conversion. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2235 | The key is interpreted as a field name for struct literals, |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 2236 | an index for array and slice literals, and a key for map literals. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2237 | For map literals, all elements must have a key. It is an error |
| 2238 | to specify multiple elements with the same field name or |
| 2239 | constant key value. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2240 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2241 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2242 | <p> |
| 2243 | For struct literals the following rules apply: |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 2244 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2245 | <ul> |
Robert Griesemer | c720875 | 2015-09-22 17:47:38 -0700 | [diff] [blame] | 2246 | <li>A key must be a field name declared in the struct type. |
Robert Griesemer | d3b1565 | 2009-11-16 08:58:55 -0800 | [diff] [blame] | 2247 | </li> |
Robert Griesemer | 369a974 | 2012-10-31 15:07:25 -0700 | [diff] [blame] | 2248 | <li>An element list that does not contain any keys must |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2249 | list an element for each struct field in the |
| 2250 | order in which the fields are declared. |
| 2251 | </li> |
| 2252 | <li>If any element has a key, every element must have a key. |
| 2253 | </li> |
Robert Griesemer | 369a974 | 2012-10-31 15:07:25 -0700 | [diff] [blame] | 2254 | <li>An element list that contains keys does not need to |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2255 | have an element for each struct field. Omitted fields |
| 2256 | get the zero value for that field. |
| 2257 | </li> |
| 2258 | <li>A literal may omit the element list; such a literal evaluates |
Robert Griesemer | 369a974 | 2012-10-31 15:07:25 -0700 | [diff] [blame] | 2259 | to the zero value for its type. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2260 | </li> |
| 2261 | <li>It is an error to specify an element for a non-exported |
| 2262 | field of a struct belonging to a different package. |
| 2263 | </li> |
| 2264 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2265 | |
| 2266 | <p> |
| 2267 | Given the declarations |
| 2268 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2269 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2270 | type Point3D struct { x, y, z float64 } |
| 2271 | type Line struct { p, q Point3D } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2272 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2273 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2274 | <p> |
| 2275 | one may write |
| 2276 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2277 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2278 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2279 | origin := Point3D{} // zero value for Point3D |
| 2280 | 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] | 2281 | </pre> |
| 2282 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 2283 | <p> |
| 2284 | For array and slice literals the following rules apply: |
| 2285 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2286 | <ul> |
| 2287 | <li>Each element has an associated integer index marking |
| 2288 | its position in the array. |
| 2289 | </li> |
| 2290 | <li>An element with a key uses the key as its index; the |
| 2291 | key must be a constant integer expression. |
| 2292 | </li> |
| 2293 | <li>An element without a key uses the previous element's index plus one. |
| 2294 | If the first element has no key, its index is zero. |
| 2295 | </li> |
| 2296 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2297 | |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2298 | <p> |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 2299 | <a href="#Address_operators">Taking the address</a> of a composite literal |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 2300 | generates a pointer to a unique <a href="#Variables">variable</a> initialized |
| 2301 | with the literal's value. |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2302 | </p> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 2303 | <pre> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 2304 | var pointer *Point3D = &Point3D{y: 1000} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2305 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2306 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2307 | <p> |
Robert Griesemer | c720875 | 2015-09-22 17:47:38 -0700 | [diff] [blame] | 2308 | The length of an array literal is the length specified in the literal type. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 2309 | 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] | 2310 | elements are set to the zero value for the array element type. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2311 | It is an error to provide elements with index values outside the index range |
| 2312 | of the array. The notation <code>...</code> specifies an array length equal |
| 2313 | to the maximum element index plus one. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2314 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2315 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2316 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 2317 | buffer := [10]string{} // len(buffer) == 10 |
| 2318 | intSet := [6]int{1, 2, 3, 5} // len(intSet) == 6 |
| 2319 | days := [...]string{"Sat", "Sun"} // len(days) == 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2320 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2321 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2322 | <p> |
| 2323 | A slice literal describes the entire underlying array literal. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 2324 | Thus, the length and capacity of a slice literal are the maximum |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2325 | element index plus one. A slice literal has the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2326 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2327 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2328 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2329 | []T{x1, x2, … xn} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2330 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2331 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2332 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2333 | and is shorthand for a slice operation applied to an array: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2334 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 2335 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2336 | <pre> |
Russ Cox | 4dfe976 | 2011-12-02 12:30:20 -0500 | [diff] [blame] | 2337 | tmp := [n]T{x1, x2, … xn} |
| 2338 | tmp[0 : n] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2339 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2340 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2341 | <p> |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2342 | Within a composite literal of array, slice, or map type <code>T</code>, |
Robert Griesemer | 7727dee | 2015-01-08 16:01:31 -0800 | [diff] [blame] | 2343 | elements or map keys that are themselves composite literals may elide the respective |
| 2344 | literal type if it is identical to the element or key type of <code>T</code>. |
| 2345 | Similarly, elements or keys that are addresses of composite literals may elide |
| 2346 | the <code>&T</code> when the element or key type is <code>*T</code>. |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2347 | </p> |
| 2348 | |
| 2349 | <pre> |
Robert Griesemer | 7727dee | 2015-01-08 16:01:31 -0800 | [diff] [blame] | 2350 | [...]Point{{1.5, -3.5}, {0, 0}} // same as [...]Point{Point{1.5, -3.5}, Point{0, 0}} |
| 2351 | [][]int{{1, 2, 3}, {4, 5}} // same as [][]int{[]int{1, 2, 3}, []int{4, 5}} |
| 2352 | [][]Point{{{0, 1}, {1, 2}}} // same as [][]Point{[]Point{Point{0, 1}, Point{1, 2}}} |
| 2353 | map[string]Point{"orig": {0, 0}} // same as map[string]Point{"orig": Point{0, 0}} |
Russ Cox | 5f49456 | 2011-12-02 14:12:53 -0500 | [diff] [blame] | 2354 | |
Robert Griesemer | 7727dee | 2015-01-08 16:01:31 -0800 | [diff] [blame] | 2355 | [...]*Point{{1.5, -3.5}, {0, 0}} // same as [...]*Point{&Point{1.5, -3.5}, &Point{0, 0}} |
| 2356 | |
| 2357 | map[Point]string{{0, 0}: "orig"} // same as map[Point]string{Point{0, 0}: "orig"} |
Robert Griesemer | a12141e | 2010-10-22 08:58:52 -0700 | [diff] [blame] | 2358 | </pre> |
| 2359 | |
| 2360 | <p> |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2361 | A parsing ambiguity arises when a composite literal using the |
Robert Griesemer | a36b5b9 | 2014-02-27 08:57:30 -0800 | [diff] [blame] | 2362 | TypeName form of the LiteralType appears as an operand between the |
| 2363 | <a href="#Keywords">keyword</a> and the opening brace of the block |
| 2364 | of an "if", "for", or "switch" statement, and the composite literal |
| 2365 | is not enclosed in parentheses, square brackets, or curly braces. |
| 2366 | In this rare case, the opening brace of the literal is erroneously parsed |
| 2367 | as the one introducing the block of statements. To resolve the ambiguity, |
| 2368 | the composite literal must appear within parentheses. |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2369 | </p> |
| 2370 | |
| 2371 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 2372 | if x == (T{a,b,c}[i]) { … } |
| 2373 | if (x == T{a,b,c}[i]) { … } |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 2374 | </pre> |
| 2375 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2376 | <p> |
| 2377 | Examples of valid array, slice, and map literals: |
| 2378 | </p> |
| 2379 | |
| 2380 | <pre> |
| 2381 | // list of prime numbers |
Rob Pike | fc06cad | 2012-02-07 06:59:36 +1100 | [diff] [blame] | 2382 | primes := []int{2, 3, 5, 7, 9, 2147483647} |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2383 | |
| 2384 | // vowels[ch] is true if ch is a vowel |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2385 | 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] | 2386 | |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2387 | // the array [10]float32{-1, 0, 0, 0, -0.1, -0.1, 0, 0, 0, -1} |
| 2388 | filter := [10]float32{-1, 4: -0.1, -0.1, 9: -1} |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2389 | |
| 2390 | // frequencies in Hz for equal-tempered scale (A4 = 440Hz) |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2391 | noteFrequency := map[string]float32{ |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 2392 | "C0": 16.35, "D0": 18.35, "E0": 20.60, "F0": 21.83, |
| 2393 | "G0": 24.50, "A0": 27.50, "B0": 30.87, |
| 2394 | } |
| 2395 | </pre> |
| 2396 | |
| 2397 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2398 | <h3 id="Function_literals">Function literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2399 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2400 | <p> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2401 | A function literal represents an anonymous <a href="#Function_declarations">function</a>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2402 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2403 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2404 | <pre class="ebnf"> |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 2405 | FunctionLit = "func" Function . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2406 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2407 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2408 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 2409 | func(a, b int, z float64) bool { return a*b < int(z) } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2410 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2411 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2412 | <p> |
| 2413 | A function literal can be assigned to a variable or invoked directly. |
| 2414 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2415 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2416 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2417 | f := func(x, y int) int { return x + y } |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 2418 | func(ch chan int) { ch <- ACK }(replyChan) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2419 | </pre> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2420 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2421 | <p> |
| 2422 | Function literals are <i>closures</i>: they may refer to variables |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 2423 | defined in a surrounding function. Those variables are then shared between |
| 2424 | the surrounding function and the function literal, and they survive as long |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2425 | as they are accessible. |
| 2426 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 2427 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2428 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2429 | <h3 id="Primary_expressions">Primary expressions</h3> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2430 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 2431 | <p> |
| 2432 | Primary expressions are the operands for unary and binary expressions. |
| 2433 | </p> |
| 2434 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2435 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2436 | PrimaryExpr = |
| 2437 | Operand | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 2438 | Conversion | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2439 | PrimaryExpr Selector | |
| 2440 | PrimaryExpr Index | |
| 2441 | PrimaryExpr Slice | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2442 | PrimaryExpr TypeAssertion | |
Robert Griesemer | ccc713c | 2014-10-27 16:31:15 -0700 | [diff] [blame] | 2443 | PrimaryExpr Arguments . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2444 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2445 | Selector = "." identifier . |
| 2446 | Index = "[" Expression "]" . |
Robert Griesemer | e333b96 | 2013-09-11 17:18:52 -0700 | [diff] [blame] | 2447 | Slice = "[" ( [ Expression ] ":" [ Expression ] ) | |
| 2448 | ( [ Expression ] ":" Expression ":" Expression ) |
| 2449 | "]" . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2450 | TypeAssertion = "." "(" Type ")" . |
Robert Griesemer | ccc713c | 2014-10-27 16:31:15 -0700 | [diff] [blame] | 2451 | Arguments = "(" [ ( ExpressionList | Type [ "," ExpressionList ] ) [ "..." ] [ "," ] ] ")" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2452 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2453 | |
| 2454 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2455 | <pre> |
| 2456 | x |
| 2457 | 2 |
| 2458 | (s + ".txt") |
| 2459 | f(3.1415, true) |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2460 | Point{1, 2} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2461 | m["foo"] |
| 2462 | s[i : j + 1] |
| 2463 | obj.color |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2464 | f.p[i].x() |
| 2465 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2466 | |
| 2467 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2468 | <h3 id="Selectors">Selectors</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2469 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2470 | <p> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2471 | For a <a href="#Primary_expressions">primary expression</a> <code>x</code> |
| 2472 | that is not a <a href="#Package_clause">package name</a>, the |
| 2473 | <i>selector expression</i> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2474 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2475 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2476 | <pre> |
| 2477 | x.f |
| 2478 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2479 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2480 | <p> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2481 | denotes the field or method <code>f</code> of the value <code>x</code> |
| 2482 | (or sometimes <code>*x</code>; see below). |
| 2483 | The identifier <code>f</code> is called the (field or method) <i>selector</i>; |
| 2484 | it must not be the <a href="#Blank_identifier">blank identifier</a>. |
| 2485 | The type of the selector expression is the type of <code>f</code>. |
| 2486 | If <code>x</code> is a package name, see the section on |
| 2487 | <a href="#Qualified_identifiers">qualified identifiers</a>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2488 | </p> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2489 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2490 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2491 | A selector <code>f</code> may denote a field or method <code>f</code> of |
| 2492 | a type <code>T</code>, or it may refer |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2493 | to a field or method <code>f</code> of a nested |
| 2494 | <a href="#Struct_types">anonymous field</a> of <code>T</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2495 | The number of anonymous fields traversed |
| 2496 | to reach <code>f</code> is called its <i>depth</i> in <code>T</code>. |
| 2497 | The depth of a field or method <code>f</code> |
| 2498 | declared in <code>T</code> is zero. |
| 2499 | The depth of a field or method <code>f</code> declared in |
| 2500 | an anonymous field <code>A</code> in <code>T</code> is the |
| 2501 | depth of <code>f</code> in <code>A</code> plus one. |
| 2502 | </p> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2503 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2504 | <p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2505 | The following rules apply to selectors: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2506 | </p> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2507 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2508 | <ol> |
| 2509 | <li> |
| 2510 | For a value <code>x</code> of type <code>T</code> or <code>*T</code> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2511 | where <code>T</code> is not a pointer or interface type, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2512 | <code>x.f</code> denotes the field or method at the shallowest depth |
| 2513 | in <code>T</code> where there |
| 2514 | is such an <code>f</code>. |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 2515 | If there is not exactly <a href="#Uniqueness_of_identifiers">one <code>f</code></a> |
| 2516 | with shallowest depth, the selector expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2517 | </li> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2518 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2519 | <li> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2520 | For a value <code>x</code> of type <code>I</code> where <code>I</code> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2521 | is an interface type, <code>x.f</code> denotes the actual method with name |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2522 | <code>f</code> of the dynamic value of <code>x</code>. |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2523 | If there is no method with name <code>f</code> in the |
| 2524 | <a href="#Method_sets">method set</a> of <code>I</code>, the selector |
| 2525 | expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2526 | </li> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2527 | |
| 2528 | <li> |
| 2529 | As an exception, if the type of <code>x</code> is a named pointer type |
| 2530 | and <code>(*x).f</code> is a valid selector expression denoting a field |
| 2531 | (but not a method), <code>x.f</code> is shorthand for <code>(*x).f</code>. |
| 2532 | </li> |
| 2533 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2534 | <li> |
| 2535 | In all other cases, <code>x.f</code> is illegal. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 2536 | </li> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2537 | |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2538 | <li> |
Russ Cox | 6e15683 | 2013-03-20 16:54:07 -0400 | [diff] [blame] | 2539 | If <code>x</code> is of pointer type and has the value |
| 2540 | <code>nil</code> and <code>x.f</code> denotes a struct field, |
| 2541 | assigning to or evaluating <code>x.f</code> |
| 2542 | causes a <a href="#Run_time_panics">run-time panic</a>. |
| 2543 | </li> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2544 | |
Russ Cox | 6e15683 | 2013-03-20 16:54:07 -0400 | [diff] [blame] | 2545 | <li> |
| 2546 | If <code>x</code> is of interface type and has the value |
| 2547 | <code>nil</code>, <a href="#Calls">calling</a> or |
| 2548 | <a href="#Method_values">evaluating</a> the method <code>x.f</code> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2549 | causes a <a href="#Run_time_panics">run-time panic</a>. |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 2550 | </li> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2551 | </ol> |
Robert Griesemer | 71de83b | 2012-06-28 12:22:24 -0700 | [diff] [blame] | 2552 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2553 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2554 | For example, given the declarations: |
| 2555 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2556 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2557 | <pre> |
| 2558 | type T0 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2559 | x int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2560 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2561 | |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2562 | func (*T0) M0() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2563 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2564 | type T1 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2565 | y int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2566 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2567 | |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2568 | func (T1) M1() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2569 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2570 | type T2 struct { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2571 | z int |
| 2572 | T1 |
| 2573 | *T0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2574 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2575 | |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2576 | func (*T2) M2() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2577 | |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2578 | type Q *T2 |
| 2579 | |
| 2580 | var t T2 // with t.T0 != nil |
| 2581 | var p *T2 // with p != nil and (*p).T0 != nil |
| 2582 | var q Q = p |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2583 | </pre> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2584 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2585 | <p> |
| 2586 | one may write: |
| 2587 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2588 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2589 | <pre> |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2590 | t.z // t.z |
| 2591 | t.y // t.T1.y |
Robert Griesemer | f9ec929 | 2015-05-18 11:18:58 -0700 | [diff] [blame] | 2592 | t.x // (*t.T0).x |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2593 | |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2594 | p.z // (*p).z |
| 2595 | p.y // (*p).T1.y |
| 2596 | p.x // (*(*p).T0).x |
| 2597 | |
| 2598 | q.x // (*(*q).T0).x (*q).x is a valid field selector |
| 2599 | |
Robert Griesemer | 02d7448 | 2015-07-31 11:15:11 -0700 | [diff] [blame] | 2600 | p.M0() // ((*p).T0).M0() M0 expects *T0 receiver |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2601 | p.M1() // ((*p).T1).M1() M1 expects T1 receiver |
Robert Griesemer | 02d7448 | 2015-07-31 11:15:11 -0700 | [diff] [blame] | 2602 | p.M2() // p.M2() M2 expects *T2 receiver |
| 2603 | t.M2() // (&t).M2() M2 expects *T2 receiver, see section on Calls |
Robert Griesemer | 40818cf | 2014-11-11 13:19:47 -0800 | [diff] [blame] | 2604 | </pre> |
| 2605 | |
| 2606 | <p> |
| 2607 | but the following is invalid: |
| 2608 | </p> |
| 2609 | |
| 2610 | <pre> |
| 2611 | q.M0() // (*q).M0 is valid but not a field selector |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2612 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2613 | |
| 2614 | |
Robert Griesemer | f852034 | 2014-08-28 08:53:25 -0700 | [diff] [blame] | 2615 | <h3 id="Method_expressions">Method expressions</h3> |
| 2616 | |
| 2617 | <p> |
| 2618 | If <code>M</code> is in the <a href="#Method_sets">method set</a> of type <code>T</code>, |
| 2619 | <code>T.M</code> is a function that is callable as a regular function |
| 2620 | with the same arguments as <code>M</code> prefixed by an additional |
| 2621 | argument that is the receiver of the method. |
| 2622 | </p> |
| 2623 | |
| 2624 | <pre class="ebnf"> |
| 2625 | MethodExpr = ReceiverType "." MethodName . |
| 2626 | ReceiverType = TypeName | "(" "*" TypeName ")" | "(" ReceiverType ")" . |
| 2627 | </pre> |
| 2628 | |
| 2629 | <p> |
| 2630 | Consider a struct type <code>T</code> with two methods, |
| 2631 | <code>Mv</code>, whose receiver is of type <code>T</code>, and |
| 2632 | <code>Mp</code>, whose receiver is of type <code>*T</code>. |
| 2633 | </p> |
| 2634 | |
| 2635 | <pre> |
| 2636 | type T struct { |
| 2637 | a int |
| 2638 | } |
| 2639 | func (tv T) Mv(a int) int { return 0 } // value receiver |
| 2640 | func (tp *T) Mp(f float32) float32 { return 1 } // pointer receiver |
| 2641 | |
| 2642 | var t T |
| 2643 | </pre> |
| 2644 | |
| 2645 | <p> |
| 2646 | The expression |
| 2647 | </p> |
| 2648 | |
| 2649 | <pre> |
| 2650 | T.Mv |
| 2651 | </pre> |
| 2652 | |
| 2653 | <p> |
| 2654 | yields a function equivalent to <code>Mv</code> but |
| 2655 | with an explicit receiver as its first argument; it has signature |
| 2656 | </p> |
| 2657 | |
| 2658 | <pre> |
| 2659 | func(tv T, a int) int |
| 2660 | </pre> |
| 2661 | |
| 2662 | <p> |
| 2663 | That function may be called normally with an explicit receiver, so |
| 2664 | these five invocations are equivalent: |
| 2665 | </p> |
| 2666 | |
| 2667 | <pre> |
| 2668 | t.Mv(7) |
| 2669 | T.Mv(t, 7) |
| 2670 | (T).Mv(t, 7) |
| 2671 | f1 := T.Mv; f1(t, 7) |
| 2672 | f2 := (T).Mv; f2(t, 7) |
| 2673 | </pre> |
| 2674 | |
| 2675 | <p> |
| 2676 | Similarly, the expression |
| 2677 | </p> |
| 2678 | |
| 2679 | <pre> |
| 2680 | (*T).Mp |
| 2681 | </pre> |
| 2682 | |
| 2683 | <p> |
| 2684 | yields a function value representing <code>Mp</code> with signature |
| 2685 | </p> |
| 2686 | |
| 2687 | <pre> |
| 2688 | func(tp *T, f float32) float32 |
| 2689 | </pre> |
| 2690 | |
| 2691 | <p> |
| 2692 | For a method with a value receiver, one can derive a function |
| 2693 | with an explicit pointer receiver, so |
| 2694 | </p> |
| 2695 | |
| 2696 | <pre> |
| 2697 | (*T).Mv |
| 2698 | </pre> |
| 2699 | |
| 2700 | <p> |
| 2701 | yields a function value representing <code>Mv</code> with signature |
| 2702 | </p> |
| 2703 | |
| 2704 | <pre> |
| 2705 | func(tv *T, a int) int |
| 2706 | </pre> |
| 2707 | |
| 2708 | <p> |
| 2709 | Such a function indirects through the receiver to create a value |
| 2710 | to pass as the receiver to the underlying method; |
| 2711 | the method does not overwrite the value whose address is passed in |
| 2712 | the function call. |
| 2713 | </p> |
| 2714 | |
| 2715 | <p> |
| 2716 | The final case, a value-receiver function for a pointer-receiver method, |
| 2717 | is illegal because pointer-receiver methods are not in the method set |
| 2718 | of the value type. |
| 2719 | </p> |
| 2720 | |
| 2721 | <p> |
| 2722 | Function values derived from methods are called with function call syntax; |
| 2723 | the receiver is provided as the first argument to the call. |
| 2724 | That is, given <code>f := T.Mv</code>, <code>f</code> is invoked |
| 2725 | as <code>f(t, 7)</code> not <code>t.f(7)</code>. |
| 2726 | To construct a function that binds the receiver, use a |
| 2727 | <a href="#Function_literals">function literal</a> or |
| 2728 | <a href="#Method_values">method value</a>. |
| 2729 | </p> |
| 2730 | |
| 2731 | <p> |
| 2732 | It is legal to derive a function value from a method of an interface type. |
| 2733 | The resulting function takes an explicit receiver of that interface type. |
| 2734 | </p> |
| 2735 | |
| 2736 | <h3 id="Method_values">Method values</h3> |
| 2737 | |
| 2738 | <p> |
| 2739 | If the expression <code>x</code> has static type <code>T</code> and |
| 2740 | <code>M</code> is in the <a href="#Method_sets">method set</a> of type <code>T</code>, |
| 2741 | <code>x.M</code> is called a <i>method value</i>. |
| 2742 | The method value <code>x.M</code> is a function value that is callable |
| 2743 | with the same arguments as a method call of <code>x.M</code>. |
| 2744 | The expression <code>x</code> is evaluated and saved during the evaluation of the |
| 2745 | method value; the saved copy is then used as the receiver in any calls, |
| 2746 | which may be executed later. |
| 2747 | </p> |
| 2748 | |
| 2749 | <p> |
| 2750 | The type <code>T</code> may be an interface or non-interface type. |
| 2751 | </p> |
| 2752 | |
| 2753 | <p> |
| 2754 | As in the discussion of <a href="#Method_expressions">method expressions</a> above, |
| 2755 | consider a struct type <code>T</code> with two methods, |
| 2756 | <code>Mv</code>, whose receiver is of type <code>T</code>, and |
| 2757 | <code>Mp</code>, whose receiver is of type <code>*T</code>. |
| 2758 | </p> |
| 2759 | |
| 2760 | <pre> |
| 2761 | type T struct { |
| 2762 | a int |
| 2763 | } |
| 2764 | func (tv T) Mv(a int) int { return 0 } // value receiver |
| 2765 | func (tp *T) Mp(f float32) float32 { return 1 } // pointer receiver |
| 2766 | |
| 2767 | var t T |
| 2768 | var pt *T |
| 2769 | func makeT() T |
| 2770 | </pre> |
| 2771 | |
| 2772 | <p> |
| 2773 | The expression |
| 2774 | </p> |
| 2775 | |
| 2776 | <pre> |
| 2777 | t.Mv |
| 2778 | </pre> |
| 2779 | |
| 2780 | <p> |
| 2781 | yields a function value of type |
| 2782 | </p> |
| 2783 | |
| 2784 | <pre> |
| 2785 | func(int) int |
| 2786 | </pre> |
| 2787 | |
| 2788 | <p> |
| 2789 | These two invocations are equivalent: |
| 2790 | </p> |
| 2791 | |
| 2792 | <pre> |
| 2793 | t.Mv(7) |
| 2794 | f := t.Mv; f(7) |
| 2795 | </pre> |
| 2796 | |
| 2797 | <p> |
| 2798 | Similarly, the expression |
| 2799 | </p> |
| 2800 | |
| 2801 | <pre> |
| 2802 | pt.Mp |
| 2803 | </pre> |
| 2804 | |
| 2805 | <p> |
| 2806 | yields a function value of type |
| 2807 | </p> |
| 2808 | |
| 2809 | <pre> |
| 2810 | func(float32) float32 |
| 2811 | </pre> |
| 2812 | |
| 2813 | <p> |
| 2814 | As with <a href="#Selectors">selectors</a>, a reference to a non-interface method with a value receiver |
| 2815 | using a pointer will automatically dereference that pointer: <code>pt.Mv</code> is equivalent to <code>(*pt).Mv</code>. |
| 2816 | </p> |
| 2817 | |
| 2818 | <p> |
| 2819 | As with <a href="#Calls">method calls</a>, a reference to a non-interface method with a pointer receiver |
| 2820 | using an addressable value will automatically take the address of that value: <code>t.Mp</code> is equivalent to <code>(&t).Mp</code>. |
| 2821 | </p> |
| 2822 | |
| 2823 | <pre> |
| 2824 | f := t.Mv; f(7) // like t.Mv(7) |
| 2825 | f := pt.Mp; f(7) // like pt.Mp(7) |
| 2826 | f := pt.Mv; f(7) // like (*pt).Mv(7) |
| 2827 | f := t.Mp; f(7) // like (&t).Mp(7) |
| 2828 | f := makeT().Mp // invalid: result of makeT() is not addressable |
| 2829 | </pre> |
| 2830 | |
| 2831 | <p> |
| 2832 | Although the examples above use non-interface types, it is also legal to create a method value |
| 2833 | from a value of interface type. |
| 2834 | </p> |
| 2835 | |
| 2836 | <pre> |
| 2837 | var i interface { M(int) } = myVal |
| 2838 | f := i.M; f(7) // like i.M(7) |
| 2839 | </pre> |
| 2840 | |
| 2841 | |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 2842 | <h3 id="Index_expressions">Index expressions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2843 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2844 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2845 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2846 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2847 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2848 | <pre> |
| 2849 | a[x] |
| 2850 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2851 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2852 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2853 | denotes the element of the array, pointer to array, slice, string or map <code>a</code> indexed by <code>x</code>. |
| 2854 | The value <code>x</code> is called the <i>index</i> or <i>map key</i>, respectively. |
| 2855 | The following rules apply: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2856 | </p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2857 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2858 | <p> |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 2859 | If <code>a</code> is not a map: |
| 2860 | </p> |
| 2861 | <ul> |
Robert Griesemer | b66df0e | 2013-03-11 09:20:52 -0700 | [diff] [blame] | 2862 | <li>the index <code>x</code> must be of integer type or untyped; |
| 2863 | it is <i>in range</i> if <code>0 <= x < len(a)</code>, |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 2864 | otherwise it is <i>out of range</i></li> |
| 2865 | <li>a <a href="#Constants">constant</a> index must be non-negative |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2866 | and representable by a value of type <code>int</code> |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 2867 | </ul> |
| 2868 | |
| 2869 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2870 | For <code>a</code> of <a href="#Array_types">array type</a> <code>A</code>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2871 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2872 | <ul> |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2873 | <li>a <a href="#Constants">constant</a> index must be in range</li> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2874 | <li>if <code>x</code> is out of range at run time, |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2875 | a <a href="#Run_time_panics">run-time panic</a> occurs</li> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2876 | <li><code>a[x]</code> is the array element at index <code>x</code> and the type of |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2877 | <code>a[x]</code> is the element type of <code>A</code></li> |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2878 | </ul> |
| 2879 | |
| 2880 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2881 | For <code>a</code> of <a href="#Pointer_types">pointer</a> to array type: |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2882 | </p> |
| 2883 | <ul> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2884 | <li><code>a[x]</code> is shorthand for <code>(*a)[x]</code></li> |
| 2885 | </ul> |
| 2886 | |
| 2887 | <p> |
| 2888 | For <code>a</code> of <a href="#Slice_types">slice type</a> <code>S</code>: |
| 2889 | </p> |
| 2890 | <ul> |
| 2891 | <li>if <code>x</code> is out of range at run time, |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2892 | a <a href="#Run_time_panics">run-time panic</a> occurs</li> |
| 2893 | <li><code>a[x]</code> is the slice element at index <code>x</code> and the type of |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2894 | <code>a[x]</code> is the element type of <code>S</code></li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2895 | </ul> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2896 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2897 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2898 | For <code>a</code> of <a href="#String_types">string type</a>: |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2899 | </p> |
| 2900 | <ul> |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 2901 | <li>a <a href="#Constants">constant</a> index must be in range |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 2902 | if the string <code>a</code> is also constant</li> |
| 2903 | <li>if <code>x</code> is out of range at run time, |
| 2904 | a <a href="#Run_time_panics">run-time panic</a> occurs</li> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2905 | <li><code>a[x]</code> is the non-constant byte value at index <code>x</code> and the type of |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2906 | <code>a[x]</code> is <code>byte</code></li> |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 2907 | <li><code>a[x]</code> may not be assigned to</li> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2908 | </ul> |
| 2909 | |
| 2910 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2911 | For <code>a</code> of <a href="#Map_types">map type</a> <code>M</code>: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2912 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2913 | <ul> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2914 | <li><code>x</code>'s type must be |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2915 | <a href="#Assignability">assignable</a> |
| 2916 | to the key type of <code>M</code></li> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2917 | <li>if the map contains an entry with key <code>x</code>, |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2918 | <code>a[x]</code> is the map value with key <code>x</code> |
| 2919 | 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] | 2920 | <li>if the map is <code>nil</code> or does not contain such an entry, |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 2921 | <code>a[x]</code> is the <a href="#The_zero_value">zero value</a> |
| 2922 | for the value type of <code>M</code></li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2923 | </ul> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2924 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2925 | <p> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2926 | Otherwise <code>a[x]</code> is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2927 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2928 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2929 | <p> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2930 | An index expression on a map <code>a</code> of type <code>map[K]V</code> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 2931 | used in an <a href="#Assignments">assignment</a> or initialization of the special form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2932 | </p> |
| 2933 | |
| 2934 | <pre> |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2935 | v, ok = a[x] |
| 2936 | v, ok := a[x] |
| 2937 | var v, ok = a[x] |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2938 | </pre> |
| 2939 | |
| 2940 | <p> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 2941 | yields an additional untyped boolean value. The value of <code>ok</code> is |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2942 | <code>true</code> if the key <code>x</code> is present in the map, and |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 2943 | <code>false</code> otherwise. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2944 | </p> |
| 2945 | |
| 2946 | <p> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 2947 | Assigning to an element of a <code>nil</code> map causes a |
| 2948 | <a href="#Run_time_panics">run-time panic</a>. |
| 2949 | </p> |
| 2950 | |
Robert Griesemer | 29f1ca5 | 2010-03-23 14:01:51 -0700 | [diff] [blame] | 2951 | |
Robert Griesemer | e333b96 | 2013-09-11 17:18:52 -0700 | [diff] [blame] | 2952 | <h3 id="Slice_expressions">Slice expressions</h3> |
| 2953 | |
| 2954 | <p> |
| 2955 | Slice expressions construct a substring or slice from a string, array, pointer |
| 2956 | to array, or slice. There are two variants: a simple form that specifies a low |
| 2957 | and high bound, and a full form that also specifies a bound on the capacity. |
| 2958 | </p> |
| 2959 | |
| 2960 | <h4>Simple slice expressions</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2961 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2962 | <p> |
Russ Cox | 8a8445b | 2011-12-02 13:11:30 -0500 | [diff] [blame] | 2963 | For a string, array, pointer to array, or slice <code>a</code>, the primary expression |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2964 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2965 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2966 | <pre> |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2967 | a[low : high] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2968 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2969 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2970 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 2971 | constructs a substring or slice. The <i>indices</i> <code>low</code> and |
| 2972 | <code>high</code> select which elements of operand <code>a</code> appear |
| 2973 | in the result. The result has indices starting at 0 and length equal to |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2974 | <code>high</code> - <code>low</code>. |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2975 | After slicing the array <code>a</code> |
| 2976 | </p> |
| 2977 | |
| 2978 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 2979 | a := [5]int{1, 2, 3, 4, 5} |
| 2980 | s := a[1:4] |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2981 | </pre> |
| 2982 | |
| 2983 | <p> |
| 2984 | 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] | 2985 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2986 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2987 | <pre> |
| 2988 | s[0] == 2 |
| 2989 | s[1] == 3 |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 2990 | s[2] == 4 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2991 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2992 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2993 | <p> |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 2994 | For convenience, any of the indices may be omitted. A missing <code>low</code> |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2995 | index defaults to zero; a missing <code>high</code> index defaults to the length of the |
| 2996 | sliced operand: |
Scott Lawrence | 0c1695b | 2010-09-07 14:30:17 -0700 | [diff] [blame] | 2997 | </p> |
| 2998 | |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 2999 | <pre> |
Robert Hencke | 58d18e2 | 2013-10-03 12:46:02 -0700 | [diff] [blame] | 3000 | a[2:] // same as a[2 : len(a)] |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3001 | a[:3] // same as a[0 : 3] |
| 3002 | a[:] // same as a[0 : len(a)] |
Robert Griesemer | 9e5bf27 | 2010-09-07 16:32:35 -0700 | [diff] [blame] | 3003 | </pre> |
| 3004 | |
Scott Lawrence | 0c1695b | 2010-09-07 14:30:17 -0700 | [diff] [blame] | 3005 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 3006 | If <code>a</code> is a pointer to an array, <code>a[low : high]</code> is shorthand for |
| 3007 | <code>(*a)[low : high]</code>. |
| 3008 | </p> |
| 3009 | |
| 3010 | <p> |
| 3011 | For arrays or strings, the indices are <i>in range</i> if |
| 3012 | <code>0</code> <= <code>low</code> <= <code>high</code> <= <code>len(a)</code>, |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 3013 | otherwise they are <i>out of range</i>. |
| 3014 | For slices, the upper index bound is the slice capacity <code>cap(a)</code> rather than the length. |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 3015 | A <a href="#Constants">constant</a> index must be non-negative and representable by a value of type |
Robert Griesemer | 6ffd235 | 2014-03-06 17:11:13 -0800 | [diff] [blame] | 3016 | <code>int</code>; for arrays or constant strings, constant indices must also be in range. |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 3017 | If both indices are constant, they must satisfy <code>low <= high</code>. |
| 3018 | If the indices are out of range at run time, a <a href="#Run_time_panics">run-time panic</a> occurs. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3019 | </p> |
| 3020 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3021 | <p> |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 3022 | Except for <a href="#Constants">untyped strings</a>, if the sliced operand is a string or slice, |
| 3023 | the result of the slice operation is a non-constant value of the same type as the operand. |
| 3024 | For untyped string operands the result is a non-constant value of type <code>string</code>. |
Robert Griesemer | c423e95 | 2010-09-02 10:16:31 -0700 | [diff] [blame] | 3025 | If the sliced operand is an array, it must be <a href="#Address_operators">addressable</a> |
| 3026 | 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] | 3027 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3028 | |
Robert Griesemer | 2961d22 | 2013-07-31 22:25:47 -0700 | [diff] [blame] | 3029 | <p> |
| 3030 | If the sliced operand of a valid slice expression is a <code>nil</code> slice, the result |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 3031 | is a <code>nil</code> slice. Otherwise, the result shares its underlying array with the |
| 3032 | operand. |
Rob Pike | 15e6ce2 | 2013-08-15 13:15:55 +1000 | [diff] [blame] | 3033 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3034 | |
Robert Griesemer | e333b96 | 2013-09-11 17:18:52 -0700 | [diff] [blame] | 3035 | <h4>Full slice expressions</h4> |
| 3036 | |
| 3037 | <p> |
| 3038 | For an array, pointer to array, or slice <code>a</code> (but not a string), the primary expression |
| 3039 | </p> |
| 3040 | |
| 3041 | <pre> |
| 3042 | a[low : high : max] |
| 3043 | </pre> |
| 3044 | |
| 3045 | <p> |
| 3046 | constructs a slice of the same type, and with the same length and elements as the simple slice |
| 3047 | expression <code>a[low : high]</code>. Additionally, it controls the resulting slice's capacity |
| 3048 | by setting it to <code>max - low</code>. Only the first index may be omitted; it defaults to 0. |
| 3049 | After slicing the array <code>a</code> |
| 3050 | </p> |
| 3051 | |
| 3052 | <pre> |
| 3053 | a := [5]int{1, 2, 3, 4, 5} |
| 3054 | t := a[1:3:5] |
| 3055 | </pre> |
| 3056 | |
| 3057 | <p> |
| 3058 | the slice <code>t</code> has type <code>[]int</code>, length 2, capacity 4, and elements |
| 3059 | </p> |
| 3060 | |
| 3061 | <pre> |
| 3062 | t[0] == 2 |
| 3063 | t[1] == 3 |
| 3064 | </pre> |
| 3065 | |
| 3066 | <p> |
| 3067 | As for simple slice expressions, if <code>a</code> is a pointer to an array, |
| 3068 | <code>a[low : high : max]</code> is shorthand for <code>(*a)[low : high : max]</code>. |
| 3069 | If the sliced operand is an array, it must be <a href="#Address_operators">addressable</a>. |
| 3070 | </p> |
| 3071 | |
| 3072 | <p> |
| 3073 | The indices are <i>in range</i> if <code>0 <= low <= high <= max <= cap(a)</code>, |
| 3074 | otherwise they are <i>out of range</i>. |
| 3075 | A <a href="#Constants">constant</a> index must be non-negative and representable by a value of type |
Robert Griesemer | 6ffd235 | 2014-03-06 17:11:13 -0800 | [diff] [blame] | 3076 | <code>int</code>; for arrays, constant indices must also be in range. |
Robert Griesemer | e333b96 | 2013-09-11 17:18:52 -0700 | [diff] [blame] | 3077 | If multiple indices are constant, the constants that are present must be in range relative to each |
| 3078 | other. |
| 3079 | If the indices are out of range at run time, a <a href="#Run_time_panics">run-time panic</a> occurs. |
| 3080 | </p> |
| 3081 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3082 | <h3 id="Type_assertions">Type assertions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3083 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3084 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3085 | For an expression <code>x</code> of <a href="#Interface_types">interface type</a> |
| 3086 | and a type <code>T</code>, the primary expression |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3087 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3088 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3089 | <pre> |
| 3090 | x.(T) |
| 3091 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3092 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3093 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3094 | asserts that <code>x</code> is not <code>nil</code> |
Russ Cox | b89a54e | 2009-05-20 18:16:04 -0700 | [diff] [blame] | 3095 | 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] | 3096 | 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] | 3097 | </p> |
| 3098 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3099 | 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] | 3100 | that the dynamic type of <code>x</code> is <a href="#Type_identity">identical</a> |
| 3101 | to the type <code>T</code>. |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 3102 | In this case, <code>T</code> must <a href="#Method_sets">implement</a> the (interface) type of <code>x</code>; |
| 3103 | otherwise the type assertion is invalid since it is not possible for <code>x</code> |
| 3104 | to store a value of type <code>T</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3105 | If <code>T</code> is an interface type, <code>x.(T)</code> asserts that the dynamic type |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 3106 | of <code>x</code> implements the interface <code>T</code>. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3107 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3108 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3109 | 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] | 3110 | stored in <code>x</code> and its type is <code>T</code>. If the type assertion is false, |
| 3111 | a <a href="#Run_time_panics">run-time panic</a> occurs. |
| 3112 | In other words, even though the dynamic type of <code>x</code> |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 3113 | 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] | 3114 | known to be <code>T</code> in a correct program. |
| 3115 | </p> |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 3116 | |
| 3117 | <pre> |
| 3118 | var x interface{} = 7 // x has dynamic type int and value 7 |
| 3119 | i := x.(int) // i has type int and value 7 |
| 3120 | |
| 3121 | type I interface { m() } |
| 3122 | var y I |
| 3123 | s := y.(string) // illegal: string does not implement I (missing method m) |
| 3124 | r := y.(io.Reader) // r has type io.Reader and y must implement both I and io.Reader |
| 3125 | </pre> |
| 3126 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3127 | <p> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 3128 | A type assertion used in an <a href="#Assignments">assignment</a> or initialization of the special form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3129 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3130 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3131 | <pre> |
| 3132 | v, ok = x.(T) |
| 3133 | v, ok := x.(T) |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 3134 | var v, ok = x.(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3135 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3136 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3137 | <p> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 3138 | yields an additional untyped boolean value. The value of <code>ok</code> is <code>true</code> |
| 3139 | if the assertion holds. Otherwise it is <code>false</code> and the value of <code>v</code> is |
| 3140 | 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] | 3141 | No run-time panic occurs in this case. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3142 | </p> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3143 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3144 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3145 | <h3 id="Calls">Calls</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3146 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3147 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3148 | Given an expression <code>f</code> of function type |
| 3149 | <code>F</code>, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3150 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3151 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3152 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 3153 | f(a1, a2, … an) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3154 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3155 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3156 | <p> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 3157 | calls <code>f</code> with arguments <code>a1, a2, … an</code>. |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3158 | Except for one special case, arguments must be single-valued expressions |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3159 | <a href="#Assignability">assignable</a> to the parameter types of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3160 | <code>F</code> and are evaluated before the function is called. |
| 3161 | The type of the expression is the result type |
| 3162 | of <code>F</code>. |
| 3163 | A method invocation is similar but the method itself |
| 3164 | is specified as a selector upon a value of the receiver type for |
| 3165 | the method. |
| 3166 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3167 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3168 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3169 | math.Atan2(x, y) // function call |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3170 | var pt *Point |
Robert Griesemer | ccc713c | 2014-10-27 16:31:15 -0700 | [diff] [blame] | 3171 | pt.Scale(3.5) // method call with receiver pt |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3172 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3173 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3174 | <p> |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 3175 | In a function call, the function value and arguments are evaluated in |
| 3176 | <a href="#Order_of_evaluation">the usual order</a>. |
| 3177 | After they are evaluated, the parameters of the call are passed by value to the function |
| 3178 | and the called function begins execution. |
| 3179 | The return parameters of the function are passed by value |
| 3180 | back to the calling function when the function returns. |
| 3181 | </p> |
| 3182 | |
| 3183 | <p> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3184 | Calling a <code>nil</code> function value |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 3185 | causes a <a href="#Run_time_panics">run-time panic</a>. |
| 3186 | </p> |
| 3187 | |
| 3188 | <p> |
Russ Cox | 1b3083e | 2013-02-09 14:46:55 -0500 | [diff] [blame] | 3189 | As a special case, if the return values of a function or method |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3190 | <code>g</code> are equal in number and individually |
| 3191 | assignable to the parameters of another function or method |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3192 | <code>f</code>, then the call <code>f(g(<i>parameters_of_g</i>))</code> |
| 3193 | will invoke <code>f</code> after binding the return values of |
| 3194 | <code>g</code> to the parameters of <code>f</code> in order. The call |
Russ Cox | 1b3083e | 2013-02-09 14:46:55 -0500 | [diff] [blame] | 3195 | of <code>f</code> must contain no parameters other than the call of <code>g</code>, |
| 3196 | and <code>g</code> must have at least one return value. |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3197 | If <code>f</code> has a final <code>...</code> parameter, it is |
| 3198 | assigned the return values of <code>g</code> that remain after |
| 3199 | assignment of regular parameters. |
| 3200 | </p> |
| 3201 | |
| 3202 | <pre> |
| 3203 | func Split(s string, pos int) (string, string) { |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 3204 | return s[0:pos], s[pos:] |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3205 | } |
| 3206 | |
| 3207 | func Join(s, t string) string { |
| 3208 | return s + t |
| 3209 | } |
| 3210 | |
| 3211 | if Join(Split(value, len(value)/2)) != value { |
Robert Griesemer | 7fc4e37 | 2011-02-01 12:51:10 -0800 | [diff] [blame] | 3212 | log.Panic("test fails") |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 3213 | } |
| 3214 | </pre> |
| 3215 | |
| 3216 | <p> |
Robert Griesemer | 2a838d6 | 2011-02-08 13:31:01 -0800 | [diff] [blame] | 3217 | A method call <code>x.m()</code> is valid if the <a href="#Method_sets">method set</a> |
| 3218 | 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] | 3219 | 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] | 3220 | 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] | 3221 | set contains <code>m</code>, <code>x.m()</code> is shorthand |
| 3222 | for <code>(&x).m()</code>: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3223 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3224 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3225 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3226 | var p Point |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3227 | p.Scale(3.5) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3228 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3229 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3230 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3231 | There is no distinct method type and there are no method literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3232 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3233 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3234 | <h3 id="Passing_arguments_to_..._parameters">Passing arguments to <code>...</code> parameters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3235 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3236 | <p> |
Robert Griesemer | a766277 | 2014-03-06 10:35:05 -0800 | [diff] [blame] | 3237 | If <code>f</code> is <a href="#Function_types">variadic</a> with a final |
| 3238 | parameter <code>p</code> of type <code>...T</code>, then within <code>f</code> |
| 3239 | the type of <code>p</code> is equivalent to type <code>[]T</code>. |
| 3240 | If <code>f</code> is invoked with no actual arguments for <code>p</code>, |
| 3241 | the value passed to <code>p</code> is <code>nil</code>. |
| 3242 | Otherwise, the value passed is a new slice |
| 3243 | of type <code>[]T</code> with a new underlying array whose successive elements |
| 3244 | are the actual arguments, which all must be <a href="#Assignability">assignable</a> |
| 3245 | to <code>T</code>. The length and capacity of the slice is therefore |
| 3246 | the number of arguments bound to <code>p</code> and may differ for each |
| 3247 | call site. |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3248 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 3249 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3250 | <p> |
Robert Griesemer | a766277 | 2014-03-06 10:35:05 -0800 | [diff] [blame] | 3251 | Given the function and calls |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3252 | </p> |
| 3253 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 3254 | func Greeting(prefix string, who ...string) |
Robert Griesemer | a766277 | 2014-03-06 10:35:05 -0800 | [diff] [blame] | 3255 | Greeting("nobody") |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3256 | Greeting("hello:", "Joe", "Anna", "Eileen") |
| 3257 | </pre> |
| 3258 | |
| 3259 | <p> |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 3260 | within <code>Greeting</code>, <code>who</code> will have the value |
Robert Griesemer | a766277 | 2014-03-06 10:35:05 -0800 | [diff] [blame] | 3261 | <code>nil</code> in the first call, and |
| 3262 | <code>[]string{"Joe", "Anna", "Eileen"}</code> in the second. |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3263 | </p> |
| 3264 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 3265 | <p> |
Robert Griesemer | 904adfd | 2010-10-27 10:44:31 -0700 | [diff] [blame] | 3266 | If the final argument is assignable to a slice type <code>[]T</code>, it may be |
| 3267 | passed unchanged as the value for a <code>...T</code> parameter if the argument |
| 3268 | 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] | 3269 | </p> |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3270 | |
| 3271 | <p> |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 3272 | Given the slice <code>s</code> and call |
Rob Pike | b81065d | 2010-01-27 13:14:40 -0800 | [diff] [blame] | 3273 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 3274 | |
Robert Griesemer | ac771a8 | 2010-09-24 14:08:28 -0700 | [diff] [blame] | 3275 | <pre> |
| 3276 | s := []string{"James", "Jasmine"} |
| 3277 | Greeting("goodbye:", s...) |
| 3278 | </pre> |
| 3279 | |
| 3280 | <p> |
| 3281 | within <code>Greeting</code>, <code>who</code> will have the same value as <code>s</code> |
| 3282 | with the same underlying array. |
| 3283 | </p> |
| 3284 | |
| 3285 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3286 | <h3 id="Operators">Operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3287 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3288 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3289 | Operators combine operands into expressions. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3290 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3291 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3292 | <pre class="ebnf"> |
Matthew Dempsky | abb818b | 2015-04-20 17:17:24 -0700 | [diff] [blame] | 3293 | Expression = UnaryExpr | Expression binary_op Expression . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3294 | UnaryExpr = PrimaryExpr | unary_op UnaryExpr . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 3295 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3296 | binary_op = "||" | "&&" | rel_op | add_op | mul_op . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3297 | rel_op = "==" | "!=" | "<" | "<=" | ">" | ">=" . |
| 3298 | add_op = "+" | "-" | "|" | "^" . |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3299 | mul_op = "*" | "/" | "%" | "<<" | ">>" | "&" | "&^" . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3300 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3301 | unary_op = "+" | "-" | "!" | "^" | "*" | "&" | "<-" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3302 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3303 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3304 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3305 | Comparisons are discussed <a href="#Comparison_operators">elsewhere</a>. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3306 | 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] | 3307 | unless the operation involves shifts or untyped <a href="#Constants">constants</a>. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3308 | For operations involving constants only, see the section on |
| 3309 | <a href="#Constant_expressions">constant expressions</a>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 3310 | </p> |
Robert Griesemer | c8e1876 | 2008-09-12 12:26:22 -0700 | [diff] [blame] | 3311 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3312 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3313 | 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] | 3314 | and the other operand is not, the constant is <a href="#Conversions">converted</a> |
| 3315 | to the type of the other operand. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3316 | </p> |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 3317 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3318 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3319 | The right operand in a shift expression must have unsigned integer type |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3320 | 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] | 3321 | If the left operand of a non-constant shift expression is an untyped constant, |
Robert Griesemer | 87c8707 | 2015-08-04 10:38:50 -0700 | [diff] [blame] | 3322 | it is first converted to the type it would assume if the shift expression were |
Robert Griesemer | 58e21dd | 2013-03-15 13:55:50 -0700 | [diff] [blame] | 3323 | replaced by its left operand alone. |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3324 | </p> |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 3325 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3326 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 3327 | var s uint = 33 |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3328 | var i = 1<<s // 1 has type int |
| 3329 | var j int32 = 1<<s // 1 has type int32; j == 0 |
| 3330 | var k = uint64(1<<s) // 1 has type uint64; k == 1<<33 |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 3331 | var m int = 1.0<<s // 1.0 has type int |
Robert Griesemer | 58e21dd | 2013-03-15 13:55:50 -0700 | [diff] [blame] | 3332 | var n = 1.0<<s != i // 1.0 has type int; n == false if ints are 32bits in size |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 3333 | var o = 1<<s == 2<<s // 1 and 2 have type int; o == true if ints are 32bits in size |
Robert Griesemer | 636c5fa | 2011-06-08 09:11:18 -0700 | [diff] [blame] | 3334 | 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] | 3335 | var u = 1.0<<s // illegal: 1.0 has type float64, cannot shift |
Robert Griesemer | 58e21dd | 2013-03-15 13:55:50 -0700 | [diff] [blame] | 3336 | var u1 = 1.0<<s != 0 // illegal: 1.0 has type float64, cannot shift |
| 3337 | var u2 = 1<<s != 1.0 // illegal: 1 has type float64, cannot shift |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 3338 | var v float32 = 1<<s // illegal: 1 has type float32, cannot shift |
Robert Griesemer | 953f2de | 2012-03-01 10:35:15 -0800 | [diff] [blame] | 3339 | var w int64 = 1.0<<33 // 1.0<<33 is a constant shift expression |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 3340 | </pre> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 3341 | |
Robert Griesemer | 3dd3ab4 | 2015-08-04 15:04:39 -0700 | [diff] [blame] | 3342 | |
| 3343 | <h4 id="Operator_precedence">Operator precedence</h4> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3344 | <p> |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 3345 | Unary operators have the highest precedence. |
| 3346 | As the <code>++</code> and <code>--</code> operators form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3347 | statements, not expressions, they fall |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 3348 | outside the operator hierarchy. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3349 | As a consequence, statement <code>*p++</code> is the same as <code>(*p)++</code>. |
| 3350 | <p> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3351 | There are five precedence levels for binary operators. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3352 | Multiplication operators bind strongest, followed by addition |
Russ Cox | 1b4e37a | 2012-09-12 12:05:24 -0400 | [diff] [blame] | 3353 | operators, comparison operators, <code>&&</code> (logical AND), |
| 3354 | and finally <code>||</code> (logical OR): |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3355 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3356 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3357 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3358 | Precedence Operator |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3359 | 5 * / % << >> & &^ |
| 3360 | 4 + - | ^ |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 3361 | 3 == != < <= > >= |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3362 | 2 && |
| 3363 | 1 || |
| 3364 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3365 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3366 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3367 | Binary operators of the same precedence associate from left to right. |
Robert Griesemer | d36d191 | 2009-09-18 11:58:35 -0700 | [diff] [blame] | 3368 | 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] | 3369 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3370 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3371 | <pre> |
| 3372 | +x |
| 3373 | 23 + 3*x[i] |
| 3374 | x <= f() |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3375 | ^a >> b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3376 | f() || g() |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3377 | x == y+1 && <-chanPtr > 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3378 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3379 | |
| 3380 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3381 | <h3 id="Arithmetic_operators">Arithmetic operators</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3382 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3383 | 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] | 3384 | type as the first operand. The four standard arithmetic operators (<code>+</code>, |
Robert Griesemer | 3dd3ab4 | 2015-08-04 15:04:39 -0700 | [diff] [blame] | 3385 | <code>-</code>, <code>*</code>, <code>/</code>) apply to integer, |
| 3386 | floating-point, and complex types; <code>+</code> also applies to strings. |
| 3387 | The bitwise logical and shift operators apply to integers only. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3388 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3389 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3390 | <pre class="grammar"> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3391 | + sum integers, floats, complex values, strings |
| 3392 | - difference integers, floats, complex values |
| 3393 | * product integers, floats, complex values |
| 3394 | / quotient integers, floats, complex values |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 3395 | % remainder integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3396 | |
Russ Cox | 1b4e37a | 2012-09-12 12:05:24 -0400 | [diff] [blame] | 3397 | & bitwise AND integers |
| 3398 | | bitwise OR integers |
| 3399 | ^ bitwise XOR integers |
| 3400 | &^ bit clear (AND NOT) integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3401 | |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3402 | << left shift integer << unsigned integer |
| 3403 | >> right shift integer >> unsigned integer |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3404 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3405 | |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3406 | |
Robert Griesemer | 3dd3ab4 | 2015-08-04 15:04:39 -0700 | [diff] [blame] | 3407 | <h4 id="Integer_operators">Integer operators</h4> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3408 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3409 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 3410 | For two integer values <code>x</code> and <code>y</code>, the integer quotient |
| 3411 | <code>q = x / y</code> and remainder <code>r = x % y</code> satisfy the following |
| 3412 | relationships: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3413 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3414 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3415 | <pre> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 3416 | x = q*y + r and |r| < |y| |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3417 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3418 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3419 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 3420 | with <code>x / y</code> truncated towards zero |
| 3421 | (<a href="http://en.wikipedia.org/wiki/Modulo_operation">"truncated division"</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3422 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3423 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3424 | <pre> |
| 3425 | x y x / y x % y |
| 3426 | 5 3 1 2 |
| 3427 | -5 3 -1 -2 |
| 3428 | 5 -3 -1 2 |
| 3429 | -5 -3 1 -2 |
| 3430 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3431 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3432 | <p> |
Robert Griesemer | bb7eb40 | 2011-05-02 17:23:18 -0700 | [diff] [blame] | 3433 | As an exception to this rule, if the dividend <code>x</code> is the most |
| 3434 | negative value for the int type of <code>x</code>, the quotient |
| 3435 | <code>q = x / -1</code> is equal to <code>x</code> (and <code>r = 0</code>). |
| 3436 | </p> |
| 3437 | |
| 3438 | <pre> |
| 3439 | x, q |
| 3440 | int8 -128 |
| 3441 | int16 -32768 |
| 3442 | int32 -2147483648 |
| 3443 | int64 -9223372036854775808 |
| 3444 | </pre> |
| 3445 | |
| 3446 | <p> |
Robert Griesemer | ddddd39 | 2012-10-19 10:12:09 -0700 | [diff] [blame] | 3447 | If the divisor is a <a href="#Constants">constant</a>, it must not be zero. |
| 3448 | If the divisor is zero at run time, a <a href="#Run_time_panics">run-time panic</a> occurs. |
Matthew Dempsky | 80a87a9 | 2013-01-06 16:56:06 -0800 | [diff] [blame] | 3449 | If the dividend is non-negative and the divisor is a constant power of 2, |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 3450 | the division may be replaced by a right shift, and computing the remainder may |
Russ Cox | 1b4e37a | 2012-09-12 12:05:24 -0400 | [diff] [blame] | 3451 | be replaced by a bitwise AND operation: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3452 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3453 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3454 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3455 | x x / 4 x % 4 x >> 2 x & 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3456 | 11 2 3 2 3 |
| 3457 | -11 -2 -3 -3 1 |
| 3458 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3459 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3460 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3461 | The shift operators shift the left operand by the shift count specified by the |
| 3462 | 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] | 3463 | integer and logical shifts if it is an unsigned integer. |
| 3464 | There is no upper limit on the shift count. Shifts behave |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3465 | as if the left operand is shifted <code>n</code> times by 1 for a shift |
| 3466 | count of <code>n</code>. |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3467 | As a result, <code>x << 1</code> is the same as <code>x*2</code> |
| 3468 | and <code>x >> 1</code> is the same as |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 3469 | <code>x/2</code> but truncated towards negative infinity. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3470 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3471 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3472 | <p> |
| 3473 | For integer operands, the unary operators |
| 3474 | <code>+</code>, <code>-</code>, and <code>^</code> are defined as |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3475 | follows: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3476 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3477 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3478 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3479 | +x is 0 + x |
| 3480 | -x negation is 0 - x |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 3481 | ^x bitwise complement is m ^ x with m = "all bits set to 1" for unsigned x |
| 3482 | and m = -1 for signed x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3483 | </pre> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3484 | |
| 3485 | |
Robert Griesemer | 3dd3ab4 | 2015-08-04 15:04:39 -0700 | [diff] [blame] | 3486 | <h4 id="Integer_overflow">Integer overflow</h4> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3487 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3488 | <p> |
| 3489 | For unsigned integer values, the operations <code>+</code>, |
| 3490 | <code>-</code>, <code>*</code>, and <code><<</code> are |
| 3491 | computed modulo 2<sup><i>n</i></sup>, where <i>n</i> is the bit width of |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 3492 | the <a href="#Numeric_types">unsigned integer</a>'s type. |
| 3493 | Loosely speaking, these unsigned integer operations |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3494 | discard high bits upon overflow, and programs may rely on ``wrap around''. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3495 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3496 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3497 | For signed integers, the operations <code>+</code>, |
| 3498 | <code>-</code>, <code>*</code>, and <code><<</code> may legally |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3499 | overflow and the resulting value exists and is deterministically defined |
| 3500 | by the signed integer representation, the operation, and its operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3501 | No exception is raised as a result of overflow. A |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 3502 | compiler may not optimize code under the assumption that overflow does |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3503 | not occur. For instance, it may not assume that <code>x < x + 1</code> is always true. |
| 3504 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3505 | |
| 3506 | |
Robert Griesemer | 3dd3ab4 | 2015-08-04 15:04:39 -0700 | [diff] [blame] | 3507 | <h4 id="Floating_point_operators">Floating-point operators</h4> |
| 3508 | |
| 3509 | <p> |
| 3510 | For floating-point and complex numbers, |
| 3511 | <code>+x</code> is the same as <code>x</code>, |
| 3512 | while <code>-x</code> is the negation of <code>x</code>. |
| 3513 | The result of a floating-point or complex division by zero is not specified beyond the |
| 3514 | IEEE-754 standard; whether a <a href="#Run_time_panics">run-time panic</a> |
| 3515 | occurs is implementation-specific. |
| 3516 | </p> |
| 3517 | |
| 3518 | |
| 3519 | <h4 id="String_concatenation">String concatenation</h4> |
| 3520 | |
| 3521 | <p> |
| 3522 | Strings can be concatenated using the <code>+</code> operator |
| 3523 | or the <code>+=</code> assignment operator: |
| 3524 | </p> |
| 3525 | |
| 3526 | <pre> |
| 3527 | s := "hi" + string(c) |
| 3528 | s += " and good bye" |
| 3529 | </pre> |
| 3530 | |
| 3531 | <p> |
| 3532 | String addition creates a new string by concatenating the operands. |
| 3533 | </p> |
| 3534 | |
| 3535 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3536 | <h3 id="Comparison_operators">Comparison operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3537 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 3538 | <p> |
Robert Griesemer | c729ed6 | 2013-03-11 09:16:29 -0700 | [diff] [blame] | 3539 | Comparison operators compare two operands and yield an untyped boolean value. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 3540 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3541 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3542 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3543 | == equal |
| 3544 | != not equal |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 3545 | < less |
| 3546 | <= less or equal |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3547 | > greater |
| 3548 | >= greater or equal |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3549 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3550 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 3551 | <p> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3552 | In any comparison, the first operand |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3553 | must be <a href="#Assignability">assignable</a> |
| 3554 | to the type of the second operand, or vice versa. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 3555 | </p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3556 | <p> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3557 | The equality operators <code>==</code> and <code>!=</code> apply |
| 3558 | to operands that are <i>comparable</i>. |
| 3559 | The ordering operators <code><</code>, <code><=</code>, <code>></code>, and <code>>=</code> |
| 3560 | apply to operands that are <i>ordered</i>. |
| 3561 | These terms and the result of the comparisons are defined as follows: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 3562 | </p> |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3563 | |
| 3564 | <ul> |
| 3565 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3566 | Boolean values are comparable. |
| 3567 | Two boolean values are equal if they are either both |
| 3568 | <code>true</code> or both <code>false</code>. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3569 | </li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3570 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3571 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3572 | Integer values are comparable and ordered, in the usual way. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3573 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3574 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3575 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3576 | Floating point values are comparable and ordered, |
| 3577 | as defined by the IEEE-754 standard. |
| 3578 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3579 | |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3580 | <li> |
| 3581 | Complex values are comparable. |
| 3582 | Two complex values <code>u</code> and <code>v</code> are |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3583 | equal if both <code>real(u) == real(v)</code> and |
| 3584 | <code>imag(u) == imag(v)</code>. |
| 3585 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3586 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3587 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3588 | String values are comparable and ordered, lexically byte-wise. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3589 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3590 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3591 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3592 | Pointer values are comparable. |
Robert Griesemer | 1320ce0 | 2012-01-09 16:54:24 -0800 | [diff] [blame] | 3593 | Two pointer values are equal if they point to the same variable or if both have value <code>nil</code>. |
| 3594 | Pointers to distinct <a href="#Size_and_alignment_guarantees">zero-size</a> variables may or may not be equal. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3595 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3596 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3597 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3598 | Channel values are comparable. |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 3599 | Two channel values are equal if they were created by the same call to |
| 3600 | <a href="#Making_slices_maps_and_channels"><code>make</code></a> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3601 | or if both have value <code>nil</code>. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3602 | </li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3603 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3604 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3605 | Interface values are comparable. |
| 3606 | Two interface values are equal if they have <a href="#Type_identity">identical</a> dynamic types |
| 3607 | and equal dynamic values or if both have value <code>nil</code>. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3608 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3609 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3610 | <li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3611 | A value <code>x</code> of non-interface type <code>X</code> and |
| 3612 | a value <code>t</code> of interface type <code>T</code> are comparable when values |
| 3613 | of type <code>X</code> are comparable and |
| 3614 | <code>X</code> implements <code>T</code>. |
| 3615 | They are equal if <code>t</code>'s dynamic type is identical to <code>X</code> |
| 3616 | and <code>t</code>'s dynamic value is equal to <code>x</code>. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3617 | </li> |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3618 | |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3619 | <li> |
Robert Griesemer | 3908467 | 2012-02-16 14:13:17 -0800 | [diff] [blame] | 3620 | Struct values are comparable if all their fields are comparable. |
| 3621 | Two struct values are equal if their corresponding |
| 3622 | non-<a href="#Blank_identifier">blank</a> fields are equal. |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3623 | </li> |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 3624 | |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3625 | <li> |
| 3626 | Array values are comparable if values of the array element type are comparable. |
| 3627 | Two array values are equal if their corresponding elements are equal. |
Robert Griesemer | 1d282a8 | 2010-06-03 16:55:50 -0700 | [diff] [blame] | 3628 | </li> |
| 3629 | </ul> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 3630 | |
Russ Cox | 83f648c | 2011-12-12 22:21:46 -0500 | [diff] [blame] | 3631 | <p> |
| 3632 | A comparison of two interface values with identical dynamic types |
| 3633 | causes a <a href="#Run_time_panics">run-time panic</a> if values |
| 3634 | of that type are not comparable. This behavior applies not only to direct interface |
| 3635 | value comparisons but also when comparing arrays of interface values |
| 3636 | or structs with interface-valued fields. |
| 3637 | </p> |
| 3638 | |
| 3639 | <p> |
| 3640 | Slice, map, and function values are not comparable. |
| 3641 | However, as a special case, a slice, map, or function value may |
| 3642 | be compared to the predeclared identifier <code>nil</code>. |
| 3643 | Comparison of pointer, channel, and interface values to <code>nil</code> |
| 3644 | is also allowed and follows from the general rules above. |
| 3645 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3646 | |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3647 | <pre> |
Matthew Dempsky | ff85f86 | 2015-10-20 15:05:22 -0700 | [diff] [blame] | 3648 | const c = 3 < 4 // c is the untyped boolean constant true |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3649 | |
Robert Griesemer | c729ed6 | 2013-03-11 09:16:29 -0700 | [diff] [blame] | 3650 | type MyBool bool |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3651 | var x, y int |
| 3652 | var ( |
Matthew Dempsky | ff85f86 | 2015-10-20 15:05:22 -0700 | [diff] [blame] | 3653 | // The result of a comparison is an untyped boolean. |
Robert Griesemer | c729ed6 | 2013-03-11 09:16:29 -0700 | [diff] [blame] | 3654 | // The usual assignment rules apply. |
| 3655 | b3 = x == y // b3 has type bool |
| 3656 | b4 bool = x == y // b4 has type bool |
| 3657 | b5 MyBool = x == y // b5 has type MyBool |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3658 | ) |
| 3659 | </pre> |
| 3660 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3661 | <h3 id="Logical_operators">Logical operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3662 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3663 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3664 | Logical operators apply to <a href="#Boolean_types">boolean</a> values |
| 3665 | and yield a result of the same type as the operands. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3666 | The right operand is evaluated conditionally. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3667 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 3668 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3669 | <pre class="grammar"> |
Russ Cox | 1b4e37a | 2012-09-12 12:05:24 -0400 | [diff] [blame] | 3670 | && conditional AND p && q is "if p then q else false" |
| 3671 | || conditional OR p || q is "if p then true else q" |
| 3672 | ! NOT !p is "not p" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3673 | </pre> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3674 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3675 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3676 | <h3 id="Address_operators">Address operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3677 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3678 | <p> |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3679 | For an operand <code>x</code> of type <code>T</code>, the address operation |
| 3680 | <code>&x</code> generates a pointer of type <code>*T</code> to <code>x</code>. |
| 3681 | The operand must be <i>addressable</i>, |
Russ Cox | e7561de | 2010-05-24 14:31:43 -0700 | [diff] [blame] | 3682 | that is, either a variable, pointer indirection, or slice indexing |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3683 | operation; or a field selector of an addressable struct operand; |
Russ Cox | e7561de | 2010-05-24 14:31:43 -0700 | [diff] [blame] | 3684 | or an array indexing operation of an addressable array. |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3685 | As an exception to the addressability requirement, <code>x</code> may also be a |
Robert Griesemer | 614b02d | 2013-01-02 18:11:49 -0800 | [diff] [blame] | 3686 | (possibly parenthesized) |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3687 | <a href="#Composite_literals">composite literal</a>. |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 3688 | If the evaluation of <code>x</code> would cause a <a href="#Run_time_panics">run-time panic</a>, |
Rob Pike | cec0954 | 2013-09-17 07:41:11 +1000 | [diff] [blame] | 3689 | then the evaluation of <code>&x</code> does too. |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3690 | </p> |
Russ Cox | 5ce78b7 | 2013-08-15 14:33:26 -0400 | [diff] [blame] | 3691 | |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3692 | <p> |
| 3693 | For an operand <code>x</code> of pointer type <code>*T</code>, the pointer |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 3694 | indirection <code>*x</code> denotes the <a href="#Variables">variable</a> of type <code>T</code> pointed |
Robert Griesemer | 0e1d941 | 2011-01-26 11:21:23 -0800 | [diff] [blame] | 3695 | to by <code>x</code>. |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 3696 | If <code>x</code> is <code>nil</code>, an attempt to evaluate <code>*x</code> |
| 3697 | will cause a <a href="#Run_time_panics">run-time panic</a>. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3698 | </p> |
| 3699 | |
| 3700 | <pre> |
| 3701 | &x |
| 3702 | &a[f(2)] |
Robert Griesemer | 614b02d | 2013-01-02 18:11:49 -0800 | [diff] [blame] | 3703 | &Point{2, 3} |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3704 | *p |
| 3705 | *pf(x) |
Russ Cox | 5ce78b7 | 2013-08-15 14:33:26 -0400 | [diff] [blame] | 3706 | |
| 3707 | var x *int = nil |
| 3708 | *x // causes a run-time panic |
Rob Pike | cec0954 | 2013-09-17 07:41:11 +1000 | [diff] [blame] | 3709 | &*x // causes a run-time panic |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3710 | </pre> |
| 3711 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3712 | |
| 3713 | <h3 id="Receive_operator">Receive operator</h3> |
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 | <p> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3716 | For an operand <code>ch</code> of <a href="#Channel_types">channel type</a>, |
| 3717 | the value of the receive operation <code><-ch</code> is the value received |
Robert Griesemer | cc3f21c | 2012-12-03 14:23:41 -0800 | [diff] [blame] | 3718 | from the channel <code>ch</code>. The channel direction must permit receive operations, |
| 3719 | and the type of the receive operation is the element type of the channel. |
| 3720 | The expression blocks until a value is available. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 3721 | Receiving from a <code>nil</code> channel blocks forever. |
Robert Griesemer | ab5c762 | 2013-05-31 11:21:37 -0700 | [diff] [blame] | 3722 | A receive operation on a <a href="#Close">closed</a> channel can always proceed |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 3723 | immediately, yielding the element type's <a href="#The_zero_value">zero value</a> |
| 3724 | after any previously sent values have been received. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3725 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3726 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3727 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3728 | v1 := <-ch |
| 3729 | v2 = <-ch |
| 3730 | f(<-ch) |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3731 | <-strobe // wait until clock pulse and discard received value |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3732 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3733 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3734 | <p> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 3735 | A receive expression used in an <a href="#Assignments">assignment</a> or initialization of the special form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3736 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3737 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3738 | <pre> |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 3739 | x, ok = <-ch |
| 3740 | x, ok := <-ch |
| 3741 | var x, ok = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3742 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3743 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3744 | <p> |
Robert Griesemer | c0fca13 | 2014-08-05 11:31:32 -0700 | [diff] [blame] | 3745 | yields an additional untyped boolean result reporting whether the |
Robert Griesemer | 689931c | 2012-06-25 11:28:24 -0700 | [diff] [blame] | 3746 | communication succeeded. The value of <code>ok</code> is <code>true</code> |
| 3747 | if the value received was delivered by a successful send operation to the |
| 3748 | channel, or <code>false</code> if it is a zero value generated because the |
| 3749 | channel is closed and empty. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3750 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3751 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 3752 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3753 | <h3 id="Conversions">Conversions</h3> |
| 3754 | |
| 3755 | <p> |
| 3756 | Conversions are expressions of the form <code>T(x)</code> |
| 3757 | where <code>T</code> is a type and <code>x</code> is an expression |
| 3758 | that can be converted to type <code>T</code>. |
| 3759 | </p> |
| 3760 | |
| 3761 | <pre class="ebnf"> |
Robert Griesemer | 60a6ae8 | 2012-09-26 10:31:57 -0700 | [diff] [blame] | 3762 | Conversion = Type "(" Expression [ "," ] ")" . |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3763 | </pre> |
| 3764 | |
| 3765 | <p> |
Robert Griesemer | 3188ffc | 2012-10-03 13:46:37 -0700 | [diff] [blame] | 3766 | If the type starts with the operator <code>*</code> or <code><-</code>, |
Russ Cox | 71c941b | 2013-02-11 07:48:14 -0500 | [diff] [blame] | 3767 | or if the type starts with the keyword <code>func</code> |
| 3768 | and has no result list, it must be parenthesized when |
| 3769 | necessary to avoid ambiguity: |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3770 | </p> |
| 3771 | |
| 3772 | <pre> |
| 3773 | *Point(p) // same as *(Point(p)) |
Russ Cox | 71c941b | 2013-02-11 07:48:14 -0500 | [diff] [blame] | 3774 | (*Point)(p) // p is converted to *Point |
Robert Griesemer | 934a520 | 2010-05-24 14:58:26 -0700 | [diff] [blame] | 3775 | <-chan int(c) // same as <-(chan int(c)) |
Russ Cox | 71c941b | 2013-02-11 07:48:14 -0500 | [diff] [blame] | 3776 | (<-chan int)(c) // c is converted to <-chan int |
Robert Griesemer | 3188ffc | 2012-10-03 13:46:37 -0700 | [diff] [blame] | 3777 | func()(x) // function signature func() x |
Russ Cox | 71c941b | 2013-02-11 07:48:14 -0500 | [diff] [blame] | 3778 | (func())(x) // x is converted to func() |
| 3779 | (func() int)(x) // x is converted to func() int |
| 3780 | func() int(x) // x is converted to func() int (unambiguous) |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3781 | </pre> |
| 3782 | |
| 3783 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3784 | A <a href="#Constants">constant</a> value <code>x</code> can be converted to |
| 3785 | type <code>T</code> in any of these cases: |
| 3786 | </p> |
| 3787 | |
| 3788 | <ul> |
| 3789 | <li> |
| 3790 | <code>x</code> is representable by a value of type <code>T</code>. |
| 3791 | </li> |
| 3792 | <li> |
Russ Cox | 7576179 | 2013-02-11 07:47:41 -0500 | [diff] [blame] | 3793 | <code>x</code> is a floating-point constant, |
| 3794 | <code>T</code> is a floating-point type, |
| 3795 | and <code>x</code> is representable by a value |
| 3796 | of type <code>T</code> after rounding using |
Robert Griesemer | 55ecda4 | 2015-09-17 18:10:20 -0700 | [diff] [blame] | 3797 | IEEE 754 round-to-even rules, but with an IEEE <code>-0.0</code> |
| 3798 | further rounded to an unsigned <code>0.0</code>. |
Russ Cox | 7576179 | 2013-02-11 07:47:41 -0500 | [diff] [blame] | 3799 | The constant <code>T(x)</code> is the rounded value. |
| 3800 | </li> |
| 3801 | <li> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3802 | <code>x</code> is an integer constant and <code>T</code> is a |
| 3803 | <a href="#String_types">string type</a>. |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 3804 | The <a href="#Conversions_to_and_from_a_string_type">same rule</a> |
| 3805 | as for non-constant <code>x</code> applies in this case. |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3806 | </li> |
| 3807 | </ul> |
| 3808 | |
| 3809 | <p> |
| 3810 | Converting a constant yields a typed constant as result. |
| 3811 | </p> |
| 3812 | |
| 3813 | <pre> |
| 3814 | uint(iota) // iota value of type uint |
| 3815 | float32(2.718281828) // 2.718281828 of type float32 |
| 3816 | complex128(1) // 1.0 + 0.0i of type complex128 |
Russ Cox | 7576179 | 2013-02-11 07:47:41 -0500 | [diff] [blame] | 3817 | float32(0.49999999) // 0.5 of type float32 |
Robert Griesemer | 55ecda4 | 2015-09-17 18:10:20 -0700 | [diff] [blame] | 3818 | float64(-1e-1000) // 0.0 of type float64 |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3819 | string('x') // "x" of type string |
| 3820 | string(0x266c) // "♬" of type string |
| 3821 | MyString("foo" + "bar") // "foobar" of type MyString |
| 3822 | string([]byte{'a'}) // not a constant: []byte{'a'} is not a constant |
| 3823 | (*int)(nil) // not a constant: nil is not a constant, *int is not a boolean, numeric, or string type |
| 3824 | int(1.2) // illegal: 1.2 cannot be represented as an int |
| 3825 | string(65.0) // illegal: 65.0 is not an integer constant |
| 3826 | </pre> |
| 3827 | |
| 3828 | <p> |
| 3829 | A non-constant value <code>x</code> can be converted to type <code>T</code> |
| 3830 | in any of these cases: |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 3831 | </p> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3832 | |
| 3833 | <ul> |
| 3834 | <li> |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 3835 | <code>x</code> is <a href="#Assignability">assignable</a> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3836 | to <code>T</code>. |
| 3837 | </li> |
| 3838 | <li> |
| 3839 | <code>x</code>'s type and <code>T</code> have identical |
| 3840 | <a href="#Types">underlying types</a>. |
| 3841 | </li> |
| 3842 | <li> |
| 3843 | <code>x</code>'s type and <code>T</code> are unnamed pointer types |
| 3844 | and their pointer base types have identical underlying types. |
| 3845 | </li> |
| 3846 | <li> |
| 3847 | <code>x</code>'s type and <code>T</code> are both integer or floating |
| 3848 | point types. |
| 3849 | </li> |
| 3850 | <li> |
| 3851 | <code>x</code>'s type and <code>T</code> are both complex types. |
| 3852 | </li> |
| 3853 | <li> |
Robert Griesemer | 60a6ae8 | 2012-09-26 10:31:57 -0700 | [diff] [blame] | 3854 | <code>x</code> is an integer or a slice of bytes or runes |
| 3855 | and <code>T</code> is a string type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3856 | </li> |
| 3857 | <li> |
Robert Griesemer | 60a6ae8 | 2012-09-26 10:31:57 -0700 | [diff] [blame] | 3858 | <code>x</code> is a string and <code>T</code> is a slice of bytes or runes. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3859 | </li> |
| 3860 | </ul> |
| 3861 | |
| 3862 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3863 | Specific rules apply to (non-constant) conversions between numeric types or |
| 3864 | to and from a string type. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3865 | These conversions may change the representation of <code>x</code> |
| 3866 | and incur a run-time cost. |
| 3867 | All other conversions only change the type but not the representation |
| 3868 | of <code>x</code>. |
| 3869 | </p> |
| 3870 | |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3871 | <p> |
| 3872 | There is no linguistic mechanism to convert between pointers and integers. |
| 3873 | The package <a href="#Package_unsafe"><code>unsafe</code></a> |
| 3874 | implements this functionality under |
| 3875 | restricted circumstances. |
| 3876 | </p> |
| 3877 | |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3878 | <h4>Conversions between numeric types</h4> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3879 | |
| 3880 | <p> |
| 3881 | For the conversion of non-constant numeric values, the following rules apply: |
| 3882 | </p> |
| 3883 | |
Robert Griesemer | 63f0149 | 2010-05-28 14:17:30 -0700 | [diff] [blame] | 3884 | <ol> |
| 3885 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3886 | When converting between integer types, if the value is a signed integer, it is |
| 3887 | sign extended to implicit infinite precision; otherwise it is zero extended. |
| 3888 | It is then truncated to fit in the result type's size. |
| 3889 | 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] | 3890 | 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] | 3891 | </li> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3892 | <li> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3893 | When converting a floating-point number to an integer, the fraction is discarded |
| 3894 | (truncation towards zero). |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3895 | </li> |
| 3896 | <li> |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 3897 | When converting an integer or floating-point number to a floating-point type, |
| 3898 | 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] | 3899 | to the precision specified by the destination type. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3900 | For instance, the value of a variable <code>x</code> of type <code>float32</code> |
| 3901 | may be stored using additional precision beyond that of an IEEE-754 32-bit number, |
| 3902 | but float32(x) represents the result of rounding <code>x</code>'s value to |
| 3903 | 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] | 3904 | of precision, but <code>float32(x + 0.1)</code> does not. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3905 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3906 | </ol> |
| 3907 | |
| 3908 | <p> |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3909 | In all non-constant conversions involving floating-point or complex values, |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 3910 | if the result type cannot represent the value the conversion |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3911 | succeeds but the result value is implementation-dependent. |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3912 | </p> |
| 3913 | |
Robert Griesemer | 2769356 | 2011-06-13 16:47:33 -0700 | [diff] [blame] | 3914 | <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] | 3915 | |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3916 | <ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3917 | <li> |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3918 | 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] | 3919 | string containing the UTF-8 representation of the integer. Values outside |
| 3920 | 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] | 3921 | |
| 3922 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3923 | string('a') // "a" |
Rémy Oudompheng | 2b4cc6c | 2012-07-11 20:26:51 +0200 | [diff] [blame] | 3924 | string(-1) // "\ufffd" == "\xef\xbf\xbd" |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3925 | string(0xf8) // "\u00f8" == "ø" == "\xc3\xb8" |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3926 | type MyString string |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3927 | MyString(0x65e5) // "\u65e5" == "日" == "\xe6\x97\xa5" |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3928 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3929 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3930 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3931 | <li> |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3932 | Converting a slice of bytes to a string type yields |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3933 | a string whose successive bytes are the elements of the slice. |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3934 | |
| 3935 | <pre> |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3936 | string([]byte{'h', 'e', 'l', 'l', '\xc3', '\xb8'}) // "hellø" |
| 3937 | string([]byte{}) // "" |
| 3938 | string([]byte(nil)) // "" |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3939 | |
| 3940 | type MyBytes []byte |
| 3941 | string(MyBytes{'h', 'e', 'l', 'l', '\xc3', '\xb8'}) // "hellø" |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3942 | </pre> |
| 3943 | </li> |
| 3944 | |
| 3945 | <li> |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3946 | Converting a slice of runes to a string type yields |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 3947 | a string that is the concatenation of the individual rune values |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3948 | converted to strings. |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 3949 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3950 | <pre> |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3951 | string([]rune{0x767d, 0x9d6c, 0x7fd4}) // "\u767d\u9d6c\u7fd4" == "白鵬翔" |
| 3952 | string([]rune{}) // "" |
| 3953 | string([]rune(nil)) // "" |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3954 | |
| 3955 | type MyRunes []rune |
| 3956 | string(MyRunes{0x767d, 0x9d6c, 0x7fd4}) // "\u767d\u9d6c\u7fd4" == "白鵬翔" |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3957 | </pre> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3958 | </li> |
| 3959 | |
| 3960 | <li> |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3961 | Converting a value of a string type to a slice of bytes type |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3962 | yields a slice whose successive elements are the bytes of the string. |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3963 | |
| 3964 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3965 | []byte("hellø") // []byte{'h', 'e', 'l', 'l', '\xc3', '\xb8'} |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3966 | []byte("") // []byte{} |
| 3967 | |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 3968 | MyBytes("hellø") // []byte{'h', 'e', 'l', 'l', '\xc3', '\xb8'} |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3969 | </pre> |
| 3970 | </li> |
| 3971 | |
| 3972 | <li> |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3973 | Converting a value of a string type to a slice of runes type |
| 3974 | yields a slice containing the individual Unicode code points of the string. |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3975 | |
Rob Pike | 1811fac | 2010-02-17 11:26:09 +1100 | [diff] [blame] | 3976 | <pre> |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 3977 | []rune(MyString("白鵬翔")) // []rune{0x767d, 0x9d6c, 0x7fd4} |
Robert Griesemer | de47f68 | 2013-06-21 16:11:13 -0700 | [diff] [blame] | 3978 | []rune("") // []rune{} |
| 3979 | |
Russ Cox | 6e3e380 | 2011-11-22 12:30:02 -0500 | [diff] [blame] | 3980 | MyRunes("白鵬翔") // []rune{0x767d, 0x9d6c, 0x7fd4} |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3981 | </pre> |
| 3982 | </li> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 3983 | </ol> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3984 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 3985 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3986 | <h3 id="Constant_expressions">Constant expressions</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 3987 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3988 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3989 | Constant expressions may contain only <a href="#Constants">constant</a> |
Robert Griesemer | ea7c57a | 2012-10-17 11:08:42 -0700 | [diff] [blame] | 3990 | operands and are evaluated at compile time. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 3991 | </p> |
| 3992 | |
| 3993 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 3994 | Untyped boolean, numeric, and string constants may be used as operands |
| 3995 | wherever it is legal to use an operand of boolean, numeric, or string type, |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 3996 | respectively. |
| 3997 | Except for shift operations, if the operands of a binary operation are |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 3998 | different kinds of untyped constants, the operation and, for non-boolean operations, the result use |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 3999 | the kind that appears later in this list: integer, rune, floating-point, complex. |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4000 | For example, an untyped integer constant divided by an |
| 4001 | untyped complex constant yields an untyped complex constant. |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4002 | </p> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 4003 | |
| 4004 | <p> |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4005 | A constant <a href="#Comparison_operators">comparison</a> always yields |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 4006 | an untyped boolean constant. If the left operand of a constant |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4007 | <a href="#Operators">shift expression</a> is an untyped constant, the |
| 4008 | result is an integer constant; otherwise it is a constant of the same |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 4009 | type as the left operand, which must be of |
| 4010 | <a href="#Numeric_types">integer type</a>. |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4011 | Applying all other operators to untyped constants results in an untyped |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4012 | constant of the same kind (that is, a boolean, integer, floating-point, |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4013 | complex, or string constant). |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4014 | </p> |
| 4015 | |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4016 | <pre> |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4017 | const a = 2 + 3.0 // a == 5.0 (untyped floating-point constant) |
| 4018 | const b = 15 / 4 // b == 3 (untyped integer constant) |
| 4019 | const c = 15 / 4.0 // c == 3.75 (untyped floating-point constant) |
Robert Griesemer | 2ae61d5 | 2012-11-17 11:16:07 -0800 | [diff] [blame] | 4020 | const Θ float64 = 3/2 // Θ == 1.0 (type float64, 3/2 is integer division) |
| 4021 | const Π float64 = 3/2. // Π == 1.5 (type float64, 3/2. is float division) |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4022 | const d = 1 << 3.0 // d == 8 (untyped integer constant) |
| 4023 | const e = 1.0 << 3 // e == 8 (untyped integer constant) |
Robert Griesemer | 2d846f6 | 2013-05-08 10:42:08 -0700 | [diff] [blame] | 4024 | const f = int32(1) << 33 // illegal (constant 8589934592 overflows int32) |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4025 | const g = float64(2) >> 1 // illegal (float64(2) is a typed floating-point constant) |
Russ Cox | ef1c535 | 2011-12-09 00:13:19 -0500 | [diff] [blame] | 4026 | const h = "foo" > "bar" // h == true (untyped boolean constant) |
| 4027 | const j = true // j == true (untyped boolean constant) |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 4028 | const k = 'w' + 1 // k == 'x' (untyped rune constant) |
Russ Cox | ef1c535 | 2011-12-09 00:13:19 -0500 | [diff] [blame] | 4029 | const l = "hi" // l == "hi" (untyped string constant) |
| 4030 | const m = string(k) // m == "x" (type string) |
Robert Hencke | 1084ab9 | 2011-12-10 10:04:33 -0800 | [diff] [blame] | 4031 | const Σ = 1 - 0.707i // (untyped complex constant) |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4032 | const Δ = Σ + 2.0e-4 // (untyped complex constant) |
| 4033 | const Φ = iota*1i - 1/1i // (untyped complex constant) |
Robert Griesemer | 32d1278 | 2011-05-23 14:12:42 -0700 | [diff] [blame] | 4034 | </pre> |
| 4035 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4036 | <p> |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4037 | Applying the built-in function <code>complex</code> to untyped |
Rob Pike | 9dfc6f6 | 2012-08-29 14:46:57 -0700 | [diff] [blame] | 4038 | integer, rune, or floating-point constants yields |
Russ Cox | a933635 | 2011-12-08 21:48:19 -0500 | [diff] [blame] | 4039 | an untyped complex constant. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4040 | </p> |
| 4041 | |
| 4042 | <pre> |
Robert Griesemer | 462860b | 2012-12-12 14:25:40 -0800 | [diff] [blame] | 4043 | const ic = complex(0, c) // ic == 3.75i (untyped complex constant) |
Mihai Borobocea | 8183ed1 | 2013-12-30 13:29:56 -0800 | [diff] [blame] | 4044 | const iΘ = complex(0, Θ) // iΘ == 1i (type complex128) |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 4045 | </pre> |
| 4046 | |
| 4047 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4048 | Constant expressions are always evaluated exactly; intermediate values and the |
| 4049 | constants themselves may require precision significantly larger than supported |
| 4050 | by any predeclared type in the language. The following are legal declarations: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4051 | </p> |
| 4052 | |
| 4053 | <pre> |
Robert Griesemer | 462860b | 2012-12-12 14:25:40 -0800 | [diff] [blame] | 4054 | const Huge = 1 << 100 // Huge == 1267650600228229401496703205376 (untyped integer constant) |
| 4055 | const Four int8 = Huge >> 98 // Four == 4 (type int8) |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4056 | </pre> |
| 4057 | |
| 4058 | <p> |
Robert Griesemer | ddddd39 | 2012-10-19 10:12:09 -0700 | [diff] [blame] | 4059 | The divisor of a constant division or remainder operation must not be zero: |
| 4060 | </p> |
| 4061 | |
| 4062 | <pre> |
| 4063 | 3.14 / 0.0 // illegal: division by zero |
| 4064 | </pre> |
| 4065 | |
| 4066 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4067 | The values of <i>typed</i> constants must always be accurately representable as values |
| 4068 | of the constant type. The following constant expressions are illegal: |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 4069 | </p> |
| 4070 | |
| 4071 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4072 | uint(-1) // -1 cannot be represented as a uint |
| 4073 | int(3.14) // 3.14 cannot be represented as an int |
Robert Griesemer | 462860b | 2012-12-12 14:25:40 -0800 | [diff] [blame] | 4074 | int64(Huge) // 1267650600228229401496703205376 cannot be represented as an int64 |
| 4075 | Four * 300 // operand 300 cannot be represented as an int8 (type of Four) |
| 4076 | Four * 100 // product 400 cannot be represented as an int8 (type of Four) |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 4077 | </pre> |
| 4078 | |
| 4079 | <p> |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4080 | The mask used by the unary bitwise complement operator <code>^</code> matches |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4081 | 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] | 4082 | and -1 for signed and untyped constants. |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 4083 | </p> |
| 4084 | |
| 4085 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4086 | ^1 // untyped integer constant, equal to -2 |
Robert Griesemer | 462860b | 2012-12-12 14:25:40 -0800 | [diff] [blame] | 4087 | uint8(^1) // illegal: same as uint8(-2), -2 cannot be represented as a uint8 |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4088 | ^uint8(1) // typed uint8 constant, same as 0xFF ^ uint8(1) = uint8(0xFE) |
| 4089 | int8(^1) // same as int8(-2) |
| 4090 | ^int8(1) // same as -1 ^ int8(1) = -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 4091 | </pre> |
| 4092 | |
Ian Lance Taylor | 9126c65 | 2012-02-13 11:25:56 -0800 | [diff] [blame] | 4093 | <p> |
| 4094 | Implementation restriction: A compiler may use rounding while |
| 4095 | computing untyped floating-point or complex constant expressions; see |
| 4096 | the implementation restriction in the section |
| 4097 | on <a href="#Constants">constants</a>. This rounding may cause a |
| 4098 | floating-point constant expression to be invalid in an integer |
| 4099 | context, even if it would be integral when calculated using infinite |
Robert Griesemer | d8c6dac | 2015-06-23 14:17:59 -0700 | [diff] [blame] | 4100 | precision, and vice versa. |
Ian Lance Taylor | 9126c65 | 2012-02-13 11:25:56 -0800 | [diff] [blame] | 4101 | </p> |
| 4102 | |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4103 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4104 | <h3 id="Order_of_evaluation">Order of evaluation</h3> |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 4105 | |
| 4106 | <p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 4107 | At package level, <a href="#Package_initialization">initialization dependencies</a> |
Robert Griesemer | dbe5f88 | 2014-05-07 08:50:52 -0700 | [diff] [blame] | 4108 | determine the evaluation order of individual initialization expressions in |
| 4109 | <a href="#Variable_declarations">variable declarations</a>. |
| 4110 | Otherwise, when evaluating the <a href="#Operands">operands</a> of an |
| 4111 | expression, assignment, or |
Robert Griesemer | f05a91e | 2012-08-09 11:50:16 -0700 | [diff] [blame] | 4112 | <a href="#Return_statements">return statement</a>, |
| 4113 | all function calls, method calls, and |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 4114 | communication operations are evaluated in lexical left-to-right |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 4115 | order. |
| 4116 | </p> |
| 4117 | |
| 4118 | <p> |
Robert Griesemer | dbe5f88 | 2014-05-07 08:50:52 -0700 | [diff] [blame] | 4119 | For example, in the (function-local) assignment |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 4120 | </p> |
| 4121 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4122 | y[f()], ok = g(h(), i()+x[j()], <-c), k() |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 4123 | </pre> |
| 4124 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 4125 | the function calls and communication happen in the order |
| 4126 | <code>f()</code>, <code>h()</code>, <code>i()</code>, <code>j()</code>, |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4127 | <code><-c</code>, <code>g()</code>, and <code>k()</code>. |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 4128 | However, the order of those events compared to the evaluation |
| 4129 | and indexing of <code>x</code> and the evaluation |
| 4130 | of <code>y</code> is not specified. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 4131 | </p> |
| 4132 | |
Robert Griesemer | f05a91e | 2012-08-09 11:50:16 -0700 | [diff] [blame] | 4133 | <pre> |
| 4134 | a := 1 |
Shenghou Ma | bdac989 | 2013-06-11 02:52:07 +0800 | [diff] [blame] | 4135 | f := func() int { a++; return a } |
Robert Griesemer | dbe5f88 | 2014-05-07 08:50:52 -0700 | [diff] [blame] | 4136 | x := []int{a, f()} // x may be [1, 2] or [2, 2]: evaluation order between a and f() is not specified |
| 4137 | m := map[int]int{a: 1, a: 2} // m may be {2: 1} or {2: 2}: evaluation order between the two map assignments is not specified |
| 4138 | n := map[int]int{a: f()} // n may be {2: 3} or {3: 3}: evaluation order between the key and the value is not specified |
Robert Griesemer | f05a91e | 2012-08-09 11:50:16 -0700 | [diff] [blame] | 4139 | </pre> |
| 4140 | |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 4141 | <p> |
Robert Griesemer | dbe5f88 | 2014-05-07 08:50:52 -0700 | [diff] [blame] | 4142 | At package level, initialization dependencies override the left-to-right rule |
| 4143 | for individual initialization expressions, but not for operands within each |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 4144 | expression: |
Robert Griesemer | dbe5f88 | 2014-05-07 08:50:52 -0700 | [diff] [blame] | 4145 | </p> |
| 4146 | |
| 4147 | <pre> |
| 4148 | var a, b, c = f() + v(), g(), sqr(u()) + v() |
| 4149 | |
| 4150 | func f() int { return c } |
| 4151 | func g() int { return a } |
| 4152 | func sqr(x int) int { return x*x } |
| 4153 | |
| 4154 | // functions u and v are independent of all other variables and functions |
| 4155 | </pre> |
| 4156 | |
| 4157 | <p> |
| 4158 | The function calls happen in the order |
| 4159 | <code>u()</code>, <code>sqr()</code>, <code>v()</code>, |
| 4160 | <code>f()</code>, <code>v()</code>, and <code>g()</code>. |
| 4161 | </p> |
| 4162 | |
| 4163 | <p> |
Rob Pike | 4fe4192 | 2009-11-07 22:00:59 -0800 | [diff] [blame] | 4164 | Floating-point operations within a single expression are evaluated according to |
| 4165 | the associativity of the operators. Explicit parentheses affect the evaluation |
| 4166 | by overriding the default associativity. |
| 4167 | In the expression <code>x + (y + z)</code> the addition <code>y + z</code> |
| 4168 | is performed before adding <code>x</code>. |
| 4169 | </p> |
| 4170 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4171 | <h2 id="Statements">Statements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4172 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4173 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4174 | Statements control execution. |
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"> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 4178 | Statement = |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 4179 | Declaration | LabeledStmt | SimpleStmt | |
| 4180 | GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt | |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4181 | FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt | |
| 4182 | DeferStmt . |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 4183 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4184 | SimpleStmt = EmptyStmt | ExpressionStmt | SendStmt | IncDecStmt | Assignment | ShortVarDecl . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4185 | </pre> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 4186 | |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 4187 | <h3 id="Terminating_statements">Terminating statements</h3> |
| 4188 | |
| 4189 | <p> |
| 4190 | A terminating statement is one of the following: |
| 4191 | </p> |
| 4192 | |
| 4193 | <ol> |
| 4194 | <li> |
| 4195 | A <a href="#Return_statements">"return"</a> or |
| 4196 | <a href="#Goto_statements">"goto"</a> statement. |
| 4197 | <!-- ul below only for regular layout --> |
| 4198 | <ul> </ul> |
| 4199 | </li> |
| 4200 | |
| 4201 | <li> |
| 4202 | A call to the built-in function |
| 4203 | <a href="#Handling_panics"><code>panic</code></a>. |
| 4204 | <!-- ul below only for regular layout --> |
| 4205 | <ul> </ul> |
| 4206 | </li> |
| 4207 | |
| 4208 | <li> |
| 4209 | A <a href="#Blocks">block</a> in which the statement list ends in a terminating statement. |
| 4210 | <!-- ul below only for regular layout --> |
| 4211 | <ul> </ul> |
| 4212 | </li> |
| 4213 | |
| 4214 | <li> |
| 4215 | An <a href="#If_statements">"if" statement</a> in which: |
| 4216 | <ul> |
| 4217 | <li>the "else" branch is present, and</li> |
| 4218 | <li>both branches are terminating statements.</li> |
| 4219 | </ul> |
| 4220 | </li> |
| 4221 | |
| 4222 | <li> |
| 4223 | A <a href="#For_statements">"for" statement</a> in which: |
| 4224 | <ul> |
| 4225 | <li>there are no "break" statements referring to the "for" statement, and</li> |
| 4226 | <li>the loop condition is absent.</li> |
| 4227 | </ul> |
| 4228 | </li> |
| 4229 | |
| 4230 | <li> |
| 4231 | A <a href="#Switch_statements">"switch" statement</a> in which: |
| 4232 | <ul> |
| 4233 | <li>there are no "break" statements referring to the "switch" statement,</li> |
| 4234 | <li>there is a default case, and</li> |
| 4235 | <li>the statement lists in each case, including the default, end in a terminating |
| 4236 | statement, or a possibly labeled <a href="#Fallthrough_statements">"fallthrough" |
| 4237 | statement</a>.</li> |
| 4238 | </ul> |
| 4239 | </li> |
| 4240 | |
| 4241 | <li> |
| 4242 | A <a href="#Select_statements">"select" statement</a> in which: |
| 4243 | <ul> |
| 4244 | <li>there are no "break" statements referring to the "select" statement, and</li> |
| 4245 | <li>the statement lists in each case, including the default if present, |
| 4246 | end in a terminating statement.</li> |
| 4247 | </ul> |
| 4248 | </li> |
| 4249 | |
| 4250 | <li> |
| 4251 | A <a href="#Labeled_statements">labeled statement</a> labeling |
| 4252 | a terminating statement. |
| 4253 | </li> |
| 4254 | </ol> |
| 4255 | |
| 4256 | <p> |
| 4257 | All other statements are not terminating. |
| 4258 | </p> |
| 4259 | |
| 4260 | <p> |
| 4261 | A <a href="#Blocks">statement list</a> ends in a terminating statement if the list |
| 4262 | is not empty and its final statement is terminating. |
| 4263 | </p> |
| 4264 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4265 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4266 | <h3 id="Empty_statements">Empty statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4267 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4268 | <p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4269 | The empty statement does nothing. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4270 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4271 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4272 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4273 | EmptyStmt = . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4274 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4275 | |
| 4276 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4277 | <h3 id="Labeled_statements">Labeled statements</h3> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 4278 | |
| 4279 | <p> |
| 4280 | A labeled statement may be the target of a <code>goto</code>, |
| 4281 | <code>break</code> or <code>continue</code> statement. |
| 4282 | </p> |
| 4283 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4284 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4285 | LabeledStmt = Label ":" Statement . |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 4286 | Label = identifier . |
| 4287 | </pre> |
| 4288 | |
| 4289 | <pre> |
Robert Griesemer | 7fc4e37 | 2011-02-01 12:51:10 -0800 | [diff] [blame] | 4290 | Error: log.Panic("error encountered") |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 4291 | </pre> |
| 4292 | |
| 4293 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4294 | <h3 id="Expression_statements">Expression statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4295 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4296 | <p> |
Robert Griesemer | 8c058b3 | 2012-09-18 11:25:53 -0700 | [diff] [blame] | 4297 | With the exception of specific built-in functions, |
| 4298 | function and method <a href="#Calls">calls</a> and |
| 4299 | <a href="#Receive_operator">receive operations</a> |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 4300 | can appear in statement context. Such statements may be parenthesized. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4301 | </p> |
| 4302 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4303 | <pre class="ebnf"> |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 4304 | ExpressionStmt = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4305 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4306 | |
Robert Griesemer | 8c058b3 | 2012-09-18 11:25:53 -0700 | [diff] [blame] | 4307 | <p> |
| 4308 | The following built-in functions are not permitted in statement context: |
| 4309 | </p> |
| 4310 | |
| 4311 | <pre> |
| 4312 | append cap complex imag len make new real |
| 4313 | unsafe.Alignof unsafe.Offsetof unsafe.Sizeof |
| 4314 | </pre> |
| 4315 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4316 | <pre> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4317 | h(x+y) |
| 4318 | f.Close() |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4319 | <-ch |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 4320 | (<-ch) |
Robert Griesemer | 8c058b3 | 2012-09-18 11:25:53 -0700 | [diff] [blame] | 4321 | len("foo") // illegal if len is the built-in function |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4322 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4323 | |
| 4324 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4325 | <h3 id="Send_statements">Send statements</h3> |
| 4326 | |
| 4327 | <p> |
| 4328 | A send statement sends a value on a channel. |
Robert Griesemer | cc3f21c | 2012-12-03 14:23:41 -0800 | [diff] [blame] | 4329 | The channel expression must be of <a href="#Channel_types">channel type</a>, |
| 4330 | the channel direction must permit send operations, |
| 4331 | and the type of the value to be sent must be <a href="#Assignability">assignable</a> |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4332 | to the channel's element type. |
| 4333 | </p> |
| 4334 | |
| 4335 | <pre class="ebnf"> |
| 4336 | SendStmt = Channel "<-" Expression . |
| 4337 | Channel = Expression . |
| 4338 | </pre> |
| 4339 | |
| 4340 | <p> |
| 4341 | Both the channel and the value expression are evaluated before communication |
Russ Cox | e7a138b | 2012-02-08 15:24:48 -0500 | [diff] [blame] | 4342 | begins. Communication blocks until the send can proceed. |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4343 | A send on an unbuffered channel can proceed if a receiver is ready. |
| 4344 | A send on a buffered channel can proceed if there is room in the buffer. |
Russ Cox | e7a138b | 2012-02-08 15:24:48 -0500 | [diff] [blame] | 4345 | A send on a closed channel proceeds by causing a <a href="#Run_time_panics">run-time panic</a>. |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4346 | A send on a <code>nil</code> channel blocks forever. |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4347 | </p> |
| 4348 | |
| 4349 | <pre> |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 4350 | ch <- 3 // send value 3 to channel ch |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4351 | </pre> |
| 4352 | |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 4353 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4354 | <h3 id="IncDec_statements">IncDec statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4355 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4356 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 4357 | The "++" and "--" statements increment or decrement their operands |
Robert Griesemer | 19b1d35 | 2009-09-24 19:36:48 -0700 | [diff] [blame] | 4358 | by the untyped <a href="#Constants">constant</a> <code>1</code>. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4359 | As with an assignment, the operand must be <a href="#Address_operators">addressable</a> |
| 4360 | or a map index expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4361 | </p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 4362 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4363 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4364 | IncDecStmt = Expression ( "++" | "--" ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4365 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4366 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4367 | <p> |
Robert Griesemer | 506c008 | 2009-09-08 15:41:14 -0700 | [diff] [blame] | 4368 | The following <a href="#Assignments">assignment statements</a> are semantically |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 4369 | equivalent: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4370 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4371 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4372 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4373 | IncDec statement Assignment |
| 4374 | x++ x += 1 |
| 4375 | x-- x -= 1 |
| 4376 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4377 | |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4378 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4379 | <h3 id="Assignments">Assignments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4380 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4381 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4382 | Assignment = ExpressionList assign_op ExpressionList . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4383 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4384 | assign_op = [ add_op | mul_op ] "=" . |
| 4385 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4386 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4387 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4388 | Each left-hand side operand must be <a href="#Address_operators">addressable</a>, |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4389 | a map index expression, or (for <code>=</code> assignments only) the |
| 4390 | <a href="#Blank_identifier">blank identifier</a>. |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 4391 | Operands may be parenthesized. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4392 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4393 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4394 | <pre> |
| 4395 | x = 1 |
| 4396 | *p = f() |
| 4397 | a[i] = 23 |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 4398 | (k) = <-ch // same as: k = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4399 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4400 | |
| 4401 | <p> |
| 4402 | An <i>assignment operation</i> <code>x</code> <i>op</i><code>=</code> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 4403 | <code>y</code> where <i>op</i> is a binary arithmetic operation is equivalent |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4404 | to <code>x</code> <code>=</code> <code>x</code> <i>op</i> |
Robert Griesemer | 637d598 | 2015-06-11 13:21:46 -0700 | [diff] [blame] | 4405 | <code>(y)</code> but evaluates <code>x</code> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4406 | 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] | 4407 | In assignment operations, both the left- and right-hand expression lists |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4408 | must contain exactly one single-valued expression, and the left-hand |
| 4409 | expression must not be the blank identifier. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4410 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4411 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4412 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 4413 | a[i] <<= 2 |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4414 | i &^= 1<<n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4415 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4416 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4417 | <p> |
| 4418 | A tuple assignment assigns the individual elements of a multi-valued |
| 4419 | operation to a list of variables. There are two forms. In the |
| 4420 | first, the right hand operand is a single multi-valued expression |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 4421 | such as a function call, a <a href="#Channel_types">channel</a> or |
| 4422 | <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] | 4423 | The number of operands on the left |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 4424 | hand side must match the number of values. For instance, if |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4425 | <code>f</code> is a function returning two values, |
| 4426 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4427 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4428 | <pre> |
| 4429 | x, y = f() |
| 4430 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4431 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4432 | <p> |
| 4433 | assigns the first value to <code>x</code> and the second to <code>y</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4434 | 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] | 4435 | of expressions on the right, each of which must be single-valued, and the |
| 4436 | <i>n</i>th expression on the right is assigned to the <i>n</i>th |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4437 | operand on the left: |
Robert Griesemer | 2dde4f5 | 2012-05-24 10:59:48 -0700 | [diff] [blame] | 4438 | </p> |
| 4439 | |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4440 | <pre> |
| 4441 | one, two, three = '一', '二', '三' |
| 4442 | </pre> |
| 4443 | |
| 4444 | <p> |
| 4445 | The <a href="#Blank_identifier">blank identifier</a> provides a way to |
| 4446 | ignore right-hand side values in an assignment: |
| 4447 | </p> |
| 4448 | |
| 4449 | <pre> |
| 4450 | _ = x // evaluate x but ignore it |
| 4451 | x, _ = f() // evaluate f() but ignore second result value |
| 4452 | </pre> |
| 4453 | |
Robert Griesemer | 2dde4f5 | 2012-05-24 10:59:48 -0700 | [diff] [blame] | 4454 | <p> |
| 4455 | The assignment proceeds in two phases. |
Robert Griesemer | 9c9e811 | 2012-12-10 11:55:57 -0800 | [diff] [blame] | 4456 | First, the operands of <a href="#Index_expressions">index expressions</a> |
Russ Cox | fa53811 | 2011-10-13 15:44:17 -0400 | [diff] [blame] | 4457 | and <a href="#Address_operators">pointer indirections</a> |
| 4458 | (including implicit pointer indirections in <a href="#Selectors">selectors</a>) |
| 4459 | on the left and the expressions on the right are all |
| 4460 | <a href="#Order_of_evaluation">evaluated in the usual order</a>. |
| 4461 | Second, the assignments are carried out in left-to-right order. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4462 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4463 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4464 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4465 | a, b = b, a // exchange a and b |
Russ Cox | fa53811 | 2011-10-13 15:44:17 -0400 | [diff] [blame] | 4466 | |
| 4467 | x := []int{1, 2, 3} |
| 4468 | i := 0 |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4469 | i, x[i] = 1, 2 // set i = 1, x[0] = 2 |
Russ Cox | fa53811 | 2011-10-13 15:44:17 -0400 | [diff] [blame] | 4470 | |
| 4471 | i = 0 |
| 4472 | x[i], i = 2, 1 // set x[0] = 2, i = 1 |
| 4473 | |
Robert Griesemer | 2dde4f5 | 2012-05-24 10:59:48 -0700 | [diff] [blame] | 4474 | x[0], x[0] = 1, 2 // set x[0] = 1, then x[0] = 2 (so x[0] == 2 at end) |
Russ Cox | fa53811 | 2011-10-13 15:44:17 -0400 | [diff] [blame] | 4475 | |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 4476 | x[1], x[3] = 4, 5 // set x[1] = 4, then panic setting x[3] = 5. |
Russ Cox | fa53811 | 2011-10-13 15:44:17 -0400 | [diff] [blame] | 4477 | |
| 4478 | type Point struct { x, y int } |
| 4479 | var p *Point |
| 4480 | x[2], p.x = 6, 7 // set x[2] = 6, then panic setting p.x = 7 |
Robert Griesemer | 2dde4f5 | 2012-05-24 10:59:48 -0700 | [diff] [blame] | 4481 | |
| 4482 | i = 2 |
| 4483 | x = []int{3, 5, 7} |
| 4484 | for i, x[i] = range x { // set i, x[2] = 0, x[0] |
| 4485 | break |
| 4486 | } |
| 4487 | // after this loop, i == 0 and x == []int{3, 5, 3} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4488 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4489 | |
| 4490 | <p> |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4491 | In assignments, each value must be <a href="#Assignability">assignable</a> |
| 4492 | to the type of the operand to which it is assigned, with the following special cases: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4493 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4494 | |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4495 | <ol> |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 4496 | <li> |
| 4497 | Any typed value may be assigned to the blank identifier. |
| 4498 | </li> |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4499 | |
Robert Griesemer | 47094dc | 2014-09-30 11:44:29 -0700 | [diff] [blame] | 4500 | <li> |
| 4501 | If an untyped constant |
| 4502 | is assigned to a variable of interface type or the blank identifier, |
| 4503 | the constant is first <a href="#Conversions">converted</a> to its |
| 4504 | <a href="#Constants">default type</a>. |
| 4505 | </li> |
| 4506 | |
| 4507 | <li> |
| 4508 | If an untyped boolean value is assigned to a variable of interface type or |
| 4509 | the blank identifier, it is first converted to type <code>bool</code>. |
| 4510 | </li> |
Robert Griesemer | f57bf7a | 2013-11-12 21:06:54 -0500 | [diff] [blame] | 4511 | </ol> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4512 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4513 | <h3 id="If_statements">If statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4514 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4515 | <p> |
| 4516 | "If" statements specify the conditional execution of two branches |
| 4517 | according to the value of a boolean expression. If the expression |
| 4518 | evaluates to true, the "if" branch is executed, otherwise, if |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 4519 | present, the "else" branch is executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4520 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4521 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4522 | <pre class="ebnf"> |
Russ Cox | 58e19aa | 2011-07-14 17:15:52 -0400 | [diff] [blame] | 4523 | IfStmt = "if" [ SimpleStmt ";" ] Expression Block [ "else" ( IfStmt | Block ) ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4524 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4525 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4526 | <pre> |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 4527 | if x > max { |
| 4528 | x = max |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4529 | } |
| 4530 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4531 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4532 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4533 | The expression may be preceded by a simple statement, which |
| 4534 | executes before the expression is evaluated. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4535 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4536 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4537 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4538 | if x := f(); x < y { |
| 4539 | return x |
Robert Griesemer | a1368a6 | 2011-02-22 15:31:57 -0800 | [diff] [blame] | 4540 | } else if x > z { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4541 | return z |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4542 | } else { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4543 | return y |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4544 | } |
| 4545 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4546 | |
| 4547 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4548 | <h3 id="Switch_statements">Switch statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4549 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4550 | <p> |
| 4551 | "Switch" statements provide multi-way execution. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4552 | An expression or type specifier is compared to the "cases" |
| 4553 | inside the "switch" to determine which branch |
| 4554 | to execute. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 4555 | </p> |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 4556 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4557 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4558 | SwitchStmt = ExprSwitchStmt | TypeSwitchStmt . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 4559 | </pre> |
| 4560 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 4561 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4562 | There are two forms: expression switches and type switches. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4563 | In an expression switch, the cases contain expressions that are compared |
| 4564 | against the value of the switch expression. |
| 4565 | In a type switch, the cases contain types that are compared against the |
| 4566 | type of a specially annotated switch expression. |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 4567 | The switch expression is evaluated exactly once in a switch statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4568 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4569 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4570 | <h4 id="Expression_switches">Expression switches</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4571 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4572 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4573 | In an expression switch, |
| 4574 | the switch expression is evaluated and |
| 4575 | the case expressions, which need not be constants, |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 4576 | 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] | 4577 | switch expression |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4578 | triggers execution of the statements of the associated case; |
| 4579 | the other cases are skipped. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4580 | If no case matches and there is a "default" case, |
| 4581 | its statements are executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4582 | There can be at most one default case and it may appear anywhere in the |
| 4583 | "switch" statement. |
Robert Griesemer | ab26623 | 2014-02-25 09:13:37 -0800 | [diff] [blame] | 4584 | A missing switch expression is equivalent to the boolean value |
| 4585 | <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4586 | </p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4587 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4588 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 4589 | ExprSwitchStmt = "switch" [ SimpleStmt ";" ] [ Expression ] "{" { ExprCaseClause } "}" . |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 4590 | ExprCaseClause = ExprSwitchCase ":" StatementList . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 4591 | ExprSwitchCase = "case" ExpressionList | "default" . |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4592 | </pre> |
| 4593 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4594 | <p> |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 4595 | If the switch expression evaluates to an untyped constant, it is first |
| 4596 | <a href="#Conversions">converted</a> to its <a href="#Constants">default type</a>; |
| 4597 | if it is an untyped boolean value, it is first converted to type <code>bool</code>. |
| 4598 | The predeclared untyped value <code>nil</code> cannot be used as a switch expression. |
| 4599 | </p> |
| 4600 | |
| 4601 | <p> |
| 4602 | If a case expression is untyped, it is first <a href="#Conversions">converted</a> |
| 4603 | to the type of the switch expression. |
| 4604 | For each (possibly converted) case expression <code>x</code> and the value <code>t</code> |
| 4605 | of the switch expression, <code>x == t</code> must be a valid <a href="#Comparison_operators">comparison</a>. |
| 4606 | </p> |
| 4607 | |
| 4608 | <p> |
| 4609 | In other words, the switch expression is treated as if it were used to declare and |
| 4610 | initialize a temporary variable <code>t</code> without explicit type; it is that |
| 4611 | value of <code>t</code> against which each case expression <code>x</code> is tested |
| 4612 | for equality. |
| 4613 | </p> |
| 4614 | |
| 4615 | <p> |
Robert Griesemer | 67a6b4f | 2013-03-01 16:45:14 -0800 | [diff] [blame] | 4616 | In a case or default clause, the last non-empty statement |
| 4617 | may be a (possibly <a href="#Labeled_statements">labeled</a>) |
| 4618 | <a href="#Fallthrough_statements">"fallthrough" statement</a> to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4619 | indicate that control should flow from the end of this clause to |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 4620 | the first statement of the next clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4621 | Otherwise control flows to the end of the "switch" statement. |
Robert Griesemer | 67a6b4f | 2013-03-01 16:45:14 -0800 | [diff] [blame] | 4622 | A "fallthrough" statement may appear as the last statement of all |
| 4623 | but the last clause of an expression switch. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4624 | </p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4625 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4626 | <p> |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 4627 | The switch expression may be preceded by a simple statement, which |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4628 | executes before the expression is evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4629 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4630 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4631 | <pre> |
| 4632 | switch tag { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 4633 | default: s3() |
| 4634 | case 0, 1, 2, 3: s1() |
| 4635 | case 4, 5, 6, 7: s2() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4636 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4637 | |
Andrew Gerrand | 10b77f7 | 2010-03-29 13:12:08 +1100 | [diff] [blame] | 4638 | switch x := f(); { // missing switch expression means "true" |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 4639 | case x < 0: return -x |
| 4640 | default: return x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4641 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4642 | |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 4643 | switch { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4644 | case x < y: f1() |
| 4645 | case x < z: f2() |
| 4646 | case x == 4: f3() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4647 | } |
| 4648 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4649 | |
Robert Griesemer | 2d9378c | 2015-07-27 13:30:16 -0700 | [diff] [blame] | 4650 | <p> |
| 4651 | Implementation restriction: A compiler may disallow multiple case |
| 4652 | expressions evaluating to the same constant. |
| 4653 | For instance, the current compilers disallow duplicate integer, |
| 4654 | floating point, or string constants in case expressions. |
| 4655 | </p> |
| 4656 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4657 | <h4 id="Type_switches">Type switches</h4> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4658 | |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4659 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4660 | A type switch compares types rather than values. It is otherwise similar |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 4661 | 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] | 4662 | has the form of a <a href="#Type_assertions">type assertion</a> |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4663 | using the reserved word <code>type</code> rather than an actual type: |
| 4664 | </p> |
| 4665 | |
| 4666 | <pre> |
| 4667 | switch x.(type) { |
| 4668 | // cases |
| 4669 | } |
| 4670 | </pre> |
| 4671 | |
| 4672 | <p> |
| 4673 | Cases then match actual types <code>T</code> against the dynamic type of the |
| 4674 | expression <code>x</code>. As with type assertions, <code>x</code> must be of |
| 4675 | <a href="#Interface_types">interface type</a>, and each non-interface type |
| 4676 | <code>T</code> listed in a case must implement the type of <code>x</code>. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4677 | </p> |
| 4678 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4679 | <pre class="ebnf"> |
Rob Pike | f3a33bc | 2009-09-14 17:39:17 -0700 | [diff] [blame] | 4680 | TypeSwitchStmt = "switch" [ SimpleStmt ";" ] TypeSwitchGuard "{" { TypeCaseClause } "}" . |
Russ Cox | c1045db | 2009-12-23 13:48:44 -0800 | [diff] [blame] | 4681 | TypeSwitchGuard = [ identifier ":=" ] PrimaryExpr "." "(" "type" ")" . |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 4682 | TypeCaseClause = TypeSwitchCase ":" StatementList . |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4683 | TypeSwitchCase = "case" TypeList | "default" . |
| 4684 | TypeList = Type { "," Type } . |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4685 | </pre> |
| 4686 | |
| 4687 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4688 | The TypeSwitchGuard may include a |
| 4689 | <a href="#Short_variable_declarations">short variable declaration</a>. |
Rob Pike | 818e3cd | 2012-02-22 16:25:55 +1100 | [diff] [blame] | 4690 | When that form is used, the variable is declared at the beginning of |
| 4691 | the <a href="#Blocks">implicit block</a> in each clause. |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4692 | In clauses with a case listing exactly one type, the variable |
| 4693 | has that type; otherwise, the variable has the type of the expression |
| 4694 | in the TypeSwitchGuard. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4695 | </p> |
| 4696 | |
| 4697 | <p> |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 4698 | The type in a case may be <a href="#Predeclared_identifiers"><code>nil</code></a>; |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4699 | that case is used when the expression in the TypeSwitchGuard |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 4700 | is a <code>nil</code> interface value. |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4701 | </p> |
| 4702 | |
| 4703 | <p> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 4704 | Given an expression <code>x</code> of type <code>interface{}</code>, |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4705 | the following type switch: |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4706 | </p> |
| 4707 | |
| 4708 | <pre> |
Robert Griesemer | e919275 | 2009-12-01 16:15:53 -0800 | [diff] [blame] | 4709 | switch i := x.(type) { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4710 | case nil: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4711 | printString("x is nil") // type of i is type of x (interface{}) |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4712 | case int: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4713 | printInt(i) // type of i is int |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4714 | case float64: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4715 | printFloat64(i) // type of i is float64 |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 4716 | case func(int) float64: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4717 | printFunction(i) // type of i is func(int) float64 |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4718 | case bool, string: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4719 | printString("type is bool or string") // type of i is type of x (interface{}) |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4720 | default: |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4721 | printString("don't know the type") // type of i is type of x (interface{}) |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 4722 | } |
| 4723 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4724 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4725 | <p> |
| 4726 | could be rewritten: |
| 4727 | </p> |
| 4728 | |
| 4729 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4730 | v := x // x is evaluated exactly once |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4731 | if v == nil { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4732 | i := v // type of i is type of x (interface{}) |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4733 | printString("x is nil") |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 4734 | } else if i, isInt := v.(int); isInt { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4735 | printInt(i) // type of i is int |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 4736 | } else if i, isFloat64 := v.(float64); isFloat64 { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4737 | printFloat64(i) // type of i is float64 |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 4738 | } else if i, isFunc := v.(func(int) float64); isFunc { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4739 | printFunction(i) // type of i is func(int) float64 |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4740 | } else { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4741 | _, isBool := v.(bool) |
| 4742 | _, isString := v.(string) |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 4743 | if isBool || isString { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4744 | i := v // type of i is type of x (interface{}) |
| 4745 | printString("type is bool or string") |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4746 | } else { |
Robert Griesemer | 4856731 | 2012-12-06 09:17:20 -0800 | [diff] [blame] | 4747 | i := v // type of i is type of x (interface{}) |
| 4748 | printString("don't know the type") |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4749 | } |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 4750 | } |
| 4751 | </pre> |
| 4752 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 4753 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4754 | The type switch guard may be preceded by a simple statement, which |
| 4755 | executes before the guard is evaluated. |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 4756 | </p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 4757 | |
| 4758 | <p> |
| 4759 | The "fallthrough" statement is not permitted in a type switch. |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4760 | </p> |
| 4761 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4762 | <h3 id="For_statements">For statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4763 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4764 | <p> |
| 4765 | A "for" statement specifies repeated execution of a block. The iteration is |
| 4766 | controlled by a condition, a "for" clause, or a "range" clause. |
| 4767 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4768 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4769 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4770 | ForStmt = "for" [ Condition | ForClause | RangeClause ] Block . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4771 | Condition = Expression . |
| 4772 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4773 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4774 | <p> |
| 4775 | In its simplest form, a "for" statement specifies the repeated execution of |
| 4776 | a block as long as a boolean condition evaluates to true. |
| 4777 | The condition is evaluated before each iteration. |
Robert Griesemer | ab26623 | 2014-02-25 09:13:37 -0800 | [diff] [blame] | 4778 | If the condition is absent, it is equivalent to the boolean value |
| 4779 | <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4780 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4781 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4782 | <pre> |
| 4783 | for a < b { |
| 4784 | a *= 2 |
| 4785 | } |
| 4786 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4787 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4788 | <p> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4789 | 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] | 4790 | additionally it may specify an <i>init</i> |
| 4791 | and a <i>post</i> statement, such as an assignment, |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4792 | an increment or decrement statement. The init statement may be a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 4793 | <a href="#Short_variable_declarations">short variable declaration</a>, but the post statement must not. |
Robert Griesemer | 2fa3e43f | 2014-09-25 12:52:05 -0700 | [diff] [blame] | 4794 | Variables declared by the init statement are re-used in each iteration. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4795 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4796 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4797 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4798 | ForClause = [ InitStmt ] ";" [ Condition ] ";" [ PostStmt ] . |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4799 | InitStmt = SimpleStmt . |
| 4800 | PostStmt = SimpleStmt . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4801 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4802 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4803 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4804 | for i := 0; i < 10; i++ { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4805 | f(i) |
| 4806 | } |
| 4807 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4808 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4809 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4810 | If non-empty, the init statement is executed once before evaluating the |
| 4811 | condition for the first iteration; |
| 4812 | the post statement is executed after each execution of the block (and |
| 4813 | only if the block was executed). |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4814 | Any element of the ForClause may be empty but the |
| 4815 | <a href="#Semicolons">semicolons</a> are |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4816 | required unless there is only a condition. |
Robert Griesemer | ab26623 | 2014-02-25 09:13:37 -0800 | [diff] [blame] | 4817 | If the condition is absent, it is equivalent to the boolean value |
| 4818 | <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4819 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4820 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4821 | <pre> |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4822 | for cond { S() } is the same as for ; cond ; { S() } |
| 4823 | for { S() } is the same as for true { S() } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4824 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4825 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4826 | <p> |
| 4827 | A "for" statement with a "range" clause |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4828 | iterates through all entries of an array, slice, string or map, |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4829 | or values received on a channel. For each entry it assigns <i>iteration values</i> |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4830 | to corresponding <i>iteration variables</i> if present and then executes the block. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4831 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4832 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4833 | <pre class="ebnf"> |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4834 | RangeClause = [ ExpressionList "=" | IdentifierList ":=" ] "range" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4835 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4836 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4837 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4838 | The expression on the right in the "range" clause is called the <i>range expression</i>, |
Robert Griesemer | cc3f21c | 2012-12-03 14:23:41 -0800 | [diff] [blame] | 4839 | which may be an array, pointer to an array, slice, string, map, or channel permitting |
| 4840 | <a href="#Receive_operator">receive operations</a>. |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4841 | As with an assignment, if present the operands on the left must be |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4842 | <a href="#Address_operators">addressable</a> or map index expressions; they |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4843 | denote the iteration variables. If the range expression is a channel, at most |
| 4844 | one iteration variable is permitted, otherwise there may be up to two. |
| 4845 | If the last iteration variable is the <a href="#Blank_identifier">blank identifier</a>, |
| 4846 | the range clause is equivalent to the same clause without that identifier. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4847 | </p> |
Rob Pike | 29d0f02 | 2011-01-05 11:39:57 -0800 | [diff] [blame] | 4848 | |
| 4849 | <p> |
Russ Cox | 61e02ee | 2013-02-15 14:39:28 -0500 | [diff] [blame] | 4850 | The range expression is evaluated once before beginning the loop, |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4851 | with one exception: if the range expression is an array or a pointer to an array |
| 4852 | and at most one iteration variable is present, only the range expression's |
| 4853 | length is evaluated; if that length is constant, |
| 4854 | <a href="#Length_and_capacity">by definition</a> |
Russ Cox | 61e02ee | 2013-02-15 14:39:28 -0500 | [diff] [blame] | 4855 | the range expression itself will not be evaluated. |
| 4856 | </p> |
| 4857 | |
| 4858 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4859 | Function calls on the left are evaluated once per iteration. |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4860 | For each iteration, iteration values are produced as follows |
| 4861 | if the respective iteration variables are present: |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4862 | </p> |
| 4863 | |
| 4864 | <pre class="grammar"> |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4865 | Range expression 1st value 2nd value |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4866 | |
| 4867 | array or slice a [n]E, *[n]E, or []E index i int a[i] E |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 4868 | string s string type index i int see below rune |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4869 | map m map[K]V key k K m[k] V |
Shenghou Ma | ced5715 | 2013-01-17 23:11:25 +0800 | [diff] [blame] | 4870 | channel c chan E, <-chan E element e E |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4871 | </pre> |
| 4872 | |
| 4873 | <ol> |
| 4874 | <li> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4875 | For an array, pointer to array, or slice value <code>a</code>, the index iteration |
Russ Cox | 61e02ee | 2013-02-15 14:39:28 -0500 | [diff] [blame] | 4876 | values are produced in increasing order, starting at element index 0. |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4877 | If at most one iteration variable is present, the range loop produces |
Robert Griesemer | bb3a32e | 2013-05-20 13:27:53 -0700 | [diff] [blame] | 4878 | iteration values from 0 up to <code>len(a)-1</code> and does not index into the array |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4879 | 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] | 4880 | </li> |
| 4881 | |
| 4882 | <li> |
| 4883 | For a string value, the "range" clause iterates over the Unicode code points |
| 4884 | in the string starting at byte index 0. On successive iterations, the index value will be the |
| 4885 | index of the first byte of successive UTF-8-encoded code points in the string, |
Robert Griesemer | b910a27 | 2011-11-01 01:09:22 -0400 | [diff] [blame] | 4886 | and the second value, of type <code>rune</code>, will be the value of |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4887 | the corresponding code point. If the iteration encounters an invalid |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4888 | UTF-8 sequence, the second value will be <code>0xFFFD</code>, |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4889 | the Unicode replacement character, and the next iteration will advance |
| 4890 | a single byte in the string. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4891 | </li> |
| 4892 | |
| 4893 | <li> |
Russ Cox | e40d6e0 | 2011-10-17 18:49:02 -0400 | [diff] [blame] | 4894 | The iteration order over maps is not specified |
| 4895 | and is not guaranteed to be the same from one iteration to the next. |
Shenghou Ma | ced5715 | 2013-01-17 23:11:25 +0800 | [diff] [blame] | 4896 | If map entries that have not yet been reached are removed during iteration, |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4897 | the corresponding iteration values will not be produced. If map entries are |
Shenghou Ma | ced5715 | 2013-01-17 23:11:25 +0800 | [diff] [blame] | 4898 | created during iteration, that entry may be produced during the iteration or |
| 4899 | may be skipped. The choice may vary for each entry created and from one |
| 4900 | iteration to the next. |
| 4901 | If the map is <code>nil</code>, the number of iterations is 0. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4902 | </li> |
| 4903 | |
| 4904 | <li> |
| 4905 | For channels, the iteration values produced are the successive values sent on |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4906 | the channel until the channel is <a href="#Close">closed</a>. If the channel |
| 4907 | is <code>nil</code>, the range expression blocks forever. |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4908 | </li> |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 4909 | </ol> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4910 | |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 4911 | <p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4912 | The iteration values are assigned to the respective |
| 4913 | iteration variables as in an <a href="#Assignments">assignment statement</a>. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4914 | </p> |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4915 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4916 | <p> |
Robert Griesemer | da63371 | 2012-02-29 09:06:05 -0800 | [diff] [blame] | 4917 | The iteration variables may be declared by the "range" clause using a form of |
Robert Griesemer | 2c9e163 | 2012-02-28 17:44:24 -0800 | [diff] [blame] | 4918 | <a href="#Short_variable_declarations">short variable declaration</a> |
| 4919 | (<code>:=</code>). |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4920 | In this case their types are set to the types of the respective iteration values |
Robert Griesemer | 2fa3e43f | 2014-09-25 12:52:05 -0700 | [diff] [blame] | 4921 | and their <a href="#Declarations_and_scope">scope</a> is the block of the "for" |
Robert Griesemer | 5474e16 | 2010-09-28 14:44:19 -0700 | [diff] [blame] | 4922 | statement; they are re-used in each iteration. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4923 | If the iteration variables are declared outside the "for" statement, |
| 4924 | after execution their values will be those of the last iteration. |
| 4925 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 4926 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4927 | <pre> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4928 | var testdata *struct { |
| 4929 | a *[7]int |
| 4930 | } |
| 4931 | for i, _ := range testdata.a { |
| 4932 | // testdata.a is never evaluated; len(testdata.a) is constant |
| 4933 | // i ranges from 0 to 6 |
| 4934 | f(i) |
| 4935 | } |
| 4936 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4937 | var a [10]string |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4938 | for i, s := range a { |
| 4939 | // type of i is int |
| 4940 | // type of s is string |
| 4941 | // s == a[i] |
| 4942 | g(i, s) |
| 4943 | } |
| 4944 | |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 4945 | var key string |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 4946 | var val interface {} // value type of m is assignable to val |
Robert Griesemer | 63f54ae | 2013-07-11 14:41:46 -0700 | [diff] [blame] | 4947 | m := map[string]int{"mon":0, "tue":1, "wed":2, "thu":3, "fri":4, "sat":5, "sun":6} |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 4948 | for key, val = range m { |
| 4949 | h(key, val) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4950 | } |
| 4951 | // key == last map key encountered in iteration |
| 4952 | // val == map[key] |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 4953 | |
| 4954 | var ch chan Work = producer() |
| 4955 | for w := range ch { |
| 4956 | doWork(w) |
| 4957 | } |
Robert Griesemer | 20ae6d9 | 2014-07-14 15:08:09 -0700 | [diff] [blame] | 4958 | |
| 4959 | // empty a channel |
| 4960 | for range ch {} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4961 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4962 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4963 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4964 | <h3 id="Go_statements">Go statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4965 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4966 | <p> |
Robert Griesemer | 25dd002 | 2012-11-29 11:46:25 -0800 | [diff] [blame] | 4967 | A "go" statement starts the execution of a function call |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4968 | as an independent concurrent thread of control, or <i>goroutine</i>, |
| 4969 | within the same address space. |
| 4970 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4971 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4972 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 4973 | GoStmt = "go" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4974 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4975 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4976 | <p> |
Robert Griesemer | 25dd002 | 2012-11-29 11:46:25 -0800 | [diff] [blame] | 4977 | The expression must be a function or method call; it cannot be parenthesized. |
| 4978 | Calls of built-in functions are restricted as for |
| 4979 | <a href="#Expression_statements">expression statements</a>. |
| 4980 | </p> |
| 4981 | |
| 4982 | <p> |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 4983 | The function value and parameters are |
| 4984 | <a href="#Calls">evaluated as usual</a> |
| 4985 | in the calling goroutine, but |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4986 | unlike with a regular call, program execution does not wait |
Robert Griesemer | b9f8b9c | 2008-09-26 13:38:38 -0700 | [diff] [blame] | 4987 | for the invoked function to complete. |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 4988 | Instead, the function begins executing independently |
| 4989 | in a new goroutine. |
| 4990 | When the function terminates, its goroutine also terminates. |
| 4991 | If the function has any return values, they are discarded when the |
| 4992 | function completes. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4993 | </p> |
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 | <pre> |
| 4996 | go Server() |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 4997 | go func(ch chan<- bool) { for { sleep(10); ch <- true; }} (c) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4998 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4999 | |
| 5000 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5001 | <h3 id="Select_statements">Select statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5002 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5003 | <p> |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 5004 | A "select" statement chooses which of a set of possible |
| 5005 | <a href="#Send_statements">send</a> or |
| 5006 | <a href="#Receive_operator">receive</a> |
| 5007 | operations will proceed. |
| 5008 | It looks similar to a |
| 5009 | <a href="#Switch_statements">"switch"</a> statement but with the |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5010 | cases all referring to communication operations. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5011 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5012 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5013 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 5014 | SelectStmt = "select" "{" { CommClause } "}" . |
Robert Griesemer | 9905cec | 2013-03-04 13:55:35 -0800 | [diff] [blame] | 5015 | CommClause = CommCase ":" StatementList . |
Robert Griesemer | b50ed02 | 2011-02-01 12:02:49 -0800 | [diff] [blame] | 5016 | CommCase = "case" ( SendStmt | RecvStmt ) | "default" . |
Robert Griesemer | d367972 | 2013-01-18 13:59:25 -0800 | [diff] [blame] | 5017 | RecvStmt = [ ExpressionList "=" | IdentifierList ":=" ] RecvExpr . |
Robert Griesemer | c134718 | 2011-04-29 12:20:31 -0700 | [diff] [blame] | 5018 | RecvExpr = Expression . |
Russ Cox | 6143918 | 2011-01-31 17:42:10 -0500 | [diff] [blame] | 5019 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5020 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5021 | <p> |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 5022 | A case with a RecvStmt may assign the result of a RecvExpr to one or |
| 5023 | two variables, which may be declared using a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 5024 | <a href="#Short_variable_declarations">short variable declaration</a>. |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 5025 | The RecvExpr must be a (possibly parenthesized) receive operation. |
| 5026 | There can be at most one default case and it may appear anywhere |
| 5027 | in the list of cases. |
| 5028 | </p> |
| 5029 | |
| 5030 | <p> |
| 5031 | Execution of a "select" statement proceeds in several steps: |
| 5032 | </p> |
| 5033 | |
| 5034 | <ol> |
| 5035 | <li> |
| 5036 | For all the cases in the statement, the channel operands of receive operations |
| 5037 | and the channel and right-hand-side expressions of send statements are |
| 5038 | evaluated exactly once, in source order, upon entering the "select" statement. |
| 5039 | The result is a set of channels to receive from or send to, |
| 5040 | and the corresponding values to send. |
| 5041 | Any side effects in that evaluation will occur irrespective of which (if any) |
| 5042 | communication operation is selected to proceed. |
| 5043 | Expressions on the left-hand side of a RecvStmt with a short variable declaration |
| 5044 | or assignment are not yet evaluated. |
| 5045 | </li> |
| 5046 | |
| 5047 | <li> |
| 5048 | If one or more of the communications can proceed, |
| 5049 | a single one that can proceed is chosen via a uniform pseudo-random selection. |
| 5050 | Otherwise, if there is a default case, that case is chosen. |
| 5051 | If there is no default case, the "select" statement blocks until |
| 5052 | at least one of the communications can proceed. |
| 5053 | </li> |
| 5054 | |
| 5055 | <li> |
| 5056 | Unless the selected case is the default case, the respective communication |
| 5057 | operation is executed. |
| 5058 | </li> |
| 5059 | |
| 5060 | <li> |
| 5061 | If the selected case is a RecvStmt with a short variable declaration or |
| 5062 | an assignment, the left-hand side expressions are evaluated and the |
| 5063 | received value (or values) are assigned. |
| 5064 | </li> |
| 5065 | |
| 5066 | <li> |
| 5067 | The statement list of the selected case is executed. |
| 5068 | </li> |
| 5069 | </ol> |
| 5070 | |
| 5071 | <p> |
| 5072 | Since communication on <code>nil</code> channels can never proceed, |
| 5073 | a select with only <code>nil</code> channels and no default case blocks forever. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5074 | </p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 5075 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5076 | <pre> |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 5077 | var a []int |
| 5078 | var c, c1, c2, c3, c4 chan int |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5079 | var i1, i2 int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5080 | select { |
| 5081 | case i1 = <-c1: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5082 | print("received ", i1, " from c1\n") |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5083 | case c2 <- i2: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5084 | print("sent ", i2, " to c2\n") |
Robert Griesemer | 6af887e | 2011-05-02 09:16:31 -0700 | [diff] [blame] | 5085 | case i3, ok := (<-c3): // same as: i3, ok := <-c3 |
Russ Cox | 19d9a40 | 2011-01-27 15:34:28 -0500 | [diff] [blame] | 5086 | if ok { |
| 5087 | print("received ", i3, " from c3\n") |
| 5088 | } else { |
| 5089 | print("c3 is closed\n") |
| 5090 | } |
Robert Griesemer | 61d8a33 | 2014-05-14 11:47:19 -0700 | [diff] [blame] | 5091 | case a[f()] = <-c4: |
| 5092 | // same as: |
| 5093 | // case t := <-c4 |
| 5094 | // a[f()] = t |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5095 | default: |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5096 | print("no communication\n") |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5097 | } |
| 5098 | |
| 5099 | for { // send random sequence of bits to c |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5100 | select { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5101 | case c <- 0: // note: no statement, no fallthrough, no folding of cases |
| 5102 | case c <- 1: |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5103 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5104 | } |
Rob Pike | 041d116 | 2010-07-13 16:23:54 -0700 | [diff] [blame] | 5105 | |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 5106 | select {} // block forever |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5107 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5108 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5109 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5110 | <h3 id="Return_statements">Return statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5111 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5112 | <p> |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5113 | A "return" statement in a function <code>F</code> terminates the execution |
| 5114 | of <code>F</code>, and optionally provides one or more result values. |
| 5115 | Any functions <a href="#Defer_statements">deferred</a> by <code>F</code> |
| 5116 | are executed before <code>F</code> returns to its caller. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5117 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5118 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5119 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 5120 | ReturnStmt = "return" [ ExpressionList ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5121 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5122 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5123 | <p> |
| 5124 | In a function without a result type, a "return" statement must not |
| 5125 | specify any result values. |
| 5126 | </p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5127 | <pre> |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 5128 | func noResult() { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5129 | return |
| 5130 | } |
| 5131 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5132 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5133 | <p> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5134 | There are three ways to return values from a function with a result |
| 5135 | type: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5136 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5137 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5138 | <ol> |
| 5139 | <li>The return value or values may be explicitly listed |
| 5140 | in the "return" statement. Each expression must be single-valued |
Robert Griesemer | 440cc95 | 2010-06-07 17:40:21 -0700 | [diff] [blame] | 5141 | and <a href="#Assignability">assignable</a> |
| 5142 | to the corresponding element of the function's result type. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5143 | <pre> |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 5144 | func simpleF() int { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5145 | return 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5146 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5147 | |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 5148 | func complexF1() (re float64, im float64) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5149 | return -7.0, -4.0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5150 | } |
| 5151 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5152 | </li> |
| 5153 | <li>The expression list in the "return" statement may be a single |
| 5154 | call to a multi-valued function. The effect is as if each value |
| 5155 | returned from that function were assigned to a temporary |
| 5156 | variable with the type of the respective value, followed by a |
| 5157 | "return" statement listing these variables, at which point the |
| 5158 | rules of the previous case apply. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5159 | <pre> |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 5160 | func complexF2() (re float64, im float64) { |
| 5161 | return complexF1() |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5162 | } |
| 5163 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5164 | </li> |
Peter Mundy | 5928e1d | 2010-11-09 10:10:57 -0800 | [diff] [blame] | 5165 | <li>The expression list may be empty if the function's result |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5166 | type specifies names for its <a href="#Function_types">result parameters</a>. |
Rob Pike | db8c2b18 | 2010-06-11 21:30:03 -0700 | [diff] [blame] | 5167 | The result parameters act as ordinary local variables |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5168 | and the function may assign values to them as necessary. |
| 5169 | The "return" statement returns the values of these variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5170 | <pre> |
Russ Cox | 9c08d65 | 2012-02-21 22:04:30 -0500 | [diff] [blame] | 5171 | func complexF3() (re float64, im float64) { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5172 | re = 7.0 |
| 5173 | im = 4.0 |
| 5174 | return |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5175 | } |
Robert Griesemer | fb64e0d | 2011-03-07 16:29:07 -0800 | [diff] [blame] | 5176 | |
Russ Cox | d9877e2 | 2011-11-01 21:45:02 -0400 | [diff] [blame] | 5177 | func (devnull) Write(p []byte) (n int, _ error) { |
Robert Griesemer | fb64e0d | 2011-03-07 16:29:07 -0800 | [diff] [blame] | 5178 | n = len(p) |
| 5179 | return |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 5180 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5181 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 5182 | </li> |
| 5183 | </ol> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5184 | |
Rob Pike | db8c2b18 | 2010-06-11 21:30:03 -0700 | [diff] [blame] | 5185 | <p> |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5186 | Regardless of how they are declared, all the result values are initialized to |
| 5187 | the <a href="#The_zero_value">zero values</a> for their type upon entry to the |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5188 | function. A "return" statement that specifies results sets the result parameters before |
| 5189 | any deferred functions are executed. |
Rob Pike | db8c2b18 | 2010-06-11 21:30:03 -0700 | [diff] [blame] | 5190 | </p> |
| 5191 | |
Robert Griesemer | c97778f | 2014-03-05 11:59:53 -0800 | [diff] [blame] | 5192 | <p> |
| 5193 | Implementation restriction: A compiler may disallow an empty expression list |
| 5194 | in a "return" statement if a different entity (constant, type, or variable) |
| 5195 | with the same name as a result parameter is in |
| 5196 | <a href="#Declarations_and_scope">scope</a> at the place of the return. |
| 5197 | </p> |
| 5198 | |
| 5199 | <pre> |
| 5200 | func f(n int) (res int, err error) { |
| 5201 | if _, err := f(n-1); err != nil { |
| 5202 | return // invalid return statement: err is shadowed |
| 5203 | } |
| 5204 | return |
| 5205 | } |
| 5206 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 5207 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5208 | <h3 id="Break_statements">Break statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5209 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5210 | <p> |
| 5211 | A "break" statement terminates execution of the innermost |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5212 | <a href="#For_statements">"for"</a>, |
| 5213 | <a href="#Switch_statements">"switch"</a>, or |
Robert Griesemer | 94849d5 | 2014-05-28 08:43:47 -0700 | [diff] [blame] | 5214 | <a href="#Select_statements">"select"</a> statement |
| 5215 | within the same function. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5216 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5217 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5218 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5219 | BreakStmt = "break" [ Label ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5220 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5221 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5222 | <p> |
| 5223 | If there is a label, it must be that of an enclosing |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5224 | "for", "switch", or "select" statement, |
| 5225 | and that is the one whose execution terminates. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5226 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5227 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5228 | <pre> |
Rob Pike | cec0954 | 2013-09-17 07:41:11 +1000 | [diff] [blame] | 5229 | OuterLoop: |
| 5230 | for i = 0; i < n; i++ { |
| 5231 | for j = 0; j < m; j++ { |
| 5232 | switch a[i][j] { |
| 5233 | case nil: |
| 5234 | state = Error |
| 5235 | break OuterLoop |
| 5236 | case item: |
| 5237 | state = Found |
| 5238 | break OuterLoop |
| 5239 | } |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 5240 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5241 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5242 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5243 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5244 | <h3 id="Continue_statements">Continue statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5245 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5246 | <p> |
| 5247 | A "continue" statement begins the next iteration of the |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5248 | innermost <a href="#For_statements">"for" loop</a> at its post statement. |
Robert Griesemer | 94849d5 | 2014-05-28 08:43:47 -0700 | [diff] [blame] | 5249 | The "for" loop must be within the same function. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5250 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5251 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5252 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5253 | ContinueStmt = "continue" [ Label ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5254 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5255 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5256 | <p> |
Rob Pike | de921996 | 2010-04-28 13:18:40 -0700 | [diff] [blame] | 5257 | If there is a label, it must be that of an enclosing |
| 5258 | "for" statement, and that is the one whose execution |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5259 | advances. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5260 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5261 | |
Rob Pike | cec0954 | 2013-09-17 07:41:11 +1000 | [diff] [blame] | 5262 | <pre> |
| 5263 | RowLoop: |
| 5264 | for y, row := range rows { |
| 5265 | for x, data := range row { |
| 5266 | if data == endOfRow { |
| 5267 | continue RowLoop |
| 5268 | } |
| 5269 | row[x] = data + bias(x, y) |
| 5270 | } |
| 5271 | } |
| 5272 | </pre> |
| 5273 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5274 | <h3 id="Goto_statements">Goto statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5275 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5276 | <p> |
Robert Griesemer | 94849d5 | 2014-05-28 08:43:47 -0700 | [diff] [blame] | 5277 | A "goto" statement transfers control to the statement with the corresponding label |
| 5278 | within the same function. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5279 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5280 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5281 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 5282 | GotoStmt = "goto" Label . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5283 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5284 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5285 | <pre> |
| 5286 | goto Error |
| 5287 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5288 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5289 | <p> |
| 5290 | Executing the "goto" statement must not cause any variables to come into |
Russ Cox | f4c7db0 | 2011-06-17 12:49:04 -0400 | [diff] [blame] | 5291 | <a href="#Declarations_and_scope">scope</a> that were not already in scope at the point of the goto. |
| 5292 | For instance, this example: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5293 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5294 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5295 | <pre> |
Russ Cox | 108564d | 2011-03-15 13:51:24 -0400 | [diff] [blame] | 5296 | goto L // BAD |
| 5297 | v := 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5298 | L: |
| 5299 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5300 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5301 | <p> |
| 5302 | is erroneous because the jump to label <code>L</code> skips |
| 5303 | the creation of <code>v</code>. |
Russ Cox | f4c7db0 | 2011-06-17 12:49:04 -0400 | [diff] [blame] | 5304 | </p> |
| 5305 | |
| 5306 | <p> |
| 5307 | A "goto" statement outside a <a href="#Blocks">block</a> cannot jump to a label inside that block. |
| 5308 | For instance, this example: |
| 5309 | </p> |
| 5310 | |
| 5311 | <pre> |
| 5312 | if n%2 == 1 { |
| 5313 | goto L1 |
| 5314 | } |
| 5315 | for n > 0 { |
| 5316 | f() |
| 5317 | n-- |
| 5318 | L1: |
| 5319 | f() |
| 5320 | n-- |
| 5321 | } |
| 5322 | </pre> |
| 5323 | |
| 5324 | <p> |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 5325 | is erroneous because the label <code>L1</code> is inside |
Russ Cox | f4c7db0 | 2011-06-17 12:49:04 -0400 | [diff] [blame] | 5326 | the "for" statement's block but the <code>goto</code> is not. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5327 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5328 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5329 | <h3 id="Fallthrough_statements">Fallthrough statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 5330 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5331 | <p> |
| 5332 | A "fallthrough" statement transfers control to the first statement of the |
Shenghou Ma | ca9876d | 2015-12-31 11:25:51 -0500 | [diff] [blame] | 5333 | next case clause in an <a href="#Expression_switches">expression "switch" statement</a>. |
Robert Griesemer | 67a6b4f | 2013-03-01 16:45:14 -0800 | [diff] [blame] | 5334 | It may be used only as the final non-empty statement in such a clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5335 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 5336 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5337 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 5338 | FallthroughStmt = "fallthrough" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5339 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 5340 | |
| 5341 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5342 | <h3 id="Defer_statements">Defer statements</h3> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 5343 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5344 | <p> |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5345 | A "defer" statement invokes a function whose execution is deferred |
| 5346 | to the moment the surrounding function returns, either because the |
| 5347 | surrounding function executed a <a href="#Return_statements">return statement</a>, |
| 5348 | reached the end of its <a href="#Function_declarations">function body</a>, |
| 5349 | or because the corresponding goroutine is <a href="#Handling_panics">panicking</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5350 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 5351 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5352 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 5353 | DeferStmt = "defer" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5354 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 5355 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5356 | <p> |
Robert Griesemer | 25dd002 | 2012-11-29 11:46:25 -0800 | [diff] [blame] | 5357 | The expression must be a function or method call; it cannot be parenthesized. |
| 5358 | Calls of built-in functions are restricted as for |
| 5359 | <a href="#Expression_statements">expression statements</a>. |
| 5360 | </p> |
| 5361 | |
| 5362 | <p> |
Robert Griesemer | b4eb22d | 2014-09-19 13:32:07 -0700 | [diff] [blame] | 5363 | Each time a "defer" statement |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 5364 | executes, the function value and parameters to the call are |
| 5365 | <a href="#Calls">evaluated as usual</a> |
Robert Griesemer | b4eb22d | 2014-09-19 13:32:07 -0700 | [diff] [blame] | 5366 | and saved anew but the actual function is not invoked. |
| 5367 | Instead, deferred functions are invoked immediately before |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5368 | the surrounding function returns, in the reverse order |
| 5369 | they were deferred. |
Robert Griesemer | b4eb22d | 2014-09-19 13:32:07 -0700 | [diff] [blame] | 5370 | If a deferred function value evaluates |
| 5371 | to <code>nil</code>, execution <a href="#Handling_panics">panics</a> |
Rob Pike | 651bb8e | 2014-09-19 14:13:51 -0700 | [diff] [blame] | 5372 | when the function is invoked, not when the "defer" statement is executed. |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5373 | </p> |
| 5374 | |
| 5375 | <p> |
| 5376 | For instance, if the deferred function is |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5377 | a <a href="#Function_literals">function literal</a> and the surrounding |
Robert Griesemer | 48f0cd2 | 2010-03-23 17:30:14 -0700 | [diff] [blame] | 5378 | function has <a href="#Function_types">named result parameters</a> that |
| 5379 | are in scope within the literal, the deferred function may access and modify |
| 5380 | the result parameters before they are returned. |
Rob Pike | 633a2ce | 2012-01-23 08:40:13 -0800 | [diff] [blame] | 5381 | If the deferred function has any return values, they are discarded when |
| 5382 | the function completes. |
Rob Pike | 15970c8 | 2012-10-16 11:27:20 +1100 | [diff] [blame] | 5383 | (See also the section on <a href="#Handling_panics">handling panics</a>.) |
| 5384 | </p> |
| 5385 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5386 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5387 | lock(l) |
| 5388 | defer unlock(l) // unlocking happens before surrounding function returns |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 5389 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5390 | // prints 3 2 1 0 before surrounding function returns |
| 5391 | for i := 0; i <= 3; i++ { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5392 | defer fmt.Print(i) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5393 | } |
Robert Griesemer | 48f0cd2 | 2010-03-23 17:30:14 -0700 | [diff] [blame] | 5394 | |
| 5395 | // f returns 1 |
| 5396 | func f() (result int) { |
| 5397 | defer func() { |
| 5398 | result++ |
| 5399 | }() |
| 5400 | return 0 |
| 5401 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5402 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 5403 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5404 | <h2 id="Built-in_functions">Built-in functions</h2> |
| 5405 | |
| 5406 | <p> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5407 | Built-in functions are |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5408 | <a href="#Predeclared_identifiers">predeclared</a>. |
| 5409 | They are called like any other function but some of them |
| 5410 | accept a type instead of an expression as the first argument. |
| 5411 | </p> |
| 5412 | |
Russ Cox | 2a5f0c6 | 2009-12-04 10:23:12 -0800 | [diff] [blame] | 5413 | <p> |
| 5414 | The built-in functions do not have standard Go types, |
| 5415 | so they can only appear in <a href="#Calls">call expressions</a>; |
| 5416 | they cannot be used as function values. |
| 5417 | </p> |
| 5418 | |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 5419 | <h3 id="Close">Close</h3> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5420 | |
| 5421 | <p> |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 5422 | For a channel <code>c</code>, the built-in function <code>close(c)</code> |
Russ Cox | f58ed4e | 2011-10-13 16:58:04 -0400 | [diff] [blame] | 5423 | records that no more values will be sent on the channel. |
| 5424 | It is an error if <code>c</code> is a receive-only channel. |
| 5425 | Sending to or closing a closed channel causes a <a href="#Run_time_panics">run-time panic</a>. |
| 5426 | Closing the nil channel also causes a <a href="#Run_time_panics">run-time panic</a>. |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 5427 | After calling <code>close</code>, and after any previously |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5428 | sent values have been received, receive operations will return |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 5429 | the zero value for the channel's type without blocking. |
Russ Cox | 9f2cb86 | 2011-03-11 14:47:02 -0500 | [diff] [blame] | 5430 | The multi-valued <a href="#Receive_operator">receive operation</a> |
| 5431 | 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] | 5432 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5433 | |
Robert Griesemer | dc60c5a | 2010-07-14 16:09:22 -0700 | [diff] [blame] | 5434 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5435 | <h3 id="Length_and_capacity">Length and capacity</h3> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 5436 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5437 | <p> |
| 5438 | The built-in functions <code>len</code> and <code>cap</code> take arguments |
| 5439 | of various types and return a result of type <code>int</code>. |
| 5440 | The implementation guarantees that the result always fits into an <code>int</code>. |
| 5441 | </p> |
| 5442 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 5443 | <pre class="grammar"> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5444 | Call Argument type Result |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 5445 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5446 | len(s) string type string length in bytes |
| 5447 | [n]T, *[n]T array length (== n) |
| 5448 | []T slice length |
| 5449 | map[K]T map length (number of defined keys) |
| 5450 | chan T number of elements queued in channel buffer |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5451 | |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5452 | cap(s) [n]T, *[n]T array length (== n) |
| 5453 | []T slice capacity |
| 5454 | chan T channel buffer capacity |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5455 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5456 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5457 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5458 | The capacity of a slice is the number of elements for which there is |
| 5459 | space allocated in the underlying array. |
| 5460 | At any time the following relationship holds: |
| 5461 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5462 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5463 | <pre> |
Anthony Martin | 0122a66 | 2011-02-08 14:51:15 -0800 | [diff] [blame] | 5464 | 0 <= len(s) <= cap(s) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5465 | </pre> |
Robert Griesemer | 667ef6c | 2008-09-10 13:00:32 -0700 | [diff] [blame] | 5466 | |
Russ Cox | f442918 | 2010-07-01 17:49:47 -0700 | [diff] [blame] | 5467 | <p> |
Shenghou Ma | a0b5b46 | 2013-01-22 03:18:20 +0800 | [diff] [blame] | 5468 | The length of a <code>nil</code> slice, map or channel is 0. |
Rob Pike | 82e2db7 | 2014-01-04 10:52:59 -0800 | [diff] [blame] | 5469 | The capacity of a <code>nil</code> slice or channel is 0. |
Robert Griesemer | 0c2e6b3 | 2010-07-13 11:54:57 -0700 | [diff] [blame] | 5470 | </p> |
| 5471 | |
| 5472 | <p> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5473 | The expression <code>len(s)</code> is <a href="#Constants">constant</a> if |
| 5474 | <code>s</code> is a string constant. The expressions <code>len(s)</code> and |
| 5475 | <code>cap(s)</code> are constants if the type of <code>s</code> is an array |
| 5476 | or pointer to an array and the expression <code>s</code> does not contain |
Robert Griesemer | 8716981 | 2014-03-03 20:07:34 -0800 | [diff] [blame] | 5477 | <a href="#Receive_operator">channel receives</a> or (non-constant) |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5478 | <a href="#Calls">function calls</a>; in this case <code>s</code> is not evaluated. |
| 5479 | Otherwise, invocations of <code>len</code> and <code>cap</code> are not |
| 5480 | constant and <code>s</code> is evaluated. |
Russ Cox | f442918 | 2010-07-01 17:49:47 -0700 | [diff] [blame] | 5481 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5482 | |
Robert Griesemer | 8716981 | 2014-03-03 20:07:34 -0800 | [diff] [blame] | 5483 | <pre> |
| 5484 | const ( |
| 5485 | c1 = imag(2i) // imag(2i) = 2.0 is a constant |
| 5486 | c2 = len([10]float64{2}) // [10]float64{2} contains no function calls |
| 5487 | c3 = len([10]float64{c1}) // [10]float64{c1} contains no function calls |
| 5488 | c4 = len([10]float64{imag(2i)}) // imag(2i) is a constant and no function call is issued |
Shenghou Ma | c0abdd9 | 2014-12-26 02:50:33 -0500 | [diff] [blame] | 5489 | c5 = len([10]float64{imag(z)}) // invalid: imag(z) is a (non-constant) function call |
Robert Griesemer | 8716981 | 2014-03-03 20:07:34 -0800 | [diff] [blame] | 5490 | ) |
| 5491 | var z complex128 |
| 5492 | </pre> |
Robert Griesemer | 5473103 | 2011-05-12 09:15:59 -0700 | [diff] [blame] | 5493 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5494 | <h3 id="Allocation">Allocation</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5495 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5496 | <p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 5497 | The built-in function <code>new</code> takes a type <code>T</code>, |
| 5498 | allocates storage for a <a href="#Variables">variable</a> of that type |
| 5499 | at run time, and returns a value of type <code>*T</code> |
| 5500 | <a href="#Pointer_types">pointing</a> to it. |
| 5501 | The variable is initialized as described in the section on |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5502 | <a href="#The_zero_value">initial values</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5503 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5504 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5505 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5506 | new(T) |
| 5507 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5508 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5509 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 5510 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5511 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5512 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5513 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5514 | type S struct { a int; b float64 } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5515 | new(S) |
| 5516 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5517 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5518 | <p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 5519 | allocates storage for a variable of type <code>S</code>, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5520 | initializes it (<code>a=0</code>, <code>b=0.0</code>), |
| 5521 | and returns a value of type <code>*S</code> containing the address |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 5522 | of the location. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5523 | </p> |
| 5524 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5525 | <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] | 5526 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5527 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5528 | The built-in function <code>make</code> takes a type <code>T</code>, |
| 5529 | which must be a slice, map or channel type, |
| 5530 | optionally followed by a type-specific list of expressions. |
| 5531 | It returns a value of type <code>T</code> (not <code>*T</code>). |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 5532 | The memory is initialized as described in the section on |
| 5533 | <a href="#The_zero_value">initial values</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5534 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5535 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5536 | <pre class="grammar"> |
Robert Griesemer | df674ff | 2010-05-04 17:31:40 -0700 | [diff] [blame] | 5537 | Call Type T Result |
| 5538 | |
| 5539 | make(T, n) slice slice of type T with length n and capacity n |
| 5540 | make(T, n, m) slice slice of type T with length n and capacity m |
| 5541 | |
| 5542 | make(T) map map of type T |
| 5543 | make(T, n) map map of type T with initial space for n elements |
| 5544 | |
Robert Griesemer | 97aa90d | 2014-05-07 10:40:39 -0700 | [diff] [blame] | 5545 | make(T) channel unbuffered channel of type T |
| 5546 | make(T, n) channel buffered channel of type T, buffer size n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5547 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5548 | |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5549 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5550 | <p> |
Robert Griesemer | b66df0e | 2013-03-11 09:20:52 -0700 | [diff] [blame] | 5551 | The size arguments <code>n</code> and <code>m</code> must be of integer type or untyped. |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 5552 | A <a href="#Constants">constant</a> size argument must be non-negative and |
| 5553 | representable by a value of type <code>int</code>. |
| 5554 | If both <code>n</code> and <code>m</code> are provided and are constant, then |
Robert Griesemer | 3bde000 | 2012-10-19 10:11:06 -0700 | [diff] [blame] | 5555 | <code>n</code> must be no larger than <code>m</code>. |
| 5556 | If <code>n</code> is negative or larger than <code>m</code> at run time, |
| 5557 | a <a href="#Run_time_panics">run-time panic</a> occurs. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 5558 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5559 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5560 | <pre> |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 5561 | s := make([]int, 10, 100) // slice with len(s) == 10, cap(s) == 100 |
Robert Griesemer | 3bde000 | 2012-10-19 10:11:06 -0700 | [diff] [blame] | 5562 | s := make([]int, 1e3) // slice with len(s) == cap(s) == 1000 |
Robert Griesemer | 3906706 | 2012-12-12 11:06:26 -0800 | [diff] [blame] | 5563 | s := make([]int, 1<<63) // illegal: len(s) is not representable by a value of type int |
Oling Cat | 018e89f | 2013-01-24 20:46:33 +1100 | [diff] [blame] | 5564 | s := make([]int, 10, 0) // illegal: len(s) > cap(s) |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 5565 | c := make(chan int, 10) // channel with a buffer size of 10 |
| 5566 | 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] | 5567 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 5568 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5569 | |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 5570 | <h3 id="Appending_and_copying_slices">Appending to and copying slices</h3> |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5571 | |
| 5572 | <p> |
Robert Griesemer | 0c49471 | 2012-09-28 15:55:38 -0700 | [diff] [blame] | 5573 | The built-in functions <code>append</code> and <code>copy</code> assist in |
| 5574 | common slice operations. |
| 5575 | For both functions, the result is independent of whether the memory referenced |
| 5576 | by the arguments overlaps. |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 5577 | </p> |
| 5578 | |
| 5579 | <p> |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 5580 | The <a href="#Function_types">variadic</a> function <code>append</code> |
| 5581 | appends zero or more values <code>x</code> |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 5582 | to <code>s</code> of type <code>S</code>, which must be a slice type, and |
| 5583 | returns the resulting slice, also of type <code>S</code>. |
Robert Griesemer | 95b8137 | 2011-06-12 12:09:50 -0700 | [diff] [blame] | 5584 | The values <code>x</code> are passed to a parameter of type <code>...T</code> |
| 5585 | where <code>T</code> is the <a href="#Slice_types">element type</a> of |
| 5586 | <code>S</code> and the respective |
| 5587 | <a href="#Passing_arguments_to_..._parameters">parameter passing rules</a> apply. |
Luuk van Dijk | 77fac21 | 2011-10-12 15:59:23 +0200 | [diff] [blame] | 5588 | As a special case, <code>append</code> also accepts a first argument |
| 5589 | assignable to type <code>[]byte</code> with a second argument of |
| 5590 | string type followed by <code>...</code>. This form appends the |
| 5591 | bytes of the string. |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 5592 | </p> |
| 5593 | |
| 5594 | <pre class="grammar"> |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 5595 | 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] | 5596 | </pre> |
| 5597 | |
| 5598 | <p> |
| 5599 | If the capacity of <code>s</code> is not large enough to fit the additional |
Robert Griesemer | 15da997 | 2013-10-16 16:16:54 -0700 | [diff] [blame] | 5600 | values, <code>append</code> allocates a new, sufficiently large underlying |
| 5601 | array that fits both the existing slice elements and the additional values. |
| 5602 | Otherwise, <code>append</code> re-uses the underlying array. |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 5603 | </p> |
| 5604 | |
| 5605 | <pre> |
| 5606 | s0 := []int{0, 0} |
Robert Griesemer | 0c49471 | 2012-09-28 15:55:38 -0700 | [diff] [blame] | 5607 | s1 := append(s0, 2) // append a single element s1 == []int{0, 0, 2} |
| 5608 | s2 := append(s1, 3, 5, 7) // append multiple elements s2 == []int{0, 0, 2, 3, 5, 7} |
| 5609 | s3 := append(s2, s0...) // append a slice s3 == []int{0, 0, 2, 3, 5, 7, 0, 0} |
| 5610 | s4 := append(s3[3:6], s3[2:]...) // append overlapping slice s4 == []int{3, 5, 7, 2, 3, 5, 7, 0, 0} |
Robert Griesemer | 0f7acf1 | 2011-04-19 14:38:49 -0700 | [diff] [blame] | 5611 | |
| 5612 | var t []interface{} |
David Symonds | 583b29c | 2014-12-04 09:29:29 +1100 | [diff] [blame] | 5613 | t = append(t, 42, 3.1415, "foo") // t == []interface{}{42, 3.1415, "foo"} |
Luuk van Dijk | 77fac21 | 2011-10-12 15:59:23 +0200 | [diff] [blame] | 5614 | |
| 5615 | var b []byte |
Robert Griesemer | 0c49471 | 2012-09-28 15:55:38 -0700 | [diff] [blame] | 5616 | b = append(b, "bar"...) // append string contents b == []byte{'b', 'a', 'r' } |
Robert Griesemer | 07e983a | 2010-10-25 16:50:31 -0700 | [diff] [blame] | 5617 | </pre> |
| 5618 | |
| 5619 | <p> |
| 5620 | The function <code>copy</code> copies slice elements from |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5621 | a source <code>src</code> to a destination <code>dst</code> and returns the |
Robert Griesemer | 0c49471 | 2012-09-28 15:55:38 -0700 | [diff] [blame] | 5622 | number of elements copied. |
Robert Griesemer | 7bc0371 | 2010-06-07 15:49:39 -0700 | [diff] [blame] | 5623 | 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] | 5624 | <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] | 5625 | The number of elements copied is the minimum of |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5626 | <code>len(src)</code> and <code>len(dst)</code>. |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 5627 | As a special case, <code>copy</code> also accepts a destination argument assignable |
| 5628 | to type <code>[]byte</code> with a source argument of a string type. |
| 5629 | This form copies the bytes from the string into the byte slice. |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5630 | </p> |
| 5631 | |
| 5632 | <pre class="grammar"> |
| 5633 | copy(dst, src []T) int |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 5634 | copy(dst []byte, src string) int |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5635 | </pre> |
| 5636 | |
| 5637 | <p> |
| 5638 | Examples: |
| 5639 | </p> |
| 5640 | |
| 5641 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5642 | var a = [...]int{0, 1, 2, 3, 4, 5, 6, 7} |
| 5643 | var s = make([]int, 6) |
Robert Griesemer | 425bbad | 2010-10-25 16:41:06 -0700 | [diff] [blame] | 5644 | var b = make([]byte, 5) |
| 5645 | n1 := copy(s, a[0:]) // n1 == 6, s == []int{0, 1, 2, 3, 4, 5} |
| 5646 | n2 := copy(s, s[2:]) // n2 == 4, s == []int{2, 3, 4, 5, 4, 5} |
| 5647 | n3 := copy(b, "Hello, World!") // n3 == 5, b == []byte("Hello") |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5648 | </pre> |
| 5649 | |
Robert Griesemer | 3e0c0a8 | 2011-10-17 12:53:10 -0700 | [diff] [blame] | 5650 | |
| 5651 | <h3 id="Deletion_of_map_elements">Deletion of map elements</h3> |
| 5652 | |
| 5653 | <p> |
| 5654 | The built-in function <code>delete</code> removes the element with key |
| 5655 | <code>k</code> from a <a href="#Map_types">map</a> <code>m</code>. The |
| 5656 | type of <code>k</code> must be <a href="#Assignability">assignable</a> |
| 5657 | to the key type of <code>m</code>. |
| 5658 | </p> |
| 5659 | |
| 5660 | <pre class="grammar"> |
| 5661 | delete(m, k) // remove element m[k] from map m |
| 5662 | </pre> |
| 5663 | |
| 5664 | <p> |
Robert Griesemer | a9a49fe | 2012-12-12 13:08:35 -0800 | [diff] [blame] | 5665 | If the map <code>m</code> is <code>nil</code> or the element <code>m[k]</code> |
| 5666 | does not exist, <code>delete</code> is a no-op. |
Robert Griesemer | 3e0c0a8 | 2011-10-17 12:53:10 -0700 | [diff] [blame] | 5667 | </p> |
| 5668 | |
| 5669 | |
Russ Cox | 0201e37 | 2012-02-29 15:20:11 -0500 | [diff] [blame] | 5670 | <h3 id="Complex_numbers">Manipulating complex numbers</h3> |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5671 | |
| 5672 | <p> |
| 5673 | Three functions assemble and disassemble complex numbers. |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5674 | The built-in function <code>complex</code> constructs a complex |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5675 | value from a floating-point real and imaginary part, while |
| 5676 | <code>real</code> and <code>imag</code> |
| 5677 | extract the real and imaginary parts of a complex value. |
| 5678 | </p> |
| 5679 | |
| 5680 | <pre class="grammar"> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5681 | complex(realPart, imaginaryPart floatT) complexT |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5682 | real(complexT) floatT |
| 5683 | imag(complexT) floatT |
| 5684 | </pre> |
| 5685 | |
| 5686 | <p> |
| 5687 | The type of the arguments and return value correspond. |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5688 | For <code>complex</code>, the two arguments must be of the same |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5689 | floating-point type and the return type is the complex type |
| 5690 | with the corresponding floating-point constituents: |
Robert Griesemer | 98aa822 | 2015-07-29 15:42:04 -0700 | [diff] [blame] | 5691 | <code>complex64</code> for <code>float32</code> arguments, and |
| 5692 | <code>complex128</code> for <code>float64</code> arguments. |
| 5693 | If one of the arguments evaluates to an untyped constant, it is first |
| 5694 | <a href="#Conversions">converted</a> to the type of the other argument. |
| 5695 | If both arguments evaluate to untyped constants, they must be non-complex |
| 5696 | numbers or their imaginary parts must be zero, and the return value of |
| 5697 | the function is an untyped complex constant. |
| 5698 | </p> |
| 5699 | |
| 5700 | <p> |
| 5701 | For <code>real</code> and <code>imag</code>, the argument must be |
| 5702 | of complex type, and the return type is the corresponding floating-point |
| 5703 | type: <code>float32</code> for a <code>complex64</code> argument, and |
| 5704 | <code>float64</code> for a <code>complex128</code> argument. |
| 5705 | If the argument evaluates to an untyped constant, it must be a number, |
| 5706 | and the return value of the function is an untyped floating-point constant. |
| 5707 | </p> |
| 5708 | |
| 5709 | <p> |
| 5710 | The <code>real</code> and <code>imag</code> functions together form the inverse of |
| 5711 | <code>complex</code>, so for a value <code>z</code> of a complex type <code>Z</code>, |
| 5712 | <code>z == Z(complex(real(z), imag(z)))</code>. |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5713 | </p> |
| 5714 | |
| 5715 | <p> |
| 5716 | If the operands of these functions are all constants, the return |
| 5717 | value is a constant. |
| 5718 | </p> |
| 5719 | |
| 5720 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5721 | var a = complex(2, -2) // complex128 |
Robert Griesemer | 98aa822 | 2015-07-29 15:42:04 -0700 | [diff] [blame] | 5722 | const b = complex(1.0, -1.4) // untyped complex constant 1 - 1.4i |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5723 | x := float32(math.Cos(math.Pi/2)) // float32 |
| 5724 | var c64 = complex(5, -x) // complex64 |
Robert Griesemer | 98aa822 | 2015-07-29 15:42:04 -0700 | [diff] [blame] | 5725 | const s uint = complex(1, 0) // untyped complex constant 1 + 0i can be converted to uint |
| 5726 | _ = complex(1, 2<<s) // illegal: 2 has floating-point type, cannot shift |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 5727 | var rl = real(c64) // float32 |
Robert Griesemer | 98aa822 | 2015-07-29 15:42:04 -0700 | [diff] [blame] | 5728 | var im = imag(a) // float64 |
| 5729 | const c = imag(b) // untyped constant -1.4 |
| 5730 | _ = imag(3 << s) // illegal: 3 has complex type, cannot shift |
Rob Pike | 7297087 | 2010-03-04 12:35:16 -0800 | [diff] [blame] | 5731 | </pre> |
| 5732 | |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5733 | <h3 id="Handling_panics">Handling panics</h3> |
| 5734 | |
| 5735 | <p> Two built-in functions, <code>panic</code> and <code>recover</code>, |
| 5736 | assist in reporting and handling <a href="#Run_time_panics">run-time panics</a> |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 5737 | and program-defined error conditions. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5738 | </p> |
| 5739 | |
| 5740 | <pre class="grammar"> |
| 5741 | func panic(interface{}) |
| 5742 | func recover() interface{} |
| 5743 | </pre> |
| 5744 | |
| 5745 | <p> |
Rob Pike | c34050f | 2013-03-12 14:28:16 -0700 | [diff] [blame] | 5746 | While executing a function <code>F</code>, |
| 5747 | an explicit call to <code>panic</code> or a <a href="#Run_time_panics">run-time panic</a> |
| 5748 | terminates the execution of <code>F</code>. |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5749 | Any functions <a href="#Defer_statements">deferred</a> by <code>F</code> |
Rob Pike | c34050f | 2013-03-12 14:28:16 -0700 | [diff] [blame] | 5750 | are then executed as usual. |
| 5751 | Next, any deferred functions run by <code>F's</code> caller are run, |
| 5752 | and so on up to any deferred by the top-level function in the executing goroutine. |
| 5753 | At that point, the program is terminated and the error |
Robert Griesemer | 1e8e14c | 2012-11-01 10:13:48 -0700 | [diff] [blame] | 5754 | condition is reported, including the value of the argument to <code>panic</code>. |
| 5755 | This termination sequence is called <i>panicking</i>. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5756 | </p> |
| 5757 | |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 5758 | <pre> |
| 5759 | panic(42) |
| 5760 | panic("unreachable") |
| 5761 | panic(Error("cannot parse")) |
| 5762 | </pre> |
| 5763 | |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5764 | <p> |
| 5765 | The <code>recover</code> function allows a program to manage behavior |
Rob Pike | c34050f | 2013-03-12 14:28:16 -0700 | [diff] [blame] | 5766 | of a panicking goroutine. |
| 5767 | Suppose a function <code>G</code> defers a function <code>D</code> that calls |
| 5768 | <code>recover</code> and a panic occurs in a function on the same goroutine in which <code>G</code> |
| 5769 | is executing. |
| 5770 | When the running of deferred functions reaches <code>D</code>, |
| 5771 | the return value of <code>D</code>'s call to <code>recover</code> will be the value passed to the call of <code>panic</code>. |
| 5772 | If <code>D</code> returns normally, without starting a new |
| 5773 | <code>panic</code>, the panicking sequence stops. In that case, |
| 5774 | the state of functions called between <code>G</code> and the call to <code>panic</code> |
| 5775 | is discarded, and normal execution resumes. |
| 5776 | Any functions deferred by <code>G</code> before <code>D</code> are then run and <code>G</code>'s |
| 5777 | execution terminates by returning to its caller. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5778 | </p> |
| 5779 | |
| 5780 | <p> |
Rob Pike | c34050f | 2013-03-12 14:28:16 -0700 | [diff] [blame] | 5781 | The return value of <code>recover</code> is <code>nil</code> if any of the following conditions holds: |
| 5782 | </p> |
| 5783 | <ul> |
| 5784 | <li> |
| 5785 | <code>panic</code>'s argument was <code>nil</code>; |
| 5786 | </li> |
| 5787 | <li> |
| 5788 | the goroutine is not panicking; |
| 5789 | </li> |
| 5790 | <li> |
| 5791 | <code>recover</code> was not called directly by a deferred function. |
| 5792 | </li> |
| 5793 | </ul> |
| 5794 | |
| 5795 | <p> |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 5796 | The <code>protect</code> function in the example below invokes |
| 5797 | the function argument <code>g</code> and protects callers from |
| 5798 | run-time panics raised by <code>g</code>. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5799 | </p> |
| 5800 | |
| 5801 | <pre> |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 5802 | func protect(g func()) { |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5803 | defer func() { |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 5804 | log.Println("done") // Println executes normally even if there is a panic |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5805 | if x := recover(); x != nil { |
Rob Pike | 966bf71 | 2011-03-01 13:54:22 -0800 | [diff] [blame] | 5806 | log.Printf("run time panic: %v", x) |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5807 | } |
Rob Pike | e6b1d42 | 2011-04-05 11:01:25 -0700 | [diff] [blame] | 5808 | }() |
Robert Griesemer | 76f3228 | 2011-02-04 08:43:21 -0800 | [diff] [blame] | 5809 | log.Println("start") |
| 5810 | g() |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 5811 | } |
| 5812 | </pre> |
| 5813 | |
Robert Griesemer | 1a8ebcc | 2009-11-18 19:15:25 -0800 | [diff] [blame] | 5814 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5815 | <h3 id="Bootstrapping">Bootstrapping</h3> |
| 5816 | |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 5817 | <p> |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5818 | Current implementations provide several built-in functions useful during |
| 5819 | bootstrapping. These functions are documented for completeness but are not |
| 5820 | guaranteed to stay in the language. They do not return a result. |
Robert Griesemer | 5eb3624 | 2009-09-16 11:05:14 -0700 | [diff] [blame] | 5821 | </p> |
| 5822 | |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5823 | <pre class="grammar"> |
Robert Griesemer | d4d4ff0 | 2009-10-19 13:13:59 -0700 | [diff] [blame] | 5824 | Function Behavior |
Robert Griesemer | 164a7bc | 2009-09-30 12:00:25 -0700 | [diff] [blame] | 5825 | |
| 5826 | print prints all arguments; formatting of arguments is implementation-specific |
| 5827 | 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] | 5828 | </pre> |
| 5829 | |
| 5830 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5831 | <h2 id="Packages">Packages</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5832 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5833 | <p> |
| 5834 | Go programs are constructed by linking together <i>packages</i>. |
Robert Griesemer | 326ef13 | 2009-09-28 19:21:15 -0700 | [diff] [blame] | 5835 | A package in turn is constructed from one or more source files |
| 5836 | that together declare constants, types, variables and functions |
| 5837 | belonging to the package and which are accessible in all files |
| 5838 | of the same package. Those elements may be |
| 5839 | <a href="#Exported_identifiers">exported</a> and used in another package. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5840 | </p> |
| 5841 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5842 | <h3 id="Source_file_organization">Source file organization</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5843 | |
| 5844 | <p> |
| 5845 | Each source file consists of a package clause defining the package |
| 5846 | to which it belongs, followed by a possibly empty set of import |
| 5847 | declarations that declare packages whose contents it wishes to use, |
| 5848 | followed by a possibly empty set of declarations of functions, |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 5849 | types, variables, and constants. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5850 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5851 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5852 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5853 | SourceFile = PackageClause ";" { ImportDecl ";" } { TopLevelDecl ";" } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5854 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5855 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5856 | <h3 id="Package_clause">Package clause</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5857 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5858 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5859 | A package clause begins each source file and defines the package |
| 5860 | to which the file belongs. |
| 5861 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5862 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5863 | <pre class="ebnf"> |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 5864 | PackageClause = "package" PackageName . |
| 5865 | PackageName = identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5866 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5867 | |
Robert Griesemer | 4e56b33 | 2009-09-10 10:14:00 -0700 | [diff] [blame] | 5868 | <p> |
| 5869 | The PackageName must not be the <a href="#Blank_identifier">blank identifier</a>. |
| 5870 | </p> |
| 5871 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5872 | <pre> |
| 5873 | package math |
| 5874 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5875 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5876 | <p> |
| 5877 | A set of files sharing the same PackageName form the implementation of a package. |
| 5878 | An implementation may require that all source files for a package inhabit the same directory. |
| 5879 | </p> |
| 5880 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5881 | <h3 id="Import_declarations">Import declarations</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5882 | |
| 5883 | <p> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 5884 | An import declaration states that the source file containing the declaration |
| 5885 | depends on functionality of the <i>imported</i> package |
| 5886 | (<a href="#Program_initialization_and_execution">§Program initialization and execution</a>) |
Rob Pike | b51ad9c | 2012-09-23 05:03:43 +1000 | [diff] [blame] | 5887 | and enables access to <a href="#Exported_identifiers">exported</a> identifiers |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 5888 | of that package. |
| 5889 | The import names an identifier (PackageName) to be used for access and an ImportPath |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5890 | that specifies the package to be imported. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5891 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5892 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 5893 | <pre class="ebnf"> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5894 | ImportDecl = "import" ( ImportSpec | "(" { ImportSpec ";" } ")" ) . |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5895 | ImportSpec = [ "." | PackageName ] ImportPath . |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5896 | ImportPath = string_lit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5897 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5898 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5899 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5900 | The PackageName is used in <a href="#Qualified_identifiers">qualified identifiers</a> |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 5901 | to access exported identifiers of the package within the importing source file. |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5902 | It is declared in the <a href="#Blocks">file block</a>. |
| 5903 | 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] | 5904 | <a href="#Package_clause">package clause</a> of the imported package. |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5905 | If an explicit period (<code>.</code>) appears instead of a name, all the |
Robert Griesemer | 103c9db | 2012-03-01 13:57:49 -0800 | [diff] [blame] | 5906 | package's exported identifiers declared in that package's |
| 5907 | <a href="#Blocks">package block</a> will be declared in the importing source |
Rob Pike | 227fe5f | 2014-01-14 15:16:01 -0800 | [diff] [blame] | 5908 | file's file block and must be accessed without a qualifier. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5909 | </p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 5910 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5911 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5912 | The interpretation of the ImportPath is implementation-dependent but |
| 5913 | it is typically a substring of the full file name of the compiled |
| 5914 | package and may be relative to a repository of installed packages. |
| 5915 | </p> |
| 5916 | |
| 5917 | <p> |
Robert Griesemer | ac4055b | 2012-02-22 23:51:25 -0800 | [diff] [blame] | 5918 | Implementation restriction: A compiler may restrict ImportPaths to |
| 5919 | non-empty strings using only characters belonging to |
Rob Pike | e6863e7 | 2014-02-25 14:15:49 -0800 | [diff] [blame] | 5920 | <a href="http://www.unicode.org/versions/Unicode6.3.0/">Unicode's</a> |
Robert Griesemer | ac4055b | 2012-02-22 23:51:25 -0800 | [diff] [blame] | 5921 | L, M, N, P, and S general categories (the Graphic characters without |
Russ Cox | fad10f9 | 2012-02-23 22:46:04 -0500 | [diff] [blame] | 5922 | spaces) and may also exclude the characters |
| 5923 | <code>!"#$%&'()*,:;<=>?[\]^`{|}</code> |
| 5924 | and the Unicode replacement character U+FFFD. |
Robert Griesemer | ac4055b | 2012-02-22 23:51:25 -0800 | [diff] [blame] | 5925 | </p> |
| 5926 | |
| 5927 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5928 | Assume we have compiled a package containing the package clause |
| 5929 | <code>package math</code>, which exports function <code>Sin</code>, and |
| 5930 | installed the compiled package in the file identified by |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5931 | <code>"lib/math"</code>. |
Rob Pike | 227fe5f | 2014-01-14 15:16:01 -0800 | [diff] [blame] | 5932 | This table illustrates how <code>Sin</code> is accessed in files |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5933 | that import the package after the |
| 5934 | various types of import declaration. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5935 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5936 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5937 | <pre class="grammar"> |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5938 | Import declaration Local name of Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5939 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5940 | import "lib/math" math.Sin |
Rob Pike | b51ad9c | 2012-09-23 05:03:43 +1000 | [diff] [blame] | 5941 | import m "lib/math" m.Sin |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5942 | import . "lib/math" Sin |
| 5943 | </pre> |
| 5944 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5945 | <p> |
Rob Pike | 3aec2e4 | 2009-09-25 17:00:22 -0700 | [diff] [blame] | 5946 | An import declaration declares a dependency relation between |
| 5947 | the importing and imported package. |
Robert Griesemer | 4be38dd | 2013-03-04 12:59:40 -0800 | [diff] [blame] | 5948 | It is illegal for a package to import itself, directly or indirectly, |
| 5949 | or to directly import a package without |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 5950 | referring to any of its exported identifiers. To import a package solely for |
| 5951 | its side-effects (initialization), use the <a href="#Blank_identifier">blank</a> |
| 5952 | identifier as explicit package name: |
| 5953 | </p> |
| 5954 | |
| 5955 | <pre> |
| 5956 | import _ "lib/math" |
| 5957 | </pre> |
| 5958 | |
| 5959 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 5960 | <h3 id="An_example_package">An example package</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5961 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5962 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5963 | Here is a complete Go package that implements a concurrent prime sieve. |
| 5964 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5965 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5966 | <pre> |
| 5967 | package main |
| 5968 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 5969 | import "fmt" |
| 5970 | |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 5971 | // Send the sequence 2, 3, 4, … to channel 'ch'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 5972 | func generate(ch chan<- int) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5973 | for i := 2; ; i++ { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5974 | ch <- i // Send 'i' to channel 'ch'. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5975 | } |
| 5976 | } |
| 5977 | |
Fazlul Shahriar | 330139e | 2009-11-30 21:23:58 -0800 | [diff] [blame] | 5978 | // Copy the values from channel 'src' to channel 'dst', |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5979 | // removing those divisible by 'prime'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 5980 | func filter(src <-chan int, dst chan<- int, prime int) { |
David Symonds | 72a2979 | 2011-11-29 15:47:36 -0800 | [diff] [blame] | 5981 | for i := range src { // Loop over values received from 'src'. |
Robert Griesemer | e1e7619 | 2009-09-25 14:11:03 -0700 | [diff] [blame] | 5982 | if i%prime != 0 { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5983 | dst <- i // Send 'i' to channel 'dst'. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5984 | } |
| 5985 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5986 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 5987 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5988 | // The prime sieve: Daisy-chain filter processes together. |
| 5989 | func sieve() { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5990 | ch := make(chan int) // Create a new channel. |
| 5991 | go generate(ch) // Start generate() as a subprocess. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5992 | for { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 5993 | prime := <-ch |
| 5994 | fmt.Print(prime, "\n") |
| 5995 | ch1 := make(chan int) |
| 5996 | go filter(ch, ch1, prime) |
| 5997 | ch = ch1 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 5998 | } |
| 5999 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6000 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6001 | func main() { |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 6002 | sieve() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6003 | } |
| 6004 | </pre> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 6005 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 6006 | <h2 id="Program_initialization_and_execution">Program initialization and execution</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6007 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 6008 | <h3 id="The_zero_value">The zero value</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6009 | <p> |
Robert Griesemer | 6962c15 | 2014-10-16 15:08:49 -0700 | [diff] [blame] | 6010 | When storage is allocated for a <a href="#Variables">variable</a>, |
| 6011 | either through a declaration or a call of <code>new</code>, or when |
| 6012 | a new value is created, either through a composite literal or a call |
| 6013 | of <code>make</code>, |
| 6014 | and no explicit initialization is provided, the variable or value is |
| 6015 | given a default value. Each element of such a variable or value is |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 6016 | 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] | 6017 | <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] | 6018 | 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] | 6019 | This initialization is done recursively, so for instance each element of an |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6020 | array of structs will have its fields zeroed if no value is specified. |
| 6021 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6022 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6023 | These two simple declarations are equivalent: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6024 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6025 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6026 | <pre> |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 6027 | var i int |
| 6028 | var i int = 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6029 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6030 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6031 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6032 | After |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6033 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6034 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6035 | <pre> |
Robert Griesemer | b94c0d2 | 2011-01-19 23:07:21 -0500 | [diff] [blame] | 6036 | type T struct { i int; f float64; next *T } |
Robert Griesemer | 130ac74 | 2009-12-10 16:43:01 -0800 | [diff] [blame] | 6037 | t := new(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6038 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6039 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6040 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6041 | the following holds: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6042 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6043 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6044 | <pre> |
| 6045 | t.i == 0 |
| 6046 | t.f == 0.0 |
| 6047 | t.next == nil |
| 6048 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6049 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6050 | <p> |
| 6051 | The same would also be true after |
| 6052 | </p> |
| 6053 | |
| 6054 | <pre> |
| 6055 | var t T |
| 6056 | </pre> |
| 6057 | |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6058 | <h3 id="Package_initialization">Package initialization</h3> |
Robert Griesemer | 259f0ff | 2014-09-29 12:44:50 -0700 | [diff] [blame] | 6059 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6060 | <p> |
Robert Griesemer | 259f0ff | 2014-09-29 12:44:50 -0700 | [diff] [blame] | 6061 | Within a package, package-level variables are initialized in |
| 6062 | <i>declaration order</i> but after any of the variables |
| 6063 | they <i>depend</i> on. |
| 6064 | </p> |
| 6065 | |
| 6066 | <p> |
| 6067 | More precisely, a package-level variable is considered <i>ready for |
| 6068 | initialization</i> if it is not yet initialized and either has |
| 6069 | no <a href="#Variable_declarations">initialization expression</a> or |
| 6070 | its initialization expression has no dependencies on uninitialized variables. |
| 6071 | Initialization proceeds by repeatedly initializing the next package-level |
| 6072 | variable that is earliest in declaration order and ready for initialization, |
| 6073 | until there are no variables ready for initialization. |
| 6074 | </p> |
| 6075 | |
| 6076 | <p> |
| 6077 | If any variables are still uninitialized when this |
| 6078 | process ends, those variables are part of one or more initialization cycles, |
| 6079 | and the program is not valid. |
| 6080 | </p> |
| 6081 | |
| 6082 | <p> |
| 6083 | The declaration order of variables declared in multiple files is determined |
| 6084 | by the order in which the files are presented to the compiler: Variables |
| 6085 | declared in the first file are declared before any of the variables declared |
| 6086 | in the second file, and so on. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6087 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6088 | |
| 6089 | <p> |
| 6090 | Dependency analysis does not rely on the actual values of the |
| 6091 | variables, only on lexical <i>references</i> to them in the source, |
Robert Griesemer | 259f0ff | 2014-09-29 12:44:50 -0700 | [diff] [blame] | 6092 | analyzed transitively. For instance, if a variable <code>x</code>'s |
| 6093 | initialization expression refers to a function whose body refers to |
| 6094 | variable <code>y</code> then <code>x</code> depends on <code>y</code>. |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6095 | Specifically: |
| 6096 | </p> |
| 6097 | |
| 6098 | <ul> |
| 6099 | <li> |
| 6100 | A reference to a variable or function is an identifier denoting that |
| 6101 | variable or function. |
| 6102 | </li> |
| 6103 | |
| 6104 | <li> |
| 6105 | A reference to a method <code>m</code> is a |
| 6106 | <a href="#Method_values">method value</a> or |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 6107 | <a href="#Method_expressions">method expression</a> of the form |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6108 | <code>t.m</code>, where the (static) type of <code>t</code> is |
| 6109 | not an interface type, and the method <code>m</code> is in the |
| 6110 | <a href="#Method_sets">method set</a> of <code>t</code>. |
| 6111 | It is immaterial whether the resulting function value |
| 6112 | <code>t.m</code> is invoked. |
| 6113 | </li> |
| 6114 | |
| 6115 | <li> |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 6116 | A variable, function, or method <code>x</code> depends on a variable |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6117 | <code>y</code> if <code>x</code>'s initialization expression or body |
| 6118 | (for functions and methods) contains a reference to <code>y</code> |
| 6119 | or to a function or method that depends on <code>y</code>. |
| 6120 | </li> |
| 6121 | </ul> |
| 6122 | |
| 6123 | <p> |
| 6124 | Dependency analysis is performed per package; only references referring |
| 6125 | to variables, functions, and methods declared in the current package |
| 6126 | are considered. |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6127 | </p> |
| 6128 | |
| 6129 | <p> |
| 6130 | For example, given the declarations |
| 6131 | </p> |
| 6132 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6133 | <pre> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6134 | var ( |
| 6135 | a = c + b |
| 6136 | b = f() |
| 6137 | c = f() |
| 6138 | d = 3 |
| 6139 | ) |
| 6140 | |
| 6141 | func f() int { |
| 6142 | d++ |
| 6143 | return d |
| 6144 | } |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6145 | </pre> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6146 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6147 | <p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6148 | the initialization order is <code>d</code>, <code>b</code>, <code>c</code>, <code>a</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6149 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6150 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6151 | <p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6152 | Variables may also be initialized using functions named <code>init</code> |
| 6153 | declared in the package block, with no arguments and no result parameters. |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 6154 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6155 | |
| 6156 | <pre> |
| 6157 | func init() { … } |
| 6158 | </pre> |
| 6159 | |
Rob Pike | 8cb9184 | 2009-09-15 11:56:39 -0700 | [diff] [blame] | 6160 | <p> |
Robin Eklind | cac006a | 2014-08-30 10:27:01 -0700 | [diff] [blame] | 6161 | Multiple such functions may be defined, even within a single |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6162 | source file. The <code>init</code> identifier is not |
| 6163 | <a href="#Declarations_and_scope">declared</a> and thus |
| 6164 | <code>init</code> functions cannot be referred to from anywhere |
| 6165 | in a program. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6166 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6167 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6168 | <p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6169 | A package with no imports is initialized by assigning initial values |
| 6170 | to all its package-level variables followed by calling all <code>init</code> |
Robert Griesemer | c00043b | 2014-05-20 17:46:08 -0700 | [diff] [blame] | 6171 | functions in the order they appear in the source, possibly in multiple files, |
| 6172 | as presented to the compiler. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 6173 | If a package has imports, the imported packages are initialized |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 6174 | before initializing the package itself. If multiple packages import |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6175 | a package, the imported package will be initialized only once. |
| 6176 | The importing of packages, by construction, guarantees that there |
| 6177 | can be no cyclic initialization dependencies. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6178 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6179 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6180 | <p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6181 | Package initialization—variable initialization and the invocation of |
| 6182 | <code>init</code> functions—happens in a single goroutine, |
| 6183 | sequentially, one package at a time. |
| 6184 | An <code>init</code> function may launch other goroutines, which can run |
| 6185 | concurrently with the initialization code. However, initialization |
| 6186 | always sequences |
| 6187 | the <code>init</code> functions: it will not invoke the next one |
| 6188 | until the previous one has returned. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6189 | </p> |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6190 | |
Robert Griesemer | 259f0ff | 2014-09-29 12:44:50 -0700 | [diff] [blame] | 6191 | <p> |
| 6192 | To ensure reproducible initialization behavior, build systems are encouraged |
| 6193 | to present multiple files belonging to the same package in lexical file name |
| 6194 | order to a compiler. |
| 6195 | </p> |
| 6196 | |
Robert Griesemer | a436698 | 2014-05-20 13:51:39 -0700 | [diff] [blame] | 6197 | |
| 6198 | <h3 id="Program_execution">Program execution</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6199 | <p> |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 6200 | A complete program is created by linking a single, unimported package |
| 6201 | called the <i>main package</i> with all the packages it imports, transitively. |
| 6202 | The main package must |
| 6203 | have package name <code>main</code> and |
Charles L. Dorian | 44262d1 | 2011-11-01 15:13:33 +0900 | [diff] [blame] | 6204 | declare a function <code>main</code> that takes no |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 6205 | arguments and returns no value. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6206 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 6207 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6208 | <pre> |
Robert Griesemer | 3c7271f | 2011-05-24 14:18:44 -0700 | [diff] [blame] | 6209 | func main() { … } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6210 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 6211 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 6212 | <p> |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 6213 | Program execution begins by initializing the main package and then |
| 6214 | invoking the function <code>main</code>. |
Robert Griesemer | 7f1d62d | 2014-05-19 08:54:19 -0700 | [diff] [blame] | 6215 | When that function invocation returns, the program exits. |
Russ Cox | a6736ca | 2011-02-03 13:40:51 -0500 | [diff] [blame] | 6216 | 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] | 6217 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6218 | |
Russ Cox | d9877e2 | 2011-11-01 21:45:02 -0400 | [diff] [blame] | 6219 | <h2 id="Errors">Errors</h2> |
| 6220 | |
| 6221 | <p> |
| 6222 | The predeclared type <code>error</code> is defined as |
| 6223 | </p> |
| 6224 | |
| 6225 | <pre> |
| 6226 | type error interface { |
| 6227 | Error() string |
| 6228 | } |
| 6229 | </pre> |
| 6230 | |
| 6231 | <p> |
| 6232 | It is the conventional interface for representing an error condition, |
| 6233 | with the nil value representing no error. |
| 6234 | For instance, a function to read data from a file might be defined: |
| 6235 | </p> |
| 6236 | |
| 6237 | <pre> |
| 6238 | func Read(f *File, b []byte) (n int, err error) |
| 6239 | </pre> |
| 6240 | |
Evan Shaw | 21110c7 | 2010-04-22 10:14:53 -0700 | [diff] [blame] | 6241 | <h2 id="Run_time_panics">Run-time panics</h2> |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 6242 | |
| 6243 | <p> |
| 6244 | Execution errors such as attempting to index an array out |
| 6245 | of bounds trigger a <i>run-time panic</i> equivalent to a call of |
| 6246 | the built-in function <a href="#Handling_panics"><code>panic</code></a> |
| 6247 | with a value of the implementation-defined interface type <code>runtime.Error</code>. |
Charles L. Dorian | 9a358df | 2011-12-08 22:27:14 -0500 | [diff] [blame] | 6248 | That type satisfies the predeclared interface type |
Russ Cox | d9877e2 | 2011-11-01 21:45:02 -0400 | [diff] [blame] | 6249 | <a href="#Errors"><code>error</code></a>. |
| 6250 | The exact error values that |
| 6251 | represent distinct run-time error conditions are unspecified. |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 6252 | </p> |
| 6253 | |
| 6254 | <pre> |
| 6255 | package runtime |
| 6256 | |
| 6257 | type Error interface { |
Russ Cox | d9877e2 | 2011-11-01 21:45:02 -0400 | [diff] [blame] | 6258 | error |
| 6259 | // and perhaps other methods |
Rob Pike | 5bb29fb | 2010-03-25 17:59:59 -0700 | [diff] [blame] | 6260 | } |
| 6261 | </pre> |
| 6262 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 6263 | <h2 id="System_considerations">System considerations</h2> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6264 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 6265 | <h3 id="Package_unsafe">Package <code>unsafe</code></h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6266 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6267 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 6268 | The built-in package <code>unsafe</code>, known to the compiler, |
| 6269 | provides facilities for low-level programming including operations |
| 6270 | that violate the type system. A package using <code>unsafe</code> |
Robert Griesemer | 5361b74 | 2014-10-23 09:45:11 -0700 | [diff] [blame] | 6271 | must be vetted manually for type safety and may not be portable. |
| 6272 | The package provides the following interface: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6273 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6274 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 6275 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6276 | package unsafe |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6277 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 6278 | type ArbitraryType int // shorthand for an arbitrary Go type; it is not a real type |
| 6279 | type Pointer *ArbitraryType |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6280 | |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 6281 | func Alignof(variable ArbitraryType) uintptr |
Hong Ruiqi | 8374e67 | 2012-04-05 22:37:07 +1000 | [diff] [blame] | 6282 | func Offsetof(selector ArbitraryType) uintptr |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 6283 | func Sizeof(variable ArbitraryType) uintptr |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6284 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6285 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6286 | <p> |
Robert Griesemer | e121de2 | 2013-10-07 10:43:28 -0700 | [diff] [blame] | 6287 | A <code>Pointer</code> is a <a href="#Pointer_types">pointer type</a> but a <code>Pointer</code> |
| 6288 | value may not be <a href="#Address_operators">dereferenced</a>. |
Robert Griesemer | 5361b74 | 2014-10-23 09:45:11 -0700 | [diff] [blame] | 6289 | Any pointer or value of <a href="#Types">underlying type</a> <code>uintptr</code> can be converted to |
| 6290 | a <code>Pointer</code> type and vice versa. |
| 6291 | The effect of converting between <code>Pointer</code> and <code>uintptr</code> is implementation-defined. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6292 | </p> |
Russ Cox | 81eb930 | 2013-02-09 17:36:31 -0500 | [diff] [blame] | 6293 | |
| 6294 | <pre> |
| 6295 | var f float64 |
| 6296 | bits = *(*uint64)(unsafe.Pointer(&f)) |
| 6297 | |
| 6298 | type ptr unsafe.Pointer |
| 6299 | bits = *(*uint64)(ptr(&f)) |
Robert Griesemer | e121de2 | 2013-10-07 10:43:28 -0700 | [diff] [blame] | 6300 | |
| 6301 | var p ptr = nil |
Russ Cox | 81eb930 | 2013-02-09 17:36:31 -0500 | [diff] [blame] | 6302 | </pre> |
| 6303 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6304 | <p> |
Robert Griesemer | c7631f5 | 2012-09-17 12:23:41 -0700 | [diff] [blame] | 6305 | The functions <code>Alignof</code> and <code>Sizeof</code> take an expression <code>x</code> |
| 6306 | of any type and return the alignment or size, respectively, of a hypothetical variable <code>v</code> |
| 6307 | as if <code>v</code> was declared via <code>var v = x</code>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6308 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6309 | <p> |
Robert Griesemer | 8c058b3 | 2012-09-18 11:25:53 -0700 | [diff] [blame] | 6310 | The function <code>Offsetof</code> takes a (possibly parenthesized) <a href="#Selectors">selector</a> |
Robert Griesemer | 5133809 | 2013-03-07 20:11:37 -0800 | [diff] [blame] | 6311 | <code>s.f</code>, denoting a field <code>f</code> of the struct denoted by <code>s</code> |
| 6312 | or <code>*s</code>, and returns the field offset in bytes relative to the struct's address. |
| 6313 | If <code>f</code> is an <a href="#Struct_types">embedded field</a>, it must be reachable |
| 6314 | without pointer indirections through fields of the struct. |
Rob Pike | 678625d | 2009-09-15 09:54:22 -0700 | [diff] [blame] | 6315 | For a struct <code>s</code> with field <code>f</code>: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6316 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6317 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6318 | <pre> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 6319 | 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] | 6320 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6321 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6322 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6323 | Computer architectures may require memory addresses to be <i>aligned</i>; |
| 6324 | that is, for addresses of a variable to be a multiple of a factor, |
| 6325 | the variable's type's <i>alignment</i>. The function <code>Alignof</code> |
| 6326 | takes an expression denoting a variable of any type and returns the |
| 6327 | alignment of the (type of the) variable in bytes. For a variable |
| 6328 | <code>x</code>: |
| 6329 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6330 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6331 | <pre> |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 6332 | uintptr(unsafe.Pointer(&x)) % unsafe.Alignof(x) == 0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6333 | </pre> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 6334 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6335 | <p> |
| 6336 | Calls to <code>Alignof</code>, <code>Offsetof</code>, and |
Robert Griesemer | eee70b0 | 2011-06-13 16:46:42 -0700 | [diff] [blame] | 6337 | <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] | 6338 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6339 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 6340 | <h3 id="Size_and_alignment_guarantees">Size and alignment guarantees</h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6341 | |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 6342 | <p> |
Robert Griesemer | 462a17e | 2013-03-22 15:36:04 -0700 | [diff] [blame] | 6343 | For the <a href="#Numeric_types">numeric types</a>, the following sizes are guaranteed: |
Robert Griesemer | 997851e | 2009-09-25 15:36:25 -0700 | [diff] [blame] | 6344 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6345 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 6346 | <pre class="grammar"> |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 6347 | type size in bytes |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6348 | |
Robert Griesemer | 777a96a | 2010-12-02 12:32:14 -0800 | [diff] [blame] | 6349 | byte, uint8, int8 1 |
| 6350 | uint16, int16 2 |
| 6351 | uint32, int32, float32 4 |
| 6352 | uint64, int64, float64, complex64 8 |
| 6353 | complex128 16 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6354 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6355 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6356 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6357 | The following minimal alignment properties are guaranteed: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 6358 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6359 | <ol> |
Robert Griesemer | dd916be | 2011-01-10 14:25:17 -0800 | [diff] [blame] | 6360 | <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] | 6361 | </li> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6362 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6363 | <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] | 6364 | 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] | 6365 | </li> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6366 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 6367 | <li>For a variable <code>x</code> of array type: <code>unsafe.Alignof(x)</code> is the same as |
| 6368 | <code>unsafe.Alignof(x[0])</code>, but at least 1. |
Robert Griesemer | 3af48037 | 2010-05-14 13:11:48 -0700 | [diff] [blame] | 6369 | </li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 6370 | </ol> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 6371 | |
Robert Griesemer | 1320ce0 | 2012-01-09 16:54:24 -0800 | [diff] [blame] | 6372 | <p> |
| 6373 | A struct or array type has size zero if it contains no fields (or elements, respectively) that have a size greater than zero. Two distinct zero-size variables may have the same address in memory. |
| 6374 | </p> |