1
0
mirror of https://github.com/golang/go synced 2024-11-25 05:57:57 -07:00

doc/articles/c_go_cgo.html: correct "C" comment to mention #cgo

Also fix invalid apostrophe characters.

R=r, gri, adg
CC=golang-dev
https://golang.org/cl/5874058
This commit is contained in:
Ian Lance Taylor 2012-03-22 17:44:28 -07:00
parent a99e9c5db5
commit 5ac186975c

View File

@ -18,7 +18,7 @@ and <code>srandom</code> functions.
{{code "/doc/progs/cgo1.go" `/package rand/` `/END/`}} {{code "/doc/progs/cgo1.go" `/package rand/` `/END/`}}
<p> <p>
Lets look at what's happening here, starting with the import statement. Let's look at what's happening here, starting with the import statement.
</p> </p>
<p> <p>
@ -45,7 +45,7 @@ package, using an ordinary Go type conversion:
{{code "/doc/progs/cgo1.go" `/func Random/` `/STOP/`}} {{code "/doc/progs/cgo1.go" `/func Random/` `/STOP/`}}
<p> <p>
Heres an equivalent function that uses a temporary variable to illustrate Here's an equivalent function that uses a temporary variable to illustrate
the type conversion more explicitly: the type conversion more explicitly:
</p> </p>
@ -73,11 +73,31 @@ above the <code>import</code> statement.
{{code "/doc/progs/cgo1.go" `/\/\*/` `/STOP/`}} {{code "/doc/progs/cgo1.go" `/\/\*/` `/STOP/`}}
<p> <p>
Cgo recognizes this comment and uses it as a header when compiling the C Cgo recognizes this comment. Any lines starting
parts of the package. In this case it is just a simple include statement, with <code>#cgo</code>
but it can be any valid C code. The comment must be immediately before the followed
line that imports <code>"C"</code>, without any intervening blank lines, by a space character are removed; these become directives for cgo.
just like a documentation comment. The remaining lines are used as a header when compiling the C parts of
the package. In this case those lines are just a
single <code>#include</code>
statement, but they can be almost any C code. The <code>#cgo</code>
directives are
used to provide flags for the compiler and linker when building the C
parts of the package.
</p>
<p>
There is a limitation: if your program uses any <code>//export</code>
directives, then the C code in the comment may only include declarations
(<code>extern int f();</code>), not definitions (<code>int f() {
return 1; }</code>). You can use <code>//export</code> directives to
make Go functions accessible to C code.
</p>
<p>
The <code>#cgo</code> and <code>//export</code> directives are
documented in
the <a href="/cmd/cgo/">cgo documentation</a>.
</p> </p>
<p> <p>
@ -85,7 +105,7 @@ just like a documentation comment.
</p> </p>
<p> <p>
Unlike Go, C doesnt have an explicit string type. Strings in C are Unlike Go, C doesn't have an explicit string type. Strings in C are
represented by a zero-terminated array of chars. represented by a zero-terminated array of chars.
</p> </p>
@ -107,7 +127,7 @@ string to standard output using C's <code>fputs</code> function from the
<p> <p>
Memory allocations made by C code are not known to Go's memory manager. Memory allocations made by C code are not known to Go's memory manager.
When you create a C string with <code>C.CString</code> (or any C memory When you create a C string with <code>C.CString</code> (or any C memory
allocation) you must remember to free the memory when youre done with it allocation) you must remember to free the memory when you're done with it
by calling <code>C.free</code>. by calling <code>C.free</code>.
</p> </p>
@ -147,7 +167,7 @@ in the Go tree demonstrate more advanced concepts.
</p> </p>
<p> <p>
For a simple, idiomatic example of a cgo-based package, see Russ Coxs <a For a simple, idiomatic example of a cgo-based package, see Russ Cox's <a
href="http://code.google.com/p/gosqlite/source/browse/sqlite/sqlite.go">gosqlite</a>. href="http://code.google.com/p/gosqlite/source/browse/sqlite/sqlite.go">gosqlite</a>.
Also, the Go Project Dashboard lists <a Also, the Go Project Dashboard lists <a
href="https://godashboard.appspot.com/project?tag=cgo">several other href="https://godashboard.appspot.com/project?tag=cgo">several other
@ -155,6 +175,6 @@ cgo packages</a>.
</p> </p>
<p> <p>
Finally, if youre curious as to how all this works internally, take a look Finally, if you're curious as to how all this works internally, take a look
at the introductory comment of the runtime packages <a href="/src/pkg/runtime/cgocall.c">cgocall.c</a>. at the introductory comment of the runtime package's <a href="/src/pkg/runtime/cgocall.c">cgocall.c</a>.
</p> </p>