BPcuG|dZddlZddlZddlZddlZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZddlmZmZddlmZddlmZmZddlmZmZmZmZmZdd lm Z dd l!m"Z"dd l#m$Z$ej%j&Z%Gd d Z'ere'Z(ne)Z(Gdde(Z*Gdde(Z+Gdde(Z,Gdde+e,Z-dS)z? The ultimate base functionality for every Inkscape extension. N) DictListTupleTypeOptionalCallableAnyUnionIO TYPE_CHECKINGcast)ArgumentParser Namespace)etree) IBaseElementISVGDocumentElement) filename_argAbortExtension ABORT_STATUSerrormsg do_nothing)load_svg)NSS)localizecdeZdZdZdZiZdZdZdZddZ e dZ e d e e d eegeffd Zd Ze d ZdefdZdZdZdZdZdZdZdZed dZedZed!dZ edZ!ed"dZ"e#dZ$dS)#InkscapeExtensionzg The base class extension, provides argument parsing and basic variable handling features. Fctj|jd|_t |_d|_t|j|_ |j dddtdd|j dtdd | |j tdS) N) description input_file? INPUT_FILEz-Filename of the input file (default is stdin))nargsmetavartypehelpdefaultz--outputzCOptional output filename for saving the result (default is stdout).)r%r'r&)rupdate extra_nssfile_ioroptionsdocumentr__doc__ arg_parser add_argumentrstr add_argumentsrselfs ,/usr/share/inkscape/extensions/inkex/base.py__init__zInkscapeExtension.__init__?s 4>"""  {{  (T\BBB $$  @ %    $$ V %    4?+++ cdS)zAdd any extra arguments to your extension handle, use: def add_arguments(self, pars): pars.add_argument("--num-cool-things", type=int, default=3) pars.add_argument("--pos-in-doc", type=str, default="doobry") N)r3parss r4r1zInkscapeExtension.add_arguments[sr6cD|j||_dS)z0Parse the given arguments and set 'self.options'N)r. parse_argsr+)r3argss r4parse_argumentsz!InkscapeExtension.parse_argumentses11$77 r6methodcfd}|S)a<Used by add_argument to match a tab selection with an object method pars.add_argument("--tab", type=self.arg_method(), default="foo") ... self.options.tab(arguments) ... .. code-block:: python .. def method_foo(self, arguments): .. # do something c2d|ddd} t|S#t$r9}|dr t cYd}~Std||d}~wwxYw)N_"-zCan not find method )striplowerreplacegetattrAttributeError startswithrr)valuenameerrorprefixr3s r4_innerz,InkscapeExtension.arg_method.._innerws==S!1!1!7!7!9!9==EEc3OOD OtT***! O O O??3''&%%%%%%%$%BD%B%BCCN Os$A BB8B>BBr8)r3rMrNs`` r4 arg_methodzInkscapeExtension.arg_methodjs/ O O O O O O r6c d}|S)aParses a number descriptor. e.g: ``1,2,4-5,7,9-`` is parsed to ``1, 2, 4, 5, 7, 9, 10, ..., lastvalue`` .. versionadded:: 1.2 Usage: .. code-block:: python # in add_arguments() pars.add_argument("--pages", type=self.arg_number_ranges(), default=1-) # later on, pages is then a list of ints pages = self.options.pages(lastvalue) cdddfd S)Nrctjdfd|}tttjd|}t fd|D}|S)Nz(\d+|)\s?-\s?(\d+|)c ^|dp|ddks}dttt t |dpt |dpdzndS)Nr,)groupjoinmapr0rangeint)m lastvalue startvalues r4zUInkscapeExtension.arg_number_ranges.._inner..method..sGGAJJ4!''!**;;"hh! #AGGAJJ$<* = = #AGGAJJ$;) < zVInkscapeExtension.arg_number_ranges.._inner..method..sBBBQ1 >>q>>>r6)resubrYr[findalltuple)pagesr]r^s ``r4r>zCInkscapeExtension.arg_number_ranges.._inner..methodsz*      CHe!rJs r4r_zEInkscapeExtension.arg_number_ranges.._inner..s66yZ444r6)rr8)rJr>s`@r4rNz3InkscapeExtension.arg_number_ranges.._inners;    , r6r8)rNs r4arg_number_rangesz#InkscapeExtension.arg_number_rangess&   6 r6r+returnc"dtffd }|S)aIUsed by add_argument to match an option with a class Types to choose from are given by the options list .. versionadded:: 1.2 Usage: .. code-block:: python pars.add_argument("--class", type=self.arg_class([ClassA, ClassB]), default="ClassA") rJcz|d}D]}||jkr|cStd|)NrBzCan not find class )rD__name__r)rJrKrbr+s r4rNz+InkscapeExtension.arg_class.._innersU;;s##D  1:%%HHH& !=t!=!=>> >r6)r0)r+rNs` r4 arg_classzInkscapeExtension.arg_classs/  ?# ? ? ? ? ? ? r6cVtdt|jd|ddS)zWrite a debug messagezDEBUG  N)rr%rn)r3msgs r4debugzInkscapeExtension.debugs5 8$t**-8888899999r6c$t|dS)zWrite a non-error messageN)r)rrs r4rrzInkscapeExtension.msgs  r6Nc |tjdd}|||jjtj|j_n'dt jvr|jjt jd<|jj ||j_| | | nL#t$r?}tt|tjt Yd}~nd}~wwxYw|dS#|wxYw)z*Main entrypoint for any Inkscape ExtensionNr DOCUMENT_PATH)sysargvr=r+r stdinosenvironoutputload_rawsave_raweffectrrr0exitrclean_up)r3r<r|errs r4runzInkscapeExtension.runs |x|   & & &|&.*-) ''  22.2l.E ?+|"*&, # MMOOO MM$++-- ( ( ( ( # # # SXX    H\ " " " " " " " " # MMOOOOODMMOOOOs0CC D- D5D D-DD--Ect|jjtr:t |jjd|_||j}n||jj}||_dS)z:Load the input stream or filename, save everything to selfrbN) isinstancer+r r0openr*loadr,)r3r,s r4r}zInkscapeExtension.load_rawsg dl-s 3 3 : 7>>DLyy..HHyy!899H  r6c||rt|jjtrJt |jjd5}||ddddS#1swxYwYdStjdkrXdtj vrJd|jj_ d dtdtfd }d }||jj_ ||jj_||jjdSdS) z3Save to the output stream, use everything from selfwbNwin32PYTEST_CURRENT_TESTcdS)NFr8r2s r4r_z,InkscapeExtension.save_raw..sr6roffsetwhencec td)Nz9We can't seek in the stream passed by Inkscape on WindowsrH)rrs r4seek_replacementz4InkscapeExtension.save_raw..seek_replacement,Wr6c td)Nz9We can't tell in the stream passed by Inkscape on Windowsrr8r6r4tell_replacementz4InkscapeExtension.save_raw..tell_replacement rr6)r) has_changedrr+r|r0rsaverwplatformrzr{seekabler[seektell)r3retstreamrrs r4r~zInkscapeExtension.save_rawsb   C  /$,-s33 /$,-t44&IIf%%%&&&&&&&&&&&&&&&&&&<7**3HBJ3V3V4F3EDL'0c 0@DL',/?DL', $,-.....3 / /sA22A69A6c0td|j)z9Takes the input stream and creates a document for parsingzNo input handle for NotImplementedErrorrKr3rs r4rzInkscapeExtension.loads""D"D"DEEEr6c0td|j)z*Save the given document to the output filezNo output handle for rrs r4rzInkscapeExtension.save""E$)"E"EFFFr6c0td|j)z3Apply some effects on the document or local contextzNo effect handle for rr2s r4rzInkscapeExtension.effect!rr6c |duS)z)Return true if the output should be savedFr8)r3rs r4rzInkscapeExtension.has_changed&s%r6cJ|j|jdSdS)z)Clean up any open handles and other itemsN)r*closer2s r4rzInkscapeExtension.clean_up+s. < # L    $ #r6cx|}|rtj|S|r|S|S)a Return the folder the svg is contained in. Returns None if there is no file. .. versionchanged:: 1.1 A default path can be given which is returned in case no path to the SVG file can be determined. ) document_pathrzpathdirname)clsr'rs r4svg_pathzInkscapeExtension.svg_path1sC  ""  )7??4(( (  N r6cxtjtj|jjpdS)z,Return the folder the extension script is inrU)rzrrrwmodules __module____file__rs r4ext_pathzInkscapeExtension.ext_pathCs)ws{3>:CIrJJJr6Tc|||}|r1tj|st d||S)z^Return the full filename of the resource in the extension's dir .. versionadded:: 1.1)cwdzCould not find resource file: ) absolute_hrefrrzrisfiler)rrK abort_on_failfilenames r4 get_resourcezInkscapeExtension.get_resourceIs_ $$Ts||~~$>>  N!9!9 N !L(!L!LMM Mr6cBtjddS)aReturns the saved location of the document * Normal return is a string containing the saved location * Empty string means the document was never saved * 'None' means this version of Inkscape doesn't support DOCUMENT_PATH DO NOT READ OR WRITE TO THE DOCUMENT FILENAME! * Inkscape may have not written the latest changes, leaving you reading old data. * Inkscape will not respect anything you write to the file, causing data loss. .. versionadded:: 1.1 rvN)rzr{getrs r4rzInkscapeExtension.document_pathTs"z~~ot444r6~/c,tj|}tj|stj|}tj|s]|;||}|t d|dkrt dtj||}tjtj|S)a Process the filename such that it's turned into an absolute filename with the working directory being the directory of the loaded svg. User's home folder is also resolved. So '~/a.png` will be `/home/bob/a.png` Default is a fallback working directory to use if the svg's filename is not available. .. versionchanged:: 1.1 If you set default to None, then the user will be given errors if there's no working directory available from Inkscape. NzSCan not use relative path, Inkscape isn't telling us the current working directory.rUz8The SVG must be saved before you can use relative paths.)rzr expanduserisabsrrrXrealpath)rrr'rs r4rzInkscapeExtension.absolute_hrefgs 7%%h//w}}X&& 4w))(33Hw}}X&& 3{ll7++;(5"99(Rw||C22Hw 2 28 < <===r6c*t|jS)z&Return a fixed name for this extension)r%rnr2s r4rKzInkscapeExtension.namesDzz""r6)r>N)T)rN)%rnr __qualname__r- multi_inxr)r5r1r=rO staticmethodrjrrrr0r rorsrrstdoutrr}r~rrrrr classmethodrrrrrpropertyrKr8r6r4rr6s0 II8   888 0--\-^4:(C5#:*>\0::: \ F0 ! ! !///<FFF GGG GGG    !!! ["KK[K [55[5$>>>[>B##X###r6rc>eZdZdZdZdZfdZfdZfdZxZ S) TempDirMixinzF Provide a temporary directory for extensions to stash files. rUinktmpcHd|_tj|i|dSr)tempdirsuperr5)r3r<kwargs __class__s r4r5zTempDirMixin.__init__s, $)&)))))r6cddlm}||j|j|_t j|jj|_ t dS)zCreate the temporary directoryr)TemporaryDirectory)rMsuffixN) tempfiler dir_prefix dir_suffix_tempdirrzrrrKrrr})r3rrs r4r}zTempDirMixin.load_rawsu 0/////+*?4?    w'' (:;;  r6cd|_|jtdS)zDelete the temporary directoryN)rrcleanuprrr3rs r4rzTempDirMixin.clean_ups<   r6) rnrrr-rrr5r}r __classcell__rs@r4rrsJJ*****     r6rcTeZdZUdZdZeeedfed<fdZ dZ xZ S) SvgInputMixinzI Expects the file input to be an svg document and will parse it. r8. select_allct|jddtdgd|jddtdgddS) Nz--idappendidsz$id attribute of object to manipulate)actionr%destr'r&z--selected-nodesselected_nodesz-id:subpath:position of selected nodes, if any)rr5r.r/r0rs r4r5zSvgInputMixin.__init__s  $$ 7 %    $$ !@ %     r6cJt|}tj||_||_|jjj|jj |jjs7|j r0|j j |j |j_|S)z5Load the stream as an svg xml etree and make a backup) rcopydeepcopyoriginal_documentgetrootsvg selectionsetr+rr descendantsfilter)r3rr,s r4rzSvgInputMixin.loadsF##!%x!8!8(0(8(8(:(: 011x! Qdo Q!>!5!5!7!7!>!PDH r6) rnrrr-rrrr__annotations__r5rrrs@r4rrst 24Jd<(#-.333     *       r6rc2eZdZdZdZedZdZdS)SvgOutputMixinz Expects the output document to be an svg document and will write an etree xml. A template can be specified to kick off the svg document building process. a{ c |ddtt|jjdi|S)z Opens a template svg document for building, the kwargs MUST include all the replacement values in the template, the default template has 'width' and 'height' of the document. unitrUr8) setdefaultrr0templateformat)rrs r4 get_templatezSvgOutputMixin.get_templatesF &"%%%/CL/99&99::;;;r6ct|jttfr|j}ndt |jjvrAt t|j}| }n-tdt |jjddz | |dS#t$r,| | dYdSwxYw)z)Save the svg document to the given streamElementzUnknown type of document: z can notzsave.zutf-8N)rr,bytesr0r%rnr rrtostring ValueErrorwrite TypeErrorencode)r3rr,docs r4rzSvgOutputMixin.saves dmeS\ 2 2 }HH $t}--6 6 6udm,,C{{}}--//HHST$--@-@-ISSS   3 LL " " " " " 3 3 3 LL11 2 2 2 2 2 2 3s4C 2DDN)rnrrr-rrrrr8r6r4rrsO H<<[<33333r6rceZdZdZdZdS)SvgThroughMixinzS Combine the input and output svg document handling (usually for effects). crtj|j}tj|j}||kS)z+Return true if the svg document has changed)rrrr,)r3roriginalresults r4rzSvgThroughMixin.has_changeds2>$"899 ..6!!r6N)rnrrr-rr8r6r4rrs-"""""r6r).r-rzrdrwrtypingrrrrrrr r r r r argparserrlxmlrinterfaces.IElementrrutilsrrrrrelements._parserrelements._utilsr localizationrrbufferr_Baseobjectrrrrr8r6r4rsc&                           /.......BBBBBBBBSSSSSSSSSSSSSS&&&&&& """"""  W#W#W#W#W#W#W#W#t  EE E5B&&&&&E&&&R,3,3,3,3,3U,3,3,3^ " " " " "m^ " " " " "r6