Updated documentation

Author: meltingice

docs/psdfile.html

@@ -35,7 +35,7 @@
 null-byte padded, we strip out these null bytes since they are of no
 use to us in Javascript.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">readString: </span><span class="nf">(length) -&gt;</span>
     <span class="nv">ret = </span><span class="p">[]</span>
-    <span class="nx">ret</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">String</span><span class="p">.</span><span class="nx">fromCharCode</span> <span class="nx">@read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">length</span><span class="p">]</span>
+    <span class="nx">ret</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="nb">String</span><span class="p">.</span><span class="nx">fromCharCode</span><span class="p">(</span><span class="nx">@read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span> <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">length</span><span class="p">]</span>
     <span class="nx">ret</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">).</span><span class="nx">replace</span> <span class="sr">/\u0000/g</span><span class="p">,</span> <span class="s2">&quot;&quot;</span>
 
   <span class="nv">readUnicodeString: </span><span class="o">-&gt;</span>

docs/psdimage.html

@@ -63,7 +63,6 @@
 
     <span class="nx">@processImageData</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>Parse the image data as raw pixel values. There is no compression used here.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseRaw: </span><span class="nf">(length = @length) -&gt;</span>
     <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Attempting to parse RAW encoded image...&quot;</span>
-    <span class="vi">@channelData = </span><span class="p">[]</span>
     <span class="nx">@channelData</span><span class="p">.</span><span class="nx">push</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="nx">i</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">length</span><span class="p">]</span>
 
     <span class="k">return</span> <span class="kc">true</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>Parse the image with RLE compression. This is the same as the TIFF standard format.

docs/psdlayer.html

@@ -92,9 +92,11 @@
       <span class="k">return</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">@layerEnd</span><span class="p">,</span> <span class="kc">false</span>
 
     <span class="nx">@parseBlendingRanges</span><span class="p">()</span>
-    <span class="nx">@parseLayerName</span><span class="p">()</span>
+    <span class="nx">@parseLegacyLayerName</span><span class="p">()</span>
     <span class="nx">@parseExtraData</span><span class="p">()</span>
 
+    <span class="vi">@name = </span><span class="nx">@legacyName</span> <span class="nx">unless</span> <span class="nx">@name</span><span class="o">?</span>
+
     <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Layer #{layerIndex}:&quot;</span><span class="p">,</span> <span class="err">@</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>In case there are filler zeros</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">@file</span><span class="p">.</span><span class="nx">seek</span> <span class="nx">extrastart</span> <span class="o">+</span> <span class="nx">extralen</span><span class="p">,</span> <span class="kc">false</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <p>Parse important information about this layer such as position, size,
 and channel info. Layer Records section.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseInfo: </span><span class="nf">(layerIndex) -&gt;</span>
     <span class="vi">@idx = </span><span class="nx">layerIndex</span></pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <h1>#</h1>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nx">Layer</span> <span class="nx">Info</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <h1>#</h1>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="p">[</span><span class="nx">@top</span><span class="p">,</span> <span class="nx">@left</span><span class="p">,</span> <span class="nx">@bottom</span><span class="p">,</span> <span class="nx">@right</span><span class="p">,</span> <span class="nx">@channels</span><span class="p">]</span> <span class="o">=</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readf</span> <span class="s2">&quot;&gt;iiiih&quot;</span>
@@ -191,8 +193,11 @@
           <span class="nv">white: </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
         <span class="nv">dest: </span>
           <span class="nv">black: </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
-          <span class="nv">white: </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-24">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-24">&#182;</a>               </div>               <p>Parse the name of this layer</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseLayerName: </span><span class="o">-&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-25">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-25">&#182;</a>               </div>               <p>Name length is padded in multiples of 4</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">namelen = </span><span class="nx">Util</span><span class="p">.</span><span class="nx">pad4</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
-    <span class="vi">@name = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span> <span class="nx">namelen</span>
+          <span class="nv">white: </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-24">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-24">&#182;</a>               </div>               <p>Parse the name of this layer. This is considered the "legacy"
+name because it is encoded with MacRoman encoding. PS >= 5.0
+includes a unicode version of the name, which is in the additional
+layer information section.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseLegacyLayerName: </span><span class="o">-&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-25">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-25">&#182;</a>               </div>               <p>Name length is padded in multiples of 4</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">namelen = </span><span class="nx">Util</span><span class="p">.</span><span class="nx">pad4</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+    <span class="vi">@legacyName = </span><span class="nx">Util</span><span class="p">.</span><span class="nx">decodeMacroman</span><span class="p">(</span><span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="nx">namelen</span><span class="p">)).</span><span class="nx">replace</span> <span class="sr">/\u0000/g</span><span class="p">,</span> <span class="s1">&#39;&#39;</span>
 
     <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Layer name: #{@name}&quot;</span>
 
@@ -230,6 +235,8 @@
           <span class="vi">@adjustments.typeTool = </span><span class="p">(</span><span class="k">new</span> <span class="nx">PSDTypeTool</span><span class="p">(</span><span class="err">@</span><span class="p">,</span> <span class="nx">length</span><span class="p">)).</span><span class="nx">parse</span><span class="p">(</span><span class="kc">true</span><span class="p">)</span>
         <span class="k">when</span> <span class="s2">&quot;TySh&quot;</span> <span class="c1"># PS &gt;= 6</span>
           <span class="vi">@adjustments.typeTool = </span><span class="p">(</span><span class="k">new</span> <span class="nx">PSDTypeTool</span><span class="p">(</span><span class="err">@</span><span class="p">,</span> <span class="nx">length</span><span class="p">)).</span><span class="nx">parse</span><span class="p">()</span>
+        <span class="k">when</span> <span class="s2">&quot;luni&quot;</span> <span class="c1"># PS &gt;= 5.0</span>
+          <span class="vi">@name = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readUnicodeString</span><span class="p">()</span>
         <span class="k">when</span> <span class="s2">&quot;lyid&quot;</span>
           <span class="vi">@layerId = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
         <span class="k">when</span> <span class="s2">&quot;lsct&quot;</span>