distutils.unixccompiler
index
/usr/local/lib/python2.3/distutils/unixccompiler.py

distutils.unixccompiler
 
Contains the UnixCCompiler class, a subclass of CCompiler that handles
the "typical" Unix-style command-line C compiler:
  * macros defined with -Dname[=value]
  * macros undefined with -Uname
  * include search directories specified with -Idir
  * libraries specified with -lllib
  * library search directories specified with -Ldir
  * compile handled by 'cc' (or similar) executable with -c option:
    compiles .c to .o
  * link static library handled by 'ar' command (possibly with 'ranlib')
  * link shared library handled by 'cc -shared'

 
Modules
       
distutils.log
os
sys
distutils.sysconfig

 
Classes
       
distutils.ccompiler.CCompiler
UnixCCompiler

 
class UnixCCompiler(distutils.ccompiler.CCompiler)
     Methods defined here:
create_static_lib(self, objects, output_libname, output_dir=None, debug=0, target_lang=None)
find_library_file(self, dirs, lib, debug=0)
library_dir_option(self, dir)
library_option(self, lib)
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, target_lang=None)
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 other attributes defined here:
compiler_type = 'unix'
dylib_lib_extension = '.dylib'
dylib_lib_format = 'lib%s%s'
executables = {'archiver': ['ar', '-cr'], 'compiler': ['cc'], 'compiler_cxx': ['cc'], 'compiler_so': ['cc'], 'linker_exe': ['cc'], 'linker_so': ['cc', '-shared'], 'preprocessor': None, 'ranlib': None}
obj_extension = '.o'
shared_lib_extension = '.so'
shared_lib_format = 'lib%s%s'
src_extensions = ['.c', '.C', '.cc', '.cxx', '.cpp', '.m']
static_lib_extension = '.a'
static_lib_format = 'lib%s%s'

Methods inherited from distutils.ccompiler.CCompiler:
__init__(self, verbose=0, dry_run=0, force=0)
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)
compile(self, sources, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None)
Compile one or more source files.
 
'sources' must be a list of filenames, most likely C/C++
files, but in reality anything that can be handled by a
particular compiler and compiler class (eg. MSVCCompiler can
handle resource files in 'sources').  Return a list of object
filenames, one per source filename in 'sources'.  Depending on
the implementation, not all source files will necessarily be
compiled, but all corresponding object filenames will be
returned.
 
If 'output_dir' is given, object files will be put under it, while
retaining their original path component.  That is, "foo/bar.c"
normally compiles to "foo/bar.o" (for a Unix implementation); if
'output_dir' is "build", then it would compile to
"build/foo/bar.o".
 
'macros', if given, must be a list of macro definitions.  A macro
definition is either a (name, value) 2-tuple or a (name,) 1-tuple.
The former defines a macro; if the value is None, the macro is
defined without an explicit value.  The 1-tuple case undefines a
macro.  Later definitions/redefinitions/ undefinitions take
precedence.
 
'include_dirs', if given, must be a list of strings, the
directories to add to the default include file search path for this
compilation only.
 
'debug' is a boolean; if true, the compiler will be instructed to
output debug symbols in (or alongside) the object file(s).
 
'extra_preargs' and 'extra_postargs' are implementation- dependent.
On platforms that have the notion of a command-line (e.g. Unix,
DOS/Windows), they are most likely lists of strings: extra
command-line arguments to prepand/append to the compiler command
line.  On other platforms, consult the implementation class
documentation.  In any event, they are intended as an escape hatch
for those occasions when the abstract compiler framework doesn't
cut the mustard.
 
'depends', if given, is a list of filenames that all targets
depend on.  If a source file is older than any file in
depends, then the source file will be recompiled.  This
supports dependency tracking, but only at a coarse
granularity.
 
Raises CompileError on failure.
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?)
detect_language(self, sources)
Detect the language of a given file, or list of files. Uses
language_map, and language_order to do the job.
executable_filename(self, basename, strip_dir=0, output_dir='')
execute(self, func, args, msg=None, level=1)
has_function(self, funcname, includes=None, include_dirs=None, libraries=None, library_dirs=None)
Return a boolean indicating whether funcname is supported on
the current platform.  The optional arguments can be used to
augment the compilation environment.
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, target_lang=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, target_lang=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, target_lang=None)
mkpath(self, name, mode=511)
move_file(self, src, dst)
object_filenames(self, source_filenames, strip_dir=0, output_dir='')
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 other attributes inherited from distutils.ccompiler.CCompiler:
EXECUTABLE = 'executable'
SHARED_LIBRARY = 'shared_library'
SHARED_OBJECT = 'shared_object'
exe_extension = None
language_map = {'.c': 'c', '.cc': 'c++', '.cpp': 'c++', '.cxx': 'c++', '.m': 'objc'}
language_order = ['c++', 'objc', 'c']

 
Data
        __revision__ = '$Id: unixccompiler.py,v 1.54 2003/06/01 19:27:40 jackjansen Exp $'