aboutsummaryrefslogtreecommitdiffstats
path: root/docs/typetool.html
blob: 1e38c9b9d435b276e38f6d2ef22aed677e7fee9c (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
<!DOCTYPE html>  <html> <head>   <title>typetool.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>               typetool.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">PSDTypeTool</span>
  <span class="nv">constructor: </span><span class="nf">(@layer, @length) -&gt;</span>
    <span class="vi">@file = </span><span class="nx">@layer</span><span class="p">.</span><span class="nx">file</span>
    <span class="vi">@data = </span><span class="p">{}</span>

  <span class="nv">parse: </span><span class="nf">(legacy = false) -&gt;</span>
    <span class="nv">version = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">version</span> <span class="o">is</span> <span class="mi">1</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>6 * 8 double numbers for transform info
xx, xy, yx, yy, tx, ty</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.transformInfo = </span><span class="p">{}</span>
    <span class="p">[</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">xx</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">xy</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">yx</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">yy</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">tx</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">transformInfo</span><span class="p">.</span><span class="nx">ty</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;&gt;6d&quot;</span><span class="p">)</span>

    <span class="k">return</span> <span class="nx">@parseLegacy</span><span class="p">()</span> <span class="k">if</span> <span class="nx">legacy</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>Below is code for PS >= 6</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">textVersion = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">textVersion</span> <span class="o">is</span> <span class="mi">50</span>

    <span class="nv">descriptorVersion = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">descriptorVersion</span> <span class="o">is</span> <span class="mi">16</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>Read descriptor (NOTE: not sure if correct...)</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.text = </span><span class="p">(</span><span class="k">new</span> <span class="nx">PSDDescriptor</span><span class="p">(</span><span class="nx">@file</span><span class="p">)).</span><span class="nx">parse</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>This isn't documented, but it seems like the raw EngineData
can be parsed as character codes. It's not perfect, but you
can get a general idea. Hopefully this can be improved in the
future.</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">engineData = </span><span class="s2">&quot;&quot;</span>
    <span class="k">for</span> <span class="nx">char</span> <span class="k">in</span> <span class="nx">@data</span><span class="p">.</span><span class="nx">text</span><span class="p">.</span><span class="nx">EngineData</span>
      <span class="nx">engineData</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">char</span><span class="p">)</span>

    <span class="vi">@data.text.EngineData = </span><span class="nx">engineData</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></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>This is a bit verbose
Log.debug "Text:", @data.text</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">warpVersion = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">warpVersion</span> <span class="o">is</span> <span class="mi">1</span>

    <span class="nv">descriptorVersion = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">descriptorVersion</span> <span class="o">is</span> <span class="mi">16</span>

    <span class="vi">@data.warp = </span><span class="p">(</span><span class="k">new</span> <span class="nx">PSDDescriptor</span><span class="p">(</span><span class="nx">@file</span><span class="p">)).</span><span class="nx">parse</span><span class="p">()</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>Log.debug "Warp:", @data.warp</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="p">[</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">left</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">top</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">right</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">bottom</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;4d&quot;</span>

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

  <span class="nv">parseLegacy: </span><span class="o">-&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-8">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-8">&#182;</a>               </div>               <p>Font Information</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="nv">version = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="nx">assert</span> <span class="nx">version</span> <span class="o">is</span> <span class="mi">6</span></pre></div>             </td>           </tr>                               <tr id="section-9">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-9">&#182;</a>               </div>               <p>Count of faces</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.facesCount = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="vi">@data.face = </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">@data</span><span class="p">.</span><span class="nx">facesCount</span><span class="p">]</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">mark = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">fontType = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">fontName = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readLengthWithString</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">fontFamilyName = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readLengthWithString</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">fontStyleName = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readLengthWithString</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">script = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>

      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">numberAxesVector = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">vector = </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">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">numberAxesVector</span><span class="p">]</span>
        <span class="nx">@data</span><span class="p">.</span><span class="nx">face</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nx">vector</span><span class="p">[</span><span class="nx">j</span><span class="p">]</span> <span class="o">=</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-10">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-10">&#182;</a>               </div>               <p>Style Information</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.stylesCount = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="vi">@data.style = </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">@data</span><span class="p">.</span><span class="nx">stylesCount</span><span class="p">]</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">mark = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">faceMark = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">size = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">tracking = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">kerning = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">leading = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">baseShift = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">autoKern = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-11">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-11">&#182;</a>               </div>               <p>Only present in version &lt;= 5</p>             </td>             <td class="code">               <div class="highlight"><pre>      <span class="nx">@file</span><span class="p">.</span><span class="nx">read</span> <span class="mi">1</span>

      <span class="nx">@data</span><span class="p">.</span><span class="nx">style</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">rotate = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-12">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-12">&#182;</a>               </div>               <p>Text Information</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.type = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="vi">@data.scalingFactor = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="vi">@data.sharacterCount = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="vi">@data.horzPlace = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="vi">@data.vertPlace = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="vi">@data.selectStart = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    <span class="vi">@data.selectEnd = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
    
    <span class="vi">@data.linesCount = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
    <span class="vi">@data.line = </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">@data</span><span class="p">.</span><span class="nx">linesCount</span><span class="p">]</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">line</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">charCount = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">line</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">orientation = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">line</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">alignment = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">line</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">actualChar = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readShortInt</span><span class="p">()</span>
      <span class="nx">@data</span><span class="p">.</span><span class="nx">line</span><span class="p">[</span><span class="nx">i</span><span class="p">].</span><span class="nv">style = </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-13">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-13">&#182;</a>               </div>               <p>Color Information</p>             </td>             <td class="code">               <div class="highlight"><pre>    <span class="vi">@data.color = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readSpaceColor</span><span class="p">()</span>
    <span class="vi">@data.antialias = </span><span class="nx">@file</span><span class="p">.</span><span class="nx">readBoolean</span><span class="p">()</span>

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

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