This repository has been archived by the owner on Sep 23, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathtikzDevice.c
2050 lines (1644 loc) · 61.9 KB
/
tikzDevice.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
/*
* tikzDevice, (C) 2009-2010 Charlie Sharpsteen and Cameron Bracken
*
* A graphics device for R :
* A Computer Language for Statistical Data Analysis
*
* Copyright (C) 1995, 1996 Robert Gentleman and Ross Ihaka
* Copyright (C) 2001-8 The R Development Core Team
*
* 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 2 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, a copy is available at
* http://www.r-project.org/Licenses/
*
* The C code in this project started as a fork of:
* A PicTeX Device, (C) 1996 Valerio Aimale
*
*
* "If I have seen further, it is only by standing on
* the shoulders of giants."
*
* -I. Newton
*
*/
/********************************************************************/
/*
* NOTE:
* This is the first effort of dyed-in-the-wool Fortran programmers
* to write C code. Hence the comments in this file will make many
* observations that may seem obvious or inane. There also may be a
* generous amount of snide comments concerning the syntax of the
* C language.
*/
/*
* Function prototypes are defined in here. Apparently in C
* it is absolutely necessary for function definitions to appear
* BEFORE they are called by other functions. Hence many source code
* files do not present code in the order in which that code
* is used. Using a header file with function declarations allows
* the programmer to order the code in any sequence they choose.
*/
/*
* This header also includes other header files describing functions
* provided by the R language.
*/
#include "tikzDevice.h"
// We are writing to files so we need stdio.h
#include <stdio.h>
/*
* Main entry point from the R environment, called by the R function
* tikz() to open a new TikZ graphics device.
*/
SEXP TikZ_StartDevice ( SEXP args ){
/*
* Make sure the version number of the R running this
* routine is compatible with the version number of
* the R that compiled this routine.
*/
R_GE_checkVersionOrDie(R_GE_version);
/* Declare local variabls for holding the components of the args SEXP */
const char *fileName;
const char *bg, *fg;
double width, height;
Rboolean standAlone, bareBones;
const char *documentDeclaration, *packages, *footer;
double baseSize;
Rboolean console, sanitize;
/*
* pGEDevDesc is a variable provided by the R Graphics Engine
* that represents a graphics device to the rest of the R system.
* It contains one important componant of type pDevDesc
* which contains information specific to the implementation of
* the TikZ Device. The creation and initialization of this component
* is the main task of this routine.
*/
pGEDevDesc tikzDev;
/* Retrieve function arguments from input SEXP. */
/*
* Skip first argument. It holds the name of the R function
* that called this C routine.
*/
args = CDR(args);
/* Recover file name. */
fileName = translateChar(asChar(CAR(args)));
/* Advance to next argument stored in the args SEXP. */
args = CDR(args);
/* Recover figure dimensions. */
/* For now these are assumed to be in inches. */
width = asReal(CAR(args)); args = CDR(args);
height = asReal(CAR(args)); args = CDR(args);
/* Recover initial background and foreground colors. */
bg = CHAR(asChar(CAR(args))); args = CDR(args);
fg = CHAR(asChar(CAR(args))); args = CDR(args);
/* Recover the base fontsize */
baseSize = asReal(CAR(args)); args = CDR(args);
/*
* Set the standAlone parameter which specifies if the TikZ
* pictures generated by this device should be wrapped in their
* own LaTeX Document
*/
standAlone = asLogical(CAR(args)); args = CDR(args);
/*
* Set the bareBones parameter which specifies if TikZ code
* should be output directly without wrapping it a LaTeX document
* or the tikzpicture environment.
*/
bareBones = asLogical(CAR(args)); args = CDR(args);
/* Grab the latex header and footers*/
documentDeclaration = CHAR(asChar(CAR(args))); args = CDR(args);
packages = CHAR(asChar(CAR(args))); args = CDR(args);
footer = CHAR(asChar(CAR(args))); args = CDR(args);
// Should the output be sent to the R console?
console = asLogical(CAR(args)); args = CDR(args);
/*
* Should text strings passed to the plotting device be sent
* to a sanitization function- i.e. to provide automatic
* escaping of TeX special characters such as %,_,\, etc?
*/
sanitize = asLogical(CAR(args)); args = CDR(args);
/*
* See the definition of tikz_engine in tikzDevice.h
*/
int engine = asInteger(CAR(args));
/* Ensure there is an empty slot avaliable for a new device. */
R_CheckDeviceAvailable();
BEGIN_SUSPEND_INTERRUPTS{
/*
* The pDevDesc variable specifies the funtions and components
* that describe the specifics of this graphics device. After
* setup, this information will be incorporated into the pGEDevDesc
* variable tikzDev.
*/
pDevDesc deviceInfo;
/*
* Create the deviceInfo variable. If this operation fails,
* a 0 is returned in order to cause R to shut down due to the
* possibility of corrupted memory.
*/
if( !( deviceInfo = (pDevDesc) calloc(1, sizeof(DevDesc))) ) {
return 0;
}
/*
* Call setup routine to initialize deviceInfo and associate
* R graphics function hooks with the appropriate C routines
* in this file.
*/
if( !TikZ_Setup( deviceInfo, fileName, width, height, bg, fg, baseSize,
standAlone, bareBones, documentDeclaration, packages,
footer, console, sanitize, engine ) ){
/*
* If setup was unsuccessful, destroy the device and return
* an error message.
*/
free( deviceInfo );
error("TikZ device setup was unsuccessful!");
}
/* Create tikzDev as a Graphics Engine device using deviceInfo. */
tikzDev = GEcreateDevDesc( deviceInfo );
/*
* Register the device as an avaiable graphics device in the R
* Session. The user will now see a device labeled "tikz output"
* when running functions such as dev.list().
*/
GEaddDevice2( tikzDev, "tikz output" );
} END_SUSPEND_INTERRUPTS;
return R_NilValue;
}
/*
* This function is responsible for initializing device parameters
* contained in the variable deviceInfo. It returns a true or false
* value depending on the success of initialization operations. The
* static keyword means this function can only be seen by other functions
* in this file. A better choice for the keyword might have been something
* like "private"...
*/
static Rboolean TikZ_Setup(
pDevDesc deviceInfo,
const char *fileName,
double width, double height,
const char *bg, const char *fg, double baseSize,
Rboolean standAlone, Rboolean bareBones,
const char *documentDeclaration,
const char *packages, const char *footer,
Rboolean console, Rboolean sanitize, int engine ){
/*
* Create tikzInfo, this variable contains information which is
* unique to the implementation of the TikZ Device. The deviceInfo
* variable contains a slot into which tikzInfo can be placed so that
* this information persists and is retrievable during the lifespan
* of this device.
*
* More information on the components of the deviceInfo structure,
* which is a pointer to a DevDesc variable, can be found under
* struct _DevDesc in the R header file GraphicsDevice.h
*
* tikzInfo is a structure which is defined in the file tikzDevice.h
*/
tikzDevDesc *tikzInfo;
pGEcontext plotParams;
/*
* pGEcontext is actually a *pointer* to a structure of type
* R_GE_gcontext. If we don't allocate it, it will be passed
* into the initialization routine without actually pointing
* to anything. This causes nasty crashes- for some reason
* only on Windows and Linux...
*/
if( !( plotParams = (pGEcontext) malloc(sizeof(pGEcontext)) ) ){
return FALSE;
}
/*
* Initialize tikzInfo, return false if this fails. A false return
* value will cause the whole device initialization routine to fail.
*/
if( !( tikzInfo = (tikzDevDesc *) malloc(sizeof(tikzDevDesc)) ) ){
return FALSE;
}
/* Copy TikZ-specific information to the tikzInfo variable. */
tikzInfo->outFileName = (char*) calloc(strlen(fileName) + 1, sizeof(char));
strcpy(tikzInfo->outFileName, fileName);
tikzInfo->engine = engine;
tikzInfo->rasterFileCount = 1;
tikzInfo->firstPage = TRUE;
tikzInfo->debug = DEBUG;
tikzInfo->standAlone = standAlone;
tikzInfo->bareBones = bareBones;
tikzInfo->firstClip = TRUE;
tikzInfo->oldFillColor = 0;
tikzInfo->oldDrawColor = 0;
tikzInfo->oldLineType = 0;
tikzInfo->plotParams = plotParams;
tikzInfo->stringWidthCalls = 0;
tikzInfo->documentDeclaration = documentDeclaration;
tikzInfo->packages = packages;
tikzInfo->footer = footer;
tikzInfo->polyLine = FALSE;
tikzInfo->console = console;
tikzInfo->sanitize = sanitize;
/* Incorporate tikzInfo into deviceInfo. */
deviceInfo->deviceSpecific = (void *) tikzInfo;
/*
* These next statements define the capabilities of the device.
* These capabilities include:
* -Device/user interaction
* -Gamma correction
* -Clipping abilities
* -UTF8 support
* -Text justification/alignment abilities
*/
/*
* Define the gamma factor- used to adjust the luminosity of an image.
* Set to 1 since there is no gamma correction in the TikZ device. Also,
* canChangeGamma is set to FALSE to disallow user adjustment of this
* default.
*/
deviceInfo->startgamma = 1;
deviceInfo->canChangeGamma = FALSE;
/*
* canHAdj is an integer specifying the level of horizontal adjustment
* or justification provided by this device. Currently set to 1 as this
* is implemented by having the device insert /raggedleft, /raggedright
* and /centering directives.
*
* Level 2 represents support for continuous variation between left aligned
* and right aligned- this is certainly possible in TeX but would take some
* thought to implement.
*/
deviceInfo->canHAdj = 1;
/*
* useRotatedTextInContour specifies if the text function along with
* rotation parameters should be used over Hershey fonts when printing
* contour plot labels. As one of the primary goals of this device
* is to unify font choices, this value is set to true.
*/
deviceInfo->useRotatedTextInContour = TRUE;
/*
* canClip specifies whether the device implements routines for trimming
* plotting output such that it falls within a rectangular clipping area.
*/
deviceInfo->canClip = TRUE;
/*
* These next parameters speficy if the device reacts to keyboard and
* mouse events. Since this device outputs to a file, not a screen window,
* these actions are disabled.
*/
deviceInfo->canGenMouseDown = FALSE;
deviceInfo->canGenMouseMove = FALSE;
deviceInfo->canGenMouseUp = FALSE;
deviceInfo->canGenKeybd = FALSE;
/*
* This parameter specifies whether the device is set up to handle UTF8
* characters. This makes a difference in the complexity of the text
* handling functions that must be built into the device. If set to true
* both hook functions textUTF8 and strWidthUTF8 must be implemented.
* Compared to ASCII, which only has 128 character values, UTF8 has
* thousands.
*
* Version 0.6.0 of tikzDevice gained the ability to calculate metrics for
* UTF8 encoded strings and characters. Those calculations are not done here
* in the C code but implemented through the magical callback to R. On the R
* level, we determine automatically is a string contains multibyte UTF8
* characters and then use XeLaTeX. Bottom line is, even though hasTextUTF8
* is FALSE we can still print UTF8 characters and we dont need a separate
* text handling function for UTF8 characters (thank god).
*
* wantSymbolUTF8 indicates if mathematical symbols should be sent to
* the device as UTF8 characters. These can be handled in the same way as
* normal UTF8 text and so wantSymbolUTF8 is TRUE.
*/
deviceInfo->hasTextUTF8 = FALSE;
switch (tikzInfo->engine) {
case pdftex:
deviceInfo->wantSymbolUTF8 = FALSE;
break;
case xetex:
deviceInfo->wantSymbolUTF8 = TRUE;
break;
}
#if R_GE_version >= 9
/* Added in 2.14.0 for `dev.capabilities`. In all cases 0 means NA (unset). */
deviceInfo->haveTransparency = 2; /* 1 = no, 2 = yes */
deviceInfo->haveTransparentBg = 2; /* 1 = no, 2 = fully, 3 = semi */
deviceInfo->haveRaster = 2; /* 1 = no, 2 = yes, 3 = except for missing values */
deviceInfo->haveCapture = 1; /* 1 = no, 2 = yes */
deviceInfo->haveLocator = 1; /* 1 = no, 2 = yes */
#endif
/*
* Initialize device parameters. These concern properties such as the
* plotting canvas size, the initial foreground and background colors and
* the initial clipping area. Other parameters related to fonts and text
* output are also included.
*/
/*
* Set canvas size. The bottom left corner is considered the origin and
* assigned the value of 0pt, 0pt. The upper right corner is assigned by
* converting the specified height and width of the device to points.
*/
deviceInfo->bottom = 0;
deviceInfo->left = 0;
deviceInfo->top = dim2dev( height );
deviceInfo->right = dim2dev( width );
/* Set default character size in pixels. */
deviceInfo->cra[0] = 9;
deviceInfo->cra[1] = 12;
/* Set initial font. */
deviceInfo->startfont = 1;
/* Set base font size. */
deviceInfo->startps = baseSize;
/*
* Apparently these are supposed to center text strings over the points at
* which they are plotted. TikZ does this automagically.
*
* We hope.
*
*/
deviceInfo->xCharOffset = 0;
deviceInfo->yCharOffset = 0;
deviceInfo->yLineBias = 0;
/* Specify the number of inches per pixel in the x and y directions. */
deviceInfo->ipr[0] = 1/dim2dev(1);
deviceInfo->ipr[1] = 1/dim2dev(1);
/* Set initial foreground and background colors. */
deviceInfo->startfill = R_GE_str2col( bg );
deviceInfo->startcol = R_GE_str2col( fg );
/* Set initial line type. */
deviceInfo->startlty = 0;
/*
* Connect R graphic function hooks to TikZ Routines implemented in this
* file. Each routine performs a specific function such as adding text,
* drawing a line or reporting/adjusting the status of the device.
*/
/* Utility routines. */
deviceInfo->close = TikZ_Close;
deviceInfo->newPage = TikZ_NewPage;
deviceInfo->clip = TikZ_Clip;
deviceInfo->size = TikZ_Size;
/* Text routines. */
deviceInfo->metricInfo = TikZ_MetricInfo;
deviceInfo->strWidth = TikZ_StrWidth;
deviceInfo->text = TikZ_Text;
/* Drawing routines. */
deviceInfo->line = TikZ_Line;
deviceInfo->circle = TikZ_Circle;
deviceInfo->rect = TikZ_Rectangle;
deviceInfo->polyline = TikZ_Polyline;
deviceInfo->polygon = TikZ_Polygon;
/*
* The following function was added in R 2.12.0, Graphics Engine
* version 8. See tikzDevice.h for more details.
*/
#if R_GE_version >= 8
deviceInfo->path = TikZ_Path;
#endif
/*
* Raster Routines. Currently implemented as stub functions to
* avoid nasty crashes.
*/
deviceInfo->raster = TikZ_Raster;
deviceInfo->cap = TikZ_Cap;
/* Dummy routines. These are mainly used by GUI graphics devices. */
deviceInfo->activate = TikZ_Activate;
deviceInfo->deactivate = TikZ_Deactivate;
deviceInfo->locator = TikZ_Locator;
deviceInfo->mode = TikZ_Mode;
/* Call TikZ_Open to create and initialize the output file. */
if( !TikZ_Open( deviceInfo ) ){
return FALSE;
}
return TRUE;
}
/*==============================================================================
Core Graphics Routines
Implementaion of an R Graphics Device as Defined by:
GraphicsDevice.h
==============================================================================*/
/*
* Routines for handling device state:
*
* - Open
* - Close
* - Newpage
* - Clip
* - Size
*/
static Rboolean TikZ_Open( pDevDesc deviceInfo ){
/*
* Shortcut pointers to variables of interest.
* It seems like there HAS to be a more elegent way of accesing
* these...
*/
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
if(tikzInfo->outFileName[0] == '\0'){
//If empty file name output to console
tikzInfo->console = TRUE;
}else{
if( !( tikzInfo->outputFile = fopen(R_ExpandFileName(tikzInfo->outFileName), "w") ) )
return FALSE;
}
/* Print header comment */
Print_TikZ_Header( tikzInfo );
/* Header for a standalone LaTeX document*/
if(tikzInfo->standAlone == TRUE){
printOutput(tikzInfo,"%s",tikzInfo->documentDeclaration);
printOutput(tikzInfo,"%s",tikzInfo->packages);
printOutput(tikzInfo,"\\begin{document}\n\n");
}
/*Show only for debugging*/
if(tikzInfo->debug == TRUE)
printOutput(tikzInfo,"%% Beginning tikzpicture\n");
/* Start the tikz environment if we have not specified a bare bones plot. */
if( tikzInfo->bareBones != TRUE ){
printOutput(tikzInfo, "\\begin{tikzpicture}[x=1pt,y=1pt]\n");
}
return TRUE;
}
static void TikZ_Close( pDevDesc deviceInfo){
/* Shortcut pointers to variables of interest. */
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
printOutput(tikzInfo, "\\end{scope}\n");
/* End the tikz environment if we're not doing a bare bones plot. */
if( tikzInfo->bareBones != TRUE )
printOutput(tikzInfo, "\\end{tikzpicture}\n");
/* Close off the standalone document*/
if(tikzInfo->standAlone == TRUE)
printOutput(tikzInfo,"\n\\end{document}\n");
if(tikzInfo->debug == TRUE)
printOutput(tikzInfo,
"%% Calculated string width %d times\n",
tikzInfo->stringWidthCalls);
/* Close the file and destroy the tikzInfo structure. */
if(tikzInfo->console == FALSE)
fclose(tikzInfo->outputFile);
/* Deallocate pointers */
free(tikzInfo->outFileName);
free(tikzInfo);
}
static void TikZ_NewPage( const pGEcontext plotParams, pDevDesc deviceInfo ){
/* Shortcut pointers to variables of interest. */
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
if ( tikzInfo->firstPage ){
tikzInfo->firstPage = FALSE;
}else{
/* End the current TikZ environment, unless we are making bare bones code. */
if( tikzInfo->bareBones != TRUE ){
printOutput(tikzInfo, "\\end{scope}\n");
printOutput(tikzInfo, "\\end{tikzpicture}\n");
/*Next clipping region will be the first on the page*/
tikzInfo->firstClip = TRUE;
/*Show only for debugging*/
if(tikzInfo->debug == TRUE)
printOutput(tikzInfo,
"%% Beginning new tikzpicture 'page'\n");
/* Start a new TikZ envioronment. */
printOutput(tikzInfo,
"\n\\begin{tikzpicture}[x=1pt,y=1pt]\n");
} // End if not bare bones.
} /* End if first page */
/* Define default colors */
SetColor(plotParams->col, TRUE, tikzInfo);
SetFill(plotParams->fill, TRUE, tikzInfo);
/* Fill canvas background */
printOutput(tikzInfo, "\\fill[color=fillColor,");
SetAlpha(plotParams->fill, TRUE, tikzInfo);
printOutput(tikzInfo, "] (0,0) rectangle (%6.2f,%6.2f);\n",
deviceInfo->right,deviceInfo->top);
}
static void TikZ_Clip( double x0, double x1,
double y0, double y1, pDevDesc deviceInfo ){
/* Shortcut pointers to variables of interest. */
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
deviceInfo->clipBottom = y0;
deviceInfo->clipLeft = x0;
deviceInfo->clipTop = y1;
deviceInfo->clipRight = x1;
if(tikzInfo->firstClip == FALSE){
printOutput(tikzInfo, "\\end{scope}\n");
}else{
tikzInfo->firstClip = FALSE;
}
printOutput(tikzInfo, "\\begin{scope}\n");
printOutput(tikzInfo,
"\\path[clip] (%6.2f,%6.2f) rectangle (%6.2f,%6.2f);\n",
x0,y0,x1,y1);
/*
* *** UGLY HACK ***
*
* So, the device was building fine on Linux and Windows,
* but when it came time to comple the output- pdflatex
* barfed on both systems, complaining about fillColor or
* drawColor not being defined. I'm pretty sure this is
* because those color values are not preserved accross
* scopes.
*
* I'm too tired to figure out the StyleDef code in detail
* right now, so i'm tweaking the stored values here in
* the hopes that it will force a reprint of style after
* we begin a new scope.
*
* Seems to work.
*/
tikzInfo->oldFillColor = -999;
tikzInfo->oldDrawColor = -999;
tikzInfo->oldLineType = -999;
if(tikzInfo->debug == TRUE)
printOutput(tikzInfo,
"\\path[draw=red,very thick,dashed] (%6.2f,%6.2f) rectangle (%6.2f,%6.2f);\n",
x0,y0,x1,y1);
/*Define the colors for fill and border*/
StyleDef(TRUE, tikzInfo->plotParams, deviceInfo);
}
static void TikZ_Size( double *left, double *right,
double *bottom, double *top, pDevDesc deviceInfo){
/* Return canvas size. */
*bottom = deviceInfo->bottom;
*left = deviceInfo->left;
*top = deviceInfo->top;
*right = deviceInfo->right;
}
/*
* Routines for calculating text metrics:
*
* - MetricInfo
* - StrWidth
*/
/*
* This function is supposed to calculate character metrics (such as raised
* letters, stretched letters, ect). Currently the TikZ device does not
* perform such functions, so this function returns the default metrics
* the Quartz device uses when it can't think of anything else.
*
* The fact that this function is not implemented is the most likely cause
* for the *vertical* alignment of text strings being off. This shortcoming
* is most obvious when plot legends are created.
*
*/
static void TikZ_MetricInfo(int c, const pGEcontext plotParams,
double *ascent, double *descent, double *width, pDevDesc deviceInfo ){
/* Shortcut pointers to variables of interest. */
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
if (tikzInfo->engine == pdftex) {
/*
* PdfTeX can only deal with ASCII characters, check the character code c
* to see if it falls outside the range of printable characters which are:
* 32-126
*/
if( c < 32 || c > 126 ){
/* Non-printable character. Set metrics to zero and return. */
*ascent = 0.0;
*descent = 0.0;
*width = 0.0;
return;
}
}
// Calculate font scaling factor.
double fontScale = ScaleFont( plotParams, deviceInfo );
// Prepare to call back to R in order to retrieve character metrics.
SEXP namespace;
PROTECT( namespace = TIKZ_NAMESPACE );
// Call out to R to retrieve the latexParseCharForMetrics function.
// Note: this code will eventually call a different function that provides
// caching of the results. Right now we're directly calling the function
// that activates LaTeX.
SEXP metricFun = findFun(install("getLatexCharMetrics"), namespace);
SEXP RCallBack;
PROTECT( RCallBack = allocVector(LANGSXP,5) );
// Place the function into the first slot of the SEXP.
SETCAR( RCallBack, metricFun );
// Place the character code into the second slot of the SEXP.
SETCADR( RCallBack, ScalarInteger( c ) );
SET_TAG( CDR( RCallBack ), install("charCode") );
// Pass graphics parameters cex and fontface.
SETCADDR( RCallBack, ScalarReal( fontScale ) );
SET_TAG( CDDR( RCallBack ), install("cex") );
SETCADDDR( RCallBack, ScalarInteger( plotParams->fontface ) );
SET_TAG( CDR(CDDR( RCallBack )), install("face") );
/*
* Set the TeX engine based on tikzInfo
*/
switch (tikzInfo->engine) {
case pdftex:
SETCAD4R(RCallBack, mkString("pdftex"));
break;
case xetex:
SETCAD4R(RCallBack, mkString("xetex"));
break;
}
SET_TAG(CDDR(CDDR(RCallBack)), install("engine"));
SEXP RMetrics;
PROTECT( RMetrics = eval(RCallBack, namespace) );
// Recover the metrics.
*ascent = REAL(RMetrics)[0];
*descent = REAL(RMetrics)[1];
*width = REAL(RMetrics)[2];
if( tikzInfo->debug == TRUE )
printOutput( tikzInfo, "%% Calculated character metrics. ascent: %f, descent: %f, width: %f\n",
*ascent, *descent, *width);
UNPROTECT(3);
return;
}
/*
* This function is supposed to calculate the plotted with, in device raster
* units of an arbitrary string. This is perhaps the most difficult function
* that a device needs to implement. Calculating the exact with of a string
* is especially tricky because this device is designed to print characters
* in whatever font is being used in the the TeX document. The end font that
* the user decides to typeset their document in may also be unknown to the
* device. The problem is further complicated by the fact that TeX strings
* can be used directly in annotations. For example the string \textit{x}
* literaly has 10 characters but when it is actually typeset it only has
* one. Given this difficulty the function currently writes the string
* to a temporary file and calls LaTeX in order to obtain an authoratative
* measure of the string width.
*
* There is a rediculous amount of overhead involved with this process and
* the number of calls required to obtion widths for common things such as
* all the number s on a plot axes can easily add up to several seconds.
*
* However, if we do not perform string width calculation R is unable to
* properly align text in the plots R. This is something that LaTeX and
* TikZ should actually be taking care of by themselves but the current
* graphics system does not allow for this.
*
* Given that we need text strings to be aligned for good output, we are
* stuck using this inefficient hybrid system untill we think of something
* better.
*
*/
static double TikZ_StrWidth( const char *str,
const pGEcontext plotParams, pDevDesc deviceInfo ){
/* Shortcut pointers to variables of interest. */
tikzDevDesc *tikzInfo = (tikzDevDesc *) deviceInfo->deviceSpecific;
// Calculate font scaling factor.
double fontScale = ScaleFont( plotParams, deviceInfo );
/*
* New string width calculation method: call back to R
* and run the R function getLatexStrWidth.
*
* This used to be implemented as a C function, but
* the nuts and bolts were re-implemented back
* on the R side of this package. There seems to
* have been no major performance penalty associated
* with doing this.
*
* Why was it done?
*
* - Windows and Linux did not suppress the output
* of the C system call to LaTeX which resulted
* in spam and lag. In the case of Windows, a
* whole mess of CMD windows were spawned which
* eventually crashed the system.
*
* - Using R's system() call we gain a level of
* abstraction that works accross all platforms.
* We can also use functions like tempdir() to
* do the dirty work somewhere where the user
* won't have to clean it up.
*
* - If a LaTeX parser ever gets implemented, it
* will probably be easiest to implement it in
* R. If a LaTeX parser ever gets stolen from
* something like python's matplotlib, R will
* probably provide the interface. Therefore
* a callback to R may be necessary anyway.
*
* - Having C code called by R call R code is
* fucking wicked.
*
*/
/*
* Find the namespace of the TikZ package.
*/
SEXP namespace;
PROTECT( namespace = TIKZ_NAMESPACE );
// Call out to R to retrieve the getLatexStrWidth function.
SEXP widthFun = findFun(install("getLatexStrWidth"), namespace);
/*
* Create a SEXP that will be the R function call. The SEXP will have five
* components- the R function being called, the string being passed, the
* current value of the graphics parameters cex and fontface and the TeX
* engine to be used. Therefore it is allocated as a LANGSXP vector of
* length 5. This is done inside a PROTECT() function to keep the R garbage
* collector from saying "Hmmm... what's this? Looks like noone is using it
* so I guess I will nuke it."
*/
SEXP RCallBack;
PROTECT( RCallBack = allocVector(LANGSXP, 5) );
// Place the function into the first slot of the SEXP.
SETCAR( RCallBack, widthFun );
//If using the sanitize option call back to R for the sanitized string
char *cleanString = NULL;
if(tikzInfo->sanitize == TRUE){
cleanString = Sanitize( str );
// Place the sanitized string into the second slot of the SEXP.
SETCADR( RCallBack, mkString( cleanString ) );
}else{
// Place the string into the second slot of the SEXP.
SETCADR( RCallBack, mkString( str ) );
}
// Tag the string with a name, this name coressponds to the
// dummy argument of the R function getLatexStringWidth.
SET_TAG( CDR( RCallBack ), install("texString") );
// Pass graphics parameters cex and fontface.
SETCADDR( RCallBack, ScalarReal( fontScale ) );
SET_TAG( CDDR( RCallBack ), install("cex") );
SETCADDDR( RCallBack, ScalarInteger( plotParams->fontface ) );
SET_TAG( CDR(CDDR( RCallBack )), install("face") );
/*
* Set the TeX engine based on tikzInfo
*/
switch (tikzInfo->engine) {
case pdftex:
SETCAD4R(RCallBack, mkString("pdftex"));
break;
case xetex:
SETCAD4R(RCallBack, mkString("xetex"));
break;
}
SET_TAG(CDDR(CDDR(RCallBack)), install("engine"));
/*
* Call the R function, capture the result.
* PROTECT may not be necessary here, but I'm doing
* it just in case the SEXP holds a pointer to an
* R function return value that the garbage collector
* decides to nuke.
*/
SEXP RStrWidth;
PROTECT( RStrWidth = eval(RCallBack, namespace) );
/*
* Why REAL()[0] instead of asReal(CAR())? I have no fucking
* clue...
*
* After browsing Rinternals.h, the location where SEXPs and
* their access functions are defined, I have an explanation
* that seems plausible.
*
* Since getLatexStrWidth returns a single variable of a single
* type, it is returned as a vector SEXP. The value can be
* extracted to a C variable by coercing the SEXP to real and
* then accessing the first element of the resulting array.
*
* When a R function returns, or passes in the case of the
* .External call that leads into all of this code, a collection
* of *different* objects they are passed as a list instead of
* a vector. Therefore CAR is needed to access the list followed
* by coercion using asReal().
*
* Seems like this explains what is going on here, although it
* is just a wild guess on my part. Maybe I should post to
* r-devel and ask for clarification...
*
*/
double width = REAL(RStrWidth)[0];
/*
* Since we called PROTECT thrice, we must call UNPROTECT
* and pass the number 3.
*/
UNPROTECT(3);
if(tikzInfo->sanitize == TRUE){ free(cleanString); }
/*Show only for debugging*/
if(tikzInfo->debug == TRUE)
printOutput(tikzInfo,
"%% Calculated string width of %s as %f\n",str,width);
/*
* Increment the number of times this function has been called
* Used for debugging purposes.
*
*/
tikzInfo->stringWidthCalls++;
return(width);
}
/*
* Output routines
*
* - Text
* - Circle
* - Rectangle
* - Line
* - Polyline
* - Polygon
* - Path
* - Raster
*/
/*
* This function should plot a string of text at coordinates x and y with
* a rotation value specified by rot and horizontal alignment specified by
* hadj. Additional parameters such as color, font type, font style, line
* height and font size are specified in the pGEcontext variable plotParams.
*
* The rotation value is given in degrees.
*/
static void TikZ_Text( double x, double y, const char *str,
double rot, double hadj, const pGEcontext plotParams,
pDevDesc deviceInfo){
/* Shortcut pointers to variables of interest. */