Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Labels
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
nexedi
cython
Commits
a6b8bae5
Commit
a6b8bae5
authored
Jan 25, 2009
by
Robert Bradshaw
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
sharing declarations, compiling
parent
9ba8cf84
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
25 additions
and
9 deletions
+25
-9
docs/external_C_code.rst
docs/external_C_code.rst
+17
-5
docs/sharing_declarations.rst
docs/sharing_declarations.rst
+1
-1
docs/source_files_and_compilation.rst
docs/source_files_and_compilation.rst
+7
-3
No files found.
docs/external_C_code.rst
View file @
a6b8bae5
.. highlight:: cython
.. highlight:: cython
.. external-C-code:
..
_
external-C-code:
**********************************
**********************************
Interfacing with External C Code
Interfacing with External C Code
...
@@ -13,10 +13,12 @@ variables from the library that you want to use.
...
@@ -13,10 +13,12 @@ variables from the library that you want to use.
You can also use public declarations to make C functions and variables defined
You can also use public declarations to make C functions and variables defined
in a Cython module available to external C code. The need for this is expected
in a Cython module available to external C code. The need for this is expected
to be less frequent, but you might want to do it, for example, if you are
to be less frequent, but you might want to do it, for example, if you are
embedding Python
in another application as a scripting language. Just as a
`embedding Python`_
in another application as a scripting language. Just as a
Cython module can be used as a bridge to allow Python code to call C code, it
Cython module can be used as a bridge to allow Python code to call C code, it
can also be used to allow C code to call Python code.
can also be used to allow C code to call Python code.
.. _embedding Python: http://www.freenet.org.nz/python/embeddingpyrex/
External declarations
External declarations
=======================
=======================
...
@@ -63,7 +65,12 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
...
@@ -63,7 +65,12 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
1. Don't use ``const``. Cython doesn't know anything about ``const``, so just
1. Don't use ``const``. Cython doesn't know anything about ``const``, so just
leave it out. Most of the time this shouldn't cause any problem, although
leave it out. Most of the time this shouldn't cause any problem, although
on rare occasions you might have to use a cast.
on rare occasions you might have to use a cast. You can also explicitly
declare something like::
ctypedef char* const_char_ptr "const char*"
though in most cases this will not be needed.
.. warning::
.. warning::
...
@@ -121,7 +128,8 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
...
@@ -121,7 +128,8 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
ctypedef int size_t
ctypedef int size_t
will work okay whatever the actual size of a :ctype:`size_t` is (provided the header
will work okay whatever the actual size of a :ctype:`size_t` is (provided the header
file defines it correctly).
file defines it correctly). Conversion to and from Python types, if any, will also
be used for this new type.
5. If the header file uses macros to define constants, translate them into a
5. If the header file uses macros to define constants, translate them into a
dummy ``enum`` declaration.
dummy ``enum`` declaration.
...
@@ -129,6 +137,10 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
...
@@ -129,6 +137,10 @@ match the C ones, and in some cases they shouldn't or can't. In particular:
6. If the header file defines a function using a macro, declare it as though
6. If the header file defines a function using a macro, declare it as though
it were an ordinary function, with appropriate argument and result types.
it were an ordinary function, with appropriate argument and result types.
7. For archaic reasons C uses the keyword :keyword:`void` to declare a function
taking no parameters. In Cython as in Python, simply declare such functions
as :meth:`foo()`.
A few more tricks and tips:
A few more tricks and tips:
* If you want to include a C header because it's needed by another header, but
* If you want to include a C header because it's needed by another header, but
...
@@ -280,7 +292,7 @@ Using Cython Declarations from C
...
@@ -280,7 +292,7 @@ Using Cython Declarations from C
==================================
==================================
Cython provides two methods for making C declarations from a Cython module
Cython provides two methods for making C declarations from a Cython module
available for use by external C code
–
public declarations and C API
available for use by external C code
---
public declarations and C API
declarations.
declarations.
.. note::
.. note::
...
...
docs/sharing_declarations.rst
View file @
a6b8bae5
...
@@ -24,7 +24,7 @@ statement.
...
@@ -24,7 +24,7 @@ statement.
A ``.pxd`` file that consists solely of extern declarations does not need
A ``.pxd`` file that consists solely of extern declarations does not need
to correspond to an actual ``.pyx`` file or Python module. This can make it a
to correspond to an actual ``.pyx`` file or Python module. This can make it a
convenient place to put common declarations, for example declarations of
convenient place to put common declarations, for example declarations of
functions from an
external library
that one wants to use in several modules.
functions from an
:ref:`external library <external-C-code>`
that one wants to use in several modules.
What a Definition File contains
What a Definition File contains
================================
================================
...
...
docs/source_files_and_compilation.rst
View file @
a6b8bae5
...
@@ -70,9 +70,13 @@ would be::
...
@@ -70,9 +70,13 @@ would be::
Notice that the files have been given a name, this is not necessary, but it
Notice that the files have been given a name, this is not necessary, but it
makes the file easier to format if the list gets long.
makes the file easier to format if the list gets long.
If any of the files depend on include paths information can be passed to the
The :class:`Extension` class takes many options, and a fuller explanation can
:obj:`Extension` class through the :keyword:`include_dirs` option, which is a
be found in the `distutils documentation`_. Some useful options to know about
list of paths to the include directories.
are ``include_dirs``, ``libraries``, and ``library_dirs`` which specify where
to find the ``.h`` and library files when linking to external libraries.
.. _distutils documentation: http://docs.python.org/extending/building.html
Multiple Cython Files in a Package
Multiple Cython Files in a Package
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment