TWiki/TWikiStoreRcsWrapDotPm.mdwn

   1 # <a name="Package &lt;code&gt;TWiki::Store::_RcsWrap="></a> Package =TWiki::Store::RcsWrap
   2
   3 **extends** <tt>[[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]]</tt>
   4
   5 This package does not publish any methods. It implements the virtual methods of the [[TWiki::Store::RcsFile|Main/TWikiStoreRcsFileDotPm]] superclass.
   6
   7 Wrapper around the RCS commands required by TWiki. There is one of these object for each file stored under RCS.
   8
   9 <div>
  10   <ul>
  11     <li><a href="#Package =TWiki::Store::_RcsWrap="> Package TWiki::Store::RcsWrap</a><ul>
  12         <li><a href="#ObjectMethod *finish*"> ObjectMethod finish <tt></tt></a></li>
  13         <li><a href="#StaticMethod *parse_RevisionDiff"> StaticMethod parseRevisionDiff <tt>($text) -&gt; \@diffArray</tt></a></li>
  14       </ul>
  15     </li>
  16   </ul>
  17 </div>
  18
  19 ## <a name="ObjectMethod &lt;strong&gt;finish*"></a><a name="ObjectMethod *finish&lt;/strong&gt; "></a> [[ObjectMethod]] **finish** ``
  20
  21 Complete processing after the client's HTTP request has been responded to.
  22
  23 1. breaking circular references to allow garbage collection in persistent environments
  24
  25 ## <a name="StaticMethod &lt;strong&gt;parse_RevisionDiff"></a> [[StaticMethod]] \*parseRevisionDiff `($text) -> \@diffArray`
  26
  27 <table border="1" cellpadding="0" cellspacing="0">
  28   <tr>
  29     <td> Description: </td>
  30     <td> parse the text into an array of diff cells </td>
  31   </tr>
  32   <tr>
  33     <td> #Description: </td>
  34     <td> unlike Algorithm::Diff I concatinate lines of the same diffType that are sqential (this might be something that should be left up to the renderer) </td>
  35   </tr>
  36   <tr>
  37     <td> Parameter: <code>$text</code></td>
  38     <td> currently unified or rcsdiff format </td>
  39   </tr>
  40   <tr>
  41     <td> Return: <code>\@diffArray</code></td>
  42     <td> reference to an array of [ diffType, $right, $left ] </td>
  43   </tr>
  44   <tr>
  45     <td> TODO: </td>
  46     <td> move into [[Main/RcsFile]] and add indirection in Store </td>
  47   </tr>
  48 </table>