psd

Version:

A general purpose Photoshop file parser.

80 lines (70 loc) • 19.6 kB

HTML

<!DOCTYPE html><html><head><title>lazy_execute.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 …<div id="jump_wrapper"><div id="jump_page"><a href="../../index.html" class="source">README</a><a href="../../lib/psd/blend_mode.coffee.html" class="source ">lib / psd / blend_mode.coffee</a><a href="../../lib/psd/channel_image.coffee.html" class="source ">lib / psd / channel_image.coffee</a><a href="../../lib/psd/color.coffee.html" class="source ">lib / psd / color.coffee</a><a href="../../lib/psd/descriptor.coffee.html" class="source ">lib / psd / descriptor.coffee</a><a href="../../lib/psd/file.coffee.html" class="source ">lib / psd / file.coffee</a><a href="../../lib/psd/header.coffee.html" class="source ">lib / psd / header.coffee</a><a href="../../lib/psd/image.coffee.html" class="source ">lib / psd / image.coffee</a><a href="../../lib/psd/image_export.coffee.html" class="source ">lib / psd / image_export.coffee</a><a href="../../lib/psd/image_exports/png.coffee.html" class="source ">lib / psd / image_exports / png.coffee</a><a href="../../lib/psd/image_format.coffee.html" class="source ">lib / psd / image_format.coffee</a><a href="../../lib/psd/image_formats/layer_raw.coffee.html" class="source ">lib / psd / image_formats / layer_raw.coffee</a><a href="../../lib/psd/image_formats/layer_rle.coffee.html" class="source ">lib / psd / image_formats / layer_rle.coffee</a><a href="../../lib/psd/image_formats/raw.coffee.html" class="source ">lib / psd / image_formats / raw.coffee</a><a href="../../lib/psd/image_formats/rle.coffee.html" class="source ">lib / psd / image_formats / rle.coffee</a><a href="../../lib/psd/image_mode.coffee.html" class="source ">lib / psd / image_mode.coffee</a><a href="../../lib/psd/image_modes/cmyk.coffee.html" class="source ">lib / psd / image_modes / cmyk.coffee</a><a href="../../lib/psd/image_modes/greyscale.coffee.html" class="source ">lib / psd / image_modes / greyscale.coffee</a><a href="../../lib/psd/image_modes/rgb.coffee.html" class="source ">lib / psd / image_modes / rgb.coffee</a><a href="../../lib/psd/init.coffee.html" class="source ">lib / psd / init.coffee</a><a href="../../lib/psd/layer/blend_modes.coffee.html" class="source ">lib / psd / layer / blend_modes.coffee</a><a href="../../lib/psd/layer/blending_ranges.coffee.html" class="source ">lib / psd / layer / blending_ranges.coffee</a><a href="../../lib/psd/layer/channel_image.coffee.html" class="source ">lib / psd / layer / channel_image.coffee</a><a href="../../lib/psd/layer/helpers.coffee.html" class="source ">lib / psd / layer / helpers.coffee</a><a href="../../lib/psd/layer/info.coffee.html" class="source ">lib / psd / layer / info.coffee</a><a href="../../lib/psd/layer/mask.coffee.html" class="source ">lib / psd / layer / mask.coffee</a><a href="../../lib/psd/layer/name.coffee.html" class="source ">lib / psd / layer / name.coffee</a><a href="../../lib/psd/layer/position_channels.coffee.html" class="source ">lib / psd / layer / position_channels.coffee</a><a href="../../lib/psd/layer.coffee.html" class="source ">lib / psd / layer.coffee</a><a href="../../lib/psd/layer_info/blend_clipping_elements.coffee.html" class="source ">lib / psd / layer_info / blend_clipping_elements.coffee</a><a href="../../lib/psd/layer_info/blend_interior_elements.coffee.html" class="source ">lib / psd / layer_info / blend_interior_elements.coffee</a><a href="../../lib/psd/layer_info/fill_opacity.coffee.html" class="source ">lib / psd / layer_info / fill_opacity.coffee</a><a href="../../lib/psd/layer_info/gradient_fill.coffee.html" class="source ">lib / psd / layer_info / gradient_fill.coffee</a><a href="../../lib/psd/layer_info/layer_id.coffee.html" class="source ">lib / psd / layer_info / layer_id.coffee</a><a href="../../lib/psd/layer_info/layer_name_source.coffee.html" class="source ">lib / psd / layer_info / layer_name_source.coffee</a><a href="../../lib/psd/layer_info/legacy_typetool.coffee.html" class="source ">lib / psd / layer_info / legacy_typetool.coffee</a><a href="../../lib/psd/layer_info/locked.coffee.html" class="source ">lib / psd / layer_info / locked.coffee</a><a href="../../lib/psd/layer_info/metadata.coffee.html" class="source ">lib / psd / layer_info / metadata.coffee</a><a href="../../lib/psd/layer_info/nested_section_divider.coffee.html" class="source ">lib / psd / layer_info / nested_section_divider.coffee</a><a href="../../lib/psd/layer_info/object_effects.coffee.html" class="source ">lib / psd / layer_info / object_effects.coffee</a><a href="../../lib/psd/layer_info/section_divider.coffee.html" class="source ">lib / psd / layer_info / section_divider.coffee</a><a href="../../lib/psd/layer_info/solid_color.coffee.html" class="source ">lib / psd / layer_info / solid_color.coffee</a><a href="../../lib/psd/layer_info/typetool.coffee.html" class="source ">lib / psd / layer_info / typetool.coffee</a><a href="../../lib/psd/layer_info/unicode_name.coffee.html" class="source ">lib / psd / layer_info / unicode_name.coffee</a><a href="../../lib/psd/layer_info/vector_mask.coffee.html" class="source ">lib / psd / layer_info / vector_mask.coffee</a><a href="../../lib/psd/layer_info/vector_origination.coffee.html" class="source ">lib / psd / layer_info / vector_origination.coffee</a><a href="../../lib/psd/layer_info/vector_stroke.coffee.html" class="source ">lib / psd / layer_info / vector_stroke.coffee</a><a href="../../lib/psd/layer_info/vector_stroke_content.coffee.html" class="source ">lib / psd / layer_info / vector_stroke_content.coffee</a><a href="../../lib/psd/layer_info.coffee.html" class="source ">lib / psd / layer_info.coffee</a><a href="../../lib/psd/layer_mask.coffee.html" class="source ">lib / psd / layer_mask.coffee</a><a href="../../lib/psd/lazy_execute.coffee.html" class="source selected">lib / psd / lazy_execute.coffee</a><a href="../../lib/psd/mask.coffee.html" class="source ">lib / psd / mask.coffee</a><a href="../../lib/psd/node.coffee.html" class="source ">lib / psd / node.coffee</a><a href="../../lib/psd/nodes/ancestry.coffee.html" class="source ">lib / psd / nodes / ancestry.coffee</a><a href="../../lib/psd/nodes/build_preview.coffee.html" class="source ">lib / psd / nodes / build_preview.coffee</a><a href="../../lib/psd/nodes/group.coffee.html" class="source ">lib / psd / nodes / group.coffee</a><a href="../../lib/psd/nodes/layer.coffee.html" class="source ">lib / psd / nodes / layer.coffee</a><a href="../../lib/psd/nodes/root.coffee.html" class="source ">lib / psd / nodes / root.coffee</a><a href="../../lib/psd/nodes/search.coffee.html" class="source ">lib / psd / nodes / search.coffee</a><a href="../../lib/psd/path_record.coffee.html" class="source ">lib / psd / path_record.coffee</a><a href="../../lib/psd/resource.coffee.html" class="source ">lib / psd / resource.coffee</a><a href="../../lib/psd/resource_section.coffee.html" class="source ">lib / psd / resource_section.coffee</a><a href="../../lib/psd/resources/layer_comps.coffee.html" class="source ">lib / psd / resources / layer_comps.coffee</a><a href="../../lib/psd/resources.coffee.html" class="source ">lib / psd / resources.coffee</a><a href="../../lib/psd/util.coffee.html" class="source ">lib / psd / util.coffee</a><a href="../../lib/psd.coffee.html" class="source ">lib / psd.coffee</a><a href="../../shims/init.coffee.html" class="source ">shims / init.coffee</a><a href="../../shims/png.coffee.html" class="source ">shims / png.coffee</a></div></div></div><table cellpadding="0" cellspacing="0"><thead><tr><th class="docs"><h1>lazy_execute.coffee</h1><div class="filepath">lib/psd/</div></th><th class="code"></th></tr></thead><tbody><tr id="section-1"><td class="docs"><div class="pilwrap"><a href="#section-1" class="pilcrow">¶</a></div>LazyExecute is very important when it comes to speed. Because some PSD documents can be extremely large and hold a LOT of data, we can significantly speed up parsing by temporarily skipping over chunks of the PSD. Chances are that you aren't going to use every piece of data in the document. This means, when you do request some data that's proxied through LazyExecute, we can parse it on the fly. This overhead should be incredibly minimal. While not as elegant as the PSD.rb counterpart, it gets the job done. We look at the object we need to proxy, and define proxies for every item on its prototype on this one. The proxy checks to see if the object has been loaded first before passing on the call to the object. If the object has not been loaded yet, we record our current position in the file, jump to the known start position of the data, parse it by calling a set method on the object, jump back to the original position in the file, and then call the proxied property. <h2 id="example">Example</h2> <pre><code class="lang-coffeescript">obj = new SomeObject() data = new LazyExecute(obj, file) .now('skip') .later('parse') .ignore('foo', 'bar') .get() </code></pre> </td><td class="code"><div class="highlight"><pre>module.exports = class LazyExecute constructor: (@obj, @file) -> @startPos = @file.tell() @loaded = false @loadMethod = null @loadArgs = [] @passthru = []</pre></div></td></tr><tr id="section-2"><td class="docs"><div class="pilwrap"><a href="#section-2" class="pilcrow">¶</a></div>This describes the method that we want to run at object instantiation. Typically this will skip over the data that we will parse on-demand later. We can pass any arguments we want to the method as well. </td><td class="code"><div class="highlight"><pre> now: (method, args...) -> @obj[method].apply(@obj, args) return @</pre></div></td></tr><tr id="section-3"><td class="docs"><div class="pilwrap"><a href="#section-3" class="pilcrow">¶</a></div>Here we describe the method we want to run when the first method/property on the object is accessed. We can also define any arguments that need to be passed to the function. </td><td class="code"><div class="highlight"><pre> later: (method, args...) -> @loadMethod = method @loadArgs = args return @</pre></div></td></tr><tr id="section-4"><td class="docs"><div class="pilwrap"><a href="#section-4" class="pilcrow">¶</a></div>Sometimes we don't have to parse the data in order to get some important information. For example, we can get the widht/height from the full preview image without parsing the image itself, since that data comes from the header. Purely convenience, but helps to optimize usage. The arguments are a list of method/property names we don't want to trigger on-demand parsing. </td><td class="code"><div class="highlight"><pre> ignore: (args...) -> @passthru.concat args return @</pre></div></td></tr><tr id="section-5"><td class="docs"><div class="pilwrap"><a href="#section-5" class="pilcrow">¶</a></div>This is called once all of the paramters of the proxy have been set up, i.e. now, later, and skip. This defines all items on the proxied objects prototype on this object, and checks to make sure the proxied object has been loaded before passing on the call. </td><td class="code"><div class="highlight"><pre> get: -> for key, val of @obj then do (key, val) => return if @[key]? Object.defineProperty @, key, get: -> @load() if not @loaded and not (key in @passthru) @obj[key] @</pre></div></td></tr><tr id="section-6"><td class="docs"><div class="pilwrap"><a href="#section-6" class="pilcrow">¶</a></div>If we are accessing a property for the first time, then this will call the load method, which was defined during setup with <code>later()</code>. The steps this performs are: <ol> <li>Records the current file position.</li> <li>Jumps to the recorded start position for the proxied data.</li> <li>Calls the load method, which was defined with <code>later()</code>.</li> <li>Jumps back to the original file position.</li> <li>Sets the <code>@loaded</code> flag to true so we know this object has been parsed.</li> </ol> </td><td class="code"><div class="highlight"><pre> load: -> origPos = @file.tell() @file.seek @startPos @obj[@loadMethod].apply(@obj, @loadArgs) @file.seek origPos @loaded = true </pre></div></td></tr></tbody></table><div id="generated">generated Tue May 12 2015 11:08:14 GMT-0400 (EDT) </div></div></body></html>