-
Notifications
You must be signed in to change notification settings - Fork 375
/
Copy pathpslegend.c
2153 lines (2006 loc) · 112 KB
/
pslegend.c
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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*--------------------------------------------------------------------
*
* Copyright (c) 1991-2025 by the GMT Team (https://www.generic-mapping-tools.org/team.html)
* See LICENSE.TXT file for copying and redistribution conditions.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3 or 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 Lesser General Public License for more details.
*
* Contact info: www.generic-mapping-tools.org
*--------------------------------------------------------------------*/
/*
* Brief synopsis: pslegend will make map legends from input that specifies what will go
* into the legend, such as headers, symbols with explanatory text,
* paragraph text, and empty space and horizontal/vertical lines.
*
* Author: Paul Wessel
* Date: 1-JAN-2010
* Version: 6 API
*/
#include "gmt_dev.h"
#include "longopt/pslegend_inc.h"
#define THIS_MODULE_CLASSIC_NAME "pslegend"
#define THIS_MODULE_MODERN_NAME "legend"
#define THIS_MODULE_LIB "core"
#define THIS_MODULE_PURPOSE "Plot a legend"
#define THIS_MODULE_KEYS "<D{,>X}"
#define THIS_MODULE_NEEDS "jr"
#define THIS_MODULE_OPTIONS "->BJKOPRUVXYpqt" GMT_OPT("c")
/* Various constants that control the multiple parameters needed for some symbols when no info is given */
#define PSLEGEND_MAJOR_SCL 1.5 /* Ratio of major axis to normal isotropic symbol size */
#define PSLEGEND_MINOR_SCL 0.55 /* Ratio of minor axis to normal isotropic symbol size */
#define PSLEGEND_ROUND_SCL 0.1 /* Fraction of corner rounding for round rectangles */
#define PSLEGEND_MAJOR_ANGLE 0 /* Angle of major axis for rotated ellipses */
#define PSLEGEND_RECT_ANGLE 25 /* Angle of rotated rectangles */
#define PSLEGEND_ANGLE_START 120 /* Start angle for wedge or math angle */
#define PSLEGEND_ANGLE_STOP 420 /* Stop angle for wedge or math angle */
#define PSLEGEND_MATH_SCL 0.6 /* Ratio of math angle radius to isotropic symbol size */
#define PSLEGEND_MATH_SIZE 1.0 /* Head size is 100% of radius */
#define PSLEGEND_FRONT_TICK "-1" /* One centered tick for fronts */
#define PSLEGEND_FRONT_TICK_SCL 0.3 /* Ratio of front tick hight to normal isotropic symbol size */
#define PSLEGEND_FRONT_SYMBOL "+l+b" /* Box to the left of the line is our default front symbol */
#define PSLEGEND_VECTOR_ANGLE 0.0 /* Angle of vector with horizontal */
#define PSLEGEND_VECTOR_SIZE 0.4 /* Head size is 40% of length */
#define PSLEGEND_VECTOR_ARG "v%gi+jc+e" /* Format for vector arg given head size */
#define PSLEGEND_VECTOR_PEN 0.5 /* Head pen is half of vector pen width */
#define PSLEGEND_INFO_HIDDEN 0 /* Index into use array for the hidden legend info */
#define PSLEGEND_INFO_GIVEN 1 /* Index into use array for the CLI-given legend file */
struct PSLEGEND_CTRL {
bool got_file; /* True if an input file was given */
struct PSLEGEND_C { /* -C<dx>[/<dy>] */
bool active;
double off[2];
} C;
struct PSLEGEND_D { /* -D[g|j|n|x]<refpoint>+w<width>[/<height>][+j<justify>][+l<spacing>][+o<dx>[/<dy>]] */
bool active;
struct GMT_REFPOINT *refpoint;
struct GMT_SCALED_RECT_DIM R;
double off[2];
double spacing;
int justify;
} D;
struct PSLEGEND_F { /* -F[+r[<radius>]][+g<fill>][+p[<pen>]][+i[<off>/][<pen>]][+s[<dx>/<dy>/][<shade>]][+d] */
bool active;
bool debug; /* If true we draw guide lines */
struct GMT_MAP_PANEL *panel;
} F;
struct PSLEGEND_M { /* -M[e|h][e|h] */
bool active;
unsigned int order[2];
unsigned int n_items;
} M;
struct PSLEGEND_S { /* -S<scale> */
bool active;
double scale;
} S;
struct PSLEGEND_T { /* -T<legendfile> */
bool active;
char *file;
} T;
#ifdef DEBUG
struct PSLEGEND_DEBUG { /* -+ */
bool active;
} DBG;
#endif
};
struct PSLEGEND_TXT {
char *text;
bool string; /* true if label or header string */
struct GMT_FONT font;
};
static void *New_Ctrl (struct GMT_CTRL *GMT) { /* Allocate and initialize a new control structure */
struct PSLEGEND_CTRL *C;
C = gmt_M_memory (GMT, NULL, 1, struct PSLEGEND_CTRL);
/* Initialize values whose defaults are not 0/false/NULL */
C->C.off[GMT_X] = C->C.off[GMT_Y] = GMT->session.u2u[GMT_PT][GMT_INCH] * GMT_FRAME_CLEARANCE; /* 4 pt */
C->D.spacing = 1.1;
C->M.order[0] = PSLEGEND_INFO_GIVEN; /* Default for classic mode */
C->M.n_items = 1; /* Only one source, the specfile, is used */
C->S.scale = 1.0; /* Full given size of symbols */
return (C);
}
static void Free_Ctrl (struct GMT_CTRL *GMT, struct PSLEGEND_CTRL *C) { /* Deallocate control structure */
if (!C) return;
gmt_free_refpoint (GMT, &C->D.refpoint);
gmt_M_free (GMT, C->F.panel);
gmt_M_str_free (C->T.file);
gmt_M_free (GMT, C);
}
static int usage (struct GMTAPI_CTRL *API, int level) {
/* This displays the pslegend synopsis and optionally full usage information */
const char *name = gmt_show_name_and_purpose (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_PURPOSE);
if (level == GMT_MODULE_PURPOSE) return (GMT_NOERROR);
GMT_Usage (API, 0, "usage: %s [<specfile>] -D%s[+w<width>[/<height>]][+l<spacing>]%s [%s] [-F%s] "
"[%s] [-M[<items>]] %s%s%s[%s] [-S<scale>] [-T<file>] [%s] [%s] [%s] [%s] %s[%s] [%s] [%s] [%s]\n",
name, GMT_XYANCHOR, GMT_OFFSET, GMT_B_OPT, GMT_PANEL, GMT_J_OPT, API->K_OPT, API->O_OPT, API->P_OPT, GMT_Rgeo_OPT,
GMT_U_OPT, GMT_V_OPT, GMT_X_OPT, GMT_Y_OPT, API->c_OPT, GMT_p_OPT, GMT_qi_OPT, GMT_t_OPT, GMT_PAR_OPT);
if (level == GMT_SYNOPSIS) return (GMT_MODULE_SYNOPSIS);
GMT_Message (API, GMT_TIME_NONE, " REQUIRED ARGUMENTS:\n");
GMT_Usage (API, 1, "\n<specfile> is a legend layout specification file [or we read standard input]. "
"See module documentation for more information and <specfile> format.");
gmt_refpoint_syntax (API->GMT, "\n-D", "Specify position and size of the legend rectangle", GMT_ANCHOR_LEGEND, 1);
GMT_Usage (API, -2, "Specify legend width with +w<width>; <height> is optional [estimated from <specfile>]. "
"If %% is appended then <width> is set to that fraction of the map width. If only codes A, C, D, G, H, L, "
"and S are used the <width> is optional as well. The remaining arguments are optional:");
gmt_refpoint_syntax (API->GMT, "D", NULL, GMT_ANCHOR_LEGEND, 2);
GMT_Usage (API, 3, " +l sets the line <spacing> factor in units of the current annotation font size [1.1].");
GMT_Message (API, GMT_TIME_NONE, "\n OPTIONAL ARGUMENTS:\n");
GMT_Option (API, "B-");
//GMT_Usage (API, 1, "\n-C<dx>[/<dy>]");
//GMT_Usage (API, -2, "Set the clearance between legend frame and internal items [%gp].", GMT_FRAME_CLEARANCE);
gmt_mappanel_syntax (API->GMT, 'F', "Specify a rectangular panel behind the legend", 2);
GMT_Option (API, "J-,K");
GMT_Usage (API, 1, "\n-M[<items>]");
GMT_Usage (API, -2, "Control how hidden and explicit legend information files are used (modern mode only). Append one or both of:");
GMT_Usage (API, 3, "e: Select the explicit legend information given by <specfile>.");
GMT_Usage (API, 3, "h: Select the hidden legend information built via previous -l options.");
GMT_Usage (API, -2, "The order these are appended controls the read order [Default is he].");
GMT_Option (API, "O,P,R");
GMT_Usage (API, 1, "\n-S<scale>");
GMT_Usage (API, -2, "Scale all symbol sizes by <scale> [1].");
GMT_Usage (API, 1, "\n-T<file>");
GMT_Usage (API, -2, "Modern mode: Write hidden legend specification file to <file>.");
GMT_Option (API, "U,V,X,c,p,qi,t,.");
return (GMT_MODULE_USAGE);
}
static int parse (struct GMT_CTRL *GMT, struct PSLEGEND_CTRL *Ctrl, struct GMT_OPTION *options) {
/* This parses the options provided to pslegend and sets parameters in Ctrl.
* Note Ctrl has already been initialized and non-zero default values set.
* Any GMT common options will override values set previously by other commands.
* It also replaces any file names specified as input or output with the data ID
* returned when registering these sources/destinations with the API.
*/
unsigned int n_errors = 0;
int n;
char xx[GMT_LEN256] = {""}, txt_a[GMT_LEN256] = {""}, txt_b[GMT_LEN256] = {""}, txt_c[GMT_LEN256] = {""};
char yy[GMT_LEN256] = {""}, txt_d[GMT_LEN256] = {""}, txt_e[GMT_LEN256] = {""}, string[GMT_LEN256] = {""};
struct GMT_OPTION *opt = NULL;
struct GMTAPI_CTRL *API = GMT->parent;
for (opt = options; opt; opt = opt->next) { /* Process all the options given */
switch (opt->option) {
case '<': /* Input files, just check they are readable */
if (GMT_Get_FilePath (API, GMT_IS_DATASET, GMT_IN, GMT_FILE_REMOTE, &(opt->arg))) n_errors++;
Ctrl->got_file = true;
break;
/* Processes program-specific parameters */
case 'C': /* Sets the clearance between frame and internal items */
n_errors += gmt_M_repeated_module_option (API, Ctrl->C.active);
if ((n = gmt_get_pair (GMT, opt->arg, GMT_PAIR_DIM_DUP, Ctrl->C.off)) < 0) n_errors++;
break;
case 'D': /* Sets position and size of legend */
n_errors += gmt_M_repeated_module_option (API, Ctrl->D.active);
if (strlen (opt->arg) < 5 || strchr ("jgn", opt->arg[0]) || gmt_found_modifier (GMT, opt->arg, "jlow")) { /* New syntax: */
if ((Ctrl->D.refpoint = gmt_get_refpoint (GMT, opt->arg, 'D')) == NULL) {
n_errors++; /* Failed basic parsing */
continue;
}
/* Args are +w<width>[/<height>][+j<justify>][+l<spacing>][+o<dx>[/<dy>]] */
if (gmt_validate_modifiers (GMT, Ctrl->D.refpoint->args, 'D', "jlow", GMT_MSG_ERROR)) n_errors++;
if (gmt_get_modifier (Ctrl->D.refpoint->args, 'j', string))
Ctrl->D.justify = gmt_just_decode (GMT, string, PSL_NO_DEF);
else /* With -Dj or -DJ, set default to reference justify point, else BL */
Ctrl->D.justify = gmt_M_just_default (GMT, Ctrl->D.refpoint, PSL_BL);
if (gmt_get_modifier (Ctrl->D.refpoint->args, 'l', string)) {
Ctrl->D.spacing = atof (string);
}
if (gmt_get_modifier (Ctrl->D.refpoint->args, 'o', string)) {
if ((n = gmt_get_pair (GMT, string, GMT_PAIR_DIM_DUP, Ctrl->D.off)) < 0) n_errors++;
}
if (gmt_get_modifier (Ctrl->D.refpoint->args, 'w', string)) {
if (gmt_rectangle_dimension (GMT, &Ctrl->D.R, 0.0, 0.0, string))
n_errors++;
}
}
else { /* Backwards handling of old syntax. Args are args are [x]<x>/<y>/<width>[/<height>][/<justify>][/<dx>/<dy>] */
Ctrl->D.refpoint = gmt_M_memory (GMT, NULL, 1, struct GMT_REFPOINT);
Ctrl->D.refpoint->mode = GMT_REFPOINT_PLOT;
Ctrl->D.justify = PSL_TC; /* Backwards compatible default justification */
n = sscanf (opt->arg, "%[^/]/%[^/]/%[^/]/%[^/]/%[^/]/%[^/]/%s", xx, yy, txt_a, txt_b, txt_c, txt_d, txt_e);
n_errors += gmt_M_check_condition (GMT, n < 3, "Old syntax is -D[x]<x0>/<y0>/<width>[/<height>][/<justify>][/<dx>/<dy>]\n");
if (n_errors) break;
if (xx[0] == 'x') {
Ctrl->D.refpoint->x = gmt_M_to_inch (GMT, &xx[1]);
Ctrl->D.refpoint->y = gmt_M_to_inch (GMT, yy);
}
else { /* The equivalent of -Dg<lon>/<lat>... */
n_errors += gmt_verify_expectations (GMT, gmt_M_type (GMT, GMT_IN, GMT_X), gmt_scanf (GMT, xx, gmt_M_type (GMT, GMT_IN, GMT_X), &Ctrl->D.refpoint->x), xx);
n_errors += gmt_verify_expectations (GMT, gmt_M_type (GMT, GMT_IN, GMT_Y), gmt_scanf (GMT, yy, gmt_M_type (GMT, GMT_IN, GMT_Y), &Ctrl->D.refpoint->y), yy);
Ctrl->D.refpoint->mode = GMT_REFPOINT_MAP;
}
Ctrl->D.R.dim[GMT_X] = gmt_M_to_inch (GMT, txt_a); /* Width is always given */
n -= 2; /* Remove the x/y count */
switch (n) {
case 1: /* Only gave reference point and width; change default justify if -Dj */
if (Ctrl->D.refpoint->mode == GMT_REFPOINT_JUST) /* For -Dj with no 2nd justification, use same code as reference coordinate */
Ctrl->D.justify = Ctrl->D.refpoint->justify;
break;
case 2: /* Gave width and (height or justify) */
if (strlen (txt_b) == 2 && strchr ("LMRBCT", txt_b[GMT_X]) && strchr ("LMRBCT", txt_b[GMT_Y])) /* Gave a 2-char justification code */
Ctrl->D.justify = gmt_just_decode (GMT, txt_b, PSL_NO_DEF);
else /* Got height */
Ctrl->D.R.dim[GMT_Y] = gmt_M_to_inch (GMT, txt_b);
break;
case 3: /* Gave width and (height and justify) or (dx/dy) */
if (strlen (txt_c) == 2 && strchr ("LMRBCT", txt_c[GMT_X]) && strchr ("LMRBCT", txt_c[GMT_Y])) { /* Gave a 2-char justification code */
Ctrl->D.R.dim[GMT_Y] = gmt_M_to_inch (GMT, txt_b);
Ctrl->D.justify = gmt_just_decode (GMT, txt_c, PSL_NO_DEF);
}
else { /* Just got offsets */
Ctrl->D.off[GMT_X] = gmt_M_to_inch (GMT, txt_b);
Ctrl->D.off[GMT_Y] = gmt_M_to_inch (GMT, txt_c);
}
break;
case 4: /* Gave width and (height or justify) and dx/dy */
if (strlen (txt_b) == 2 && strchr ("LMRBCT", txt_b[GMT_X]) && strchr ("LMRBCT", txt_b[GMT_Y])) /* Gave a 2-char justification code */
Ctrl->D.justify = gmt_just_decode (GMT, txt_b, PSL_NO_DEF);
else
Ctrl->D.R.dim[GMT_Y] = gmt_M_to_inch (GMT, txt_b);
Ctrl->D.off[GMT_X] = gmt_M_to_inch (GMT, txt_c);
Ctrl->D.off[GMT_Y] = gmt_M_to_inch (GMT, txt_d);
break;
case 5: /* Got them all */
Ctrl->D.R.dim[GMT_Y] = gmt_M_to_inch (GMT, txt_b);
Ctrl->D.justify = gmt_just_decode (GMT, txt_c, PSL_NO_DEF);
Ctrl->D.off[GMT_X] = gmt_M_to_inch (GMT, txt_d);
Ctrl->D.off[GMT_Y] = gmt_M_to_inch (GMT, txt_e);
break;
}
}
break;
case 'F':
n_errors += gmt_M_repeated_module_option (API, Ctrl->F.active);
if (gmt_getpanel (GMT, opt->option, opt->arg, &(Ctrl->F.panel))) {
gmt_mappanel_syntax (GMT, 'F', "Specify a rectangular panel behind the legend", 2);
n_errors++;
}
Ctrl->F.debug = Ctrl->F.panel->debug; /* Hidden +d processing; this may go away */
if (gmt_M_compat_check (GMT, 4) && !opt->arg[0]) Ctrl->F.panel->mode |= GMT_PANEL_OUTLINE; /* Draw frame if just -F is given if in compatibility mode */
if (!Ctrl->F.panel->clearance) gmt_M_memset (Ctrl->F.panel->padding, 4, double); /* No clearance is default since handled via -C */
break;
case 'G': /* Inside legend box fill [OBSOLETE] */
if (gmt_M_compat_check (GMT, 4)) {
char tmparg[GMT_LEN32] = {""};
GMT_Report (API, GMT_MSG_COMPAT, "Option -G is deprecated; -F...+g%s was set instead, use this in the future.\n", opt->arg);
Ctrl->F.active = true;
sprintf (tmparg, "+g%s", opt->arg);
if (gmt_getpanel (GMT, opt->option, tmparg, &(Ctrl->F.panel))) {
gmt_mappanel_syntax (GMT, 'F', "Specify a rectangular panel behind the legend", 2);
n_errors++;
}
Ctrl->F.panel->mode |= GMT_PANEL_FILL;
}
else
n_errors += gmt_default_option_error (GMT, opt);
break;
case 'L': /* Sets linespacing in units of fontsize [1.1] */
GMT_Report (API, GMT_MSG_COMPAT, "Option -L is deprecated; -D...+l%s was set instead, use this in the future.\n", opt->arg);
n_errors += gmt_get_required_double (GMT, opt->arg, opt->option, 0, &Ctrl->D.spacing);
break;
case 'M': /* Merge both hidden and explicit legend info */
n_errors += gmt_M_repeated_module_option (API, Ctrl->M.active);
Ctrl->M.n_items = 0; /* Given -M we must reset and see what the user wants */
if (opt->arg[0] == '\0') { /* Only gave -M, set default for -M */
Ctrl->M.order[0] = PSLEGEND_INFO_HIDDEN;
Ctrl->M.order[1] = PSLEGEND_INFO_GIVEN;
Ctrl->M.n_items = 2;
}
else if (opt->arg[0] == 'h') /* Hidden first */
Ctrl->M.order[Ctrl->M.n_items++] = PSLEGEND_INFO_HIDDEN;
else if (opt->arg[0] == 'e') /* Specfile first */
Ctrl->M.order[Ctrl->M.n_items++] = PSLEGEND_INFO_GIVEN;
if (opt->arg[1] == 'h') /* Hidden second */
Ctrl->M.order[Ctrl->M.n_items++] = PSLEGEND_INFO_HIDDEN;
else if (opt->arg[1] == 'e') /* Specfile second */
Ctrl->M.order[Ctrl->M.n_items++] = PSLEGEND_INFO_GIVEN;
if (strlen(opt->arg) > Ctrl->M.n_items) {
GMT_Report (API, GMT_MSG_COMPAT, "Option -M: Illegal argument %s, it must be either h, e, he, or eh\n", opt->arg);
n_errors++;
}
break;
case 'S': /* Sets common symbol scale factor [1] */
n_errors += gmt_M_repeated_module_option (API, Ctrl->S.active);
n_errors += gmt_get_required_double (GMT, opt->arg, opt->option, 0, &Ctrl->S.scale);
break;
case 'T': /* Sets legendfile for saving the hidden file */
n_errors += gmt_M_repeated_module_option (API, Ctrl->T.active);
n_errors += gmt_get_required_file (GMT, opt->arg, opt->option, 0, GMT_IS_DATASET, GMT_OUT, GMT_FILE_LOCAL, &(Ctrl->T.file));
break;
#ifdef DEBUG
case '+': /* Dump temp files */
Ctrl->DBG.active = true;
n_errors += gmt_get_no_argument (GMT, opt->arg, opt->option, 0);
break;
#endif
default: /* Report bad options */
n_errors += gmt_default_option_error (GMT, opt);
break;
}
}
/* Check that the options selected are mutually consistent */
n_errors += gmt_M_check_condition (GMT, Ctrl->C.off[GMT_X] < 0.0 || Ctrl->C.off[GMT_Y] < 0.0, "Option -C: clearances cannot be negative!\n");
n_errors += gmt_M_check_condition (GMT, !Ctrl->D.active, "The -D option is required!\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->S.scale <= 0.0, "The -S option cannot set a zero scale!\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->M.active && GMT->current.setting.run_mode == GMT_CLASSIC, "The -M option is only available in modern mode\n");
if (!Ctrl->D.refpoint) return (GMT_PARSE_ERROR); /* Need to exit because next ones to not apply */
n_errors += gmt_M_check_condition (GMT, Ctrl->D.R.dim[GMT_Y] < 0.0, "Option -D: legend box height cannot be negative!\n");
if (Ctrl->D.refpoint->mode != GMT_REFPOINT_PLOT) { /* Anything other than -Dx need -R -J; other cases don't */
static char *kind = GMT_REFPOINT_CODES; /* The five types of refpoint specifications */
n_errors += gmt_M_check_condition (GMT, !GMT->common.R.active[RSET], "Option -D%c requires the -R option\n", kind[Ctrl->D.refpoint->mode]);
n_errors += gmt_M_check_condition (GMT, !GMT->common.J.active, "Option -D%c requires the -J option\n", kind[Ctrl->D.refpoint->mode]);
}
return (n_errors ? GMT_PARSE_ERROR : GMT_NOERROR);
}
#define bailout(code) {gmt_M_free_options (mode); return (code);}
#define Return(code) {Free_Ctrl (GMT, Ctrl); gmt_end_module (GMT, GMT_cpy); bailout (code);}
/* Used to draw the current y-line for debug purposes only. */
GMT_LOCAL void pslegend_drawbase (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, double x0, double x1, double y0) {
struct GMT_PEN faint_pen;
gmt_init_pen (GMT, &faint_pen, 0.0);
gmt_setpen (GMT, &faint_pen);
PSL_plotsegment (PSL, x0, y0, x1, y0);
}
/* Used to fill the cells in the current y-line. */
GMT_LOCAL void pslegend_fillcell (struct GMT_CTRL *GMT, double x0, double y0, double y1, double xoff[], double *d_gap, unsigned int n_cols, char *fill[]) {
unsigned int col;
double dim[2];
struct GMT_FILL F;
dim[1] = y1 - y0 + *d_gap;
y0 = 0.5 * (y0 + y1 + *d_gap); /* Recycle y0 to mean mid level */
for (col = 0; col < n_cols; col++) {
if (!fill[col]) continue; /* No fill for this cell */
if (gmt_getfill (GMT, fill[col], &F)) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Unable to interpret %s as a valid fill, skipped\n", fill[col]);
continue;
}
gmt_setfill (GMT, &F, 0);
dim[0] = xoff[col+1] - xoff[col];
PSL_plotsymbol (GMT->PSL, x0 + 0.5 * (xoff[col+1] + xoff[col]), y0, dim, PSL_RECT);
}
*d_gap = 0.0; /* Reset any "gap after D operator" once we use it */
}
GMT_LOCAL struct GMT_DATASET *pslegend_get_dataset_pointer (struct GMTAPI_CTRL *API, struct GMT_DATASET *Din, unsigned int geometry, uint64_t n_segments, uint64_t n_rows, uint64_t n_cols, bool text) {
uint64_t seg, dim[GMT_DIM_SIZE] = {1, n_segments, n_rows, n_cols}; /* We will a 1 or 2-row data set for up to n_segments segments; allocate just once */
unsigned int mode = (text) ? GMT_WITH_STRINGS : 0;
struct GMT_DATASET *D = NULL;
if (Din) return Din; /* Already done this */
if (D == NULL && (D = GMT_Create_Data (API, GMT_IS_DATASET, geometry, mode, dim, NULL, NULL, 0, 0, NULL)) == NULL) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to create a data set for pslegend\n");
return (NULL);
}
/* Initialize counters to zero */
D->n_records = D->n_segments = D->table[0]->n_records = 0;
for (seg = 0; seg < n_segments; seg++)
D->table[0]->segment[seg]->n_rows = 0;
return (D);
}
GMT_LOCAL struct GMT_DATASEGMENT * pslegend_get_segment (struct GMT_DATASET **D, unsigned id, uint64_t seg) {
return D[id]->table[0]->segment[seg]; /* Get next segment from first table */
}
GMT_LOCAL void pslegend_maybe_realloc_table (struct GMT_CTRL *GMT, struct GMT_DATATABLE *T, uint64_t k, uint64_t n_rows) {
struct GMT_DATATABLE_HIDDEN *TH = gmt_get_DT_hidden (T);
unsigned int mode = (T->segment[0]->text) ? GMT_WITH_STRINGS : 0;
if (k < TH->n_alloc) return; /* Not yet */
T->segment = gmt_M_memory (GMT, T->segment, TH->n_alloc + GMT_SMALL_CHUNK, struct GMT_DATASEGMENT *);
for (unsigned int seg = (unsigned int)TH->n_alloc; seg < (unsigned int)TH->n_alloc + GMT_SMALL_CHUNK; seg++) {
T->segment[seg] = gmt_get_segment (GMT, T->n_columns);
gmt_alloc_segment (GMT, T->segment[seg], n_rows, T->n_columns, mode, true);
}
TH->n_alloc += GMT_SMALL_CHUNK;
}
GMT_LOCAL void pslegend_free_unused_segments (struct GMT_CTRL *GMT, struct GMT_DATATABLE *T, uint64_t k) {
/* Must finalize the number of allocated segments */
struct GMT_DATATABLE_HIDDEN *TH = gmt_get_DT_hidden (T);
if (k == TH->n_alloc) return; /* Exact match */
T->n_segments = k;
for (unsigned int seg = T->n_segments; seg < TH->n_alloc; seg++) {
gmt_free_segment (GMT, &(T->segment[seg]));
}
T->segment = gmt_M_memory (GMT, T->segment, T->n_segments, struct GMT_DATASEGMENT *);
TH->n_alloc = T->n_segments;
}
GMT_LOCAL void pslegend_free_unused_rows (struct GMT_CTRL *GMT, struct GMT_DATASEGMENT *S, uint64_t k) {
/* Must finalize the number of allocated rows */
struct GMT_DATASEGMENT_HIDDEN *SH = gmt_get_DS_hidden (S);
if (k == SH->n_alloc) return; /* Not yet */
S->n_rows = k;
if (S->n_columns) { /* Numerical data */
uint64_t col;
for (col = 0; col < S->n_columns; col++)
S->data[col] = gmt_M_memory (GMT, S->data[col], S->n_rows, double);
}
if (S->text) S->text = gmt_M_memory (GMT, S->text, S->n_rows, char *);
}
GMT_LOCAL void pslegend_maybe_realloc_segment (struct GMT_CTRL *GMT, struct GMT_DATASEGMENT *S) {
struct GMT_DATASEGMENT_HIDDEN *SH = gmt_get_DS_hidden (S);
if (S->n_rows < SH->n_alloc) return; /* Not yet */
SH->n_alloc += GMT_SMALL_CHUNK;
if (S->n_columns) { /* Numerical data */
uint64_t col;
for (col = 0; col < S->n_columns; col++)
S->data[col] = gmt_M_memory (GMT, S->data[col], SH->n_alloc, double);
}
if (S->text) S->text = gmt_M_memory (GMT, S->text, SH->n_alloc, char *);
}
GMT_LOCAL double pslegend_get_image_aspect (struct GMTAPI_CTRL *API, char *file) {
double aspect;
struct GMT_IMAGE *I = NULL;
if (strstr (file, ".eps") || strstr (file, ".ps") || strstr (file, ".epsi") || strstr (file, ".epsf")) { /* EPS file */
struct imageinfo h;
if (PSL_loadeps (API->GMT->PSL, file, &h, NULL)) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to read EPS file %s, no pattern set\n", file);
return (-1.0);
}
aspect = (double)h.height / (double)h.width;
return aspect;
}
if ((I = GMT_Read_Data (API, GMT_IS_IMAGE, GMT_IS_FILE, GMT_IS_SURFACE, GMT_CONTAINER_ONLY, NULL, file, NULL)) == NULL) {
GMT_Report (API, GMT_MSG_ERROR, "Unable to read image %s, no pattern set\n", file);
return (-1.0);
}
aspect = (double)I->header->n_rows / (double)I->header->n_columns;
GMT_Destroy_Data (API, &I);
return aspect;
}
GMT_LOCAL bool pslegend_new_fontsyntax (struct GMT_CTRL *GMT, char *word1, char *word2) {
/* Old syntax expect fontsize and font to be given as two items, while new (GMT5)
* syntax expects fontsize,fontname,fontcolor to be a single item with optional,
* comma-separated parts. This function determines what we were given... */
bool new;
if (!strcmp (word1, "-") && !strcmp (word2, "-")) new = false; /* Gave - for both size and font defaults means old syntax */
else if (strchr (word1, ',')) new = true; /* Got a comma-separated list of font attributes */
else if (!strcmp (word1, "-")) new = (gmt_getfonttype (GMT, word2) == -1); /* Detect old syntax if word1 is - and word2 is a font name or integer */
else if (!gmt_not_numeric (GMT, word1) && !strcmp (word2, "-")) new = false; /* Detect old syntax if word1 is a size and word2 - for default font */
else if (!gmt_not_numeric (GMT, word1) && gmt_getfonttype (GMT, word2) >= 0) new = false; /* Detect old syntax if word1 is a size and word2 is a font name or integer */
else if (gmt_not_numeric (GMT, word2)) new = true; /* Must be start of the main text */
else new = true; /* Must assume current syntax */
if (!new && gmt_M_compat_check (GMT, 4))
GMT_Report (GMT->parent, GMT_MSG_COMPAT, "Your GMT4 font specification [%s %s] is deprecated; use [<size>][,<name>][,<fill>][=<pen>] in the future.\n", word1, word2);
return new;
}
/* Define the fraction of the height of the font to the font size */
#define FONT_HEIGHT_PRIMARY (GMT->session.font[GMT->current.setting.font_annot[GMT_PRIMARY].id].height)
#define FONT_HEIGHT(font_id) (GMT->session.font[font_id].height)
#define FONT_HEIGHT_LABEL (GMT->session.font[GMT->current.setting.font_label.id].height)
#define SYM 0
#define FRONT 1
#define QLINE 2
#define DLINE 3
#define TXT 4
#define PAR 5
#define N_DAT 6
#define PSLEGEND_MAX_COLS 100
GMT_LOCAL double get_the_size (struct GMT_CTRL *GMT, char *size, double def_value, double factor) {
return (strcmp (size, "-") ? gmt_M_to_inch (GMT, size) : def_value * factor);
}
EXTERN_MSC int GMT_pslegend (void *V_API, int mode, void *args) {
/* High-level function that implements the pslegend task */
unsigned int set, tbl, pos, first = 0, ID, n_item = 0;
int i, justify = 0, n = 0, n_columns = 1, n_col, col, error = 0, column_number = 0, id, n_scan, status = 0, max_cols = 0;
bool flush_paragraph = false, v_line_draw_now = false, gave_label, gave_mapscale_options, did_old = false, use[2] = {false, true};
bool drawn = false, b_cpt = false, C_is_active = false, do_width = false, in_PS_ok = true, got_line = false, got_geometric = false;
bool confidence_band = false;
uint64_t seg, row, n_fronts = 0, n_quoted_lines = 0, n_decorated_lines = 0, n_symbols = 0, n_par_lines = 0, n_par_total = 0, krow[N_DAT], n_records = 0;
int64_t n_para = -1;
size_t n_char = 0;
char txt_a[GMT_LEN256] = {""}, txt_b[GMT_LEN256] = {""}, txt_c[GMT_LEN256] = {""}, txt_d[GMT_LEN256] = {""};
char txt_e[GMT_LEN256] = {""}, txt_f[GMT_LEN256] = {""}, key[GMT_LEN256] = {""}, sub[GMT_LEN256] = {""}, just;
char tmp[GMT_LEN256] = {""}, symbol[GMT_LEN256] = {""}, text[GMT_BUFSIZ] = {""}, image[GMT_BUFSIZ] = {""}, xx[GMT_LEN256] = {""};
char yy[GMT_LEN256] = {""}, size[GMT_LEN256] = {""}, angle[GMT_LEN256] = {""}, mapscale[GMT_LEN256] = {""};
char font[GMT_LEN256] = {""}, lspace[GMT_LEN256] = {""}, tw[GMT_LEN256] = {""}, jj[GMT_LEN256] = {""};
char bar_cpt[GMT_LEN256] = {""}, bar_gap[GMT_LEN256] = {""}, bar_height[GMT_LEN256] = {""}, bar_modifiers[GMT_LEN256] = {""};
char module_options[GMT_LEN256] = {""}, r_options[GMT_LEN256] = {""}, xy_mode[3] = {""}, J_arg[GMT_LEN64] = {"-Jx1i"};
char txtcolor[GMT_LEN256] = {""}, def_txtcolor[GMT_LEN256] = {""}, buffer[GMT_BUFSIZ] = {""}, A[GMT_LEN32] = {""}, legend_file[PATH_MAX] = {""};
char path[PATH_MAX] = {""}, B[GMT_LEN32] = {""}, C[GMT_LEN32] = {""}, p[GMT_LEN256] = {""};
char *plot_points[2] = {"psxy", "plot"}, *plot_text[2] = {"pstext", "text"}, orig_symbol = 0;
char *line = NULL, string[GMT_VF_LEN] = {""}, *c = NULL, *fill[PSLEGEND_MAX_COLS];
#ifdef DEBUG
char *dname[N_DAT] = {"symbol", "front", "qline", "textline", "partext"};
#endif
double x_orig, y_orig, x_off, x, y, r, col_left_x, row_base_y, d_line_half_width, d_line_hor_offset, off_ss, off_tt, def_dx2 = 0.0, W, H;
double v_line_ver_offset = 0.0, height, az1, az2, row_height, scl, aspect, xy_offset[2], line_size = 0.0, C_rgb[4] = {0.0, 0.0, 0.0, 0.0};
double half_line_spacing, quarter_line_spacing, one_line_spacing, v_line_y_start = 0.0, d_off, def_size = 0.0, shrink[4] = {0.0, 0.0, 0.0, 0.0};
double sum_width, h, gap, d_line_after_gap = 0.0, d_line_last_y0 = 0.0, col_width[PSLEGEND_MAX_COLS], x_off_col[PSLEGEND_MAX_COLS];
struct imageinfo header;
struct PSLEGEND_CTRL *Ctrl = NULL;
struct GMT_CTRL *GMT = NULL, *GMT_cpy = NULL;
struct GMT_OPTION *options = NULL, *opt = NULL;
struct PSL_CTRL *PSL = NULL; /* General PSL internal parameters */
struct GMT_FONT ifont;
struct GMT_PEN current_pen;
struct PSLEGEND_TXT *legend_item = NULL;
struct GMT_DATASET *In = NULL, *INFO[2] = {NULL, NULL};
struct GMT_DATASET *D[N_DAT];
struct GMT_DATASEGMENT *S[N_DAT];
struct GMT_DATASEGMENT_HIDDEN *SH = NULL;
struct GMT_PALETTE *P = NULL;
struct GMTAPI_CTRL *API = gmt_get_api_ptr (V_API); /* Cast from void to GMTAPI_CTRL pointer */
gmt_M_memset (&header, 1, struct imageinfo); /* initialize struct */
gmt_M_memset (fill, PSLEGEND_MAX_COLS, char *); /* initialize array */
/*----------------------- Standard module initialization and parsing ----------------------*/
if (API == NULL) return (GMT_NOT_A_SESSION);
if (mode == GMT_MODULE_PURPOSE) return (usage (API, GMT_MODULE_PURPOSE)); /* Return the purpose of program */
options = GMT_Create_Options (API, mode, args); if (API->error) return (API->error); /* Set or get option list */
if ((error = gmt_report_usage (API, options, 0, usage)) != GMT_NOERROR) bailout (error); /* Give usage if requested */
/* Parse the command-line arguments; return if errors are encountered */
if ((GMT = gmt_init_module (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_KEYS, THIS_MODULE_NEEDS, module_kw, &options, &GMT_cpy)) == NULL) bailout (API->error); /* Save current state */
if (GMT_Parse_Common (API, THIS_MODULE_OPTIONS, options)) Return (API->error);
Ctrl = New_Ctrl (GMT); /* Allocate and initialize a new control structure */
if ((error = parse (GMT, Ctrl, options)) != 0) Return (error);
/*---------------------------- This is the pslegend main code ----------------------------*/
gmt_M_memset (D, N_DAT, struct GMT_DATASET *); /* Set these arrays to NULL */
gmt_M_memset (S, N_DAT, struct GMT_DATASEGMENT *);
gmt_M_memset (krow, N_DAT, uint64_t);
GMT_Report (API, GMT_MSG_INFORMATION, "Processing input text table data\n");
if (gmt_M_compat_check (GMT, 4)) {
/* Since pslegend v4 used '>' to indicate a paragraph record we avoid confusion with multiple segment-headers by *
* temporarily setting # as segment header flag since all headers are skipped anyway */
GMT->current.setting.io_seg_marker[GMT_IN] = '#';
}
/* Here, use[PSLEGEND_INFO_HIDDEN] = false and use[PSLEGEND_INFO_GIVEN] is set to true. This is classic mode defaults.
* However, we may be in modern mode which allows both inputs, yet this may be further modified via -M. */
if (GMT->current.setting.run_mode == GMT_MODERN) /* Possibly use both hidden info and explicit info files */
use[PSLEGEND_INFO_HIDDEN] = true; /* Now both are true */
if (use[PSLEGEND_INFO_HIDDEN] && gmt_legend_file (API, legend_file) == 1) { /* Running modern mode AND we have a hidden legend file to read */
GMT_Report (API, GMT_MSG_INFORMATION, "Processing hidden legend specification file %s\n", legend_file);
if ((INFO[PSLEGEND_INFO_HIDDEN] = GMT_Read_Data (API, GMT_IS_DATASET, GMT_IS_FILE, GMT_IS_TEXT, GMT_READ_NORMAL, NULL, legend_file, NULL)) == NULL) {
Return (API->error);
}
/* Possibly save the hidden spec file to a user-accessible file via -T */
if (Ctrl->T.active && GMT_Write_Data (API, GMT_IS_DATASET, GMT_IS_FILE, GMT_IS_TEXT, GMT_WRITE_NORMAL, NULL, Ctrl->T.file, INFO[PSLEGEND_INFO_HIDDEN]) != GMT_NOERROR) {
Return (API->error);
}
use[PSLEGEND_INFO_GIVEN] = false; /* Since we have a hidden file we turn off specfile unless -M is set */
if (Ctrl->M.active) { /* And even then we must check if e and/or h was set */
use[PSLEGEND_INFO_HIDDEN] = false; /* So even though we have hidden info we must see if -M sets h to actually use it */
for (set = 0; set < Ctrl->M.n_items; set++) { /* Loop over what we set via -M */
if (Ctrl->M.order[set] == PSLEGEND_INFO_GIVEN)
use[PSLEGEND_INFO_GIVEN] = true; /* OK, do want the specfile info */
else if (Ctrl->M.order[set] == PSLEGEND_INFO_HIDDEN)
use[PSLEGEND_INFO_HIDDEN] = true; /* OK, do want the hidden info */
}
}
else { /* Default under modern mode (no -M) is to use both, with hidden first then spec */
if (Ctrl->got_file) { /* Gave a specfile means we explicitly want this only */
use[PSLEGEND_INFO_HIDDEN] = false; /* So even though we have hidden info we override with explicit file */
use[PSLEGEND_INFO_GIVEN] = true; /* Have specfile */
Ctrl->M.order[0] = PSLEGEND_INFO_GIVEN;
Ctrl->M.n_items = 1;
}
else { /* No choice but to try both since there may be a stdin thing */
Ctrl->M.order[0] = PSLEGEND_INFO_HIDDEN;
Ctrl->M.order[1] = PSLEGEND_INFO_GIVEN;
Ctrl->M.n_items = 2;
}
}
if (use[PSLEGEND_INFO_HIDDEN]) n_records += INFO[PSLEGEND_INFO_HIDDEN]->n_records;
}
else /* There were no hidden legend items so we must read a spec file, modern or classic does not matter */
use[PSLEGEND_INFO_HIDDEN] = false;
if (use[PSLEGEND_INFO_GIVEN]) { /* Possibly register stdin and/or read specified input file(s) */
if (GMT_Init_IO (API, GMT_IS_DATASET, GMT_IS_TEXT, GMT_IN, GMT_ADD_DEFAULT, 0, options) != GMT_NOERROR) { /* Register data input */
Return (API->error);
}
if ((INFO[PSLEGEND_INFO_GIVEN] = GMT_Read_Data (API, GMT_IS_DATASET, GMT_IS_FILE, 0, GMT_READ_NORMAL, NULL, NULL, NULL)) == NULL) {
Return (API->error);
}
n_records += INFO[PSLEGEND_INFO_GIVEN]->n_records;
}
ID = GMT->current.setting.run_mode; /* Use as index to arrays with correct module names for classic [0] or modern [1] */
/* When no projection specified (i.e, -Dx is used), we cannot autoscale so must set undefined dimensions and font sizes to nominal sizes */
if (!(GMT->common.R.active[RSET] && GMT->common.J.active)) {
GMT_Report (API, GMT_MSG_INFORMATION, "Without -R -J we must select default font sizes and dimensions regardless of plot size\n");
gmt_set_undefined_defaults (GMT, 0.0, false); /* Must set undefined to their reference values */
}
else if (gmt_map_setup (GMT, GMT->common.R.wesn)) /* gmt_map_setup will call gmt_set_undefined_defaults as well */
Return (GMT_PROJECTION_ERROR);
if (Ctrl->D.R.dim[GMT_X] == 0.0) { /* Compute legend width */
if (Ctrl->D.R.fraction[GMT_X]) /* Use a fraction of map width */
Ctrl->D.R.dim[GMT_X] = Ctrl->D.R.scl[GMT_X] * fabs (GMT->current.map.width);
else { /* Determine it from the contents */
legend_item = gmt_M_memory (GMT, NULL, n_records, struct PSLEGEND_TXT); /* Array to hold all labels */
do_width = true;
}
}
/* First attempt to compute the legend height */
one_line_spacing = Ctrl->D.spacing * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH;
half_line_spacing = 0.5 * one_line_spacing;
quarter_line_spacing = 0.25 * one_line_spacing;
height = 2.0 * Ctrl->C.off[GMT_Y];
for (set = 0; set < Ctrl->M.n_items; set++) { /* We may have one or two sources to consider in desired order */
if (!use[Ctrl->M.order[set]]) continue; /* This one was not selected */
In = INFO[Ctrl->M.order[set]]; /* Short-hand to this source */
for (tbl = 0; tbl < In->n_tables; tbl++) { /* We only expect one table but who knows what the user does */
for (seg = 0; seg < In->table[tbl]->n_segments; seg++) { /* We only expect one segment in each table but again... */
for (row = 0; row < In->table[tbl]->segment[seg]->n_rows; row++) { /* Finally processing the rows */
line = In->table[tbl]->segment[seg]->text[row];
if (gmt_is_a_blank_line (line) || strchr (GMT->current.setting.io_head_marker_in, line[0])) continue; /* Skip all headers or blank lines */
/* Data record to process */
if (line[0] != 'T' && flush_paragraph) { /* Flush contents of pending paragraph [Call GMT_text] */
flush_paragraph = false;
column_number = 0;
}
switch (line[0]) {
case 'B': /* Color scale Bar [Use GMT_psscale] */
/* B cptname offset height[+modifiers] [ Optional psscale args -B -I -L -M -N -S -Z -p ] */
sscanf (&line[2], "%*s %*s %s", bar_height);
if ((c = strchr (bar_height, '+')) != NULL) c[0] = 0; /* Chop off any modifiers so we can compute the height */
height += gmt_M_to_inch (GMT, bar_height) + GMT->current.setting.map_tick_length[GMT_PRIMARY] + GMT->current.setting.map_annot_offset[GMT_PRIMARY] + FONT_HEIGHT_PRIMARY * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH;
column_number = 0;
if (strstr (&line[2], "-B")) b_cpt = true; /* Passed -B options with the bar presecription */
in_PS_ok = false;
break;
case 'A': /* Color change, no height implication */
case 'C':
case 'F':
break;
case 'D': /* Delimiter record: D offset pen [-|=|+] */
txt_c[0] = '\0';
sscanf (&line[2], "%s %s %s", txt_a, txt_b, txt_c);
if (!(txt_c[0] == '-' || txt_c[0] == '=')) height += quarter_line_spacing;
if (!(txt_c[0] == '+' || txt_c[0] == '=')) height += quarter_line_spacing;
column_number = 0;
break;
case 'G': /* Gap record */
sscanf (&line[2], "%s", txt_a);
height += (txt_a[strlen(txt_a)-1] == 'l') ? atoi (txt_a) * one_line_spacing : gmt_M_to_inch (GMT, txt_a);
column_number = 0;
break;
case 'H': /* Header record */
sscanf (&line[2], "%s %s %[^\n]", size, font, text);
if (pslegend_new_fontsyntax (GMT, size, font)) { /* GMT5 font specification */
sscanf (&line[2], "%s %[^\n]", font, text);
if (font[0] == '-')
sprintf (tmp, "%s", gmt_putfont (GMT, &GMT->current.setting.font_title));
else
strcpy (tmp, font); /* Gave a font specification */
}
else { /* Old GMT4 syntax for fontsize and font */
if (size[0] == '-') size[0] = 0;
if (font[0] == '-') font[0] = 0;
sprintf (tmp, "%s,%s", size, font); /* Put size, font together for parsing by gmt_getfont */
}
ifont = GMT->current.setting.font_title; /* Set default font */
gmt_getfont (GMT, tmp, &ifont);
height += Ctrl->D.spacing * ifont.size / PSL_POINTS_PER_INCH;
column_number = 0;
if (do_width) {
gmt_M_memcpy (&legend_item[n_item].font, &ifont, 1, struct GMT_FONT);
legend_item[n_item].string = true;
legend_item[n_item++].text = strdup (text);
}
break;
case 'I': /* Image record [use GMT_psimage] */
sscanf (&line[2], "%s %s %s", image, size, key);
first = gmt_download_file_if_not_found (GMT, image, GMT_CACHE_DIR);
if (gmt_getdatapath (GMT, &image[first], path, R_OK) == NULL) {
GMT_Report (API, GMT_MSG_ERROR, "Cannot find/open file %s.\n", &image[first]);
continue;
}
if ((aspect = pslegend_get_image_aspect (API, path)) < 0.0) {
GMT_Report (API, GMT_MSG_ERROR, "Trouble reading %s! - Skipping.\n", &image[first]);
continue;
}
height += gmt_M_to_inch (GMT, size) * aspect;
column_number = 0;
in_PS_ok = false;
break;
case 'L': /* Label record */
sscanf (&line[2], "%s %s %s %[^\n]", size, font, key, text);
if (pslegend_new_fontsyntax (GMT, size, font)) { /* GMT5 font specification */
sscanf (&line[2], "%s %s %[^\n]", font, key, text);
if (font[0] == '-') /* Want default font */
sprintf (tmp, "%s", gmt_putfont (GMT, &GMT->current.setting.font_label));
else
strcpy (tmp, font); /* Gave a font specification */
}
else { /* Old GMT4 syntax for fontsize and font */
if (size[0] == '-') size[0] = 0;
if (font[0] == '-') font[0] = 0;
sprintf (tmp, "%s,%s", size, font); /* Put size, font together for parsing by gmt_getfont */
}
ifont = GMT->current.setting.font_label; /* Set default font */
gmt_getfont (GMT, tmp, &ifont);
if (column_number%n_columns == 0) {
height += Ctrl->D.spacing * ifont.size / PSL_POINTS_PER_INCH;
column_number = 0;
}
column_number++;
if (do_width) {
gmt_M_memcpy (&legend_item[n_item].font, &ifont, 1, struct GMT_FONT);
legend_item[n_item].string = true;
legend_item[n_item++].text = strdup (text);
}
break;
case 'M': /* Map scale record M lon0|- lat0 length[n|m|k][+opts] f|p [-R -J] */
sscanf (&line[2], "%s %s %s %s %s %s", txt_a, txt_b, txt_c, txt_d, txt_e, txt_f);
for (i = 0, gave_mapscale_options = false; txt_c[i] && !gave_mapscale_options; i++) if (txt_c[i] == '+') gave_mapscale_options = true;
/* Default assumes label is added on top */
just = 't';
gave_label = true;
d_off = FONT_HEIGHT_LABEL * GMT->current.setting.font_label.size / PSL_POINTS_PER_INCH + fabs(GMT->current.setting.map_label_offset[GMT_Y]);
if ((txt_d[0] == 'f' || txt_d[0] == 'p') && gmt_get_modifier (txt_c, 'j', string)) /* Specified alternate justification old-style */
just = string[0];
else if (gmt_get_modifier (txt_c, 'a', string)) /* Specified alternate alignment */
just = string[0];
if (gmt_get_modifier (txt_c, 'u', string)) /* Specified alternate alignment */
gave_label = false; /* Not sure why I do this, will find out */
if (gave_label && (just == 't' || just == 'b')) height += d_off;
height += GMT->current.setting.map_scale_height + FONT_HEIGHT_PRIMARY * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH + GMT->current.setting.map_annot_offset[GMT_PRIMARY];
column_number = 0;
in_PS_ok = false;
break;
case 'N': /* n_columns or column width record */
pos = n_columns = 0;
while ((gmt_strtok (&line[2], " \t", &pos, p))) {
n_columns++;
if (n_columns == PSLEGEND_MAX_COLS) {
GMT_Report (API, GMT_MSG_ERROR, "Exceeding maximum columns (%d) in N operator\n", PSLEGEND_MAX_COLS);
Return (GMT_RUNTIME_ERROR);
}
}
if (n_columns == 0) n_columns = 1; /* Default to 1 if nothing is given */
/* Check if user gave just the number of columns */
if (n_columns == 1 && (pos = atoi (&line[2])) > 1) n_columns = pos;
if (n_columns > max_cols) max_cols = n_columns;
column_number = 0;
break;
case '>': /* Paragraph text header */
if (gmt_M_compat_check (GMT, 4)) /* Warn and fall through on purpose */
GMT_Report (API, GMT_MSG_COMPAT, "Paragraph text header flag > is deprecated; use P instead\n");
else {
GMT_Report (API, GMT_MSG_ERROR, "Unrecognized record (%s)\n", line);
Return (GMT_RUNTIME_ERROR);
break;
}
/* Intentionally fall through */
case 'P': /* Paragraph text header */
flush_paragraph = true;
column_number = 0;
n_par_total++;
in_PS_ok = false;
break;
case 'S': /* Symbol record: S [dx1 symbol size fill pen [ dx2 text ]] */
text[0] = '\0';
n_scan = sscanf (line, "%*s %*s %s %s %*s %*s %s %[^\n]", symbol, size, txt_b, text);
if (column_number%n_columns == 0 && symbol[0] != 'L') { /* Skip L to not count both symbols making up the confidence line */
height += one_line_spacing;
column_number = 0;
}
column_number++;
/* Find the largest symbol size specified */
gmt_strrepc (size, '/', ' '); /* Replace any slashes with spaces */
gmt_strrepc (size, ',', ' '); /* Replace any commas with spaces */
n = sscanf (size, "%s %s %s", A, B, C);
if (n > 1) { /* Multi-arg symbol, use the last arg as size since closest to height */
if (strchr ("eEjJvV", symbol[0])) /* These all has 2nd arg as size */
x = gmt_M_to_inch (GMT, B);
else if (strchr ("rRm", symbol[0])) /* These all has 1st arg as size */
x = gmt_M_to_inch (GMT, A);
else { /* Last arg */
if (n == 3)
x = gmt_M_to_inch (GMT, C);
else
x = gmt_M_to_inch (GMT, B);
}
}
else {
if (strcmp (size, "-")) {
char *c = NULL;
if ((c = strchr (size, ','))) { /* Probably got width,height for rectangle */
c[0] = '\0';
x = gmt_M_to_inch (GMT, size);
c[0] = ',';
}
else
x = gmt_M_to_inch (GMT, size);
}
else
x = 0.0;
}
if (strchr ("fqvV-~", symbol[0])) { /* A line-type symbol or vector */
got_line = true;
if (x > 0.0) line_size = x;
}
else /* Got regular symbols too */
got_geometric = true;
if (x > def_size) def_size = x;
if (n_scan > 2 && strcmp (txt_b, "-")) {
x = gmt_M_to_inch (GMT, txt_b);
if (x > def_dx2) def_dx2 = x;
}
if (do_width && n_scan == 4 && strlen (text)) {
gmt_M_memcpy (&legend_item[n_item].font, &(GMT->current.setting.font_annot[GMT_PRIMARY]), 1, struct GMT_FONT);
legend_item[n_item++].text = strdup (text);
}
break;
case 'T': /* paragraph text record */
n_char += strlen (line) - 2;
if (!flush_paragraph) n_par_total++; /* paragraph text without leading header provided */
flush_paragraph = true;
column_number = 0;
n_par_lines++;
in_PS_ok = false;
break;
case 'V': /* Vertical line from here to next V */
column_number = 0;
break;
default:
GMT_Report (API, GMT_MSG_ERROR, "Unrecognized record (%s)\n", line);
Return (GMT_RUNTIME_ERROR);
break;
}
}
}
}
}
if (do_width) {
if (max_cols > 1) {
GMT_Report (API, GMT_MSG_ERROR, "Must specify -D...+w<width> if more than one symbol column (N = %d)\n", max_cols);
Return (GMT_RUNTIME_ERROR);
}
if (!in_PS_ok) {
GMT_Report (API, GMT_MSG_ERROR, "Must specify -D...+w<width> if codes other than D, H, L, S, V are used\n");
Return (GMT_RUNTIME_ERROR);
}
}
W = GMT_LET_WIDTH * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH; /* Average current annotation font width in inches */
H = FONT_HEIGHT_PRIMARY * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH; /* Average current annotation font width in inches */
if (got_line && gmt_M_is_zero (line_size)) { /* Got lines but no lengths specified */
line_size = 2.5 * W; /* 2.5 mean character widths in inches */
if (def_size == 0.0) /* No other symbol size were specified, so set those too */
def_size = (got_geometric) ? H : line_size;
}
else if (def_size == 0.0) /* No sizes specified in input file; default to H */
def_size = H; /* In inches */
if (def_dx2 == 0.0) /* No dist to text label given; set to default symbol size + annotation size */
def_dx2 = MAX (def_size, line_size) + W; /* In inches */
GMT_Report (API, GMT_MSG_DEBUG, "Default symbol size = %g and default distance to text label is %g\n", def_size, def_dx2);
if (n_char) { /* Typesetting paragraphs, make a guesstimate of number of typeset lines */
int n_lines;
double average_char_width = 0.44; /* There is no such thing but this is just a 1st order estimate */
double x_lines;
/* Guess: Given legend width and approximate char width, do the simple expression */
x_lines = n_char * (average_char_width * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH) / ((Ctrl->D.R.dim[GMT_X] - 2 * Ctrl->C.off[GMT_X]));
n_lines = irint (ceil (x_lines));
height += n_lines * Ctrl->D.spacing * GMT->current.setting.font_annot[GMT_PRIMARY].size / PSL_POINTS_PER_INCH;
GMT_Report (API, GMT_MSG_DEBUG, "Estimating %d lines of typeset paragraph text [%.1f].\n", n_lines, x_lines);
}
scl = gmt_convert_units (GMT, "1", GMT_INCH, GMT->current.setting.proj_length_unit);
if (Ctrl->D.R.dim[GMT_Y] == 0.0) { /* Use the computed height */
Ctrl->D.R.dim[GMT_Y] = height;
GMT_Report (API, GMT_MSG_INFORMATION, "Legend height not given, using estimated height of %g %s.\n", scl*height,
GMT->session.unit_name[GMT->current.setting.proj_length_unit]);
}
else
GMT_Report (API, GMT_MSG_INFORMATION, "Legend height given as %g %s; estimated height is %g %s.\n",
scl*Ctrl->D.R.dim[GMT_Y], GMT->session.unit_name[GMT->current.setting.proj_length_unit],
scl*height, GMT->session.unit_name[GMT->current.setting.proj_length_unit]);
if (do_width) Ctrl->D.R.dim[GMT_X] = Ctrl->D.R.dim[GMT_Y]; /* Temporarily needed in gmt_map_setup */
if (!(GMT->common.R.active[RSET] && GMT->common.J.active)) { /* When no projection specified (i.e, -Dx is used), use fake linear projection -Jx1i */
double wesn[4];
gmt_M_memset (wesn, 4, double);
GMT->common.R.active[RSET] = true;
GMT->common.J.active = false;
gmt_parse_common_options (GMT, "J", 'J', "x1i");
wesn[XHI] = Ctrl->D.R.dim[GMT_X]; wesn[YHI] = Ctrl->D.R.dim[GMT_Y];
if (gmt_map_setup (GMT, wesn)) Return (GMT_PROJECTION_ERROR);
if (GMT->common.B.active[GMT_PRIMARY] || GMT->common.B.active[GMT_SECONDARY]) { /* Cannot use -B if no -R -J */
GMT->common.B.active[GMT_PRIMARY] = GMT->common.B.active[GMT_SECONDARY] = false;
GMT_Report (API, GMT_MSG_INFORMATION, "Disabling your -B option since -R -J were not set\n");
}
}
if ((PSL = gmt_plotinit (GMT, options)) == NULL) Return (GMT_RUNTIME_ERROR);
gmt_plane_perspective (GMT, GMT->current.proj.z_project.view_plane, GMT->current.proj.z_level);
gmt_plotcanvas (GMT); /* Fill canvas if requested */
gmt_set_basemap_orders (GMT, GMT_BASEMAP_FRAME_BEFORE, GMT_BASEMAP_GRID_BEFORE, GMT_BASEMAP_ANNOT_BEFORE);
gmt_map_basemap (GMT); /* Plot basemap if requested */
if (GMT->current.map.frame.draw && b_cpt) /* Two conflicting -B settings, reset main -B since we just finished the frame */
gmt_M_memset (&(GMT->current.map.frame), 1, struct GMT_PLOT_FRAME);