distutils.cygwinccompiler
index
/usr/lib/python2.2/distutils/cygwinccompiler.py

distutils.cygwinccompiler
 
Provides the CygwinCCompiler class, a subclass of UnixCCompiler that
handles the Cygwin port of the GNU C compiler to Windows.  It also contains
the Mingw32CCompiler class which handles the mingw32 port of GCC (same as
cygwin in no-cygwin mode).

 
Modules
            
copy
os
sys
 
Classes
            
distutils.unixccompiler.UnixCCompiler(distutils.ccompiler.CCompiler)
CygwinCCompiler
Mingw32CCompiler
 
class CygwinCCompiler(distutils.unixccompiler.UnixCCompiler)
       
  
Method resolution order:
CygwinCCompiler
distutils.unixccompiler.UnixCCompiler
distutils.ccompiler.CCompiler

Methods defined here:
__init__(self, verbose=0, dry_run=0, force=0)
compile(self, sources, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None)
# not much different of the compile method in UnixCCompiler,
# but we have to insert some lines in the middle of it, so
# we put here a adapted version of it.
# (If we would call compile() in the base class, it would do some
# initializations a second time, this is why all is done here.)
link(self, target_desc, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
object_filenames(self, source_filenames, strip_dir=0, output_dir='')
# overwrite the one from CCompiler to support rc and res-files

Data and non-method functions defined here:
__doc__ = None
__module__ = 'distutils.cygwinccompiler'
compiler_type = 'cygwin'
exe_extension = '.exe'
obj_extension = '.o'
shared_lib_extension = '.dll'
shared_lib_format = '%s%s'
static_lib_extension = '.a'
static_lib_format = 'lib%s%s'

Methods inherited from distutils.unixccompiler.UnixCCompiler:
create_static_lib(self, objects, output_libname, output_dir=None, debug=0)
find_library_file(self, dirs, lib, debug=0)
library_dir_option(self, dir)
library_option(self, lib)
preprocess(self, source, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None)
runtime_library_dir_option(self, dir)

Data and non-method functions inherited from distutils.unixccompiler.UnixCCompiler:
dylib_lib_extension = '.dylib'
dylib_lib_format = 'lib%s%s'
executables = {'archiver': ['ar', '-cr'], 'compiler': ['cc'], 'compiler_so': ['cc'], 'linker_exe': ['cc'], 'linker_so': ['cc', '-shared'], 'preprocessor': None, 'ranlib': None}
src_extensions = ['.c', '.C', '.cc', '.cxx', '.cpp', '.m']

Methods inherited from distutils.ccompiler.CCompiler:
_check_macro_definitions(self, definitions)
Ensures that every element of 'definitions' is a valid macro
definition, ie. either (name,value) 2-tuple or a (name,) tuple.  Do
nothing if all definitions are OK, raise TypeError otherwise.
_find_macro(self, name)
_fix_compile_args(self, output_dir, macros, include_dirs)
Typecheck and fix-up some of the arguments to the 'compile()'
method, and return fixed-up values.  Specifically: if 'output_dir'
is None, replaces it with 'self.output_dir'; ensures that 'macros'
is a list, and augments it with 'self.macros'; ensures that
'include_dirs' is a list, and augments it with 'self.include_dirs'.
Guarantees that the returned values are of the correct type,
i.e. for 'output_dir' either string or None, and for 'macros' and
'include_dirs' either list or None.
_fix_lib_args(self, libraries, library_dirs, runtime_library_dirs)
Typecheck and fix up some of the arguments supplied to the
'link_*' methods.  Specifically: ensure that all arguments are
lists, and augment them with their permanent versions
(eg. 'self.libraries' augments 'libraries').  Return a tuple with
fixed versions of all arguments.
_fix_object_args(self, objects, output_dir)
Typecheck and fix up some arguments supplied to various methods.
Specifically: ensure that 'objects' is a list; if output_dir is
None, replace with self.output_dir.  Return fixed versions of
'objects' and 'output_dir'.
_need_link(self, objects, output_file)
Return true if we need to relink the files listed in 'objects'
to recreate 'output_file'.
_prep_compile(self, sources, output_dir)
Determine the list of object files corresponding to 'sources',
and figure out which ones really need to be recompiled.  Return a
list of all object files and a dictionary telling which source
files can be skipped.
add_include_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
header files.  The compiler is instructed to search directories in
the order in which they are supplied by successive calls to
'add_include_dir()'.
add_library(self, libname)
Add 'libname' to the list of libraries that will be included in
all links driven by this compiler object.  Note that 'libname'
should *not* be the name of a file containing a library, but the
name of the library itself: the actual filename will be inferred by
the linker, the compiler, or the compiler class (depending on the
platform).
 
The linker will be instructed to link against libraries in the
order they were supplied to 'add_library()' and/or
'set_libraries()'.  It is perfectly valid to duplicate library
names; the linker will be instructed to link against libraries as
many times as they are mentioned.
add_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
libraries specified to 'add_library()' and 'set_libraries()'.  The
linker will be instructed to search for libraries in the order they
are supplied to 'add_library_dir()' and/or 'set_library_dirs()'.
add_link_object(self, object)
Add 'object' to the list of object files (or analogues, such as
explicitly named library files or the output of "resource
compilers") to be included in every link driven by this compiler
object.
add_runtime_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
shared libraries at runtime.
announce(self, msg, level=1)
debug_print(self, msg)
define_macro(self, name, value=None)
Define a preprocessor macro for all compilations driven by this
compiler object.  The optional parameter 'value' should be a
string; if it is not supplied, then the macro will be defined
without an explicit value and the exact outcome depends on the
compiler used (XXX true? does ANSI say anything about this?)
executable_filename(self, basename, strip_dir=0, output_dir='')
execute(self, func, args, msg=None, level=1)
library_filename(self, libname, lib_type='static', strip_dir=0, output_dir='')
link_executable(self, objects, output_progname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None)
link_shared_lib(self, objects, output_libname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
link_shared_object(self, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
mkpath(self, name, mode=511)
move_file(self, src, dst)
set_executable(self, key, value)
set_executables(self, **args)
Define the executables (and options for them) that will be run
to perform the various stages of compilation.  The exact set of
executables that may be specified here depends on the compiler
class (via the 'executables' class attribute), but most will have:
  compiler      the C/C++ compiler
  linker_so     linker used to create shared objects and libraries
  linker_exe    linker used to create binary executables
  archiver      static library creator
 
On platforms with a command-line (Unix, DOS/Windows), each of these
is a string that will be split into executable name and (optional)
list of arguments.  (Splitting the string is done similarly to how
Unix shells operate: words are delimited by spaces, but quotes and
backslashes can override this.  See
'distutils.util.split_quoted()'.)
set_include_dirs(self, dirs)
Set the list of directories that will be searched to 'dirs' (a
list of strings).  Overrides any preceding calls to
'add_include_dir()'; subsequence calls to 'add_include_dir()' add
to the list passed to 'set_include_dirs()'.  This does not affect
any list of standard include directories that the compiler may
search by default.
set_libraries(self, libnames)
Set the list of libraries to be included in all links driven by
this compiler object to 'libnames' (a list of strings).  This does
not affect any standard system libraries that the linker may
include by default.
set_library_dirs(self, dirs)
Set the list of library search directories to 'dirs' (a list of
strings).  This does not affect any standard library search path
that the linker may search by default.
set_link_objects(self, objects)
Set the list of object files (or analogues) to be included in
every link to 'objects'.  This does not affect any standard object
files that the linker may include by default (such as system
libraries).
set_runtime_library_dirs(self, dirs)
Set the list of directories to search for shared libraries at
runtime to 'dirs' (a list of strings).  This does not affect any
standard search path that the runtime linker may search by
default.
shared_object_filename(self, basename, strip_dir=0, output_dir='')
spawn(self, cmd)
undefine_macro(self, name)
Undefine a preprocessor macro for all compilations driven by
this compiler object.  If the same macro is defined by
'define_macro()' and undefined by 'undefine_macro()' the last call
takes precedence (including multiple redefinitions or
undefinitions).  If the macro is redefined/undefined on a
per-compilation basis (ie. in the call to 'compile()'), then that
takes precedence.
warn(self, msg)

Data and non-method functions inherited from distutils.ccompiler.CCompiler:
EXECUTABLE = 'executable'
SHARED_LIBRARY = 'shared_library'
SHARED_OBJECT = 'shared_object'
 
class Mingw32CCompiler(CygwinCCompiler)
      # the same as cygwin plus some additional parameters
 
  
Method resolution order:
Mingw32CCompiler
CygwinCCompiler
distutils.unixccompiler.UnixCCompiler
distutils.ccompiler.CCompiler

Methods defined here:
__init__(self, verbose=0, dry_run=0, force=0)

Data and non-method functions defined here:
__doc__ = None
__module__ = 'distutils.cygwinccompiler'
compiler_type = 'mingw32'

Methods inherited from CygwinCCompiler:
compile(self, sources, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None)
# not much different of the compile method in UnixCCompiler,
# but we have to insert some lines in the middle of it, so
# we put here a adapted version of it.
# (If we would call compile() in the base class, it would do some
# initializations a second time, this is why all is done here.)
link(self, target_desc, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
object_filenames(self, source_filenames, strip_dir=0, output_dir='')
# overwrite the one from CCompiler to support rc and res-files

Data and non-method functions inherited from CygwinCCompiler:
exe_extension = '.exe'
obj_extension = '.o'
shared_lib_extension = '.dll'
shared_lib_format = '%s%s'
static_lib_extension = '.a'
static_lib_format = 'lib%s%s'

Methods inherited from distutils.unixccompiler.UnixCCompiler:
create_static_lib(self, objects, output_libname, output_dir=None, debug=0)
find_library_file(self, dirs, lib, debug=0)
library_dir_option(self, dir)
library_option(self, lib)
preprocess(self, source, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None)
runtime_library_dir_option(self, dir)

Data and non-method functions inherited from distutils.unixccompiler.UnixCCompiler:
dylib_lib_extension = '.dylib'
dylib_lib_format = 'lib%s%s'
executables = {'archiver': ['ar', '-cr'], 'compiler': ['cc'], 'compiler_so': ['cc'], 'linker_exe': ['cc'], 'linker_so': ['cc', '-shared'], 'preprocessor': None, 'ranlib': None}
src_extensions = ['.c', '.C', '.cc', '.cxx', '.cpp', '.m']

Methods inherited from distutils.ccompiler.CCompiler:
_check_macro_definitions(self, definitions)
Ensures that every element of 'definitions' is a valid macro
definition, ie. either (name,value) 2-tuple or a (name,) tuple.  Do
nothing if all definitions are OK, raise TypeError otherwise.
_find_macro(self, name)
_fix_compile_args(self, output_dir, macros, include_dirs)
Typecheck and fix-up some of the arguments to the 'compile()'
method, and return fixed-up values.  Specifically: if 'output_dir'
is None, replaces it with 'self.output_dir'; ensures that 'macros'
is a list, and augments it with 'self.macros'; ensures that
'include_dirs' is a list, and augments it with 'self.include_dirs'.
Guarantees that the returned values are of the correct type,
i.e. for 'output_dir' either string or None, and for 'macros' and
'include_dirs' either list or None.
_fix_lib_args(self, libraries, library_dirs, runtime_library_dirs)
Typecheck and fix up some of the arguments supplied to the
'link_*' methods.  Specifically: ensure that all arguments are
lists, and augment them with their permanent versions
(eg. 'self.libraries' augments 'libraries').  Return a tuple with
fixed versions of all arguments.
_fix_object_args(self, objects, output_dir)
Typecheck and fix up some arguments supplied to various methods.
Specifically: ensure that 'objects' is a list; if output_dir is
None, replace with self.output_dir.  Return fixed versions of
'objects' and 'output_dir'.
_need_link(self, objects, output_file)
Return true if we need to relink the files listed in 'objects'
to recreate 'output_file'.
_prep_compile(self, sources, output_dir)
Determine the list of object files corresponding to 'sources',
and figure out which ones really need to be recompiled.  Return a
list of all object files and a dictionary telling which source
files can be skipped.
add_include_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
header files.  The compiler is instructed to search directories in
the order in which they are supplied by successive calls to
'add_include_dir()'.
add_library(self, libname)
Add 'libname' to the list of libraries that will be included in
all links driven by this compiler object.  Note that 'libname'
should *not* be the name of a file containing a library, but the
name of the library itself: the actual filename will be inferred by
the linker, the compiler, or the compiler class (depending on the
platform).
 
The linker will be instructed to link against libraries in the
order they were supplied to 'add_library()' and/or
'set_libraries()'.  It is perfectly valid to duplicate library
names; the linker will be instructed to link against libraries as
many times as they are mentioned.
add_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
libraries specified to 'add_library()' and 'set_libraries()'.  The
linker will be instructed to search for libraries in the order they
are supplied to 'add_library_dir()' and/or 'set_library_dirs()'.
add_link_object(self, object)
Add 'object' to the list of object files (or analogues, such as
explicitly named library files or the output of "resource
compilers") to be included in every link driven by this compiler
object.
add_runtime_library_dir(self, dir)
Add 'dir' to the list of directories that will be searched for
shared libraries at runtime.
announce(self, msg, level=1)
debug_print(self, msg)
define_macro(self, name, value=None)
Define a preprocessor macro for all compilations driven by this
compiler object.  The optional parameter 'value' should be a
string; if it is not supplied, then the macro will be defined
without an explicit value and the exact outcome depends on the
compiler used (XXX true? does ANSI say anything about this?)
executable_filename(self, basename, strip_dir=0, output_dir='')
execute(self, func, args, msg=None, level=1)
library_filename(self, libname, lib_type='static', strip_dir=0, output_dir='')
link_executable(self, objects, output_progname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None)
link_shared_lib(self, objects, output_libname, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
link_shared_object(self, objects, output_filename, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None)
mkpath(self, name, mode=511)
move_file(self, src, dst)
set_executable(self, key, value)
set_executables(self, **args)
Define the executables (and options for them) that will be run
to perform the various stages of compilation.  The exact set of
executables that may be specified here depends on the compiler
class (via the 'executables' class attribute), but most will have:
  compiler      the C/C++ compiler
  linker_so     linker used to create shared objects and libraries
  linker_exe    linker used to create binary executables
  archiver      static library creator
 
On platforms with a command-line (Unix, DOS/Windows), each of these
is a string that will be split into executable name and (optional)
list of arguments.  (Splitting the string is done similarly to how
Unix shells operate: words are delimited by spaces, but quotes and
backslashes can override this.  See
'distutils.util.split_quoted()'.)
set_include_dirs(self, dirs)
Set the list of directories that will be searched to 'dirs' (a
list of strings).  Overrides any preceding calls to
'add_include_dir()'; subsequence calls to 'add_include_dir()' add
to the list passed to 'set_include_dirs()'.  This does not affect
any list of standard include directories that the compiler may
search by default.
set_libraries(self, libnames)
Set the list of libraries to be included in all links driven by
this compiler object to 'libnames' (a list of strings).  This does
not affect any standard system libraries that the linker may
include by default.
set_library_dirs(self, dirs)
Set the list of library search directories to 'dirs' (a list of
strings).  This does not affect any standard library search path
that the linker may search by default.
set_link_objects(self, objects)
Set the list of object files (or analogues) to be included in
every link to 'objects'.  This does not affect any standard object
files that the linker may include by default (such as system
libraries).
set_runtime_library_dirs(self, dirs)
Set the list of directories to search for shared libraries at
runtime to 'dirs' (a list of strings).  This does not affect any
standard search path that the runtime linker may search by
default.
shared_object_filename(self, basename, strip_dir=0, output_dir='')
spawn(self, cmd)
undefine_macro(self, name)
Undefine a preprocessor macro for all compilations driven by
this compiler object.  If the same macro is defined by
'define_macro()' and undefined by 'undefine_macro()' the last call
takes precedence (including multiple redefinitions or
undefinitions).  If the macro is redefined/undefined on a
per-compilation basis (ie. in the call to 'compile()'), then that
takes precedence.
warn(self, msg)

Data and non-method functions inherited from distutils.ccompiler.CCompiler:
EXECUTABLE = 'executable'
SHARED_LIBRARY = 'shared_library'
SHARED_OBJECT = 'shared_object'
 
Functions
            
check_config_h()
Check if the current Python installation (specifically, pyconfig.h)
appears amenable to building extensions with GCC.  Returns a tuple
(status, details), where 'status' is one of the following constants:
  CONFIG_H_OK
    all is well, go ahead and compile
  CONFIG_H_NOTOK
    doesn't look good
  CONFIG_H_UNCERTAIN
    not sure -- unable to read pyconfig.h
'details' is a human-readable string explaining the situation.
 
Note there are two ways to conclude "OK": either 'sys.version' contains
the string "GCC" (implying that this Python was built with GCC), or the
installed "pyconfig.h" contains the string "__GNUC__".
get_versions()
 Try to find out the versions of gcc, ld and dllwrap.
If not possible it returns None for it.
 
Data
             CONFIG_H_NOTOK = 'not ok'
CONFIG_H_OK = 'ok'
CONFIG_H_UNCERTAIN = 'uncertain'
__file__ = '/usr/lib/python2.2/distutils/cygwinccompiler.pyc'
__name__ = 'distutils.cygwinccompiler'
__revision__ = '$Id: cygwinccompiler.py,v 1.14 2001/12/06 20:51:35 fdrake Exp $'