summaryrefslogtreecommitdiffstats
path: root/pdb/groups/palette.pdb
blob: da3c7fc5338adddf5ab7acb5d484baaa3342839c (plain)
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# GIMP - The GNU Image Manipulation Program
# Copyright (C) 1995 Spencer Kimball and Peter Mattis

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

# "Perlized" from C source by Manish Singh <yosh@gimp.org>

sub palette_new {
    $blurb = "Creates a new palette";
    $help  = "This procedure creates a new, uninitialized palette";

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The requested name of the new palette' }
    );

    @outargs = (
	{ name => 'actual_name', type => 'string',
	  desc => 'The actual new palette name' }
    );

    %invoke = (
        code => <<'CODE'
{
  GimpData *data = gimp_data_factory_data_new (gimp->palette_factory,
                                               context, name);

  if (data)
    actual_name = g_strdup (gimp_object_get_name (data));
  else
    success = FALSE;
}
CODE
    );
}

sub palette_is_editable {
    $blurb = "Tests if palette can be edited";
    $help  = "Returns TRUE if you have permission to change the palette";

    &bill_pdb_misc('2004', '2.4');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    @outargs = (
	{ name => 'editable', type => 'boolean',
	  desc => "TRUE if the palette can be edited" }
    );

    %invoke = (
        code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    editable = gimp_data_is_writable (GIMP_DATA (palette));
  else
    success = FALSE;
}
CODE
    );
}

sub palette_duplicate {
    $blurb = "Duplicates a palette";
    $help  = "This procedure creates an identical palette by a different name";

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    @outargs = (
	{ name => 'copy_name', type => 'string', non_empty => 1,
	  desc => "The name of the palette's copy" }
    );

    %invoke = (
        code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    {
      GimpPalette *palette_copy = (GimpPalette *)
        gimp_data_factory_data_duplicate (gimp->palette_factory,
                                          GIMP_DATA (palette));

      if (palette_copy)
        copy_name = g_strdup (gimp_object_get_name (palette_copy));
      else
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_rename {
    $blurb = "Rename a palette";
    $help  = "This procedure renames a palette";

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'new_name', type => 'string', non_empty => 1,
          desc => "The new name of the palette" }
    );

    @outargs = (
	{ name => 'actual_name', type => 'string',
	  desc => "The actual new name of the palette" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_RENAME, error);

  if (palette)
    {
      gimp_object_set_name (GIMP_OBJECT (palette), new_name);
      actual_name = g_strdup (gimp_object_get_name (palette));
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_delete {
    $blurb = "Deletes a palette";
    $help  = "This procedure deletes a palette";

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette && gimp_data_is_deletable (GIMP_DATA (palette)))
    success = gimp_data_factory_data_delete (gimp->palette_factory,
                                             GIMP_DATA (palette),
                                             TRUE, error);
  else
    success = FALSE;
}
CODE
    );
}

sub palette_get_info {
    $blurb = 'Retrieve information about the specified palette.';

    $help = <<'HELP';
This procedure retrieves information about the specified palette. This
includes the name, and the number of colors.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    @outargs = (
        { name => 'num_colors', type => 'int32', void_ret => 1,
          desc => 'The number of colors in the palette' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    num_colors = gimp_palette_get_n_colors (palette);
  else
    success = FALSE;
}
CODE
    );
}

sub palette_get_colors {
    $blurb = 'Gets all colors from the specified palette.';

    $help = <<'HELP';
This procedure retrieves all color entries of the specified palette. 
HELP

    &neo_pdb_misc('2006', '2.6');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    @outargs = (
    	{ name => 'colors', type => 'colorarray',
	  desc => 'The colors in the palette',
	  array => { name => 'num_colors',
                     desc => 'Length of the colors array' } }
    );

    %invoke = (
	vars => [ 'GimpPalette *palette = NULL' ],
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    {
      GList *list = gimp_palette_get_colors (palette);
      gint   i;

      num_colors = gimp_palette_get_n_colors (palette);
      colors     = g_new (GimpRGB, num_colors);

      for (i = 0; i < num_colors; i++, list = g_list_next (list))
        {
          GimpPaletteEntry *entry = list->data;

          colors[i] = entry->color;
        }
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_get_columns {
    $blurb = "Retrieves the number of columns to use to display this palette";
    $help = <<'HELP';
This procedures retrieves the preferred number of columns to use when the
palette is being displayed.
HELP

    &neo_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' }
    );

    @outargs = (
        { name => 'num_columns', type => 'int32',
          desc => "The number of columns used to display this palette" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    num_columns = gimp_palette_get_columns (palette);
  else
    success = FALSE;
}
CODE
    );
}

sub palette_set_columns {
    $blurb = "Sets the number of columns to use when displaying the palette";
    $help = <<'HELP';
This procedures controls how many colors are shown per row when the
palette is being displayed. This value can only be changed if the
palette is writable. The maximum allowed value is 64.
HELP

    &neo_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'columns', type => '0 <= int32 <= 64',
          desc => "The new number of columns" }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_WRITE, error);

  if (palette)
    gimp_palette_set_columns (palette, columns);
  else
    success = FALSE;
}
CODE
    );
}

sub palette_add_entry {
    $blurb = 'Adds a palette entry to the specified palette.';

    $help = <<'HELP';
This procedure adds an entry to the specified palette.
It returns an error if the entry palette does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_name', type => 'string', null_ok => 1,
          desc => 'The name of the entry' },
        { name => 'color', type => 'color',
          desc => 'The new entry\'s color color' }
    );

    @outargs = (
        { name => 'entry_num', type => 'int32', void_ret => 1,
          desc => 'The index of the added entry' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_WRITE, error);

  if (palette)
    {
      GimpPaletteEntry *entry =
        gimp_palette_add_entry (palette, -1, entry_name, &color);

      entry_num = entry->position;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_delete_entry {
    $blurb = 'Deletes a palette entry from the specified palette.';

    $help = <<'HELP';
This procedure deletes an entry from the specified palette.
It returns an error if the entry palette does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_num', type => 'int32',
          desc => 'The index of the added entry' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_WRITE, error);

  if (palette)
    {
      GimpPaletteEntry *entry = gimp_palette_get_entry (palette, entry_num);

      if (entry)
        gimp_palette_delete_entry (palette, entry);
      else
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_entry_get_color {
    $blurb = 'Gets the specified palette entry from the specified palette.';

    $help = <<'HELP';
This procedure retrieves the color of the zero-based entry specified for the
specified palette. It returns an error if the entry does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_num', type => 'int32',
          desc => 'The entry to retrieve' }
    );

    @outargs = (
        { name => 'color', type => 'color', void_ret => 1,
          desc => 'The color requested' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    {
      GimpPaletteEntry *entry = gimp_palette_get_entry (palette, entry_num);

      if (entry)
        color = entry->color;
      else
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_entry_set_color {
    $blurb = 'Sets the specified palette entry in the specified palette.';

    $help = <<'HELP';
This procedure sets the color of the zero-based entry specified for the
specified palette. It returns an error if the entry does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_num', type => 'int32',
          desc => 'The entry to retrieve' },
        { name => 'color', type => 'color',
          desc => 'The new color' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_WRITE, error);

  if (palette)
    success = gimp_palette_set_entry_color (palette, entry_num, &color);
  else
    success = FALSE;
}
CODE
    );
}

sub palette_entry_get_name {
    $blurb = 'Gets the specified palette entry from the specified palette.';

    $help = <<'HELP';
This procedure retrieves the name of the zero-based entry specified for the
specified palette. It returns an error if the entry does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_num', type => 'int32',
          desc => 'The entry to retrieve' }
    );

    @outargs = (
        { name => 'entry_name', type => 'string', void_ret => 1,
          desc => 'The name requested' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_READ, error);

  if (palette)
    {
      GimpPaletteEntry *entry = gimp_palette_get_entry (palette, entry_num);

      if (entry)
        entry_name = g_strdup (entry->name);
      else
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub palette_entry_set_name {
    $blurb = 'Sets the specified palette entry in the specified palette.';

    $help = <<'HELP';
This procedure sets the name of the zero-based entry specified for the
specified palette. It returns an error if the entry does not exist.
HELP

    &mitch_pdb_misc('2004', '2.2');

    @inargs = (
	{ name => 'name', type => 'string', non_empty => 1,
	  desc => 'The palette name' },
        { name => 'entry_num', type => 'int32',
          desc => 'The entry to retrieve' },
        { name => 'entry_name', type => 'string', null_ok => 1,
          desc => 'The new name' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpPalette *palette = gimp_pdb_get_palette (gimp, name, GIMP_PDB_DATA_ACCESS_WRITE, error);

  if (palette)
    success = gimp_palette_set_entry_name (palette, entry_num, entry_name);
  else
    success = FALSE;
}
CODE
    );
}


@headers = qw(<string.h>
              "core/gimp.h"
              "core/gimpcontext.h"
              "core/gimpdatafactory.h"
              "core/gimppalette.h"
              "gimppdb-utils.h");

@procs = qw(palette_new
            palette_duplicate
            palette_rename
            palette_delete
            palette_is_editable
            palette_get_info palette_get_colors
            palette_get_columns palette_set_columns
            palette_add_entry palette_delete_entry
            palette_entry_get_color palette_entry_set_color
            palette_entry_get_name palette_entry_set_name);

%exports = (app => [@procs], lib => [@procs]);

$desc = 'Palette';
$doc_title = 'gimppalette';
$doc_short_desc = 'Functions operating on a single palette.';
$doc_long_desc = 'Functions operating on a single palette.';

1;