spencer/ps
1
0
Fork 0
mirror of https://github.com/sbrow/ps.git synced 2025-12-29 18:47:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
Unknown
2018-04-24 21:11:34 -04:00
parent 1c5764282e
commit f92bb18c30
4 changed files with 47 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Variables.go
View File

@@ -4,6 +4,7 @@ import (
"fmt" "fmt"
) )
// Colors enumerates some basic, commonly used colors.
var Colors map[string]Color = map[string]Color{ var Colors map[string]Color = map[string]Color{
"Black": &RGB{0, 0, 0}, "Black": &RGB{0, 0, 0},
"Gray": &RGB{128, 128, 128}, "Gray": &RGB{128, 128, 128},
@@ -11,19 +12,27 @@ var Colors map[string]Color = map[string]Color{
} }
// ModeEnum determines how aggressively the package will attempt to sync with Photoshop. // ModeEnum determines how aggressively the package will attempt to sync with Photoshop.
// Loading Photoshop files from scratch takes a long time, so the package saves
// the state of the document in a JSON file in the /data folder whenever you call
// Document.Dump(). ModeEnum tells the program how trustworthy that file is.
type ModeEnum int type ModeEnum int
// Holds the current mode. // Holds the current mode.
var Mode ModeEnum var Mode ModeEnum
// Fast mode never checks layers before returning. // Fast mode skips all verification. Use Fast mode only when certain that the
// .psd file hasn't changed since the last time Document.Dump() was called.
const Fast ModeEnum = 2 const Fast ModeEnum = 2
// Normal Mode Always checks to see if layers are up to date // Normal Mode only verifies layers as they are operated on. The first time a
// before returning them. // layer's properties would be checked, it first overwrites the data from the
// Dump with data pulled directly from Photoshop. This allows you to quickly
// load documents in their current form.
const Normal ModeEnum = 0 const Normal ModeEnum = 0
// Safe Mode Always loads the document from scratch. (Very Slow) // Safe Mode always loads the document from scratch, ignoring any dumped data.
// (Very Slow). If a function panics due to outdated data, often times re-running
// the function in safe mode is enough to re-mediate it.
const Safe ModeEnum = 1 const Safe ModeEnum = 1
// PSSaveOptions is an enum for options when closing a document. // PSSaveOptions is an enum for options when closing a document.

4
colors.go
View File

@@ -26,7 +26,7 @@ func Compare(a, b Color) Color {
return b return b
} }
// RGB is a color in RGB format. It fulfills the Color interface. // RGB is a color in RGB format. It implements the Color interface.
type RGB struct { type RGB struct {
Red int Red int
Green int Green int
@@ -43,7 +43,7 @@ func (r RGB) Hex() []uint8 {
return make([]uint8, 6) return make([]uint8, 6)
} }
// Hex is a color in hexadecimal format. It fulfills the Color interface. // Hex is a color in hexadecimal format. It implements the Color interface.
type Hex []uint8 type Hex []uint8
func (h Hex) RGB() [3]int { func (h Hex) RGB() [3]int {

48
ps.go
View File

@@ -1,9 +1,7 @@
// Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. // Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang.
// The interaction between the two is implemented using Javascript/VBScript.
// //
// Most of the interaction between the two is implemented via // Currently only supports Photoshop CS5 Windows x86_64.
// Javascript and/or VBS/Applescript.
//
// Currently only works with CS5 on Windows.
package ps package ps
import ( import (
@@ -19,8 +17,11 @@ import (
"strings" "strings"
) )
var Cmd string // The name of the program that runs scripts on this OS.
var Opts string var scmd string
// The options we need to pass to scmd.
var opts string
var pkgpath string var pkgpath string
func init() { func init() {
@@ -28,10 +29,10 @@ func init() {
pkgpath = filepath.Dir(file) pkgpath = filepath.Dir(file)
switch runtime.GOOS { switch runtime.GOOS {
case "windows": case "windows":
Cmd = "cscript.exe" scmd = "cscript.exe"
Opts = "/nologo" opts = "/nologo"
case "darwin": case "darwin":
Cmd = "osacript" scmd = "osacript"
} }
} }
@@ -41,7 +42,7 @@ func Start() error {
return err return err
} }
// Close closes the active document in Photoshop. // Close closes the active document in Photoshop, using the given save option.
func Close(save PSSaveOptions) error { func Close(save PSSaveOptions) error {
_, err := run("close", save.String()) _, err := run("close", save.String())
return err return err
@@ -49,7 +50,7 @@ func Close(save PSSaveOptions) error {
// Open opens a Photoshop document with the specified path. // Open opens a Photoshop document with the specified path.
// If Photoshop is not currently running, it is started before // If Photoshop is not currently running, it is started before
// opening the document // opening the document.
func Open(path string) error { func Open(path string) error {
_, err := run("open", path) _, err := run("open", path)
return err return err
@@ -68,8 +69,8 @@ func SaveAs(path string) error {
} }
// DoJs runs a Photoshop Javascript script file (.jsx) from the specified location. // DoJs runs a Photoshop Javascript script file (.jsx) from the specified location.
// It can't directly return output, so instead the scripts write their output to // It can't directly return output, so instead the script must write their output to
// a temporary file, whose contents is then read and returned. // a temporary file ($TEMP/js_out.txt), whose contents is then read and returned.
func DoJs(path string, args ...string) (out []byte, err error) { func DoJs(path string, args ...string) (out []byte, err error) {
// Temp file for js to output to. // Temp file for js to output to.
outpath := filepath.Join(os.Getenv("TEMP"), "js_out.txt") outpath := filepath.Join(os.Getenv("TEMP"), "js_out.txt")
@@ -100,7 +101,7 @@ func DoJs(path string, args ...string) (out []byte, err error) {
// signals that they are ready (by pushing enter). // signals that they are ready (by pushing enter).
// //
// Useful for when you need to do something by hand in the middle of an // Useful for when you need to do something by hand in the middle of an
// otherwise automated process. // otherwise automated process. (i.e. loading a dataset).
func Wait(msg string) { func Wait(msg string) {
fmt.Print(msg) fmt.Print(msg)
var input string var input string
@@ -125,14 +126,14 @@ func run(name string, args ...string) ([]byte, error) {
} }
if strings.Contains(name, "dojs") { if strings.Contains(name, "dojs") {
args = append([]string{Opts, filepath.Join(pkgpath, "scripts", name)}, args = append([]string{opts, filepath.Join(pkgpath, "scripts", name)},
args[0], args[0],
fmt.Sprintf("%s", strings.Join(args[1:], ",")), fmt.Sprintf("%s", strings.Join(args[1:], ",")),
) )
} else { } else {
args = append([]string{Opts, filepath.Join(pkgpath, "scripts", name)}, args...) args = append([]string{opts, filepath.Join(pkgpath, "scripts", name)}, args...)
} }
cmd := exec.Command(Cmd, args...) cmd := exec.Command(scmd, args...)
cmd.Stdout = &out cmd.Stdout = &out
cmd.Stderr = &errs cmd.Stderr = &errs
err := cmd.Run() err := cmd.Run()
@@ -142,7 +143,7 @@ func run(name string, args ...string) ([]byte, error) {
return out.Bytes(), nil return out.Bytes(), nil
} }
// DoAction runs the Photoshop action with name from set. // DoAction runs the Photoshop Action "name" from the Action Set "set".
func DoAction(set, name string) error { func DoAction(set, name string) error {
_, err := run("action", set, name) _, err := run("action", set, name)
return err return err
@@ -151,15 +152,18 @@ func DoAction(set, name string) error {
// ApplyDataset fills out a template file with information // ApplyDataset fills out a template file with information
// from a given dataset (csv) file. It is important to note that running this // from a given dataset (csv) file. It is important to note that running this
// function will change data in the Photoshop document, but will not update // function will change data in the Photoshop document, but will not update
// data in the Go Document struct (if any); you will have to implement syncing // data in the Go Document struct- you will have to implement syncing
// them yourself. // them yourself.
func ApplyDataset(name string) ([]byte, error) { func ApplyDataset(name string) error {
return DoJs("applyDataset.jsx", name) _, err := DoJs("applyDataset.jsx", name)
return err
} }
// JSLayer "compiles" Javascript code to get an ArtLayer with the given path. // JSLayer "compiles" Javascript code to get an ArtLayer with the given path.
// The output always ends with a semicolon, so if you want to access a specific // The output always ends with a semicolon, so if you want to access a specific
// property of the layer, you'll have to trim the output before concatenating // property of the layer, you'll have to trim the output before concatenating.
//
// TODO: get rid of the semicolon.
func JSLayer(path string, art ...bool) string { func JSLayer(path string, art ...bool) string {
path = strings.TrimLeft(path, "/") path = strings.TrimLeft(path, "/")
pth := strings.Split(path, "/") pth := strings.Split(path, "/")

10
structs.go
View File

@@ -179,7 +179,8 @@ func (d *Document) Dump() {
} }
// ArtLayer reflects certain values from an Art Layer in a Photoshop document. // ArtLayer reflects certain values from an Art Layer in a Photoshop document.
// TODO: Make TextLayer a subclass of ArtLayer //
// TODO: Make TextLayer a subclass of ArtLayer.
type ArtLayer struct { type ArtLayer struct {
name string // The layer's name. name string // The layer's name.
Text *string // The contents of a text layer. Text *string // The contents of a text layer.
@@ -219,7 +220,7 @@ func (a *ArtLayer) SetText(txt string) {
a.Refresh() a.Refresh()
} }
// MarshalJSON fulfills the json.Marshaler interface, allowing the ArtLayer to be // MarshalJSON implements the json.Marshaler interface, allowing the ArtLayer to be
// saved to disk in JSON format. // saved to disk in JSON format.
func (a *ArtLayer) MarshalJSON() ([]byte, error) { func (a *ArtLayer) MarshalJSON() ([]byte, error) {
// txt := strings.Replace(*a.Text, "\r", "\\r", -1) // txt := strings.Replace(*a.Text, "\r", "\\r", -1)
@@ -370,6 +371,7 @@ func (a *ArtLayer) Path() string {
return fmt.Sprintf("%s%s", a.parent.Path(), a.name) return fmt.Sprintf("%s%s", a.parent.Path(), a.name)
} }
// TODO: Documentation for Format()
func (a *ArtLayer) Format(start, end int, font, style string) { func (a *ArtLayer) Format(start, end int, font, style string) {
if !a.Visible() { if !a.Visible() {
return return
@@ -383,7 +385,7 @@ func (a *ArtLayer) Format(start, end int, font, style string) {
// Layer returns an ArtLayer from the active document given a specified // Layer returns an ArtLayer from the active document given a specified
// path string. // path string.
func Layer(path string) (ArtLayer, error) { func layer(path string) (ArtLayer, error) {
byt, err := DoJs("getLayer.jsx", JSLayer(path)) byt, err := DoJs("getLayer.jsx", JSLayer(path))
var out ArtLayer var out ArtLayer
err = json.Unmarshal(byt, &out) err = json.Unmarshal(byt, &out)
@@ -453,7 +455,7 @@ func (a *ArtLayer) SetPos(x, y int, bound string) {
} }
func (a *ArtLayer) Refresh() error { func (a *ArtLayer) Refresh() error {
tmp, err := Layer(a.Path()) tmp, err := layer(a.Path())
if err != nil { if err != nil {
return err return err
} }