forked from vedang/pdf-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
synctex_parser.c
8924 lines (8561 loc) · 331 KB
/
synctex_parser.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) 2008-2017 jerome DOT laurens AT u-bourgogne DOT fr
This file is part of the __SyncTeX__ package.
[//]: # (Latest Revision: Sun Oct 15 15:09:55 UTC 2017)
[//]: # (Version: 1.21)
See `synctex_parser_readme.md` for more details
## License
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE
Except as contained in this notice, the name of the copyright holder
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written
authorization from the copyright holder.
Acknowledgments:
----------------
The author received useful remarks from the pdfTeX developers, especially Hahn The Thanh,
and significant help from XeTeX developer Jonathan Kew
Nota Bene:
----------
If you include or use a significant part of the synctex package into a software,
I would appreciate to be listed as contributor and see "SyncTeX" highlighted.
*/
/* We assume that high level application like pdf viewers will want
* to embed this code as is. We assume that they also have locale.h and setlocale.
* For other tools such as TeXLive tools, you must define SYNCTEX_USE_LOCAL_HEADER,
* when building. You also have to create and customize synctex_parser_local.h to fit your system.
* In particular, the HAVE_LOCALE_H and HAVE_SETLOCALE macros should be properly defined.
* With this design, you should not need to edit this file. */
/**
* \file synctex_parser.c
* \brief SyncTeX file parser and controller.
* - author: Jérôme LAURENS
* \version 1.21
* \date Sun Oct 15 15:09:55 UTC 2017
*
* Reads and parse *.synctex[.gz] files,
* performs edit and display queries.
*
* See
* - synctex_scanner_new_with_output_file
* - synctex_scanner_parse
* - synctex_scanner_free
* - synctex_display_query
* - synctex_edit_query
* - synctex_scanner_next_result
* - synctex_scanner_reset_result
*
* The data is organized in a graph with multiple entries.
* The root object is a scanner, it is created with the contents on a synctex file.
* Each node of the tree is a synctex_node_t object.
* There are 3 subtrees, two of them sharing the same leaves.
* The first tree is the list of input records, where input file names are associated with tags.
* The second tree is the box tree as given by TeX when shipping pages out.
* First level objects are sheets and forms, containing boxes, glues, kerns...
* The third tree allows to browse leaves according to tag and line.
*/
# if defined(SYNCTEX_USE_LOCAL_HEADER)
# include "synctex_parser_local.h"
# else
# define HAVE_LOCALE_H 1
# define HAVE_SETLOCALE 1
# if defined(_MSC_VER)
# define SYNCTEX_INLINE __inline
# else
# define SYNCTEX_INLINE inline
# endif
# endif
#include <stdlib.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <limits.h>
#if defined(HAVE_LOCALE_H)
#include <locale.h>
#endif
/* Mark unused parameters, so that there will be no compile warnings. */
#ifdef __DARWIN_UNIX03
# define SYNCTEX_UNUSED(x) SYNCTEX_PRAGMA(unused(x))
# define SYNCTEX_PRAGMA(x) _Pragma ( #x )
#else
# define SYNCTEX_UNUSED(x) (void)(x);
#endif
#include "synctex_parser_advanced.h"
SYNCTEX_INLINE static int _synctex_abs(int x) {
return x>0? x: -x;
}
/* These are the possible extensions of the synctex file */
const char * synctex_suffix = ".synctex";
const char * synctex_suffix_gz = ".gz";
typedef synctex_node_p(*synctex_node_new_f)(synctex_scanner_p);
typedef void(*synctex_node_fld_f)(synctex_node_p);
typedef char *(*synctex_node_str_f)(synctex_node_p);
/**
* Pseudo class.
* - author: J. Laurens
*
* Each nodes has a class, it is therefore called an object.
* Each class has a unique scanner.
* Each class has a type which is a unique identifier.
* The class points to various methods,
* each of them vary amongst objects.
* Each class has a data model which stores node's attributes.
* Each class has an tree model which stores children and parent.
* Inspectors give access to data and tree elements.
*/
/* 8 fields + size: spcflnat */
typedef struct synctex_tree_model_t {
int sibling;
int parent;
int child;
int friend;
int last;
int next_hbox;
int arg_sibling;
int target;
int size;
} synctex_tree_model_s;
typedef const synctex_tree_model_s * synctex_tree_model_p;
typedef struct synctex_data_model_t {
int tag;
int line;
int column;
int h;
int v;
int width;
int height;
int depth;
int mean_line;
int weight;
int h_V;
int v_V;
int width_V;
int height_V;
int depth_V;
int name;
int page;
int size;
} synctex_data_model_s;
typedef const synctex_data_model_s * synctex_data_model_p;
typedef int (*synctex_int_getter_f)(synctex_node_p);
typedef struct synctex_tlcpector_t {
synctex_int_getter_f tag;
synctex_int_getter_f line;
synctex_int_getter_f column;
} synctex_tlcpector_s;
typedef const synctex_tlcpector_s * synctex_tlcpector_p;
static int _synctex_int_none(synctex_node_p node) {
SYNCTEX_UNUSED(node)
return 0;
}
static const synctex_tlcpector_s synctex_tlcpector_none = {
&_synctex_int_none, /* tag */
&_synctex_int_none, /* line */
&_synctex_int_none, /* column */
};
typedef struct synctex_inspector_t {
synctex_int_getter_f h;
synctex_int_getter_f v;
synctex_int_getter_f width;
synctex_int_getter_f height;
synctex_int_getter_f depth;
} synctex_inspector_s;
typedef const synctex_inspector_s * synctex_inspector_p;
static const synctex_inspector_s synctex_inspector_none = {
&_synctex_int_none, /* h */
&_synctex_int_none, /* v */
&_synctex_int_none, /* width */
&_synctex_int_none, /* height */
&_synctex_int_none, /* depth */
};
typedef float (*synctex_float_getter_f)(synctex_node_p);
typedef struct synctex_vispector_t {
synctex_float_getter_f h;
synctex_float_getter_f v;
synctex_float_getter_f width;
synctex_float_getter_f height;
synctex_float_getter_f depth;
} synctex_vispector_s;
static float _synctex_float_none(synctex_node_p node) {
SYNCTEX_UNUSED(node)
return 0;
}
static const synctex_vispector_s synctex_vispector_none = {
&_synctex_float_none, /* h */
&_synctex_float_none, /* v */
&_synctex_float_none, /* width */
&_synctex_float_none, /* height */
&_synctex_float_none, /* depth */
};
typedef const synctex_vispector_s * synctex_vispector_p;
struct synctex_class_t {
synctex_scanner_p scanner;
synctex_node_type_t type;
synctex_node_new_f new;
synctex_node_fld_f free;
synctex_node_fld_f log;
synctex_node_fld_f display;
synctex_node_str_f abstract;
synctex_tree_model_p navigator;
synctex_data_model_p modelator;
synctex_tlcpector_p tlcpector;
synctex_inspector_p inspector;
synctex_vispector_p vispector;
};
/**
* Nota bene: naming convention.
* For static API, when the name contains "proxy", it applies to proxies.
* When the name contains "noxy", it applies to non proxies only.
* When the name contains "node", well it depends...
*/
typedef synctex_node_p synctex_proxy_p;
typedef synctex_node_p synctex_noxy_p;
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark Abstract OBJECTS and METHODS
# endif
/**
* \def SYNCTEX_MSG_SEND
* \brief Takes care of sending the given message if possible.
* - parameter NODE: of type synctex_node_p
* - parameter SELECTOR: one of the class_ pointer properties
*/
# define SYNCTEX_MSG_SEND(NODE,SELECTOR) do {\
synctex_node_p N__ = NODE;\
if (N__ && N__->class_->SELECTOR) {\
(*(N__->class_->SELECTOR))(N__);\
}\
} while (synctex_NO)
/**
* Free the given node by sending the free message.
* - parameter NODE: of type synctex_node_p
*/
void synctex_node_free(synctex_node_p node) {
SYNCTEX_MSG_SEND(node,free);
}
# if defined(SYNCTEX_TESTING)
# if !defined(SYNCTEX_USE_HANDLE)
# define SYNCTEX_USE_HANDLE 1
# endif
# if !defined(SYNCTEX_USE_CHARINDEX)
# define SYNCTEX_USE_CHARINDEX 1
# endif
# endif
SYNCTEX_INLINE static synctex_node_p _synctex_new_handle_with_target(synctex_node_p target);
# if defined(SYNCTEX_USE_HANDLE)
# define SYNCTEX_SCANNER_FREE_HANDLE(SCANR) \
__synctex_scanner_free_handle(SCANR)
# define SYNCTEX_SCANNER_REMOVE_HANDLE_TO(WHAT) \
__synctex_scanner_remove_handle_to(WHAT)
# define SYNCTEX_REGISTER_HANDLE_TO(NODE) \
__synctex_scanner_register_handle_to(NODE)
# else
# define SYNCTEX_SCANNER_FREE_HANDLE(SCANR)
# define SYNCTEX_SCANNER_REMOVE_HANDLE_TO(WHAT)
# define SYNCTEX_REGISTER_HANDLE_TO(NODE)
# endif
# if defined(SYNCTEX_USE_CHARINDEX)
# define SYNCTEX_CHARINDEX(NODE) (NODE->char_index)
# define SYNCTEX_LINEINDEX(NODE) (NODE->line_index)
# define SYNCTEX_PRINT_CHARINDEX_FMT "#%i"
# define SYNCTEX_PRINT_CHARINDEX_WHAT ,SYNCTEX_CHARINDEX(node)
# define SYNCTEX_PRINT_CHARINDEX \
printf(SYNCTEX_PRINT_CHARINDEX_FMT SYNCTEX_PRINT_CHARINDEX_WHAT)
# define SYNCTEX_PRINT_LINEINDEX_FMT "L#%i"
# define SYNCTEX_PRINT_LINEINDEX_WHAT ,SYNCTEX_LINEINDEX(node)
# define SYNCTEX_PRINT_LINEINDEX \
printf(SYNCTEX_PRINT_LINEINDEX_FMT SYNCTEX_PRINT_LINEINDEX_WHAT)
# define SYNCTEX_PRINT_CHARINDEX_NL \
printf(SYNCTEX_PRINT_CHARINDEX_FMT "\n" SYNCTEX_PRINT_CHARINDEX_WHAT)
# define SYNCTEX_PRINT_LINEINDEX_NL \
printf(SYNCTEX_PRINT_CHARINDEX_FMT "\n"SYNCTEX_PRINT_LINEINDEX_WHAT)
# define SYNCTEX_IMPLEMENT_CHARINDEX(NODE,CORRECTION)\
NODE->char_index = (synctex_charindex_t)(scanner->reader->charindex_offset+SYNCTEX_CUR-SYNCTEX_START+(CORRECTION)); \
NODE->line_index = scanner->reader->line_number;
# else
# define SYNCTEX_CHARINDEX(NODE) 0
# define SYNCTEX_LINEINDEX(NODE) 0
# define SYNCTEX_PRINT_CHARINDEX_FMT
# define SYNCTEX_PRINT_CHARINDEX_WHAT
# define SYNCTEX_PRINT_CHARINDEX
# define SYNCTEX_PRINT_CHARINDEX
# define SYNCTEX_PRINT_LINEINDEX_FMT
# define SYNCTEX_PRINT_LINEINDEX_WHAT
# define SYNCTEX_PRINT_LINEINDEX
# define SYNCTEX_PRINT_CHARINDEX_NL printf("\n")
# define SYNCTEX_PRINT_LINEINDEX_NL printf("\n")
# define SYNCTEX_IMPLEMENT_CHARINDEX(NODE,CORRECTION)
# endif
/**
* The next macros are used to access the node tree info
* SYNCTEX_DATA(node) points to the first synctex integer or pointer data of node
* SYNCTEX_DATA(node)[index] is the information at index
* for example, the page of a sheet is stored in SYNCTEX_DATA(sheet)[_synctex_data_page_idx]
* - parameter NODE: of type synctex_node_p
* If the name starts with "__", the argument is nonullable
*/
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark Tree SETGET
# endif
#if SYNCTEX_DEBUG > 1000
#define SYNCTEX_PARAMETER_ASSERT(WHAT) \
do { \
if (!(WHAT)) { \
printf("! Parameter failure: %s\n",#WHAT); \
} \
} while (synctex_NO)
#define DEFINE_SYNCTEX_TREE_HAS(WHAT)\
static synctex_bool_t _synctex_tree_has_##WHAT(synctex_node_p node) {\
if (node) {\
if (node->class_->navigator->WHAT>=0) {\
return synctex_YES; \
} else {\
printf("WARNING: NO tree %s for %s\n", #WHAT, synctex_node_isa(node));\
}\
}\
return synctex_NO;\
}
#else
#define SYNCTEX_PARAMETER_ASSERT(WHAT)
#define DEFINE_SYNCTEX_TREE_HAS(WHAT) \
static synctex_bool_t _synctex_tree_has_##WHAT(synctex_node_p node) {\
return (node && (node->class_->navigator->WHAT>=0));\
}
#endif
# define DEFINE_SYNCTEX_TREE__GET(WHAT) \
SYNCTEX_INLINE static synctex_node_p __synctex_tree_##WHAT(synctex_non_null_node_p node) {\
return node->data[node->class_->navigator->WHAT].as_node;\
}
# define DEFINE_SYNCTEX_TREE_GET(WHAT) \
DEFINE_SYNCTEX_TREE__GET(WHAT) \
static synctex_node_p _synctex_tree_##WHAT(synctex_node_p node) {\
if (_synctex_tree_has_##WHAT(node)) {\
return __synctex_tree_##WHAT(node);\
}\
return 0;\
}
# define DEFINE_SYNCTEX_TREE__RESET(WHAT) \
SYNCTEX_INLINE static synctex_node_p __synctex_tree_reset_##WHAT(synctex_non_null_node_p node) {\
synctex_node_p old = node->data[node->class_->navigator->WHAT].as_node;\
node->data[node->class_->navigator->WHAT].as_node=NULL;\
return old;\
}
# define DEFINE_SYNCTEX_TREE_RESET(WHAT) \
DEFINE_SYNCTEX_TREE__RESET(WHAT) \
SYNCTEX_INLINE static synctex_node_p _synctex_tree_reset_##WHAT(synctex_node_p node) {\
return _synctex_tree_has_##WHAT(node)? \
__synctex_tree_reset_##WHAT(node): NULL; \
}
# define DEFINE_SYNCTEX_TREE__SET(WHAT) \
SYNCTEX_INLINE static synctex_node_p __synctex_tree_set_##WHAT(synctex_non_null_node_p node, synctex_node_p new_value) {\
synctex_node_p old = __synctex_tree_##WHAT(node);\
node->data[node->class_->navigator->WHAT].as_node=new_value;\
return old;\
}
# define DEFINE_SYNCTEX_TREE_SET(WHAT) \
DEFINE_SYNCTEX_TREE__SET(WHAT) \
SYNCTEX_INLINE static synctex_node_p _synctex_tree_set_##WHAT(synctex_node_p node, synctex_node_p new_value) {\
return _synctex_tree_has_##WHAT(node)?\
__synctex_tree_set_##WHAT(node,new_value):NULL;\
}
# define DEFINE_SYNCTEX_TREE__GETSETRESET(WHAT) \
DEFINE_SYNCTEX_TREE__GET(WHAT) \
DEFINE_SYNCTEX_TREE__SET(WHAT) \
DEFINE_SYNCTEX_TREE__RESET(WHAT)
# define DEFINE_SYNCTEX_TREE_GETSET(WHAT) \
DEFINE_SYNCTEX_TREE_HAS(WHAT) \
DEFINE_SYNCTEX_TREE_GET(WHAT) \
DEFINE_SYNCTEX_TREE_SET(WHAT)
# define DEFINE_SYNCTEX_TREE_GETRESET(WHAT) \
DEFINE_SYNCTEX_TREE_HAS(WHAT) \
DEFINE_SYNCTEX_TREE_GET(WHAT) \
DEFINE_SYNCTEX_TREE_RESET(WHAT)
# define DEFINE_SYNCTEX_TREE_GETSETRESET(WHAT) \
DEFINE_SYNCTEX_TREE_HAS(WHAT) \
DEFINE_SYNCTEX_TREE_GET(WHAT) \
DEFINE_SYNCTEX_TREE_SET(WHAT) \
DEFINE_SYNCTEX_TREE_RESET(WHAT)
/*
* _synctex_tree_set_... methods return the old value.
* The return value of _synctex_tree_set_child and
* _synctex_tree_set_sibling must be released somehown.
*/
DEFINE_SYNCTEX_TREE__GETSETRESET(sibling)
DEFINE_SYNCTEX_TREE_GETSETRESET(parent)
DEFINE_SYNCTEX_TREE_GETSETRESET(child)
DEFINE_SYNCTEX_TREE_GETSETRESET(friend)
DEFINE_SYNCTEX_TREE_GETSET(last)
DEFINE_SYNCTEX_TREE_GETSET(next_hbox)
DEFINE_SYNCTEX_TREE_GETSET(arg_sibling)
DEFINE_SYNCTEX_TREE_GETSETRESET(target)
#if SYNCTEX_DEBUG>1000
# undef SYNCTEX_USE_NODE_COUNT
# define SYNCTEX_USE_NODE_COUNT 1
#endif
#if SYNCTEX_USE_NODE_COUNT>0
# define SYNCTEX_DECLARE_NODE_COUNT int node_count;
# define SYNCTEX_INIT_NODE_COUNT \
do { node_count = 0; } while(synctex_NO)
#else
# define SYNCTEX_DECLARE_NODE_COUNT
# define SYNCTEX_INIT_NODE_COUNT
#endif
#if SYNCTEX_USE_NODE_COUNT>10
# define SYNCTEX_DID_NEW(N) _synctex_did_new(N)
# define SYNCTEX_WILL_FREE(N) _synctex_will_free(N)
#else
# define SYNCTEX_DID_NEW(N)
# define SYNCTEX_WILL_FREE(N)
#endif
#define SYNCTEX_HAS_CHILDREN(NODE) (NODE && _synctex_tree_child(NODE))
# ifdef __SYNCTEX_WORK__
# include "/usr/include/zlib.h"
# else
# include <zlib.h>
# endif
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark STATUS
# endif
/* When the end of the synctex file has been reached: */
# define SYNCTEX_STATUS_EOF 0
/* When the function could not return the value it was asked for: */
# define SYNCTEX_STATUS_NOT_OK (SYNCTEX_STATUS_EOF+1)
/* When the function returns the value it was asked for:
It must be the biggest one */
# define SYNCTEX_STATUS_OK (SYNCTEX_STATUS_NOT_OK+1)
/* Generic error: */
# define SYNCTEX_STATUS_ERROR (SYNCTEX_STATUS_EOF-1)
/* Parameter error: */
# define SYNCTEX_STATUS_BAD_ARGUMENT (SYNCTEX_STATUS_ERROR-1)
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark File reader
# endif
/* We ensure that SYNCTEX_BUFFER_SIZE < UINT_MAX, I don't know if it makes sense... */
/* Actually, the minimum buffer size is driven by integer and float parsing, including the unit.
* ±0.123456789e123??
*/
# define SYNCTEX_BUFFER_MIN_SIZE 32
# define SYNCTEX_BUFFER_SIZE 32768
#if SYNCTEX_BUFFER_SIZE >= UINT_MAX
# error BAD BUFFER SIZE(1)
#endif
#if SYNCTEX_BUFFER_SIZE < SYNCTEX_BUFFER_MIN_SIZE
# error BAD BUFFER SIZE(2)
#endif
typedef struct synctex_reader_t {
gzFile file; /* The (possibly compressed) file */
char * output;
char * synctex;
char * current; /* current location in the buffer */
char * start; /* start of the buffer */
char * end; /* end of the buffer */
size_t min_size;
size_t size;
int lastv;
int line_number;
SYNCTEX_DECLARE_CHAR_OFFSET
} synctex_reader_s;
typedef synctex_reader_s * synctex_reader_p;
typedef struct {
synctex_status_t status;
char * synctex;
gzFile file;
synctex_io_mode_t io_mode;
} synctex_open_s;
/* This functions opens the file at the "output" given location.
* It manages the problem of quoted filenames that appear with pdftex and filenames containing the space character.
* In TeXLive 2008, the synctex file created with pdftex did contain unexpected quotes.
* This function will remove them if possible.
* All the reference arguments will take a value on return. They must be non NULL.
* - returns: an open structure which status is
* SYNCTEX_STATUS_OK on success,
* SYNCTEX_STATUS_ERROR on failure.
* - note: on success, the caller is the owner
* of the fields of the returned open structure.
*/
static synctex_open_s __synctex_open_v2(const char * output, synctex_io_mode_t io_mode, synctex_bool_t add_quotes) {
synctex_open_s open = {SYNCTEX_STATUS_ERROR, NULL, NULL, io_mode};
char * quoteless_synctex_name = NULL;
const char * mode = _synctex_get_io_mode_name(open.io_mode);
size_t size = strlen(output)+strlen(synctex_suffix)+strlen(synctex_suffix_gz)+1;
if (NULL == (open.synctex = (char *)malloc(size))) {
_synctex_error("! __synctex_open_v2: Memory problem (1)\n");
return open;
}
/* we have reserved for synctex enough memory to copy output (including its 2 eventual quotes), both suffices,
* including the terminating character. size is free now. */
if (open.synctex != strcpy(open.synctex,output)) {
_synctex_error("! __synctex_open_v2: Copy problem\n");
return_on_error:
free(open.synctex);
open.synctex = NULL;
free(quoteless_synctex_name);/* We MUST have quoteless_synctex_name<>synctex_name */
return open;
}
/* remove the last path extension if any */
_synctex_strip_last_path_extension(open.synctex);
if (!strlen(open.synctex)) {
goto return_on_error;
}
/* now insert quotes. */
if (add_quotes) {
char * quoted = NULL;
if (_synctex_copy_with_quoting_last_path_component(open.synctex,"ed,size) || quoted == NULL) {
/* There was an error or quoting does not make sense: */
goto return_on_error;
}
quoteless_synctex_name = open.synctex;
open.synctex = quoted;
}
/* Now add to open.synctex the first path extension. */
if (open.synctex != strcat(open.synctex,synctex_suffix)){
_synctex_error("! __synctex_open_v2: Concatenation problem (can't add suffix '%s')\n",synctex_suffix);
goto return_on_error;
}
/* Add to quoteless_synctex_name as well, if relevant. */
if (quoteless_synctex_name && (quoteless_synctex_name != strcat(quoteless_synctex_name,synctex_suffix))){
free(quoteless_synctex_name);
quoteless_synctex_name = NULL;
}
if (NULL == (open.file = gzopen(open.synctex,mode))) {
/* Could not open this file */
if (errno != ENOENT) {
/* The file does exist, this is a lower level error, I can't do anything. */
_synctex_error("could not open %s, error %i\n",open.synctex,errno);
goto return_on_error;
}
/* Apparently, there is no uncompressed synctex file. Try the compressed version */
if (open.synctex != strcat(open.synctex,synctex_suffix_gz)){
_synctex_error("! __synctex_open_v2: Concatenation problem (can't add suffix '%s')\n",synctex_suffix_gz);
goto return_on_error;
}
open.io_mode |= synctex_io_gz_mask;
mode = _synctex_get_io_mode_name(open.io_mode); /* the file is a compressed and is a binary file, this caused errors on Windows */
/* Add the suffix to the quoteless_synctex_name as well. */
if (quoteless_synctex_name && (quoteless_synctex_name != strcat(quoteless_synctex_name,synctex_suffix_gz))){
free(quoteless_synctex_name);
quoteless_synctex_name = NULL;
}
if (NULL == (open.file = gzopen(open.synctex,mode))) {
/* Could not open this file */
if (errno != ENOENT) {
/* The file does exist, this is a lower level error, I can't do anything. */
_synctex_error("Could not open %s, error %i\n",open.synctex,errno);
}
goto return_on_error;
}
}
/* At this point, the file is properly open.
* If we are in the add_quotes mode, we change the file name by removing the quotes. */
if (quoteless_synctex_name) {
gzclose(open.file);
if (rename(open.synctex,quoteless_synctex_name)) {
_synctex_error("Could not rename %s to %s, error %i\n",open.synctex,quoteless_synctex_name,errno);
/* We could not rename, reopen the file with the quoted name. */
if (NULL == (open.file = gzopen(open.synctex,mode))) {
/* No luck, could not re open this file, something has happened meanwhile */
if (errno != ENOENT) {
/* The file does not exist any more, it has certainly be removed somehow
* this is a lower level error, I can't do anything. */
_synctex_error("Could not open again %s, error %i\n",open.synctex,errno);
}
goto return_on_error;
}
} else {
/* The file has been successfully renamed */
if (NULL == (open.file = gzopen(quoteless_synctex_name,mode))) {
/* Could not open this file */
if (errno != ENOENT) {
/* The file does exist, this is a lower level error, I can't do anything. */
_synctex_error("Could not open renamed %s, error %i\n",quoteless_synctex_name,errno);
}
goto return_on_error;
}
/* The quote free file name should replace the old one:*/
free(open.synctex);
open.synctex = quoteless_synctex_name;
quoteless_synctex_name = NULL;
}
}
/* The operation is successful, return the arguments by value. */
open.status = SYNCTEX_STATUS_OK;
return open;
}
/* Opens the output file, taking into account the eventual build_directory.
* - returns: an open structure which status is
* SYNCTEX_STATUS_OK on success,
* SYNCTEX_STATUS_ERROR on failure.
* - note: on success, the caller is the owner
* of the fields of the returned open structure.
*/
static synctex_open_s _synctex_open_v2(const char * output, const char * build_directory, synctex_io_mode_t io_mode, synctex_bool_t add_quotes) {
synctex_open_s open = __synctex_open_v2(output,io_mode,add_quotes);
if (open.status == SYNCTEX_STATUS_OK) {
return open;
}
if (build_directory && strlen(build_directory)) {
char * build_output;
const char *lpc;
size_t size;
synctex_bool_t is_absolute;
build_output = NULL;
lpc = _synctex_last_path_component(output);
size = strlen(build_directory)+strlen(lpc)+2; /* One for the '/' and one for the '\0'. */
is_absolute = _synctex_path_is_absolute(build_directory);
if (!is_absolute) {
size += strlen(output);
}
if ((build_output = (char *)_synctex_malloc(size))) {
if (is_absolute) {
build_output[0] = '\0';
} else {
if (build_output != strcpy(build_output,output)) {
_synctex_free(build_output);
return open;
}
build_output[lpc-output]='\0';
}
if (build_output == strcat(build_output,build_directory)) {
/* Append a path separator if necessary. */
if (!SYNCTEX_IS_PATH_SEPARATOR(build_output[strlen(build_directory)-1])) {
if (build_output != strcat(build_output,"/")) {
_synctex_free(build_output);
return open;
}
}
/* Append the last path component of the output. */
if (build_output != strcat(build_output,lpc)) {
_synctex_free(build_output);
return open;
}
open = __synctex_open_v2(build_output,io_mode,add_quotes);
}
_synctex_free(build_output);
} /* if ((build_output... */
} /* if (build_directory...) */
return open;
}
void synctex_reader_free(synctex_reader_p reader) {
if (reader) {
_synctex_free(reader->output);
_synctex_free(reader->synctex);
_synctex_free(reader->start);
gzclose(reader->file);
_synctex_free(reader);
}
}
/*
* Return reader on success.
* Deallocate reader and return NULL on failure.
*/
synctex_reader_p synctex_reader_init_with_output_file(synctex_reader_p reader, const char * output, const char * build_directory) {
if (reader) {
/* now open the synctex file */
synctex_open_s open = _synctex_open_v2(output,build_directory,0,synctex_ADD_QUOTES);
if (open.status<SYNCTEX_STATUS_OK) {
open = _synctex_open_v2(output,build_directory,0,synctex_DONT_ADD_QUOTES);
if (open.status<SYNCTEX_STATUS_OK) {
return NULL;
}
}
reader->synctex = open.synctex;
reader->file = open.file;
/* make a private copy of output */
if (NULL == (reader->output = (char *)_synctex_malloc(strlen(output)+1))){
_synctex_error("! synctex_scanner_new_with_output_file: Memory problem (2), reader's output is not reliable.");
} else if (reader->output != strcpy(reader->output,output)) {
_synctex_free(reader->output);
reader->output = NULL;
_synctex_error("! synctex_scanner_new_with_output_file: Copy problem, reader's output is not reliable.");
}
reader->start = reader->end = reader->current = NULL;
reader->min_size = SYNCTEX_BUFFER_MIN_SIZE;
reader->size = SYNCTEX_BUFFER_SIZE;
reader->start = reader->current =
(char *)_synctex_malloc(reader->size+1); /* one more character for null termination */
if (NULL == reader->start) {
_synctex_error("! malloc error in synctex_reader_init_with_output_file.");
bailey:
#ifdef SYNCTEX_DEBUG
return reader;
#else
synctex_reader_free(reader);
return NULL;
#endif
}
reader->end = reader->start+reader->size;
/* reader->end always points to a null terminating character.
* Maybe there is another null terminating character between reader->current and reader->end-1.
* At least, we are sure that reader->current points to a string covering a valid part of the memory. */
# if defined(SYNCTEX_USE_CHARINDEX)
reader->charindex_offset = -reader->size;
# endif
}
return reader;
}
# if defined(SYNCTEX_USE_HANDLE)
# define SYNCTEX_DECLARE_HANDLE synctex_node_p handle;
# else
# define SYNCTEX_DECLARE_HANDLE
# endif
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark SCANNER
# endif
/**
* The synctex scanner is the root object.
* Is is initialized with the contents of a text file or a gzipped file.
* The buffer_.* are first used to parse the text.
*/
struct synctex_scanner_t {
synctex_reader_p reader;
SYNCTEX_DECLARE_NODE_COUNT
SYNCTEX_DECLARE_HANDLE
char * output_fmt; /* dvi or pdf, not yet used */
synctex_iterator_p iterator;/* result iterator */
int version; /* 1, not yet used */
struct {
unsigned has_parsed:1; /* Whether the scanner has parsed its underlying synctex file. */
unsigned postamble:1; /* Whether the scanner has parsed its underlying synctex file. */
unsigned reserved:sizeof(unsigned)-2; /* alignment */
} flags;
int pre_magnification; /* magnification from the synctex preamble */
int pre_unit; /* unit from the synctex preamble */
int pre_x_offset; /* X offset from the synctex preamble */
int pre_y_offset; /* Y offset from the synctex preamble */
int count; /* Number of records, from the synctex postamble */
float unit; /* real unit, from synctex preamble or post scriptum */
float x_offset; /* X offset, from synctex preamble or post scriptum */
float y_offset; /* Y Offset, from synctex preamble or post scriptum */
synctex_node_p input; /* The first input node, its siblings are the other input nodes */
synctex_node_p sheet; /* The first sheet node, its siblings are the other sheet nodes */
synctex_node_p form; /* The first form, its siblings are the other forms */
synctex_node_p ref_in_sheet; /* The first form ref node in sheet, its friends are the other form ref nodes */
synctex_node_p ref_in_form; /* The first form ref node, its friends are the other form ref nodes in sheet */
int number_of_lists; /* The number of friend lists */
synctex_node_r lists_of_friends;/* The friend lists */
synctex_class_s class_[synctex_node_number_of_types]; /* The classes of the nodes of the scanner */
int display_switcher;
char * display_prompt;
};
/**
* Create a new node of the given type.
* - parameter scanner: of type synctex_node_p
* - parameter type: a type, the client is responsible
* to ask for an acceptable type.
*/
synctex_node_p synctex_node_new(synctex_scanner_p scanner, synctex_node_type_t type) {
return scanner? scanner->class_[type].new(scanner):NULL;
}
# if defined(SYNCTEX_USE_HANDLE)
SYNCTEX_INLINE static void __synctex_scanner_free_handle(synctex_scanner_p scanner) {
synctex_node_free(scanner->handle);
}
SYNCTEX_INLINE static void __synctex_scanner_remove_handle_to(synctex_node_p node) {
synctex_node_p arg_sibling = NULL;
synctex_node_p handle = node->class_->scanner->handle;
while (handle) {
synctex_node_p sibling;
if (node == _synctex_tree_target(handle)) {
sibling = __synctex_tree_reset_sibling(handle);
if (arg_sibling) {
__synctex_tree_set_sibling(arg_sibling, sibling);
} else {
node->class_->scanner->handle = sibling;
}
synctex_node_free(handle);
break;
} else {
sibling = __synctex_tree_sibling(handle);
}
arg_sibling = handle;
handle = sibling;
}
}
SYNCTEX_INLINE static void __synctex_scanner_register_handle_to(synctex_node_p node) {
synctex_node_p NNN = _synctex_new_handle_with_target(node);
__synctex_tree_set_sibling(NNN,node->class_->scanner->handle);
node->class_->scanner->handle = NNN;
}
#endif
#if SYNCTEX_USE_NODE_COUNT>10
SYNCTEX_INLINE static void _synctex_did_new(synctex_node_p node) {
printf("NODE CREATED # %i, %s, %p\n",
(node->class_->scanner->node_count)++,
synctex_node_isa(node),
node);
}
SYNCTEX_INLINE static void _synctex_will_free(synctex_node_p node) {
printf("NODE DELETED # %i, %s, %p\n",
--(node->class_->scanner->node_count),
synctex_node_isa(node),
node);
}
#endif
/**
* Free the given node.
* - parameter node: of type synctex_node_p
* - note: a node is meant to own its child and sibling.
* It is not owned by its parent, unless it is its first child.
* This destructor is for all nodes with children.
*/
static void _synctex_free_node(synctex_node_p node) {
if (node) {
SYNCTEX_SCANNER_REMOVE_HANDLE_TO(node);
SYNCTEX_WILL_FREE(node);
synctex_node_free(__synctex_tree_sibling(node));
synctex_node_free(_synctex_tree_child(node));
_synctex_free(node);
}
return;
}
/**
* Free the given handle.
* - parameter node: of type synctex_node_p
* - note: a node is meant to own its child and sibling.
* It is not owned by its parent, unless it is its first child.
* This destructor is for all handles.
*/
static void _synctex_free_handle(synctex_node_p handle) {
if (handle) {
_synctex_free_handle(__synctex_tree_sibling(handle));
_synctex_free_handle(_synctex_tree_child(handle));
_synctex_free(handle);
}
return;
}
/**
* Free the given leaf node.
* - parameter node: of type synctex_node_p, with no child nor sibling.
* - note: a node is meant to own its child and sibling.
* It is not owned by its parent, unless it is its first child.
* This destructor is for all nodes with no children.
*/
static void _synctex_free_leaf(synctex_node_p node) {
if (node) {
SYNCTEX_SCANNER_REMOVE_HANDLE_TO(node);
SYNCTEX_WILL_FREE(node);
synctex_node_free(__synctex_tree_sibling(node));
_synctex_free(node);
}
return;
}
/**
SYNCTEX_CUR, SYNCTEX_START and SYNCTEX_END are convenient shortcuts
*/
# define SYNCTEX_CUR (scanner->reader->current)
# define SYNCTEX_START (scanner->reader->start)
# define SYNCTEX_END (scanner->reader->end)
/* Here are gathered all the possible status that the next scanning functions will return.
* All these functions return a status, and pass their result through pointers.
* Negative values correspond to errors.
* The management of the buffer is causing some significant overhead.
* Every function that may access the buffer returns a status related to the buffer and file state.
* status >= SYNCTEX_STATUS_OK means the function worked as expected
* status < SYNCTEX_STATUS_OK means the function did not work as expected
* status == SYNCTEX_STATUS_NOT_OK means the function did not work as expected but there is still some material to parse.
* status == SYNCTEX_STATUS_EOF means the function did not work as expected and there is no more material.
* status<SYNCTEX_STATUS_EOF means an error
*/
#if defined(SYNCTEX_USE_CHARINDEX)
synctex_node_p synctex_scanner_handle(synctex_scanner_p scanner) {
return scanner? scanner->handle:NULL;
}
#endif
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark Decoding prototypes
# endif
typedef struct {
int integer;
synctex_status_t status;
} synctex_is_s;
static synctex_is_s _synctex_decode_int(synctex_scanner_p scanner);
static synctex_is_s _synctex_decode_int_opt(synctex_scanner_p scanner, int default_value);
static synctex_is_s _synctex_decode_int_v(synctex_scanner_p scanner);
typedef struct {
char * string;
synctex_status_t status;
} synctex_ss_s;
static synctex_ss_s _synctex_decode_string(synctex_scanner_p scanner);
# ifdef SYNCTEX_NOTHING
# pragma mark -
# pragma mark Data SETGET
# endif
/**
* The next macros are used to access the node data info
* through the class modelator integer fields.
* - parameter NODE: of type synctex_node_p
*/
# define SYNCTEX_DATA(NODE) ((*((((NODE)->class_))->info))(NODE))
#if defined SYNCTEX_DEBUG > 1000
# define DEFINE_SYNCTEX_DATA_HAS(WHAT) \
SYNCTEX_INLINE static synctex_bool_t __synctex_data_has_##WHAT(synctex_node_p node) {\
return (node && (node->class_->modelator->WHAT>=0));\
}\
SYNCTEX_INLINE static synctex_bool_t _synctex_data_has_##WHAT(synctex_node_p node) {\
if (node && (node->class_->modelator->WHAT<0)) {\
printf("WARNING: NO %s for %s\n", #WHAT, synctex_node_isa(node));\
}\
return __synctex_data_has_##WHAT(node);\
}
#else
# define DEFINE_SYNCTEX_DATA_HAS(WHAT) \
SYNCTEX_INLINE static synctex_bool_t __synctex_data_has_##WHAT(synctex_node_p node) {\
return (node && (node->class_->modelator->WHAT>=0));\
}\
SYNCTEX_INLINE static synctex_bool_t _synctex_data_has_##WHAT(synctex_node_p node) {\
return __synctex_data_has_##WHAT(node);\
}
#endif
SYNCTEX_INLINE static synctex_data_p __synctex_data(synctex_node_p node) {
return node->data+node->class_->navigator->size;
}