0h v SrSSKrSSKrSSKrSSKJrJrJr SSKJrJ r J r SSK J r SSK JrJrJr SrSrSrS rS rS rS rS r\\\\/rSrSr\\/rSrSr\\/rSr Sr!Sr"Sr#Sr$Sr%Sr&Sr'Sr(Sr)\ \!\"\#\$\%\&\'\(\)/ r*\\-\-\*-r+Sr,Sr-Sr.Sr/S r0Sr1S!r2S"r3S#r4S$r5S%r6S&r7S'r8S(r9S)r:S*r;S+rS.r?S/r@S0rAS1rBS2rCS3rDS4rES5rFS6rGS7rHS8rIS9rJS:rKS;rLSP\?P\@P\AP\EP\FP\GP\HP\IP\JP\KP\LP\MP\NP\OP\PP\QP\RPrSS>rTS?rU\T\U/rV\S\V-rW\/\1/rX\WVs/sH o\X;dM UPM snrYS@rZSAr[SBr\\Z\[\\/r]SCr^SDr_\^\_/r`S1raS2rb\a\b/rcSErdSFreSGrfSHrg\d\e\f\g/rhSIriSJrjSKrkSLrl\i\j\k\l/rm\R"SM\R5rp\R"SN\R\R-5rr\R"SO\R\R-5rs\R"SP\R\R-5rt\R"SQ\R\R-5ru\R"SR\R\R-5rv\R"SS\R\R-5rw\R"ST\R\R-5rx\R"SU\R\R-5ry\R"SV\R\R-5rz\R"SW\R\R-5r{\R"SX\R\R-5r|\R"SY\R\R-5r}SZR\+5RS[S\5r\R"S]\-S^-\R\R-\GR-5r\R"S_\R\R-5r\R"S`\R\R-\GR-5r"SaSb\5r"ScSd\5r"SeSf\5r"SgSh\5r"SiSj\5r\"Sk/SlQ5r\"Sm/SnQ5r"SoSp\5r"SqSr\5rgs snf)suz 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. N) namedtupleCounter OrderedDict)negtlt)Tuple)Positionwarnerror deprecatedreturnssince stability descriptionz return valuereturnz returns value attributeszget value funczref funcz rename tozset value functransfertypez unref funcvaluevirtual()z allow-nonearrayz async-funcclosure constructorz copy-funcz default-valuedestroyz element-typeemitterz finish-funcforeignz free-funcz get-propertyzget-value-funcgetterininoutmethodnullableoptionalnotoutzref-funcz rename-toscopez set-propertyzset-value-funcsetterskipz sync-funcz unref-func attributezin-outz fixed-sizelengthzzero-terminatedzcallee-allocateszcaller-allocatesasynccallnotifiedforever containerfloatingfullnonez \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 (?P[\w]+) # class name \s* # 0 or more whitespace characters \|{1} # 1 required vertical bar \s* # 0 or more whitespace characters (?P[\w-]+\.[\w-]+) # action 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 dot \s* # 0 or more whitespace characters (?P[\w-]*\w) # field 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(\rSrSrSrSrSrSrSrg)GtkDocAnnotationsi7z 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`. positioncfURSS5Ul[R"U/UQ70UD6 g)Nr<)popr<r__init__)selfargskwargss 8/lib/gobject-introspection/giscanner/annotationparser.pyr?GtkDocAnnotations.__init__@s. :t4 T3D3F3c([XRS9$)Nr<)r;r<r@s rC__copy__GtkDocAnnotations.__copy__Gs  >>rErGN) __name__ __module__ __qualname____firstlineno____doc__ __slots__r?rI__static_attributes__rErCr;r;7s I4?rEr;c(\rSrSrSrSrSrS1SjrSrSr S r S2S jr S r S r S rSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSr S r!S!r"S"r#S#r$S$r%S%r&S&r'S'r(S(r)S)r*S*r+S+r,S,r-S-r.S.r/S/r0S0r1g)3GtkDocAnnotatableiKzC Base class for GTK-Doc comment block parts that can be annotated. )r< annotationsrRNc.Xl[5UlgN)r<r;rU)r@r<s rCr?GtkDocAnnotatable.__init__Ws! -.rEc$SUR<S3$)Nz)rUrHs rC__repr__GtkDocAnnotatable.__repr__`s-1-=-=@@rEc (UR(GaURRnURR5GHJup#X R;a)[ USUR SS5-5nU"XU5 O+U[ ;a[SU<3U5 O[SU<3U5 U[:Xa[U;av[UR;a'[S[S-[-<S[<S 3U5 [UR;a'[S[S-[-<S[<S 3U5 U[:XdM[U;dGM [UR;dGM#[S[S-[-<S[<S 3U5 GMM g g ) zQ Validate annotations stored by the :class:`GtkDocAnnotatable` instance, if any. _do_validate_-_zunexpected annotation: zunknown annotation: zcannot have both "r9z" and "z " presentN)rUr<itemsvalid_annotationsgetattrreplaceALL_ANNOTATIONSr ANN_NOTOPT_NOT_NULLABLE ANN_NULLABLEANN_ALLOW_NONEOPT_NOT_OPTIONAL ANN_OPTIONAL)r@r<ann_nameoptionsvalidates rCrmGtkDocAnnotatable.validatecsN    ''00H%)%5%5%;%;%=!555&t_x?O?OPSUX?Y-YZHX90CXNX@(Kw&+;w+F#t'7'77%m.>> N%'&)9)99%m.>>P%' w&+;w+F#t'7'77%m.>> N%'9&> rEc US:XaSnOSU4-nUS:XaSnOUS:XaSnOSU4-nU"X45(a[SU<S U<S U<S U<S 3 U5 g g )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. rr7z%dz no optionsr z one optionz %d options"z " annotation r9z, z givenN)r ) r@r<rk n_optionsexpected_n_optionsoperatormessagetss rC_validate_options#GtkDocAnnotatable._validate_optionssh" >A }$A  "A 1 $A 255A I 2 2 hANPX Y 3rEc[U5nUbURUX(U[S5 UbURUX(U[S5 UbURUX(U[S5 U(a%Ub!USn X;a[ SU<SU <S3U5 gggg) 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 Nneedsztakes at leastz takes at mostr invalid "" annotation option: "rp)lenrwrrrr ) r@r<rkrlchoicesexact_n_options min_n_options max_n_optionsrqoptions rC_validate_annotation&GtkDocAnnotatable._validate_annotationsL  &  " "8#+W V  $  " "8#+ rK[ ]  $  " "8#+ r? \ w*QZF$xPRZ[%+7rEc&URXUSS9 g)a= 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 rrNrr@r<rkrls rC_do_validate_allow_none)GtkDocAnnotatable._do_validate_allow_none !!(gq!QrEc [U5S:XagUR5HupEU[:Xa[U5 MU[:Xa(Ub#US ;a[ SU<SU<SU<S 3U5 MKMMMOU[:XaUc[ SU<S 3U5 MoMq[ SU<S U<S3U5 M g![[ 4a8 Uc[ SU<SU<S3U5 M[ SU<SU<SU<S3U5 Mf=f) a8 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 rNrpz" annotation option "z" needs a valuer{z " value "z", must be an integer)01z", must be 0 or 1z*" annotation option "length" needs a valuer|) r}r`OPT_ARRAY_FIXED_SIZEint TypeError ValueErrorr OPT_ARRAY_ZERO_TERMINATEDOPT_ARRAY_LENGTH)r@r<rkrlrrs rC_do_validate_array$GtkDocAnnotatable._do_validate_arrays w<1  $]]_MF-- 'J44$j)@"FE3!#*A$++=HW!#!xP--":.'}HV\]%'&7%' 's B,,(C4C43C4c&URXUSS9 g)a2 Validate the ``(async-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 rNrrs rC_do_validate_async_func)GtkDocAnnotatable._do_validate_async_funcrrEcg)a2 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 NrRrs rC_do_validate_attributes)GtkDocAnnotatable._do_validate_attributes  rEc&URXUSS9 g)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 )rNrrs rC_do_validate_closure&GtkDocAnnotatable._do_validate_closures !!(gQ!OrEc&URXUSS9 g)a3 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 rrNrrs rC_do_validate_constructor*GtkDocAnnotatable._do_validate_constructor$rrEc&URXUSS9 g)a1 Validate the ``(copy-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 rNrrs rC_do_validate_copy_func(GtkDocAnnotatable._do_validate_copy_func0rrEcg)a5 Validate the ``(default-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 NrRrs rC_do_validate_default_value,GtkDocAnnotatable._do_validate_default_value<rrEc&URXUSS9 g)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 rNrrs rC_do_validate_destroy&GtkDocAnnotatable._do_validate_destroyIrrEc(URXUSSS9 g)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)rrNrrs rC_do_validate_element_type+GtkDocAnnotatable._do_validate_element_typeUs !!(gQ^_!`rEc&URXUSS9 g)a/ Validate the ``(emitter)`` 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 rNrrs rC_do_validate_emitter&GtkDocAnnotatable._do_validate_emitterarrEc&URXUSS9 g)a3 Validate the ``(finish-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 rNrrs rC_do_validate_finish_func*GtkDocAnnotatable._do_validate_finish_funcmrrEc&URXUSS9 g)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 rrNrrs rC_do_validate_foreign&GtkDocAnnotatable._do_validate_foreignyrrEc&URXUSS9 g)a1 Validate the ``(free-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 rNrrs rC_do_validate_free_func(GtkDocAnnotatable._do_validate_free_funcrrEc&URXUSS9 g)a4 Validate the ``(get-property)`` 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 rNrrs rC_do_validate_get_property+GtkDocAnnotatable._do_validate_get_propertyrrEc&URXUSS9 ga2 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 rNrrs rC_do_validate_get_value_func-GtkDocAnnotatable._do_validate_get_value_funcrrEc&URXUSS9 g)a. Validate the ``(getter)`` 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 rNrrs rC_do_validate_getter%GtkDocAnnotatable._do_validate_getterrrEc&URXUSS9 g)a* 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 rrNrrs rC_do_validate_in!GtkDocAnnotatable._do_validate_inrrEc&URXUSS9 g)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 rrNrrs rC_do_validate_inout$GtkDocAnnotatable._do_validate_inoutrrEc&URXUSS9 g)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 rrNrrs rC_do_validate_method%GtkDocAnnotatable._do_validate_methodrrEc&URXUSS9 g)a; 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 rrNrrs rC_do_validate_nullable'GtkDocAnnotatable._do_validate_nullablerrEc&URXUSS9 g)a; 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 rrNrrs rC_do_validate_optional'GtkDocAnnotatable._do_validate_optionalrrEc0URXUS[S9 g)a6 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 rr~N)r NOT_OPTIONSrs rC_do_validate_not"GtkDocAnnotatable._do_validate_nots  !!(gq*5 " 7rEc0URXUS[S9 g)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 )rr~N)r OUT_OPTIONSrs rC_do_validate_out"GtkDocAnnotatable._do_validate_outs  !!(gQ*5 " 7rEc&URXUSS9 g)a0 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 rNrrs rC_do_validate_ref_func'GtkDocAnnotatable._do_validate_ref_func rrEc&URXUSS9 g)a1 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 rNrrs rC_do_validate_rename_to(GtkDocAnnotatable._do_validate_rename_torrEc0URXUS[S9 g)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 rN)r SCOPE_OPTIONSrs rC_do_validate_scope$GtkDocAnnotatable._do_validate_scope#s  !!(gq*7 " 9rEc&URXUSS9 g)a4 Validate the ``(set-property)`` 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 rNrrs rC_do_validate_set_property+GtkDocAnnotatable._do_validate_set_property0rrEc&URXUSS9 grrrs rC_do_validate_set_value_func-GtkDocAnnotatable._do_validate_set_value_func<rrEc&URXUSS9 g)a. Validate the ``(setter)`` 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 rNrrs rC_do_validate_setter%GtkDocAnnotatable._do_validate_setterHrrEc&URXUSS9 g)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 rrNrrs rC_do_validate_skip#GtkDocAnnotatable._do_validate_skipTrrEc&URXUSS9 g)a1 Validate the ``(sync-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 rNrrs rC_do_validate_sync_func(GtkDocAnnotatable._do_validate_sync_func`rrEc0URXUS[S9 g)a0 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 rN)rTRANSFER_OPTIONSrs rC_do_validate_transfer'GtkDocAnnotatable._do_validate_transferls  !!(gq*: " r rUrHs rCrZGtkDocParameter.__repr__s.2ii9I9IJJrE)rr rW)rKrLrMrNrOrPrh ANN_ARRAYANN_ATTRIBUTES ANN_CLOSURE ANN_DESTROYANN_ELEMENT_TYPEANN_IN ANN_INOUTANN_OUT ANN_SCOPEANN_SKIP ANN_TRANSFERANN_TYPErjrgrerar?rZrQrRrErCrrsS(I !& KrErc D\rSrSrSrSr\\\\ \ \ \ \ \\4 rSSjrSrSrg) GtkDocTagiz Represents a GTK-Doc tag part. )r rrNcV[RX5 XlSUlSUlgrW)rTr?r rrr s rCr?GtkDocTag.__init__s*""42   rEc@SUR<SUR<S3$)Nz r6rEcBURU[R5$rW)r0rsger3s rC__ge__GtkDocCommentBlock.__ge__Ar6rEcBURU[R5$rW)r0rsler3s rC__le__GtkDocCommentBlock.__le__Dr6rEcBURU[R5$rW)r0rseqr3s rC__eq__GtkDocCommentBlock.__eq__Gr6rEcBURU[R5$rW)r0rsrr3s rC__ne__GtkDocCommentBlock.__ne__Jr6rEc,[UR5$rW)hashr rHs rC__hash__GtkDocCommentBlock.__hash__MsDIIrEc@SUR<SUR<S3$)NzU RJ<S.3U SUU5 [MU#U 5n U$(Ga UROU UU%-UU$5n U R:(aU R@(a[S?U"<S@3U 5 U#[v[x4;aL[zRU RP5n U RSA5U l>U RSB5U l(OcU#[~:XaY[RU RP5n U RSA5R5U l>U RSB5U l(U U RRU#'U nG M[\RU5cUR5nU[0[^4;aU RP(d_U[0:XaUUR9U UUUU R@5n.U.R:(a%U.R(aU.R@U l G MrU RPcUU l(OU =RPSU-- sl(G MU[F[n4;dG MURP(dfUROU UUUUR@5n.U.R:(a6U.R(a%U.R@Ul U.RPUl(G M,URPcUUl(OU=RPSU-- sl(G M\ U (aU RP(aU RPR?5U l(U RRR5Hn URU 5 M U RVR5Hn/URU/5 M XlFU R5 U $g)Ca 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:Ncoder|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 zSECTION: section_name class_name: property_name delimiterfieldsz:: signal_namezACTION: action_name. field_name symbol_namemissing ":" at column Tz'identifier not found on the first line:parameter_namez"@z(" parameter unexpected at this location:z7encountered multiple "Returns" parameters or tags for "z".Varargsz...z5" parameter is deprecated, please use "@..." instead:z multiple "@z" parameters for identifier "z":tag_namez,GObject-Introspection specific GTK-Doc tag "zH" has been deprecated, please use annotations on the identifier instead:r9r^r=z,malformed "Attributes:" tag will be ignored:rz3Duplicate "Attributes:" annotation will be ignored:z/GTK-Doc tag "Description:" has been deprecated:rpz#:" tag unexpected at this location:z:encountered multiple return value parameters or tags for " multiple "z:" tags for identifier "z#annotations not supported for tag "z:".rr)Hr resub LINE_BREAK_REsplitr}COMMENT_BLOCK_START_REmatchr endgroupr startCOMMENT_BLOCK_END_REINDENTATION_REappendCOMMENT_ASTERISK_RErc SECTION_RE PROPERTY_RE SIGNAL_RE ACTION_REFIELD_RE SYMBOL_REPART_IDENTIFIERr%r&r'_parse_annotationsrjrmstriprU PARAMETER_RElowerPART_PARAMETERS TAG_RETURNSr r _parse_fieldsrr*endswithr)keysr EMPTY_LINE_REPART_DESCRIPTIONTAG_REDEPRECATED_GI_ANN_TAGSTAG_ATTRIBUTES_parse_annotation_options_list_parse_annotationgetTAG_DESCRIPTION PART_TAGS TAG_RETURNTAG_RETURN_VALUETAG_RETURNS_VALUETAG_DEPRECATED TAG_SINCETAG_VALUE_VERSION_REr TAG_STABILITYTAG_VALUE_STABILITY_RE capitalizerstriprkrP_clean_description_fieldr(rm)0r@r|rxr}r&r'comment_block_pos comment_linescomment_lines_lenresultr<r~identifier_warned block_indent line_indent part_indentin_part current_part returns_seenline original_line column_offsetidentifier_nameidentifier_delimiteridentifier_fieldsidentifier_fields_startres marker_pos param_nameparam_name_lower param_fieldsparam_fields_startrR parameterrtag_name_lower tag_fieldstag_fields_startrk transformed annotation ann_optionsrq docannotationstored_annotationrlrrQs0 rCrr,GtkDocCommentBlockParser.parse_comment_blocks  $X6}dG<BB4H  .(--mA.>?  A%#H5?tVZZ%7q9IK ,,v.Kll9-G#H5^tVZZ%7q9IK#H58tV\\)%NP$+a !!$&++M",=> f-Jll9-G#H7H.H1.LM0tVZZ%7r9JL#H7H.H1.LM8tVZZ %:M"6R&UO+/((,%.2+(..t4F5;\\,5O5;\\/5R+T/5||K/H,,2LL,B)28,,x2H/!*!6!:@,,|:T:@,,}:U/WO39<< 3L006 X0F-6 7)1)=#)AGlA[BH,,|B\7^O;A<< ;T$88> X8N$5>Dll8>T$;-6__T-BF'-BH,,}B]?E||K?X(<DDFF)-*..2 04 kAZ1ZJ$( UV)Y)14]%T,,0)G&m]L "''-F) #\\*:; #-#3#3#5 %||H5 %+\\(%;"#\\*:;mK ?O"DD:X!4]D*#{2!,J''+ ,115&($K:C#!%!3!3H4ADV4V4A4@"B">>.4.@.@CO.4.@.@CO69M&&{3#&L I-''..:3F$(!4]D"'J!5!5!:!:!<<%}'9'9;"D*mE,JA !//0=@R0R0=0<>F~~060B0B -060B0B -3< $$Z0( ##D))g/?9[.[*)  \\$'F+4) !<< 3!)!1#\\(3 #)<<#9 #\\*5 E !%;;'/3"4]D .55c3?H%7&( !%!3!3H4:LL4L}4\484>4D4D4F484949 ";">>.4.@.@ .2.Q.QRZR\RVR\/^ -0 ,< #,>=H+VW.2[K%.!^@K[YZ^@KA3PK%**X*2D*m%U26K/A" +9A;CTCTCV.W :>:P:P$,$14D$D$1$/ ;1 7- 5B4M4M4Q4QR^4_ 1#4$)+8*2D*m%UKXM$=$=h$G,0,B,B8?LO_?_?CJRT^?_-a)'?F 11(;#6J!4]D/G$0084> 1%11z5LL1//.}7P7P.}7K7K))'Gi''GXP!4]D"j+&68I&KK''+ ,115&($K:C!!%!3!3H4ADT4T4A4>"@">>.4.@.@CO.4.@.@CO69M&&{3#&L%););)@)@)BB'););=&j-I$NH=C!!%!3!3H4ADT4T4A4>"@">>%11 %T\&_&.!0 ..)1LL)=)C)CFDVDV)W,2LL,A 28,,}2M!/=!@)?)E)EfFXFX)Y,2LL,A,L,L,N 28,,}2M9)>89 M5$ ,,404M-!--<-_i88#//**8]MSW+7+C+CEAyyQ%:%:34== 034== 0 ++3/3L, ,,t ;,S "\ ((,9,E,E,K,K,M )$))002--c23'--446--e47)5 %  " " $ rEc`UR(aURR5S:XaSUlg[RURR SS5S5(a URR 5UlgURR5Ulgg)z Remove extraneous leading and trailing whitespace from description fields. :param part: a GTK-Doc comment block part having a description field rNrr r)rrrrrr)r@parts rCr1GtkDocCommentBlockParser._clean_description_fields   %%'2-#'  &&t'7'7'='=dA'Fq'IJJ'+'7'7'>'>'@D$'+'7'7'='='?D$ rEc/nU(aMURS5nUS:a%[SUSX&-U5 URXX45nU$URS5nU$)uC 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 rrzMinvalid annotation options: expected a "list" but received "key=value pairs":Nr9)findr !_parse_annotation_options_unknownr)r@r<columnrrlparsedrs rCr7GtkDocCommentBlockParser._parse_annotation_options_listsj" \\#&F{3tV_d<??RV` !s+ rEc[5nU(aIURS5H4nURSS5nUSn[U5S:XaUSOSn XU'M6 U$)uR 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 r9rr rrN)rrr}) r@r<rrrlrppartskeyrs rC_parse_annotation_options_dict7GtkDocCommentBlockParser._parse_annotation_options_dicts\" ]]3'QAh$'J!Oa#s (  rEc4U(aUR5/$g)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<rrrls rCr:GtkDocCommentBlockParser._parse_annotation_options_unknowns$ MMO$ $ rEcURS[5RS[5nURSS5nUSR 5n[ U5S:XaUSOSnU[ :Xa&[S[ <S [<S 3USX#5 [nO}U[:Xas[S[<S [<S 3USX#5 [nURXX75n[ U5nUS:XaUSnO%US:XaUS<S US<3nO[S USX#5 g U[ U5S-- nU[;aURXX75nXg4$U[;aURXX75nXg4$UR!XUU5nXg4$)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  ''X6>>sHM   a(8>>#"%e*/eAht } $ ,4 /!H  & 14 /&H==hPTbKK(IA~)!n a)4QQH Kf4!#h-!## ' '==hPTbK$$ ) )==hPTbK $$@@SWALNK$$rENc vU(aUc [US9nOUR5nO/nSnSn Sn Sn /n Sn Sn[U5GHupUR5nU[:XaRU S- n U S:XaU n U [:Xa"[ SUSX)-U5 [ SSSSS5s $U S:aU RU5 GONU[:XGa U S-n U [:Xa"[ SUSX)-U5 [ SSSSS5s $U S:a"[ SUSX)-U5 [ SSSSS5s $U S:XaU S-nUS La]URUX--USRU 5R55unnUb#UU;a[ S U<S 3USX)-U5 UUU'S nO0URSRU 5R55 S n/n OJU RU5 O8U(aU S:aU RU5 OU S:Xa OU RU5 Un GM U S:a [ SUSX)-U5 [ SSSSS5$[ S XxX5$) 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` NrGFrrr z4unexpected parentheses, annotations will be ignored:z4unbalanced parentheses, annotations will be ignored:Trz" annotations:) r;copy enumerateisspacerr rirrrjoinr)r@r<rrrrU parse_optionsparsed_annotationsparsed_annotations_changedi parens_level prev_char char_bufferrlrmcur_charcur_char_is_spacer rls rCr+GtkDocCommentBlockParser._parse_annotationsIs" "%6%I"%0%5%5%7"!# %*"     $V,KA ( 0 0 2 8#! 1$ !I(P"D&*d<25$dDQQ!A%&&x0X%! (P"D&*d<25$dDQQ!A%P"D&*d<25$dDQQ!Q&!eG$,(,(>(>x?E?Q?C?Aww{?S?Y?Y?[)] g +#'99 %d&M&.fj$!H7>.t49=6*11"''+2F2L2L2NO592"$K&&x0"!#&&x01$&&x0 Iq-t !  HD&*d 4*5$dDI I*41C+4? ?rEcSnURXX4XV5n U R(azXIRSR5nU(aWU(aPUR S5(aUSSnO4U RS:a$X)R-n [ SU S-<S3USX5 [ U RU RU RU5$)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 rNrr rr) rrjrmr startswithr rnrUrk) r@r<rrrrUrvalidate_description_fielddescription_fieldrrs rCr&GtkDocCommentBlockParser._parse_fieldss,((4)4E >> &~~ 7 = = ?  %?$//44(9!"(=%~~)%+nn%< JNM%tZ?"&..&2D2DfF`F`"35 5rErR)NT)NTT)rKrLrMrNrOrrrrrrrrrrrQrRrErCrprpnsL4#Jqf@ >8%*F%R<@b?HIMEI&5rErpc:\rSrSrSrS SjrSrSrSrSr Sr g ) GtkDocCommentBlockWriterizM Serialized :class:`GtkDocCommentBlock` objects into GTK-Doc comment blocks. cXlgrWindent)r@r!s rCr?!GtkDocCommentBlockWriter.__init__s  rEc/nUR5Hup4U(a[U[5(aSRU5nOHSnUR5H"upgU(aXV<SU<S3- nMXV<S3- nM$ UR 5nUR SU<SU<S35 MUR SU<S35 M SRU5$)u 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 r9rrrr)r` isinstancelistr rr)r@rU serializedrkrlserialize_optionsrrs rC_serialize_annotations/GtkDocCommentBlockWriter._serialize_annotationss4 !,!2!2!4 Hgt,,(+(9%(*%&-mmo  -S%1HH--#@- '6 ):(?(?(A%!!x9J"KL!!H"78#"5&xx ##rEc`SUR<3nUR(a!USURUR5-- nUR(aFURR S5(aUSUR-- nOUSUR-- nOUS- nUR S5$)zh Serialize a parameter. :param parameter: :class:`GtkDocParameter` to be serialized :returns: a string @: rr)r rUr(rrr)r@rr&s rC_serialize_parameter-GtkDocCommentBlockWriter._serialize_parameter s(nn/   $!UR UR5nURUR<SU<35 OURUR<S35 UR R 5H#nURURU55 M% UR(aDURS5 URRS5HnURU5 M UR(aRURS5 URR 5H#nURURU55 M% UR(aY[UR5R!S5S S =(d S nUR#S 5(aUnUS -n O USS nUn OSnS n S n U [%U5:a6X*n U (a U <S U <S3X*'OU <S3X*'U S- n U [%U5:aM6UR'S U<S35 URU <S35 UR((a UR'S UR(<S35 UR*(aURUR*<S35 SR-U5$)z Serialize a :class:`GtkDocCommentBlock` object. :param block: :class:`GtkDocCommentBlock` to be serialized :returns: a string NrSECTIONACTIONr,rrr rr9rrz* z* z/** z*/ )r rrrUr(r)rPextendr-rrr*r0r!rr( most_commonrr}insertr&r'r ) r@blocklinesrUrQlrRr! start_indentrrrs rCwriteGtkDocCommentBlockWriter.writeJ sg =Ezz$$Y//5::3H3H3R3R UZZ($$"&"="=e>O>O"PKLLUZZ!EFLL%**!78,,. T66u=>/   R **006ALLO7zz R  ::,,.CLL!4!4S!9:/{{ !2!23??B1EaHOC??4((#)L"(3,K#)#2;L"(K! ! Ac%j.x-8$?EH*58EHQ c%j. LL8 9 LL[3 4   Q%*;*; >? u'7'7:;775> !rEr N)T) rKrLrMrNrOr?r(r-r0r<rQrRrErCrrs" /$b&4&>L"rEr)rOrurrs collectionsrrrrrrtypingr rtr r r rrrrrrrr GTKDOC_TAGSrrDEPRECATED_GTKDOC_TAGSrrDEPRECATED_GI_TAGSrTAG_GET_VALUE_FUNC TAG_REF_FUNC TAG_RENAME_TOTAG_SET_VALUE_FUNC TAG_TRANSFERTAG_TYPETAG_UNREF_FUNC TAG_VALUE TAG_VFUNCrALL_TAGSrrrhrrTrrrUrVrWrrrXrYrZr[r\r]r^rrr_rgrjrerr`rarrbrcrdrrerrrfrhrgGI_ANNSrrDEPRECATED_GI_ANNSrdrrrrr ARRAY_OPTIONSOPT_OUT_CALLEE_ALLOCATESOPT_OUT_CALLER_ALLOCATESrrfrirOPT_SCOPE_ASYNCOPT_SCOPE_CALLOPT_SCOPE_NOTIFIEDOPT_SCOPE_FOREVERrOPT_TRANSFER_CONTAINEROPT_TRANSFER_FLOATINGOPT_TRANSFER_FULLOPT_TRANSFER_NONErcompileUNICODErVERBOSErrrrrrrrrrrrr rc _all_tags IGNORECASErrrr;objectrTrrr%rirnrpr)anns0rCras2M^ 88**      !)*,  # ')%  %    (,&',&"(## % / /2D DG] ]       # !   !%           !%       " >"  "  "  "   "   "   "  "  "  "  "  "  "  "  "  "  !" " #" $ %" & '" ( )" * +" , -" . /" 0 1" 2 3" 4 5" 6 7" 8 9" : ;" < =" > ?" @ A" B C" D E" J  ##%..~.#2R?CAQ6QC?R$-%!*, .-'') !12  #"$ %"*)%%' ="**5  JJ  zz JJ  jj JJ   JJ  JJ  ZZ JJ " JJ JJ  "jj"JJ% * JJ"JJ%  * JJ"JJ%  * ::"JJ% *zz JJ  HHX  & &sE 2 !!$ JJbmm+ -zz JJ  JJbmm+ -? ?(\ R\ R~$K'$KN!E!!EHi*iZ%   e 5ve 5P@"v@"S>Ss / R6<R6