[gimp] Bug 304399 – Color Palette Export to TXT, CSS, XML, or XHTML
- From: Martin Nordholts <martinn src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gimp] Bug 304399 – Color Palette Export to TXT, CSS, XML, or XHTML
- Date: Sun, 2 Aug 2009 13:09:25 +0000 (UTC)
commit e7e5a6d19d100ac1b4a70ac6446e00712538a2a3
Author: Barak Itkin <lightningismyname gmail com>
Date: Sun Aug 2 15:30:57 2009 +0300
Bug 304399 â?? Color Palette Export to TXT, CSS, XML, or XHTML
Add a palette export script which allows exporting palettes to .css,
.php, .py, .txt and .java by adding a Export to menu item in the
palette context menu in the Palettes dockable.
plug-ins/script-fu/scripts/Makefile.am | 1 +
plug-ins/script-fu/scripts/palette-export.scm | 432 +++++++++++++++++++++++++
2 files changed, 433 insertions(+), 0 deletions(-)
---
diff --git a/plug-ins/script-fu/scripts/Makefile.am b/plug-ins/script-fu/scripts/Makefile.am
index 9de6f4c..2c85487 100644
--- a/plug-ins/script-fu/scripts/Makefile.am
+++ b/plug-ins/script-fu/scripts/Makefile.am
@@ -72,6 +72,7 @@ scripts = \
neon-logo.scm \
news-text.scm \
old-photo.scm \
+ palette-export.scm \
paste-as-brush.scm \
paste-as-pattern.scm \
perspective-shadow.scm \
diff --git a/plug-ins/script-fu/scripts/palette-export.scm b/plug-ins/script-fu/scripts/palette-export.scm
new file mode 100644
index 0000000..22700dd
--- /dev/null
+++ b/plug-ins/script-fu/scripts/palette-export.scm
@@ -0,0 +1,432 @@
+; ----------------------------------------------------------------------------------------------------
+; GIMP palette export toolkit - Written by Barak Itkin <lightningismyname gmail com>
+;
+; This script includes various exporters for gimp palettes, and other utility function to help in
+; exporting to other (text-based) formats.
+; See instruction on adding new exporters at the end
+; ----------------------------------------------------------------------------------------------------
+; Changelog:
+; July 23rd, 2009 - Version 1.1
+; Removed the palette choose box - the script will now export the active palette.
+; This was done because, this script should usually be invoked by a right click on a
+; palette, and it's confusing to have to choose a palette again.
+; Renamed the default palette name to "palette.ext"
+; Shortened long lines (320 charcters =D)
+;
+; See http://bugzilla.gnome.org/show_bug.cgi?id=304399#c19
+;
+; May 15th, 2009 - Version 1.0
+; Basic framework for exporting palettes.
+; The default exporters are java, css, text, python and php
+;
+; See http://bugzilla.gnome.org/show_bug.cgi?id=304399#c16
+; ----------------------------------------------------------------------------------------------------
+; Numbers and Math
+; ----------------------------------------------------------------------------------------------------
+
+; For all the opertations below, this is the order of respectable digits:
+(define conversion-digits (list "0" "1" "2" "3" "4" "5" "6" "7" "8" "9"
+ "a" "b" "c" "d" "e" "f" "g" "h" "i" "j" "k" "l" "m" "n" "o" "p" "q"
+ "r" "s" "t" "u" "v" "w" "x" "y" "z"))
+
+; Converts a decimal number to another base. The returned number is a string
+(define (convert-decimal-to-base num base)
+ (define (highest-order num base)
+ (if (and (<= 0 num) (< num base))
+ 0
+ (+ 1 (highest-order (quotient num base) base))
+ )
+ )
+ (define (calc base num str)
+ (let ((max-order (highest-order num base)))
+ (cond ((not (= 0 max-order))
+ (let ((num-of-times (quotient num (inexact->exact (expt base max-order)))))
+ (calc base
+ (- num (* num-of-times (expt base max-order)))
+ (string-append str (list-ref conversion-digits num-of-times)))
+ )
+ )
+ (else (string-append str (list-ref conversion-digits num)))
+ ))
+ )
+ (calc base num "")
+ )
+
+; Convert a string representation of a number in some base, to a decimal number
+(define (convert-base-to-decimal base num-str)
+ (define (convert-char num-char)
+ (if (char-numeric? num-char)
+ (string->number (string num-char))
+ (+ 10 (- (char->integer num-char) (char->integer #\a)))
+ )
+ )
+ (define (calc base num-str num)
+ (if (equal? num-str "")
+ num
+ (calc base
+ (substring num-str 1)
+ (+ (* num base) (convert-char (string-ref num-str 0)))
+ )
+ )
+ )
+ (calc base num-str 0)
+ )
+
+; If a string num-str is shorter then size, pad it with pad-str in the begining untill it's at least
+; size long
+(define (pre-pad-number num-str size pad-str)
+ (if (< (string-length num-str) size)
+ (pre-pad-number (string-append pad-str num-str) size pad-str)
+ num-str
+ )
+ )
+
+; ----------------------------------------------------------------------------------------------------
+; Color convertors
+; ----------------------------------------------------------------------------------------------------
+
+; The standard way for representing a color would be a list of red green and blue (gimp's default)
+(define color-get-red car)
+(define color-get-green cadr)
+(define color-get-blue caddr)
+
+; Convert a color to a hexadecimal string
+; '(255 255 255) => "#ffffff"
+
+(define (color-rgb-to-hexa-decimal color)
+ (string-append "#"
+ (pre-pad-number (convert-decimal-to-base (color-get-red color) 16) 2 "0")
+ (pre-pad-number (convert-decimal-to-base (color-get-green color) 16) 2 "0")
+ (pre-pad-number (convert-decimal-to-base (color-get-blue color) 16) 2 "0")
+ )
+ )
+
+; Convert a color to a css color
+; '(255 255 255) => "rgb(255, 255, 255)"
+(define (color-rgb-to-css color)
+ (string-append "rgb(" (number->string (color-get-red color))
+ ", " (number->string (color-get-green color))
+ ", " (number->string (color-get-blue color)) ")")
+ )
+
+; Convert a color to a simple pair of braces with comma seperated values
+; '(255 255 255) => "(255, 255, 255)"
+(define (color-rgb-to-comma-seperated-list color)
+ (string-append "(" (number->string (color-get-red color))
+ ", " (number->string (color-get-green color))
+ ", " (number->string (color-get-blue color)) ")")
+ )
+
+
+; ----------------------------------------------------------------------------------------------------
+; Export utils
+; ----------------------------------------------------------------------------------------------------
+
+; List of charcters that should not appear in file names
+(define illegal-file-name-chars (list #\\ #\/ #\: #\* #\? #\" #\< #\> #\|))
+
+; A function to filter a list lst by a given predicate pred
+(define (filter pred lst)
+ (if (null? lst)
+ '()
+ (if (pred (car lst))
+ (cons (car lst) (filter pred (cdr lst)))
+ (filter pred (cdr lst))
+ )
+ )
+ )
+
+; A function to check if a certain value obj is inside a list lst
+(define (contained? obj lst) (member obj lst))
+
+; This functions filters a string to have only characters which are either alpha-numeric or contained
+; in more-legal (which is a variable holding a list of characters)
+(define (clean str more-legal)
+ (list->string (filter (lambda (ch) (or (char-alphabetic? ch)
+ (char-numeric? ch)
+ (contained? ch more-legal)))
+ (string->list str)))
+ )
+
+; A function that recieves the a file-name, and filters out all the character that shouldn't appear
+; in file names. Then, it makes sure the remaining name isn't only white-spaces. If it's only
+; white-spaces, the function returns false. Otherwise, it returns the fixed file-name
+(define (valid-file-name name)
+ (let* ((clean (list->string (filter (lambda (ch) (not (contained? ch illegal-file-name-chars)))
+ (string->list name))))
+ (clean-without-spaces (list->string (filter (lambda (ch) (not (char-whitespace? ch)))
+ (string->list clean))))
+ )
+ (if (equal? clean-without-spaces "")
+ #f
+ clean
+ )
+ )
+ )
+
+; Filters a string from all the characters which are not alpha-numeric (this also removes whitespaces)
+(define (name-alpha-numeric str)
+ (clean str '())
+ )
+
+; This function does the same as name-alpha-numeric, with an added operation - it removes
+; any numbers from the begining
+(define (name-standard str)
+ (let ((cleaned (clean str '())))
+ (while (char-numeric? (string-ref cleaned 0))
+ (set! cleaned (substring cleaned 1))
+ )
+ cleaned
+ )
+ )
+
+(define name-no-conversion (lambda (obj) obj))
+(define color-none (lambda (x) ""))
+(define name-none (lambda (x) ""))
+
+(define displayln (lambda (obj) (display obj) (display "\n")))
+
+; The loop for exporting all the colors
+(define (export-palette palette-name color-convertor name-convertor
+ start name-pre name-after name-color-seperator
+ color-pre color-after entry-seperator end)
+
+ (define (write-color-line index)
+ (display name-pre)
+ (display (name-convertor (car (gimp-palette-entry-get-name palette-name index))))
+ (display name-after)
+ (display name-color-seperator)
+ (display color-pre)
+ (display (color-convertor (car (gimp-palette-entry-get-color palette-name index))))
+ (display color-after)
+ )
+
+ (let ((color-count (car (gimp-palette-get-colors palette-name)))
+ (i 0)
+ )
+
+ (display start)
+
+ (while (< i (- color-count 1))
+ (begin
+ (write-color-line i)
+ (display entry-seperator)
+ (set! i (+ 1 i))
+ )
+ )
+
+ (write-color-line i)
+ (display end)
+ )
+ )
+
+(define (register-palette-exporter export-type file-type description author copyright date)
+ (script-fu-register (string-append "gimp-palette-export-" export-type)
+ (string-append export-type "...")
+ description
+ author
+ copyright
+ date
+ ""
+ SF-DIRNAME "Folder for the output file" ""
+ SF-STRING "The name of the file to create
+(If a file with this name already exist, it will be replaced)" (string-append "palette." file-type)
+ )
+ (script-fu-menu-register (string-append "gimp-palette-export-" export-type) "<Palettes>/Export as")
+ )
+
+(define (bad-file-name)
+ (gimp-message (string-append "The file name you entered is not a suitable name for a file name! \""
+ file-name "\" All the characters in the file name are either "
+ "white-spaces or characters which can not appear in file names (The"
+ "following characters can not appear in file names: "
+ (list->string illegal-file-name-chars) ")")))
+
+; ----------------------------------------------------------------------------------------------------
+; Exporters
+; ----------------------------------------------------------------------------------------------------
+; The typical look of an exporter would be like this (look at the bottom to see some examples):
+; (define (gimp-palette-export-my-export directory-name file-name palette-name)
+; (let ((valid-name (valid-file-name file-name)))
+; (if valid-name
+; (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+; (lambda ()
+; (export-palette (car (gimp-context-get-palette)) - The active palette (since this script
+; should be invoked by a right click on
+; a palette)
+; color-to-string-convertor - A function that recieves a color and
+; converts it to a string
+; name-convertor - A function that recieves the name of the color
+; from the palette, and alters it if necessary
+; start - A string to put before the loop of the colors
+; name-pre - A string to put before the name of each color
+; name-after - A string to put after the name of each color
+; name-color-seperator - A string to put between the name of the color
+; and the color itself
+; color-pre - A string to put before each color
+; color-after - A string to put after each color
+; entry-seperator - A string that should be put only between entries
+; end - A string to put when the loop has ended
+; )))
+; (bad-file-name)
+; )
+; )
+; )
+; (register-palette-exporter "my-export" ".filetype" description author copyright date)
+;
+; avaialable name conversions: name-alpha-numeric, name-standard, name-no-conversion, name-none, color-none
+; avaialable color conversions: color-rgb-to-hexa-decimal, color-rgb-to-css, color-rgb-to-comma-seperated-list
+;
+; You can also add more custom features with this toolkit, however then you will need to do some coding :)
+; For non-programmers who want to add exporters: \n means newline, \t means tab, (and for a normal \, you
+; must write \\)
+;
+; WARNING! If a procedure that writes a file from script-fu crashes, it will currupt the behaviour of the entire
+; script-fu system (you will have to restart gimp) so you must double-check that it can't get stuck!
+; If you are not sure what you are doing, use the template above or contact me by email (and I'll try to
+; help) <lightningismyname gmail com>
+
+(define (gimp-palette-export-css directory-name file-name)
+ (let ((valid-name (valid-file-name file-name)))
+ (if valid-name
+ (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+ (lambda () (export-palette (car (gimp-context-get-palette))
+ color-rgb-to-css
+ name-alpha-numeric ; name-convertor
+ "/* Generated with GIMP palette Export */\n" ; start
+ "." ; name-pre
+ "" ; name-after
+ " { " ; name-color-seperator
+ "color: " ; color-pre
+ " }" ; color-after
+ "\n" ; entry-seperator
+ "" ; end
+ )))
+ (bad-file-name)
+ )
+ )
+ )
+(register-palette-exporter "css" "css"
+ (string-append "Exports the active palette as a list css stylesheet with the colors "
+ "entry name as their class name, and the color itself as the color attribute")
+ "Barak Itkin <lightningismyname gmail com>" "Barak Itkin" "May 15th, 2009")
+
+(define (gimp-palette-export-php directory-name file-name)
+ (let ((valid-name (valid-file-name file-name)))
+ (if valid-name
+ (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+ (lambda () (export-palette (car (gimp-context-get-palette))
+ color-rgb-to-hexa-decimal
+ name-standard ; name-convertor
+ "<?php\n/* Generated with GIMP palette Export */\n$colors={\n" ; start
+ "'" ; name-pre
+ "'" ; name-after
+ " => " ; name-color-seperator
+ "'" ; color-pre
+ "'" ; color-after
+ ",\n" ; entry-seperator
+ "}\n?>" ; end
+ )))
+ (bad-file-name)
+ )
+ )
+ )
+(register-palette-exporter "php" "php"
+ "Exports the active palette as a php dictionary (name => color)"
+ "Barak Itkin <lightningismyname gmail com>" "Barak Itkin" "May 15th, 2009")
+
+(define (gimp-palette-export-python directory-name file-name)
+ (let ((valid-name (valid-file-name file-name)))
+ (if valid-name
+ (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+ (lambda ()
+ (let ((palette-name (car (gimp-context-get-palette))))
+ (begin (displayln "# Generated with GIMP palette Export")
+ (displayln (string-append "# Based on the palette " palette-name))
+ (export-palette palette-name
+ color-rgb-to-hexa-decimal
+ name-standard ; name-convertor
+ "colors={\n" ; start
+ "'" ; name-pre
+ "'" ; name-after
+ ": " ; name-color-seperator
+ "'" ; color-pre
+ "'" ; color-after
+ ",\n" ; entry-seperator
+ "}" ; end
+ ))))
+ )
+ (bad-file-name)
+ )
+ )
+ )
+(register-palette-exporter "python" "py"
+ "Exports the active palette as a python dictionary (name: color)"
+ "Barak Itkin <lightningismyname gmail com>" "Barak Itkin" "May 15th, 2009")
+
+(define (gimp-palette-export-text directory-name file-name)
+ (let ((valid-name (valid-file-name file-name)))
+ (if valid-name
+ (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+ (lambda ()
+ (export-palette (car (gimp-context-get-palette))
+ color-rgb-to-hexa-decimal
+ name-none ; name-convertor
+ "" ; start
+ "" ; name-pre
+ "" ; name-after
+ "" ; name-color-seperator
+ "" ; color-pre
+ "" ; color-after
+ "\n" ; entry-seperator
+ "" ; end
+ )
+ )
+ )
+ (bad-file-name)
+ )
+ )
+ )
+(register-palette-exporter "text" "txt"
+ "Write all the colors in a palette to a text file, one hexa-decimal value per line (no names)"
+ "Barak Itkin <lightningismyname gmail com>" "Barak Itkin" "May 15th, 2009")
+
+(define (gimp-palette-export-java directory-name file-name)
+ (let ((valid-name (valid-file-name file-name)))
+ (if valid-name
+ (with-output-to-file (string-append directory-name DIR-SEPARATOR file-name)
+ (lambda ()
+ (let ((palette-name (car (gimp-context-get-palette))))
+ (begin (displayln "")
+ (displayln "import java.awt.Color;")
+ (displayln "import java.util.Hashtable;")
+ (displayln "")
+ (displayln "// Generated with GIMP palette Export ")
+ (displayln (string-append "// Based on the palette " palette-name))
+ (displayln (string-append "public class " (name-standard palette-name) " {"))
+ (displayln "")
+ (displayln " Hashtable<String, Color> colors;")
+ (displayln "")
+ (displayln (string-append " public " (name-standard palette-name) "() {"))
+ (export-palette (car (gimp-context-get-palette))
+ color-rgb-to-comma-seperated-list
+ name-no-conversion
+ " colors = new Hashtable<String,Color>();\n" ; start
+ " colors.put(\"" ; name-pre
+ "\"" ; name-after
+ ", " ; name-color-seperator
+ "new Color" ; color-pre
+ ");" ; color-after
+ "\n" ; entry-seperator
+ "\n }" ; end
+ )
+ (display "\n}"))))
+ )
+ (bad-file-name)
+ )
+ )
+ )
+
+(register-palette-exporter "java" "java"
+ "Exports the active palette as a java.util.Hashtable<String, Color>"
+ "Barak Itkin <lightningismyname gmail com>" "Barak Itkin" "May 15th, 2009")
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
