B 0ªaŒã@s6dZddlmZddlmZddlmZddlmZddlZddlZddlZddl m Z ddlm Z m Z m Z d d l mZmZd d lmZmZmZdZd Zd Zd ZdZdZdZdZeeeegZdZdZeegZdZ dZ!e e!gZ"dZ#dZ$dZ%dZ&dZ'dZ(dZ)dZ*dZ+dZ,e#e$e%e&e'e(e)e*e+e,g Z-eee"e-Z.d Z/d!Z0d"Z1d#Z2dZ3d$Z4d%Z5d&Z6d'Z7d(Z8d)Z9d*Z:d+Z;d,Zd/Z?d0Z@d1ZAd2ZBd3ZCd4ZDd5ZEdZFdZGd6ZHdZIdZJe1e=e>e?e2e3e4e5e6e7e8e9e:e;eZVd?ZWeVeWgZXd-ZYeYgZZd@Z[dAZ\dBZ]e[e\e]gZ^dCZ_dDZ`dEZadFZbe_e`eaebgZce ddGeje¡Zfe ddHejeejgB¡Zhe ddIejeejgB¡Zie ddJejeejgB¡Zje ddKejeejgB¡Zke ddLejeejgB¡Zle ddMejeejgB¡Zme ddNejeejgB¡Zne ddOejeejgB¡Zoe ddPejeejgB¡Zpe ddQejeejgB¡ZqdR re.¡ sdSdT¡Zte ddUetdVejeejgBejuB¡Zve ddWejeejgB¡Zwe ddXejeejgBejuB¡ZxGdYdZ„dZeƒZyGd[d\„d\ezƒZ{Gd]d^„d^e{ƒZ|Gd_d`„d`e{ƒZ}Gdadb„dbe{ƒZ~e dcdddedfdgdhgƒZe dcdddedfdgƒZ€Gdidj„djezƒZGdkdl„dlezƒZ‚dS)mu GTK-Doc comment block format ---------------------------- A GTK-Doc comment block is built out of multiple parts. Each part can be further divided into fields which are separated by a colon ("``:``") delimiter. Known parts and the fields they are constructed from look like the following (optional fields are enclosed in square brackets):: ┌───────────────────────────────────────────────────────────┠│ /** │ ─▷ start token ├────────────────────┬──────────────────────────────────────┤ │ * identifier_name │ [: annotations] │ ─▷ identifier part ├────────────────────┼─────────────────┬────────────────────┤ │ * @parameter_name │ [: annotations] │ : description │ ─▷ parameter part ├────────────────────┴─────────────────┴────────────────────┤ │ * │ ─▷ comment block description │ * comment_block_description │ ├─────────────┬─────────────────┬───────────┬───────────────┤ │ * tag_name │ [: annotations] │ [: value] │ : description │ ─▷ tag part ├─────────────┴─────────────────┴───────────┴───────────────┤ │ */ │ ─▷ end token └───────────────────────────────────────────────────────────┘ There are two conditions that must be met before a comment block is recognized as a GTK-Doc comment block: #. The comment block is opened with a GTK-Doc start token ("``/**``") #. The first line following the start token contains a valid identifier part Once a GTK-Doc comment block has been identified as such and has been stripped from its start and end tokens the remaining parts have to be written in a specific order: #. There must be exactly 1 `identifier` part on the first line of the comment block which consists of: * a required `identifier_name` field * an optional `annotations` field, optionally spanning multiple lines #. Zero or more `parameter` parts, each consisting of: * a required `parameter_name` field * an optional `annotations` field, optionally spanning multiple lines * a required `description` field (can be the empty string) #. One optional `comment block description` part which must begin with at least 1 empty line signaling the start of this part. #. Zero or more `tag` parts, each consisting of: * a required `tag_name` field * an optional `annotations` field, optionally spanning multiple lines * an optional `value` field * a required `description` field (can be the empty string) Additionally, the following restrictions are in effect: #. Separating parts with an empty line: * `identifier` and `parameter` parts cannot be separated from each other by an empty line as this would signal the start of the `comment block description` part (see above). * it is required to separate the `comment block description` part from the `identifier` or `parameter` parts with an empty line (see above) * `comment block description` and `tag` parts can optionally be separated by an empty line #. Parts and fields cannot span multiple lines, except for: * the `comment_block_description` part * `parameter description` and `tag description` fields * `identifier`, `parameter` and `tag` part `annotations` fields #. Taking the above restrictions into account, spanning multiple paragraphs is limited to the `comment block description` part and `tag description` fields. Refer to the `GTK-Doc manual`_ for more detailed usage information. .. _GTK-Doc manual: http://developer.gnome.org/gtk-doc-manual/1.18/documenting.html.en é)Úabsolute_import)Údivision)Úprint_function)Úunicode_literalsN)Ú namedtuple)ÚneÚgtÚlté)ÚCounterÚ OrderedDict)ÚPositionÚwarnÚerrorééZ deprecatedZreturnsZsinceZ stabilityÚ descriptionz return valueÚreturnz returns valueÚ attributeszget value funczref funcz rename tozset value funcZtransferÚtypez unref funcÚvalueZvirtualú(ú)z allow-noneZarrayZclosureÚ constructorZdestroyz element-typeZforeignzget-value-funcÚinZinoutÚmethodZnullableZoptionalÚnotÚoutzref-funcz rename-toZscopezset-value-funcÚskipz unref-funcZ attributezin-outcCsg|]}|tkr|‘qS©)ÚDICT_ANNOTATIONS)Ú.0Úannrrúsr$z fixed-sizeÚlengthzzero-terminatedzcallee-allocateszcaller-allocatesÚasyncZcallZnotifiedZ containerZfloatingZfullÚnonez \r\n|\r|\naV ^ # start (?P.*?) # whitespace, code, ... \s* # 0 or more whitespace characters (?P/\*{2}(?![\*/])) # 1 forward slash character followed # by exactly 2 asterisk characters # and not followed by a slash character \s* # 0 or more whitespace characters (?P.*?) # GTK-Doc comment text \s* # 0 or more whitespace characters $ # end aû ^ # start \s* # 0 or more whitespace characters (?P.*?) # GTK-Doc comment text \s* # 0 or more whitespace characters (?P\*+/) # 1 or more asterisk characters followed # by exactly 1 forward slash character (?P.*?) # whitespace, code, ... \s* # 0 or more whitespace characters $ # end a  ^ # start \s* # 0 or more whitespace characters (?P.*?) # invalid comment text \s* # 0 or more whitespace characters \* # 1 asterisk character \s? # 0 or 1 whitespace characters # WARNING: removing more than 1 # whitespace character breaks # embedded example program indentation zs ^ (?P\s*) # 0 or more whitespace characters .* $ zà ^ # start \s* # 0 or more whitespace characters $ # end a0 ^ # start \s* # 0 or more whitespace characters SECTION # SECTION \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P\w\S+?) # section name \s* # 0 or more whitespace characters :? # invalid delimiter \s* # 0 or more whitespace characters $ az ^ # start \s* # 0 or more whitespace characters (?P[\w-]*\w) # symbol name \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P.*?) # annotations + description \s* # 0 or more whitespace characters :? # invalid delimiter \s* # 0 or more whitespace characters $ # end aÄ ^ # start \s* # 0 or more whitespace characters (?P[\w]+) # class name \s* # 0 or more whitespace characters :{1} # 1 required colon \s* # 0 or more whitespace characters (?P[\w-]*\w) # property name \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P.*?) # annotations + description \s* # 0 or more whitespace characters :? # invalid delimiter \s* # 0 or more whitespace characters $ # end aà ^ # start \s* # 0 or more whitespace characters (?P[\w]+) # class name \s* # 0 or more whitespace characters :{2} # 2 required colons \s* # 0 or more whitespace characters (?P[\w-]*\w) # signal name \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P.*?) # annotations + description \s* # 0 or more whitespace characters :? # invalid delimiter \s* # 0 or more whitespace characters $ # end a' ^ # start \s* # 0 or more whitespace characters @ # @ character (?P[\w-]*\w|.*?\.\.\.) # parameter name \s* # 0 or more whitespace characters :{1} # 1 required delimiter \s* # 0 or more whitespace characters (?P.*?) # annotations + description \s* # 0 or more whitespace characters $ # end ú|ú z\sz® ^ # start \s* # 0 or more whitespace characters (?Pa) # tag name \s* # 0 or more whitespace characters :{1} # 1 required delimiter \s* # 0 or more whitespace characters (?P.*?) # annotations + value + description \s* # 0 or more whitespace characters $ # end a¾ ^ # start \s* # 0 or more whitespace characters (?P([0-9\.])*) # value \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P.*?) # description \s* # 0 or more whitespace characters $ # end a¾ ^ # start \s* # 0 or more whitespace characters (?P(stable|unstable|private|internal)?) # value \s* # 0 or more whitespace characters (?P:?) # delimiter \s* # 0 or more whitespace characters (?P.*?) # description \s* # 0 or more whitespace characters $ # end c@s&eZdZdZdZddd„Zdd„ZdS) ÚGtkDocAnnotationszó An ordered dictionary mapping annotation names to annotation options (if any). Annotation options can be either a :class:`list`, a :class:`giscanner.collections.OrderedDict` (depending on the annotation name)or :const:`None`. ÚpositionNcCst ||¡||_dS)N)r Ú__init__r+)Úselfr+Zsequencerrr#r, s zGtkDocAnnotations.__init__cCs t|j|ƒS)N)r*r+)r-rrr#Ú__copy__szGtkDocAnnotations.__copy__)NN)Ú__name__Ú __module__Ú __qualname__Ú__doc__Ú __slots__r,r.rrrr#r*s r*c@seZdZdZdZdZdCdd„Zdd„Zd d „Zd d „Z dDd d„Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zd'd(„Zd)d*„Zd+d,„Zd-d.„Zd/d0„Zd1d2„Zd3d4„Zd5d6„Zd7d8„Zd9d:„Z d;d<„Z!d=d>„Z"d?d@„Z#dAdB„Z$dS)EÚGtkDocAnnotatablezK Base class for GTK-Doc comment block parts that can be annotated. )r+Ú annotationsrNcCs||_tƒ|_dS)N)r+r*r5)r-r+rrr#r,!szGtkDocAnnotatable.__init__cCs d|jfS)Nz)r5)r-rrr#Ú__repr__*szGtkDocAnnotatable.__repr__cCsÚ|jrÖ|jj}xÆ|j ¡D]¸\}}||jkrPt|d| dd¡ƒ}||||ƒn*|tkrjtd|f|ƒntd|f|ƒ|tkrt |krt |jkr®tdtdt t f|ƒt |jkrtdtdt t f|ƒqWdS) za Validate annotations stored by the :class:`GtkDocAnnotatable` instance, if any. Z _do_validate_ú-Ú_zunexpected annotation: %szunknown annotation: %sz&cannot have both "%s" and "%s" presentr)N) r5r+ÚitemsÚvalid_annotationsÚgetattrÚreplaceÚALL_ANNOTATIONSrÚANN_NOTÚOPT_NOT_NULLABLEÚ ANN_NULLABLEÚANN_ALLOW_NONE)r-r+Úann_nameÚoptionsÚvalidaterrr#rD-s$   zGtkDocAnnotatable.validatec Csb|dkrd}n d|f}|dkr&d}n|dkr4d}n d|f}|||ƒr^td||||f|ƒd S) a, Validate the number of options held by an annotation according to the test ``operator(n_options, expected_n_options)``. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param n_options: number of options held by the annotation :param expected_n_options: number of expected options :param operator: an operator function from python's :mod:`operator` module, for example :func:`operator.ne` or :func:`operator.lt` :param message: warning message used when the test ``operator(n_options, expected_n_options)`` fails. rr'z%dz no optionsr z one optionz %d optionsz"%s" annotation %s %s, %s givenN)r) r-r+rBÚ n_optionsZexpected_n_optionsÚoperatorÚmessageÚtÚsrrr#Ú_validate_optionsNs   z#GtkDocAnnotatable._validate_optionsc CsŽt|ƒ}|dk r$| ||||td¡|dk r@| ||||td¡|dk r\| ||||td¡|rŠ|dk rŠ|d} | |krŠtd|| f|ƒdS)aß Validate an annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to be validated :param choices: an iterable of allowed option names or :const:`None` to skip this test :param exact_n_options: exact number of expected options or :const:`None` to skip this test :param min_n_options: minimum number of expected options or :const:`None` to skip this test :param max_n_options: maximum number of expected options or :const:`None` to skip this test NZneedsztakes at leastz takes at mostrz$invalid "%s" annotation option: "%s")ÚlenrJrr rr) r-r+rBrCÚchoicesÚexact_n_optionsÚ min_n_optionsÚ max_n_optionsrEÚoptionrrr#Ú_validate_annotationns z&GtkDocAnnotatable._validate_annotationcCs|j|||dddS)am Validate the ``(allow-none)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options held by the annotation r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_allow_nones z)GtkDocAnnotatable._do_validate_allow_nonec Csìt|ƒdkrdSxÖ| ¡D]Ê\}}|tkr‚y t|ƒWqättfk r~|dkrftd||f|ƒntd|||f|ƒYqäXq|tkr°|dk rä|dkrätd|||f|ƒq|tkrÒ|dkrätd|f|ƒqtd||f|ƒqWdS) ah Validate the ``(array)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options held by the annotation rNz)"%s" annotation option "%s" needs a valuezBinvalid "%s" annotation option "%s" value "%s", must be an integer)Ú0Ú1z>invalid "%s" annotation option "%s" value "%s", must be 0 or 1z-"%s" annotation option "length" needs a valuez$invalid "%s" annotation option: "%s") rKr9ÚOPT_ARRAY_FIXED_SIZEÚintÚ TypeErrorÚ ValueErrorrÚOPT_ARRAY_ZERO_TERMINATEDÚOPT_ARRAY_LENGTH)r-r+rBrCrPrrrr#Ú_do_validate_arrayœs0       z$GtkDocAnnotatable._do_validate_arraycCsdS)ab Validate the ``(attributes)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate Nr)r-r+rBrCrrr#Ú_do_validate_attributesÂs z)GtkDocAnnotatable._do_validate_attributescCs|j|||dddS)a_ Validate the ``(closure)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rON)rQ)r-r+rBrCrrr#Ú_do_validate_closureÏs z&GtkDocAnnotatable._do_validate_closurecCs|j|||dddS)ac Validate the ``(constructor)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_constructorÛs z*GtkDocAnnotatable._do_validate_constructorcCs|j|||dddS)a_ Validate the ``(destroy)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_destroyçs z&GtkDocAnnotatable._do_validate_destroycCs|j|||ddddS)a_ Validate the ``(element)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r r)rNrON)rQ)r-r+rBrCrrr#Ú_do_validate_element_typeós z+GtkDocAnnotatable._do_validate_element_typecCs|j|||dddS)a_ Validate the ``(foreign)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_foreignÿs z&GtkDocAnnotatable._do_validate_foreigncCs|j|||dddS)ab Validate the ``(value-func)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_get_value_func s z-GtkDocAnnotatable._do_validate_get_value_funccCs|j|||dddS)aZ Validate the ``(in)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_ins z!GtkDocAnnotatable._do_validate_incCs|j|||dddS)a^ Validate the ``(in-out)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_inout#s z$GtkDocAnnotatable._do_validate_inoutcCs|j|||dddS)a^ Validate the ``(method)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_method/s z%GtkDocAnnotatable._do_validate_methodcCs|j|||dddS)ak Validate the ``(nullable)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options held by the annotation r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_nullable;s z'GtkDocAnnotatable._do_validate_nullablecCs|j|||dddS)ak Validate the ``(optional)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options held by the annotation r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_optionalGs z'GtkDocAnnotatable._do_validate_optionalcCs|j|||dtddS)af Validate the ``(not)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options held by the annotation r )rMrLN)rQÚ NOT_OPTIONS)r-r+rBrCrrr#Ú_do_validate_notSs z"GtkDocAnnotatable._do_validate_notcCs|j|||dtddS)a[ Validate the ``(out)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rOrLN)rQÚ OUT_OPTIONS)r-r+rBrCrrr#Ú_do_validate_out`s z"GtkDocAnnotatable._do_validate_outcCs|j|||dddS)a` Validate the ``(ref-func)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_ref_funcms z'GtkDocAnnotatable._do_validate_ref_funccCs|j|||dddS)aa Validate the ``(rename-to)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_rename_toys z(GtkDocAnnotatable._do_validate_rename_tocCs|j|||dtddS)a] Validate the ``(scope)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMrLN)rQÚ SCOPE_OPTIONS)r-r+rBrCrrr#Ú_do_validate_scope…s z$GtkDocAnnotatable._do_validate_scopecCs|j|||dddS)ab Validate the ``(value-func)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_set_value_func’s z-GtkDocAnnotatable._do_validate_set_value_funccCs|j|||dddS)a\ Validate the ``(skip)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r)rMN)rQ)r-r+rBrCrrr#Ú_do_validate_skipžs z#GtkDocAnnotatable._do_validate_skipcCs|j|||dtddS)a` Validate the ``(transfer)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMrLN)rQÚTRANSFER_OPTIONS)r-r+rBrCrrr#Ú_do_validate_transferªs z'GtkDocAnnotatable._do_validate_transfercCs|j|||dddS)a\ Validate the ``(type)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_type·s z#GtkDocAnnotatable._do_validate_typecCs|j|||dddS)ab Validate the ``(unref-func)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_unref_funcÃs z)GtkDocAnnotatable._do_validate_unref_funccCs|j|||dddS)a] Validate the ``(value)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_valueÏs z$GtkDocAnnotatable._do_validate_valuecCs|j|||dddS)a_ Validate the ``(virtual)`` annotation. :param position: :class:`giscanner.message.Position` of the line in the source file containing the annotation to be validated :param ann_name: name of the annotation holding the options to validate :param options: annotation options to validate r )rMN)rQ)r-r+rBrCrrr#Ú_do_validate_virtualÛs z&GtkDocAnnotatable._do_validate_virtual)N)NNNN)%r/r0r1r2r3r:r,r6rDrJrQrRr[r\r]r^r_r`rarbrcrdrerfrgrirkrlrmrorprqrsrtrurvrwrrrr#r4sF !  ! &                       r4c@sJeZdZdZdZeeeee e e e e eeeeeeefZddd„Zdd„ZdS) ÚGtkDocParameterz. Represents a GTK-Doc parameter part. )ÚnamerNcCst ||¡||_d|_dS)N)r4r,ryr)r-ryr+rrr#r,ós zGtkDocParameter.__init__cCsd|j|jfS)Nz)ryr5)r-rrr#r6üszGtkDocParameter.__repr__)N)r/r0r1r2r3rAÚ ANN_ARRAYÚANN_ATTRIBUTESÚ ANN_CLOSUREÚ ANN_DESTROYÚANN_ELEMENT_TYPEÚANN_INÚ ANN_INOUTÚANN_OUTÚ ANN_SCOPEÚANN_SKIPÚ ANN_TRANSFERÚANN_TYPEÚ ANN_OPTIONALr@r>r:r,r6rrrr#rxès   rxc @s>eZdZdZdZeeeee e e e e ef Zddd„Zdd„ZdS) Ú GtkDocTagz( Represents a GTK-Doc tag part. )ryrrNcCs"t ||¡||_d|_d|_dS)N)r4r,ryrr)r-ryr+rrr#r, s zGtkDocTag.__init__cCsd|j|jfS)Nz)ryr5)r-rrr#r6szGtkDocTag.__repr__)N)r/r0r1r2r3rArzr{r~rƒr„r…r@r†r>r:r,r6rrrr#r‡s   r‡c@sŽeZdZdZdZeeeee e e e e eeeeefZddd„Zdd„Zdd „Zd d „Zd d „Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„ZdS)ÚGtkDocCommentBlockz- Represents a GTK-Doc comment block. )Ú code_beforeÚ code_afterÚ indentationryÚparamsrÚtagsNcCs>t ||¡d|_d|_g|_||_tƒ|_d|_tƒ|_ dS)N) r4r,r‰rŠr‹ryr rŒrr)r-ryr+rrr#r,'s zGtkDocCommentBlock.__init__cCs||j|jƒS)N)ry)r-ÚotherÚoprrr#Ú_compareBszGtkDocCommentBlock._comparecCs| |tj¡S)N)rrFr )r-rŽrrr#Ú__lt__HszGtkDocCommentBlock.__lt__cCs| |tj¡S)N)rrFr)r-rŽrrr#Ú__gt__KszGtkDocCommentBlock.__gt__cCs| |tj¡S)N)rrFÚge)r-rŽrrr#Ú__ge__NszGtkDocCommentBlock.__ge__cCs| |tj¡S)N)rrFÚle)r-rŽrrr#Ú__le__QszGtkDocCommentBlock.__le__cCs| |tj¡S)N)rrFÚeq)r-rŽrrr#Ú__eq__TszGtkDocCommentBlock.__eq__cCs| |tj¡S)N)rrFr)r-rŽrrr#Ú__ne__WszGtkDocCommentBlock.__ne__cCs t|jƒS)N)Úhashry)r-rrr#Ú__hash__ZszGtkDocCommentBlock.__hash__cCsd|j|jfS)Nz)ryr5)r-rrr#r6]szGtkDocCommentBlock.__repr__cCsFt |¡x|j ¡D] }| ¡qWx|j ¡D] }| ¡q2WdS)zz Validate annotations applied to the :class:`GtkDocCommentBlock` identifier, parameters and tags. N)r4rDrŒÚvaluesr)r-ÚparamÚtagrrr#rD`s   zGtkDocCommentBlock.validate)N)r/r0r1r2r3r{ÚANN_CONSTRUCTORÚ ANN_FOREIGNÚANN_GET_VALUE_FUNCÚ ANN_METHODÚ ANN_REF_FUNCÚ ANN_RENAME_TOÚANN_SET_VALUE_FUNCrƒr„r…ÚANN_UNREF_FUNCÚ ANN_VALUEÚ ANN_VFUNCr:r,rr‘r’r”r–r˜r™r›r6rDrrrr#rˆs  rˆZResultÚsuccessr5Úannotations_changedÚ start_posÚend_posc@s\eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z ddd„Z ddd„Z dS)ÚGtkDocCommentBlockParseraþ Parse GTK-Doc comment blocks into a parse tree built out of :class:`GtkDocCommentBlock`, :class:`GtkDocParameter`, :class:`GtkDocTag` and :class:`GtkDocAnnotations` objects. This parser tries to accept malformed input whenever possible and does not cause the process to exit on syntax errors. It does however emit: * warning messages at the slightest indication of recoverable malformed input and * error messages for unrecoverable malformed input whenever possible. Recoverable, in this context, means that we can serialize the :class:`GtkDocCommentBlock` instance using a :class:`GtkDocCommentBlockWriter` without information being lost. It is usually a good idea to heed these warning and error messages as malformed input can result in both: * invalid GTK-Doc output (HTML, pdf, ...) when the comment blocks are parsed with GTK-Doc's gtkdoc-mkdb * unexpected introspection behavior, for example missing parameters in the generated .gir and .typelib files .. NOTE:: :class:`GtkDocCommentBlockParser` functionality is based on gtkdoc-mkdb's `ScanSourceFile()`_ function. .. _ScanSourceFile(): http://git.gnome.org/browse/gtk-doc/tree/gtkdoc-mkdb.in#n3722 c CsÀi}x¶|D]®\}}}y| |||¡}Wn<tk rb}ztdt|ƒt||ƒƒw Wdd}~XYnX|dk r |j|kr®||j}tj |j j ¡} t d|j|j   | ¡f|j ƒ|||j<q W|S)zç Parse multiple GTK-Doc comment blocks. :param comments: an iterable of ``(comment, filename, lineno)`` tuples :returns: a dictionary mapping identifier names to :class:`GtkDocCommentBlock` objects z‹unrecoverable parse error, please file a GObject-Introspection bugreport including the complete comment block at the indicated location. %sNzJmultiple comment blocks documenting '%s:' identifier (already seen at %s).) Úparse_comment_blockÚ ExceptionrÚstrr ryÚosÚpathÚdirnamer+ÚfilenamerÚformat) r-ZcommentsZcomment_blocksÚcommentr´ÚlinenoÚ comment_blockÚeZ firstseenr²rrr#Úparse_comment_blocks’s$   z-GtkDocCommentBlockParser.parse_comment_blocksc0 CsN d}d}t||ƒ}t td|¡ d¡}t|ƒ}t |d¡} | ræ|dkrpt||ƒ} td| d|   d¡|dƒdS|   d¡}|   d¡}|r¬t||ƒ} t d | d|   d¡|dƒ|rÞt||ƒ} t d | d|   d¡|dƒ||d<qê|d=ndSt  |d ¡} | rˆ|   d¡}|   d¡}|rDt|||dƒ} t d | d|   d¡|d ƒ|r€t|||dƒ} t d | d|   d¡|d ƒ||d <n|d =ndSd} d} g} d}d}d}d}d} x*|D ] }|d7}t||ƒ} |}d}t |¡} |  |   d¡¡t |¡} | r@|   d¡}|r$td| d|   d¡|ƒ|   d¡}||   d¡d…}t |¡} t|   d¡ dd¡ƒ}| dkr4t |¡} | r˜d|   d¡f}d}d}d}nÎt |¡} | ràd|   d¡|   d¡f}|   d¡}|   d¡}|   d¡}n†t |¡} | r(d|   d¡|   d¡f}|   d¡}|   d¡}|   d¡}n>t |¡} | rfd|   d¡f}|   d¡}|   d¡}|   d¡}| rt}|}t||ƒ} || _|| _|r| | ||||¡}|jr||jd… ¡rÒd} d}d}d} n>|j| _|s|jr||   d¡}t d|df| d||ƒ| s´| s´d} td | d||ƒq´t |¡} | rÒ|}|   d!¡}|  ¡}|   d¡}|   d¡}|   d!¡|}|tt!gkr t d"|f| d||ƒt!}|t"kr t"}|s¾d}ntd#| j#f| ƒt$t"| ƒ} |r | %| ||||¡} | jr | j| _| j&| _&| | j't"<| }q´n:|d$ks@| (d%¡rZ|d%krZt d&|f| d||ƒd%}|| j) *¡kr„td'|| j#f| d||ƒt+|| ƒ}!|rÀ| %| ||||¡} | jrÀ| j|!_| j&|!_&|!| j)|<|!}q´t, |¡rø|tt!gkrøt-}|}q´t. |¡} | rÈ||k rÈ|}|   d(¡}"|"  ¡}#|   d¡}$|   d¡}%|   d(¡|}|#t/krºt d)|"f| d||ƒ|# d*d+¡}&|#t0krŠd}'| %| |   d(¡|||$ ¡ddd¡} | jr´xz| jD]p}(| 1| |||(¡})t|)ƒ}*|*dkrðd,|'|)df}'n6|*d-krd.|'|)d|)df}'ntd/| d||ƒd}'q¸W|'r´d,|&|' ¡f}'| 2| ||%||'¡\}&}+| j 3d0¡},|,r~td1| d||ƒn |+| j|&<n*| 2| ||%|d,|&|$f¡\}&}-|-| j|&<q´nJ|#t4krt d2| d||ƒt-}| j&dkrì|$| _&n| j&d3|$f7_&q´|t-ks:|t!kr | j&r:|tkr>| j)s>| j&s>t5}|t5krbt5}t d4|"f| d||ƒ|#t6t"t7t8gkrâ|s€d}ntd5| j#f| ƒt$t"| ƒ} |$rÎ| %| ||%||$¡} | jrÎ| j| _| j&| _&| | j't"<| }q´næ|#| j' *¡k r td6|"| j#f| d||ƒt$|#| ƒ} |$ r¶| %| ||%||$¡} | j r¶| j rPtd7|"f| ƒ|#t9t:gk r„t; | j&¡} |   d8¡| _<|   d9¡| _&n2|#t=k r¶t> | j&¡} |   d8¡ ?¡| _<|   d9¡| _&| | j'|#<| }q´t, |¡dk rà| @¡}|tt-gk r\| j& s0|tk r0| | |||| j¡}.|.j r0|.jA r0|.j| _q´| j&dk rD|| _&n| j&d|7_&q´nx|t!t5gkr´|j& sª| %| ||||j¡}.|.j rª|.jA rª|.j|_|.j&|_&q´|j&dk r¾||_&n|j&d|7_&q´q´W| rF| j& rô| j& ¡| _&x| j' B¡D]} | C| ¡ qWx| j) B¡D]}/| C|/¡ q W| | _D|  E¡| SdSdS):a¼ Parse a single GTK-Doc comment block. :param comment: string representing the GTK-Doc comment block including it's start ("``/**``") and end ("``*/``") tokens. :param filename: source file name where the comment block originated from :param lineno: line number in the source file where the comment block starts :returns: a :class:`GtkDocCommentBlock` object or ``None`` ÚÚ rr z'Skipping invalid GTK-Doc comment block:NÚcoder¶zGGTK-Doc comment block start token "/**" should not be preceded by code:zOGTK-Doc comment block start token "/**" should not be followed by comment text:éÿÿÿÿzDGTK-Doc comment block end token "*/" should not be followed by code:zLGTK-Doc comment block end token "*/" should not be preceded by comment text:Fr‹zinvalid comment text:ú z z SECTION:%sZ section_namez%s:%sÚ class_nameZ property_nameZ delimiterÚfieldsz%s::%sZ signal_namez%sZ symbol_namezmissing ":" at column %s:Tz'identifier not found on the first line:Zparameter_namez,"@%s" parameter unexpected at this location:z;encountered multiple "Returns" parameters or tags for "%s".ZVarargsz...z9"@%s" parameter is deprecated, please use "@..." instead:z.multiple "@%s" parameters for identifier "%s":Útag_namezvGObject-Introspection specific GTK-Doc tag "%s" has been deprecated, please use annotations on the identifier instead:r)r7z%s %srz%s %s=%sz,malformed "Attributes:" tag will be ignored:rz3Duplicate "Attributes:" annotation will be ignored:z/GTK-Doc tag "Description:" has been deprecated:z %sz&"%s:" tag unexpected at this location:z>encountered multiple return value parameters or tags for "%s".z(multiple "%s:" tags for identifier "%s":z(annotations not supported for tag "%s:".rr)Fr ÚreÚsubÚ LINE_BREAK_REÚsplitrKÚCOMMENT_BLOCK_START_REÚmatchrÚendÚgrouprÚstartÚCOMMENT_BLOCK_END_REÚINDENTATION_REÚappendÚCOMMENT_ASTERISK_REr<Ú SECTION_REÚ PROPERTY_REÚ SIGNAL_REÚ SYMBOL_REÚPART_IDENTIFIERrˆr‰rŠÚ_parse_annotationsr©r¬Ústripr5Ú PARAMETER_REÚlowerÚPART_PARAMETERSÚ TAG_RETURNSryr‡Ú _parse_fieldsrrÚendswithrŒÚkeysrxÚ EMPTY_LINE_REÚPART_DESCRIPTIONÚTAG_REÚDEPRECATED_GI_ANN_TAGSÚTAG_ATTRIBUTESÚ_parse_annotation_options_listÚ_parse_annotationÚgetÚTAG_DESCRIPTIONÚ PART_TAGSÚ TAG_RETURNÚTAG_RETURN_VALUEÚTAG_RETURNS_VALUEÚTAG_DEPRECATEDÚ TAG_SINCEÚTAG_VALUE_VERSION_RErÚ TAG_STABILITYÚTAG_VALUE_STABILITY_REÚ capitalizeÚrstriprªrœÚ_clean_description_fieldr‹rD)0r-r¶r´r·r‰rŠZcomment_block_posZ comment_linesZcomment_lines_lenÚresultr+r¸Zidentifier_warnedZ block_indentÚ line_indentZ part_indentZin_partZ current_partZ returns_seenÚlineZ original_lineZ column_offsetZidentifier_nameZidentifier_delimiterZidentifier_fieldsZidentifier_fields_startZresÚ marker_posZ param_nameZparam_name_lowerZ param_fieldsZparam_fields_startržÚ parameterrÂZtag_name_lowerZ tag_fieldsZtag_fields_startrBZ transformedÚ annotationÚ ann_optionsrEZ docannotationZstored_annotationrCÚrrrrr#r®·s”                                                                                                  z,GtkDocCommentBlockParser.parse_comment_blockcCsR|jrN|j ¡dkrd|_n2t |j dd¡d¡rB|j ¡|_n |j ¡|_dS)zª Remove extraneous leading and trailing whitespace from description fields. :param part: a GTK-Doc comment block part having a description field r»Nr¼r r)rrÖrÞrÈrÆrñ)r-Úpartrrr#rò˜s z1GtkDocCommentBlockParser._clean_description_fieldcCsNg}|rJ| d¡}|dkr@td|d|||ƒ| ||||¡}n | d¡}|S)u£ Parse annotation options into a list. For example:: ┌──────────────────────────────────────────────────────────────┠│ 'option1 option2 option3' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ ['option1', 'option2', 'option3'] │ â—─ parsed options └──────────────────────────────────────────────────────────────┘ :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of the `options` in the source file :param line: complete source line :param options: annotation options to parse :returns: a list of annotation options ú=rzMinvalid annotation options: expected a "list" but received "key=value pairs":Nr))ÚfindrÚ!_parse_annotation_options_unknownrÆ)r-r+ÚcolumnrõrCÚparsedrórrr#rã¨s  z7GtkDocCommentBlockParser._parse_annotation_options_listc CsVtƒ}|rRxF| d¡D]8}| dd¡}|d}t|ƒdkrB|dnd} | ||<qW|S)u² Parse annotation options into a dict. For example:: ┌──────────────────────────────────────────────────────────────┠│ 'option1=value1 option2 option3=value2' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ {'option1': 'value1', 'option2': None, 'option3': 'value2'} │ â—─ parsed options └──────────────────────────────────────────────────────────────┘ :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of the `options` in the source file :param line: complete source line :param options: annotation options to parse :returns: an ordered dictionary of annotation options r)rür rrN)r rÆrK) r-r+rÿrõrCrÚpÚpartsÚkeyrrrr#Ú_parse_annotation_options_dictÇs  z7GtkDocCommentBlockParser._parse_annotation_options_dictcCs|r| ¡gSdS)u Parse annotation options into a list holding a single item. This is used when the annotation options to parse in not known to be a list nor dict. For example:: ┌──────────────────────────────────────────────────────────────┠│ ' option1 option2 option3=value1 ' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ ['option1 option2 option3=value1'] │ â—─ parsed options └──────────────────────────────────────────────────────────────┘ :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of the `options` in the source file :param line: complete source line :param options: annotation options to parse :returns: a list of annotation options N)rÖ)r-r+rÿrõrCrrr#rþãsz:GtkDocCommentBlockParser._parse_annotation_options_unknownc CsJ| dt¡ dt¡}| dd¡}|d ¡}t|ƒdkr@|dnd}|tkrjtdttf|d||ƒt}n€|t krêtdt t f|d||ƒt }|  ||||¡}t|ƒ}|dkr¸|d}n2|dkrÖd |d|df}nt d |d||ƒd S|t|ƒd7}|t kr|  ||||¡}n,|tkr2| ||||¡}n| ||||¡}||fS) u} Parse an annotation into the annotation name and a list or dict (depending on the name of the annotation) holding the options. For example:: ┌──────────────────────────────────────────────────────────────┠│ 'name opt1=value1 opt2=value2 opt3' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ 'name', {'opt1': 'value1', 'opt2':'value2', 'opt3':None} │ â—─ parsed annotation └──────────────────────────────────────────────────────────────┘ ┌──────────────────────────────────────────────────────────────┠│ 'name opt1 opt2' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ 'name', ['opt1', 'opt2'] │ â—─ parsed annotation └──────────────────────────────────────────────────────────────┘ ┌──────────────────────────────────────────────────────────────┠│ 'unkownname unknown list of options' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ 'unkownname', ['unknown list of options'] │ â—─ parsed annotation └──────────────────────────────────────────────────────────────┘ :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of the `annotation` in the source file :param line: complete source line :param annotation: annotation to parse :returns: a tuple containing the annotation name and options ú<ú>r)r rrNz="%s" annotation has been deprecated, please use "%s" instead:z%s=%sz3malformed "(attribute)" annotation will be ignored:)NN)r<ÚANN_LPARÚANN_RPARrÆrØrKÚ ANN_INOUT_ALTrr€Ú ANN_ATTRIBUTEr{rãrÚLIST_ANNOTATIONSr rrþ) r-r+rÿrõrørrBrùrErrr#räøs>         z*GtkDocCommentBlockParser._parse_annotationNTc CsJ|r |dkrt|ƒ}q$| ¡}ng}d}d} d} d} g} d} d}xÄt|ƒD]¶\} }| ¡}|tkr¼| d7} | dkrz| } | tkr¦td|d|| |ƒtdddddƒS| dkr¸|  |¡nD|tkrÌ| d8} | tkrútd|d|| |ƒtdddddƒS| dkr(td|d|| |ƒtdddddƒS| dkrÀ| d}|dkr¢|  ||| |d  | ¡  ¡¡\}}|dk rº||kr”td |f|d|| |ƒ|||<d}n| d  | ¡  ¡¡d}g} n |  |¡n4|rè| dkr|  |¡n| dkröPn |  |¡|} qLW| dkr6td|d|| |ƒtdddddƒStd||| |ƒSdS) a  Parse annotations into a :class:`GtkDocAnnotations` object. :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of the `annotations` in the source file :param line: complete source line :param fields: string containing the fields to parse :param annotations: a :class:`GtkDocAnnotations` object :param parse_options: whether options will be parsed into a :class:`GtkDocAnnotations` object or into a :class:`list` :returns: if `parse_options` evaluates to True a :class:`GtkDocAnnotations` object, a :class:`list` otherwise. If `line` does not contain any annotations, :const:`None` NFrr»r z4unexpected parentheses, annotations will be ignored:z4unbalanced parentheses, annotations will be ignored:Tzmultiple "%s" annotations:) r*ÚcopyÚ enumerateÚisspacerrÚ_ParseAnnotationsResultrÎrräÚjoinrÖ)r-r+rÿrõrÁr5Ú parse_optionsZparsed_annotationsZparsed_annotations_changedÚiZ parens_levelZ prev_charZ char_bufferr«r¬Zcur_charZcur_char_is_spaceryrCrrr#rÕ@s€               z+GtkDocCommentBlockParser._parse_annotationsc Cs’d}| ||||||¡} | jr~|| jd… ¡}|r~|r~| d¡rP|dd…}n.| jdkr~|| j} td| df|d| |ƒt| j| j| j|ƒS)u‚ Parse annotations out of field data. For example:: ┌──────────────────────────────────────────────────────────────┠│ '(skip): description of some parameter' │ ─▷ source ├──────────────────────────────────────────────────────────────┤ │ ({'skip': []}, 'description of some parameter') │ â—─ annotations and └──────────────────────────────────────────────────────────────┘ remaining fields :param position: :class:`giscanner.message.Position` of `line` in the source file :param column: start column of `fields` in the source file :param line: complete source line :param fields: string containing the fields to parse :param parse_options: whether options will be parsed into a :class:`GtkDocAnnotations` object or into a :class:`list` :param validate_description_field: :const:`True` to validate the description field :returns: if `parse_options` evaluates to True a :class:`GtkDocAnnotations` object, a :class:`list` otherwise. If `line` does not contain any annotations, :const:`None` and a string holding the remaining fields r»Nú:r rzmissing ":" at column %s:) rÕr©r¬rÖÚ startswithrÚ_ParseFieldsResultr5rª) r-r+rÿrõrÁr5rZvalidate_description_fieldZdescription_fieldrórörrr#rÛ¤s     z&GtkDocCommentBlockParser._parse_fields)NT)NTT) r/r0r1r2rºr®ròrãrrþrärÕrÛrrrr#r­ws%dI cr­c@s:eZdZdZddd„Zdd„Zdd„Zd d „Zd d „Zd S)ÚGtkDocCommentBlockWriterzU Serialized :class:`GtkDocCommentBlock` objects into GTK-Doc comment blocks. TcCs ||_dS)N)Úindent)r-rrrr#r,Òsz!GtkDocCommentBlockWriter.__init__cCs¨g}x˜| ¡D]Œ\}}|rŠt|tƒr0d |¡}nFd}x8| ¡D],\}}|r\|d||f7}q>|d|f7}q>W| ¡}| d||f¡q| d|f¡qWd |¡S)uA Serialize an annotation field. For example:: ┌──────────────────────────────────────────────────────────────┠│ {'name': {'opt1': 'value1', 'opt2':'value2', 'opt3':None} │ â—─ GtkDocAnnotations ├──────────────────────────────────────────────────────────────┤ │ '(name opt1=value1 opt2=value2 opt3)' │ ─▷ serialized └──────────────────────────────────────────────────────────────┘ ┌──────────────────────────────────────────────────────────────┠│ {'name': ['opt1', 'opt2']} │ â—─ GtkDocAnnotations ├──────────────────────────────────────────────────────────────┤ │ '(name opt1 opt2)' │ ─▷ serialized └──────────────────────────────────────────────────────────────┘ ┌──────────────────────────────────────────────────────────────┠│ {'unkownname': ['unknown list of options']} │ â—─ GtkDocAnnotations ├──────────────────────────────────────────────────────────────┤ │ '(unkownname unknown list of options)' │ ─▷ serialized └──────────────────────────────────────────────────────────────┘ :param annotations: :class:`GtkDocAnnotations` to be serialized :returns: a string r)r»z%s=%s z%s z(%s %s)z(%s))r9Ú isinstanceÚlistrrÖrÎ)r-r5Ú serializedrBrCZserialize_optionsrrrrr#Ú_serialize_annotations×s  z/GtkDocCommentBlockWriter._serialize_annotationscCsjd|jf}|jr&|d| |j¡7}|jrX|j d¡rH|d|j7}q`|d|j7}n|d7}| d¡S)zˆ Serialize a parameter. :param parameter: :class:`GtkDocParameter` to be serialized :returns: a string z@%sz: r¼r)ryr5rrrrÆ)r-r÷rrrr#Ú_serialize_parameters  z-GtkDocCommentBlockWriter._serialize_parametercCs†|j ¡}|jr$|d| |j¡7}|jr8|d|j7}|jrh|j d¡rZ|d|j7}n|d|j7}|js||js||d7}| d¡S)zv Serialize a tag. :param tag: :class:`GtkDocTag` to be serialized :returns: a string z: r¼r)ryrðr5rrrrrÆ)r-ržrrrr#Ú_serialize_tag"s   z'GtkDocCommentBlockWriter._serialize_tagc Csü|dkr dSg}|j d¡r*| |j¡n:|jrR| |j¡}| d|j|f¡n| d|jf¡x"|j ¡D]}| | |¡¡qpW|j r¸| d¡x|j   d¡D]}| |¡q¦W|j rì| d¡x"|j  ¡D]}| |  |¡¡qÔW|j r>t|jƒ d¡ddpd }| d ¡r,|}|d } n|dd …}|} nd}d } d} xJ| t|ƒkr”|| } | rzd | | f|| <nd | f|| <| d7} qLW| dd|f¡| d| f¡|jrÔ| dd|jf¡|jrî| d|jf¡d |¡SdS)z  Serialize a :class:`GtkDocCommentBlock` object. :param block: :class:`GtkDocCommentBlock` to be serialized :returns: a string Nr»ZSECTIONz%s: %sz%s:r¼r rr)r¿r¾z%s* %s z%s* z%s/** z%s*/ z%s )ryrrÎr5rrŒrœÚextendrrrÆrrrr r‹Ú most_commonrÜrKÚinsertr‰rŠr) r-ÚblockÚlinesr5rÚlržrZ start_indentrôrrõrrr#ÚwriteAsT       zGtkDocCommentBlockWriter.writeN)T) r/r0r1r2r,rrrr$rrrr#rÍs  1r)ƒr2Z __future__rrrrr±rÃrFÚ collectionsrrrr r r rGr rrrÔrÙrßrçrërÚrìrîZ GTKDOC_TAGSræréZDEPRECATED_GTKDOC_TAGSrèrêZDEPRECATED_GI_TAGSrâZTAG_GET_VALUE_FUNCZ TAG_REF_FUNCZ TAG_RENAME_TOZTAG_SET_VALUE_FUNCZ TAG_TRANSFERZTAG_TYPEZTAG_UNREF_FUNCZ TAG_VALUEZ TAG_VFUNCráZALL_TAGSrrrArzr{r|rŸr}r~r r¡rr€r¢r@r†r>rr£r¤r‚r¥rƒr„r…r¦r¨r§ZGI_ANNSr r ZDEPRECATED_GI_ANNSr=r r rUrZrYZ ARRAY_OPTIONSZOPT_OUT_CALLEE_ALLOCATESZOPT_OUT_CALLER_ALLOCATESrjr?rhZOPT_SCOPE_ASYNCZOPT_SCOPE_CALLZOPT_SCOPE_NOTIFIEDrnZOPT_TRANSFER_CONTAINERZOPT_TRANSFER_FLOATINGZOPT_TRANSFER_FULLZOPT_TRANSFER_NONErrÚcompileÚUNICODErÅÚVERBOSErÇrÌrÏrÍrÞrÐrÓrÑrÒr×rr<Z _all_tagsÚ IGNORECASEràrírïr*Úobjectr4rxr‡rˆrrr­rrrrr#Úks’             VU   \