o $}@sVdZddlmZddlmZddlmZddlZddlZddlZddlm Z ddlm Z ddl m Z dd l m Z dd l mZdd l mZdd l mZdd l mZddl mZe je jejejejejdZddZddZddZGddde jZGdddeZ GdddeZ  d%ddZ!Gd d!d!eZ"d"d#Z#e$d$kre#e %dSdS)&aCloud SDK markdown document renderer. This module marshals markdown renderers to convert Cloud SDK markdown to text, HTML and manpage documents. The renderers are self-contained, allowing the Cloud SDK runtime to generate documents on the fly for all target architectures. The MarkdownRenderer class parses markdown from an input stream and renders it using the Renderer class. The Renderer member functions provide an abstract document model that matches markdown entities to the output document, e.g., font embellishment, section headings, lists, hanging indents, text margins, tables. There is a Renderer derived class for each output style that writes the result on an output stream returns Rendere.Finish(). )absolute_import)division)unicode_literalsN) argv_utils) exceptions)devsite_renderer) html_renderer)linter_renderer) man_renderer)markdown_renderer)renderer) text_renderer)devsitehtmlmanmarkdowntextlintercCsn|||krdSd}|t|kr5|||kr|d7}n|||kr+|d8}|dkr+|S|d7}|t|ksdS)aEReturns the index in buf of the end of the nested beg...end group. Args: buf: Input buffer. i: The buf[] index of the first beg character. beg: The group begin character. end: The group end character. Returns: The index in buf of the end of the nested beg...end group, 0 if there is no group. r)len)bufibegendnestingrS/tmp/google-cloud-sdk/lib/googlecloudsdk/core/document_renderers/render_document.py_GetNestedGroup;s      rcstfdddD S)z5Returns True if target is a valid anchor/link target.c3s|]}|vVqdSNr).0ctargetrr Xsz!_IsValidTarget..z ,()[])anyr!rr!r_IsValidTargetVsr%cCstd|d|S)z1Return True if the link is set as the flag value.z --.*=https?$N)research)rrrrr_IsFlagValueLink[sr(cs eZdZdZfddZZS)DocumentStyleErrorz)An exception for unknown document styles.cs0dj|dttd}tt||dS)NzFUnknown markdown document style [{style}] -- must be one of: {styles}.z, )stylestyles)formatjoinsortedSTYLESkeyssuperr)__init__)selfr*message __class__rrr2cs zDocumentStyleError.__init__)__name__ __module__ __qualname____doc__r2 __classcell__rrr5rr)`sr)c@seZdZdZddZdS)_ListElementStateaList element state. Attributes: bullet: True if the current element is a bullet. ignore_line: The number of blank line requests to ignore. level: List element nesting level counting from 0. line_break_seen: True if line break has been seen for bulleted lists. cCsd|_d|_d|_d|_dS)NFr)bullet ignore_linelevelline_break_seenr3rrrr2ts z_ListElementState.__init__Nr7r8r9r:r2rrrrr<js r<c@seZdZdZejejejdZe j dddfddZ ddZ dd Z d2d d Zd d ZddZddZddZddZddZddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Z d0d1Z!dS)3MarkdownRendereraReads markdown and renders to a document. Attributes: _EMPHASIS: The font emphasis attribute dict indexed by markdown character. _buf: The current output line. _code_block_indent: ```...``` code block indent if >= 0. _depth: List nesting depth counting from 0. _edit: True if NOTES edits are required. _example: The current example indentation space count. _fin: The markdown input stream. _line: The current input line. _lists: _ListElementState list element state stack indexed by _depth. _next_example: The next example indentation space count. _notes: Additional text for the NOTES section. _paragraph: True if the last line was ``+'' paragraph at current indent. _next_paragraph: The next line starts a new paragraph at same indentation. _renderer: The document_renderer.Renderer subclass. command_metadata: Optional metadata of command. command_node: The command object that the document is being rendered for. )*_`NcCs|||_d|_||_||_|j|_tg|_d|_d|_d|_ d|_ d|_ d|_ d|_ d|_||_d|_d|_d|_||_dS)aKInitializes the renderer. Args: style_renderer: The document_renderer.Renderer subclass. fin: The markdown input stream. notes: Optional sentences for the NOTES section. command_metadata: Optional metadata of command. command_node: The command object that the document is being rendered for. rFNz$ gcloud) _renderer_buf_fin_notes_editr<_lists_code_block_indent_depth_example _next_example _paragraph_peek_next_paragraph_linecommand_metadata_example_regex_last_list_level_in_example_section command_node)r3style_rendererfinnotesrWr[rrrr2s&   zMarkdownRenderer.__init__cCs|dkr||d|dkrd}|d}nV|dkr*||d|dkr*d}|d}nA|dkr?||d|dkr?d}|d}n,|dkrT||d|dkrTd}|d}n|d kri||d |d krid }|d }nd Sd }d } |t|ks|||r||ddkr|d8}|}|}|d}n ||dkr|}|d}t||dd}n ||dvrn|d7}qp|sd S|d|||||||fS)a=Checks for link:target[text] hyperlink anchor markdown. Hyperlink anchors are of the form: ':' [ '[' ']' ] For example: http://www.google.com[Google Search] The underlying renderer determines how the parts are displayed. Args: buf: Input buffer. i: The buf[] index of ':'. Returns: (i, back, target, text) i: The buf[] index just past the link, 0 if no link. back: The number of characters to retain before buf[i]. target: The link target. text: The link text. ftphttplinkrhttpsmailto)rrNNrT.[]z {}()<>'"`*)risspacer)r3rrback target_begtext_begtext_end target_endrrr _AnchorStyle1sP        zMarkdownRenderer._AnchorStyle1cCs|d}t||dd}|r|t|dks||ddkrdS|d}t||ddd}|r2||kr4dS|d||||||fS)aChecks for [text](target) hyperlink anchor markdown. Hyperlink anchors are of the form: '[' ']' '(' ')' For example: [Google Search](http://www.google.com) [](http://www.show.the.link) The underlying renderer determines how the parts are displayed. Args: buf: Input buffer. i: The buf[] index of ':'. Returns: (i, target, text) i: The buf[] index just past the link, 0 if no link. target: The link target. text: The link text. rrirj()rNN))rr)r3rrrnrormrprrr _AnchorStyle2s$ zMarkdownRenderer._AnchorStyle2cCs|jdks|jr dnd}d}|dur|j}d|_|rx|j|}d}d}|t|krx||}|dkr]|||\}}} } |r[t| r[t||s[|d| }|d}|j | | }n |dkr|| ||\}} } |r{t| r{|d}|j | | }n||vrj|r||dnd } |t|dkr||dnd } | d kr|d kr| d kr|t|d kr||d nd } | d kr| d |d }|dkr||j t j7}|||d |7}||j t j7}|d }q%n| d|}|dkr|d 7}||||7}|}q%|r|dkr| dkr|d7}nR| |kr&||7}|d7}nD|dkr5| dvr5| dvsD|d krE| dvrE| dvrEn%| rP| rPn|rY|dkrYn|d kra| }|j |j|}||7}|d7}|t|ks,|j|S)zConverts inline markdown attributes in self._buf. Args: buf: Convert markdown from this string instead of self._buf. Returns: A string with markdown attributes converted to render properly. rrGz*_`NF:rri rFrs```r_z''rErDz /z ./z .)rOrQrJrIEscaperrqr%r(LinkrufindFontr CODEisalnum _EMPHASISEntities)r3remphasisretr is_literalr index_after_anchorrlr"rlrxindex_at_code_block_quoteindex_at_air_quoterrr _Attributess              @zMarkdownRenderer._AttributescCs^|j|dr-||jr|j|kr||_|j|_|j|jd|_|j|dSdS)zRenders self._line[i:] as an example. This is a helper function for _ConvertCodeBlock() and _ConvertExample(). Args: i: The current character index in self._line. N)rV_FillrQrRrJrIExamplerr3rrrr_ExampledszMarkdownRenderer._ExamplecCs|jr |j|dSdS)z5Sends self._buf to the renderer and clears self._buf.N)rJrIFillrrArrrrtszMarkdownRenderer._FillcCs$|jdur |j}d|_|S|jS)z}Reads and possibly preprocesses the next markdown line from self._fin. Returns: The next markdown input line. N)rTrKreadliner3linerrr _ReadLineys  zMarkdownRenderer._ReadLinecCs ||_dS)zEPushes back one lookahead line. The next _ReadlLine will return line.N)rTrrrr _PushBackLines zMarkdownRenderer._PushBackLinecCs|js|j|jdS |}|sn|j||jr1|dkr1|jd|jdd|_q|jrB|jd|jddSdS)z5Generates markdown with additonal NOTES if requested.NTz ## NOTES  rGz ## NOTES )rMrIWriterKreadrrLrrrr_ConvertMarkdownToMarkdowns z+MarkdownRenderer._ConvertMarkdownToMarkdowncCs|jr|S||j|jjr-|jj|jddd|jr&|jd8_nd|j|j_|j|jjr?|j|jjd8_|j|jjsMd|j|j_|jr^|j|jjr^|j|jjrc|j dS)a?Detects and converts a blank markdown line (length 0). Resets the indentation to the default and emits a blank line. Multiple blank lines are suppressed in the output. Args: i: The current character index in self._line. Returns: -1 if the input line is a blank markdown, i otherwise. rTrFrH) rVrrNrPr=rIListr>r@Linerrrr_ConvertBlankLines*    z"MarkdownRenderer._ConvertBlankLinecCst|jdks|jddkr|S|d|j|j_|j|jjr?|jj|jddd|jr8|jd8_nd|j|j_|j d|_ dS)zDetects and converts + markdown line (length 1). Emits a blank line but retains the current indent. Args: i: The current character index in self._line. Returns: -1 if the input line is a '+' markdown, i otherwise. rr+TrFrH) rrVrrNrPr@r=rIrrrUrrrr_ConvertParagraphs  z"MarkdownRenderer._ConvertParagraphcCs|}|j|}|dvr |S|t|jkr-|j||kr-|d7}|t|jkr-|j||ks|t|jks;|j|dkr=|S|jd|kre|j|j||r[|j||d dkr]|S||d }nt|j}||j|d||_|}|dkr|dr|j|dd d|j ||d |_ |d vr|d krd }nd } | |_|jsn|j |_|jr|jj||dnqn|jr|dkr|j|_d|_|dk|_dS)a Detects and converts a markdown heading line. = level-1 [=] # level-1 [#] == level-2 [==] ## level-2 [##] Args: i: The current character index in self._line. Returns: -1 if the input line is a heading markdown, i otherwise. )=#rrwrHz(1)NrEr)NAMESYNOPSISrTF) is_synopsisNOTESEXAMPLES)rVrendswithrrJrrI SetCommandlowersplitHeadingrPrrstripSynopsisrLrZ)r3r start_indexmarker end_indexheadingis_synopsis_sectionrrr_ConvertHeadingsV       z MarkdownRenderer._ConvertHeadingcCs|jddks|jddksd|jvr|S|}|s|S|ds)|||Sg} ||_|js5n|j|_|jdrBn ||dq,d |_t }t |d krm|dD]}|j |d q^|d d }|j ry|ry|j||dS) aDetects and converts a sequence of markdown table lines. This method will consume multiple input lines if the current line is a table heading. The table markdown sequence is: [...format="csv"...] |====* col-1-data-item,col-2-data-item... ... Args: i: The current character index in self._line. Returns: -1 if the input lines are table markdown, i otherwise. rrirHrjz format="csv"z|====T,rGr)labelN)rVr startswithrrJrappendrrr TableAttributesr AddColumncolumnsrITable)r3rrrowstablerrrr_ConvertOldTables8          z!MarkdownRenderer._ConvertOldTablecCsd}d|jvr ||Sd|jvrd}|j}nd}|}|r#d|vr2||jur-||||Sd}|rPtd|j}|dsO|dsO|d d}d}ng}td|}|dsj|dsj|d d}d}|rt|t|kr||jur~||||Stj |d }t t|D]<} d } || } | d r| d rd } n| d rd} | t|kr|| nd} t| |krt| nd} |j | | | dqg} |}|dvr||ntd|}||q|r|j||d|_dS)aDetects and converts a sequence of markdown table lines. Markdown attributes are not supported in headings or column data. This method will consume multiple input lines if the current line is a table heading or separator line. The table markdown sequence is: heading line heading-1 | ... | heading-n OR for boxed table | heading-1 | ... | heading-n | separator line --- | ... | --- OR for boxed table | --- | ... | --- | WHERE :--- align left :---: align center ---: align right ----* length >= fixed_width_length sets column fixed width row data lines col-1-data-item | ... | col-n-data-item ... blank line ends table Args: i: The current character index in self._line. Returns: -1 if the input lines are table markdown, i otherwise. z | z---FTz *\| *rrHr)boxleftrvcenterrightN)alignrwidth)NrGrz+ rG)rVrrrr&rstriprr rrangerrrrrrIrrJ)r3rfixed_width_lengthheadrrrseprindexrsrrrrowrrr _ConvertTable8sl&                  zMarkdownRenderer._ConvertTablecCsD|t|jkr |j|dkr |d7}|t|jkr |j|dks|S)zAdvances i past any indentation spaces. Args: i: The current character index in self._line. Returns: i after indentation spaces skipped. rwr)rrVrrrr_ConvertIndentations z$MarkdownRenderer._ConvertIndentationcCs|j|ddrG|j|dd}|s3|jdkrd|_n||_|j|jdkr.ddSddS|jdkrG|rG|j|||_dS|jdkrN|S||jdS)zDetects and converts a ```...``` code block markdown. Args: i: The current character index in self._line. Returns: -1 if the input line is part of a code block markdown, i otherwise. Nrxr_rrHrG)rVrrOrISetLangr~r)r3rlangrrr_ConvertCodeBlocks$     z"MarkdownRenderer._ConvertCodeBlockcCsR|r|S|jd}|dkr|Sd}d}|}|d}|t|jkr>|j|dkr>|d7}|d7}|t|jkr>|j|dks(|t|jkrN|j|sN|S|t|jkrn|j|rn|d7}|t|jkrn|j|s\|t|jkow| }|r~|d8}|jdr||_n|jr|jds|jd}|j|jj s|j|jj |kr|jd7_|jt|jkr|j t n|j|jj |kr|jd8_|j|jj |ks| |rt|j}d}n!d|j|j_ d|j|j_||j|j_ |jd||_|}|r |}|jj|||d|t|jkr'|j|j|d7_d S) ajDetects and converts a definition list item markdown line. [item-level-1]:: [definition-line] [definition-lines] [item-level-2]::: [definition-line] [definition-lines] Args: i: The current character index in self._line. Returns: -1 if the input line is a definition list item markdown, i otherwise. z::rrNrsrvF) definitionrrH)rVr{rrkrrYrrNrPr=r?rr<rr>rJrrIr)r3rindex_at_definition_markdownr? list_level original_irrrrr_ConvertDefinitionListsb    z'MarkdownRenderer._ConvertDefinitionListcCs|js |j|dvr |S|j|}|d}|}|t|jkr;|j||kr;|d7}|d7}|t|jkr;|j||ks%|t|jksI|j|dkrK|S|j|jjru|j|jj|kru|j|jj|krt|jd8_|j|jj|ksdn|jd7_|jt|jkr|jtd|j|j_d|j|j_ d|j|j_ ||j|j_| |j |j|t|jkr|j|dkr|d7}|t|jkr|j|dks|j|j|d7_d S) aDetects and converts a bullet list item markdown line. The list item indicator may be '-' or '*'. nesting by multiple indicators: - level-1 -- level-2 - level-1 or nesting by indicator indentation: * level-1 * level-2 * level-1 Args: i: The current character index in self._line. Returns: -1 if the input line is a bullet list item markdown, i otherwise. z-*rsrrwTrFNrH)rQrVrrNrPr=r?rr<r>r@rrIrrJ)r3rr=r?rrrr_ConvertBulletList s> z#MarkdownRenderer._ConvertBulletListcCsR|j|jjr dnd}|js|o|j }|r |s"|js"|js"|S||dS)a Detects and converts an example markdown line. Example lines are indented by one or more space characters. Args: i: The current character index in self._line. Returns: -1 if the input line is is an example line markdown, i otherwise. FTrH) rNrPr=rZrJrrQrSr)r3rexample_allowedrrr_ConvertExample=s  z MarkdownRenderer._ConvertExamplecCsx|s|js|S|j|jjs|S|j|jjdkr$|j|jjd8_|j|jjs:||jj|jddd|S)zDetects and converts an end of list markdown line. Args: i: The current character index in self._line. Returns: -1 if the input line is an end of list markdown, i otherwise. rTr)rPrNr@r>rrIrrrrr_ConvertEndOfListPs z"MarkdownRenderer._ConvertEndOfListcCs.d|j|j_|jd|j|d7_dS)a Detects and converts any remaining markdown text. The input line is always consumed by this method. It should be the last _Convert*() method called for each input line. Args: i: The current character index in self._line. Returns: -1 FrwNrH)rNrPr@rJrVrrrr_ConvertRemainderds z"MarkdownRenderer._ConvertRemaindercCsH||jr|j|jdd|j|j7_||jS)zFlushes the fill buffer and checks for NOTES. A previous _ConvertHeading() will have cleared self._notes if a NOTES section has already been seen. Returns: The renderer Finish() value. rsr)rrLrIrrrJFinishrArrr_Finishts   zMarkdownRenderer._Finishc Cst|jtjr |dS |j|_d|_|j|_d|_| |_ |j s) |S|j |j r;d|jd|j |_ |j |_ d}|j|j|j|j|j|j|j|j|j|j|jf D] }||}|dkrgnq[q)zCRenders the markdown from fin to out and returns renderer.Finish().NTrFrwz ) isinstancerIr rCrrRrQrUrSrrVrrXrrrrrrrrrrrrr)r3rdetect_and_convertrrrRunsB   zMarkdownRenderer.Runr)"r7r8r9r:r BOLDITALICr}rsysstdinr2rqrurrrrrrrrrrrrrrrrrrrrrrrrrC{s8 @ U 80j A2 rCrPc CsJ|tvrt|t||ptj||||d}t||ptj||ddS)aURenders markdown to a selected document style. Args: style: The rendered document style name, must be one of the STYLES keys. fin: The input stream containing the markdown. out: The output stream for the rendered document. width: The page width in characters. notes: Optional sentences inserted in the NOTES section. title: The document title. command_metadata: Optional metadata of command, including available flags. command_node: The command object that the document is being rendered for. Raises: DocumentStyleError: The markdown style was unknown. )outtitlerrWr[)r]r^rWN)r/r)rstdoutrCrr) r*r]rrr^rrWr[r\rrrRenderDocuments rc@seZdZdZdddZdS)CommandMetaDatazHObject containing metadata of command to be passed into linter renderer.NTcCs&|r|ng|_|r |ng|_||_dSr)flags bool_flagsis_group)r3rrrrrrr2s zCommandMetaData.__init__)NNTrBrrrrrsrcCsttjdd}|jdddd|jddttd d d |jd d dd||dd}t|j|j |j dddS)z&Standalone markdown document renderer.zNRenders markdown on the standard input into a document on the standard output.) descriptionz--notes SENTENCESzDInserts SENTENCES into the NOTES section which is created if needed.)metavarhelpz--styleSTYLErzThe output style.)rchoicesdefaultrz--titleTITLEzThe document title.rN)r^rrW) argparseArgumentParser add_argumentr.r/r0 parse_argsrr*r^r)argvparserargsrrrmains0  r__main__)rNNrNNNN)&r: __future__rrrrr&rgooglecloudsdk.corerr&googlecloudsdk.core.document_renderersrrr r r r r DevSiteRenderer HTMLRenderer ManRendererrC TextRendererLinterRendererr/rr%r(Errorr)objectr<rrrr7GetDecodedArgvrrrrsV              8