=rdZddlmZddlmZddlmZddlZddlZddlmZGddejZ y) z*Cloud SDK markdown document HTML renderer.)absolute_import)division)unicode_literalsN)rendererceZdZdZdZddddZdZfdZd Zd Z d Z d Z d Z dZ dZdZddZdZdZdZdZdZddZddZdZxZS) HTMLRenderera\Renders markdown to HTML. Attributes: _BULLET: A list of bullet type names indexed by list level modulo #bullets. _ESCAPE: Character element code name dict indexed by input character. _FONT_TAG: A list of font embellishment tag names indexed by font attribute. _document_ids: The set of html ids unique in the current document. _example: True if currently rendering an example. _fill: The number of characters in the current output line. _heading: A string of HTML tags that closes out a heading section. _level: The section or list level counting from 0. _paragraph: True if the output already contains a paragraph tag. Used to avoid sequences of 2 or more paragraph tags in the output. _pop: A list of list element closing tag names indexed by _level. _section: Section heading but no section body yet. )disccirclesquarez&z<z>)&<>)code)rvarrctt| |i|t|_d|_d|_d|_d|_d|_ d|_ dg|_ d|_ |j|jjdy)NFra
)superr__init__set _document_ids_example_fill _global_flags_heading_level _paragraph_pop_section_Title_outwrite)selfargskwargs __class__s ;lib/googlecloudsdk/core/document_renderers/html_renderer.pyrzHTMLRenderer.__init__2sz ,&77DDMDJDDMDKDODIDMKKMIIOOc|jjd|jr(|jjd|jz|jjdy)zRenders an HTML document title.z z%s z N)r!r"_titler#s r'r zHTMLRenderer._Title_sOIIOO {{ iioo+dkk9:IIOO  r(cd|_|jrhd|_|jr"d|_|jj dd|_|jj d|j yy)z/Flushes the current collection of Fill() lines.Fz r N)rrrrr!r"Contentr+s r'_FlushzHTMLRenderer._FlushtsZDO zzdm    $dj iiood llnr(c>d}tjd|}|r|jd}|jdj dd}||}|}d} ||j vr|j j ||S|dz }dj|| }D) z&Returns a unique document id for name.c0tjdd|S)z=Returns singlularized name if name is 'COMMANDS' or 'GROUPS'.z(COMMAND|GROUP)S$z\1resub)names r'$SingularizeCommandAndGroupDocumentIDzHHTMLRenderer.GetDocumentID..SingularizeCommandAndGroupDocumentIDsVV(% 66r(zY(-- |\[)*(<[^>]*>)*(?P-[-_a-z0-9\[\]]+|[_A-Za-z.0-9 ][-_A-Za-z.0-9 ]*|[-.0-9]+).*anchor -rz{name}-{number})r5number)r3matchgroupstripreplaceraddformat)r#r5r6mattemptr;s r' GetDocumentIDzHTMLRenderer.GetDocumentIDs 7   A WWX d ::c? " "3 ,D / 5DG F  ** * w' kf!((d6(Bg r(cTtjdd|}|jddS)zEscapes special characters to their entity tags. This is applied after font embellishments. Args: buf: Normal text that may contain special characters. Returns: The string with special characters converted to entity tags. z (``[^`]*)''z\1´´z...z…)r3r4r?)r#bufescs r'EntitieszHTMLRenderer.Entitiess( && 3S 9C ;;uj ))r(c8djfd|DS)zEscapes special characters in normal text. This is applied before font embellishments. Args: buf: Normal text that may contain special characters. Returns: The escaped string. rc3VK|] }jj||"yw)N)_ESCAPEget).0cr#s r' z&HTMLRenderer.Escape..s#73a4<<##Aq)3s&))join)r#rFs` r'EscapezHTMLRenderer.Escapes 77737 77r(c|j|js)d|_d|_|jj dt |}|j }|t |z}|jj d|j|zz|jj ||jj dy)zSDisplays line as an indented example. Args: line: The example line. Tz

z z
N)Blankrrr!r"lenlstrip)r#lineindents r'ExamplezHTMLRenderer.Examples  JJL ==dmdj iioom$ YF ;;=D c$iFIIOOH V 345IIOODIIOOHr(c^|jr"d|_|jjd|j|jrd|_|j |}|j D]}t|}|j|z|jk\r#|jjdd|_n<|jr0|xjdz c_|jjd|xj|z c_|jj|y)zpAdds a line to the output, splitting to stay within the output width. Args: line: The text line. Fz

r-rr:r8N) rr!r"rTrLinkGlobalFlagssplitrUr_width)r#rWwordns r'FillzHTMLRenderer.Fills  do iioogJJL  d  ! !$ 'd  d)a a4;; &  :: a   jjAoj iioodr(c|j|j|jd|jr%|jj |j|jj dy)z'Finishes all output document rendering.outrz

N)Fontr!Listrr"r+s r'FinishzHTMLRenderer.FinishsKII$))IIIaL }} iioodmm$IIOO12r(cg}|tjtjtjfD]]}d|z}|j|zs|xj|zc_t |j |D]}|jd|z_nd|z}|xj|zc_|j|zr)|j |D]}|jd|zn1t |j |D]}|jd|zdj|}|r|r|j|dz|S)a-Returns the font embellishment string for attr. Args: attr: None to reset to the default font, otherwise one of renderer.BOLD, renderer.ITALIC, or renderer.CODE. out: Writes tags line to this stream if not None. Returns: The font embellishment HTML tag string. r:zz<%s>rr-) rBOLDITALICCODE_fontreversed _FONT_TAGappendrPr")r#attrrctagsmasktag embellishments r'rdzHTMLRenderer.Fonts D |==(//8==A$Dy ::  ** *dnnT23c KK# &4 B$Yd jjDj d >>$'C ++fsl #(DNN401C ++gm $2GGDMM } ii $% r(cld|_|dz }|dkDrd}|jjd|||fzy)zyRenders an HTML heading. Args: level: The heading level counting from 1. heading: The heading text.  rS z1
%s
N)rr!r"r#levelheadings r'_HeadingzHTMLRenderer._Heading!sBDM QJE qyeIIOO> '5 ! "r(cr|dk(r|jdry|j|j|j|j d|j r%|jj |j |j||d|_|jdrd|_ yy)zsRenders a heading. Args: level: The heading level counting from 1. heading: The heading text. r:z(1)NrbrTz WIDE FLAGS) endswithr/rdr!rerr"rzrrrws r'HeadingzHTMLRenderer.Heading1s zg&&u- KKMII$))IIIaL }} iioodmm$MM%!DM &d'r(ct|j|js|jd|_yy)z$Renders a paragraph separating line.TN)r/ HaveBlankrTrr+s r'LinezHTMLRenderer.LineDs*KKM >>  jjldo r(cnd|vs|jdrdj||xs|Sd|vs|jdrdj||xs|S|s|jdd }d }|j|r|d t | }|jdd d z}dj||S)zRenders an anchor. Args: target: The link target URL. text: The text to be displayed instead of the link. Returns: The rendered link anchor and text. :zwww.z){text})targettext#z..z{text}/r8z/helpN_z.html) startswithrAr|r?rU)r#rrtails r'LinkzHTMLRenderer.LinkKs f}))&1 8 ? ?dnf@ f}- , 3 3dnf4  ^^C %d D tlT #f ^^C % /F * 1 1d 1 KKr(c0tjdd|S)zAdd global flags links to line if any. Args: line: The text line. Returns: line with annoted global flag links. z (--[-a-z]+)z\1r2)r#rWs r'r[zHTMLRenderer.LinkGlobalFlagses 66.":D AAr(c|j|jrr|j|kDrc|jj|j|j|xjdzc_|jr|j|kDrc|s|sy||j|kr|xjdz c_|jt |jk\r|jj dd|j|j<|jr#d|_|jjdn|jjdnkd|j|jvr5|jjd d|j|j<n|jjd |r<|jjd j|j|| y|jdkDr7d|j|jvr|jjd y|jjdd|j|j<y|j|kr|xjdz c_|jt |jk\r|jj dd|j|j<|jjd|j|dz t |jzzdzn|jjd|jjdy)zRenders a bullet or definition list item. Args: level: The list nesting level. definition: Bullet list if None, definition list otherwise. end: End of list if True. r:Nrz
Fz
z
dtz ruzN
{definition}
) document_id definitionz
z
z
z z