<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<!-- Source/Synopsis/Formatters/HTML/Parts/Summary.py.html -->
<!-- this view was generated by Source -->
<head>
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"/>
<title >Synopsis - Synopsis/Formatters/HTML/Parts/Summary.py</title>
<link href="../../../../../style.css" type="text/css" rel="stylesheet" />
</head>
<body class="Source">
<div class="navigation">
<span class="normal"><a href="../../../../../Scopes/Synopsis.html" >Global Package</a></span>
<span class="normal"><a href="../../../../../InheritanceTree.html" >Inheritance Tree</a></span>
<span class="normal"><a href="../../../../../InheritanceGraph.html" >Inheritance Graph</a></span>
<span class="normal"><a href="../../../../../NameIndex.html" >Name Index</a></span>
</div>
File: <b >Synopsis/Formatters/HTML/Parts/Summary.py</b><pre class="sxr"><a id="line1"></a><span class="lineno"> 1</span><span class="line"><span class="py-comment">#</span></span>
<a id="line2"></a><span class="lineno"> 2</span><span class="line"><span class="py-comment"># Copyright (C) 2000 Stephen Davies</span></span>
<a id="line3"></a><span class="lineno"> 3</span><span class="line"><span class="py-comment"># Copyright (C) 2000 Stefan Seefeld</span></span>
<a id="line4"></a><span class="lineno"> 4</span><span class="line"><span class="py-comment"># All rights reserved.</span></span>
<a id="line5"></a><span class="lineno"> 5</span><span class="line"><span class="py-comment"># Licensed to the public under the terms of the GNU LGPL (>= 2),</span></span>
<a id="line6"></a><span class="lineno"> 6</span><span class="line"><span class="py-comment"># see the file COPYING for details.</span></span>
<a id="line7"></a><span class="lineno"> 7</span><span class="line"><span class="py-comment">#</span></span>
<a id="line8"></a><span class="lineno"> 8</span>
<a id="line9"></a><span class="lineno"> 9</span><span class="line"><span class="py-keyword">from</span> Synopsis <span class="py-keyword">import</span> ASG</span>
<a id="line10"></a><span class="lineno">10</span><span class="line"><span class="py-keyword">from</span> Synopsis.Processor <span class="py-keyword">import</span> Parameter</span>
<a id="line11"></a><span class="lineno">11</span><span class="line"><span class="py-keyword">from</span> Synopsis.Formatters.HTML.Part <span class="py-keyword">import</span> Part</span>
<a id="line12"></a><span class="lineno">12</span><span class="line"><span class="py-keyword">from</span> Synopsis.Formatters.HTML.Fragments <span class="py-keyword">import</span> *</span>
<a id="line13"></a><span class="lineno">13</span><span class="line"><span class="py-keyword">from</span> Synopsis.Formatters.HTML.Tags <span class="py-keyword">import</span> *</span>
<a id="line14"></a><span class="lineno">14</span>
<a id="line15"></a><span class="lineno">15</span><span class="line"><span class="py-keyword">class</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html">Summary</a>(Part):</span>
<a id="line16"></a><span class="lineno">16</span><span class="line"> <span class="py-string">"""Formatting summary visitor. This formatter displays a summary for each</span></span>
<a id="line17"></a><span class="lineno">17</span><span class="line"><span class="py-string"> declaration, with links to the details if there is one. All of this is</span></span>
<a id="line18"></a><span class="lineno">18</span><span class="line"><span class="py-string"> controlled by the ASGFormatters."""</span></span>
<a id="line19"></a><span class="lineno">19</span>
<a id="line20"></a><span class="lineno">20</span><span class="line"> fragments = Parameter([DeclarationSummaryFormatter(), SummaryCommenter()],</span>
<a id="line21"></a><span class="lineno">21</span><span class="line"> <span class="py-string">''</span>)</span>
<a id="line22"></a><span class="lineno">22</span>
<a id="line23"></a><span class="lineno">23</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#register">register</a>(self, view):</span>
<a id="line24"></a><span class="lineno">24</span>
<a id="line25"></a><span class="lineno">25</span><span class="line"> Part.register(self, view)</span>
<a id="line26"></a><span class="lineno">26</span><span class="line"> self.__link_detail = False</span>
<a id="line27"></a><span class="lineno">27</span>
<a id="line28"></a><span class="lineno">28</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#set_link_detail">set_link_detail</a>(self, flag):</span>
<a id="line29"></a><span class="lineno">29</span><span class="line"> <span class="py-string">"""Sets link_detail flag to given value.</span></span>
<a id="line30"></a><span class="lineno">30</span><span class="line"><span class="py-string"> @see label()"""</span></span>
<a id="line31"></a><span class="lineno">31</span>
<a id="line32"></a><span class="lineno">32</span><span class="line"> self.__link_detail = flag</span>
<a id="line33"></a><span class="lineno">33</span>
<a id="line34"></a><span class="lineno">34</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#label">label</a>(self, ref, label=None):</span>
<a id="line35"></a><span class="lineno">35</span><span class="line"> <span class="py-string">"""Override to check link_detail flag. If it's set, returns a reference</span></span>
<a id="line36"></a><span class="lineno">36</span><span class="line"><span class="py-string"> instead - which will be to the detailed info"""</span></span>
<a id="line37"></a><span class="lineno">37</span>
<a id="line38"></a><span class="lineno">38</span><span class="line"> <span class="py-keyword">if</span> label <span class="py-keyword">is</span> None: label = ref</span>
<a id="line39"></a><span class="lineno">39</span><span class="line"> <span class="py-keyword">if</span> self.__link_detail:</span>
<a id="line40"></a><span class="lineno">40</span><span class="line"> <span class="py-comment"># Insert a reference instead</span></span>
<a id="line41"></a><span class="lineno">41</span><span class="line"> <span class="py-keyword">return</span> span(<span class="py-string">'name'</span>,self.reference(ref, str(self.scope().prune(label))))</span>
<a id="line42"></a><span class="lineno">42</span><span class="line"> <span class="py-keyword">return</span> Part.label(self, ref, label)</span>
<a id="line43"></a><span class="lineno">43</span>
<a id="line44"></a><span class="lineno">44</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#write_section_start">write_section_start</a>(self, heading):</span>
<a id="line45"></a><span class="lineno">45</span><span class="line"> <span class="py-string">"""Start a 'summary' section and write an appropriate heading."""</span></span>
<a id="line46"></a><span class="lineno">46</span>
<a id="line47"></a><span class="lineno">47</span><span class="line"> self.write(<span class="py-string">'<div class="summary">\n'</span>)</span>
<a id="line48"></a><span class="lineno">48</span><span class="line"> self.write(div(<span class="py-string">'heading'</span>, heading) + <span class="py-string">'\n'</span>)</span>
<a id="line49"></a><span class="lineno">49</span>
<a id="line50"></a><span class="lineno">50</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#write_section_end">write_section_end</a>(self, heading):</span>
<a id="line51"></a><span class="lineno">51</span><span class="line"> <span class="py-string">"""Close the section."""</span></span>
<a id="line52"></a><span class="lineno">52</span>
<a id="line53"></a><span class="lineno">53</span><span class="line"> self.write(<span class="py-string">'</div><!-- summary -->\n'</span>)</span>
<a id="line54"></a><span class="lineno">54</span>
<a id="line55"></a><span class="lineno">55</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#write_section_item">write_section_item</a>(self, text):</span>
<a id="line56"></a><span class="lineno">56</span><span class="line"> <span class="py-string">"""Add an item."""</span></span>
<a id="line57"></a><span class="lineno">57</span>
<a id="line58"></a><span class="lineno">58</span><span class="line"> self.write(div(<span class="py-string">'item'</span>, text) + <span class="py-string">'\n'</span>)</span>
<a id="line59"></a><span class="lineno">59</span>
<a id="line60"></a><span class="lineno">60</span><span class="line"> <span class="py-keyword">def</span> <a href="../../../../../Scopes/Synopsis/Formatters/HTML/Parts/Summary/Summary.html#process">process</a>(self, scope):</span>
<a id="line61"></a><span class="lineno">61</span><span class="line"> <span class="py-string">"Print out the summaries from the given scope"</span></span>
<a id="line62"></a><span class="lineno">62</span>
<a id="line63"></a><span class="lineno">63</span><span class="line"> <span class="py-keyword">if</span> type(scope) == ASG.Forward:</span>
<a id="line64"></a><span class="lineno">64</span><span class="line"> <span class="py-keyword">return</span></span>
<a id="line65"></a><span class="lineno">65</span>
<a id="line66"></a><span class="lineno">66</span><span class="line"> doc = self.processor.documentation</span>
<a id="line67"></a><span class="lineno">67</span><span class="line"> sorter = self.processor.sorter.clone(scope.declarations)</span>
<a id="line68"></a><span class="lineno">68</span>
<a id="line69"></a><span class="lineno">69</span><span class="line"> self.write_start()</span>
<a id="line70"></a><span class="lineno">70</span><span class="line"> <span class="py-keyword">for</span> section <span class="py-keyword">in</span> sorter:</span>
<a id="line71"></a><span class="lineno">71</span><span class="line"> <span class="py-comment"># Write a header for this section</span></span>
<a id="line72"></a><span class="lineno">72</span><span class="line"> heading = section+<span class="py-string">' Summary:'</span></span>
<a id="line73"></a><span class="lineno">73</span><span class="line"> self.write_section_start(heading)</span>
<a id="line74"></a><span class="lineno">74</span><span class="line"> <span class="py-comment"># Iterate through the children in this section</span></span>
<a id="line75"></a><span class="lineno">75</span><span class="line"> <span class="py-keyword">for</span> child <span class="py-keyword">in</span> sorter[section]:</span>
<a id="line76"></a><span class="lineno">76</span><span class="line"> <span class="py-comment"># Check if need to add to detail list</span></span>
<a id="line77"></a><span class="lineno">77</span><span class="line"> <span class="py-keyword">if</span> doc.details(child, self.view()):</span>
<a id="line78"></a><span class="lineno">78</span><span class="line"> <span class="py-comment"># Setup the linking stuff</span></span>
<a id="line79"></a><span class="lineno">79</span><span class="line"> self.set_link_detail(1)</span>
<a id="line80"></a><span class="lineno">80</span><span class="line"> child.accept(self)</span>
<a id="line81"></a><span class="lineno">81</span><span class="line"> self.set_link_detail(0)</span>
<a id="line82"></a><span class="lineno">82</span><span class="line"> <span class="py-keyword">else</span>:</span>
<a id="line83"></a><span class="lineno">83</span><span class="line"> <span class="py-comment"># Just do it</span></span>
<a id="line84"></a><span class="lineno">84</span><span class="line"> child.accept(self)</span>
<a id="line85"></a><span class="lineno">85</span><span class="line"> <span class="py-comment"># Finish off this section</span></span>
<a id="line86"></a><span class="lineno">86</span><span class="line"> self.write_section_end(heading)</span>
<a id="line87"></a><span class="lineno">87</span><span class="line"> self.write_end()</span>
<a id="line88"></a><span class="lineno">88</span>
<a id="line89"></a><span class="lineno">89</span>
</pre>
<div class="logo">Generated on Thu Apr 16 16:27:14 2009 by
<br/>
<a href="http://synopsis.fresco.org" target="_blank"><img src="../../../../../synopsis.png" alt="logo"/> synopsis</a> (version devel)</div>
</body>
</html>
