-
G2;c       s     d  Z    h  d d <d d <d d <d d <d	 d
 <d d <d d <Z - y . e d i d  d Z Wn / 0 d Z n X5 d k Z 6 d k Z 7 d k Z < d k Z B d   Z	 K d e i
 i i f d     YZ d S(   s=   Formatter which produces output in plain ASCII text format.

s#   $RCSfile: formatter_TextFile.py,v $s   module_names    Doug Hellmann <doug@hellfly.net>s   creators   HappyDocs   projects   Sat, 03-Jun-2000 17:58:02 EDTs   createds   $Author: doughellmann $s   authors   $Revision: 1.1 $s   versions   $Date: 2001/10/24 21:27:35 $s   dates    i   s   0.0Nc      s#   B C D h  d d <t  d <Sd S(   s<   Return information about this module for the dynamic loader.s   Texts   names   factoryN(   s   TextFormatter(    (    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   entryPointB s   s   TextFormatterc      sv  K d  Z  V X d d  Z i d   Z  d   Z  d   Z  e d d  Z  d   Z  e d d	  Z  d
   Z  d   Z	  d   Z
  d   Z  d   Z  d   Z  d   Z  d   Z  d d d  Z  d   Z  d   Z  d   Z  e d  Z  d   Z  d   Z d   Z d   Z d   Z d   Z d   Z d    Z RS(!   s  Formatter which produces plain ASCII text.

    Parameters
          
       filenamePrefix -- A prefix to append to the base names of files
                         and directories being created.  This is
                         useful for situations where the names which
                         would be automatically generated might cause
                         a name clash or conflict.
      
    i   c    s  X Y Z | o [ d Sn \ t i |  } ] | o ^ t i | d  } _ x | D_ ] } ` t i |  } a | o | d d j o b | d } n- c | o | d d j o d | d } n e |  i d | |  qW Wf |  i d |  n g d Sd S(	   s1   Output the text string to the information source.Ns   
i    s    i   s   	i   s   	%s
(	   s   texts   strings   strips   splits   liness   lines   selfs   writeRaws   output(   s   selfs   texts   outputs
   textFormats   quotes   lines   lines(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys	   writeTextX s    

 	c    s   i t u |  i | |  v | i   } w | i   y x | Dy ]u } z |  i i	 |  } { | o | |  i | ~ | i  } n  |  i |  }  |  i | |  i | d   q? W |  i |   d Sd S(   s   Write the list of exceptions raised by a function.

        Parameters

          output -- Where to write.

          function -- FunctionInfo from parseinfo module.

          listHeader -- Header for list being generated.

        s	   PlainTextN(   s   selfs
   listHeaders   outputs   functions   getExceptionNamess   exception_namess   sorts   names   _docsets   getClassInfos   exception_classs   getReferences   refs   getPythonReferences   listItems
   formatCodes
   listFooter(   s   selfs   outputs   functions
   listHeaders   exception_classs   refs   exception_namess   name(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   writeExceptionListForFunctioni s   
 	
#c    s      d Sd S(   sD   Returns the extension to use when creating files for this formatter.s   txtN(    (   s   self(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getFilenameExtension s   c    s      d Sd S(   s<   Return the name of the root node for the documentation tree.s   toc.txtN(    (   s   self(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getRootNodeName s   i    c    s3     | o  |  i d | |  n  d  Sd  S(   Ns   
-- %s --

(   s   titles   selfs   writeRaws   output(   s   selfs   outputs   titles   allowMultiColumn(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   listHeader s   
c    s%     |  i d | |   d  Sd  S(   Ns   	* %s
(   s   selfs   writeRaws   texts   output(   s   selfs   outputs   text(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   listItem s   c    s3     | o  |  i d | |  n  d  Sd  S(   Ns   ==> %s <==
(   s   titles   selfs   writeRaws   output(   s   selfs   outputs   titles   allowMultiColumn(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   listHeader s   
c    s!     |  i d |   d  Sd  S(   Ns   
(   s   selfs   writeRaws   output(   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   listFooter s   c    s!     |  i | |   d  Sd  S(   N(   s   selfs
   listHeaders   outputs   title(   s   selfs   outputs   title(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   descriptiveListHeader s   c    s4     |  i d | t i |  f |   d  Sd  S(   Ns
   	%s : %s

(   s   selfs   writeRaws   items   strings   strips   descriptions   output(   s   selfs   outputs   items   descriptions   descriptionFormat(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   descriptiveListItem s   &c    s     |  i |   d  Sd  S(   N(   s   selfs
   listFooters   output(   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   descriptiveListFooter s   c    s%     |  i d | |   d  Sd  S(   Ns   
** %s **

(   s   selfs   writeRaws   titles   output(   s   selfs   outputs   title(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   sectionHeader s   c    s!     |  i d |   d  Sd  S(   Ns   
(   s   selfs   writeRaws   output(   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   sectionFooter s   c    s4     | i   }  |  i d | |   d  Sd  S(   Ns   
== %s ==

(   s
   infoObjects   getNames   titles   selfs   writeRaws   output(   s   selfs   outputs
   infoObjects   title(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   itemHeader s   c    s!     |  i d |   d  Sd  S(   Ns   
(   s   selfs   writeRaws   output(   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   itemFooter s   s   -iP   c    sN      | t |  }  |  i | | |   |  i d |   d Sd S(   s   Output a sectional dividing line.

        Parameters:

            output -- destination for written output

            fill="-" -- character to use to draw the line

            span=80 -- width of line to draw
            
        s   

N(   s   spans   lens   fills   selfs   writeRaws   output(   s   selfs   outputs   fills   span(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   dividingLine s
   c    s
     d  S(   N(    (   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   pushSectionLevel s   c    s
     d  S(   N(    (   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   popSectionLevel s   c    s0     | |  i j o  | d Sn  | Sd  S(   Ns    (standard module)(   s
   moduleNames   selfs   sys_modules(   s   selfs
   moduleName(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getPythonReference s   c    s     | oz  t |  t i j o  t i i | i   } nB  t |  t i j o  t i i |  } n  | i	   } n  h  | d <|  i |  d <}  d | }  | Sd  S(   Ns   names   links   %(name)s (see %(link)s)(   s   names   types
   infoSources   typess   FileTypes   happydoclibs   paths   basenames
   StringTypes   getNames   selfs   getOutputNameForObjects   infos   ref(   s   selfs
   infoSources   relativeSources   names   infos   ref(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getReference s   $c    s3     h  | i   d <}  d | }  | Sd  S(   Ns   names   %(name)s (see %(name)s)(   s
   infoSources   getNames   infos   ref(   s   selfs
   infoSources   infos   ref(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getLocalReference s   c    s3     h  | i   d <} d | } | Sd  S(   Ns   names   %(name)s (see %(name)s)(   s
   infoSources   getNames   infos   ref(   s   selfs
   infoSources   infos   ref(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getInternalReference s   c    s<   h  | i   d <| d <} d | } | Sd  S(   Ns   names   targets'   %(target)s (see %(target)s in %(name)s)(   s
   infoSources   getNames   names   infos   ref(   s   selfs
   infoSources   names   relativeSources   infos   ref(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   getNamedReferences   !c    s   d  Sd  S(   N(    (   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   indents   c    s   d  Sd  S(   N(    (   s   selfs   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   dedents   c    s   | Sd  S(   N(   s   text(   s   selfs   texts
   textFormat(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys
   formatCodes   c    s   | Sd  S(   N(   s   text(   s   selfs   text(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   formatKeywords   c    s   d  Sd  S(   N(    (   s   selfs   texts   output(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   comments   (   s   __doc__s	   writeTexts   writeExceptionListForFunctions   getFilenameExtensions   getRootNodeNames   Nones
   listHeaders   listItems
   listFooters   descriptiveListHeaders   descriptiveListItems   descriptiveListFooters   sectionHeaders   sectionFooters
   itemHeaders
   itemFooters   dividingLines   pushSectionLevels   popSectionLevels   getPythonReferences   getReferences   getLocalReferences   getInternalReferences   getNamedReferences   indents   dedents
   formatCodes   formatKeywords   comment(    (    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   TextFormatterK s:   	!	(   s   __doc__s   __rcs_info__s   splits   __version__s   strings   oss   typess'   happydoclib.formatter.fileformatterbases   happydoclibs
   entryPoints	   formatters   fileformatterbases   FileBasedFormatters   TextFormatter(   s
   entryPoints   strings   typess   TextFormatters   __version__s   oss   happydoclibs   __rcs_info__(    (    sf   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_TextFile.pys   ? s   H	