aboutsummaryrefslogtreecommitdiffstats
path: root/docs/psddescriptor.html
blob: e161d7f5f91c6f5d7e5b95a4b46b60e81521004c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<!DOCTYPE html>  <html> <head>   <title>psddescriptor.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="blackwhite.html">                 blackwhite.coffee               </a>                                           <a class="source" href="brightnesscontrast.html">                 brightnesscontrast.coffee               </a>                                           <a class="source" href="colorbalance.html">                 colorbalance.coffee               </a>                                           <a class="source" href="curves.html">                 curves.coffee               </a>                                           <a class="source" href="exposure.html">                 exposure.coffee               </a>                                           <a class="source" href="gradient.html">                 gradient.coffee               </a>                                           <a class="source" href="huesaturation.html">                 huesaturation.coffee               </a>                                           <a class="source" href="invert.html">                 invert.coffee               </a>                                           <a class="source" href="layereffect.html">                 layereffect.coffee               </a>                                           <a class="source" href="levels.html">                 levels.coffee               </a>                                           <a class="source" href="pattern.html">                 pattern.coffee               </a>                                           <a class="source" href="photofilter.html">                 photofilter.coffee               </a>                                           <a class="source" href="posterize.html">                 posterize.coffee               </a>                                           <a class="source" href="selectivecolor.html">                 selectivecolor.coffee               </a>                                           <a class="source" href="solidcolor.html">                 solidcolor.coffee               </a>                                           <a class="source" href="threshold.html">                 threshold.coffee               </a>                                           <a class="source" href="typetool.html">                 typetool.coffee               </a>                                           <a class="source" href="vibrance.html">                 vibrance.coffee               </a>                                           <a class="source" href="log.html">                 log.coffee               </a>                                           <a class="source" href="psd.html">                 psd.coffee               </a>                                           <a class="source" href="psdassert.html">                 psdassert.coffee               </a>                                           <a class="source" href="psdchannelimage.html">                 psdchannelimage.coffee               </a>                                           <a class="source" href="psdcolor.html">                 psdcolor.coffee               </a>                                           <a class="source" href="psddescriptor.html">                 psddescriptor.coffee               </a>                                           <a class="source" href="psdfile.html">                 psdfile.coffee               </a>                                           <a class="source" href="psdheader.html">                 psdheader.coffee               </a>                                           <a class="source" href="psdimage.html">                 psdimage.coffee               </a>                                           <a class="source" href="psdlayer.html">                 psdlayer.coffee               </a>                                           <a class="source" href="psdlayermask.html">                 psdlayermask.coffee               </a>                                           <a class="source" href="psdresource.html">                 psdresource.coffee               </a>                                           <a class="source" href="util.html">                 util.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               psddescriptor.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>                            </td>             <td class="code">               <div class="highlight"><pre><span class="k">class</span> <span class="nx">PSDDescriptor</span>
  <span class="nv">constructor: </span><span class="nf">(@file) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Main entry point for parsing a descriptor</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parse: </span><span class="o">-&gt;</span>
    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Parsing descriptor...&quot;</span>

    <span class="nv">data = </span><span class="p">{}</span>
    <span class="nv">data.class = </span><span class="nx">@parseClass</span><span class="p">()</span>

    <span class="nv">numItems = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Descriptor contains #{numItems} items&quot;</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">numItems</span><span class="p">]</span>
      <span class="nv">item = </span><span class="nx">@parseKeyItem</span><span class="p">()</span>
      <span class="nx">data</span><span class="p">[</span><span class="nx">item</span><span class="p">.</span><span class="nx">id</span><span class="p">]</span> <span class="o">=</span> <span class="nx">item</span><span class="p">.</span><span class="nx">value</span>

    <span class="nx">data</span>

  <span class="nv">parseID: </span><span class="o">-&gt;</span>
    <span class="nv">len = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="k">if</span> <span class="nx">len</span> <span class="o">is</span> <span class="mi">0</span>
      <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="k">else</span>
      <span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span><span class="p">(</span><span class="nx">len</span><span class="p">)</span>

  <span class="nv">parseClass: </span><span class="o">-&gt;</span>
    <span class="nv">name: </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readUnicodeString</span><span class="p">()</span>
    <span class="nv">id: </span><span class="nx">@parseID</span><span class="p">()</span>

  <span class="nv">parseKeyItem: </span><span class="o">-&gt;</span>
    <span class="nv">id: </span><span class="nx">@parseID</span><span class="p">()</span>
    <span class="nv">value: </span><span class="nx">@parseItem</span><span class="p">()</span>

  <span class="nv">parseItem: </span><span class="o">-&gt;</span>
    <span class="nv">type = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
    <span class="nx">Log</span><span class="p">.</span><span class="nx">debug</span> <span class="s2">&quot;Found descriptor type: #{type}&quot;</span>

    <span class="nv">value = </span><span class="k">switch</span> <span class="nx">type</span>
      <span class="k">when</span> <span class="s1">&#39;bool&#39;</span> <span class="k">then</span> <span class="nx">@parseBoolean</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;type&#39;</span><span class="p">,</span> <span class="s1">&#39;GlbC&#39;</span> <span class="k">then</span> <span class="nx">@parseClass</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;Objc&#39;</span><span class="p">,</span> <span class="s1">&#39;GlbO&#39;</span> <span class="k">then</span> <span class="nx">@parse</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;doub&#39;</span> <span class="k">then</span> <span class="nx">@parseDouble</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;enum&#39;</span> <span class="k">then</span> <span class="nx">@parseEnum</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;alis&#39;</span> <span class="k">then</span> <span class="nx">@parseAlias</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;Pth &#39;</span> <span class="k">then</span> <span class="nx">@parseFilePath</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;long&#39;</span> <span class="k">then</span> <span class="nx">@parseInteger</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;comp&#39;</span> <span class="k">then</span> <span class="nx">@parseLargeInteger</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;VlLs&#39;</span> <span class="k">then</span> <span class="nx">@parseList</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;ObAr&#39;</span> <span class="k">then</span> <span class="nx">@parseObjectArray</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;tdta&#39;</span> <span class="k">then</span> <span class="nx">@parseRawData</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;obj &#39;</span> <span class="k">then</span> <span class="nx">@parseReference</span><span class="p">()</span>
      <span class="k">when</span> <span class="s1">&#39;TEXT&#39;</span> <span class="k">then</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="s1">&#39;UntF&#39;</span> <span class="k">then</span> <span class="nx">@parseUnitDouble</span><span class="p">()</span>

    <span class="nx">value</span>

  <span class="nv">parseBoolean: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span>
  <span class="nv">parseDouble: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readDouble</span><span class="p">()</span>
  <span class="nv">parseInteger: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
  <span class="nv">parseLargeInteger: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readLongLong</span><span class="p">()</span>
  <span class="nv">parseIdentifier: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
  <span class="nv">parseIndex: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
  <span class="nv">parseOffset: </span><span class="o">-&gt;</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
  <span class="nv">parseProperty: </span><span class="o">-&gt;</span> <span class="nx">@parseID</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>We discard the first ID because it's the same as the key
parsed from the Key/Item.</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseEnum: </span><span class="o">-&gt;</span>
    <span class="nx">@parseID</span><span class="p">()</span>
    <span class="nx">@parseID</span><span class="p">()</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>File Alias
This data is opaque and unique to Mac OS</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="nv">parseAlias: </span><span class="o">-&gt;</span>
    <span class="nv">len = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</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">len</span><span class="p">)</span>

  <span class="nv">parseFilePath: </span><span class="o">-&gt;</span>
    <span class="nv">len = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>Little-endian?!?</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="p">[</span>
      <span class="nx">sig</span><span class="p">,</span>
      <span class="nx">pathSize</span><span class="p">,</span>
      <span class="nx">numChars</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="p">(</span><span class="s2">&quot;&lt;4s2i&quot;</span><span class="p">)</span>

    <span class="nv">charBytes = </span><span class="nx">numChars</span> <span class="o">*</span> <span class="mi">2</span>
    <span class="nv">path = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">read</span><span class="p">(</span><span class="nx">charBytes</span><span class="p">)</span>

    <span class="nv">sig: </span><span class="nx">sig</span><span class="p">,</span> <span class="nv">path: </span><span class="nx">path</span>

  <span class="nv">parseList: </span><span class="o">-&gt;</span>
    <span class="nv">numItems = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nv">items = </span><span class="p">[]</span>
    <span class="nx">items</span><span class="p">.</span><span class="nx">push</span> <span class="nx">@parseItem</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">numItems</span><span class="p">]</span>
    <span class="nx">items</span>

  <span class="nv">parseObjectArray: </span><span class="o">-&gt;</span>
    <span class="nv">numItems = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nv">klass = </span><span class="nx">@parseClass</span><span class="p">()</span>
    <span class="nv">itemsInObj = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>

    <span class="nv">obj = </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">numItems</span><span class="p">]</span>
      <span class="nv">item = </span><span class="p">[]</span>
      <span class="k">for</span> <span class="nx">j</span> <span class="k">in</span> <span class="p">[</span><span class="mi">0</span><span class="p">...</span><span class="nx">itemsInObj</span><span class="p">]</span>
        <span class="nx">item</span><span class="p">.</span><span class="nx">push</span> <span class="nx">@parseObjectArray</span><span class="p">()</span>

      <span class="nx">obj</span><span class="p">.</span><span class="nx">push</span> <span class="nx">item</span>

    <span class="nx">obj</span>

  <span class="nv">parseObjectArray: </span><span class="o">-&gt;</span>
    <span class="nv">id = </span><span class="nx">@parseID</span><span class="p">()</span>
    <span class="nv">type = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
    <span class="nv">unitID = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span><span class="p">()</span>
    <span class="nv">num = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>

    <span class="nv">values = </span><span class="p">[]</span>
    <span class="nx">values</span><span class="p">.</span><span class="nx">push</span> <span class="nx">@file</span><span class="p">.</span><span class="nx">readDouble</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">num</span><span class="p">]</span>
    <span class="nx">values</span>

  <span class="nv">parseRawData: </span><span class="o">-&gt;</span>
    <span class="nv">len = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</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">len</span><span class="p">)</span>

  <span class="nv">parseReference: </span><span class="o">-&gt;</span>
    <span class="nv">form = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readString</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
    <span class="nv">klass = </span><span class="nx">@parseClass</span><span class="p">()</span>

    <span class="nv">value = </span><span class="k">switch</span> <span class="nx">form</span>
      <span class="k">when</span> <span class="s2">&quot;Clss&quot;</span> <span class="k">then</span> <span class="kc">null</span>
      <span class="k">when</span> <span class="s2">&quot;Enmr&quot;</span> <span class="k">then</span> <span class="nx">@parseEnum</span><span class="p">()</span>
      <span class="k">when</span> <span class="s2">&quot;Idnt&quot;</span> <span class="k">then</span> <span class="nx">@parseIdentifier</span><span class="p">()</span>
      <span class="k">when</span> <span class="s2">&quot;indx&quot;</span> <span class="k">then</span> <span class="nx">@parseIndex</span><span class="p">()</span>
      <span class="k">when</span> <span class="s2">&quot;name&quot;</span> <span class="k">then</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;rele&quot;</span> <span class="k">then</span> <span class="nx">@parseOffset</span><span class="p">()</span>
      <span class="k">when</span> <span class="s2">&quot;prop&quot;</span> <span class="k">then</span> <span class="nx">@parseProperty</span><span class="p">()</span>

    <span class="nx">value</span>

  <span class="nv">parseUnitDouble: </span><span class="o">-&gt;</span>
    <span class="nv">unitID = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">parseString</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
    <span class="nv">unit = </span><span class="k">switch</span> <span class="nx">unitID</span>
      <span class="k">when</span> <span class="s2">&quot;#Ang&quot;</span> <span class="k">then</span> <span class="s2">&quot;Angle&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Rsl&quot;</span> <span class="k">then</span> <span class="s2">&quot;Density&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Rlt&quot;</span> <span class="k">then</span> <span class="s2">&quot;Distance&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Nne&quot;</span> <span class="k">then</span> <span class="s2">&quot;None&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Prc&quot;</span> <span class="k">then</span> <span class="s2">&quot;Percent&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Pxl&quot;</span> <span class="k">then</span> <span class="s2">&quot;Pixels&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Mlm&quot;</span> <span class="k">then</span> <span class="s2">&quot;Millimeters&quot;</span>
      <span class="k">when</span> <span class="s2">&quot;#Pnt&quot;</span> <span class="k">then</span> <span class="s2">&quot;Points&quot;</span>

    <span class="nv">value = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readDouble</span><span class="p">()</span>

    <span class="nv">id: </span><span class="nx">unitID</span><span class="p">,</span> <span class="nv">unit: </span><span class="nx">unit</span><span class="p">,</span> <span class="nv">value: </span><span class="nx">value</span>

</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>