^Rc@sdZdZddlZddlZddlZddlmZmZmZm Z m Z ddl m Z ddl mZddlmZddlmZdd lmZmZdd lmZdd lmZd fd YZddfddfddfddffZeedZidddfd6dddfd6dddfd6dd d!fd"6d#d$d%fd&6d'd(d)fd6Zd*Zeed+d+d+d,Z d-Z!d.Z"dS(/sdistutils.ccompiler Contains CCompiler, an abstract base class that defines the interface for the Distutils compiler abstraction model.s$Id$iN(t CompileErrort LinkErrortUnknownFileErrortDistutilsPlatformErrortDistutilsModuleError(tspawn(t move_file(tmkpath(t newer_group(t split_quotedtexecute(tlog(tcustomize_compilert CCompilerc BseZdZdAZdAZdAZdAZdAZdAZ dAZ dAZ idd6dd6dd6dd6dd6Z dddgZ d d d d Zd Zd Zd ZdZdAdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!dZ"dZ#d Z$d!Z%dAdAdAdAdAd"Z&dAdAdAd dAdAdAd#Z'd$Z(dAd dAd%Z)d&Z*d'Z+d(Z,dAdAdAdAdAd dAdAdAdAd) Z-dAdAdAdAdAd dAdAdAdAd* Z.dAdAdAdAdAd dAdAdAdAd+ Z/dAdAdAdAd dAdAdAd,Z0d-Z1d.Z2d/Z3dAdAdAdAd0Z4d d1Z5d d2d3Z6d d2d4Z7d d2d5Z8d6d d2d7Z9d8d9Z:d:Z;d;Z<dAd8d<Z=d=Z>d>Z?d?d@Z@RS(BsAbstract base class to define the interface that must be implemented by real compiler classes. Also has some utility methods used by several compiler classes. The basic idea behind a compiler abstraction class is that each instance can be used for all the compile/link steps in building a single project. Thus, attributes common to all of those compile and link steps -- include directories, macros to define, libraries to link against, etc. -- are attributes of the compiler instance. To allow for variability in how individual files are treated, most of those attributes may be varied on a per-compilation or per-link basis. tcs.csc++s.ccs.cpps.cxxtobjcs.micCs||_||_||_d|_g|_g|_g|_g|_g|_ g|_ x.|j j D]}|j ||j |qjWdS(N(tdry_runtforcetverbosetNonet output_dirtmacrost include_dirst librariest library_dirstruntime_library_dirstobjectst executablestkeystset_executable(tselfRRRtkey((s)/usr/lib/python2.7/distutils/ccompiler.pyt__init__]s          cKsZxS|jD]E}||jkr>td||jjfn|j|||q WdS(sDefine 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()'.) s$unknown executable '%s' for class %sN(RRt ValueErrort __class__t__name__R(RtargsR((s)/usr/lib/python2.7/distutils/ccompiler.pytset_executabless cCs<t|tr(t||t|nt|||dS(N(t isinstancetstrtsetattrR (RRtvalue((s)/usr/lib/python2.7/distutils/ccompiler.pyRscCs<d}x/|jD]$}|d|kr*|S|d}qWdS(Nii(RR(Rtnametitdefn((s)/usr/lib/python2.7/distutils/ccompiler.pyt _find_macros c Csx|D]}t|tost|dksct|dkost|dtsc|ddkost|dtstd|ddqqWdS(sEnsures 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. iiisinvalid macro definition '%s': s.must be tuple (string,), (string, string), or s(string, None)N(R&ttupletlenR'Rt TypeError(Rt definitionsR,((s)/usr/lib/python2.7/distutils/ccompiler.pyt_check_macro_definitionss # cCsH|j|}|dk r(|j|=n||f}|jj|dS(s_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?) N(R-RRtappend(RR*R)R+R,((s)/usr/lib/python2.7/distutils/ccompiler.pyt define_macros    cCsE|j|}|dk r(|j|=n|f}|jj|dS(sUndefine 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. N(R-RRR3(RR*R+tundefn((s)/usr/lib/python2.7/distutils/ccompiler.pytundefine_macros    cCs|jj|dS(sAdd '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()'. N(RR3(Rtdir((s)/usr/lib/python2.7/distutils/ccompiler.pytadd_include_dirscCs||_dS(sySet 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. N(R(Rtdirs((s)/usr/lib/python2.7/distutils/ccompiler.pytset_include_dirsscCs|jj|dS(sAdd '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. N(RR3(Rtlibname((s)/usr/lib/python2.7/distutils/ccompiler.pyt add_libraryscCs||_dS(sSet 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. N(R(Rtlibnames((s)/usr/lib/python2.7/distutils/ccompiler.pyt set_librariesscCs|jj|dS(s'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()'. N(RR3(RR7((s)/usr/lib/python2.7/distutils/ccompiler.pytadd_library_dirscCs||_dS(sSet 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. N(R(RR9((s)/usr/lib/python2.7/distutils/ccompiler.pytset_library_dirsscCs|jj|dS(slAdd 'dir' to the list of directories that will be searched for shared libraries at runtime. N(RR3(RR7((s)/usr/lib/python2.7/distutils/ccompiler.pytadd_runtime_library_dirscCs||_dS(sSet 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. N(R(RR9((s)/usr/lib/python2.7/distutils/ccompiler.pytset_runtime_library_dirs%scCs|jj|dS(sAdd '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. N(RR3(Rtobject((s)/usr/lib/python2.7/distutils/ccompiler.pytadd_link_object-scCs||_dS(sSet 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). N(R(RR((s)/usr/lib/python2.7/distutils/ccompiler.pytset_link_objects5scCs|dkr|j}nt|ts3tdn|dkrK|j}n.t|trp||jpig}n td|dkr|j}n:t|ttfrt||jpg}n td|dkrg}n|j |ddd|}t ||}i} xmt t |D]Y} || } || } t jj| d} |jt jj| | | f| | t|ttfrt||jpg}n tdd|||fS(s;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. s3'libraries' (if supplied) must be a list of stringss6'library_dirs' (if supplied) must be a list of stringss%'runtime_library_dirs' (if supplied) smust be a list of stringsN(RRR&RGR.R0RR(RRRR((s)/usr/lib/python2.7/distutils/ccompiler.pyt _fix_lib_argss*       cCsE|jr dS|jr.t||dd}nt||}|SdS(sjReturn true if we need to relink the files listed in 'objects' to recreate 'output_file'. itmissingtnewerN(RRR(RRt output_fileRb((s)/usr/lib/python2.7/distutils/ccompiler.pyt _need_links   c Cst|ts|g}nd}t|j}x}|D]u}tjj|\}}|jj |}y1|jj |}||kr|}|}nWq7t k rq7Xq7W|S(s|Detect the language of a given file, or list of files. Uses language_map, and language_order to do the job. N( R&RGRR/tlanguage_orderRKRLRMt language_maptgettindexR!( RRQtlangRhtsourcetbaseRXtextlangtextindex((s)/usr/lib/python2.7/distutils/ccompiler.pytdetect_languages     cCsdS(sPreprocess a single C/C++ source file, named in 'source'. Output will be written to file named 'output_file', or stdout if 'output_file' not supplied. 'macros' is a list of macro definitions as for 'compile()', which will augment the macros set with 'define_macro()' and 'undefine_macro()'. 'include_dirs' is a list of directory names that will be added to the default list. Raises PreprocessError on failure. N((RRjRcRRt extra_preargstextra_postargs((s)/usr/lib/python2.7/distutils/ccompiler.pyt preprocesss c Cs|j||||||\}} }} } |j| ||} xU| D]M} y| | \}}Wntk ryqInX|j| ||| || qIW| S(sK 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. (RYR]tKeyErrort_compile(RRQRRRRZRoRpRRRRTRUR\RWRVRX((s)/usr/lib/python2.7/distutils/ccompiler.pytcompiles7   cCsdS(sCompile 'src' to product 'obj'.N((RRWRVRXR\RpRT((s)/usr/lib/python2.7/distutils/ccompiler.pyRsCscCsdS(s&Link a bunch of stuff together to create a static library file. The "bunch of stuff" consists of the list of object files supplied as 'objects', the extra object files supplied to 'add_link_object()' and/or 'set_link_objects()', the libraries supplied to 'add_library()' and/or 'set_libraries()', and the libraries supplied as 'libraries' (if any). 'output_libname' should be a library name, not a filename; the filename will be inferred from the library name. 'output_dir' is the directory where the library file will be put. 'debug' is a boolean; if true, debugging information will be included in the library (note that on most platforms, it is the compile step where this matters: the 'debug' flag is included here just for consistency). 'target_lang' is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages. Raises LibError on failure. N((RRtoutput_libnameRRZt target_lang((s)/usr/lib/python2.7/distutils/ccompiler.pytcreate_static_libJst shared_objecttshared_libraryt executablecCs tdS(suLink a bunch of stuff together to create an executable or shared library file. The "bunch of stuff" consists of the list of object files supplied as 'objects'. 'output_filename' should be a filename. If 'output_dir' is supplied, 'output_filename' is relative to it (i.e. 'output_filename' can provide directory components if needed). 'libraries' is a list of libraries to link against. These are library names, not filenames, since they're translated into filenames in a platform-specific way (eg. "foo" becomes "libfoo.a" on Unix and "foo.lib" on DOS/Windows). However, they can include a directory component, which means the linker will look in that specific directory rather than searching all the normal locations. 'library_dirs', if supplied, should be a list of directories to search for libraries that were specified as bare library names (ie. no directory component). These are on top of the system default and those supplied to 'add_library_dir()' and/or 'set_library_dirs()'. 'runtime_library_dirs' is a list of directories that will be embedded into the shared library and used to search for other shared libraries that *it* depends on at run-time. (This may only be relevant on Unix.) 'export_symbols' is a list of symbols that the shared library will export. (This appears to be relevant only on Windows.) 'debug' is as for 'compile()' and 'create_static_lib()', with the slight distinction that it actually matters on most platforms (as opposed to 'create_static_lib()', which includes a 'debug' flag mostly for form's sake). 'extra_preargs' and 'extra_postargs' are as for 'compile()' (except of course that they supply command-line arguments for the particular linker being used). 'target_lang' is the target language for which the given objects are being compiled. This allows specific linkage time treatment of certain languages. Raises LinkError on failure. N(tNotImplementedError(Rt target_descRtoutput_filenameRRRRtexport_symbolsRZRoRpt build_tempRv((s)/usr/lib/python2.7/distutils/ccompiler.pytlinkis/c CsG|jtj||j|dd||||||| | | | dS(Ntlib_typetshared(RR tSHARED_LIBRARYtlibrary_filename( RRRuRRRRR~RZRoRpRRv((s)/usr/lib/python2.7/distutils/ccompiler.pytlink_shared_libs  c Cs8|jtj||||||||| | | | dS(N(RR t SHARED_OBJECT( RRR}RRRRR~RZRoRpRRv((s)/usr/lib/python2.7/distutils/ccompiler.pytlink_shared_objects  c CsA|jtj||j|||||d||| d| dS(N(RR t EXECUTABLEtexecutable_filenameR( RRtoutput_prognameRRRRRZRoRpRv((s)/usr/lib/python2.7/distutils/ccompiler.pytlink_executables cCs tdS(skReturn the compiler option to add 'dir' to the list of directories searched for libraries. N(R{(RR7((s)/usr/lib/python2.7/distutils/ccompiler.pytlibrary_dir_optionscCs tdS(ssReturn the compiler option to add 'dir' to the list of directories searched for runtime libraries. N(R{(RR7((s)/usr/lib/python2.7/distutils/ccompiler.pytruntime_library_dir_optionscCs tdS(sReturn the compiler option to add 'dir' to the list of libraries linked into the shared library or executable. N(R{(Rtlib((s)/usr/lib/python2.7/distutils/ccompiler.pytlibrary_optionsc CsEddl}|dkr!g}n|dkr6g}n|dkrKg}n|dkr`g}n|jd|dt\}}tj|d} z7x|D]} | jd| qW| jd|Wd| jXy|j|gd|} Wnt k rt SXy |j | d d |d |Wnt t fk r@t SXtS( sReturn a boolean indicating whether funcname is supported on the current platform. The optional arguments can be used to augment the compilation environment. iNs.cttexttws#include "%s" s+main (int argc, char **argv) { %s(); } Rsa.outRR(ttempfileRtmkstemptTrueRKtfdopentwritetcloseRtRtFalseRRR0( RtfuncnametincludesRRRRtfdtfnametftinclR((s)/usr/lib/python2.7/distutils/ccompiler.pyt has_functions8             cCs tdS(sHSearch the specified list of directories for a static or shared library file 'lib' and return the full path to that file. If 'debug' true, look for a debugging version (if that makes sense on the current platform). Return None if 'lib' wasn't found in any of the specified directories. N(R{(RR9RRZ((s)/usr/lib/python2.7/distutils/ccompiler.pytfind_library_filestcCs|dkrd}ng}x|D]}tjj|\}}tjj|d}|tjj|}||jkrtd||fn|rtjj|}n|j tjj |||j q"W|S(NRis"unknown file type '%s' (from '%s')( RRKRLRMt splitdrivetisabstsrc_extensionsRtbasenameR3tjoint obj_extension(Rtsource_filenamesRFRt obj_namestsrc_nameRkRX((s)/usr/lib/python2.7/distutils/ccompiler.pyRH-s   cCs5|rtjj|}ntjj|||jS(N(RKRLRRtshared_lib_extension(RRRFR((s)/usr/lib/python2.7/distutils/ccompiler.pytshared_object_filename>scCs;|rtjj|}ntjj|||jp6dS(NR(RKRLRRt exe_extension(RRRFR((s)/usr/lib/python2.7/distutils/ccompiler.pyRDststaticc Cs|dkrtdnt||d}t||d}tjj|\}}|||f} |rud}ntjj||| S( NRRtdylibs0'lib_type' must be "static", "shared" or "dylib"t _lib_formatt_lib_extensionR(RssharedR(R!tgetattrRKRLtsplitR( RR;RRFRtfmtRXR7Rktfilename((s)/usr/lib/python2.7/distutils/ccompiler.pyRJs   icCstj|dS(N(R RZ(Rtmsgtlevel((s)/usr/lib/python2.7/distutils/ccompiler.pytannounce\scCs"ddlm}|r|GHndS(Ni(tDEBUG(tdistutils.debugR(RRR((s)/usr/lib/python2.7/distutils/ccompiler.pyt debug_print_scCstjjd|dS(Ns warning: %s (tsyststderrR(RR((s)/usr/lib/python2.7/distutils/ccompiler.pytwarndscCst||||jdS(N(R R(RtfuncR$RR((s)/usr/lib/python2.7/distutils/ccompiler.pyR gscCst|d|jdS(NR(RR(Rtcmd((s)/usr/lib/python2.7/distutils/ccompiler.pyRjscCst||d|jS(NR(RR(RRVtdst((s)/usr/lib/python2.7/distutils/ccompiler.pyRmsicCst||d|jdS(NR(RR(RR*tmode((s)/usr/lib/python2.7/distutils/ccompiler.pyRpsN(AR#t __module__t__doc__Rt compiler_typeRRtstatic_lib_extensionRtstatic_lib_formattshared_lib_formatRRfReR R%RR-R2R4R6R8R:R<R>R?R@RARBRDRERYR]R^R_R`RdRnRqRtRsRwRRRRRRRRRRRRRHRRRRRRR RRR(((s)/usr/lib/python2.7/distutils/ccompiler.pyR s    $ !              ,  #   C   1       + +     scygwin.*tunixtos2emxtemxtposixtnttmsvccCs|dkrtj}n|dkr0tj}nxHtD]@\}}tj||dk sstj||dk r7|Sq7WdS(sr Determine the default compiler to use for the given platform. osname should be one of the standard Python OS names (i.e. the ones returned by os.name) and platform the common value returned by sys.platform for the platform in question. The default values are os.name and sys.platform in case the parameters are not given. RN(RRKR*Rtplatformt_default_compilerstretmatch(tosnameRtpatterntcompiler((s)/usr/lib/python2.7/distutils/ccompiler.pytget_default_compilers    t unixccompilert UnixCCompilersstandard UNIX-style compilert msvccompilert MSVCCompilersMicrosoft Visual C++tcygwinccompilertCygwinCCompilers'Cygwin port of GNU C Compiler for Win32tcygwintMingw32CCompilers(Mingw32 port of GNU C Compiler for Win32tmingw32t bcppcompilert BCPPCompilersBorland C++ Compilertbcppt emxccompilert EMXCCompilers#EMX port of GNU C Compiler for OS/2cCsvddlm}g}x6tjD](}|jd|dt|dfq#W|j||}|jddS(syPrint list of available compilers (used by the "--help-compiler" options to "build", "build_ext", "build_clib"). i(t FancyGetopts compiler=isList of available compilers:N(tdistutils.fancy_getoptRtcompiler_classRR3Rtsortt print_help(Rt compilersRtpretty_printer((s)/usr/lib/python2.7/distutils/ccompiler.pytshow_compilerss  ic Cs|dkrtj}ny2|dkr6t|}nt|\}}}WnAtk rd|}|dk r|d|}nt|nXy5d|}t|tj |} t | |} WnEt k rt d|n(tk r t dd||fnX| d||S(s[Generate an instance of some CCompiler subclass for the supplied platform/compiler combination. 'plat' defaults to 'os.name' (eg. 'posix', 'nt'), and 'compiler' defaults to the default compiler for that platform. Currently only 'posix' and 'nt' are supported, and the default compilers are "traditional Unix interface" (UnixCCompiler class) and Visual C++ (MSVCCompiler class). Note that it's perfectly possible to ask for a Unix compiler object under Windows, and a Microsoft compiler object under Unix -- if you supply a value for 'compiler', 'plat' is ignored. s5don't know how to compile C/C++ code on platform '%s's with '%s' compilers distutils.s4can't compile C/C++ code: unable to load module '%s's4can't compile C/C++ code: unable to find class '%s' sin module '%s'N( RRKR*RRRrRt __import__Rtmodulestvarst ImportErrorR( tplatRRRRt module_namet class_nametlong_descriptionRtmoduletklass((s)/usr/lib/python2.7/distutils/ccompiler.pyt new_compilers2             cCsg}x|D]}t|toAdt|ko?dknsXtdd|nt|dkr|jd|dq t|dkr |dd kr|jd|dq|jd|q q Wx|D]}|jd |qW|S( sGenerate C pre-processor options (-D, -U, -I) as used by at least two types of compilers: the typical Unix compiler and Visual C++. 'macros' is the usual thing, a list of 1- or 2-tuples, where (name,) means undefine (-U) macro 'name', and (name,value) means define (-D) macro 'name' to 'value'. 'include_dirs' is just a list of directory names to be added to the header file search path (-I). Returns a list of command-line options suitable for either Unix compilers or Visual C++. iisbad macro definition '%s': s5each element of 'macros' list must be a 1- or 2-tuples-U%sis-D%ss-D%s=%ss-I%sN(R&R.R/R0R3R(RRRTtmacroR7((s)/usr/lib/python2.7/distutils/ccompiler.pyRIs" "  c Cs g}x$|D]}|j|j|q WxI|D]A}|j|}t|trh|j|q4|j|q4Wx|D]}tjj|\}} |dkr|j |g| } | dk r|j| q|j d|q|j|j |qW|S(sgGenerate linker options for searching library directories and linking with specific libraries. 'libraries' and 'library_dirs' are, respectively, lists of library names (not filenames!) and search directories. Returns a list of command-line options suitable for use with some compiler (depending on the two format strings passed in). Rs6no library file corresponding to '%s' found (skipping)N( R3RRR&RGtextendRKRLRRRRR( RRRRtlib_optsR7toptRtlib_dirtlib_nametlib_file((s)/usr/lib/python2.7/distutils/ccompiler.pytgen_lib_options s$        (#Rt __revision__RRKRtdistutils.errorsRRRRRtdistutils.spawnRtdistutils.file_utilRtdistutils.dir_utilRtdistutils.dep_utilRtdistutils.utilR R t distutilsR tdistutils.sysconfigR R RRRRRRRIR(((s)/usr/lib/python2.7/distutils/ccompiler.pytsJ   (m           - 1