a LgD\@sJdZddlZddlmZmZmZmZmZmZddl m Z ddl m Z ddl mZddlmZed ejZeeedd d d Zeeeed d dZeeedd ddZdBeeeeeddddZeeedd ddZeeeddddZeeefeeeeeeddddZeddddZeeefeedd d!d"Zedd#d$d%Z eeeedd&d'd(Z!eeeedd&d)d*Z"eeeeeedd+d,d-Z#eeeeeedd+d.d/Z$eeedd0d1d2Z%eddd3d4Z&eddd5d6Z'eddd7d8Z(eddd9d:Z)eddd;d<Z*eddd=d>Z+eeeed?d@dAZ,dS)Ca Normalize and validate (context-free) QAPI schema expression structures. `QAPISchemaParser` parses a QAPI schema into abstract syntax trees consisting of dict, list, str, bool, and int nodes. This module ensures that these nested structures have the correct type(s) and key(s) where appropriate for the QAPI context-free grammar. The QAPI schema expression language allows for certain syntactic sugar; this module also handles the normalization process of these nested structures. See `check_exprs` for the main entry point. See `schema.QAPISchema` for processing into native Python data structures and contextual semantic validation. N)DictIterableListOptionalUnioncast)c_name) QAPISemError)QAPIExpression)QAPISourceInfoz)(__[a-z0-9.-]+_)?(x-)?([a-z][a-z0-9_-]*)$)nameinfosourcereturncCst|tst|d|dS)zf Ensure that ``name`` is a ``str``. :raise QAPISemError: When ``name`` fails validation. z%s requires a string nameN isinstancestrr )r rrrz-check_keys..pprint..)joinsorted)r3rrrpprintszcheck_keys..pprintz%s misses key%s %srsz*%s has unknown key%s %s Valid keys are %s.N)rrsetr len) r0rrr1r2r;missingallowedunknownrrr check_keyss,  rC)exprrcCs|dD](}||vr||durt|jd|qdD](}||vr2||dur2t|jd|q2d|vrxd|vrxt|jd d S) z Ensure flag members (if present) have valid values. :param expr: The expression to validate. :raise QAPISemError: When certain flags have an invalid value, or when incompatible flags are present. )gensuccess-responseFz"flag '%s' may only use false value)boxed allow-ooballow-preconfig coroutineTz!flag '%s' may only use true valuerHrJz2flags 'allow-oob' and 'coroutine' are incompatibleN)r r)rDkeyrrr check_flagss   rL)rDrrrcs^tttfddfdd ttddfdd |d}|durRdS|dS) a Validate the ``if`` member of an object. The ``if`` member may be either a ``str`` or a dict. :param expr: The expression containing the ``if`` member to validate. :param info: QAPI schema source file information. :param source: Error string describing ``expr``. :raise QAPISemError: When the "if" member fails validation, or when there are no non-empty conditions. :return: None N)condrcst|tr,td|s(td|fdSt|tsDtdt|dggdt|dkrvtdd|vr|dn&d |vrd |d nd |d dS) Nz[A-Z][A-Z0-9_]*z3'if' condition '%s' of %s is not a valid identifierz2'if' condition of %s must be a string or an objectz'if' condition of %s)allanynotrz)'if' condition of %s has conflicting keysrPrNrO)rrr fullmatchr dictrCr?)rM _check_if _check_infixrrrrrT s6    zcheck_if.._check_if)operatoroperandsrcsDt|tstd|f|s.td|D] }|q2dS)Nz%'%s' condition of %s must be an arrayz"'if' condition [] of %s is useless)rlistr )rVrWoperand)rTrrrrrU&s zcheck_if.._check_infixif)rrobjectget)rDrrifcondrrSrcheck_ifs " r^)membersrcCs8t|tr4|D] \}}t|tr&qd|i||<qdS)a Normalize a "members" value. If ``members`` is a dict, for every value in that dict, if that value is not itself already a dict, normalize it to ``{'type': value}``. :forms: :sugared: ``Dict[str, Union[str, TypeRef]]`` :canonical: ``Dict[str, TypeRef]`` :param members: The members value to normalize. :return: None, ``members`` is normalized in-place as needed. typeN)rrRitems)r_rKargrrrnormalize_members9s   rc)r0rrrcCs$|dur t|ts t|d|dS)Nz%s should be a type namerr0rrrrrcheck_type_namePsrecCsZ|dust|trdSt|ts.t|d|t|dksHt|dtsVt|d|dS)Nz!%s should be a type name or arrayrrz,%s: array type must contain single type name)rrrXr r?rdrrrcheck_type_name_or_arrayVs rf)r0rr parent_namercCs|dur dSt|ts$t|d|||jjv}|D]\}}d||f}|drb|dd}t|||||dt|ddkst|dd rt|d |t |||d gd d gt |||t | d |t |d ||q8dS)aK Normalize and validate an optional implicit struct type. Accept ``None`` or a ``dict`` defining an implicit struct type. The latter is normalized in place. :param value: The value to check. :param info: QAPI schema source file information. :param source: Error string describing this ``value``. :param parent_name: When the value of ``parent_name`` is in pragma ``member-name-exceptions``, an implicit struct type may violate the member naming rules. :raise QAPISemError: When ``value`` fails validation. :return: None Nz#%s should be an object or type namez%s member '%s'*rr$r%FuZhas_z%s uses reserved namer`rZfeatures)rrRr r,member_name_exceptionsrarr'r rCr^check_featuresr\rf)r0rrrg permissiverKrbZ key_sourcerrrcheck_type_implicites*      rocCs(|dust|trdSt||||dS)N)rrro)r0rrrgrrrcheck_type_name_or_implicitsrp)rkrrcCs|dur dSt|ts t|ddd|D|dd<|D]f}d}t|tsPJt|||dgdgt|d||d||df}t|d||t|||q:dS) a Normalize and validate the ``features`` member. ``features`` may be a ``list`` of either ``str`` or ``dict``. Any ``str`` element will be normalized to ``{'name': element}``. :forms: :sugared: ``List[Union[str, Feature]]`` :canonical: ``List[Feature]`` :param features: The features member value to validate. :param info: QAPI schema source file information. :raise QAPISemError: When ``features`` fails validation. :return: None, ``features`` is normalized in-place as needed. Nz'features' must be an arraycSs"g|]}t|tr|nd|iqSr rrR)r5frrr sz"check_features..z'features' memberr rZ%s '%s')rrXr rRrCrr'r^)rkrfeatrrrrrms  rmc Cs|d}|d}|d}|j}t|ts4t|d|durPt|tsPt|d||jjv}dd|D|dd<|D]}d }t|||d gd d g|d }t |||d ||f}|d rd|}t |||||dt |||t |d |qvdS)z Normalize and validate this expression as an ``enum`` definition. :param expr: The expression to validate. :raise QAPISemError: When ``expr`` is not a valid ``enum``. :return: None, ``expr`` is normalized in-place as needed. enumdataprefixz'data' must be an arrayNz'prefix' must be a stringcSs"g|]}t|tr|nd|iqSrqrr)r5mrrrrtszcheck_enum..z 'data' memberr rZrkrurdri)r\rrrXr rr,rlrCrisdigitr'r^rm) rDr r_ryrrnmemberr member_namerrr check_enums4          rcCs>tt|d}|d}t||jd|t|d|jddS)z Normalize and validate this expression as a ``struct`` definition. :param expr: The expression to validate. :raise QAPISemError: When ``expr`` is not a valid ``struct``. :return: None, ``expr`` is normalized in-place as needed. structrx'data'base'base'N)rrrorrer\)rDr r_rrr check_structs rc Cstt|d}|d}|d}|d}|j}t||d|t||dt|tsZt|d|D]@\}}d|}t |||d gd gt |||t |d ||qbd S) z Normalize and validate this expression as a ``union`` definition. :param expr: The expression to validate. :raise QAPISemError: when ``expr`` is not a valid ``union``. :return: None, ``expr`` is normalized in-place as needed. unionr discriminatorrxrz'discriminator''data' must be an object'data' member '%s'r`rZN) rrrrprrrRr rarCr^re) rDr rrr_rrKr0rrrr check_unions     rcCs|d}|j}|st|dt|ts0t|d|D]L\}}d|}t|||t|||dgdgt|||t|d||q8dS)a Normalize and validate this expression as an ``alternate`` definition. :param expr: The expression to validate. :raise QAPISemError: When ``expr`` is not a valid ``alternate``. :return: None, ``expr`` is normalized in-place as needed. rxz'data' must not be emptyrrr`rZN) rr rrRrar'rCr^rf)rDr_rrKr0rrrrcheck_alternates      rcCsj|d}|d}|dd}|rH|dur8t|jdt||jdnt||jddt||jddS) z Normalize and validate this expression as a ``command`` definition. :param expr: The expression to validate. :raise QAPISemError: When ``expr`` is not a valid ``command``. :return: None, ``expr`` is normalized in-place as needed. rxreturnsrGFN'boxed': true requires 'data'rz 'returns')r\r rrerprf)rDargsretsrGrrr check_command)s    rcCsR|d}|dd}|r>|dur.t|jdt||jdnt||jdddS)z Normalize and validate this expression as an ``event`` definition. :param expr: The expression to validate. :raise QAPISemError: When ``expr`` is not a valid ``event``. :return: None, ``expr`` is normalized in-place as needed. rxrGFNrr)r\r rrerp)rDrrGrrr check_event?s   r)exprsrcCsN|D]B}|j}|j}d|vr q|hd@}t|dkrFt|d|}t|||d|tt||}| ||t ||||r|j |krt|d|j | |n|j jrt|d|dkrt|||dd ggd t|n4|d kr6t|||gd d dgt|dt|d t|n|dkrnt|||dd gd dgt|d t|n|dkrt|||dd ggdt|d t|n~|dkrt|||dggdt|d t|nF|dkrt|||dggdt|d t|nds$Jdt|||t|d|t|q|S)a Validate and normalize a list of parsed QAPI schema expressions. This function accepts a list of expressions and metadata as returned by the parser. It destructively normalizes the expressions in-place. :param exprs: The list of expressions to normalize and validate. :raise QAPISemError: When any expression fails validation. :return: The same list of expressions (now modified). include> alternaterr+rwr*rrz_expression must have exactly one key 'enum', 'struct', 'union', 'alternate', 'command', 'event'z'%s'z!documentation comment is for '%s'zdocumentation comment requiredrwrx)rZrkryr)rrrrxrZrkrrr)rrZrkr+) rxrrGrZrkrErFrHrIrJr*)rxrGrZrkFzunexpected meta type)rdockeysr?r poprrrset_defnr/ZsymbolZ check_exprr, doc_requiredrCrrcr\rrrrrr^rmrL)rrDrrZmetasr)r rrr check_exprsSs                           r)FF)-__doc__rtypingrrrrrrcommonr errorr parserr rr compile IGNORECASErr[rrrr#boolr'r(r/rCrLr^rcrerfrorprmrrrrrrrrrrrst        %  ?   ,  "'