python-fu-dump / dump.py

  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
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
from gimpfu import *
from string import Template
import gtk
import os
import collections
import ctypes
import unicodedata
import re
import pprint

PROC_CSS = """html, body
{
        width:100%;
        height:100%;
        margin:0px;
}

body
{
        width:578px;
        margin:24px auto 0px 36px;
}

p, table
{
        margin:0px 0px 0px 12px;
}

nav
{
        display:block;
        margin-bottom:6px;
        text-align:center;
}

h1
{
        margin-top:0px;
}

h1, h4
{
        margin-bottom:0px;
}

div#author
{
        text-align:right;
        font-style:italic;
}

span.date
{
        font:bold 14px Monospace,small-caps;
}

table
{
        font-family:'Trebuchet MS', Arial, Helvetica, sans-serif;
        width:100%;
        border-collapse:collapse;
}

table td, table th 
{
        font-size:1em;
        border:1px solid SlateGray;
        padding:3px 7px 2px 7px;
}

table th
{
        font-size:1.1em;
        text-align:left;
        padding-top:5px;
        padding-bottom:4px;
        background-color:LightSlateGray;
        color:#ffffff;
}

table tr.alt td 
{
        color:#000000;
        background-color:#C9CFD6;
}
"""
PROC_HTML = """<!DOCTYPE html>
<html>
        <head>
                <title>pdb: ${proc_name}</title>

                <meta name="description" content="${proc_blurb}">
                <meta name="author" content="Code Fox">
                <meta charset="UTF-8">

                <link rel="stylesheet" type="text/css" href="proc.css">
        </head>
        <body>
                <div style="display:inline-block;">
                        <h1>
                                ${proc_name}
                        </h1>
                        <div id="author">
                                ${proc_author}
                        </div>
                </div>
                <hr style="margin-bottom:0px;"/>
                <nav>
                        <a href="${prev_link}" style="float:left;">previous</a>
                        <a href="${index_link}">index</a>
                        <a href="${next_link}" style="float:right;">next</a>
                </nav>
                <p id="copyright" style="margin:0">
                        <span class="date">${proc_date}</span><br>
                        ${proc_copyright}
                </p>
                <h4>Description</h4>
                <p id="description">
                        ${proc_blurb}
                </p>
                <h4>Help</h4>
                <p id="help">
                        ${proc_help}
                </p>
                <hr />
                <h4>Type</h4>
                <p id="type">
                        ${proc_type}
                </p>
                <h4>Parameters</h4>
                <table id="parameters">
                        <thead>
                                <tr>
                                        <th>Type</th>
                                        <th>Name</th>
                                        <th>Description</th>
                                </tr>
                        </thead>
                        <tbody>
                                ${parameters}
                        </tbody>
                </table>
                <h4>Return</h4>
                <table id="return">
                        <thead>
                                <tr>
                                        <th>type</th>
                                        <th>name</th>
                                        <th>description</th>
                                </tr>
                        </thead>
                        <tbody>
                                ${results}
                        </tbody>
                </table>
                <hr style="margin-bottom:0px;" />
                <nav>
                        <a href="${index_link}" style="width:100%; text-align:center;">index</a>
                </nav>
        </body>
</html>
"""
TR_HTML = """
                                <tr ${class}>
                                        <td>
                                                ${type}
                                        </td>
                                        <td>
                                                ${name}
                                        </td>
                                        <td>
                                                ${desc}
                                        </td>
                                </tr>

"""
INDEX_TEMPLATE = """
"""

def escape(html):
    """
    Returns the given HTML with ampersands, quotes and angle brackets encoded.

    Based on code in: Django
    """
    html = force_unicode(html)
    html = html.replace('&', '&amp;')
    html = html.replace('<', '&lt;')
    html = html.replace('>', '&gt;')
    html = html.replace('"', '&quot;')
    html = html.replace("'", '&#39;')

    return html

def slugify(value):
    """
    Normalizes string, converts to lowercase, removes non-alpha characters,
    and converts spaces to hyphens.

    Based on code in: Django
    """
    value = unicodedata.normalize('NFKD', unicode(value))
    value = value.encode('ascii', 'ignore')
    value = re.sub('[^\w\s-]', '', value).strip().lower()
    value = re.sub('[-\s]+', '-', value)
    return value

def get_dir() :
        MessageBox = ctypes.windll.user32.MessageBoxA
        response = ""

        # Check for new pygtk: this is new class in PyGtk 2.4
        if (gtk.pygtk_version < (2,3,90)) :
                MessageBox(None, "This plugin requires PyGtk 2.3.90 or later", "Error", 0)
                return response

        dialog = gtk.FileChooserDialog(
                "Dump to...",
                None,
                gtk.FILE_CHOOSER_ACTION_OPEN,
                (
                        gtk.STOCK_CANCEL,
                        gtk.RESPONSE_CANCEL,
                        gtk.STOCK_OPEN,
                        gtk.RESPONSE_OK
                )
        )
        dialog.set_default_response(gtk.RESPONSE_OK)
        dialog.set_action(gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER)

        if (dialog.run() == gtk.RESPONSE_OK) :
                response = dialog.get_filename()
        dialog.destroy()

        return response

def prepare(root) :
        # create sub directory if it doesnt exist
        outDirectory = os.path.join(
                        root,
                        "pdb"
        )

        if not os.path.exists(outDirectory):
                os.makedirs(outDirectory)

        return outDirectory

def dump_css(outDirectory) :
        # write css file
        outFile = os.path.join(
                outDirectory,
                "proc.css"
        )

        with open(outFile,'w') as f:
                f.write(PROC_CSS)

        return None

def var_type_str(t) :

        if (PF_INT8 == t) :
                return "PF_INT8"
        if (PF_INT16 == t) :
                return "PF_INT16"
        if (PF_INT32 == t) :
                return "PF_INT32"
        if (PF_INT == t) :
                return "PF_INT"
        if (PF_FLOAT == t) :
                return "PF_FLOAT"
        if (PF_STRING == t) :
                return "PF_STRING"
        if (PF_VALUE == t) :
                return "PF_VALUE"
        if (PF_COLOR == t) :
                return "PF_COLOR"
        if (PF_COLOUR == t) :
                return "PF_COLOUR"
        """
        in the documentation, but not defined in gimpfu
        if (PF_REGION == t) :
                return "PF_REGION"
        """
        if (PF_IMAGE == t) :
                return "PF_IMAGE"
        if (PF_LAYER == t) :
                return "PF_LAYER"
        if (PF_CHANNEL == t) :
                return "PF_CHANNEL"
        if (PF_DRAWABLE == t) :
                return "PF_DRAWABLE"
        if (PF_TOGGLE == t) :
                return "PF_TOGGLE"
        if (PF_BOOL == t) :
                return "PF_BOOL"
        if (PF_RADIO == t) :
                return "PF_RADIO"
        if (PF_SLIDER == t) :
                return "PF_SLIDER"
        if (PF_SPINNER == t) :
                return "PF_SPINNER"
        if (PF_ADJUSTMENT == t) :
                return "PF_ADJUSTMENT"
        if (PF_FONT == t) :
                return "PF_FONT"
        if (PF_FILE == t) :
                return "PF_FILE"
        if (PF_BRUSH == t) :
                return "PF_BRUSH"
        if (PF_PATTERN == t) :
                return "PF_PATTERN"
        if (PF_GRADIENT == t) :
                return "PF_GRADIENT"
        if (PF_PALETTE == t) :
                return "PF_PALETTE"

        return "unknown"

def proc_type_str(t) :
        if (PLUGIN == t) :
                return "PROC_PLUG_IN"
        if (EXTENSION == t) :
                return "PROC_EXTENSION"
        if (TEMPORARY == t) :
                return "PROC_TEMPORARY"

        return "unknown"

def dump_table(lst) :
        row = dict()
        html = ""
        alt = False
        for item in lst :
                row["class"] = ""
                if (True == alt) :
                        row["class"] = ' class="alt"'
                row["type"] = var_type_str(item[0])
                row["name"] = item[1]
                row["desc"] = item[2]

                html += Template(TR_HTML).safe_substitute(row)
                alt = not alt

        return html

def dump_proc(proc, outFile, mode, links) :
        d = dict()

        d["prev_link"] = links[0]
        d["index_link"] = links[1]
        d["next_link"] = links[2]

        d["proc_name"] = proc.proc_name
        d["proc_author"] = proc.proc_author
        d["proc_date"] = proc.proc_date
        d["proc_copyright"] = proc.proc_copyright
        d["proc_blurb"] = proc.proc_blurb
        d["proc_help"] = proc.proc_help
        d["proc_type"] = proc_type_str(proc.proc_type)

        d["parameters"] = dump_table(proc.params)
        d["results"] = dump_table(proc.return_vals)

        with open(outFile, mode) as f :
                f.write(Template(PROC_HTML).safe_substitute(d))

        return None

def dump_pdb() :
        MessageBox = ctypes.windll.user32.MessageBoxA

        root = get_dir()
        if("" == root) :
                return None

        outDirectory = prepare(root)
        dump_css(outDirectory)

        # loop through PDB
        procs = gimp.pdb.query()
        procs.sort()
        for i in range(len(procs)):
                name = procs[i]
                outFile = os.path.join(
                        outDirectory,
                        "%s.html"%(slugify(name))
                )
                
                links = list()
                if (0 < i) :
                        link = "%s.html"%(slugify(procs[i-1]))
                        links.append(link)
                else :
                        links.append("")

                links.append("../index.html")

                if (len(procs) - 1 >  i) :
                        link = "%s.html"%(slugify(procs[i+1]))
                        links.append(link)
                else :
                        links.append("")

                dump_proc(pdb[name], outFile, 'w+', links)
                #break

        # write index file

        return None

register(
        #name
        "dump-pdb",
        #blurb
        "dumps pdb database to HTML",
        #help
        "man up buttercup",
        #author
        "codefox",
        #copyright
        "MIT license => rtfm",
        #date
        "Jan 29, 2013",
        #menu path
        "<Toolbox>/Help/Procedure Dump",
        #image types
        None,
        #params
        [],
        #results
        [],
        #function
        dump_pdb
)

main()
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.