Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2 | |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 3 | <!-- |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 4 | Open issues: |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 5 | [ ] Semantics of type declaration: |
| 6 | - creating a new type (status quo), or only a new type name? |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 7 | - declaration "type T S" strips methods of S. why/why not? |
| 8 | - no mechanism to declare a local type name: type T P.T |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 9 | |
Robert Griesemer | 3b576a7 | 2009-06-17 14:31:33 -0700 | [diff] [blame] | 10 | |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 11 | Todo's: |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 12 | [ ] need language about function/method calls and parameter passing rules |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 13 | [ ] need to say something about "scope" of selectors? |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 14 | [ ] clarify what a field name is in struct declarations |
| 15 | (struct{T} vs struct {T T} vs struct {t T}) |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 16 | [ ] need explicit language about the result type of operations |
| 17 | [ ] may want to have some examples for the types of shift operations |
Robert Griesemer | 9f4a27c | 2009-01-16 15:44:08 -0800 | [diff] [blame] | 18 | [ ] document illegality of package-external tuple assignments to structs |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 19 | w/ private fields: P.T(1, 2) illegal since same as P.T(a: 1, b: 2) for |
Robert Griesemer | 9f4a27c | 2009-01-16 15:44:08 -0800 | [diff] [blame] | 20 | a T struct { a b int }. |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 21 | [ ] should probably write something about evaluation order of statements even |
| 22 | though obvious |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 23 | [ ] specify iteration direction for range clause |
| 24 | [ ] review language on implicit dereferencing |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame] | 25 | [ ] document T.m mechanism to obtain a function from a method |
Robert Griesemer | c59d2f1 | 2008-09-09 10:48:14 -0700 | [diff] [blame] | 26 | --> |
| 27 | |
Robert Griesemer | 40d6bb5 | 2009-04-20 15:32:20 -0700 | [diff] [blame] | 28 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 29 | <h2 id="Introduction">Introduction</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 30 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 31 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 32 | This is a reference manual for the Go programming language. For |
| 33 | more information and other documents, see <a |
| 34 | href="/">the Go home page</a>. |
| 35 | </p> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 36 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 37 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 38 | Go is a general-purpose language designed with systems programming |
| 39 | in mind. It is strongly typed and garbage-collected, and has explicit |
| 40 | support for concurrent programming. Programs are constructed from |
| 41 | <i>packages</i>, whose properties allow efficient management of |
| 42 | dependencies. The existing implementations use a traditional |
| 43 | compile/link model to generate executable binaries. |
| 44 | </p> |
| 45 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 46 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 47 | The grammar is compact and regular, allowing for easy analysis by |
| 48 | automatic tools such as integrated development environments. |
| 49 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 50 | <hr/> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 51 | <h2 id="Notation">Notation</h2> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 52 | <p> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 53 | The syntax is specified using Extended Backus-Naur Form (EBNF): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 54 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 55 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 56 | <pre class="grammar"> |
Robert Griesemer | 88a0c40 | 2009-04-23 14:42:21 -0700 | [diff] [blame] | 57 | Production = production_name "=" Expression "." . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 58 | Expression = Alternative { "|" Alternative } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 59 | Alternative = Term { Term } . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 60 | Term = production_name | token [ "..." token ] | Group | Option | Repetition . |
| 61 | Group = "(" Expression ")" . |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 62 | Option = "[" Expression "]" . |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 63 | Repetition = "{" Expression "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 64 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 65 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 66 | <p> |
| 67 | Productions are expressions constructed from terms and the following |
| 68 | operators, in increasing precedence: |
| 69 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 70 | <pre class="grammar"> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 71 | | alternation |
| 72 | () grouping |
| 73 | [] option (0 or 1 times) |
| 74 | {} repetition (0 to n times) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 75 | </pre> |
Robert Griesemer | 4d23030 | 2008-12-17 15:39:15 -0800 | [diff] [blame] | 76 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 77 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 78 | Lower-case production names are used to identify lexical tokens. |
| 79 | Non-terminals are in CamelCase. Lexical symbols are enclosed in |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 80 | double <code>""</code> or back quotes <code>``</code>. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 81 | </p> |
| 82 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 83 | <p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 84 | The form <code>a ... b</code> represents the set of characters from |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 85 | <code>a</code> through <code>b</code> as alternatives. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 86 | </p> |
| 87 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 88 | <hr/> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 89 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 90 | <h2 id="Source_code_representation">Source code representation</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 91 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 92 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 93 | Source code is Unicode text encoded in UTF-8. The text is not |
| 94 | canonicalized, so a single accented code point is distinct from the |
| 95 | same character constructed from combining an accent and a letter; |
| 96 | those are treated as two code points. For simplicity, this document |
| 97 | will use the term <i>character</i> to refer to a Unicode code point. |
| 98 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 99 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 100 | Each code point is distinct; for instance, upper and lower case letters |
| 101 | are different characters. |
| 102 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 103 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 104 | <h3 id="Characters">Characters</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 105 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 106 | <p> |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 107 | The following terms are used to denote specific Unicode character classes: |
| 108 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 109 | <pre class="ebnf"> |
| 110 | unicode_char = /* an arbitrary Unicode code point */ . |
| 111 | unicode_letter = /* a Unicode code point classified as "Letter" */ . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 112 | unicode_digit = /* a Unicode code point classified as "Digit" */ . |
| 113 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 114 | |
Robert Griesemer | 83c1760 | 2009-01-16 14:12:50 -0800 | [diff] [blame] | 115 | (The Unicode Standard, Section 4.5 General Category - Normative.) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 116 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 117 | <h3 id="Letters_and_digits">Letters and digits</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 118 | |
| 119 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 120 | The underscore character <code>_</code> (U+005F) is considered a letter. |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 121 | </p> |
| 122 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 123 | letter = unicode_letter | "_" . |
| 124 | decimal_digit = "0" ... "9" . |
| 125 | octal_digit = "0" ... "7" . |
| 126 | hex_digit = "0" ... "9" | "A" ... "F" | "a" ... "f" . |
| 127 | </pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 128 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 129 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 130 | <h2 id="Lexical_elements">Lexical elements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 131 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 132 | <h3 id="Comments">Comments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 133 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 134 | <p> |
| 135 | There are two forms of comments. The first starts at the character |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 136 | sequence <code>//</code> and continues through the next newline. The |
| 137 | second starts at the character sequence <code>/*</code> and continues |
| 138 | through the character sequence <code>*/</code>. Comments do not nest. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 139 | </p> |
| 140 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 141 | <h3 id="Tokens">Tokens</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 142 | |
| 143 | <p> |
| 144 | Tokens form the vocabulary of the Go language. |
| 145 | There are four classes: identifiers, keywords, operators |
| 146 | and delimiters, and literals. <i>White space</i>, formed from |
| 147 | blanks, tabs, and newlines, is ignored except as it separates tokens |
| 148 | that would otherwise combine into a single token. Comments |
| 149 | behave as white space. While breaking the input into tokens, |
| 150 | the next token is the longest sequence of characters that form a |
| 151 | valid token. |
| 152 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 153 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 154 | <h3 id="Identifiers">Identifiers</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 155 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 156 | <p> |
| 157 | Identifiers name program entities such as variables and types. |
| 158 | An identifier is a sequence of one or more letters and digits. |
| 159 | The first character in an identifier must be a letter. |
| 160 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 161 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 162 | identifier = letter { letter | unicode_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 163 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 164 | <pre> |
| 165 | a |
| 166 | _x9 |
| 167 | ThisVariableIsExported |
| 168 | αβ |
| 169 | </pre> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 170 | Some identifiers are predeclared (§<a href="#Predeclared_identifiers">Predeclared identifiers</a>). |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 171 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 172 | <h3 id="Keywords">Keywords</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 173 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 174 | <p> |
| 175 | The following keywords are reserved and may not be used as identifiers. |
| 176 | </p> |
| 177 | <pre class="grammar"> |
| 178 | break default func interface select |
| 179 | case defer go map struct |
| 180 | chan else goto package switch |
| 181 | const fallthrough if range type |
| 182 | continue for import return var |
| 183 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 184 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 185 | <h3 id="Operators_and_Delimiters">Operators and Delimiters</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 186 | |
| 187 | <p> |
| 188 | The following character sequences represent operators, delimiters, and other special tokens: |
| 189 | </p> |
| 190 | <pre class="grammar"> |
| 191 | + & += &= && == != ( ) |
| 192 | - | -= |= || < <= [ ] |
| 193 | * ^ *= ^= <- > >= { } |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 194 | / << /= <<= ++ = := , ; |
| 195 | % >> %= >>= -- ! ... . : |
Rob Pike | cd04ec9 | 2009-03-11 21:59:05 -0700 | [diff] [blame] | 196 | &^ &^= |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 197 | </pre> |
| 198 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 199 | <h3 id="Integer_literals">Integer literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 200 | |
| 201 | <p> |
| 202 | An integer literal is a sequence of one or more digits in the |
| 203 | corresponding base, which may be 8, 10, or 16. An optional prefix |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 204 | sets a non-decimal base: <code>0</code> for octal, <code>0x</code> or |
| 205 | <code>0X</code> for hexadecimal. In hexadecimal literals, letters |
| 206 | <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] | 207 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 208 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 209 | int_lit = decimal_lit | octal_lit | hex_lit . |
| 210 | decimal_lit = ( "1" ... "9" ) { decimal_digit } . |
| 211 | octal_lit = "0" { octal_digit } . |
| 212 | hex_lit = "0" ( "x" | "X" ) hex_digit { hex_digit } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 213 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 214 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 215 | <pre> |
| 216 | 42 |
| 217 | 0600 |
| 218 | 0xBadFace |
| 219 | 170141183460469231731687303715884105727 |
| 220 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 221 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 222 | <h3 id="Floating-point_literals">Floating-point literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 223 | <p> |
| 224 | A floating-point literal is a decimal representation of a floating-point |
| 225 | number. It has an integer part, a decimal point, a fractional part, |
| 226 | and an exponent part. The integer and fractional part comprise |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 227 | 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] | 228 | followed by an optionally signed decimal exponent. One of the |
| 229 | integer part or the fractional part may be elided; one of the decimal |
| 230 | point or the exponent may be elided. |
| 231 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 232 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 233 | float_lit = decimals "." [ decimals ] [ exponent ] | |
| 234 | decimals exponent | |
| 235 | "." decimals [ exponent ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 236 | decimals = decimal_digit { decimal_digit } . |
| 237 | exponent = ( "e" | "E" ) [ "+" | "-" ] decimals . |
| 238 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 239 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 240 | <pre> |
| 241 | 0. |
| 242 | 2.71828 |
| 243 | 1.e+0 |
| 244 | 6.67428e-11 |
| 245 | 1E6 |
| 246 | .25 |
| 247 | .12345E+5 |
| 248 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 249 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 250 | <h3 id="Ideal_numbers">Ideal numbers</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 251 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 252 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 253 | Integer literals represent values of arbitrary precision, or <i>ideal |
| 254 | integers</i>. Similarly, floating-point literals represent values |
| 255 | of arbitrary precision, or <i>ideal floats</i>. These <i>ideal |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 256 | numbers</i> have no size or named type and cannot overflow. However, |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 257 | when (used in an expression) assigned to a variable or typed constant, |
| 258 | the destination must be able to represent the assigned value. |
| 259 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 260 | <p> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 261 | Implementation restriction: A compiler may implement ideal numbers |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 262 | by choosing an internal representation with at least twice the precision |
| 263 | of any machine type. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 264 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 265 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 266 | <h3 id="Character_literals">Character literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 267 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 268 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 269 | A character literal represents an integer value, typically a |
| 270 | Unicode code point, as one or more characters enclosed in single |
| 271 | quotes. Within the quotes, any character may appear except single |
| 272 | quote and newline. A single quoted character represents itself, |
| 273 | while multi-character sequences beginning with a backslash encode |
| 274 | values in various formats. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 275 | </p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 276 | <p> |
| 277 | The simplest form represents the single character within the quotes; |
| 278 | since Go source text is Unicode characters encoded in UTF-8, multiple |
| 279 | UTF-8-encoded bytes may represent a single integer value. For |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 280 | instance, the literal <code>'a'</code> holds a single byte representing |
| 281 | a literal <code>a</code>, Unicode U+0061, value <code>0x61</code>, while |
| 282 | <code>'ä'</code> holds two bytes (<code>0xc3</code> <code>0xa4</code>) representing |
| 283 | a literal <code>a</code>-dieresis, U+00E4, value <code>0xe4</code>. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 284 | </p> |
| 285 | <p> |
| 286 | Several backslash escapes allow arbitrary values to be represented |
| 287 | as ASCII text. There are four ways to represent the integer value |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 288 | as a numeric constant: <code>\x</code> followed by exactly two hexadecimal |
| 289 | digits; <code>\u</code> followed by exactly four hexadecimal digits; |
| 290 | <code>\U</code> followed by exactly eight hexadecimal digits, and a |
| 291 | plain backslash <code>\</code> followed by exactly three octal digits. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 292 | In each case the value of the literal is the value represented by |
| 293 | the digits in the corresponding base. |
| 294 | </p> |
| 295 | <p> |
| 296 | Although these representations all result in an integer, they have |
| 297 | different valid ranges. Octal escapes must represent a value between |
| 298 | 0 and 255 inclusive. (Hexadecimal escapes satisfy this condition |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 299 | by construction). The `Unicode' escapes <code>\u</code> and <code>\U</code> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 300 | represent Unicode code points so within them some values are illegal, |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 301 | in particular those above <code>0x10FFFF</code> and surrogate halves. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 302 | </p> |
| 303 | <p> |
| 304 | After a backslash, certain single-character escapes represent special values: |
| 305 | </p> |
| 306 | <pre class="grammar"> |
| 307 | \a U+0007 alert or bell |
| 308 | \b U+0008 backspace |
| 309 | \f U+000C form feed |
| 310 | \n U+000A line feed or newline |
| 311 | \r U+000D carriage return |
| 312 | \t U+0009 horizontal tab |
| 313 | \v U+000b vertical tab |
| 314 | \\ U+005c backslash |
| 315 | \' U+0027 single quote (valid escape only within character literals) |
| 316 | \" U+0022 double quote (valid escape only within string literals) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 317 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 318 | <p> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 319 | All other sequences are illegal inside character literals. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 320 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 321 | <pre class="ebnf"> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 322 | char_lit = "'" ( unicode_value | byte_value ) "'" . |
| 323 | unicode_value = unicode_char | little_u_value | big_u_value | escaped_char . |
| 324 | byte_value = octal_byte_value | hex_byte_value . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 325 | octal_byte_value = `\` octal_digit octal_digit octal_digit . |
| 326 | hex_byte_value = `\` "x" hex_digit hex_digit . |
| 327 | little_u_value = `\` "u" hex_digit hex_digit hex_digit hex_digit . |
| 328 | big_u_value = `\` "U" hex_digit hex_digit hex_digit hex_digit |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 329 | hex_digit hex_digit hex_digit hex_digit . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 330 | escaped_char = `\` ( "a" | "b" | "f" | "n" | "r" | "t" | "v" | `\` | "'" | `"` ) . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 331 | </pre> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 332 | <pre> |
| 333 | 'a' |
| 334 | 'ä' |
| 335 | '本' |
| 336 | '\t' |
| 337 | '\000' |
| 338 | '\007' |
| 339 | '\377' |
| 340 | '\x07' |
| 341 | '\xff' |
| 342 | '\u12e4' |
| 343 | '\U00101234' |
| 344 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 345 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 346 | <p> |
| 347 | The value of a character literal is an ideal integer, just as with |
| 348 | integer literals. |
| 349 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 350 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 351 | <h3 id="String_literals">String literals</h3> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 352 | |
| 353 | <p> |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 354 | String literals represent <i>ideal string</i> values. Ideal strings do not |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 355 | have a named type but they are compatible with type <code>string</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 356 | (§<a href="#Type_identity_and_compatibility">Type identity and compatibility</a>). |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 357 | There are two forms: raw string literals and interpreted string |
| 358 | literals. |
| 359 | </p> |
| 360 | <p> |
| 361 | Raw string literals are character sequences between back quotes |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 362 | <code>``</code>. Within the quotes, any character is legal except |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 363 | back quote. The value of a raw string literal is the |
| 364 | string composed of the uninterpreted characters between the quotes; |
| 365 | in particular, backslashes have no special meaning and the string may |
| 366 | span multiple lines. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 367 | </p> |
| 368 | <p> |
| 369 | Interpreted string literals are character sequences between double |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 370 | quotes <code>""</code>. The text between the quotes forms the |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 371 | value of the literal, with backslash escapes interpreted as they |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 372 | are in character literals (except that <code>\'</code> is illegal and |
| 373 | <code>\"</code> is legal). The three-digit octal (<code>\000</code>) |
| 374 | and two-digit hexadecimal (<code>\x00</code>) escapes represent individual |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 375 | <i>bytes</i> of the resulting string; all other escapes represent |
| 376 | the (possibly multi-byte) UTF-8 encoding of individual <i>characters</i>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 377 | Thus inside a string literal <code>\377</code> and <code>\xFF</code> represent |
| 378 | a single byte of value <code>0xFF</code>=255, while <code>ÿ</code>, |
| 379 | <code>\u00FF</code>, <code>\U000000FF</code> and <code>\xc3\xbf</code> represent |
| 380 | the two bytes <code>0xc3 0xbf</code> of the UTF-8 encoding of character |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 381 | U+00FF. |
| 382 | </p> |
| 383 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 384 | <p> |
| 385 | A sequence of string literals is concatenated to form a single string. |
| 386 | </p> |
| 387 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 388 | <pre class="ebnf"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 389 | StringLit = string_lit { string_lit } . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 390 | string_lit = raw_string_lit | interpreted_string_lit . |
| 391 | raw_string_lit = "`" { unicode_char } "`" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 392 | interpreted_string_lit = """ { unicode_value | byte_value } """ . |
| 393 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 394 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 395 | <pre> |
Robert Griesemer | db7a622 | 2009-06-18 13:51:14 -0700 | [diff] [blame] | 396 | `abc` // same as "abc" |
| 397 | `\n |
| 398 | \n` // same as "\\n\n\\n" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 399 | "\n" |
| 400 | "" |
| 401 | "Hello, world!\n" |
| 402 | "日本語" |
| 403 | "\u65e5本\U00008a9e" |
| 404 | "\xff\u00FF" |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 405 | "Alea iacta est." |
| 406 | "Alea " /* The die */ `iacta est` /* is cast */ "." // same as "Alea iacta est." |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 407 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 408 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 409 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 410 | These examples all represent the same string: |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 411 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 412 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 413 | <pre> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 414 | "日本語" // UTF-8 input text |
| 415 | `日本語` // UTF-8 input text as a raw literal |
| 416 | "\u65e5\u672c\u8a9e" // The explicit Unicode code points |
| 417 | "\U000065e5\U0000672c\U00008a9e" // The explicit Unicode code points |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 418 | "\xe6\x97\xa5\xe6\x9c\xac\xe8\xaa\x9e" // The explicit UTF-8 bytes |
| 419 | </pre> |
Robert Griesemer | cd49927 | 2008-09-29 12:09:00 -0700 | [diff] [blame] | 420 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 421 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 422 | If the source code represents a character as two code points, such as |
| 423 | a combining form involving an accent and a letter, the result will be |
| 424 | an error if placed in a character literal (it is not a single code |
| 425 | point), and will appear as two code points if placed in a string |
| 426 | literal. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 427 | </p> |
| 428 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 429 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 430 | <h2 id="Types">Types</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 431 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 432 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 433 | A type determines the set of values and operations specific to values of that |
| 434 | type. A type may be specified by a (possibly qualified) <i>type name</i> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 435 | (§<a href="#Qualified_identifier">Qualified identifier</a>, §<a href="#Type_declarations">Type declarations</a>) or a <i>type literal</i>, |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 436 | which composes a new type from previously declared types. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 437 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 438 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 439 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 440 | Type = TypeName | TypeLit | "(" Type ")" . |
| 441 | TypeName = QualifiedIdent. |
| 442 | TypeLit = ArrayType | StructType | PointerType | FunctionType | InterfaceType | |
| 443 | SliceType | MapType | ChannelType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 444 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 445 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 446 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 447 | <i>Basic types</i> such as <code>int</code> are predeclared (§<a href="#Predeclared_identifiers">Predeclared identifiers</a>). |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 448 | Other types may be constructed from these, recursively, |
| 449 | including arrays, structs, pointers, functions, interfaces, slices, maps, and |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 450 | channels. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 451 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 452 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 453 | <p> |
Robert Griesemer | 3b576a7 | 2009-06-17 14:31:33 -0700 | [diff] [blame] | 454 | A type may have a <i>method set</i> associated with it |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 455 | (§<a href="#Interface_types">Interface types</a>, §<a href="#Method_declarations">Method declarations</a>). |
| 456 | The method set of an interface type (§<a href="#Interface_types">Interface types</a>) is its interface. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 457 | The method set of any other named type <code>T</code> |
| 458 | consists of all methods with receiver |
| 459 | type <code>T</code>. |
| 460 | The method set of the corresponding pointer type <code>*T</code> |
| 461 | is the set of all methods with receiver <code>*T</code> or <code>T</code> |
| 462 | (that is, it also contains the method set of <code>T</code>). |
| 463 | Any other type has an empty method set. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 464 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 465 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 466 | The <i>static type</i> (or just <i>type</i>) of a variable is the |
| 467 | type defined by its declaration. Variables of interface type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 468 | (§<a href="#Interface_types">Interface types</a>) also have a distinct <i>dynamic type</i>, which |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 469 | is the actual type of the value stored in the variable at run-time. |
| 470 | The dynamic type may vary during execution but is always compatible |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 471 | with the static type of the interface variable. For non-interface |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 472 | types, the dynamic type is always the static type. |
| 473 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 474 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 475 | <h3 id="Basic_types">Basic types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 476 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 477 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 478 | Basic types include traditional numeric types, booleans, and strings. All are predeclared. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 479 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 480 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 481 | <h3 id="Numeric_types">Numeric types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 482 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 483 | <p> |
| 484 | The architecture-independent numeric types are: |
| 485 | </p> |
Robert Griesemer | ebf14c6 | 2008-10-30 14:50:23 -0700 | [diff] [blame] | 486 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 487 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 488 | uint8 the set of all unsigned 8-bit integers (0 to 255) |
| 489 | uint16 the set of all unsigned 16-bit integers (0 to 65535) |
| 490 | uint32 the set of all unsigned 32-bit integers (0 to 4294967295) |
| 491 | uint64 the set of all unsigned 64-bit integers (0 to 18446744073709551615) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 492 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 493 | int8 the set of all signed 8-bit integers (-128 to 127) |
| 494 | int16 the set of all signed 16-bit integers (-32768 to 32767) |
| 495 | int32 the set of all signed 32-bit integers (-2147483648 to 2147483647) |
| 496 | int64 the set of all signed 64-bit integers (-9223372036854775808 to 9223372036854775807) |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 497 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 498 | float32 the set of all valid IEEE-754 32-bit floating point numbers |
| 499 | float64 the set of all valid IEEE-754 64-bit floating point numbers |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 500 | |
| 501 | byte familiar alias for uint8 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 502 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 503 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 504 | <p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 505 | Integer types are represented in the usual binary format; the value of |
| 506 | an n-bit integer is n bits wide. A negative signed integer is represented |
| 507 | as the two's complement of its absolute value. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 508 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 509 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 510 | <p> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 511 | There is also a set of numeric types with implementation-specific sizes: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 512 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 513 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 514 | <pre class="grammar"> |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 515 | uint either 32 or 64 bits |
| 516 | int either 32 or 64 bits |
| 517 | float either 32 or 64 bits |
| 518 | 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] | 519 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 520 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 521 | <p> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 522 | To avoid portability issues all numeric types are distinct except |
| 523 | <code>byte</code>, which is an alias for <code>uint8</code>. |
| 524 | Conversions |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 525 | are required when incompatible numeric types are mixed in an expression |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 526 | or assignment. For instance, <code>int32</code> and <code>int</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 527 | 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] | 528 | particular architecture. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 529 | |
| 530 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 531 | <h3 id="Booleans">Booleans</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 532 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 533 | The type <code>bool</code> comprises the Boolean truth values |
| 534 | represented by the predeclared constants <code>true</code> |
| 535 | and <code>false</code>. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 536 | |
| 537 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 538 | <h3 id="Strings">Strings</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 539 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 540 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 541 | The <code>string</code> type represents the set of string values. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 542 | Strings behave like arrays of bytes but are immutable: once created, |
| 543 | it is impossible to change the contents of a string. |
| 544 | |
| 545 | <p> |
| 546 | The elements of strings have type <code>byte</code> and may be |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 547 | accessed using the usual indexing operations (§<a href="#Indexes">Indexes</a>). It is |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 548 | illegal to take the address of such an element, that is, even if |
| 549 | <code>s[i]</code> is the <code>i</code><sup>th</sup> byte of a |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 550 | string, <code>&s[i]</code> is invalid. The length of string |
| 551 | <code>s</code> can be discovered using the built-in function |
| 552 | <code>len(s)</code>. It is a compile-time constant if <code>s</code> |
| 553 | is a string literal. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 554 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 555 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 556 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 557 | <h3 id="Array_types">Array types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 558 | |
| 559 | <p> |
| 560 | An array is a numbered sequence of elements of a single |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 561 | type, called the element type. |
| 562 | The number of elements is called the length and is never |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 563 | negative. |
| 564 | </p> |
| 565 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 566 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 567 | ArrayType = "[" ArrayLength "]" ElementType . |
| 568 | ArrayLength = Expression . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 569 | ElementType = Type . |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 570 | </pre> |
| 571 | |
| 572 | <p> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 573 | The length is part of the array's type and must must be a |
| 574 | <a href="#Constant_expressions">constant expression</a> that evaluates to a non-negative |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 575 | integer value. The length of array <code>a</code> can be discovered |
| 576 | using the built-in function <code>len(a)</code>, which is a |
| 577 | compile-time constant. The elements can be indexed by integer |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 578 | indices 0 through the <code>len(a)-1</code> (§<a href="#Indexes">Indexes</a>). |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 579 | </p> |
| 580 | |
| 581 | <pre> |
| 582 | [32]byte |
| 583 | [2*N] struct { x, y int32 } |
| 584 | [1000]*float64 |
| 585 | </pre> |
| 586 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 587 | <h3 id="Slice_types">Slice types</h3> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 588 | |
| 589 | <p> |
| 590 | A slice is a reference to a contiguous segment of an array and |
| 591 | contains a numbered sequence of elements from that array. A slice |
| 592 | type denotes the set of all slices of arrays of its element type. |
| 593 | A slice value may be <code>nil</code>. |
| 594 | </p> |
| 595 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 596 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 597 | SliceType = "[" "]" ElementType . |
| 598 | </pre> |
| 599 | |
| 600 | <p> |
| 601 | Like arrays, slices are indexable and have a length. The length of a |
| 602 | slice <code>s</code> can be discovered by the built-in function |
| 603 | <code>len(s)</code>; unlike with arrays it may change during |
| 604 | execution. The elements can be addressed by integer indices 0 |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 605 | through <code>len(s)-1</code> (§<a href="#Indexes">Indexes</a>). The slice index of a |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 606 | given element may be less than the index of the same element in the |
| 607 | underlying array. |
| 608 | </p> |
| 609 | <p> |
| 610 | A slice, once initialized, is always associated with an underlying |
| 611 | array that holds its elements. A slice therfore shares storage |
| 612 | with its array and with other slices of the same array; by contrast, |
| 613 | distinct arrays always represent distinct storage. |
| 614 | </p> |
| 615 | <p> |
| 616 | 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] | 617 | 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] | 618 | the length of the slice and the length of the array beyond the slice; |
| 619 | a slice of length up to that capacity can be created by `slicing' a new |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 620 | one from the original slice (§<a href="#Slices">Slices</a>). |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 621 | The capacity of a slice <code>a</code> can be discovered using the |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 622 | built-in function <code>cap(a)</code> and the relationship between |
| 623 | <code>len()</code> and <code>cap()</code> is: |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 624 | </p> |
| 625 | |
| 626 | <pre> |
| 627 | 0 <= len(a) <= cap(a) |
| 628 | </pre> |
| 629 | |
| 630 | <p> |
| 631 | The value of an uninitialized slice is <code>nil</code>. |
| 632 | The length and capacity of a <code>nil</code> slice |
| 633 | are 0. A new, initialized slice value for a given element type <code>T</code> is |
| 634 | made using the built-in function <code>make</code>, which takes a slice type |
| 635 | and parameters specifying the length and optionally the capacity: |
| 636 | </p> |
| 637 | |
| 638 | <pre> |
| 639 | make([]T, length) |
| 640 | make([]T, length, capacity) |
| 641 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 642 | |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 643 | <p> |
| 644 | The <code>make()</code> call allocates a new, hidden array to which the returned |
| 645 | slice value refers. That is, calling <code>make</code> |
| 646 | </p> |
| 647 | |
| 648 | <pre> |
| 649 | make([]T, length, capacity) |
| 650 | </pre> |
| 651 | |
| 652 | <p> |
| 653 | produces the same slice as allocating an array and slicing it, so these two examples |
| 654 | result in the same slice: |
| 655 | </p> |
| 656 | |
| 657 | <pre> |
| 658 | make([]int, 50, 100) |
| 659 | new([100]int)[0:50] |
| 660 | </pre> |
| 661 | |
| 662 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 663 | <h3 id="Struct_types">Struct types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 664 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 665 | <p> |
| 666 | A struct is a sequence of named |
| 667 | elements, called fields, with various types. A struct type declares |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 668 | an identifier and type for each field. Within a struct, field identifiers |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 669 | must be unique. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 670 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 671 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 672 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 673 | StructType = "struct" "{" [ FieldDeclList ] "}" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 674 | FieldDeclList = FieldDecl { ";" FieldDecl } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 675 | FieldDecl = (IdentifierList Type | [ "*" ] TypeName) [ Tag ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 676 | Tag = StringLit . |
| 677 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 678 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 679 | <pre> |
| 680 | // An empty struct. |
| 681 | struct {} |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 682 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 683 | // A struct with 5 fields. |
| 684 | struct { |
| 685 | x, y int; |
| 686 | u float; |
| 687 | A *[]int; |
| 688 | F func(); |
| 689 | } |
| 690 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 691 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 692 | <p> |
| 693 | A field declared with a type but no field identifier is an <i>anonymous field</i>. |
| 694 | Such a field type must be specified as |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 695 | a type name <code>T</code> or as a pointer to a type name <code>*T</code>, |
Ian Lance Taylor | 3e804ba | 2009-08-17 11:40:57 -0700 | [diff] [blame] | 696 | and <code>T</code> itself may not be |
| 697 | a pointer type. The unqualified type name acts as the field identifier. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 698 | </p> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 699 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 700 | <pre> |
| 701 | // A struct with four anonymous fields of type T1, *T2, P.T3 and *P.T4 |
| 702 | struct { |
| 703 | T1; // the field name is T1 |
| 704 | *T2; // the field name is T2 |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 705 | P.T3; // the field name is T3 |
| 706 | *P.T4; // the field name is T4 |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 707 | x, y int; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 708 | } |
| 709 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 710 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 711 | <p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 712 | The unqualified type name of an anonymous field must not conflict with the |
| 713 | field identifier (or unqualified type name for an anonymous field) of any |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 714 | other field within the struct. The following declaration is illegal: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 715 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 716 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 717 | <pre> |
| 718 | struct { |
| 719 | T; // conflicts with anonymous field *T and *P.T |
| 720 | *T; // conflicts with anonymous field T and *P.T |
| 721 | *P.T; // conflicts with anonymous field T and *T |
| 722 | } |
| 723 | </pre> |
Robert Griesemer | 1f3e842 | 2008-09-29 18:41:30 -0700 | [diff] [blame] | 724 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 725 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 726 | Fields and methods (§<a href="#Method_declarations">Method declarations</a>) of an anonymous field are |
| 727 | promoted to be ordinary fields and methods of the struct (§<a href="#Selectors">Selectors</a>). |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 728 | The following rules apply for a struct type named <code>S</code> and |
| 729 | a type named <code>T</code>: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 730 | </p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 731 | <ul> |
| 732 | <li>If <code>S</code> contains an anonymous field <code>T</code>, the |
| 733 | method set of <code>S</code> includes the method set of <code>T</code>. |
| 734 | </li> |
| 735 | |
| 736 | <li>If <code>S</code> contains an anonymous field <code>*T</code>, the |
| 737 | method set of <code>S</code> includes the method set of <code>*T</code> |
| 738 | (which itself includes the method set of <code>T</code>). |
| 739 | </li> |
| 740 | |
| 741 | <li>If <code>S</code> contains an anonymous field <code>T</code> or |
| 742 | <code>*T</code>, the method set of <code>*S</code> includes the |
| 743 | method set of <code>*T</code> (which itself includes the method |
| 744 | set of <code>T</code>). |
| 745 | </li> |
| 746 | </ul> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 747 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 748 | A field declaration may be followed by an optional string literal <i>tag</i>, |
| 749 | which becomes an attribute for all the identifiers in the corresponding |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 750 | field declaration. The tags are made |
| 751 | visible through a reflection library (TODO: reference?) |
| 752 | but are otherwise ignored. |
| 753 | </p> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 754 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 755 | <pre> |
| 756 | // A struct corresponding to the EventIdMessage protocol buffer. |
Rob Pike | cdbf619 | 2009-02-24 17:47:45 -0800 | [diff] [blame] | 757 | // The tag strings define the protocol buffer field numbers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 758 | struct { |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 759 | time_usec uint64 "field 1"; |
| 760 | server_ip uint32 "field 2"; |
| 761 | process_id uint32 "field 3"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 762 | } |
| 763 | </pre> |
Robert Griesemer | 2e90e54 | 2008-10-30 15:52:37 -0700 | [diff] [blame] | 764 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 765 | <h3 id="Pointer_types">Pointer 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 | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 768 | A pointer type denotes the set of all pointers to variables of a given |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 769 | type, called the <i>base type</i> of the pointer. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 770 | A pointer value may be <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 771 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 772 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 773 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 774 | PointerType = "*" BaseType . |
| 775 | BaseType = Type . |
| 776 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 777 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 778 | <pre> |
| 779 | *int |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 780 | *map[string] *chan int |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 781 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 782 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 783 | <h3 id="Function_types">Function types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 784 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 785 | <p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 786 | A function type denotes the set of all functions with the same parameter |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 787 | and result types. |
| 788 | A function value may be <code>nil</code>. |
| 789 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 790 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 791 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 792 | FunctionType = "func" Signature . |
| 793 | Signature = Parameters [ Result ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 794 | Result = Parameters | Type . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 795 | Parameters = "(" [ ParameterList ] ")" . |
| 796 | ParameterList = ParameterDecl { "," ParameterDecl } . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 797 | ParameterDecl = [ IdentifierList ] ( Type | "..." ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 798 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 799 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 800 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 801 | Within a list of parameters or results, the names (IdentifierList) |
| 802 | must either all be present or all be absent. If present, each name |
| 803 | stands for one item (parameter or result) of the specified type; if absent, each |
| 804 | type stands for one item of that type. Parameter and result |
| 805 | lists are always parenthesized except that if there is exactly |
| 806 | one unnamed result that is not a function type it may writen as an unparenthesized type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 807 | </p> |
| 808 | <p> |
| 809 | For the last parameter only, instead of a type one may write |
| 810 | <code>...</code> to indicate that the function may be invoked with |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 811 | zero or more additional arguments of any |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 812 | type. If parameters of such a function are named, the final identifier |
| 813 | list must be a single name, that of the <code>...</code> parameter. |
| 814 | </p> |
Robert Griesemer | 2bfa957 | 2008-10-24 13:13:12 -0700 | [diff] [blame] | 815 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 816 | <pre> |
| 817 | func () |
| 818 | func (x int) |
| 819 | func () int |
| 820 | func (string, float, ...) |
| 821 | func (a, b int, z float) bool |
| 822 | func (a, b int, z float) (bool) |
| 823 | func (a, b int, z float, opt ...) (success bool) |
| 824 | func (int, int, float) (float, *[]int) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 825 | func (n int) (func (p* T)) |
| 826 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 827 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 828 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 829 | <h3 id="Interface_types">Interface types</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 830 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 831 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 832 | An interface type specifies a method set called its <i>interface</i>. |
| 833 | A variable of interface type can store a value of any type with a method set |
| 834 | that is any superset of the interface. Such a type is said to |
| 835 | <i>implement the interface</i>. An interface value may be <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 836 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 837 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 838 | <pre class="ebnf"> |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 839 | InterfaceType = "interface" "{" [ MethodSpecList ] "}" . |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 840 | MethodSpecList = MethodSpec { ";" MethodSpec } [ ";" ] . |
| 841 | MethodSpec = IdentifierList Signature | InterfaceTypeName . |
| 842 | InterfaceTypeName = TypeName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 843 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 844 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 845 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 846 | // A simple File interface |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 847 | interface { |
| 848 | Read, Write (b Buffer) bool; |
| 849 | Close (); |
| 850 | } |
| 851 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 852 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 853 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 854 | More than one type may implement an interface. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 855 | For instance, if two types <code>S1</code> and <code>S2</code> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 856 | have the method set |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 857 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 858 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 859 | <pre> |
| 860 | func (p T) Read(b Buffer) bool { return ... } |
| 861 | func (p T) Write(b Buffer) bool { return ... } |
| 862 | func (p T) Close() { ... } |
| 863 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 864 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 865 | <p> |
| 866 | (where <code>T</code> stands for either <code>S1</code> or <code>S2</code>) |
| 867 | then the <code>File</code> interface is implemented by both <code>S1</code> and |
| 868 | <code>S2</code>, regardless of what other methods |
| 869 | <code>S1</code> and <code>S2</code> may have or share. |
| 870 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 871 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 872 | <p> |
| 873 | A type implements any interface comprising any subset of its methods |
| 874 | and may therefore implement several distinct interfaces. For |
| 875 | instance, all types implement the <i>empty interface</i>: |
| 876 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 877 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 878 | <pre> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 879 | interface { } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 880 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 881 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 882 | <p> |
| 883 | Similarly, consider this interface specification, |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 884 | which appears within a <a href="#Type_declarations">type declaration</a> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 885 | to define an interface called <code>Lock</code>: |
| 886 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 887 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 888 | <pre> |
| 889 | type Lock interface { |
| 890 | Lock, Unlock (); |
| 891 | } |
| 892 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 893 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 894 | <p> |
| 895 | If <code>S1</code> and <code>S2</code> also implement |
| 896 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 897 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 898 | <pre> |
| 899 | func (p T) Lock() { ... } |
| 900 | func (p T) Unlock() { ... } |
| 901 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 902 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 903 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 904 | they implement the <code>Lock</code> interface as well |
| 905 | as the <code>File</code> interface. |
| 906 | </p> |
| 907 | <p> |
| 908 | An interface may contain an interface type name <code>T</code> |
| 909 | in place of a method specification. |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 910 | In this notation, <code>T</code> must denote a different interface type |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 911 | and the effect is equivalent to enumerating the methods of <code>T</code> explicitly |
| 912 | in the interface. |
| 913 | </p> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 914 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 915 | <pre> |
| 916 | type ReadWrite interface { |
| 917 | Read, Write (b Buffer) bool; |
| 918 | } |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 919 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 920 | type File interface { |
| 921 | ReadWrite; // same as enumerating the methods in ReadWrite |
| 922 | Lock; // same as enumerating the methods in Lock |
| 923 | Close(); |
| 924 | } |
| 925 | </pre> |
Robert Griesemer | 38c232f | 2009-02-11 15:09:15 -0800 | [diff] [blame] | 926 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 927 | <h3 id="Map_types">Map types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 928 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 929 | <p> |
| 930 | A map is an unordered group of elements of one type, called the |
| 931 | value type, indexed by a set of unique <i>keys</i> of another type, |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 932 | called the key type. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 933 | A map value may be <code>nil</code>. |
| 934 | |
| 935 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 936 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 937 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 938 | MapType = "map" "[" KeyType "]" ValueType . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 939 | KeyType = Type . |
| 940 | ValueType = Type . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 941 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 942 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 943 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 944 | The comparison operators <code>==</code> and <code>!=</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 945 | (§<a href="#Comparison_operators">Comparison operators</a>) must be fully defined for operands of the |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 946 | key type; thus the key type must be a basic, pointer, interface, |
| 947 | map, or channel type. If the key type is an interface type, these |
| 948 | comparison operators must be defined for the dynamic key values; |
| 949 | failure will cause a run-time error. |
| 950 | |
| 951 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 952 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 953 | <pre> |
| 954 | map [string] int |
| 955 | map [*T] struct { x, y float } |
| 956 | map [string] interface {} |
| 957 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 958 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 959 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 960 | The number of elements is called the length and is never negative. |
| 961 | The length of a map <code>m</code> can be discovered using the |
| 962 | built-in function <code>len(m)</code> and may change during execution. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 963 | The value of an uninitialized map is <code>nil</code>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 964 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 965 | <p> |
| 966 | Upon creation, a map is empty. Values may be added and removed |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 967 | during execution using special forms of assignment (§<a href="#Assignments">Assignments</a>). |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 968 | A new, empty map value is made using the built-in |
| 969 | function <code>make</code>, which takes the map type and an optional |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 970 | capacity hint as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 971 | </p> |
| 972 | |
| 973 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 974 | make(map[string] int) |
| 975 | make(map[string] int, 100) |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 976 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 977 | |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 978 | <p> |
| 979 | The initial capacity does not bound its size: |
| 980 | maps grow to accommodate the number of items |
| 981 | stored in them. |
| 982 | </p> |
| 983 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 984 | <h3 id="Channel_types">Channel types</h3> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 985 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 986 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 987 | A channel provides a mechanism for two concurrently executing functions |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 988 | to synchronize execution and communicate by passing a value of a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 989 | specified element type. |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 990 | A value of channel type may be <code>nil</code>. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 991 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 992 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 993 | <pre class="ebnf"> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 994 | ChannelType = Channel | SendChannel | RecvChannel . |
| 995 | Channel = "chan" ValueType . |
| 996 | SendChannel = "chan" "<-" ValueType . |
| 997 | RecvChannel = "<-" "chan" ValueType . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 998 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 999 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1000 | <p> |
| 1001 | Upon creation, a channel can be used both to send and to receive values. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1002 | By conversion or assignment, a channel may be constrained only to send or |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1003 | to receive. This constraint is called a channel's <i>direction</i>; either |
| 1004 | <i>send</i>, <i>receive</i>, or <i>bi-directional</i> (unconstrained). |
| 1005 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1006 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1007 | <pre> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 1008 | chan T // can be used to send and receive values of type T |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1009 | chan <- float // can only be used to send floats |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 1010 | <-chan int // can only be used to receive ints |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1011 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1012 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1013 | <p> |
| 1014 | The value of an uninitialized channel is <code>nil</code>. A new, initialized channel |
| 1015 | value is made using the built-in function <code>make</code>, |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 1016 | which takes the channel type and an optional capacity as arguments: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1017 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1018 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1019 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1020 | <pre> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1021 | make(chan int, 100) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1022 | </pre> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1023 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1024 | <p> |
| 1025 | The capacity, in number of elements, sets the size of the buffer in the channel. If the |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1026 | capacity is greater than zero, the channel is asynchronous and, provided the |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1027 | buffer is not full, sends can succeed without blocking. If the capacity is zero |
| 1028 | or absent, the communication succeeds only when both a sender and receiver are ready. |
| 1029 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1030 | |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 1031 | <p> |
| 1032 | For a channel <code>c</code>, the predefined function <code>close(c)</code> |
| 1033 | marks the channel as unable to accept more |
| 1034 | values through a send operation. After any previously |
| 1035 | sent values have been received, receives will return |
| 1036 | the zero value for the channel's type. After at least one such zero value has been |
| 1037 | received, <code>closed(c)</code> returns true. |
| 1038 | </p> |
| 1039 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1040 | <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] | 1041 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1042 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1043 | Two types may be <i>identical</i>, <i>compatible</i>, or <i>incompatible</i>. |
| 1044 | Two identical types are always compatible, but two compatible types may not be identical. |
| 1045 | Go is <i>type safe</i>: a value of one type cannot be assigned to a variable of an |
| 1046 | incompatible type, and two values of incompatible types cannot be mixed in |
| 1047 | binary operations.</p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1048 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1049 | <h3 id="Type_identity_and_compatibility">Type identity and compatibility</h3> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1050 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1051 | <h4 id="Type_identity">Type identity</h4> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1052 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1053 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1054 | Two named types are identical if their type names originate in the same |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1055 | type declaration (§<a href="#Declarations_and_scope">Declarations and scope</a>). A named and an unnamed type |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1056 | are never identical. Two unnamed types are identical if the corresponding |
| 1057 | type literals have the same literal structure and corresponding components have |
| 1058 | identical types. In detail: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1059 | </p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1060 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1061 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1062 | <li>Two array types are identical if they have identical element types and |
| 1063 | the same array length.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1064 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1065 | <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] | 1066 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1067 | <li>Two struct types are identical if they have the same sequence of fields, |
| 1068 | and if corresponding fields have the same names and identical types. |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1069 | Two anonymous fields are considered to have the same name.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1070 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1071 | <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] | 1072 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1073 | <li>Two function types are identical if they have the same number of parameters |
| 1074 | and result values and if corresponding parameter and result types are |
| 1075 | identical. All "..." parameters have identical type. |
| 1076 | Parameter and result names are not required to match.</li> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1077 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1078 | <li>Two interface types are identical if they have the same set of methods |
| 1079 | with the same names and identical function types. The order |
| 1080 | of the methods is irrelevant.</li> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1081 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1082 | <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] | 1083 | |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1084 | <li>Two channel types are identical if they have identical value types and |
| 1085 | the same direction.</li> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1086 | </ul> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1087 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1088 | <h4 id="Type_compatibility">Type compatibility</h4> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1089 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1090 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1091 | Type compatibility is less stringent than type identity: a named and an unnamed |
| 1092 | type are compatible if the respective type literals are compatible. |
| 1093 | In all other respects, the definition of type compatibility is the |
| 1094 | same as for type identity listed above but with ``compatible'' |
| 1095 | substituted for ``identical''. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 1096 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1097 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1098 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1099 | Given the declarations |
| 1100 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1101 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1102 | <pre> |
| 1103 | type ( |
| 1104 | T0 []string; |
| 1105 | T1 []string |
| 1106 | T2 struct { a, b int }; |
| 1107 | T3 struct { a, c int }; |
| 1108 | T4 func (int, float) *T0 |
| 1109 | T5 func (x int, y float) *[]string |
| 1110 | ) |
| 1111 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1112 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1113 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1114 | these types are identical: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1115 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1116 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1117 | <pre> |
| 1118 | T0 and T0 |
| 1119 | []int and []int |
| 1120 | struct { a, b *T5 } and struct { a, b *T5 } |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1121 | func (x int, y float) *[]string and func (int, float) (result *[]string) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1122 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1123 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1124 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1125 | <code>T0</code> and <code>T1</code> are neither identical nor compatible |
| 1126 | because they are named types with distinct declarations. |
| 1127 | </p> |
| 1128 | |
| 1129 | <p> |
| 1130 | These types are compatible: |
| 1131 | </p> |
| 1132 | |
| 1133 | <pre> |
| 1134 | T0 and T0 |
| 1135 | T0 and []string |
| 1136 | T3 and struct { a int; c int } |
| 1137 | T4 and func (x int, y float) *[]string |
| 1138 | </pre> |
| 1139 | |
| 1140 | <p> |
| 1141 | <code>T2</code> and <code>struct { a, c int }</code> are incompatible because |
| 1142 | they have different field names. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 1143 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1144 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1145 | <h3 id="Assignment_compatibility">Assignment compatibility</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1146 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1147 | <p> |
| 1148 | Values of any type may always be assigned to variables |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1149 | of compatible static type. Some types and values have conditions under which they may |
| 1150 | be assigned to otherwise incompatible types: |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1151 | </p> |
| 1152 | <ul> |
| 1153 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1154 | A value can be assigned to an interface variable if the static |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1155 | type of the value implements the interface. |
| 1156 | </li> |
| 1157 | <li> |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 1158 | The predeclared constant <code>nil</code> can be assigned to any |
| 1159 | pointer, function, slice, map, channel, or interface variable. |
| 1160 | <li> |
| 1161 | A pointer <code>p</code> to an array can be assigned to a slice variable |
| 1162 | <code>v</code> with compatible element type |
| 1163 | if the type of <code>p</code> or <code>v</code> is unnamed. |
| 1164 | The slice variable then refers to the original array; the data is not copied. |
| 1165 | </li> |
| 1166 | <li> |
| 1167 | A bidirectional channel <code>c</code> can be assigned to a channel variable |
| 1168 | <code>v</code> with compatible channel value type |
| 1169 | if the type of <code>c</code> or <code>v</code> is unnamed. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1170 | </li> |
| 1171 | </ul> |
| 1172 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1173 | <h3 id="Comparison_compatibility">Comparison compatibility</h3> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1174 | |
| 1175 | <p> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1176 | Values of any type may be compared to other values of compatible static |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1177 | type. Values of numeric and string type may be compared using the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1178 | full range of comparison operators as described in §<a href="#Comparison_operators;">Comparison operators;</a> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1179 | booleans may be compared only for equality or inequality. |
| 1180 | </p> |
| 1181 | |
| 1182 | <p> |
| 1183 | Values of composite type may be |
| 1184 | compared for equality or inequality using the <code>==</code> and |
| 1185 | <code>!=</code> operators, with the following provisos: |
| 1186 | </p> |
| 1187 | <ul> |
| 1188 | <li> |
| 1189 | Arrays and structs may not be compared to anything. |
| 1190 | </li> |
| 1191 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1192 | A slice value may only be compared explicitly against <code>nil</code>. |
| 1193 | A slice value is equal to <code>nil</code> if it has been assigned the explicit |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1194 | value <code>nil</code> or if it is a variable (or array element, |
| 1195 | field, etc.) that has not been modified since it was created |
| 1196 | uninitialized. |
| 1197 | </li> |
| 1198 | <li> |
| 1199 | Similarly, an interface value is equal to <code>nil</code> if it has |
| 1200 | been assigned the explicit value <code>nil</code> or if it is a |
| 1201 | variable (or array element, field, etc.) that has not been modified |
| 1202 | since it was created uninitialized. |
| 1203 | </li> |
| 1204 | <li> |
| 1205 | For types that can be compared to <code>nil</code>, |
| 1206 | two values of the same type are equal if they both equal <code>nil</code>, |
| 1207 | unequal if one equals <code>nil</code> and one does not. |
| 1208 | </li> |
| 1209 | <li> |
| 1210 | Pointer values are equal if they point to the same location. |
| 1211 | </li> |
| 1212 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1213 | Function values are equal if they refer to the same function. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1214 | </li> |
| 1215 | <li> |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1216 | Channel and map values are equal if they were created by the same call to <code>make</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1217 | (§<a href="#Making_slices">Making slices</a>, maps, and channels). |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 1218 | When comparing two values of channel type, the channel value types |
| 1219 | must be compatible but the channel direction is ignored. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1220 | </li> |
| 1221 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 1222 | Interface values may be compared if they have compatible static types. |
Rob Pike | da38974 | 2009-03-02 19:13:40 -0800 | [diff] [blame] | 1223 | They will be equal only if they have the same dynamic type and the underlying values are equal. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1224 | </li> |
| 1225 | </ul> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 1226 | <hr/> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 1227 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1228 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1229 | <h2 id="Blocks">Blocks</h2> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1230 | |
| 1231 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1232 | A <i>block</i> is a sequence of declarations and statements within matching |
| 1233 | brace brackets. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1234 | </p> |
| 1235 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1236 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1237 | Block = "{" StatementList "}" . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1238 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1239 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1240 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1241 | 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] | 1242 | </p> |
| 1243 | |
| 1244 | <ol> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1245 | <li>The <i>universe block</i> encompasses all Go source text.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1246 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1247 | <li>Each package (§<a href="#Packages">Packages</a>) has a <i>package block</i> containing all |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1248 | Go source text for that package.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1249 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1250 | <li>Each file has a <i>file block</i> containing all Go source text |
| 1251 | in that file.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1252 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1253 | <li>Each <code>if</code>, <code>for</code>, and <code>switch</code> |
| 1254 | statement is considered to be in its own implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1255 | |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1256 | <li>Each clause in a <code>switch</code> or <code>select</code> statement |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1257 | acts as an implicit block.</li> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1258 | </ol> |
| 1259 | |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1260 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1261 | Blocks nest and influence scoping (§<a href="#Declarations_and_scope">Declarations and scope</a>). |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1262 | </p> |
| 1263 | |
| 1264 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1265 | <h2 id="Declarations_and_scope">Declarations and scope</h2> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1266 | |
| 1267 | <p> |
| 1268 | A declaration binds an identifier to a constant, type, variable, function, or package. |
| 1269 | Every identifier in a program must be declared. |
| 1270 | No identifier may be declared twice in the same block, and |
| 1271 | no identifier may be declared in both the file and package block. |
| 1272 | </p> |
| 1273 | |
| 1274 | <pre class="ebnf"> |
| 1275 | Declaration = ConstDecl | TypeDecl | VarDecl . |
| 1276 | TopLevelDecl = Declaration | FunctionDecl | MethodDecl . |
| 1277 | </pre> |
| 1278 | |
| 1279 | <p> |
| 1280 | The <i>scope</i> of a declared identifier is the extent of source text in which |
| 1281 | the identifier denotes the specified constant, type, variable, function, or package. |
| 1282 | </p> |
| 1283 | |
| 1284 | <p> |
| 1285 | Go is lexically scoped using blocks: |
| 1286 | </p> |
| 1287 | |
| 1288 | <ol> |
| 1289 | <li>The scope of a predeclared identifier is the universe block.</li> |
| 1290 | |
| 1291 | <li>The scope of an identifier denoting a constant, type, variable, |
| 1292 | or function declared at top level (outside any function) is the |
| 1293 | package block.</li> |
| 1294 | |
| 1295 | <li>The scope of an imported package identifier is the file block |
| 1296 | of the file containing the import declaration.</li> |
| 1297 | |
| 1298 | <li>The scope of an identifier denoting a function parameter or |
| 1299 | result variable is the function body.</li> |
| 1300 | |
| 1301 | <li>The scope of a constant or variable identifier declared |
| 1302 | inside a function begins at the end of the ConstSpec or VarSpec |
| 1303 | and ends at the end of the innermost containing block.</li> |
| 1304 | |
| 1305 | <li>The scope of a type identifier declared inside a function |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1306 | begins at the identifier in the TypeSpec |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1307 | and ends at the end of the innermost containing block.</li> |
| 1308 | </ol> |
| 1309 | |
| 1310 | <p> |
| 1311 | An identifier declared in a block may be redeclared in an inner block. |
| 1312 | While the identifier of the inner declaration is in scope, it denotes |
| 1313 | the entity declared by the inner declaration. |
| 1314 | </p> |
| 1315 | |
| 1316 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1317 | The package clause (§<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] | 1318 | does not appear in any scope. Its purpose is to identify the files belonging |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1319 | to the same package (§<a href="#Packages">Packages</a>) and to specify the default name for import |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1320 | declarations. |
| 1321 | </p> |
| 1322 | |
| 1323 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1324 | <h3 id="Label_scopes">Label scopes</h3> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1325 | |
| 1326 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1327 | Labels are declared by labeled statements (§<a href="#Labeled_statements">Labeled statements</a>) and are |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1328 | used in the <code>break</code>, <code>continue</code>, and <code>goto</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1329 | statements (§<a href="#Break_statements">Break statements</a>, §<a href="#Continue_statements">Continue statements</a>, §<a href="#Goto_statements">Goto statements</a>). |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1330 | In contrast to other identifiers, labels are not block scoped and do |
| 1331 | not conflict with identifiers that are not labels. The scope of a label |
| 1332 | is the body of the function in which it is declared and excludes |
| 1333 | the body of any nested function. |
| 1334 | </p> |
| 1335 | |
| 1336 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1337 | <h3 id="Predeclared_identifiers">Predeclared identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1338 | |
| 1339 | <p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1340 | The following identifiers are implicitly declared in the universe block: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1341 | </p> |
| 1342 | <pre class="grammar"> |
| 1343 | Basic types: |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1344 | bool byte float32 float64 int8 int16 int32 int64 |
| 1345 | string uint8 uint16 uint32 uint64 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1346 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 1347 | Architecture-specific convenience types: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1348 | float int uint uintptr |
| 1349 | |
| 1350 | Constants: |
| 1351 | true false iota nil |
| 1352 | |
| 1353 | Functions: |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1354 | cap close closed len make new panic panicln print println |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1355 | |
| 1356 | Packages: |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 1357 | unsafe |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1358 | </pre> |
| 1359 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1360 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1361 | <h3 id="Exported_identifiers">Exported identifiers</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1362 | |
| 1363 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1364 | An identifier may be <i>exported</i> to permit access to it from another package |
| 1365 | using a <a href="#Qualified_identifiers">qualified identifier</a>. An identifier |
| 1366 | is exported if both: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1367 | </p> |
| 1368 | <ol> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1369 | <li>the first character of the identifier's name is a Unicode upper case letter (Unicode class "Lu"); and |
| 1370 | <li>the identifier is declared in the <a href="#Blocks">package block</a> or is a field or method of a type |
| 1371 | declared in that block. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1372 | </ol> |
| 1373 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1374 | All other identifiers are not exported. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1375 | </p> |
| 1376 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1377 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1378 | <h3 id="Const_declarations">Const declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1379 | |
| 1380 | <p> |
| 1381 | A constant declaration binds a list of identifiers (the names of |
| 1382 | the constants) to the values of a list of constant expressions |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1383 | (§<a href="#Constant_expressions">Constant expressions</a>). The number of identifiers must be equal |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1384 | to the number of expressions, and the n<sup>th</sup> identifier on |
| 1385 | the left is bound to value of the n<sup>th</sup> expression on the |
| 1386 | right. |
| 1387 | </p> |
| 1388 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1389 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1390 | ConstDecl = "const" ( ConstSpec | "(" [ ConstSpecList ] ")" ) . |
| 1391 | ConstSpecList = ConstSpec { ";" ConstSpec } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1392 | ConstSpec = IdentifierList [ [ Type ] "=" ExpressionList ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1393 | |
| 1394 | IdentifierList = identifier { "," identifier } . |
| 1395 | ExpressionList = Expression { "," Expression } . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1396 | </pre> |
| 1397 | |
| 1398 | <p> |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1399 | If the type is omitted, the constants take the |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1400 | individual types of the corresponding expressions, which may be |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1401 | <i>ideal integer</i> or <i>ideal float</i> (§<a href="#Ideal_number">Ideal number</a>). If the type |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1402 | is present, all constants take the type specified, and the types |
| 1403 | of all the expressions must be assignment-compatible |
| 1404 | with that type. |
| 1405 | </p> |
| 1406 | |
| 1407 | <pre> |
| 1408 | const Pi float64 = 3.14159265358979323846 |
| 1409 | const E = 2.718281828 |
| 1410 | const ( |
| 1411 | size int64 = 1024; |
| 1412 | eof = -1; |
| 1413 | ) |
| 1414 | const a, b, c = 3, 4, "foo" // a = 3, b = 4, c = "foo" |
| 1415 | const u, v float = 0, 3 // u = 0.0, v = 3.0 |
| 1416 | </pre> |
| 1417 | |
| 1418 | <p> |
| 1419 | Within a parenthesized <code>const</code> declaration list the |
| 1420 | expression list may be omitted from any but the first declaration. |
| 1421 | Such an empty list is equivalent to the textual substitution of the |
Russ Cox | f8ba0f4 | 2009-03-12 19:04:56 -0700 | [diff] [blame] | 1422 | first preceding non-empty expression list, and its type if any. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1423 | Omitting the list of expressions is therefore equivalent to |
| 1424 | repeating the previous list. The number of identifiers must be equal |
| 1425 | to the number of expressions in the previous list. |
| 1426 | Together with the <code>iota</code> constant generator |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1427 | (§<a href="#Iota">Iota</a>) this mechanism permits light-weight declaration of sequential values: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1428 | </p> |
| 1429 | |
| 1430 | <pre> |
| 1431 | const ( |
| 1432 | Sunday = iota; |
| 1433 | Monday; |
| 1434 | Tuesday; |
| 1435 | Wednesday; |
| 1436 | Thursday; |
| 1437 | Friday; |
| 1438 | Partyday; |
| 1439 | numberOfDays; // this constant is not exported |
| 1440 | ) |
| 1441 | </pre> |
| 1442 | |
| 1443 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1444 | <h3 id="Iota">Iota</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1445 | |
| 1446 | <p> |
| 1447 | Within a constant declaration, the predeclared pseudo-constant |
| 1448 | <code>iota</code> represents successive integers. It is reset to 0 |
| 1449 | whenever the reserved word <code>const</code> appears in the source |
| 1450 | and increments with each semicolon. It can be used to construct a |
| 1451 | set of related constants: |
| 1452 | </p> |
| 1453 | |
| 1454 | <pre> |
| 1455 | const ( // iota is reset to 0 |
| 1456 | c0 = iota; // c0 == 0 |
| 1457 | c1 = iota; // c1 == 1 |
| 1458 | c2 = iota // c2 == 2 |
| 1459 | ) |
| 1460 | |
| 1461 | const ( |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1462 | a = 1 << iota; // a == 1 (iota has been reset) |
| 1463 | b = 1 << iota; // b == 2 |
| 1464 | c = 1 << iota; // c == 4 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1465 | ) |
| 1466 | |
| 1467 | const ( |
| 1468 | u = iota * 42; // u == 0 (ideal integer) |
| 1469 | v float = iota * 42; // v == 42.0 (float) |
| 1470 | w = iota * 42; // w == 84 (ideal integer) |
| 1471 | ) |
| 1472 | |
| 1473 | const x = iota; // x == 0 (iota has been reset) |
| 1474 | const y = iota; // y == 0 (iota has been reset) |
| 1475 | </pre> |
| 1476 | |
| 1477 | <p> |
| 1478 | Within an ExpressionList, the value of each <code>iota</code> is the same because |
| 1479 | it is only incremented at a semicolon: |
| 1480 | </p> |
| 1481 | |
| 1482 | <pre> |
| 1483 | const ( |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1484 | bit0, mask0 = 1 << iota, 1 << iota - 1; // bit0 == 1, mask0 == 0 |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1485 | bit1, mask1; // bit1 == 2, mask1 == 1 |
| 1486 | bit2, mask2; // bit2 == 4, mask2 == 3 |
| 1487 | ) |
| 1488 | </pre> |
| 1489 | |
| 1490 | <p> |
| 1491 | This last example exploits the implicit repetition of the |
| 1492 | last non-empty expression list. |
| 1493 | </p> |
| 1494 | |
| 1495 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1496 | <h3 id="Type_declarations">Type declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1497 | |
| 1498 | <p> |
| 1499 | A type declaration binds an identifier, the <i>type name</i>, |
| 1500 | to a new type. <font color=red>TODO: what exactly is a "new type"?</font> |
| 1501 | </p> |
| 1502 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1503 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1504 | TypeDecl = "type" ( TypeSpec | "(" [ TypeSpecList ] ")" ) . |
| 1505 | TypeSpecList = TypeSpec { ";" TypeSpec } [ ";" ] . |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1506 | TypeSpec = identifier Type . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1507 | </pre> |
| 1508 | |
| 1509 | <pre> |
Robert Griesemer | bdec330 | 2009-08-31 17:57:14 -0700 | [diff] [blame] | 1510 | type IntArray [16]int |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1511 | |
| 1512 | type ( |
| 1513 | Point struct { x, y float }; |
| 1514 | Polar Point |
| 1515 | ) |
| 1516 | |
| 1517 | type TreeNode struct { |
| 1518 | left, right *TreeNode; |
Russ Cox | 461dd91 | 2009-03-04 14:44:51 -0800 | [diff] [blame] | 1519 | value *Comparable; |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1520 | } |
| 1521 | |
| 1522 | type Comparable interface { |
| 1523 | cmp(Comparable) int |
| 1524 | } |
| 1525 | </pre> |
| 1526 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1527 | <h3 id="Variable_declarations">Variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1528 | |
| 1529 | <p> |
| 1530 | A variable declaration creates a variable, binds an identifier to it and |
| 1531 | gives it a type and optionally an initial value. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1532 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1533 | <pre class="ebnf"> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1534 | VarDecl = "var" ( VarSpec | "(" [ VarSpecList ] ")" ) . |
| 1535 | VarSpecList = VarSpec { ";" VarSpec } [ ";" ] . |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1536 | VarSpec = IdentifierList ( Type [ "=" ExpressionList ] | "=" ExpressionList ) . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1537 | </pre> |
| 1538 | |
| 1539 | <pre> |
| 1540 | var i int |
| 1541 | var U, V, W float |
| 1542 | var k = 0 |
| 1543 | var x, y float = -1.0, -2.0 |
| 1544 | var ( |
| 1545 | i int; |
| 1546 | u, v, s = 2.0, 3.0, "bar" |
| 1547 | ) |
| 1548 | </pre> |
| 1549 | |
| 1550 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1551 | If a list of expressions is given, the variables are initialized |
| 1552 | by assigning those expressions to the variables (§<a href="#Assignments">Assignments</a>). |
| 1553 | Otherwise, each variable is initialized to its <i>zero value</i> |
| 1554 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1555 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1556 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1557 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1558 | If the type is present, each variable is given that type. |
| 1559 | Otherwise, the types are deduced from the assignment |
| 1560 | of the expression list. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1561 | </p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1562 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1563 | <p> |
| 1564 | If the type is absent and the corresponding expression is a constant |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1565 | expression of ideal integer, float, or string type, the type of the |
| 1566 | declared variable is <code>int</code>, <code>float</code>, |
| 1567 | or <code>string</code> respectively: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1568 | </p> |
| 1569 | |
| 1570 | <pre> |
| 1571 | var i = 0 // i has type int |
| 1572 | var f = 3.1415 // f has type float |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1573 | var s = "OMDB" // s has type string |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1574 | </pre> |
| 1575 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1576 | <h3 id="Short_variable_declarations">Short variable declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1577 | |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1578 | A <i>short variable declaration</i> uses the syntax: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1579 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1580 | <pre class="ebnf"> |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 1581 | ShortVarDecl = IdentifierList ":=" ExpressionList . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1582 | </pre> |
| 1583 | |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1584 | It is a shorthand for a regular variable declaration with |
| 1585 | initializer expressions but no types: |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1586 | |
| 1587 | <pre class="grammar"> |
| 1588 | "var" IdentifierList = ExpressionList . |
| 1589 | </pre> |
| 1590 | |
| 1591 | <pre> |
| 1592 | i, j := 0, 10; |
| 1593 | f := func() int { return 7; } |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 1594 | ch := make(chan int); |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1595 | r, w := os.Pipe(fd); // os.Pipe() returns two values |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1596 | </pre> |
| 1597 | |
| 1598 | <p> |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 1599 | Unlike regular variable declarations, a short variable declaration may redeclare variables provided they |
Rob Pike | 2a1683a | 2009-04-19 20:04:15 -0700 | [diff] [blame] | 1600 | were originally declared in the same block with the same type, and at |
| 1601 | least one of the variables is new. As a consequence, redeclaration |
| 1602 | can only appear in a multi-variable short declaration. |
| 1603 | Redeclaration does not introduce a new |
| 1604 | variable; it just assigns a new value to the original. |
| 1605 | </p> |
| 1606 | |
| 1607 | <pre> |
| 1608 | field1, offset := nextField(str, 0); |
| 1609 | field2, offset := nextField(str, offset); // redeclares offset |
| 1610 | </pre> |
| 1611 | |
| 1612 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1613 | Short variable declarations may appear only inside functions. |
| 1614 | In some contexts such as the initializers for <code>if</code>, |
| 1615 | <code>for</code>, or <code>switch</code> statements, |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1616 | they can be used to declare local temporary variables (§<a href="#Statements">Statements</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1617 | </p> |
| 1618 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1619 | <h3 id="Function_declarations">Function declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1620 | |
| 1621 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1622 | A function declaration binds an identifier to a function (§<a href="#Function_types">Function types</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1623 | </p> |
| 1624 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1625 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1626 | FunctionDecl = "func" identifier Signature [ Body ] . |
| 1627 | Body = Block. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1628 | </pre> |
| 1629 | |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1630 | <p> |
| 1631 | A function declaration may omit the body. Such a declaration provides the |
| 1632 | signature for a function implemented outside Go, such as an assembly routine. |
| 1633 | </p> |
| 1634 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1635 | <pre> |
| 1636 | func min(x int, y int) int { |
| 1637 | if x < y { |
| 1638 | return x; |
| 1639 | } |
| 1640 | return y; |
| 1641 | } |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 1642 | |
| 1643 | func flushICache(begin, end uintptr) // implemented externally |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1644 | </pre> |
| 1645 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1646 | <h3 id="Method_declarations">Method declarations</h3> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1647 | |
| 1648 | <p> |
| 1649 | A method declaration binds an identifier to a method, |
| 1650 | which is a function with a <i>receiver</i>. |
| 1651 | </p> |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1652 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1653 | MethodDecl = "func" Receiver identifier Signature [ Body ] . |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1654 | Receiver = "(" [ identifier ] [ "*" ] TypeName ")" . |
| 1655 | </pre> |
| 1656 | |
| 1657 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1658 | The receiver type must be of the form <code>T</code> or <code>*T</code> where |
| 1659 | <code>T</code> is a type name. <code>T</code> is called the |
| 1660 | <i>receiver base type</i> or just <i>base type</i>. |
| 1661 | The base type must not be a pointer or interface type and must be |
Stephen Ma | 5db1d38 | 2009-09-02 20:09:25 -0700 | [diff] [blame^] | 1662 | declared in the same package as the method. |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1663 | The method is said to be <i>bound</i> to the base type |
| 1664 | and is visible only within selectors for that type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1665 | (§<a href="#Type_declarations">Type declarations</a>, §<a href="#Selectors">Selectors</a>). |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1666 | </p> |
| 1667 | |
| 1668 | <p> |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1669 | Given type <code>Point</code>, the declarations |
| 1670 | </p> |
| 1671 | |
| 1672 | <pre> |
| 1673 | func (p *Point) Length() float { |
| 1674 | return Math.sqrt(p.x * p.x + p.y * p.y); |
| 1675 | } |
| 1676 | |
| 1677 | func (p *Point) Scale(factor float) { |
| 1678 | p.x = p.x * factor; |
| 1679 | p.y = p.y * factor; |
| 1680 | } |
| 1681 | </pre> |
| 1682 | |
| 1683 | <p> |
| 1684 | bind the methods <code>Length</code> and <code>Scale</code> |
| 1685 | to the base type <code>Point</code>. |
| 1686 | </p> |
| 1687 | |
| 1688 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1689 | If the receiver's value is not referenced inside the the body of the method, |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1690 | its identifier may be omitted in the declaration. The same applies in |
| 1691 | general to parameters of functions and methods. |
| 1692 | </p> |
| 1693 | |
| 1694 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1695 | The type of a method is the type of a function with the receiver as first |
| 1696 | argument. For instance, the method <code>Scale</code> has type |
| 1697 | </p> |
| 1698 | |
| 1699 | <pre> |
| 1700 | (p *Point, factor float) |
| 1701 | </pre> |
| 1702 | |
| 1703 | <p> |
| 1704 | However, a function declared this way is not a method. |
| 1705 | </p> |
| 1706 | |
Rob Pike | a9ed30f | 2009-02-23 19:26:07 -0800 | [diff] [blame] | 1707 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1708 | <h2 id="Expressions">Expressions</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1709 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1710 | <p> |
| 1711 | An expression specifies the computation of a value by applying |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 1712 | operators and functions to operands. An expression has a value |
| 1713 | and a type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1714 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1715 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1716 | <h3 id="Operands">Operands</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1717 | |
| 1718 | Operands denote the elementary values in an expression. |
| 1719 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1720 | <pre class="ebnf"> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1721 | Operand = Literal | QualifiedIdent | "(" Expression ")" . |
| 1722 | Literal = BasicLit | CompositeLit | FunctionLit . |
| 1723 | BasicLit = int_lit | float_lit | char_lit | StringLit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1724 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1725 | |
| 1726 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1727 | <h3 id="Constants">Constants</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1728 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1729 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1730 | A <i>constant</i> is a literal of a basic type |
| 1731 | (including the predeclared constants <code>true</code>, <code>false</code> |
| 1732 | and <code>nil</code> |
| 1733 | and values denoted by <code>iota</code>) |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1734 | or a constant expression (§<a href="#Constant_expressions">Constant expressions</a>). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1735 | Constants have values that are known at compile time. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1736 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1737 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1738 | <h3 id="Qualified_identifiers">Qualified identifiers</h3> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1739 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1740 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1741 | A qualified identifier is an identifier qualified by a package name prefix. |
| 1742 | </p> |
Robert Griesemer | 337af31 | 2008-11-17 18:11:36 -0800 | [diff] [blame] | 1743 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1744 | <pre class="ebnf"> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 1745 | QualifiedIdent = [ PackageName "." ] identifier . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1746 | PackageName = identifier . |
| 1747 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1748 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1749 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 1750 | A qualified identifier accesses an identifier in a separate package. |
| 1751 | The identifier must be <a href="#Exported_identifiers">exported</a> by that |
| 1752 | package, which means that it must begin with a Unicode upper case letter. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1753 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1754 | |
| 1755 | <pre> |
| 1756 | Math.Sin |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1757 | </pre> |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 1758 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1759 | <h3 id="Composite_literals">Composite literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1760 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1761 | <p> |
| 1762 | Composite literals construct values for structs, arrays, slices, and maps |
| 1763 | and create a new value each time they are evaluated. |
| 1764 | They consist of the type of the value |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1765 | followed by a brace-bound list of composite elements. An element may be |
| 1766 | a single expression or a key-value pair. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1767 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1768 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1769 | <pre class="ebnf"> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1770 | CompositeLit = LiteralType "{" [ ElementList ] "}" . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1771 | LiteralType = StructType | ArrayType | "[" "..." "]" ElementType | |
| 1772 | SliceType | MapType | TypeName . |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1773 | ElementList = Element { "," Element } [ "," ] . |
| 1774 | Element = [ Key ":" ] Value . |
| 1775 | Key = Expression . |
| 1776 | Value = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1777 | </pre> |
Robert Griesemer | 0976e34 | 2008-09-03 13:37:44 -0700 | [diff] [blame] | 1778 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1779 | <p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1780 | The LiteralType must be a struct, array, slice, or map type |
| 1781 | (the grammar enforces this constraint except when the type is given |
| 1782 | as a TypeName). |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 1783 | The types of the expressions must be <a href="#Assignment_compatibility">assignment compatible</a> to |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 1784 | the respective field, element, and key types of the LiteralType; |
| 1785 | there is no additional conversion. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1786 | The key is interpreted as a field name for struct literals, |
| 1787 | an index for array and slice literals, and a key for map literals. |
| 1788 | For map literals, all elements must have a key. It is an error |
| 1789 | to specify multiple elements with the same field name or |
| 1790 | constant key value. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1791 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1792 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1793 | <p> |
| 1794 | For struct literals the following rules apply: |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 1795 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1796 | <ul> |
| 1797 | <li>A literal which does not contain any keys must |
| 1798 | list an element for each struct field in the |
| 1799 | order in which the fields are declared. |
| 1800 | </li> |
| 1801 | <li>If any element has a key, every element must have a key. |
| 1802 | </li> |
| 1803 | <li>A literal which contains keys does not need to |
| 1804 | have an element for each struct field. Omitted fields |
| 1805 | get the zero value for that field. |
| 1806 | </li> |
| 1807 | <li>A literal may omit the element list; such a literal evaluates |
| 1808 | to the zero value for its type. |
| 1809 | </li> |
| 1810 | <li>It is an error to specify an element for a non-exported |
| 1811 | field of a struct belonging to a different package. |
| 1812 | </li> |
| 1813 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1814 | |
| 1815 | <p> |
| 1816 | Given the declarations |
| 1817 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1818 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1819 | type Point struct { x, y, z float } |
| 1820 | type Line struct { p, q Point } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1821 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1822 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1823 | <p> |
| 1824 | one may write |
| 1825 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1826 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1827 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1828 | origin := Point{}; // zero value for Point |
| 1829 | line := Line{origin, Point{y: -4, z: 12.3}}; // zero value for line.q.x |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1830 | </pre> |
| 1831 | |
Robert Griesemer | cfe9211 | 2009-06-18 13:29:40 -0700 | [diff] [blame] | 1832 | <p> |
| 1833 | For array and slice literals the following rules apply: |
| 1834 | </p> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1835 | <ul> |
| 1836 | <li>Each element has an associated integer index marking |
| 1837 | its position in the array. |
| 1838 | </li> |
| 1839 | <li>An element with a key uses the key as its index; the |
| 1840 | key must be a constant integer expression. |
| 1841 | </li> |
| 1842 | <li>An element without a key uses the previous element's index plus one. |
| 1843 | If the first element has no key, its index is zero. |
| 1844 | </li> |
| 1845 | </ul> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1846 | |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1847 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1848 | Taking the address of a composite literal (§<a href="#Address_operators">Address operators</a>) |
Rob Pike | 2a5af74 | 2009-03-20 17:03:48 -0700 | [diff] [blame] | 1849 | generates a unique pointer to an instance of the literal's value. |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1850 | </p> |
Rob Pike | 37ab838 | 2009-03-18 22:58:36 -0700 | [diff] [blame] | 1851 | <pre> |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1852 | var pointer *Point = &Point{y: 1000}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1853 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1854 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1855 | <p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 1856 | The length of an array literal is the length specified in the LiteralType. |
| 1857 | 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] | 1858 | elements are set to the zero value for the array element type. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1859 | It is an error to provide elements with index values outside the index range |
| 1860 | of the array. The notation <code>...</code> specifies an array length equal |
| 1861 | to the maximum element index plus one. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1862 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 1863 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1864 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1865 | buffer := [10]string{}; // len(buffer) == 10 |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1866 | intSet := [6]int{1, 2, 3, 5}; // len(intSet) == 6 |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1867 | days := [...]string{"Sat", "Sun"}; // len(days) == 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1868 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1869 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1870 | <p> |
| 1871 | A slice literal describes the entire underlying array literal. |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1872 | Thus, the length and capacity of a slice literal is the maximum |
| 1873 | element index plus one. A slice literal has the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1874 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1875 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1876 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1877 | []T{x1, x2, ... xn} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1878 | </pre> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1879 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1880 | <p> |
| 1881 | and is a shortcut for a slice operation applied to an array literal: |
| 1882 | </p> |
Robert Griesemer | 91bbd64 | 2009-01-07 09:31:35 -0800 | [diff] [blame] | 1883 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1884 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1885 | [n]T{x1, x2, ... xn}[0 : n] |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1886 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1887 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1888 | <p> |
Russ Cox | 7a5e97b | 2009-03-03 15:40:30 -0800 | [diff] [blame] | 1889 | A parsing ambiguity arises when a composite literal using the |
| 1890 | TypeName form of the LiteralType appears in the condition of an |
| 1891 | "if", "for", or "switch" statement, because the braces surrounding |
| 1892 | the expressions in the literal are confused with those introducing |
| 1893 | a block of statements. To resolve the ambiguity in this rare case, |
| 1894 | the composite literal must appear within |
| 1895 | parentheses. |
| 1896 | </p> |
| 1897 | |
| 1898 | <pre> |
| 1899 | if x == (T{a,b,c}[i]) { ... } |
| 1900 | if (x == T{a,b,c}[i]) { ... } |
| 1901 | </pre> |
| 1902 | |
Robert Griesemer | 838cf12 | 2009-05-22 10:25:06 -0700 | [diff] [blame] | 1903 | <p> |
| 1904 | Examples of valid array, slice, and map literals: |
| 1905 | </p> |
| 1906 | |
| 1907 | <pre> |
| 1908 | // list of prime numbers |
| 1909 | primes := []int{2, 3, 5, 7, 9, 11, 13, 17, 19, 991}; |
| 1910 | |
| 1911 | // vowels[ch] is true if ch is a vowel |
| 1912 | vowels := [128]bool{'a': true, 'e': true, 'i': true, 'o': true, 'u': true, 'y': true}; |
| 1913 | |
| 1914 | // the array [10]float{-1, 0, 0, 0, -0.1, -0.1, 0, 0, 0, -1}; |
| 1915 | filter := [10]float{-1, 4: -0.1, -0.1, 9: -1}; |
| 1916 | |
| 1917 | // frequencies in Hz for equal-tempered scale (A4 = 440Hz) |
| 1918 | noteFrequency := map[string]float{ |
| 1919 | "C0": 16.35, "D0": 18.35, "E0": 20.60, "F0": 21.83, |
| 1920 | "G0": 24.50, "A0": 27.50, "B0": 30.87, |
| 1921 | } |
| 1922 | </pre> |
| 1923 | |
| 1924 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1925 | <h3 id="Function_literals">Function literals</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1926 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1927 | <p> |
| 1928 | A function literal represents an anonymous function. |
| 1929 | It consists of a specification of the function type and a function body. |
| 1930 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1931 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1932 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 1933 | FunctionLit = FunctionType Body . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1934 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1935 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1936 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1937 | func (a, b int, z float) bool { return a*b < int(z) } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1938 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1939 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1940 | <p> |
| 1941 | A function literal can be assigned to a variable or invoked directly. |
| 1942 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1943 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1944 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1945 | f := func(x, y int) int { return x + y } |
| 1946 | func(ch chan int) { ch <- ACK } (reply_chan) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1947 | </pre> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1948 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1949 | <p> |
| 1950 | Function literals are <i>closures</i>: they may refer to variables |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 1951 | defined in a surrounding function. Those variables are then shared between |
| 1952 | the surrounding function and the function literal, and they survive as long |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1953 | as they are accessible. |
| 1954 | </p> |
Robert Griesemer | 7231ceb | 2008-09-08 15:01:04 -0700 | [diff] [blame] | 1955 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1956 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1957 | <h3 id="Primary_expressions">Primary expressions</h3> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1958 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 1959 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1960 | PrimaryExpr = |
| 1961 | Operand | |
| 1962 | PrimaryExpr Selector | |
| 1963 | PrimaryExpr Index | |
| 1964 | PrimaryExpr Slice | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1965 | PrimaryExpr TypeAssertion | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1966 | PrimaryExpr Call . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 1967 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 1968 | Selector = "." identifier . |
| 1969 | Index = "[" Expression "]" . |
| 1970 | Slice = "[" Expression ":" Expression "]" . |
| 1971 | TypeAssertion = "." "(" Type ")" . |
| 1972 | Call = "(" [ ExpressionList ] ")" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1973 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1974 | |
| 1975 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1976 | <pre> |
| 1977 | x |
| 1978 | 2 |
| 1979 | (s + ".txt") |
| 1980 | f(3.1415, true) |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 1981 | Point{1, 2} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1982 | m["foo"] |
| 1983 | s[i : j + 1] |
| 1984 | obj.color |
| 1985 | Math.sin |
| 1986 | f.p[i].x() |
| 1987 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1988 | |
| 1989 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 1990 | <h3 id="Selectors">Selectors</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1991 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1992 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 1993 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 1994 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 1995 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 1996 | <pre> |
| 1997 | x.f |
| 1998 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 1999 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2000 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2001 | denotes the field or method <code>f</code> of the value denoted by <code>x</code> |
| 2002 | (or of <code>*x</code> if |
| 2003 | <code>x</code> is of pointer type). The identifier <code>f</code> |
| 2004 | is called the (field or method) |
| 2005 | <i>selector</i>. |
| 2006 | The type of the expression is the type of <code>f</code>. |
| 2007 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2008 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2009 | A selector <code>f</code> may denote a field or method <code>f</code> of |
| 2010 | a type <code>T</code>, or it may refer |
| 2011 | to a field or method <code>f</code> of a nested anonymous field of |
| 2012 | <code>T</code>. |
| 2013 | The number of anonymous fields traversed |
| 2014 | to reach <code>f</code> is called its <i>depth</i> in <code>T</code>. |
| 2015 | The depth of a field or method <code>f</code> |
| 2016 | declared in <code>T</code> is zero. |
| 2017 | The depth of a field or method <code>f</code> declared in |
| 2018 | an anonymous field <code>A</code> in <code>T</code> is the |
| 2019 | depth of <code>f</code> in <code>A</code> plus one. |
| 2020 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2021 | <p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2022 | The following rules apply to selectors: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2023 | </p> |
| 2024 | <ol> |
| 2025 | <li> |
| 2026 | For a value <code>x</code> of type <code>T</code> or <code>*T</code> |
| 2027 | where <code>T</code> is not an interface type, |
| 2028 | <code>x.f</code> denotes the field or method at the shallowest depth |
| 2029 | in <code>T</code> where there |
| 2030 | is such an <code>f</code>. |
| 2031 | If there is not exactly one <code>f</code> with shallowest depth, the selector |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2032 | expression is illegal. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2033 | </li> |
| 2034 | <li> |
| 2035 | For a variable <code>x</code> of type <code>I</code> or <code>*I</code> |
| 2036 | where <code>I</code> is an interface type, |
| 2037 | <code>x.f</code> denotes the actual method with name <code>f</code> of the value assigned |
| 2038 | to <code>x</code> if there is such a method. |
| 2039 | If no value or <code>nil</code> was assigned to <code>x</code>, <code>x.f</code> is illegal. |
| 2040 | </li> |
| 2041 | <li> |
| 2042 | In all other cases, <code>x.f</code> is illegal. |
| 2043 | </ol> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2044 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2045 | Selectors automatically dereference pointers as necessary. |
| 2046 | If <code>x</code> is of pointer type, <code>x.y</code> |
| 2047 | is shorthand for <code>(*x).y</code>; if <code>y</code> |
| 2048 | is also of pointer type, <code>x.y.z</code> is shorthand |
| 2049 | for <code>(*(*x).y).z</code>, and so on. |
| 2050 | If <code>*x</code> is of pointer type, dereferencing |
| 2051 | must be explicit; |
| 2052 | only one level of automatic dereferencing is provided. |
| 2053 | For an <code>x</code> of type <code>T</code> containing an |
| 2054 | anonymous field declared as <code>*A</code>, |
| 2055 | <code>x.f</code> is a shortcut for <code>(*x.A).f</code>. |
| 2056 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2057 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2058 | For example, given the declarations: |
| 2059 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2060 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2061 | <pre> |
| 2062 | type T0 struct { |
| 2063 | x int; |
| 2064 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2065 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2066 | func (recv *T0) M0() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2067 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2068 | type T1 struct { |
| 2069 | y int; |
| 2070 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2071 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2072 | func (recv T1) M1() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2073 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2074 | type T2 struct { |
| 2075 | z int; |
| 2076 | T1; |
| 2077 | *T0; |
| 2078 | } |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2079 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2080 | func (recv *T2) M2() |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2081 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2082 | var p *T2; // with p != nil and p.T1 != nil |
| 2083 | </pre> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2084 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2085 | <p> |
| 2086 | one may write: |
| 2087 | </p> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2088 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2089 | <pre> |
| 2090 | p.z // (*p).z |
| 2091 | p.y // ((*p).T1).y |
| 2092 | p.x // (*(*p).T0).x |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2093 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2094 | p.M2 // (*p).M2 |
| 2095 | p.M1 // ((*p).T1).M1 |
| 2096 | p.M0 // ((*p).T0).M0 |
| 2097 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2098 | |
| 2099 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2100 | <font color=red> |
Robert Griesemer | 071c91b | 2008-10-23 12:04:45 -0700 | [diff] [blame] | 2101 | TODO: Specify what happens to receivers. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2102 | </font> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2103 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2104 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2105 | <h3 id="Indexes">Indexes</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2106 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2107 | <p> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2108 | A primary expression of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2109 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2110 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2111 | <pre> |
| 2112 | a[x] |
| 2113 | </pre> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2114 | |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2115 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2116 | denotes the array or map element of <code>a</code> indexed by <code>x</code>. |
| 2117 | The value <code>x</code> is called the |
| 2118 | <i>array index</i> or <i>map key</i>, respectively. The following |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2119 | rules apply: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2120 | </p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2121 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2122 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2123 | For <code>a</code> of type <code>A</code> or <code>*A</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2124 | where <code>A</code> is an array type (§<a href="#Array_types">Array types</a>), |
| 2125 | or for <code>a</code> of type <code>S</code> where <code>S</code> is a slice type (§<a href="#Slice_types">Slice types</a>): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2126 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2127 | <ul> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2128 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code> |
| 2129 | <li><code>a[x]</code> is the array element at index <code>x</code> and the type of |
| 2130 | <code>a[x]</code> is the element type of <code>A</code> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2131 | </ul> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2132 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2133 | <p> |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2134 | For <code>a</code> of type <code>T</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2135 | where <code>T</code> is a string type (§<a href="#Strings">Strings</a>): |
Russ Cox | eaa92e0 | 2009-06-25 14:43:55 -0700 | [diff] [blame] | 2136 | </p> |
| 2137 | <ul> |
| 2138 | <li><code>x</code> must be an integer value and <code>0 <= x < len(a)</code> |
| 2139 | <li><code>a[x]</code> is the byte at index <code>x</code> and the type of |
| 2140 | <code>a[x]</code> is <code>byte</code> |
| 2141 | <li><code>a[x]</code> may not be assigned to |
| 2142 | </ul> |
| 2143 | |
| 2144 | <p> |
| 2145 | For <code>a</code> of type <code>M</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2146 | where <code>M</code> is a map type (§<a href="#Map_types">Map types</a>): |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2147 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2148 | <ul> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 2149 | <li><code>x</code>'s type must be compatible with the key type of <code>M</code> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2150 | and the map must contain an entry with key <code>x</code> (but see special forms below) |
| 2151 | <li><code>a[x]</code> is the map value with key <code>x</code> |
| 2152 | and the type of <code>a[x]</code> is the value type of <code>M</code> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2153 | </ul> |
Robert Griesemer | bbfe312 | 2008-10-09 17:12:09 -0700 | [diff] [blame] | 2154 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2155 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2156 | Otherwise <code>a[x]</code> is illegal. If the index or key is out of range evaluating |
| 2157 | an otherwise legal index expression, a run-time exception occurs. |
| 2158 | </p> |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 2159 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2160 | <p> |
| 2161 | However, if an index expression on a map <code>a</code> of type <code>map[K] V</code> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2162 | is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2163 | </p> |
| 2164 | |
| 2165 | <pre> |
| 2166 | r, ok = a[x] |
| 2167 | r, ok := a[x] |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2168 | var r, ok = a[x] |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2169 | </pre> |
| 2170 | |
| 2171 | <p> |
| 2172 | the result of the index expression is a pair of values with types |
| 2173 | <code>(K, bool)</code>. |
| 2174 | If the key is present in the map, |
| 2175 | the expression returns the pair <code>(a[x], true)</code>; |
| 2176 | otherwise it returns <code>(Z, false)</code> where <code>Z</code> is |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2177 | the zero value for <code>V</code> (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2178 | No run-time exception occurs in this case. |
| 2179 | The index expression in this construct thus acts like a function call |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2180 | returning a value and a boolean indicating success. (§<a href="#Assignments">Assignments</a>) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2181 | </p> |
| 2182 | |
| 2183 | <p> |
| 2184 | Similarly, if an assignment to a map has the special form |
| 2185 | </p> |
| 2186 | |
| 2187 | <pre> |
| 2188 | a[x] = r, ok |
| 2189 | </pre> |
| 2190 | |
| 2191 | <p> |
| 2192 | and boolean <code>ok</code> has the value <code>false</code>, |
| 2193 | the entry for key <code>x</code> is deleted from the map; if |
| 2194 | <code>ok</code> is <code>true</code>, the construct acts like |
| 2195 | a regular assignment to an element of the map. |
| 2196 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2197 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2198 | <h3 id="Slices">Slices</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2199 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2200 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 2201 | Strings, arrays, and slices can be <i>sliced</i> to construct substrings or descriptors |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 2202 | of subarrays. The index expressions in the slice select which elements appear |
| 2203 | in the result. The result has indexes starting at 0 and length equal to the |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2204 | difference in the index values in the slice. After slicing the array <code>a</code> |
| 2205 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2206 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2207 | <pre> |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 2208 | a := [4]int{1, 2, 3, 4}; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2209 | s := a[1:3]; |
| 2210 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2211 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2212 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2213 | the slice <code>s</code> has type <code>[]int</code>, length 2, capacity 3, and elements |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2214 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2215 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2216 | <pre> |
| 2217 | s[0] == 2 |
| 2218 | s[1] == 3 |
| 2219 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2220 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2221 | <p> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 2222 | The slice length must be non-negative. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2223 | For arrays or strings, the indexes |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 2224 | <code>lo</code> and <code>hi</code> must satisfy |
| 2225 | 0 <= <code>lo</code> <= <code>hi</code> <= length; |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2226 | for slices, the upper bound is the capacity rather than the length. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2227 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2228 | If the sliced operand is a string, the result of the slice operation is another, new |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2229 | string (§<a href="#Strings">Strings</a>). If the sliced operand is an array or slice, the result |
| 2230 | of the slice operation is a slice (§<a href="#Slice_types">Slice types</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2231 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2232 | |
| 2233 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2234 | <h3 id="Type_assertions">Type assertions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2235 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2236 | <p> |
| 2237 | For an expression <code>x</code> and a type <code>T</code>, the primary expression |
| 2238 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2239 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2240 | <pre> |
| 2241 | x.(T) |
| 2242 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2243 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2244 | <p> |
Russ Cox | b89a54e | 2009-05-20 18:16:04 -0700 | [diff] [blame] | 2245 | asserts that <code>x</code> is not the zero interface value |
| 2246 | 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] | 2247 | The notation <code>x.(T)</code> is called a <i>type assertion</i>. |
| 2248 | The type of <code>x</code> must be an interface type. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2249 | </p> |
| 2250 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2251 | More precisely, if <code>T</code> is not an interface type, <code>x.(T)</code> asserts |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2252 | that the dynamic type of <code>x</code> is identical to the type <code>T</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2253 | (§<a href="#Type_identity_and_compatibility">Type identity and compatibility</a>). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2254 | If <code>T</code> is an interface type, <code>x.(T)</code> asserts that the dynamic type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2255 | of <code>T</code> implements the interface <code>T</code> (§<a href="#Interface_types">Interface types</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2256 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2257 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2258 | If the type assertion holds, the value of the expression is the value |
| 2259 | stored in <code>x</code> and its type is <code>T</code>. If the type assertion is false, a run-time |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2260 | exception occurs. In other words, even though the dynamic type of <code>x</code> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2261 | 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] | 2262 | known to be <code>T</code> in a correct program. |
| 2263 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2264 | <p> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2265 | If a type assertion is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2266 | </p> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2267 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2268 | <pre> |
| 2269 | v, ok = x.(T) |
| 2270 | v, ok := x.(T) |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2271 | var v, ok = x.(T) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2272 | </pre> |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 2273 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2274 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2275 | the result of the assertion is a pair of values with types <code>(T, bool)</code>. |
| 2276 | If the assertion holds, the expression returns the pair <code>(x.(T), true)</code>; |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2277 | otherwise, the expression returns <code>(Z, false)</code> where <code>Z</code> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2278 | is the zero value for type <code>T</code> (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2279 | No run-time exception occurs in this case. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2280 | The type assertion in this construct thus acts like a function call |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2281 | returning a value and a boolean indicating success. (§<a href="#Assignments">Assignments</a>) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2282 | </p> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2283 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2284 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2285 | <h3 id="Calls">Calls</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2286 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2287 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2288 | Given an expression <code>f</code> of function type |
| 2289 | <code>F</code>, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2290 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2291 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2292 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2293 | f(a1, a2, ... an) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2294 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2295 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2296 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2297 | calls <code>f</code> with arguments <code>a1, a2, ... an</code>. |
| 2298 | The arguments must be single-valued expressions |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2299 | <a href="#Assignment_compatibility">assignment compatible</a> with the parameters of |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2300 | <code>F</code> and are evaluated before the function is called. |
| 2301 | The type of the expression is the result type |
| 2302 | of <code>F</code>. |
| 2303 | A method invocation is similar but the method itself |
| 2304 | is specified as a selector upon a value of the receiver type for |
| 2305 | the method. |
| 2306 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2307 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2308 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2309 | Atan2(x, y) // function call |
| 2310 | var pt *Point; |
| 2311 | pt.Scale(3.5) // method call with receiver pt |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2312 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2313 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2314 | <p> |
Robert Griesemer | 56809d0 | 2009-05-20 11:02:48 -0700 | [diff] [blame] | 2315 | A method call <code>x.m()</code> is valid if the method set of |
| 2316 | (the type of) <code>x</code> contains <code>m</code> (and the |
| 2317 | argument list is compatible with the parameter list of <code>m</code>). |
| 2318 | If <code>x</code> is addressable and <code>&x</code>'s method |
| 2319 | set contains <code>m</code>, <code>x.m()</code> is shorthand |
| 2320 | for <code>(&x).m()</code>: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2321 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2322 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2323 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2324 | var p Point; |
| 2325 | p.Scale(3.5) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2326 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2327 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2328 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2329 | There is no distinct method type and there are no method literals. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2330 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2331 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2332 | <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] | 2333 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2334 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2335 | When a function <code>f</code> has a <code>...</code> parameter, |
| 2336 | it is always the last formal parameter. Within calls to <code>f</code>, |
| 2337 | the arguments before the <code>...</code> are treated normally. |
| 2338 | After those, an arbitrary number (including zero) of trailing |
| 2339 | arguments may appear in the call and are bound to the <code>...</code> |
| 2340 | parameter. |
| 2341 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2342 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2343 | <p> |
| 2344 | Within <code>f</code>, the <code>...</code> parameter has static |
| 2345 | type <code>interface{}</code> (the empty interface). For each call, |
| 2346 | its dynamic type is a structure whose sequential fields are the |
| 2347 | trailing arguments of the call. That is, the actual arguments |
| 2348 | provided for a <code>...</code> parameter are wrapped into a struct |
| 2349 | that is passed to the function instead of the actual arguments. |
| 2350 | Using the reflection library (TODO: reference), <code>f</code> may |
| 2351 | unpack the elements of the dynamic type to recover the actual |
| 2352 | arguments. |
| 2353 | </p> |
| 2354 | |
| 2355 | <p> |
| 2356 | Given the function and call |
| 2357 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2358 | <pre> |
Rob Pike | fb24d79 | 2009-05-08 11:21:20 -0700 | [diff] [blame] | 2359 | func Fprintf(f io.Writer, format string, args ...) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2360 | Fprintf(os.Stdout, "%s %d", "hello", 23); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2361 | </pre> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2362 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2363 | <p> |
| 2364 | Within <code>Fprintf</code>, the dynamic type of <code>args</code> for this |
| 2365 | call will be, schematically, |
| 2366 | <code> struct { string; int }</code>. |
| 2367 | </p> |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2368 | |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2369 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2370 | <p> |
| 2371 | As a special case, if a function passes its own <code>...</code> parameter as the argument |
| 2372 | for a <code>...</code> in a call to another function with a <code>...</code> parameter, |
| 2373 | the parameter is not wrapped again but passed directly. In short, a formal <code>...</code> |
| 2374 | parameter is passed unchanged as an actual <code>...</code> parameter. |
Robert Griesemer | 69e26bf | 2008-11-04 16:46:45 -0800 | [diff] [blame] | 2375 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2376 | <h3 id="Operators">Operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2377 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2378 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2379 | Operators combine operands into expressions. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2380 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2381 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2382 | <pre class="ebnf"> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2383 | Expression = UnaryExpr | Expression binary_op UnaryExpr . |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2384 | UnaryExpr = PrimaryExpr | unary_op UnaryExpr . |
Robert Griesemer | 57b3461 | 2008-10-10 12:45:44 -0700 | [diff] [blame] | 2385 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2386 | binary_op = log_op | com_op | rel_op | add_op | mul_op . |
| 2387 | log_op = "||" | "&&" . |
| 2388 | com_op = "<-" . |
| 2389 | rel_op = "==" | "!=" | "<" | "<=" | ">" | ">=" . |
| 2390 | add_op = "+" | "-" | "|" | "^" . |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2391 | mul_op = "*" | "/" | "%" | "<<" | ">>" | "&" | "&^" . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2392 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2393 | unary_op = "+" | "-" | "!" | "^" | "*" | "&" | "<-" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2394 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2395 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2396 | <p> |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2397 | Comparisons are discussed elsewhere |
| 2398 | (§<a href="#Comparison_compatibility">Comparison compatibility</a>). |
| 2399 | For other binary operators, the |
| 2400 | operand types must be identical |
| 2401 | (§<a href="#Properties_of_types_and_values">Properties of types and values</a>) |
| 2402 | unless the operation involves |
| 2403 | channels, shifts, or ideal constants. |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 2404 | </p> |
Robert Griesemer | c8e1876 | 2008-09-12 12:26:22 -0700 | [diff] [blame] | 2405 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2406 | <p> |
| 2407 | In a channel send, the first operand is always a channel and the |
| 2408 | second is a value of the channel's element type. |
| 2409 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2410 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2411 | <p> |
| 2412 | Except for shift operations, |
| 2413 | if one operand has ideal type and the other operand does not, |
Rob Pike | 0262f88 | 2009-08-24 16:12:59 -0700 | [diff] [blame] | 2414 | the ideal operand is converted to match the type of |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2415 | the other operand (§<a href="#Expressions">Expressions</a>). |
| 2416 | If both operands are ideal numbers and one is an |
| 2417 | ideal float, the other is converted to ideal float |
| 2418 | (relevant for <code>/</code> and <code>%</code>). |
| 2419 | </p> |
Robert Griesemer | 7539c85 | 2009-07-31 18:05:07 -0700 | [diff] [blame] | 2420 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2421 | <p> |
| 2422 | The right operand in a shift operation must have unsigned integer type |
| 2423 | or be an ideal number that can be converted to unsigned integer type |
| 2424 | (§<a href="#Arithmetic_operators">Arithmetic operators</a>). |
| 2425 | </p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2426 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2427 | <p> |
| 2428 | If the left operand of a non-constant shift operation is an ideal number, |
| 2429 | the type of the ideal number |
| 2430 | is what it would be if the shift operation were replaced by the left operand alone. |
| 2431 | </p> |
Robert Griesemer | a6b546f | 2008-10-20 11:46:40 -0700 | [diff] [blame] | 2432 | |
Rob Pike | 83cbca5 | 2009-08-21 14:18:08 -0700 | [diff] [blame] | 2433 | <pre> |
| 2434 | var s uint = 33; |
| 2435 | var i = 1<<s; // 1 has type int |
| 2436 | var j = int32(1<<s); // 1 has type int32; j == 0 |
| 2437 | var u = uint64(1<<s); // 1 has type uint64; u == 1<<33 |
| 2438 | var f = float(1<<s); // illegal: 1 has type float, cannot shift |
| 2439 | var g = float(1<<33); // legal; 1<<33 is a constant shift operation; g == 1<<33 |
| 2440 | </pre> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2441 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2442 | <p> |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2443 | Unary operators have the highest precedence. |
| 2444 | As the <code>++</code> and <code>--</code> operators form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2445 | statements, not expressions, they fall |
Russ Cox | ec9b042 | 2009-07-09 16:44:13 -0700 | [diff] [blame] | 2446 | outside the operator hierarchy. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2447 | As a consequence, statement <code>*p++</code> is the same as <code>(*p)++</code>. |
| 2448 | <p> |
| 2449 | There are six precedence levels for binary operators. |
| 2450 | Multiplication operators bind strongest, followed by addition |
Robert Griesemer | ad71110 | 2008-09-11 17:48:20 -0700 | [diff] [blame] | 2451 | operators, comparison operators, communication operators, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2452 | <code>&&</code> (logical and), and finally <code>||</code> (logical or): |
| 2453 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2454 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2455 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2456 | Precedence Operator |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2457 | 6 * / % << >> & &^ |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2458 | 5 + - | ^ |
| 2459 | 4 == != < <= > >= |
| 2460 | 3 <- |
| 2461 | 2 && |
| 2462 | 1 || |
| 2463 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2464 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2465 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2466 | Binary operators of the same precedence associate from left to right. |
| 2467 | For instance, <code>x / y / z</code> is the same as <code>(x / y) / z</code>. |
| 2468 | </p> |
| 2469 | <p> |
| 2470 | Examples: |
| 2471 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2472 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2473 | <pre> |
| 2474 | +x |
| 2475 | 23 + 3*x[i] |
| 2476 | x <= f() |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2477 | ^a >> b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2478 | f() || g() |
| 2479 | x == y + 1 && <-chan_ptr > 0 |
| 2480 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2481 | |
| 2482 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2483 | <h3 id="Arithmetic_operators">Arithmetic operators</h3> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2484 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2485 | Arithmetic operators apply to numeric types and yield a result of the same |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2486 | type as the first operand. The four standard arithmetic operators (<code>+</code>, |
| 2487 | <code>-</code>, <code>*</code>, <code>/</code>) apply both to integer and |
| 2488 | floating point types, while <code>+</code> applies also |
| 2489 | to strings; all other arithmetic operators apply to integers only. |
| 2490 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2491 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2492 | <pre class="grammar"> |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2493 | + sum integers, floats, strings |
| 2494 | - difference integers, floats |
| 2495 | * product integers, floats |
| 2496 | / quotient integers, floats |
| 2497 | % remainder integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2498 | |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 2499 | & bitwise and integers |
| 2500 | | bitwise or integers |
| 2501 | ^ bitwise xor integers |
| 2502 | &^ bit clear (and not) integers |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2503 | |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2504 | << left shift integer << unsigned integer |
| 2505 | >> right shift integer >> unsigned integer |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2506 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2507 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2508 | <p> |
| 2509 | Strings can be concatenated using the <code>+</code> operator |
| 2510 | or the <code>+=</code> assignment operator: |
| 2511 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2512 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2513 | <pre> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2514 | s := "hi" + string(c); |
| 2515 | s += " and good bye"; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2516 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2517 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2518 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2519 | String addition creates a new string by concatenating the operands. |
| 2520 | </p> |
| 2521 | <p> |
| 2522 | For integer values, <code>/</code> and <code>%</code> satisfy the following relationship: |
| 2523 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2524 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2525 | <pre> |
| 2526 | (a / b) * b + a % b == a |
| 2527 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2528 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2529 | <p> |
| 2530 | with <code>(a / b)</code> truncated towards zero. |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2531 | Examples: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2532 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2533 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2534 | <pre> |
| 2535 | x y x / y x % y |
| 2536 | 5 3 1 2 |
| 2537 | -5 3 -1 -2 |
| 2538 | 5 -3 -1 2 |
| 2539 | -5 -3 1 -2 |
| 2540 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2541 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2542 | <p> |
| 2543 | If the dividend is positive and the divisor is a constant power of 2, |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2544 | the division may be replaced by a left shift, and computing the remainder may |
| 2545 | be replaced by a bitwise "and" operation: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2546 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2547 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2548 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2549 | x x / 4 x % 4 x >> 2 x & 3 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2550 | 11 2 3 2 3 |
| 2551 | -11 -2 -3 -3 1 |
| 2552 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2553 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2554 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2555 | The shift operators shift the left operand by the shift count specified by the |
| 2556 | right operand. They implement arithmetic shifts if the left operand is a signed |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2557 | integer and logical shifts if it is an unsigned integer. The shift count must |
| 2558 | be an unsigned integer. There is no upper limit on the shift count. Shifts behave |
| 2559 | as if the left operand is shifted <code>n</code> times by 1 for a shift |
| 2560 | count of <code>n</code>. |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2561 | As a result, <code>x << 1</code> is the same as <code>x*2</code> |
| 2562 | and <code>x >> 1</code> is the same as |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2563 | <code>x/2</code> truncated towards negative infinity. |
| 2564 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2565 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2566 | <p> |
| 2567 | For integer operands, the unary operators |
| 2568 | <code>+</code>, <code>-</code>, and <code>^</code> are defined as |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2569 | follows: |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2570 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2571 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2572 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2573 | +x is 0 + x |
| 2574 | -x negation is 0 - x |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 2575 | ^x bitwise complement is m ^ x with m = "all bits set to 1" for unsigned x |
| 2576 | and m = -1 for signed x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2577 | </pre> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2578 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2579 | <p> |
| 2580 | For floating point numbers, |
| 2581 | <code>+x</code> is the same as <code>x</code>, |
| 2582 | while <code>-x</code> is the negation of <code>x</code>. |
| 2583 | </p> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2584 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2585 | <h3 id="Integer_overflow">Integer overflow</h3> |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2586 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2587 | <p> |
| 2588 | For unsigned integer values, the operations <code>+</code>, |
| 2589 | <code>-</code>, <code>*</code>, and <code><<</code> are |
| 2590 | computed modulo 2<sup><i>n</i></sup>, where <i>n</i> is the bit width of |
| 2591 | the unsigned integer's type |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2592 | (§<a href="#Numeric_types">Numeric types</a>). Loosely speaking, these unsigned integer operations |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2593 | discard high bits upon overflow, and programs may rely on ``wrap around''. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2594 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2595 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2596 | For signed integers, the operations <code>+</code>, |
| 2597 | <code>-</code>, <code>*</code>, and <code><<</code> may legally |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2598 | overflow and the resulting value exists and is deterministically defined |
| 2599 | by the signed integer representation, the operation, and its operands. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2600 | No exception is raised as a result of overflow. A |
Robert Griesemer | 9dfb2ea | 2008-12-12 10:30:10 -0800 | [diff] [blame] | 2601 | compiler may not optimize code under the assumption that overflow does |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2602 | not occur. For instance, it may not assume that <code>x < x + 1</code> is always true. |
| 2603 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2604 | |
| 2605 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2606 | <h3 id="Comparison_operators">Comparison operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2607 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2608 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2609 | Comparison operators yield a boolean result. All comparison operators apply |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2610 | to basic types except bools. |
| 2611 | The operators <code>==</code> and <code>!=</code> apply, at least in some cases, |
| 2612 | to all types except arrays and structs. |
| 2613 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2614 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2615 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2616 | == equal |
| 2617 | != not equal |
| 2618 | < less |
| 2619 | <= less or equal |
| 2620 | > greater |
| 2621 | >= greater or equal |
| 2622 | </pre> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2623 | |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2624 | <p> |
| 2625 | Numeric basic types are compared in the usual way. |
| 2626 | </p> |
| 2627 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 2628 | Strings are compared byte-wise (lexically). |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2629 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2630 | <p> |
Robert Griesemer | 18b05c1 | 2009-01-26 09:34:19 -0800 | [diff] [blame] | 2631 | Booleans are equal if they are either both "true" or both "false". |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2632 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2633 | <p> |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2634 | The rules for comparison of composite types are described in the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2635 | section on §<a href="#Comparison_compatibility">Comparison compatibility</a>. |
Rob Pike | 5af7de3 | 2009-02-24 15:17:59 -0800 | [diff] [blame] | 2636 | </p> |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 2637 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2638 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2639 | <h3 id="Logical_operators">Logical operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2640 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2641 | <p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2642 | Logical operators apply to boolean operands and yield a boolean result. |
| 2643 | The right operand is evaluated conditionally. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2644 | </p> |
Robert Griesemer | 41d65ac | 2008-09-04 15:17:27 -0700 | [diff] [blame] | 2645 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2646 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2647 | && conditional and p && q is "if p then q else false" |
| 2648 | || conditional or p || q is "if p then true else q" |
| 2649 | ! not !p is "not p" |
| 2650 | </pre> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 2651 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2652 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2653 | <h3 id="Address_operators">Address operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2654 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2655 | <p> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2656 | The unary prefix address-of operator <code>&</code> generates the address of its operand, which must be a variable, |
| 2657 | pointer indirection, field selector, or array or slice indexing operation. It is illegal to take the address of a function |
| 2658 | result variable. |
| 2659 | Given an operand of pointer type, the unary prefix pointer indirection operator <code>*</code> retrieves the value pointed |
| 2660 | to by the operand. |
| 2661 | </p> |
| 2662 | |
| 2663 | <pre> |
| 2664 | &x |
| 2665 | &a[f(2)] |
| 2666 | *p |
| 2667 | *pf(x) |
| 2668 | </pre> |
| 2669 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2670 | <p> |
| 2671 | <font color=red>TODO: This text needs to be cleaned up and go elsewhere, there are no address |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2672 | operators involved. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2673 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2674 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2675 | <p> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2676 | Methods are a form of function and a method ``value'' has a function type. |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2677 | Consider the type T with method M: |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2678 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2679 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2680 | <pre> |
| 2681 | type T struct { |
| 2682 | a int; |
| 2683 | } |
| 2684 | func (tp *T) M(a int) int; |
| 2685 | var t *T; |
| 2686 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2687 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2688 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2689 | To construct the value of method M, one writes |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2690 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2691 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2692 | <pre> |
| 2693 | t.M |
| 2694 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2695 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2696 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2697 | using the variable t (not the type T). |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2698 | <font color=red>TODO: It makes perfect sense to be able to say T.M (in fact, it makes more |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2699 | sense then t.M, since only the type T is needed to find the method M, i.e., |
| 2700 | its address). TBD. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2701 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2702 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2703 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2704 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2705 | The expression t.M is a function value with type |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2706 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2707 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2708 | <pre> |
| 2709 | func (t *T, a int) int |
| 2710 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2711 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2712 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2713 | and may be invoked only as a function, not as a method: |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2714 | </p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2715 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2716 | <pre> |
| 2717 | var f func (t *T, a int) int; |
| 2718 | f = t.M; |
| 2719 | x := f(t, 7); |
| 2720 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2721 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2722 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2723 | Note that one does not write t.f(7); taking the value of a method demotes |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2724 | it to a function. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2725 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2726 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2727 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2728 | In general, given type T with method M and variable t of type T, |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2729 | the method invocation |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2730 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2731 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2732 | <pre> |
| 2733 | t.M(args) |
| 2734 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2735 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2736 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2737 | is equivalent to the function call |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2738 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2739 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2740 | <pre> |
| 2741 | (t.M)(t, args) |
| 2742 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2743 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2744 | <p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2745 | <font color=red> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2746 | TODO: should probably describe the effect of (t.m) under §<a href="#Expressions_if_t">Expressions if t</a>.m |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2747 | denotes a method: Effect is as described above, converts into function. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2748 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2749 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2750 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2751 | If T is an interface type, the expression t.M does not determine which |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2752 | underlying type's M is called until the point of the call itself. Thus given |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 2753 | T1 and T2, both implementing interface I with method M, the sequence |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2754 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2755 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2756 | <pre> |
| 2757 | var t1 *T1; |
| 2758 | var t2 *T2; |
| 2759 | var i I = t1; |
| 2760 | m := i.M; |
| 2761 | m(t2, 7); |
| 2762 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2763 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2764 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2765 | will invoke t2.M() even though m was constructed with an expression involving |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2766 | t1. Effectively, the value of m is a function literal |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2767 | </p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2768 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2769 | <pre> |
| 2770 | func (recv I, a int) { |
| 2771 | recv.M(a); |
| 2772 | } |
| 2773 | </pre> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2774 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2775 | <p> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2776 | that is automatically created. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2777 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2778 | <p> |
| 2779 | <font color=red> |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2780 | TODO: Document implementation restriction: It is illegal to take the address |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2781 | of a result parameter (e.g.: func f() (x int, p *int) { return 2, &x }). |
Robert Griesemer | 2b9fe0e | 2009-01-30 14:48:29 -0800 | [diff] [blame] | 2782 | (TBD: is it an implementation restriction or fact?) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2783 | </font> |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 2784 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2785 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2786 | <h3 id="Communication_operators">Communication operators</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2787 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2788 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2789 | The term <i>channel</i> means "variable of channel type" (§<a href="#Channel_types">Channel types</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2790 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2791 | <p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2792 | The send operation uses the binary operator "<-", which operates on |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2793 | a channel and a value (expression): |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2794 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2795 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2796 | <pre> |
| 2797 | ch <- 3 |
| 2798 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2799 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2800 | <p> |
| 2801 | The send operation sends the value on the channel. Both the channel |
| 2802 | and the expression are evaluated before communication begins. |
| 2803 | Communication blocks until the send can proceed, at which point the |
| 2804 | value is transmitted on the channel. A send can proceed if the |
| 2805 | channel is asynchronous and there is room in its buffer or the |
| 2806 | channel is synchronous and a receiver is ready. |
| 2807 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2808 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2809 | If the send operation appears in an expression context, the value |
| 2810 | of the expression is a boolean and the operation is non-blocking. |
| 2811 | The value of the boolean reports true if the communication succeeded, |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2812 | false if it did not. (The channel and |
| 2813 | the expression to be sent are evaluated regardless.) |
| 2814 | These two examples are equivalent: |
| 2815 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2816 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2817 | <pre> |
| 2818 | ok := ch <- 3; |
| 2819 | if ok { print("sent") } else { print("not sent") } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2820 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2821 | if ch <- 3 { print("sent") } else { print("not sent") } |
| 2822 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2823 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2824 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2825 | In other words, if the program tests the value of a send operation, |
| 2826 | the send is non-blocking and the value of the expression is the |
| 2827 | success of the operation. If the program does not test the value, |
| 2828 | the operation blocks until it succeeds. |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2829 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2830 | <p> |
| 2831 | The receive operation uses the prefix unary operator "<-". |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2832 | The value of the expression is the value received, whose type |
| 2833 | is the element type of the channel. |
| 2834 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2835 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2836 | <pre> |
| 2837 | <-ch |
| 2838 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2839 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2840 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2841 | The expression blocks until a value is available, which then can |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2842 | be assigned to a variable or used like any other expression. |
| 2843 | If the receive expression does not save the value, the value is |
| 2844 | discarded. |
| 2845 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2846 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2847 | <pre> |
| 2848 | v1 := <-ch |
| 2849 | v2 = <-ch |
| 2850 | f(<-ch) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2851 | <-strobe // wait until clock pulse |
| 2852 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2853 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2854 | <p> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2855 | If a receive expression is used in an assignment or initialization of the form |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2856 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2857 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2858 | <pre> |
Rob Pike | d553707 | 2009-08-22 00:04:04 -0700 | [diff] [blame] | 2859 | x, ok = <-ch |
| 2860 | x, ok := <-ch |
| 2861 | var x, ok = <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2862 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2863 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2864 | <p> |
| 2865 | the receive operation becomes non-blocking. |
| 2866 | If the operation can proceeed, the boolean variable |
| 2867 | <code>ok</code> will be set to <code>true</code> |
| 2868 | and the value stored in <code>x</code>; otherwise |
| 2869 | <code>ok</code> is set |
| 2870 | to <code>false</code> and <code>x</code> is set to the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2871 | zero value for its type (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2872 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2873 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2874 | <p> |
| 2875 | <font color=red>TODO: Probably in a separate section, communication semantices |
| 2876 | need to be presented regarding send, receive, select, and goroutines.</font> |
| 2877 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2878 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2879 | <h3 id="Constant_expressions">Constant expressions</h3> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2880 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2881 | <p> |
| 2882 | Constant expressions may contain only constants, <code>iota</code>, |
| 2883 | numeric literals, string literals, and |
| 2884 | some constant-valued built-in functions such as <code>unsafe.Sizeof</code> |
| 2885 | and <code>len</code> applied to an array. |
| 2886 | In practice, constant expressions are those that can be evaluated at compile time. |
| 2887 | <p> |
| 2888 | The type of a constant expression is determined by the type of its |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2889 | elements. If it contains only numeric literals, its type is <i>ideal |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2890 | integer</i> or <i>ideal float</i> (§<a href="#Ideal_number">Ideal number</a>). Whether a literal |
Rob Pike | ce9417e | 2009-03-12 17:08:47 -0700 | [diff] [blame] | 2891 | is an integer or float depends on the syntax of the literals (123 vs. 123.0). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 2892 | The nature of the arithmetic |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2893 | operations within the expression depends, elementwise, on the values; |
| 2894 | for example, 3/2 is an integer division yielding 1, while 3./2. is |
| 2895 | a floating point division yielding 1.5. Thus |
| 2896 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2897 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2898 | <pre> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2899 | const x = 3./2. + 3/2; |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2900 | </pre> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2901 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 2902 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2903 | yields a floating point constant of ideal float value 2.5 (1.5 + |
| 2904 | 1); its constituent expressions are evaluated using distinct rules |
| 2905 | for division. |
| 2906 | </p> |
| 2907 | |
| 2908 | <p> |
| 2909 | Intermediate values and the constants themselves |
| 2910 | may require precision significantly larger than any concrete type |
| 2911 | in the language. The following are legal declarations: |
| 2912 | </p> |
| 2913 | |
| 2914 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 2915 | const Huge = 1 << 100; |
| 2916 | const Four int8 = Huge >> 98; |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2917 | </pre> |
| 2918 | |
| 2919 | <p> |
| 2920 | A constant expression may appear in any context, such as assignment |
| 2921 | to a variable of any numeric type, as long as the value of the |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2922 | expression can be represented accurately in that context. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2923 | It is erroneous to assign a value with a non-zero fractional part |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 2924 | to an integer, or if the assignment would overflow or underflow, |
| 2925 | or in general if the value cannot be represented by the type of |
| 2926 | the variable. |
| 2927 | For |
| 2928 | instance, <code>3</code> can be assigned to any integer variable but also to any |
| 2929 | floating point variable, while <code>-1e12</code> can be assigned to a |
| 2930 | <code>float32</code>, <code>float64</code>, or even <code>int64</code> |
| 2931 | but not <code>uint64</code> or <code>string</code>. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 2932 | </p> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2933 | |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 2934 | <p> |
| 2935 | If a typed constant expression evaluates to a value that is not |
| 2936 | representable by that type, the compiler reports an error. |
| 2937 | </p> |
| 2938 | |
| 2939 | <pre> |
| 2940 | uint8(-1) // error, out of range |
| 2941 | uint8(100) * 100 // error, out of range |
| 2942 | </pre> |
| 2943 | |
| 2944 | <p> |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 2945 | The mask used by the unary bitwise complement operator matches |
| 2946 | the rule for non-constants: the mask is the all 1s for unsigned constants |
| 2947 | and -1 for signed and ideal constants. |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 2948 | </p> |
| 2949 | |
| 2950 | <pre> |
| 2951 | ^1 // ideal constant, equal to -2 |
| 2952 | uint8(^1) // error, same as uint8(-2), out of range |
| 2953 | ^uint8(1) // typed uint8 constant, same as 0xFF ^ uint8(1) = uint8(0xFE) |
| 2954 | int8(^1) // same as int8(-2) |
Russ Cox | d83dc4f | 2009-05-29 16:04:16 -0700 | [diff] [blame] | 2955 | ^int8(1) // same as -1 ^ int8(1) = -2 |
Rob Pike | 21d0349 | 2009-03-24 19:16:42 -0700 | [diff] [blame] | 2956 | </pre> |
| 2957 | |
| 2958 | <p> |
| 2959 | TODO: perhaps ^ should be disallowed on non-uints instead of assuming twos complement. |
| 2960 | Also it may be possible to make typed constants more like variables, at the cost of fewer |
| 2961 | overflow etc. errors being caught. |
| 2962 | </p> |
| 2963 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2964 | <h3 id="Order_of_evaluation">Order of evaluation</h3> |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2965 | |
| 2966 | <p> |
| 2967 | When evaluating the elements of an assignment or expression, |
| 2968 | all function calls, method calls and |
| 2969 | communication operations are evaluated in lexical left-to-right |
| 2970 | order. Otherwise, the order of evaluation is unspecified. |
| 2971 | </p> |
| 2972 | |
| 2973 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2974 | For example, in the assignment |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2975 | </p> |
| 2976 | <pre> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2977 | y[f()], ok = g(h(), i() + x[j()], <-c), k() |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2978 | </pre> |
| 2979 | <p> |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 2980 | the function calls and communication happen in the order |
| 2981 | <code>f()</code>, <code>h()</code>, <code>i()</code>, <code>j()</code>, |
| 2982 | <code><-c</code>, <code>g()</code>, and <code>k()</code>. |
| 2983 | However, the order of those events compared to the evaluation |
| 2984 | and indexing of <code>x</code> and the evaluation |
| 2985 | of <code>y</code> is not specified. |
Rob Pike | c956e90 | 2009-04-14 20:10:49 -0700 | [diff] [blame] | 2986 | </p> |
| 2987 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 2988 | <hr/> |
Robert Griesemer | b90b213 | 2008-09-19 15:49:55 -0700 | [diff] [blame] | 2989 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 2990 | <h2 id="Statements">Statements</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2991 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2992 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2993 | Statements control execution. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 2994 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 2995 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 2996 | <pre class="ebnf"> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 2997 | Statement = |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 2998 | Declaration | EmptyStmt | LabeledStmt | |
| 2999 | SimpleStmt | GoStmt | ReturnStmt | BreakStmt | ContinueStmt | GotoStmt | |
| 3000 | FallthroughStmt | Block | IfStmt | SwitchStmt | SelectStmt | ForStmt | |
| 3001 | DeferStmt . |
Robert Griesemer | 7abfcd9 | 2008-10-07 17:14:30 -0700 | [diff] [blame] | 3002 | |
Robert Griesemer | e1b8cb8 | 2009-07-16 20:31:41 -0700 | [diff] [blame] | 3003 | SimpleStmt = ExpressionStmt | IncDecStmt | Assignment | ShortVarDecl . |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3004 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3005 | StatementList = Statement { Separator Statement } . |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3006 | Separator = [ ";" ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3007 | </pre> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 3008 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3009 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3010 | Elements of a list of statements are separated by semicolons, |
| 3011 | which may be omitted only if the previous statement: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 3012 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3013 | <ul> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3014 | <li>ends with the closing parenthesis ")" of a list of declarations |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 3015 | (§<a href="#Declarations_and_scope">Declarations and scope</a>); or</li> |
Rob Pike | 736a1ae | 2009-04-02 23:03:41 -0700 | [diff] [blame] | 3016 | <li>ends with a closing brace "}" that is not part of an expression. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3017 | </ul> |
Robert Griesemer | 7271e04 | 2008-10-09 20:05:24 -0700 | [diff] [blame] | 3018 | |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3019 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3020 | <h3 id="Empty_statements">Empty statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3021 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3022 | <p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3023 | The empty statement does nothing. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3024 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3025 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3026 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3027 | EmptyStmt = . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3028 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3029 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3030 | <p> |
| 3031 | A statement list can always in effect be terminated with a semicolon by |
| 3032 | adding an empty statement. |
| 3033 | </p> |
| 3034 | |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3035 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3036 | <h3 id="Labeled_statements">Labeled statements</h3> |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3037 | |
| 3038 | <p> |
| 3039 | A labeled statement may be the target of a <code>goto</code>, |
| 3040 | <code>break</code> or <code>continue</code> statement. |
| 3041 | </p> |
| 3042 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3043 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3044 | LabeledStmt = Label ":" Statement . |
Robert Griesemer | dea4394 | 2009-03-16 17:36:52 -0700 | [diff] [blame] | 3045 | Label = identifier . |
| 3046 | </pre> |
| 3047 | |
| 3048 | <pre> |
| 3049 | Error: log.Fatal("error encountered") |
| 3050 | </pre> |
| 3051 | |
| 3052 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3053 | <h3 id="Expression_statements">Expression statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3054 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3055 | <p> |
| 3056 | Function calls, method calls, and channel operations |
| 3057 | can appear in statement context. |
| 3058 | </p> |
| 3059 | |
| 3060 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3061 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3062 | ExpressionStmt = Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3063 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3064 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3065 | <pre> |
| 3066 | f(x+y) |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3067 | <-ch |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3068 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3069 | |
| 3070 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3071 | <h3 id="IncDec_statements">IncDec statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3072 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3073 | <p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3074 | The "++" and "--" statements increment or decrement their operands |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3075 | by the ideal numeric value 1. As with an assignment, the operand |
| 3076 | must be a variable, pointer indirection, field selector or index expression. |
| 3077 | </p> |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3078 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3079 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3080 | IncDecStmt = Expression ( "++" | "--" ) . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3081 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3082 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3083 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3084 | The following assignment statements (§<a href="#Assignments">Assignments</a>) are semantically |
Robert Griesemer | 52a5480 | 2008-09-30 13:02:50 -0700 | [diff] [blame] | 3085 | equivalent: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3086 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3087 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3088 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3089 | IncDec statement Assignment |
| 3090 | x++ x += 1 |
| 3091 | x-- x -= 1 |
| 3092 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3093 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3094 | <h3 id="Assignments">Assignments</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3095 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3096 | <pre class="ebnf"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3097 | Assignment = ExpressionList assign_op ExpressionList . |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3098 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3099 | assign_op = [ add_op | mul_op ] "=" . |
| 3100 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3101 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3102 | <p> |
| 3103 | Each left-hand side operand must be a variable, pointer indirection, |
| 3104 | field selector, or index expression. |
| 3105 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3106 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3107 | <pre> |
| 3108 | x = 1 |
| 3109 | *p = f() |
| 3110 | a[i] = 23 |
| 3111 | k = <-ch |
Rob Pike | 307ec21 | 2009-03-12 15:53:56 -0700 | [diff] [blame] | 3112 | i &^= 1<<n |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3113 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3114 | |
| 3115 | <p> |
| 3116 | An <i>assignment operation</i> <code>x</code> <i>op</i><code>=</code> |
| 3117 | <code>y</code> where <i>op</i> is a binary arithmetic operation is equivalent |
| 3118 | to <code>x</code> <code>=</code> <code>x</code> <i>op</i> |
| 3119 | <code>y</code> but evalutates <code>x</code> |
| 3120 | only once. The <i>op</i><code>=</code> construct is a single token. |
| 3121 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3122 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3123 | <pre> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3124 | a[i] <<= 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3125 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3126 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3127 | <p> |
| 3128 | A tuple assignment assigns the individual elements of a multi-valued |
| 3129 | operation to a list of variables. There are two forms. In the |
| 3130 | first, the right hand operand is a single multi-valued expression |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3131 | such as a function evaluation or channel or map operation (§<a href="#Channel">Channel</a> |
| 3132 | operations, §<a href="#Map_operations">Map operations</a>) or a type assertion (§<a href="#Type_assertions">Type assertions</a>). |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3133 | The number of operands on the left |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3134 | hand side must match the number of values. For instance, If |
| 3135 | <code>f</code> is a function returning two values, |
| 3136 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3137 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3138 | <pre> |
| 3139 | x, y = f() |
| 3140 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3141 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3142 | <p> |
| 3143 | assigns the first value to <code>x</code> and the second to <code>y</code>. |
| 3144 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3145 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3146 | <p> |
| 3147 | 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] | 3148 | of expressions on the right, each of which must be single-valued, and the |
| 3149 | <i>n</i>th expression on the right is assigned to the <i>n</i>th |
| 3150 | operand on the left. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3151 | The expressions on the right are evaluated before assigning to |
| 3152 | any of the operands on the left, but otherwise the evaluation |
| 3153 | order is unspecified. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3154 | </p> |
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 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3157 | a, b = b, a // exchange a and b |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3158 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3159 | |
| 3160 | <p> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3161 | In assignments, the type of each value must be |
| 3162 | <a href="#Assignment_compatibility">assignment compatible</a> with the type of the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3163 | operand to which it is assigned. |
| 3164 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3165 | |
| 3166 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3167 | <h3 id="If_statements">If statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3168 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3169 | <p> |
| 3170 | "If" statements specify the conditional execution of two branches |
| 3171 | according to the value of a boolean expression. If the expression |
| 3172 | evaluates to true, the "if" branch is executed, otherwise, if |
| 3173 | present, the "else" branch is executed. A missing condition |
| 3174 | is equivalent to <code>true</code>. |
| 3175 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3176 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3177 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3178 | IfStmt = "if" [ [ SimpleStmt ] ";" ] [ Expression ] Block [ "else" Statement ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3179 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3180 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3181 | <pre> |
| 3182 | if x > 0 { |
| 3183 | return true; |
| 3184 | } |
| 3185 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3186 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3187 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3188 | The expression may be preceded by a simple statement, which |
| 3189 | executes before the expression is evaluated. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3190 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3191 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3192 | <pre> |
| 3193 | if x := f(); x < y { |
| 3194 | return x; |
| 3195 | } else if x > z { |
| 3196 | return z; |
| 3197 | } else { |
| 3198 | return y; |
| 3199 | } |
| 3200 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3201 | |
| 3202 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3203 | <h3 id="Switch_statements">Switch statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3204 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3205 | <p> |
| 3206 | "Switch" statements provide multi-way execution. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3207 | An expression or type specifier is compared to the "cases" |
| 3208 | inside the "switch" to determine which branch |
| 3209 | to execute. |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3210 | </p> |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3211 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3212 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3213 | SwitchStmt = ExprSwitchStmt | TypeSwitchStmt . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3214 | </pre> |
| 3215 | |
Rob Pike | afee1c5 | 2009-03-20 17:41:25 -0700 | [diff] [blame] | 3216 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3217 | There are two forms: expression switches and type switches. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3218 | In an expression switch, the cases contain expressions that are compared |
| 3219 | against the value of the switch expression. |
| 3220 | In a type switch, the cases contain types that are compared against the |
| 3221 | type of a specially annotated switch expression. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3222 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3223 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3224 | <h4 id="Expression_switches">Expression switches</h4> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3225 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3226 | <p> |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3227 | In an expression switch, |
| 3228 | the switch expression is evaluated and |
| 3229 | the case expressions, which need not be constants, |
Robert Griesemer | 4f18549 | 2009-05-01 17:00:16 -0700 | [diff] [blame] | 3230 | 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] | 3231 | switch expression |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3232 | triggers execution of the statements of the associated case; |
| 3233 | the other cases are skipped. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3234 | If no case matches and there is a "default" case, |
| 3235 | its statements are executed. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3236 | There can be at most one default case and it may appear anywhere in the |
| 3237 | "switch" statement. |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3238 | A missing expression is equivalent to |
| 3239 | the expression <code>true</code>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3240 | </p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3241 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3242 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3243 | ExprSwitchStmt = "switch" [ [ SimpleStmt ] ";" ] [ Expression ] "{" { ExprCaseClause } "}" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3244 | ExprCaseClause = ExprSwitchCase ":" [ StatementList ] . |
| 3245 | ExprSwitchCase = "case" ExpressionList | "default" . |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3246 | </pre> |
| 3247 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3248 | <p> |
| 3249 | In a case or default clause, |
| 3250 | the last statement only may be a "fallthrough" statement |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3251 | (§<a href="#Fallthrough_statement">Fallthrough statement</a>) to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3252 | indicate that control should flow from the end of this clause to |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3253 | the first statement of the next clause. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3254 | Otherwise control flows to the end of the "switch" statement. |
| 3255 | </p> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 3256 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3257 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3258 | The expression may be preceded by a simple statement, which |
| 3259 | executes before the expression is evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3260 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3261 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3262 | <pre> |
| 3263 | switch tag { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3264 | default: s3() |
| 3265 | case 0, 1, 2, 3: s1() |
| 3266 | case 4, 5, 6, 7: s2() |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3267 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3268 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3269 | switch x := f(); { |
Rob Pike | 65ec16b | 2009-05-29 15:46:03 -0700 | [diff] [blame] | 3270 | case x < 0: return -x |
| 3271 | default: return x |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3272 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3273 | |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3274 | switch { // missing expression means "true" |
| 3275 | case x < y: f1(); |
| 3276 | case x < z: f2(); |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3277 | case x == 4: f3(); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3278 | } |
| 3279 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3280 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3281 | <h4 id="Type_switches">Type switches</h4> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3282 | |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3283 | <p> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3284 | A type switch compares types rather than values. It is otherwise similar |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3285 | 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] | 3286 | has the form of a <a href="#Type_assertions">type assertion</a> |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3287 | using the reserved word <code>type</code> rather than an actual type. |
| 3288 | Cases then match literal types against the dynamic type of the expression |
Rob Pike | f538760 | 2009-03-30 16:08:41 -0700 | [diff] [blame] | 3289 | in the type assertion. |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3290 | </p> |
| 3291 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3292 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3293 | TypeSwitchStmt = "switch" [ [ SimpleStmt ] ";" ] TypeSwitchGuard "{" { TypeCaseClause } "}" . |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3294 | TypeSwitchGuard = [ identifier ":=" ] Expression "." "(" "type" ")" . |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3295 | TypeCaseClause = TypeSwitchCase ":" [ StatementList ] . |
Robert Griesemer | 3b576a7 | 2009-06-17 14:31:33 -0700 | [diff] [blame] | 3296 | TypeSwitchCase = "case" Type | "default" . |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3297 | </pre> |
| 3298 | |
| 3299 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3300 | The TypeSwitchGuard may include a |
| 3301 | <a href="#Short_variable_declarations">short variable declaration</a>. |
| 3302 | When that form is used, the variable is declared in each clause. |
| 3303 | In clauses with a case listing exactly one type, the variable |
| 3304 | has that type; otherwise, the variable has the type of the expression |
| 3305 | in the TypeSwitchGuard. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3306 | </p> |
| 3307 | |
| 3308 | <p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3309 | The type in a case may be <code>nil</code> |
| 3310 | (§<a href="#Predeclared_identifiers">Predeclared identifiers</a>); |
| 3311 | that case is used when the expression in the TypeSwitchGuard |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3312 | is a <code>nil</code> interface value. |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3313 | </p> |
| 3314 | |
| 3315 | <p> |
| 3316 | Given a function <code>f</code> that returns |
| 3317 | a value of type <code>interface{}</code>, |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3318 | the following type switch: |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3319 | </p> |
| 3320 | |
| 3321 | <pre> |
| 3322 | switch i := f().(type) { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3323 | case nil: |
| 3324 | printString("f() returns nil"); |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3325 | case int: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3326 | printInt(i); // i is an int |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3327 | case float: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3328 | printFloat(i); // i is a float |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3329 | case func(int) float: |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3330 | printFunction(i); // i is a function |
| 3331 | case bool, string: |
| 3332 | printString("type is bool or string"); // i is an interface{} |
Rob Pike | 5a57849 | 2009-03-17 16:48:35 -0700 | [diff] [blame] | 3333 | default: |
| 3334 | printString("don't know the type"); |
| 3335 | } |
| 3336 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3337 | |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3338 | <p> |
| 3339 | could be rewritten: |
| 3340 | </p> |
| 3341 | |
| 3342 | <pre> |
| 3343 | v := f(); |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3344 | if v == nil { |
| 3345 | printString("f() returns nil"); |
| 3346 | } else if i, is_int := v.(int); is_int { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3347 | printInt(i); // i is an int |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3348 | } else if i, is_float := v.(float); is_float { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3349 | printFloat(i); // i is a float |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3350 | } else if i, is_func := v.(func(int) float); is_func { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3351 | printFunction(i); // i is a function |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3352 | } else { |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3353 | i1, is_bool := v.(bool); |
| 3354 | i2, is_string := v.(string); |
| 3355 | if is_bool || is_string { |
| 3356 | i := v; |
| 3357 | printString("type is bool or string"); // i is an interface{} |
| 3358 | } else { |
| 3359 | i := v; |
| 3360 | printString("don't know the type"); // i is an interface{} |
| 3361 | } |
Rob Pike | 70c1a10 | 2009-03-18 19:23:59 -0700 | [diff] [blame] | 3362 | } |
| 3363 | </pre> |
| 3364 | |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 3365 | <p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3366 | The type switch guard may be preceded by a simple statement, which |
| 3367 | executes before the guard is evaluated. |
Robert Griesemer | 1f95f0d | 2009-08-27 16:44:17 -0700 | [diff] [blame] | 3368 | </p> |
Robert Griesemer | 9ecd30a | 2009-08-27 14:22:51 -0700 | [diff] [blame] | 3369 | |
| 3370 | <p> |
| 3371 | The "fallthrough" statement is not permitted in a type switch. |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3372 | </p> |
| 3373 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3374 | <h3 id="For_statements">For statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3375 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3376 | <p> |
| 3377 | A "for" statement specifies repeated execution of a block. The iteration is |
| 3378 | controlled by a condition, a "for" clause, or a "range" clause. |
| 3379 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3380 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3381 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3382 | ForStmt = "for" [ Condition | ForClause | RangeClause ] Block . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3383 | Condition = Expression . |
| 3384 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3385 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3386 | <p> |
| 3387 | In its simplest form, a "for" statement specifies the repeated execution of |
| 3388 | a block as long as a boolean condition evaluates to true. |
| 3389 | The condition is evaluated before each iteration. |
| 3390 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3391 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3392 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3393 | <pre> |
| 3394 | for a < b { |
| 3395 | a *= 2 |
| 3396 | } |
| 3397 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3398 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3399 | <p> |
| 3400 | A "for" statement with a "for" clause is also controlled by its condition, but |
| 3401 | additionally it may specify an <i>init</i> |
| 3402 | and a <i>post</i> statement, such as an assignment, |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 3403 | an increment or decrement statement. The init statement may be a |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3404 | <a href="#Short_variable_declarations">short variable declaration</a>, but the post statement must not. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3405 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3406 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3407 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3408 | ForClause = [ InitStmt ] ";" [ Condition ] ";" [ PostStmt ] . |
| 3409 | InitStmt = SimpleStmt . |
| 3410 | PostStmt = SimpleStmt . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3411 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3412 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3413 | <pre> |
| 3414 | for i := 0; i < 10; i++ { |
| 3415 | f(i) |
| 3416 | } |
| 3417 | </pre> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3418 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3419 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3420 | If non-empty, the init statement is executed once before evaluating the |
| 3421 | condition for the first iteration; |
| 3422 | the post statement is executed after each execution of the block (and |
| 3423 | only if the block was executed). |
| 3424 | Any element of the "for" clause may be empty but the semicolons are |
| 3425 | required unless there is only a condition. |
| 3426 | If the condition is absent, it is equivalent to <code>true</code>. |
| 3427 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3428 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3429 | <pre> |
| 3430 | for ; cond ; { S() } is the same as for cond { S() } |
| 3431 | for true { S() } is the same as for { S() } |
| 3432 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3433 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3434 | <p> |
| 3435 | A "for" statement with a "range" clause |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3436 | iterates through all entries of an array, slice, string or map, |
| 3437 | or values received on a channel. |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3438 | For each entry it first assigns the current index or key to an iteration |
| 3439 | variable - or the current (index, element) or (key, value) pair to a pair |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3440 | of iteration variables - and then executes the block. |
| 3441 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3442 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3443 | <pre class="ebnf"> |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3444 | RangeClause = ExpressionList ( "=" | ":=" ) "range" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3445 | </pre> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3446 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3447 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3448 | The type of the right-hand expression in the "range" clause must be an |
| 3449 | array, slice, string or map, or a pointer to an array, slice, string or map; |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3450 | or it may be a channel. |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3451 | Except for channels, |
Rob Pike | b340879 | 2009-04-15 20:51:17 -0700 | [diff] [blame] | 3452 | the identifier list must contain one or two expressions |
| 3453 | (as in assignments, these must be a |
| 3454 | variable, pointer indirection, field selector, or index expression) |
| 3455 | denoting the |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3456 | iteration variables. On each iteration, |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3457 | the first variable is set to the string, array or slice index or |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3458 | map key, and the second variable, if present, is set to the corresponding |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3459 | string or array element or map value. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3460 | The types of the array or slice index (always <code>int</code>) |
| 3461 | and element, or of the map key and value respectively, |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3462 | must be <a href="#Assignment_compatibility">assignment compatible</a> to the iteration variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3463 | </p> |
| 3464 | <p> |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3465 | For strings, the "range" clause iterates over the Unicode code points |
| 3466 | in the string. On successive iterations, the index variable will be the |
Rob Pike | 55faa5f | 2009-04-15 21:49:50 -0700 | [diff] [blame] | 3467 | index of successive UTF-8-encoded code points in the string, and |
Rob Pike | 7aee71b | 2009-04-15 20:28:25 -0700 | [diff] [blame] | 3468 | the second variable, of type <code>int</code>, will be the value of |
| 3469 | the corresponding code point. If the iteration encounters an invalid |
| 3470 | UTF-8 sequence, the second variable will be <code>0xFFFD</code>, |
| 3471 | the Unicode replacement character, and the next iteration will advance |
| 3472 | a single byte in the string. |
| 3473 | </p> |
| 3474 | <p> |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3475 | For channels, the identifier list must contain one identifier. |
Robert Griesemer | ce9fbdb | 2009-04-29 11:45:08 -0700 | [diff] [blame] | 3476 | The iteration receives values sent on the channel until the channel is closed; |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3477 | it does not process the zero value sent before the channel is closed. |
| 3478 | </p> |
| 3479 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3480 | The iteration variables may be declared by the "range" clause (":="), in which |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3481 | case their scope ends at the end of the "for" statement (§<a href="#Declarations_and">Declarations and</a> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3482 | scope rules). In this case their types are set to |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3483 | <code>int</code> and the array element type, or the map key and value types, respectively. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3484 | If the iteration variables are declared outside the "for" statement, |
| 3485 | after execution their values will be those of the last iteration. |
| 3486 | </p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3487 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3488 | <pre> |
| 3489 | var a [10]string; |
Rob Pike | 426335f | 2009-03-02 17:52:52 -0800 | [diff] [blame] | 3490 | m := map[string]int{"mon":0, "tue":1, "wed":2, "thu":3, "fri":4, "sat":5, "sun":6}; |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3491 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3492 | for i, s := range a { |
| 3493 | // type of i is int |
| 3494 | // type of s is string |
| 3495 | // s == a[i] |
| 3496 | g(i, s) |
| 3497 | } |
| 3498 | |
| 3499 | var key string; |
| 3500 | var val interface {}; // value type of m is assignment-compatible to val |
| 3501 | for key, value = range m { |
| 3502 | h(key, value) |
| 3503 | } |
| 3504 | // key == last map key encountered in iteration |
| 3505 | // val == map[key] |
| 3506 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3507 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3508 | <p> |
Robert Griesemer | 30a1a8c | 2008-12-16 11:38:56 -0800 | [diff] [blame] | 3509 | If map entries that have not yet been processed are deleted during iteration, |
| 3510 | they will not be processed. If map entries are inserted during iteration, the |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3511 | behavior is implementation-dependent, but each entry will be processed at most once. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3512 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3513 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3514 | <h3 id="Go_statements">Go statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3515 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3516 | <p> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3517 | A "go" statement starts the execution of a function or method call |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3518 | as an independent concurrent thread of control, or <i>goroutine</i>, |
| 3519 | within the same address space. |
| 3520 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3521 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3522 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3523 | GoStmt = "go" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3524 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3525 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3526 | <p> |
| 3527 | The expression must be a call, and |
| 3528 | unlike with a regular call, program execution does not wait |
Robert Griesemer | b9f8b9c | 2008-09-26 13:38:38 -0700 | [diff] [blame] | 3529 | for the invoked function to complete. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3530 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3531 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3532 | <pre> |
| 3533 | go Server() |
| 3534 | go func(ch chan <- bool) { for { sleep(10); ch <- true; }} (c) |
| 3535 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3536 | |
| 3537 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3538 | <h3 id="Select_statements">Select statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3539 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3540 | <p> |
| 3541 | A "select" statement chooses which of a set of possible communications |
| 3542 | will proceed. It looks similar to a "switch" statement but with the |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3543 | cases all referring to communication operations. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3544 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3545 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3546 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3547 | SelectStmt = "select" "{" { CommClause } "}" . |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3548 | CommClause = CommCase ":" StatementList . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3549 | CommCase = "case" ( SendExpr | RecvExpr) | "default" . |
| 3550 | SendExpr = Expression "<-" Expression . |
| 3551 | RecvExpr = [ Expression ( "=" | ":=" ) ] "<-" Expression . |
| 3552 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3553 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3554 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3555 | For all the send and receive expressions in the "select" |
| 3556 | statement, the channel expression is evaluated. Any expressions |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3557 | that appear on the right hand side of send expressions are also |
| 3558 | evaluated. If any of the resulting channels can proceed, one is |
| 3559 | chosen and the corresponding communication and statements are |
| 3560 | evaluated. Otherwise, if there is a default case, that executes; |
Rob Pike | cd368a2 | 2008-10-02 10:37:12 -0700 | [diff] [blame] | 3561 | if not, the statement blocks until one of the communications can |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3562 | complete. The channels and send expressions are not re-evaluated. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3563 | A channel pointer may be <code>nil</code>, |
| 3564 | which is equivalent to that case not |
| 3565 | being present in the select statement |
| 3566 | except, if a send, its expression is still evaluated. |
| 3567 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3568 | <p> |
Rob Pike | 569a107 | 2008-10-03 11:18:45 -0700 | [diff] [blame] | 3569 | Since all the channels and send expressions are evaluated, any side |
| 3570 | effects in that evaluation will occur for all the communications |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3571 | in the "select" statement. |
| 3572 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3573 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3574 | If multiple cases can proceed, a uniform fair choice is made to decide |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3575 | which single communication will execute. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3576 | <p> |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3577 | The receive case may declare a new variable using a |
| 3578 | <a href="#Short_variable_declarations">short variable declaration</a>. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3579 | </p> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 3580 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3581 | <pre> |
| 3582 | var c, c1, c2 chan int; |
| 3583 | var i1, i2 int; |
| 3584 | select { |
| 3585 | case i1 = <-c1: |
| 3586 | print("received ", i1, " from c1\n"); |
| 3587 | case c2 <- i2: |
| 3588 | print("sent ", i2, " to c2\n"); |
| 3589 | default: |
| 3590 | print("no communication\n"); |
| 3591 | } |
| 3592 | |
| 3593 | for { // send random sequence of bits to c |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3594 | select { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3595 | case c <- 0: // note: no statement, no fallthrough, no folding of cases |
| 3596 | case c <- 1: |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3597 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3598 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3599 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3600 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3601 | <font color=red> |
Robert Griesemer | 2902a82 | 2008-09-17 13:57:11 -0700 | [diff] [blame] | 3602 | TODO: Make semantics more precise. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3603 | </font> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3604 | |
| 3605 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3606 | <h3 id="Return_statements">Return statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3607 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3608 | <p> |
| 3609 | A "return" statement terminates execution of the containing function |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3610 | and optionally provides a result value or values to the caller. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3611 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3612 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3613 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3614 | ReturnStmt = "return" [ ExpressionList ] . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3615 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3616 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3617 | <p> |
| 3618 | In a function without a result type, a "return" statement must not |
| 3619 | specify any result values. |
| 3620 | </p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3621 | <pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3622 | func no_result() { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3623 | return |
| 3624 | } |
| 3625 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3626 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3627 | <p> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3628 | There are three ways to return values from a function with a result |
| 3629 | type: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3630 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3631 | |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3632 | <ol> |
| 3633 | <li>The return value or values may be explicitly listed |
| 3634 | in the "return" statement. Each expression must be single-valued |
Robert Griesemer | 4ed666e | 2009-08-27 16:45:42 -0700 | [diff] [blame] | 3635 | and <a href="#Assignment_compatibility">assignment compatible</a> to the corresponding element of |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3636 | the result type of the function. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3637 | <pre> |
| 3638 | func simple_f() int { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3639 | return 2 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3640 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3641 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3642 | func complex_f1() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3643 | return -7.0, -4.0 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3644 | } |
| 3645 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3646 | </li> |
| 3647 | <li>The expression list in the "return" statement may be a single |
| 3648 | call to a multi-valued function. The effect is as if each value |
| 3649 | returned from that function were assigned to a temporary |
| 3650 | variable with the type of the respective value, followed by a |
| 3651 | "return" statement listing these variables, at which point the |
| 3652 | rules of the previous case apply. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3653 | <pre> |
| 3654 | func complex_f2() (re float, im float) { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3655 | return complex_f1() |
| 3656 | } |
| 3657 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3658 | </li> |
| 3659 | <li>The expression list may be empty if the functions's result |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3660 | type specifies names for its result parameters (§<a href="#Function_Types">Function Types</a>). |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3661 | The result parameters act as ordinary local variables that are |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3662 | initialized to the zero values for their type (§<a href="#The_zero_value">The zero value</a>) |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3663 | and the function may assign values to them as necessary. |
| 3664 | The "return" statement returns the values of these variables. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3665 | <pre> |
| 3666 | func complex_f3() (re float, im float) { |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3667 | re = 7.0; |
| 3668 | im = 4.0; |
| 3669 | return; |
| 3670 | } |
| 3671 | </pre> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3672 | </li> |
| 3673 | </ol> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3674 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3675 | <p> |
Robert Griesemer | 4b90833 | 2009-08-07 17:05:41 -0700 | [diff] [blame] | 3676 | <font color=red> |
| 3677 | TODO: Define when return is required.<br /> |
| 3678 | TODO: Language about result parameters needs to go into a section on |
| 3679 | function/method invocation<br /> |
| 3680 | </font> |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3681 | </p> |
| 3682 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3683 | <h3 id="Break_statements">Break statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3684 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3685 | <p> |
| 3686 | A "break" statement terminates execution of the innermost |
| 3687 | "for", "switch" or "select" statement. |
| 3688 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3689 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3690 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3691 | BreakStmt = "break" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3692 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3693 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3694 | <p> |
| 3695 | If there is a label, it must be that of an enclosing |
| 3696 | "for", "switch" or "select" statement, and that is the one whose execution |
| 3697 | terminates |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3698 | (§<a href="#For_statements">For statements</a>, §<a href="#Switch_statements">Switch statements</a>, §<a href="#Select_statements">Select statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3699 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3700 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3701 | <pre> |
| 3702 | L: for i < n { |
| 3703 | switch i { |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3704 | case 5: break L |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3705 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3706 | } |
| 3707 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3708 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3709 | <h3 id="Continue_statements">Continue statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3710 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3711 | <p> |
| 3712 | A "continue" statement begins the next iteration of the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3713 | innermost "for" loop at the post statement (§<a href="#For_statements">For statements</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3714 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3715 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3716 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3717 | ContinueStmt = "continue" [ Label ]. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3718 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3719 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3720 | <p> |
| 3721 | The optional label is analogous to that of a "break" statement. |
| 3722 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3723 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3724 | <h3 id="Goto_statements">Goto statements</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3725 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3726 | <p> |
| 3727 | A "goto" statement transfers control to the statement with the corresponding label. |
| 3728 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3729 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3730 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3731 | GotoStmt = "goto" Label . |
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 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3734 | <pre> |
| 3735 | goto Error |
| 3736 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3737 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3738 | <p> |
| 3739 | Executing the "goto" statement must not cause any variables to come into |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3740 | scope that were not already in scope at the point of the goto. For |
| 3741 | instance, this example: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3742 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3743 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3744 | <pre> |
| 3745 | goto L; // BAD |
| 3746 | v := 3; |
| 3747 | L: |
| 3748 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3749 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3750 | <p> |
| 3751 | is erroneous because the jump to label <code>L</code> skips |
| 3752 | the creation of <code>v</code>. |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 3753 | (TODO: Eliminate in favor of used and not set errors?) |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3754 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3755 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3756 | <h3 id="Fallthrough_statements">Fallthrough statements</h3> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3757 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3758 | <p> |
| 3759 | A "fallthrough" statement transfers control to the first statement of the |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3760 | next case clause in a expression "switch" statement (§<a href="#Expression_switches">Expression switches</a>). It may |
Robert Griesemer | 091cba8 | 2009-03-19 08:39:40 -0700 | [diff] [blame] | 3761 | be used only as the final non-empty statement in a case or default clause in an |
| 3762 | expression "switch" statement. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3763 | </p> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3764 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3765 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3766 | FallthroughStmt = "fallthrough" . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3767 | </pre> |
Robert Griesemer | aed247f | 2008-10-08 17:05:30 -0700 | [diff] [blame] | 3768 | |
| 3769 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3770 | <h3 id="Defer_statements">Defer statements</h3> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3771 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3772 | <p> |
| 3773 | A "defer" statement invokes a function whose execution is deferred to the moment |
| 3774 | the surrounding function returns. |
| 3775 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3776 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 3777 | <pre class="ebnf"> |
Rob Pike | 1141716 | 2009-03-24 17:45:53 -0700 | [diff] [blame] | 3778 | DeferStmt = "defer" Expression . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3779 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3780 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3781 | <p> |
| 3782 | The expression must be a function or method call. |
| 3783 | Each time the "defer" statement |
Robert Griesemer | 7471eab | 2009-01-27 14:51:24 -0800 | [diff] [blame] | 3784 | executes, the parameters to the function call are evaluated and saved anew but the |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3785 | function is not invoked. Immediately before the innermost function surrounding |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3786 | the "defer" statement returns, but after its return value (if any) is evaluated, |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3787 | each deferred function is executed with its saved parameters. Deferred functions |
| 3788 | are executed in LIFO order. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3789 | </p> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3790 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3791 | <pre> |
| 3792 | lock(l); |
| 3793 | defer unlock(l); // unlocking happens before surrounding function returns |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3794 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3795 | // prints 3 2 1 0 before surrounding function returns |
| 3796 | for i := 0; i <= 3; i++ { |
| 3797 | defer fmt.Print(i); |
| 3798 | } |
| 3799 | </pre> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3800 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3801 | <hr/> |
Robert Griesemer | 4a903e0 | 2009-01-27 09:29:40 -0800 | [diff] [blame] | 3802 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3803 | <h2 id="Predeclared_functions">Predeclared functions</h2> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3804 | <ul> |
| 3805 | <li>cap |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 3806 | <li>close |
| 3807 | <li>closed |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3808 | <li>len |
| 3809 | <li>make |
| 3810 | <li>new |
| 3811 | <li>panic |
| 3812 | <li>panicln |
| 3813 | <li>print |
| 3814 | <li>println |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3815 | </ul> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3816 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3817 | <h3 id="Length_and_capacity">Length and capacity</h3> |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3818 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3819 | <pre class="grammar"> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3820 | Call Argument type Result |
Robert Griesemer | 7a4ed4f | 2008-09-03 15:15:51 -0700 | [diff] [blame] | 3821 | |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 3822 | len(s) string string length (in bytes) |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3823 | [n]T, *[n]T array length (== n) |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 3824 | []T slice length |
| 3825 | map[K]T map length |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3826 | chan T number of elements in channel buffer |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3827 | |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 3828 | cap(s) [n]T, *[n]T array length (== n) |
| 3829 | []T slice capacity |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3830 | chan T channel buffer capacity |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3831 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3832 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3833 | <p> |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3834 | The type of the result is always <code>int</code> and the |
| 3835 | implementation guarantees that |
| 3836 | the result always fits into an <code>int</code>. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3837 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3838 | The capacity of a slice or map is the number of elements for which there is |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3839 | space allocated in the underlying array (for a slice) or map. For a slice |
| 3840 | <code>s</code>, at any time the following relationship holds: |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3841 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3842 | <pre> |
| 3843 | 0 <= len(s) <= cap(s) |
| 3844 | </pre> |
Robert Griesemer | 667ef6c | 2008-09-10 13:00:32 -0700 | [diff] [blame] | 3845 | |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3846 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3847 | <h3 id="Conversions">Conversions</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3848 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3849 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3850 | Conversions look like function calls of the form |
| 3851 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3852 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3853 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3854 | T(value) |
| 3855 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3856 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3857 | <p> |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3858 | where <code>T</code> is a type |
| 3859 | and <code>value</code> is an expression |
| 3860 | that can be converted to a value |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3861 | of result type <code>T</code>. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3862 | <p> |
Robert Griesemer | 133c68e | 2008-09-26 14:04:21 -0700 | [diff] [blame] | 3863 | The following conversion rules apply: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3864 | </p> |
| 3865 | <ul> |
| 3866 | <li> |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 3867 | 1) The conversion succeeds if the value is assignment-compatible |
| 3868 | to a variable of type T. |
Russ Cox | e8b4319 | 2009-03-03 08:10:25 -0800 | [diff] [blame] | 3869 | </li> |
| 3870 | <li> |
Robert Griesemer | e2cb60b | 2009-06-19 13:03:01 -0700 | [diff] [blame] | 3871 | 2) The conversion succeeds if the value would be assignment-compatible |
| 3872 | to a variable of type T if the value type or T or any of their component |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3873 | types are unnamed (§<a href="#Type_identity_and_compatibility">Type identity and compatibility</a>). |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3874 | </li> |
| 3875 | <li> |
| 3876 | 3) Between integer types. If the value is a signed quantity, it is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3877 | sign extended to implicit infinite precision; otherwise it is zero |
| 3878 | extended. It is then truncated to fit in the result type size. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3879 | For example, <code>uint32(int8(0xFF))</code> is <code>0xFFFFFFFF</code>. |
| 3880 | The conversion always yields a valid value; there is no signal for overflow. |
| 3881 | </li> |
| 3882 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3883 | 4) Between integer and floating point types, or between floating point |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3884 | types. To avoid overdefining the properties of the conversion, for |
Robert Griesemer | 434c605 | 2008-11-07 13:34:37 -0800 | [diff] [blame] | 3885 | now it is defined as a ``best effort'' conversion. The conversion |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3886 | always succeeds but the value may be a NaN or other problematic |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3887 | result. <font color=red>TODO: clarify?</font> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3888 | </li> |
| 3889 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3890 | 5) Strings permit three special conversions: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3891 | </li> |
| 3892 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3893 | 5a) Converting an integer value yields a string containing the UTF-8 |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3894 | representation of the integer. |
| 3895 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3896 | <pre> |
| 3897 | string(0x65e5) // "\u65e5" |
| 3898 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3899 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3900 | </li> |
| 3901 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3902 | 5b) Converting a slice of integers yields a string that is the |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame] | 3903 | concatenation of the individual integers converted to strings. |
| 3904 | If the slice value is <code>nil</code>, the result is the empty string. |
| 3905 | <pre> |
| 3906 | string([]int{0x65e5, 0x672c, 0x8a9e}) // "\u65e5\u672c\u8a9e" |
| 3907 | </pre> |
| 3908 | </li> |
| 3909 | <li> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 3910 | 5c) Converting a slice of bytes yields a string whose successive |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame] | 3911 | bytes are those of the slice. If the slice value is <code>nil</code>, |
| 3912 | the result is the empty string. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3913 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3914 | <pre> |
Robert Griesemer | 1a304e1 | 2009-05-08 10:25:06 -0700 | [diff] [blame] | 3915 | string([]byte{'h', 'e', 'l', 'l', 'o'}) // "hello" |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3916 | </pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3917 | </li> |
| 3918 | </ul> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3919 | |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3920 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3921 | There is no linguistic mechanism to convert between pointers and integers. |
| 3922 | The <code>unsafe</code> package |
| 3923 | implements this functionality under |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3924 | restricted circumstances (§<a href="#Package_unsafe">Package <code>unsafe</code></a>). |
Rob Pike | df3183f | 2009-02-26 16:37:23 -0800 | [diff] [blame] | 3925 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3926 | |
| 3927 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3928 | <h3 id="Allocation">Allocation</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3929 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3930 | <p> |
| 3931 | The built-in function <code>new</code> takes a type <code>T</code> and |
| 3932 | returns a value of type <code>*T</code>. |
Robert Griesemer | a329471 | 2009-01-05 11:17:26 -0800 | [diff] [blame] | 3933 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3934 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3935 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3936 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3937 | <pre> |
| 3938 | new(T) |
| 3939 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3940 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3941 | <p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 3942 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3943 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3944 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3945 | <pre> |
| 3946 | type S struct { a int; b float } |
| 3947 | new(S) |
| 3948 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3949 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3950 | <p> |
| 3951 | dynamically allocates memory for a variable of type <code>S</code>, |
| 3952 | initializes it (<code>a=0</code>, <code>b=0.0</code>), |
| 3953 | and returns a value of type <code>*S</code> containing the address |
| 3954 | of the memory. |
| 3955 | </p> |
| 3956 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3957 | <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] | 3958 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3959 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3960 | Slices, maps and channels are reference types that do not require the |
| 3961 | extra indirection of an allocation with <code>new</code>. |
| 3962 | The built-in function <code>make</code> takes a type <code>T</code>, |
| 3963 | which must be a slice, map or channel type, |
| 3964 | optionally followed by a type-specific list of expressions. |
| 3965 | It returns a value of type <code>T</code> (not <code>*T</code>). |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3966 | The memory is initialized as described in the section on initial values |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 3967 | (§<a href="#The_zero_value">The zero value</a>). |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3968 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3969 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3970 | <pre> |
| 3971 | make(T [, optional list of expressions]) |
| 3972 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3973 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3974 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3975 | For instance |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3976 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3977 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3978 | <pre> |
| 3979 | make(map[string] int) |
| 3980 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3981 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3982 | <p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3983 | creates a new map value and initializes it to an empty map. |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3984 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3985 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3986 | <p> |
| 3987 | The parameters affect sizes for allocating slices, maps, and |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3988 | buffered channels: |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 3989 | </p> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3990 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3991 | <pre> |
| 3992 | s := make([]int, 10, 100); # slice with len(s) == 10, cap(s) == 100 |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 3993 | s := make([]int, 10); # slice with len(s) == cap(s) == 10 |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 3994 | c := make(chan int, 10); # channel with a buffer size of 10 |
| 3995 | m := make(map[string] int, 100); # map with initial space for 100 elements |
| 3996 | </pre> |
Robert Griesemer | 633957b | 2009-01-06 13:23:20 -0800 | [diff] [blame] | 3997 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 3998 | <hr/> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 3999 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4000 | <h2 id="Packages">Packages</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4001 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4002 | <p> |
| 4003 | Go programs are constructed by linking together <i>packages</i>. |
| 4004 | A package is in turn constructed from one or more source files that |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4005 | together provide access to a set of types, constants, functions, |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4006 | and variables. Those elements may be <i>imported</i> and used in |
| 4007 | another package. |
| 4008 | </p> |
| 4009 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4010 | <h3 id="Source_file_organization">Source file organization</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4011 | |
| 4012 | <p> |
| 4013 | Each source file consists of a package clause defining the package |
| 4014 | to which it belongs, followed by a possibly empty set of import |
| 4015 | declarations that declare packages whose contents it wishes to use, |
| 4016 | followed by a possibly empty set of declarations of functions, |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4017 | types, variables, and constants. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4018 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4019 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4020 | <pre class="ebnf"> |
Robert Griesemer | 0a162a1 | 2009-08-19 16:44:04 -0700 | [diff] [blame] | 4021 | SourceFile = PackageClause { ImportDecl [ ";" ] } { TopLevelDecl [ ";" ] } . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4022 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4023 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4024 | <h3 id="Package_clause">Package clause</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4025 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4026 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4027 | A package clause begins each source file and defines the package |
| 4028 | to which the file belongs. |
| 4029 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4030 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4031 | <pre class="ebnf"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4032 | PackageClause = "package" PackageName . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4033 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4034 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4035 | <pre> |
| 4036 | package math |
| 4037 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4038 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4039 | <p> |
| 4040 | A set of files sharing the same PackageName form the implementation of a package. |
| 4041 | An implementation may require that all source files for a package inhabit the same directory. |
| 4042 | </p> |
| 4043 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4044 | <h3 id="Import_declarations">Import declarations</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4045 | |
| 4046 | <p> |
Robert Griesemer | aeaab59 | 2009-08-31 17:30:55 -0700 | [diff] [blame] | 4047 | A source file gains access to <a href="#Exported_identifiers">exported identifiers</a> |
| 4048 | from another package through an import declaration. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4049 | In the general form, an import declaration provides an identifier |
| 4050 | that code in the source file may use to access the imported package's |
| 4051 | contents and a file name referring to the (compiled) implementation of |
| 4052 | the package. The file name may be relative to a repository of |
| 4053 | installed packages. |
| 4054 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4055 | |
Robert Griesemer | f7ac3136 | 2009-07-10 16:06:40 -0700 | [diff] [blame] | 4056 | <pre class="ebnf"> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4057 | ImportDecl = "import" ( ImportSpec | "(" [ ImportSpecList ] ")" ) . |
| 4058 | ImportSpecList = ImportSpec { ";" ImportSpec } [ ";" ] . |
| 4059 | ImportSpec = [ "." | PackageName ] PackageFileName . |
| 4060 | PackageFileName = StringLit . |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4061 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4062 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4063 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4064 | After an import, in the usual case an exported name <i>N</i> from the imported |
| 4065 | package <i>P</i> may be accessed by the qualified identifier |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4066 | <i>P</i><code>.</code><i>N</i> (§<a href="#Qualified_identifiers">Qualified identifiers</a>). The actual |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4067 | name <i>P</i> depends on the form of the import declaration. If |
| 4068 | an explicit package name <code>p1</code> is provided, the qualified |
| 4069 | identifer will have the form <code>p1.</code><i>N</i>. If no name |
| 4070 | is provided in the import declaration, <i>P</i> will be the package |
| 4071 | name declared within the source files of the imported package. |
| 4072 | Finally, if the import declaration uses an explicit period |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4073 | (<code>.</code>) for the package name, <i>N</i> will be declared |
| 4074 | in the current file's file block and can be accessed without a qualifier. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4075 | </p> |
Russ Cox | 16b95ba | 2009-08-20 10:22:52 -0700 | [diff] [blame] | 4076 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4077 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4078 | In this table, assume we have compiled a package named |
| 4079 | <code>math</code>, which exports function <code>Sin</code>, and |
| 4080 | installed the compiled package in file |
| 4081 | <code>"lib/math"</code>. |
| 4082 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4083 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4084 | <pre class="grammar"> |
| 4085 | Import syntax Local name of Sin |
| 4086 | |
| 4087 | import M "lib/math" M.Sin |
| 4088 | import "lib/math" math.Sin |
| 4089 | import . "lib/math" Sin |
| 4090 | </pre> |
| 4091 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4092 | <h3 id="Multiple-file_packages">Multiple-file packages</h3> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4093 | |
| 4094 | <p> |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 4095 | If a package is constructed from multiple source files, |
| 4096 | all names declared in the package block, not just uppercase ones, |
| 4097 | are in scope in all the files in the package. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4098 | </p> |
| 4099 | |
| 4100 | <p> |
| 4101 | If source file <code>math1.go</code> contains |
| 4102 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4103 | <pre> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4104 | package math |
| 4105 | |
| 4106 | const twoPi = 6.283185307179586 |
| 4107 | |
| 4108 | function Sin(x float) float { return ... } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4109 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4110 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4111 | <p> |
Russ Cox | fe53795 | 2009-08-20 10:47:40 -0700 | [diff] [blame] | 4112 | then a second file <code>math2.go</code> also in |
| 4113 | <code>package math</code> |
| 4114 | may refer directly to <code>Sin</code> and <code>twoPi</code>. |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4115 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4116 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4117 | <h3 id="An_example_package">An example package</h3> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4118 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4119 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4120 | Here is a complete Go package that implements a concurrent prime sieve. |
| 4121 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4122 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4123 | <pre> |
| 4124 | package main |
| 4125 | |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4126 | import "fmt" |
| 4127 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4128 | // Send the sequence 2, 3, 4, ... to channel 'ch'. |
| 4129 | func generate(ch chan <- int) { |
| 4130 | for i := 2; ; i++ { |
| 4131 | ch <- i // Send 'i' to channel 'ch'. |
| 4132 | } |
| 4133 | } |
| 4134 | |
| 4135 | // Copy the values from channel 'in' to channel 'out', |
| 4136 | // removing those divisible by 'prime'. |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4137 | func filter(src chan <- int, dst <-chan int, prime int) { |
| 4138 | for i := range src { // Loop over values received from 'src'. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4139 | if i % prime != 0 { |
Rob Pike | 94b67eb | 2009-03-24 17:40:47 -0700 | [diff] [blame] | 4140 | dst <- i // Send 'i' to channel 'dst'. |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4141 | } |
| 4142 | } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4143 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4144 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4145 | // The prime sieve: Daisy-chain filter processes together. |
| 4146 | func sieve() { |
| 4147 | ch := make(chan int); // Create a new channel. |
| 4148 | go generate(ch); // Start generate() as a subprocess. |
| 4149 | for { |
| 4150 | prime := <-ch; |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4151 | fmt.Print(prime, "\n"); |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4152 | ch1 := make(chan int); |
| 4153 | go filter(ch, ch1, prime); |
| 4154 | ch = ch1 |
| 4155 | } |
| 4156 | } |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4157 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4158 | func main() { |
| 4159 | sieve() |
| 4160 | } |
| 4161 | </pre> |
Robert Griesemer | 6715358 | 2008-12-16 14:45:09 -0800 | [diff] [blame] | 4162 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4163 | <hr/> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4164 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4165 | <h2 id="Program_initialization_and_execution">Program initialization and execution</h2> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4166 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4167 | <h3 id="The_zero_value">The zero value</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4168 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4169 | When memory is allocated to store a value, either through a declaration |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4170 | or <code>new()</code>, and no explicit initialization is provided, the memory is |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4171 | given a default initialization. Each element of such a value is |
Robert Griesemer | ef45e64 | 2009-08-21 11:25:00 -0700 | [diff] [blame] | 4172 | 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] | 4173 | <code>0</code> for integers, <code>0.0</code> for floats, <code>""</code> |
| 4174 | for strings, and <code>nil</code> for pointers and interfaces. |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4175 | This initialization is done recursively, so for instance each element of an |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4176 | array of structs will have its fields zeroed if no value is specified. |
| 4177 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4178 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4179 | These two simple declarations are equivalent: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4180 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4181 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4182 | <pre> |
| 4183 | var i int; |
| 4184 | var i int = 0; |
| 4185 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4186 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4187 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4188 | After |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4189 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4190 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4191 | <pre> |
| 4192 | type T struct { i int; f float; next *T }; |
| 4193 | t := new(T); |
| 4194 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4195 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4196 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4197 | the following holds: |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4198 | </p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4199 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4200 | <pre> |
| 4201 | t.i == 0 |
| 4202 | t.f == 0.0 |
| 4203 | t.next == nil |
| 4204 | </pre> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4205 | |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4206 | <p> |
| 4207 | The same would also be true after |
| 4208 | </p> |
| 4209 | |
| 4210 | <pre> |
| 4211 | var t T |
| 4212 | </pre> |
| 4213 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4214 | <h3 id="Program_execution">Program execution</h3> |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4215 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4216 | A package with no imports is initialized by assigning initial values to |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4217 | all its package-level variables in declaration order and then calling any |
| 4218 | package-level function with the name and signature of |
| 4219 | </p> |
| 4220 | <pre> |
| 4221 | func init() |
| 4222 | </pre> |
| 4223 | <p> |
| 4224 | defined in its source. Since a package may contain more |
| 4225 | than one source file, there may be more than one |
| 4226 | <code>init()</code> function in a package, but |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4227 | only one per source file. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4228 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4229 | <p> |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4230 | Initialization code may contain "go" statements, but the functions |
Robert Griesemer | d8a764c | 2009-02-06 17:01:10 -0800 | [diff] [blame] | 4231 | they invoke do not begin execution until initialization of the entire |
| 4232 | program is complete. Therefore, all initialization code is run in a single |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4233 | goroutine. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4234 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4235 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4236 | An <code>init()</code> function cannot be referred to from anywhere |
| 4237 | in a program. In particular, <code>init()</code> cannot be called explicitly, |
| 4238 | nor can a pointer to <code>init</code> be assigned to a function variable. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4239 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4240 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4241 | If a package has imports, the imported packages are initialized |
Robert Griesemer | 566e3b2 | 2008-09-26 16:41:50 -0700 | [diff] [blame] | 4242 | before initializing the package itself. If multiple packages import |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4243 | a package <code>P</code>, <code>P</code> will be initialized only once. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4244 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4245 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4246 | The importing of packages, by construction, guarantees that there can |
| 4247 | be no cyclic dependencies in initialization. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4248 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4249 | <p> |
Robert Griesemer | df49fb3 | 2008-08-28 17:47:53 -0700 | [diff] [blame] | 4250 | A complete program, possibly created by linking multiple packages, |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4251 | must have one package called <code>main</code>, with a function |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4252 | </p> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4253 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4254 | <pre> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4255 | func main() { ... } |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4256 | </pre> |
Robert Griesemer | 4dc2528 | 2008-09-09 10:37:19 -0700 | [diff] [blame] | 4257 | |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4258 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4259 | defined. |
| 4260 | The function <code>main.main()</code> takes no arguments and returns no value. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4261 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4262 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4263 | Program execution begins by initializing the <code>main</code> package and then |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4264 | invoking <code>main.main()</code>. |
| 4265 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4266 | <p> |
Rob Pike | 4659685 | 2009-03-02 16:17:29 -0800 | [diff] [blame] | 4267 | When <code>main.main()</code> returns, the program exits. |
Rob Pike | 8f2330d | 2009-02-25 16:20:44 -0800 | [diff] [blame] | 4268 | </p> |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4269 | <p> |
| 4270 | Implementation restriction: The compiler assumes package <code>main</code> |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 4271 | is not imported by any other package. |
Rob Pike | 811dd25 | 2009-03-04 20:39:39 -0800 | [diff] [blame] | 4272 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4273 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4274 | <hr/> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4275 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4276 | <h2 id="System_considerations">System considerations</h2> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4277 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4278 | <h3 id="Package_unsafe">Package <code>unsafe</code></h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4279 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4280 | <p> |
Rob Pike | 96750f1 | 2009-02-27 16:47:48 -0800 | [diff] [blame] | 4281 | The built-in package <code>unsafe</code>, known to the compiler, |
| 4282 | provides facilities for low-level programming including operations |
| 4283 | that violate the type system. A package using <code>unsafe</code> |
| 4284 | must be vetted manually for type safety. The package provides the |
| 4285 | following interface: |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4286 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4287 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4288 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4289 | package unsafe |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4290 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4291 | type ArbitraryType int // shorthand for an arbitrary Go type; it is not a real type |
| 4292 | type Pointer *ArbitraryType |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4293 | |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4294 | func Alignof(variable ArbitraryType) int |
| 4295 | func Offsetof(selector ArbitraryType) int |
| 4296 | func Reflect(i interface {}) (value uint64, typestring string, indir bool) |
| 4297 | func Sizeof(variable ArbitraryType) int |
| 4298 | func Unreflect(value uint64, typestring string, indir bool) interface {} |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4299 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4300 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4301 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4302 | Any pointer or value of type <code>uintptr</code> can be converted into |
| 4303 | a <code>Pointer</code> and vice versa. |
| 4304 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4305 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4306 | The function <code>Sizeof</code> takes an expression denoting a |
Robert Griesemer | 4023dce | 2009-08-14 17:41:52 -0700 | [diff] [blame] | 4307 | variable of any type and returns the size of the variable in bytes. |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4308 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4309 | <p> |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4310 | The function <code>Offsetof</code> takes a selector (§<a href="#Selectors">Selectors</a>) denoting a struct |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4311 | field of any type and returns the field offset in bytes relative to the |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4312 | struct's address. For a struct <code>s</code> with field <code>f</code>: |
| 4313 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4314 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4315 | <pre> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4316 | uintptr(unsafe.Pointer(&s)) + uintptr(unsafe.Offsetof(s.f)) == uintptr(unsafe.Pointer(&s.f)) |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4317 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4318 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4319 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4320 | Computer architectures may require memory addresses to be <i>aligned</i>; |
| 4321 | that is, for addresses of a variable to be a multiple of a factor, |
| 4322 | the variable's type's <i>alignment</i>. The function <code>Alignof</code> |
| 4323 | takes an expression denoting a variable of any type and returns the |
| 4324 | alignment of the (type of the) variable in bytes. For a variable |
| 4325 | <code>x</code>: |
| 4326 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4327 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4328 | <pre> |
| 4329 | uintptr(unsafe.Pointer(&x)) % uintptr(unsafe.Alignof(x)) == 0 |
| 4330 | </pre> |
Robert Griesemer | 533dfd6 | 2009-05-13 16:56:00 -0700 | [diff] [blame] | 4331 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4332 | <p> |
| 4333 | Calls to <code>Alignof</code>, <code>Offsetof</code>, and |
| 4334 | <code>Sizeof</code> are constant expressions of type <code>int</code>. |
| 4335 | </p> |
Robert Griesemer | 98b4f6a | 2009-05-12 21:37:46 -0700 | [diff] [blame] | 4336 | <p> |
| 4337 | <font color=red>TODO describe Reflect, Unreflect</font> |
| 4338 | </p> |
Robert Griesemer | 6f8df7a | 2009-02-11 21:57:15 -0800 | [diff] [blame] | 4339 | |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4340 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4341 | <h3 id="Size_and_alignment_guarantees">Size and alignment guarantees</h3> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4342 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4343 | For the numeric types (§<a href="#Numeric_types">Numeric types</a>), the following sizes are guaranteed: |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4344 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4345 | <pre class="grammar"> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4346 | type size in bytes |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4347 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4348 | byte, uint8, int8 1 |
| 4349 | uint16, int16 2 |
| 4350 | uint32, int32, float32 4 |
| 4351 | uint64, int64, float64 8 |
| 4352 | </pre> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4353 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4354 | <p> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4355 | The following minimal alignment properties are guaranteed: |
Rob Pike | 4501d34 | 2009-02-19 17:31:36 -0800 | [diff] [blame] | 4356 | </p> |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4357 | <ol> |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4358 | <li>For a variable <code>x</code> of any type: <code>1 <= unsafe.Alignof(x) <= unsafe.Maxalign</code>. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4359 | |
Russ Cox | 5958dd6 | 2009-03-04 17:19:21 -0800 | [diff] [blame] | 4360 | <li>For a variable <code>x</code> of numeric type: <code>unsafe.Alignof(x)</code> is the smaller |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4361 | of <code>unsafe.Sizeof(x)</code> and <code>unsafe.Maxalign</code>, but at least 1. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4362 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4363 | <li>For a variable <code>x</code> of struct type: <code>unsafe.Alignof(x)</code> is the largest of |
| 4364 | all the values <code>unsafe.Alignof(x.f)</code> for each field <code>f</code> of x, but at least 1. |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4365 | |
Rob Pike | f27e9f0 | 2009-02-23 19:22:05 -0800 | [diff] [blame] | 4366 | <li>For a variable <code>x</code> of array type: <code>unsafe.Alignof(x)</code> is the same as |
| 4367 | <code>unsafe.Alignof(x[0])</code>, but at least 1. |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4368 | </ol> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4369 | |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4370 | <hr/> |
| 4371 | |
Russ Cox | 7c4f7cc | 2009-08-20 11:11:03 -0700 | [diff] [blame] | 4372 | <h2 id="Implementation_differences"><font color=red>Implementation differences - TODO</font></h2> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4373 | <p> |
| 4374 | <font color=red> |
Robert Griesemer | 237c8ab | 2009-09-01 14:07:30 -0700 | [diff] [blame] | 4375 | <ul> |
| 4376 | <li>Implementation does not honor the restriction on goto statements and targets (no intervening declarations).</li> |
| 4377 | <li>A type switch must have an assignment in the guard expression and does not support multiple types per case.</li> |
| 4378 | </ul> |
Rob Pike | ff70f09 | 2009-02-20 13:36:14 -0800 | [diff] [blame] | 4379 | </font> |
| 4380 | </p> |
Robert Griesemer | 52c02c2 | 2009-02-11 13:46:30 -0800 | [diff] [blame] | 4381 | |
Robert Griesemer | c2d5586 | 2009-02-19 16:49:10 -0800 | [diff] [blame] | 4382 | </div> |
| 4383 | </body> |
| 4384 | </html> |