psd

Version:

A general purpose Photoshop file parser.

71 lines (53 loc) • 20.3 kB

HTML

<!DOCTYPE html><html><head><title>header.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 selected">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 ">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>header.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> </td><td class="code"><div class="highlight"><pre>{Module} = require 'coffeescript-module'</pre></div></td></tr><tr id="section-2"><td class="docs"><div class="pilwrap"><a href="#section-2" class="pilcrow">¶</a></div>Represents the header of the PSD, which is the first thing always parsed. The header stores important information about the PSD such as the dimensions and the color depth. </td><td class="code"><div class="highlight"><pre>module.exports = class Header extends Module @aliasProperty 'height', 'rows' @aliasProperty 'width', 'cols'</pre></div></td></tr><tr id="section-3"><td class="docs"><div class="pilwrap"><a href="#section-3" class="pilcrow">¶</a></div>All of the color modes are stored internally as a short from 0-15. This is a mapping of that value to a human-readable name. </td><td class="code"><div class="highlight"><pre> MODES = [ 'Bitmap' 'GrayScale' 'IndexedColor' 'RGBColor' 'CMYKColor' 'HSLColor' 'HSBColor' 'Multichannel' 'Duotone' 'LabColor' 'Gray16' 'RGB48' 'Lab48' 'CMYK64' 'DeepMultichannel' 'Duotone16' ]</pre></div></td></tr><tr id="section-4"><td class="docs"><div class="pilwrap"><a href="#section-4" class="pilcrow">¶</a></div>The signature of the PSD. Should be 8BPS. </td><td class="code"><div class="highlight"><pre> sig: null</pre></div></td></tr><tr id="section-5"><td class="docs"><div class="pilwrap"><a href="#section-5" class="pilcrow">¶</a></div>The version of the PSD. Should be 1. </td><td class="code"><div class="highlight"><pre> version: null</pre></div></td></tr><tr id="section-6"><td class="docs"><div class="pilwrap"><a href="#section-6" class="pilcrow">¶</a></div>The number of color channels in the PSD. </td><td class="code"><div class="highlight"><pre> channels: null</pre></div></td></tr><tr id="section-7"><td class="docs"><div class="pilwrap"><a href="#section-7" class="pilcrow">¶</a></div>The height of the PSD. Can also be accessed with <code>height</code>. </td><td class="code"><div class="highlight"><pre> rows: null</pre></div></td></tr><tr id="section-8"><td class="docs"><div class="pilwrap"><a href="#section-8" class="pilcrow">¶</a></div>The width of the PSD. Can also be accessed with <code>width</code>. </td><td class="code"><div class="highlight"><pre> cols: null</pre></div></td></tr><tr id="section-9"><td class="docs"><div class="pilwrap"><a href="#section-9" class="pilcrow">¶</a></div>The bit depth of the PSD. </td><td class="code"><div class="highlight"><pre> depth: null</pre></div></td></tr><tr id="section-10"><td class="docs"><div class="pilwrap"><a href="#section-10" class="pilcrow">¶</a></div>The color mode of the PSD. </td><td class="code"><div class="highlight"><pre> mode: null</pre></div></td></tr><tr id="section-11"><td class="docs"><div class="pilwrap"><a href="#section-11" class="pilcrow">¶</a></div>Creates a new Header. @param [File] file The PSD file. </td><td class="code"><div class="highlight"><pre> constructor: (@file) -></pre></div></td></tr><tr id="section-12"><td class="docs"><div class="pilwrap"><a href="#section-12" class="pilcrow">¶</a></div>Parses the header data. </td><td class="code"><div class="highlight"><pre> parse: -> @sig = @file.readString(4) @version = @file.readUShort() @file.seek 6, true @channels = @file.readUShort() @rows = @height = @file.readUInt() @cols = @width = @file.readUInt() @depth = @file.readUShort() @mode = @file.readUShort() colorDataLen = @file.readUInt() @file.seek colorDataLen, true</pre></div></td></tr><tr id="section-13"><td class="docs"><div class="pilwrap"><a href="#section-13" class="pilcrow">¶</a></div>Converts the color mode key to a readable version. </td><td class="code"><div class="highlight"><pre> modeName: -> MODES[@mode]</pre></div></td></tr><tr id="section-14"><td class="docs"><div class="pilwrap"><a href="#section-14" class="pilcrow">¶</a></div>Exports all of the header data in a basic object. </td><td class="code"><div class="highlight"><pre> export: -> data = {} for key in ['sig', 'version', 'channels', 'rows', 'cols', 'depth', 'mode'] data[key] = @[key] data </pre></div></td></tr></tbody></table><div id="generated">generated Tue May 12 2015 11:08:10 GMT-0400 (EDT) </div></div></body></html>