<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: P4RecId</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <h1>P4RecId <sup class="type-note">(Class)</sup></h1> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/p4table_rb.html"> p4table.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="description"> <p> Class for creating and formatting record id’s. Normally these are just of the form "<tablename>/<nnnnnn>" </p> </div> <div id="method-list"> <h2 class="section-bar">Methods</h2> <div class="name-list"> <a href="#M000003">new</a> <a href="#M000002">new_from_job</a> <a href="#M000001">next</a> <a href="#M000004">seq_str</a> <a href="#M000005">to_s</a> </div> </div> <div id="attribute-list"> <h2 class="section-bar">Attributes</h2> <div class="name-list"> <table> <tr class="top-aligned-row context-row"> <td class="context-item-name">seq</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">table</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> </table> </div> </div> </div> <!-- if includes --> <!-- if method_list --> <div id="methods"> <h2 class="section-bar">Public Class methods</h2> <div id="method-M000003" class="method-detail"> <a name="M000003"></a> <div class="method-heading"> <a href="#M000003" class="method-signature"> <span class="method-name">new</span><span class="method-args">( table, seq )</span> </a> </div> <div class="method-description"> <p> Construct a new RecID for the given table name and sequence number </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000003-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000003-source"> <pre> <span class="ruby-comment cmt"># File p4table.rb, line 230</span> 230: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">table</span>, <span class="ruby-identifier">seq</span> ) 231: <span class="ruby-ivar">@table</span> = <span class="ruby-identifier">table</span> 232: <span class="ruby-keyword kw">if</span> ( <span class="ruby-identifier">seq</span>.<span class="ruby-identifier">kind_of?</span>( <span class="ruby-constant">String</span> ) ) 233: <span class="ruby-keyword kw">if</span> ( <span class="ruby-identifier">seq</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^0*([1-9]\d+)$/</span> ) 234: <span class="ruby-ivar">@seq</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span> 235: <span class="ruby-keyword kw">else</span> 236: <span class="ruby-ivar">@seq</span> = <span class="ruby-identifier">seq</span>.<span class="ruby-identifier">to_i</span> 237: <span class="ruby-keyword kw">end</span> 238: <span class="ruby-keyword kw">else</span> 239: <span class="ruby-ivar">@seq</span> = <span class="ruby-identifier">seq</span> 240: <span class="ruby-keyword kw">end</span> 241: <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000002" class="method-detail"> <a name="M000002"></a> <div class="method-heading"> <a href="#M000002" class="method-signature"> <span class="method-name">new_from_job</span><span class="method-args">( job )</span> </a> </div> <div class="method-description"> <p> Instantiate a new P4RecID from the job name ( "<table>/<id>" ). Used to load existing records. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000002-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000002-source"> <pre> <span class="ruby-comment cmt"># File p4table.rb, line 222</span> 222: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">P4RecId</span>.<span class="ruby-identifier">new_from_job</span>( <span class="ruby-identifier">job</span> ) 223: ( <span class="ruby-identifier">table</span>, <span class="ruby-identifier">seq</span> ) = <span class="ruby-identifier">job</span>.<span class="ruby-identifier">split</span>( <span class="ruby-value str">"/"</span> ) 224: <span class="ruby-constant">P4RecId</span>.<span class="ruby-identifier">new</span>( <span class="ruby-constant">P4Table</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">table</span> ), <span class="ruby-identifier">seq</span> ) 225: <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000001" class="method-detail"> <a name="M000001"></a> <div class="method-heading"> <a href="#M000001" class="method-signature"> <span class="method-name">next</span><span class="method-args">( table )</span> </a> </div> <div class="method-description"> <p> Get the next ID for the specified table using </p> <ol> <li>p4 counter <table> </li> <li>p4 counter <table> = <n+1> </li> </ol> <p> Yes, this has a race condition, but there’s no atomic get and set operation for Perforce counters. </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000001-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000001-source"> <pre> <span class="ruby-comment cmt"># File p4table.rb, line 210</span> 210: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">P4RecId</span>.<span class="ruby-keyword kw">next</span>( <span class="ruby-identifier">table</span> ) 211: <span class="ruby-identifier">p4</span> = <span class="ruby-constant">P4Global</span>.<span class="ruby-identifier">tagged</span> 212: <span class="ruby-identifier">val</span> = <span class="ruby-identifier">p4</span>.<span class="ruby-identifier">run_counter</span>( <span class="ruby-identifier">table</span>.<span class="ruby-identifier">name</span> ).<span class="ruby-identifier">shift</span>.<span class="ruby-identifier">to_i</span> 213: <span class="ruby-identifier">val</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> 214: <span class="ruby-identifier">p4</span>.<span class="ruby-identifier">run_counter</span>( <span class="ruby-identifier">table</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">val</span> ) 215: <span class="ruby-constant">P4RecId</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">table</span>, <span class="ruby-identifier">val</span> ) 216: <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h2 class="section-bar">Public Instance methods</h2> <div id="method-M000004" class="method-detail"> <a name="M000004"></a> <div class="method-heading"> <a href="#M000004" class="method-signature"> <span class="method-name">seq_str</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Format the sequence number for printing </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000004-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000004-source"> <pre> <span class="ruby-comment cmt"># File p4table.rb, line 252</span> 252: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">seq_str</span> 253: <span class="ruby-identifier">sprintf</span>( <span class="ruby-value str">"%06d"</span>, <span class="ruby-ivar">@seq</span> ) 254: <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000005" class="method-detail"> <a name="M000005"></a> <div class="method-heading"> <a href="#M000005" class="method-signature"> <span class="method-name">to_s</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> String representation of an id </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000005-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000005-source"> <pre> <span class="ruby-comment cmt"># File p4table.rb, line 259</span> 259: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span> 260: <span class="ruby-ivar">@table</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"/"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">seq_str</span>() 261: <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#2 | 4678 | Tony Smith |
Update p4table.rb to use the new spec parsing and formatting features of P4Ruby. This means we now only need one Perforce client instance to handle specs in both hash form and text form. |
||
#1 | 4677 | Tony Smith |
Move P4table.rb to the P4Ruby library and rename it to p4table.rb instead. There's an update coming so this is just the move. |