B bx@s0dZddlmZmZddlZddlZddlZddlZddl Zddl Zddlm Z ddl m Z mZGdddZeZgfdd ZGd d d ejjZGd d d ejjZGdddejjZGdddeZdddZGdddeZddZddZGdddZGdddZGdd d ejjZd!d"Z dS)#a SCons.Builder Builder object subsystem. A Builder object is a callable that encapsulates information about how to execute actions to create a target Node (file) from source Nodes (files), and how to create those dependencies for tracking. The main entry point here is the Builder() factory method. This provides a procedural interface that creates the right underlying Builder object based on the keyword arguments supplied and the types of the arguments. The goal is for this external interface to be simple enough that the vast majority of users can create new Builders as necessary to support building new types of files in their configurations, without having to dive any deeper into this subsystem. The base class here is BuilderBase. This is a concrete base class which does, in fact, represent the Builder objects that we (or users) create. There is also a proxy that looks like a Builder: CompositeBuilder This proxies for a Builder with an action that is actually a dictionary that knows how to map file suffixes to a specific action. This is so that we can invoke different actions (compilers, compile options) for different flavors of source files. Builders and their proxies have the following public interface methods used by other modules: - __call__() THE public interface. Calling a Builder object (with the use of internal helper methods) sets up the target and source dependencies, appropriate mapping to a specific action, and the environment manipulation necessary for overridden construction variable. This also takes care of warning about possible mistakes in keyword arguments. - add_emitter() Adds an emitter for a specific file suffix, used by some Tool modules to specify that (for example) a yacc invocation on a .y can create a .h *and* a .c file. - add_action() Adds an action for a specific file suffix, heavily used by Tool modules to add their specific action(s) for turning a source file into an object file to the global static and shared object file Builders. There are the following methods for internal use within this module: - _execute() The internal method that handles the heavily lifting when a Builder is called. This is used so that the __call__() methods can set up warning about possible mistakes in keyword-argument overrides, and *then* execute all of the steps necessary so that the warnings only occur once. - get_name() Returns the Builder's name within a specific Environment, primarily used to try to return helpful information in error messages. - adjust_suffix() - get_prefix() - get_suffix() - get_src_suffix() - set_src_suffix() Miscellaneous stuff for handling the prefix and suffix manipulation we use in turning source file names into target file names. )UserDictUserListN)logInstanceCreation) InternalError UserErrorc@s eZdZdS)_NullN)__name__ __module__ __qualname__r r ,lib/python3.7/site-packages/SCons/Builder.pyrqsrcs`|rTfdd|D}|rTtdd|Dd}dt| t| dgStjS)Ncs&g|]}t| d|kr|qS)N)len).0S)pathr r xsz"match_splitext..cSsg|]}t||fqSr )r )rZ_fr r r rzs)maxr SConsUtilsplitext)rsuffixesZmatchsufsufr )rr match_splitextvs $rcs:eZdZdZd fdd ZddZdd Zd d ZZS) DictCmdGeneratorzThis is a callable class that can be used as a command generator function. It holds on to a dictionary mapping file suffixes to Actions. It uses that dictionary to return the proper action based on the file suffix of the source file.NTcst|||_dS)N)super__init__source_ext_match)selfmappingr) __class__r r rs zDictCmdGenerator.__init__cCs t|S)N)listkeys)rr r r src_suffixesszDictCmdGenerator.src_suffixescCs |||<dS)z1Add a suffix-action pair to the mapping. Nr )rsuffixactionr r r add_actionszDictCmdGenerator.add_actionc Csf|sgS|jrp|}d}xntt|D]D}t||d}|rf||krftdtttt||||f|}q&Wntt|d|d}|stdtttt|tttt|fytj j ||||} WnHt k r} z(td| j d| j d| j dfWdd} ~ XYnX| dkrbtdtttt|tttt||tt|f| S)Nrz^While building `%s' from `%s': Cannot build multiple sources with different extensions: %s, %srzGWhile building `%s': Cannot deduce file extension from source files: %szAAmbiguous suffixes after environment substitution: %s == %s == %szWhile building `%s' from `%s': Don't know how to build from a source file with suffix `%s'. Expected a suffix in this list: %s.)rr#mapstrrrreprr!rrSelector__call__KeyErrorargsr") rtargetsourceenvZ for_signaturerZextsrcZmy_extreter r r r,s.  (6 8zDictCmdGenerator.__call__)NT) rr r __doc__rr#r&r, __classcell__r r )r r r~s rc@seZdZdZddZdS)CallableSelectorzPA callable dictionary that will, in turn, call the value it finds if it can.cCs(tjj|||}t|r$|||}|S)N)rrr+r,callable)rr1r0valuer r r r,s zCallableSelector.__call__N)rr r r5r,r r r r r7sr7c@seZdZdZddZdS) DictEmitteralA callable dictionary that maps file suffixes to emitters. When called, it finds the right emitter in its dictionary for the suffix of the first source file, and calls that emitter to get the right lists of targets and sources to return. If there's no emitter for the suffix in its dictionary, the original target and source are returned. cCs.tjj|||}|r&||||\}}||fS)N)rrr+r,)rr/r0r1emitterr r r r,szDictEmitter.__call__N)rr r r5r,r r r r r:sr:c@seZdZdZddZdS) ListEmitterzWA callable list of emitters that calls each in sequence, returning the result. cCs(x|jD]}||||\}}qW||fS)N)data)rr/r0r1r4r r r r,s zListEmitter.__call__N)rr r r5r,r r r r r<sr<r/r0)Ztargetssourcescs(eZdZdZfddZddZZS)OverrideWarnera'A class for warning about keyword arguments that we use as overrides in a Builder call. This class exists to handle the fact that a single Builder call can actually invoke multiple builders. This class only emits the warnings once, no matter how many Builders are invoked. cs(t|tjjrt|dd|_dS)NzBuilder.OverrideWarner)rrrDebugtrack_instancesralready_warned)rr)r r r rs  zOverrideWarner.__init__cCsT|jr dSx>|D]2}|tkrt|}d||f}tjtjj|qWd|_dS)Nz)Did you mean to use `%s' instead of `%s'?r)rBr"misleading_keywordsrWarningswarnZMisleadingKeywordsWarning)rkZaltmsgr r r rEs zOverrideWarner.warn)rr r r5rrEr6r r )r r r?s r?cKsNd}d|kr:d|krtdtj|di|d<|d=ntd|kr|dd}d|kr\|d=tj|drt|d|}tj|i|d<||d<ntj|d|d<d|kr,|d}tj |rtj |}|std |t ||d<n6tj|rt ||d<ntj |r,t||d<tf|}|dk rJt||}|S) zA factory for builder objects.N generatorr%z4You must not specify both an action and a generator.rT src_suffixr;zISupplied emitter '%s' does not appear to refer to an Environment variable)rrZActionZCommandGeneratorActiongetris_Dictrr# is_StringZget_environment_var EmitterProxyr:is_Listr< BuilderBaseCompositeBuilder)kwZ compositerr;varresultr r r Builders<         rTc Csx|D]}|jr td||r|jdk r"|j|k r"t|jddt|ddkr|t|jddt|ddkr||jr"|jj}|jj|||j}|j|||}||krd|| |||jf}t j t j j |nFyd||d |d f}Wntk rd |}YnXt||jr|j|krZd |j||||f}t|||krd |ttt|ttt|f}t|q|j|krd |ttt|jttt|f}t|qW|jrt|dkrtdttt|ttt|fdS)zValidate that the lists of target and source nodes are legal for this builder and environment. Raise errors or issue warnings as appropriate. z=Multiple ways to build the same target were specified for: %sNZ __subjectrr overrideszeTwo different environments were specified for target %s, but they appear to have the same action: %szlTwo environments with different actions were specified for the same target: %s (action 1: %s) (action 2: %s)zutf-8zNTwo environments with different actions were specified for the same target: %szITwo different builders (%s and %s) were specified for the same target: %szMTwo different target lists have a target in common: %s (from %s and from %s)zTMultiple ways to build the same target were specified for: %s (from %s and from %s)zKMore than one source given for single-source builder: targets=%s sources=%s)Z side_effectrZhas_explicit_builderr1getattrmultibuilderr%Z get_contentsZ genstringrrDrEZDuplicateEnvironmentWarningdecodeUnicodeDecodeErrorget_name get_executorZget_all_targetsr!r(r)r> single_sourcer ) rXr1tlistslisttr%Z t_contentscontentsrGr r r _node_errorss@  *  $ rbc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rMaThis is a callable class that can act as a Builder emitter. It holds on to a string that is a key into an Environment dictionary, and will look there at actual build time to see if it holds a callable. If so, we will call that as the actual emitter.cCstj||_dS)N)rrZ to_StringrR)rrRr r r rRszEmitterProxy.__init__cCst|j}x tj|r&||kr&||}qWt|rB||||\}}n*tj|rlx|D]}||||\}}qTW||fS)N)rRrrrLr8rN)rr/r0r1r;r4r r r r,Us   zEmitterProxy.__call__cCs |j|jkS)N)rR)rotherr r r __eq__eszEmitterProxy.__eq__cCs |j|jkS)N)rR)rrcr r r __lt__hszEmitterProxy.__lt__cCs |j|jkS)N)rR)rrcr r r __le__kszEmitterProxy.__le__cCs |j|jkS)N)rR)rrcr r r __gt__nszEmitterProxy.__gt__cCs |j|jkS)N)rR)rrcr r r __ge__qszEmitterProxy.__ge__N) rr r r5rr,rdrerfrgrhr r r r rMKsrMc@s,eZdZdZdddddddddddddedddfddZd d Zd d Zd dZd7ddZ d8ddZ d9ddZ iifddZ ddefddZ ddZgfddZddZgfdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zifd+d,Zd-d.Zejed/d0Zd1d2Zejed3d4Zd5d6ZdS):rOzdBase class for Builders, objects that create output nodes (files) from input nodes (files). NrrFcKstjjrt|di|_||_| |_tj|r8t |}||_ tj|rRt |}| |_ | |_ d|krrd}t |d|krd}t |||_||||||_||_||_||_||_| |_| r| |_i|_|tk r||jd<||_|dkrg}ntj|s|g}||_dS)NzBuilder.BuilderBaserUzThe "overrides" keyword to Builder() creation has been removed; specify the items as keyword arguments to the Builder() call instead.scannerztThe "scanner" keyword to Builder() creation has been removed; use: source_scanner or target_scanner as appropriate.chdir)rr@rAr_memor%rWrrKr7prefixr1r] TypeErrorrU set_suffixset_src_suffix ensure_suffixtarget_factorysource_factorytarget_scannersource_scannerr;name executor_kw_null is_explicitrN src_builder)rr%rmr$rIrrrsrtrur;rWr1r]rvrkryrzrqrUrGr r r rysL      zBuilderBase.__init__cCs tddS)NzSDo not test for the Node.builder attribute directly; use Node.has_builder() instead)r)rr r r __bool__szBuilderBase.__bool__c Csny*t|d|}t|d|Sttttfk rhy|jStk rbt |j SXYnXdS)aBAttempts to get the name of the Builder. Look at the BUILDERS variable of env, expecting it to be a dictionary containing this Builder, and return the key of the dictionary. If there's no key, then return a directly-configured name (if there is one) or the name of the class (by default).BUILDERSN) r!valuesindexr"AttributeErrorr-rn ValueErrorrvr)r )rr1r~r r r r[szBuilderBase.get_namecCs |j|jkS)N)__dict__)rrcr r r rdszBuilderBase.__eq__cCs(|s |j}|r||}ng}t||S)N)r1r#r)rrr1rr r r rs  zBuilderBase.splitextcCsX|sgSg}tj|s|g}x4|D],}tj|rFtj||||}||q$W|S)N)rrrNrLZ adjustixesappend)rfilesprerrqrSfr r r _adjustixess   zBuilderBase._adjustixescs}j}j}|d|}||}|}|} |dkry|dj} Wn:t k rt d|dYqt k rg} YqXfdd} | || | g} n$||| j }j||||d} j rg} x(| D] }|s|| |qW| dd}|dd}j | |d\}}x$| D]}|jkrP|dqPWj||||d} j||||d}| |fS)zz+BuilderBase._create_nodes..)r/r0)r/r0r1)get_src_suffix get_factoryrrrsr arg2nodes get_prefix get_suffixZtarget_from_sourcerr IndexErrorrqr;Z is_derived builder_setrrX)rr1r/r0src_sufrrrsr_rrZt_from_sr^rZ new_targetsr`Z orig_tlistZ orig_slistr )r1rr _create_nodessF               zBuilderBase._create_nodesc Csv|jr||||}|jrt|dkr|dkrg}|dkrHdgt|}xHt||D]:\}}|dk rj|g}|dk rx|g}||||||qTWtj |S| | |||\} } t| dkrx| D] } | | _ qWt ||| | d} d} |jr0y| djdd} Wnttfk r$Yn X| | | dkr|jsnd}t|||pX|jttt| f|j|p~|j| | } | rytj| } Wntk rYnX| | | | dkrtj|j|g| | |} | rtj| | xN| D]F} |j !| _"| #|| $|| %| | &| | '|j(qW|)drjx| D]}d|j*_+qXWtj | S)Nrr)Zcreatez+Builder %s must have an action to build %s.Z SCONF_NODE),rzsrc_builder_sourcesr]r zipextend_executerZNodeZNodeListrErZ target_peersrbrWr\rrZ add_sourcesr%rr[r1r!r(r)Z batch_keyZExecutorZGetBatchExecutorr-Z add_batchZAddBatchExecutorZfsgetcwdcwdrZenv_setZ add_sourceZ set_executorZ set_explicitryrJZ attributesZ conftest_node)rr1r/r0overwarnrwrSZtgtr2r^r_r`ZexecutorkeyZfmtZnoder r r r'sn                 zBuilderBase._executec Ks|tkr|j}n|j}||d<d|krLtj|drL||d|d<|rd|kr|dfdd}tj|sz|g}tt ||}|d=|j r|j }| |q|}n|j }| |}| |||t||S)NrksrcdircSs2ddl}tj|r.|j|s.|j||}|S)Nr)os.pathrrrLrisabsjoin)rrosr r r prependDirIfRelativesz2BuilderBase.__call__..prependDirIfRelative)rxrwcopyrrrLsubstrNr!r(rUupdateZOverriderr?) rr1r/r0rkrQZekwrZenv_kwr r r r,ws(     zBuilderBase.__call__cCs|r|ddkrd|S|S)Nr)._$rr )rZsuffr r r adjust_suffixszBuilderBase.adjust_suffixcCs"|j}t|r|||}||S)N)rmr8r)rr1r>rmr r r rs zBuilderBase.get_prefixcCst|s||}||_dS)N)r8rr$)rr$r r r ros zBuilderBase.set_suffixcCs"|j}t|r|||}||S)N)r$r8r)rr1r>r$r r r rs zBuilderBase.get_suffixcs4|s g}ntj|s|g}fdd|D_dS)Ncs"g|]}t|r|p|qSr )r8r)rr)rr r rsz.BuilderBase.set_src_suffix..)rrrNrI)rrIr )rr rps  zBuilderBase.set_src_suffixcCs||}|sdS|dS)z5Get the first src_suffix in the list of src_suffixes.rir)r#)rr1r3r r r rs zBuilderBase.get_src_suffixcCs||j|<dS)a?Add a suffix-emitter mapping to this Builder. This assumes that emitter has been initialized with an appropriate dictionary type, and will throw a TypeError if not, so the caller is responsible for knowing that this is an appropriate method to call for the Builder in question. N)r;)rr$r;r r r add_emitterszBuilderBase.add_emittercCsi|_|j|dS)z Add a new Builder to the list of src_builders. This requires wiping out cached values so that the computed lists of source suffixes get re-calculated. N)rlrzr)rrXr r r add_src_builderszBuilderBase.add_src_buildercCs8i}x.||D] }x||D] }|||<q WqW|S)au Returns a dictionary mapping all of the source suffixes of all src_builders of this Builder to the underlying Builder that should be called first. This dictionary is used for each target specified, so we save a lot of extra computation by memoizing it for each construction environment. Note that this is re-computed each time, not cached, because there might be changes to one of our source Builders (or one of their source Builders, and so on, and so on...) that we can't "see." The underlying methods we call cache their computed values, though, so we hope repeatedly aggregating them into a dictionary like this won't be too big a hit. We may need to look for a better way to do this if performance data show this has turned into a significant bottleneck. )get_src_buildersr#)rr1sdictbldrr r r _get_sdicts zBuilderBase._get_sdictc s,||}||}tttt|}||fddg}xtj|D]}tj |r| |} | sd|kr| |} | |d| d}n |j } | ry || } Wntk r||Yn.match_src_suffix..r )rvr#lengthsZ node_suffixesrr )rvr match_src_suffixs  z9BuilderBase.src_builder_sources..match_src_suffixrrrcsg|]}|jr|qSr )rv)rr`)rr r r sz3BuilderBase.src_builder_sources..)rr#r!setr(r rrZflattenrLrrrrvr-rrrrrsr)rr1r0rrr#rrSsZ match_suffixrrr^rsr )rr rs0          zBuilderBase.src_builder_sourcescCst|S)N)id)rr1r r r _get_src_builders_keysz!BuilderBase._get_src_builders_keyc Cst|}y|jd}Wn"tk r8i}||jd<Yn Xy||Stk rVYnXg}xL|jD]B}tj|ry|d|}Wntk rwdYnX||qdW|||<|S)z Returns the list of source Builders for this Builder. This exists mainly to look up Builders referenced as strings in the 'BUILDER' variable of the construction environment and cache the result. rr|)rrlr-rzrrrLr)rr1memo_key memo_dictZbuildersrr r r rs(   zBuilderBase.get_src_builderscCst|S)N)r)rr1r r r _subst_src_suffixes_key:sz#BuilderBase._subst_src_suffixes_keycsxt}y|jd}Wn"tk r8i}||jd<Yn Xy||Stk rVYnXfdd|jD}|||<|S)z The suffix list may contain construction variable expansions, so we have to evaluate the individual strings. To avoid doing this over and over, we memoize the results for each construction environment. subst_src_suffixescsg|]}|qSr )r)rx)r1r r rPsz2BuilderBase.subst_src_suffixes..)rrlr-rI)rr1rrrr )r1r r=szBuilderBase.subst_src_suffixescCsji}||}x|D] }d||<qWx@||D]2}x,||D]}||kr@d||<||q@Wq0W|S)a+ Returns the list of source suffixes for all src_builders of this Builder. This is essentially a recursive descent of the src_builder "tree." (This value isn't cached because there may be changes in a src_builder many levels deep that we can't see.) r)rrr#r)rr1rrrrXr r r r#Ts    zBuilderBase.src_suffixes)N)F)NN) rr r r5rxrr{r[rdrrrrr,rrrorrprrrrrrrZMemoizeZ CountDictCallrrrr#r r r r rOtsR 1 @P"     +!rOcs4eZdZdZfddZejdZddZ Z S)rPzA Builder Proxy whose main purpose is to always have a DictCmdGenerator as its action, and to provide access to the DictCmdGenerator's add_action() method. cs.tjjrt|dt|||_||_dS)NzBuilder.CompositeBuilder)rr@rArrrcmdgenrX)rrXr)r r r rns   zCompositeBuilder.__init__r,cCs"|j||||jdS)N)rr&rpr#)rr$r%r r r r&xszCompositeBuilder.add_action) rr r r5rrrZDelegater,r&r6r r )r r rPhs  rPcCst|tpt|tpt|S)z"Returns True if the specified obj is one of our Builder classes. The test is complicated a bit by the fact that CompositeBuilder is a proxy, not a subclass of BuilderBase. ) isinstancerOrPr8)objr r r is_a_Builder|s  r)!r5 collectionsrrZ SCons.ActionrZ SCons.DebugZSCons.ExecutorZ SCons.MemoizeZ SCons.UtilZSCons.WarningsrZ SCons.Errorsrrrrxrrr+rr7r:r<rCr?rTrbrMrOZProxyrPrr r r r ds8  2 *1)w