summaryrefslogtreecommitdiff
path: root/Build/source/texk/web2c/synctexdir/synctex_main.c
blob: e8436943b1d0688e6079f6078235faa5e69f98c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
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
/* 
Copyright (c) 2008, 2009 jerome DOT laurens AT u-bourgogne DOT fr

This file is part of the SyncTeX package.

Latest Revision: Wed Jul  1 11:18:13 UTC 2009

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.

Version 1.2
Thu Jun 19 09:39:21 UTC 2008

History:
--------

- the -d option for an input directory

Important notice:
-----------------
This file is named "synctex_main.c".
This is the command line interface to the synctex_parser.c.
*/

#   include "web2c/c-auto.h" /* for inline && HAVE_xxx */

#   include <stdlib.h>
#   include <stdio.h>
#   include <string.h>
#   include <stdarg.h>
#   include <math.h>
#   include "synctex_parser.h"
#   include "synctex_parser_utils.h"

/*  The code below uses strlcat and strlcpy, which avoids security warnings with some compilers.
    However, if these are not available we simply use the old, unchecked versions;
    this is OK because all the uses in this code are working with a buffer that's been
    allocated based on measuring the strings involved. */
#   ifndef HAVE_STRLCAT
#       define strlcat(dst, src, size) strcat((dst), (src))
#   endif
#   ifndef HAVE_STRLCPY
#       define strlcpy(dst, src, size) strcpy((dst), (src))
#   endif
#   ifndef HAVE_FMAX
#       define fmax my_fmax
inline static double my_fmax(double x, double y) { return (x < y) ? y : x; }
#   endif

#if SYNCTEX_DEBUG
#   include "unistd.h"
#endif

int main(int argc, char *argv[]);

void synctex_help(const char * error,...);
void synctex_help_view(const char * error,...);
void synctex_help_edit(const char * error,...);
void synctex_help_update(const char * error,...);

int synctex_view(int argc, char *argv[]);
int synctex_edit(int argc, char *argv[]);
int synctex_update(int argc, char *argv[]);
int synctex_test(int argc, char *argv[]);

int main(int argc, char *argv[])
{
	int arg_index = 1;
	printf("This is SyncTeX command line utility, version 1.2\n");
	if(arg_index<argc) {
		if(0==strcmp("help",argv[arg_index])) {
			if(++arg_index<argc) {
				if(0==strcmp("view",argv[arg_index])) {
					synctex_help_view(NULL);
					return 0;
				} else if(0==strcmp("edit",argv[arg_index])) {
					synctex_help_edit(NULL);
					return 0;
				} else if(0==strcmp("update",argv[arg_index])) {
					synctex_help_update(NULL);
					return 0;
				}
			}
			synctex_help(NULL);
			return 0;
		} else if(0==strcmp("view",argv[arg_index])) {
			return synctex_view(argc-arg_index-1,argv+arg_index+1);
		} else if(0==strcmp("edit",argv[arg_index])) {
			return synctex_edit(argc-arg_index-1,argv+arg_index+1);
		} else if(0==strcmp("update",argv[arg_index])) {
			return synctex_update(argc-arg_index-1,argv+arg_index+1);
		} else if(0==strcmp("test",argv[arg_index])) {
			return synctex_test(argc-arg_index-1,argv+arg_index+1);
		}
	}
	synctex_help("Missing options");
	return 0;
}

static void synctex_usage(const char * error,va_list ap) {
	if(error) {
		fprintf(stderr,"SyncTeX ERROR: ");
		vfprintf(stderr,error,ap);
		fprintf(stderr,"\n");
	}
	fprintf((error?stderr:stdout),
		"usage: synctex <subcommand> [options] [args]\n"
		"Synchronize TeXnology command-line client, version 1.2\n\n"
		"The Synchronization TeXnology by Jérôme Laurens is a new feature of recent TeX engines.\n"
		"It allows to synchronize between input and output, which means to\n"
		"navigate from the source document to the typeset material and vice versa.\n\n"
	);
	return;
}

void synctex_help(const char * error,...) {
	va_list v;
	va_start(v, error);
	synctex_usage(error, v);
	va_end(v);
	fprintf((error?stderr:stdout),
		"Available subcommands:\n"
		"   view     to perform forwards synchronization\n"
		"   edit     to perform backwards synchronization\n"
		"   update   to update a synctex file after a dvi/xdv to pdf filter\n"
		"   help     this help\n\n"
		"Type 'synctex help <subcommand>' for help on a specific subcommand.\n"
		"There is also an undocumented test subcommand.\n"
	);
	return;
}

void synctex_help_view(const char * error,...) {
	va_list v;
	va_start(v, error);
	synctex_usage(error, v);
	va_end(v);
	fputs("synctex view: forwards or direct synchronization,\n"
		"command sent by the editor to view the output corresponding to the position under the mouse\n"
		"\n"
		"usage: synctex view -i line:column:input -o output [-d directory] [-x viewer-command] [-h before/offset:middle/after]\n"
		"\n"
		"-i line:column:input\n"
		"       specify the line, column and input file.\n"
		"       The line and column are 1 based integers,\n"
		"       they allow to identify every character in a file.\n"
		"       column is the offset of a character relative to the containing line.\n"
		"       Pass 0 if this information is not relevant.\n"
		"       input is either the name of the main source file or an included document.\n"
		"       It must be the very name as understood by TeX, id est the name exactly as it appears in the log file.\n"
		"       It does not matter if the file actually exists or not, except that the command is not really useful.\n"
		"       \n"
		"-o output\n"
		"       is the full or relative path of the output file (with any relevant path extension).\n"
		"       This file must exist.\n"
		"       \n"
		"-d directory\n"
		"       is the directory containing the synctex file, in case it is different from the directory of the output.\n"
		"       This directory must exist.\n"
		"       An example will explain how things work: for synctex -o ...:bar.tex -d foo,\n"
		"       the chosen synctex file is the most recent among bar.synctex, bar.synctex.gz, foo/bar.synctex and foo/bar.synctex.gz.\n"
		"		The other ones are simply removed, if the authorization is granted\n"
		"       \n"
		"-x viewer-command\n"
		"       Normally the synctex tool outputs its result to the stdout.\n"
		"       It is possible to launch an external tool with the result.\n"
		"       The viewer-command is a printf like format string with following specifiers.\n"
		"       %{output} is the name specifier of the main document, without path extension.\n"
		"       %{page} is the 0 based page number specifier, %{page+1} is the 1 based page number specifier.\n"
		"       To synchronize by point, %{x} is the x coordinate specifier, %{y} is the y coordinate specifier,\n"
		"       both in dots and relative to the top left corner of the page.\n"
		"       To synchronize by box,\n"
		"       %{h} is the horizontal coordinate specifier of the origin of the enclosing box,\n"
		"       %{v} is the vertical coordinate specifier of the origin of the enclosing box,\n"
		"       both in dots and relative to the upper left corner of the page.\n"
		"       They may be different from the preceding pair of coordinates.\n"
		"       %{width} is the width specifier, %{height} is the height specifier of the enclosing box.\n"
		"       The latter dimension is naturally counted from bottom to top.\n"
		"       There is no notion of depth for such a box.\n"
		"       To synchronize by content, %{before} is the word before,\n"
		"       %{offset} is the offset specifier, %{middle} is the middle word, and %{after} is the word after.\n"
		"\n"
		"       If no viewer command is provided, the content of the SYNCTEX_VIEWER environment variable is used instead.\n"
		"\n"
		"-h before/offset:middle/after\n"
		"       This hint allows a forwards synchronization by contents.\n"
		"       Instead of giving a character offset in a line, you can give full words.\n"
		"       A full word is a sequence of characters (excepting '/').\n"
		"       You will choose full words in the source document that will certainly appear unaltered in the output.\n"
		"       The \"middle\" word contains the character under the mouse at position offset.\n"
		"       \"before\" is a full word preceding middle and \"after\" is following it.\n"
		"       The before or after word can be missing, they are then considered as void strings.\n"
		"       \n"
		"The result is a list of records. In general the first one is the most accurate but\n"
		"it is the responsibility of the client to decide which one best fits the user needs.\n",
		(error?stderr:stdout)
	);
	return;
}

typedef struct {
	int line;
	int column;
	unsigned int offset;
	char * input;
	char * output;
	char * directory;
	char * viewer;
	char * before;
	char * middle;
	char * after;
} synctex_view_params_t;

int synctex_view_proceed(synctex_view_params_t * paramsRef);

/* "usage: synctex view -i line:column:input -o output [-d directory] [-x viewer-command] [-h before/offset:middle/after]\n" */
int synctex_view(int argc, char *argv[]) {
	int arg_index = 0;
	char * start = NULL;
	char * end = NULL;
	synctex_view_params_t Ps = {-1,0,0,NULL,NULL,NULL,NULL,NULL,NULL,NULL};
		
	/* required */
	if((arg_index>=argc) || strcmp("-i",argv[arg_index]) || (++arg_index>=argc)) {
		synctex_help_view("Missing -i required argument");
		return -1;
	}
	start = argv[arg_index];
	Ps.line = strtol(start,&end,10);
	if(end>start && strlen(end)>0 && *end==':') {
		start = end+1;
		Ps.column = strtol(start,&end,10);
		if(end == start || Ps.column < 0) {
			Ps.column = 0;
		}
		if(strlen(end)>1 && *end==':') {
			Ps.input = end+1;
			goto scan_output;
		}
	}
	synctex_help_view("Bad -i argument");
	return -1;
scan_output:
	if((++arg_index>=argc) || strcmp("-o",argv[arg_index]) || (++arg_index>=argc)) {
		synctex_help_view("Missing -o required argument");
		return -1;
	}
	Ps.output = argv[arg_index];
	/* now scan the optional arguments */
	if(++arg_index<argc) {
		if(0 == strcmp("-d",argv[arg_index])) {
			if(++arg_index<argc) {
				Ps.directory = argv[arg_index];
				if(++arg_index<argc) {
					goto option_command;
				} else {
					synctex_view_proceed(&Ps);
				}
			} else {
				Ps.directory = getenv("SYNCTEX_BUILD_DIRECTORY");
				synctex_view_proceed(&Ps);
			}
		}
option_command:
		if(0 == strcmp("-x",argv[arg_index])) {
			if(++arg_index<argc) {
				if(strcmp("-",argv[arg_index])) {
					/* next option does not start with '-', this is a command */
					Ps.viewer = argv[arg_index];
					if(++arg_index<argc) {
						goto option_hint;
					} else {
						synctex_view_proceed(&Ps);
					}
				} else {
					/* retrieve the environment variable */
					Ps.viewer = getenv("SYNCTEX_VIEWER");
					goto option_hint;
				}
			} else {
				Ps.viewer = getenv("SYNCTEX_VIEWER");
				synctex_view_proceed(&Ps);
			}
		}
option_hint:
		if(0 == strcmp("-h",argv[arg_index]) && ++arg_index<argc) {
			/* modify the argument */;
			Ps.after = strstr(argv[arg_index],"/");
			if(NULL != Ps.after) {
				Ps.before = argv[arg_index];
				*Ps.after = '\0';
				++Ps.after;
				Ps.offset = strtoul(Ps.after,&Ps.middle,10);
				if(Ps.middle>Ps.after && strlen(Ps.middle)>2) {
					Ps.after = strstr(++Ps.middle,"/");
					if(NULL != Ps.after) {
						*Ps.after = '\0';
						if(Ps.offset<strlen(Ps.middle)) {
							++Ps.after;
							synctex_view_proceed(&Ps);
						}
					}
				}
			}
			synctex_help_view("Bad hint");
			return -1;
		}
	}
	return synctex_view_proceed(&Ps);
}

int synctex_view_proceed(synctex_view_params_t * Ps) {
	synctex_scanner_t scanner = NULL;
	size_t size = 0;
#if SYNCTEX_DEBUG
	printf("line:%i\n",Ps->line);
	printf("column:%i\n",Ps->column);
	printf("input:%s\n",Ps->input);
	printf("viewer:%s\n",Ps->viewer);
	printf("before:%s\n",Ps->before);
	printf("offset:%i\n",Ps->offset);
	printf("middle:%s\n",Ps->middle);
	printf("after:%s\n",Ps->after);
	printf("output:%s\n",Ps->output);
	printf("cwd:%s\n",getcwd(NULL,0));
#endif
	/*  We assume that viewer is not so big: */
#   define SYNCTEX_STR_SIZE 65536
	if(Ps->viewer && strlen(Ps->viewer)>=SYNCTEX_STR_SIZE) {
		synctex_help_view("Viewer command is too long");
		return -1;
	}
	scanner = synctex_scanner_new_with_output_file(Ps->output,Ps->directory,1);
	if(scanner && synctex_display_query(scanner,Ps->input,Ps->line,Ps->column)) {
		synctex_node_t node = NULL;
		if((node = synctex_next_result(scanner)) != NULL) {
			/* filtering the command */
			if(Ps->viewer && strlen(Ps->viewer)) {
				char * viewer = Ps->viewer;
				char * where = NULL;
				char * buffer = NULL;
				char * buffer_cur = NULL;
				int printed = 0;
				int status = 0;
				/* Preparing the buffer where everything will be printed */
				size = strlen(viewer)+3*sizeof(int)+6*sizeof(float)+4*(SYNCTEX_STR_SIZE);
				buffer = malloc(size+1);
				if(NULL == buffer) {
					synctex_help_view("No memory available");
					return -1;
				}
				/*  Properly terminate the buffer, no bad access for string related functions. */
				buffer[size] = '\0';
				/* Replace %{ by &{, then remove all unescaped '%'*/
				while((where = strstr(viewer,"%{")) != NULL) {
					*where = '&';
				}
				/* find all the unescaped '%', change to a safe character */
				where = viewer;
				while(where && (where = strstr(where,"%"))) {
					/*  Find the next occurrence of a "%",
					 *  if it is not followed by another "%",
					 *  replace it by a "&" */
					if(strlen(++where)) {
						if(*where == '%') {
							++where;
						} else {
							*(where-1)='&';
						}
					}
				}
				buffer_cur = buffer;
				/*  find the next occurrence of a format key */
				where = viewer;
				while(viewer && (where = strstr(viewer,"&{"))) {
					#define TEST(KEY,FORMAT,WHAT)\
					if(!strncmp(where,KEY,strlen(KEY))) {\
						printed = where-viewer;\
						if(buffer_cur != memcpy(buffer_cur,viewer,(size_t)printed)) {\
							synctex_help_view("Memory copy problem");\
							free(buffer);\
							return -1;\
						}\
						buffer_cur += printed;size-=printed;\
						printed = snprintf(buffer_cur,size,FORMAT,WHAT);\
						buffer_cur += printed;size-=printed;\
						*buffer_cur='\0';\
						viewer = where+strlen(KEY);\
						continue;\
					}
					TEST("&{output}","%s",synctex_scanner_get_output(scanner));
					TEST("&{page}",  "%i",synctex_node_page(node)-1);
					TEST("&{page+1}","%i",synctex_node_page(node));
					TEST("&{x}",     "%f",synctex_node_visible_h(node));
					TEST("&{y}",     "%f",synctex_node_visible_v(node));
					TEST("&{h}",     "%f",synctex_node_box_visible_h(node));
					TEST("&{v}",     "%f",synctex_node_box_visible_v(node)+synctex_node_box_visible_depth(node));
					TEST("&{width}", "%f",fabs(synctex_node_box_visible_width(node)));
					TEST("&{height}","%f",fmax(synctex_node_box_visible_height(node)+synctex_node_box_visible_depth(node),1));
					TEST("&{before}","%s",(Ps->before && strlen(Ps->before)<SYNCTEX_STR_SIZE?Ps->before:""));
					TEST("&{offset}","%i",Ps->offset);
					TEST("&{middle}","%s",(Ps->middle && strlen(Ps->middle)<SYNCTEX_STR_SIZE?Ps->middle:""));
					TEST("&{after}", "%s",(Ps->after && strlen(Ps->after)<SYNCTEX_STR_SIZE?Ps->after:""));
					#undef TEST
					break;
				}
				/* copy the rest of viewer into the buffer */
				if(buffer_cur != memcpy(buffer_cur,viewer,strlen(viewer))) {
					synctex_help_view("Memory copy problem");
					free(buffer);
					return -1;
				}
				printf("SyncTeX: Executing\n%s\n",buffer);
				status = system(buffer);
				free(buffer);
				buffer = NULL;
				return status;
			} else {
				/* just print out the results */
				puts("SyncTeX result begin");
				do {
					printf(	"Output:%s\n"
							"Page:%i\n"
							"x:%f\n"
							"y:%f\n"
							"h:%f\n"
							"v:%f\n"
							"W:%f\n"
							"H:%f\n"
							"before:%s\n"
							"offset:%i\n"
							"middle:%s\n"
							"after:%s\n",
							Ps->output,
							synctex_node_page(node),
							synctex_node_visible_h(node),
							synctex_node_visible_v(node),
							synctex_node_box_visible_h(node),
							synctex_node_box_visible_v(node)+synctex_node_box_visible_depth(node),
							synctex_node_box_visible_width(node),
							synctex_node_box_visible_height(node)+synctex_node_box_visible_depth(node),
							(Ps->before?Ps->before:""),
							Ps->offset,
							(Ps->middle?Ps->middle:""),
							(Ps->after?Ps->after:""));
				} while((node = synctex_next_result(scanner)) != NULL);
				puts("SyncTeX result end");
			}
		}
	}
	return 0;
}

void synctex_help_edit(const char * error,...) {
	va_list v;
	va_start(v, error);
	synctex_usage(error, v);
	va_end(v);
	fputs(
		"synctex edit: backwards or reverse synchronization,\n"
		"command sent by the viewer to edit the source corresponding to the position under the mouse\n\n"
		"\n"
		"usage: synctex edit -o page:x:y:file [-d directory] [-x editor-command] [-h offset:context]\n"
		"\n"
		"-o page:x:y:file\n"
		"       specify the page and coordinates of the point under the mouse.\n"
		"       page is 1 based.\n"
		"       Coordinates x and y are counted from the top left corner of the page.\n"
		"       Their unit is the big point (72 dpi).\n"
		"       \n"
		"       file is in general the path of a pdf or dvi file.\n"
		"       It can be either absolute or relative to the current directory.\n"
		"       This named file must always exist.\n"
		"       \n"
		"-d directory\n"
		"       is the directory containing the synctex file, in case it is different from the directory of the output.\n"
		"       This directory must exist.\n"
		"       An example will explain how things work: for synctex -o ...:bar.tex -d foo,\n"
		"       the chosen synctex file is the most recent among bar.synctex, bar.synctex.gz, foo/bar.synctex and foo/bar.synctex.gz.\n"
		"		The other ones are simply removed, if the authorization is granted\n"
		"       \n"
		"-x editor-command\n"
		"       Normally the synctex tool outputs its result to the stdout.\n"
		"       It is possible to execute an external tool with the result of the query.\n"
		"       The editor-command is a printf like format string with following specifiers.\n"
		"       They will be replaced by their value before the command is executed.\n"
		"       %{output} is the full path specifier of the output document, with no extension.\n"
		"       %{input} is the name specifier of the input document.\n"
		"       %{line} is the 0 based line number specifier. %{line+1} is the 1 based line number specifier.\n"
		"       %{column} is the 0 based column number specifier or -1. %{column+1} is the 1 based column number or -1.\n"
		"       %{offset} is the 0 based offset specifier and %{context} is the context specifier of the hint.\n"
		"       \n"
		"       If no editor-command is provided, the content of the SYNCTEX_EDITOR environment variable is used instead.\n"
		"       \n"
		"-h offset:context\n"
		"       This hint allows a backwards or reverse synchronization by contents.\n"
		"       You give a context including the character at the mouse location, and\n"
		"       the offset of this character relative to the beginning of this bunch of text.\n"
		"       \n",
		(error?stderr:stdout)
	);
	return;
}

typedef struct {
	int page;
	float x;
	float y;
	unsigned int offset;
	char * output;
	char * directory;
	char * editor;
	char * context;
} synctex_edit_params_t;

int synctex_edit_proceed(synctex_edit_params_t * Ps);

/*	"usage: synctex edit -o page:x:y:output [-d directory] [-x editor-command] [-h offset:context]\n"  */
int synctex_edit(int argc, char *argv[]) {
	int arg_index = 0;
	char * start = NULL;
	char * end = NULL;
	synctex_edit_params_t Ps = {0,0,0,0,NULL,NULL,NULL,NULL};
	/* required */
	if((arg_index>=argc) || strcmp("-o",argv[arg_index]) || (++arg_index>=argc)) {
		synctex_help_edit("Missing -o required argument");
		return -1;
	}
	start = argv[arg_index];
	Ps.page = strtol(start,&end,10);
	if(end>start && strlen(end)>1 && *end==':') {
		start = end+1;
		Ps.x = strtod(start,&end);
		if(end>start && strlen(end)>1 && *end==':') {
			start = end+1;
			Ps.y = strtod(start,&end);
			if(end>start && strlen(end)>1 && *end==':') {
				Ps.output = ++end;
				goto scan_execute;
			}
		}
	}
	synctex_help_edit("Bad -o argument");
	return -1;
scan_execute:
	/* now scan the optional arguments */
	if(++arg_index<argc) {
		if(0 == strcmp("-d",argv[arg_index])) {
			if(++arg_index<argc) {
				Ps.directory = argv[arg_index];
				if(++arg_index<argc) {
					goto option_command;
				} else {
					return synctex_edit_proceed(&Ps);
				}
			} else {
				Ps.directory = getenv("SYNCTEX_BUILD_DIRECTORY");
				return synctex_edit_proceed(&Ps);
			}
		}
option_command:
		if(0 == strcmp("-x",argv[arg_index])) {
			if(++arg_index<argc) {
				if(strcmp("-",argv[arg_index])) {
					/* next option does not start with '-', this is a command */
					Ps.editor = argv[arg_index];
					if(++arg_index<argc) {
						goto option_hint;
					} else {
						return synctex_edit_proceed(&Ps);
					}
				} else {
					/* retrieve the environment variable */
					Ps.editor = getenv("SYNCTEX_EDITOR");
					goto option_hint;
				}
			} else {
				Ps.editor = getenv("SYNCTEX_EDITOR");
				return synctex_edit_proceed(&Ps);
			}
		}
option_hint:
		if(0 == strcmp("-h",argv[arg_index]) && ++arg_index<argc) {
			
			start = argv[arg_index];
			end = NULL;
			Ps.offset = strtol(start,&end,10);
			if(end>start && strlen(end)>1 && *end==':') {
				Ps.context = end+1;
				return synctex_edit_proceed(&Ps);
			}
			synctex_help_edit("Bad -h argument");
			return -1;
		}
	}
	return synctex_edit_proceed(&Ps);
}

int synctex_edit_proceed(synctex_edit_params_t * Ps) {
	synctex_scanner_t scanner = NULL;
#if SYNCTEX_DEBUG
	printf("page:%i\n",Ps->page);
	printf("x:%f\n",Ps->x);
	printf("y:%f\n",Ps->y);
	printf("almost output:%s\n",Ps->output);
	printf("editor:%s\n",Ps->editor);
	printf("offset:%i\n",Ps->offset);
	printf("context:%s\n",Ps->context);
	printf("cwd:%s\n",getcwd(NULL,0));
#endif
	scanner = synctex_scanner_new_with_output_file(Ps->output,Ps->directory,1);
	if(NULL == scanner) {
		synctex_help_edit("No SyncTeX available for %s",Ps->output);
		return -1;
	}
	if(synctex_edit_query(scanner,Ps->page,Ps->x,Ps->y)) {
		synctex_node_t node = NULL;
		const char * input = NULL;
		if(NULL != (node = synctex_next_result(scanner))
				&& NULL != (input = synctex_scanner_get_name(scanner,synctex_node_tag(node)))) {
			/* filtering the command */
			if(Ps->editor && strlen(Ps->editor)) {
				size_t size = 0;
				char * where = NULL;
				char * buffer = NULL;
				char * buffer_cur = NULL;
				int printed;
				int status;
				size = strlen(Ps->editor)+3*sizeof(int)+3*SYNCTEX_STR_SIZE;
				buffer = malloc(size+1);
				if(NULL == buffer) {
					printf("SyncTeX ERROR: No memory available\n");
					return -1;
				}
				buffer[size]='\0';
				/* Replace %{ by &{, then remove all unescaped '%'*/
				while((where = strstr(Ps->editor,"%{")) != NULL) {
					*where = '&';
				}
				where = Ps->editor;
				while(where &&(where = strstr(where,"%"))) {
					if(strlen(++where)) {
						if(*where == '%') {
							++where;
						} else {
							*(where-1)='&';
						}
					}
				}
				buffer_cur = buffer;
				/*  find the next occurrence of a format key */
				where = Ps->editor;
				while(Ps->editor && (where = strstr(Ps->editor,"&{"))) {
					#define TEST(KEY,FORMAT,WHAT)\
					if(!strncmp(where,KEY,strlen(KEY))) {\
						printed = where-Ps->editor;\
						if(buffer_cur != memcpy(buffer_cur,Ps->editor,(size_t)printed)) {\
							synctex_help_edit("Memory copy problem");\
							free(buffer);\
							return -1;\
						}\
						buffer_cur += printed;size-=printed;\
						printed = snprintf(buffer_cur,size,FORMAT,WHAT);\
						buffer_cur += printed;size-=printed;\
						*buffer_cur='\0';\
						Ps->editor = where+strlen(KEY);\
						continue;\
					}
					TEST("&{output}", "%s",Ps->output);
					TEST("&{input}",  "%s",input);
					TEST("&{line}",   "%i",synctex_node_line(node));
					TEST("&{column}", "%i",-1);
					TEST("&{offset}", "%i",Ps->offset);
					TEST("&{context}","%s",Ps->context);
					#undef TEST
					break;
				}
				/* copy the rest of editor into the buffer */
				if(buffer_cur != memcpy(buffer_cur,Ps->editor,strlen(Ps->editor))) {
					fputs("!  synctex_edit: Memory copy problem",stderr);
					free(buffer);
					return -1;
				}\
				printf("SyncTeX: Executing\n%s\n",buffer);
				status = system(buffer);
				free(buffer);
				buffer = NULL;
				return status;
			} else {
				/* just print out the results */
				puts("SyncTeX result begin");
				do {
					printf(	"Output:%s\n"
							"Input:%s\n"
							"Line:%i\n"
							"Column:%i\n"
							"Offset:%i\n"
							"Context:%s\n",
							Ps->output,
							input,
							synctex_node_line(node),
							synctex_node_column(node),
							Ps->offset,
							(Ps->context?Ps->context:""));
				} while((node = synctex_next_result(scanner)) != NULL);
				puts("SyncTeX result end");
			}
		}
	}
	return 0;
}

void synctex_help_update(const char * error,...) {
	va_list v;
	va_start(v, error);
	synctex_usage(error, v);
	va_end(v);
	fputs(
		"synctex update: up to date synctex file,\n"
		"Use this command to update the synctex file once a dvi/xdv to pdf filter is applied.\n\n"
		"\n"
		"usage: synctex update -o output [-d directory] [-m number] [-x dimension] [-y dimension]\n"
		"\n"
		"-o output     is the full or relative path of an existing file,\n"
		"              either the real synctex file you wish to update\n"
		"              or a related file: foo.tex, foo.pdf, foo.dvi...\n"
		"-d directory  is the directory containing the synctex file, in case it is different from the directory of the output.\n"
		"			   This directory must exist.\n"
		"				An example will explain how things work: for synctex -o ...:bar.tex -d foo,\n"
		"				the chosen synctex file is the most recent among bar.synctex, bar.synctex.gz, foo/bar.synctex and foo/bar.synctex.gz.\n"
		"				The other ones are simply removed, if the authorization is granted\n"
		"				\n"
		"-m number     Set additional magnification\n"
		"-x dimension  Set horizontal offset\n"
		"-y dimension  Set vertical offset\n"
		"In general, these are exactly the same options provided to the dvi/xdv to pdf filter.\n",
		(error?stderr:stdout)
	);
	return;
}

/*  "usage: synctex update -o output [-d directory] [-m number] [-x dimension] [-y dimension]\n"  */
int synctex_update(int argc, char *argv[]) {
	int arg_index = 0;
	synctex_updater_t updater = NULL;
	char * magnification = NULL;
	char * x = NULL;
	char * y = NULL;
	char * output = NULL;
	char * directory = NULL;
	#define SYNCTEX_fprintf (*synctex_fprintf)
	if(arg_index>=argc) {
		synctex_help_update("Bad update command");
		return -1;
	}
	/* required */
	if((arg_index>=argc) || strcmp("-o",argv[arg_index]) || (++arg_index>=argc)) {
		synctex_help_update("Missing -o required argument");
		return -1;
	}
	output = argv[arg_index];
	if(++arg_index>=argc) {
		return 0;
	}
next_argument:
	if(0 == strcmp("-m",argv[arg_index])) {
		if(++arg_index>=argc) {
			synctex_help_update("Missing magnification");
			return -1;
		}
		magnification = argv[arg_index];
prepare_next_argument:
		if(++arg_index<argc) {
			goto next_argument;
		}
	} else if(0 == strcmp("-x",argv[arg_index])) {
		if(++arg_index>=argc) {
			synctex_help_update("Missing x offset");
			return -1;
		}
		x = argv[arg_index];
		goto prepare_next_argument;
	} else if(0 == strcmp("-y",argv[arg_index])) {
		if(++arg_index>=argc) {
			synctex_help_update("Missing y offset");
			return -1;
		}
		y = argv[arg_index];
		goto prepare_next_argument;
	} else if(0 == strcmp("-d",argv[arg_index])) {
		if(++arg_index<argc) {
			directory = argv[arg_index];
		} else {
			directory = getenv("SYNCTEX_BUILD_DIRECTORY");
		}
		goto prepare_next_argument;
	}

	/* Arguments parsed */
	updater = synctex_updater_new_with_output_file(output,directory);
	synctex_updater_append_magnification(updater,magnification);
	synctex_updater_append_x_offset(updater,x);
	synctex_updater_append_y_offset(updater,y);
	synctex_updater_free(updater);
	return 0;
}

int synctex_test_file (int argc, char *argv[]);

/*  "usage: synctex test subcommand options\n"  */
int synctex_test(int argc, char *argv[]) {
	if(argc) {
		if(0==strcmp("file",argv[0])) {
			return synctex_test_file(argc-1,argv+1);
		}
	}
	return 0;
}

int synctex_test_file (int argc, char *argv[])
{
	int arg_index = 0;
	char * output = NULL;
	char * directory = NULL;
	char * synctex_name = NULL;
	synctex_compress_mode_t mode = synctex_compress_mode_none;
	if(arg_index>=argc) {
		_synctex_error("!  usage: synctex test file -o output [-d directory]\n");
		return -1;
	}
	/* required */
	if((arg_index>=argc) || strcmp("-o",argv[arg_index]) || (++arg_index>=argc)) {
		_synctex_error("!  usage: synctex test file -o output [-d directory]\n");
		return -1;
	}
	output = argv[arg_index];
	/* optional */
	if(++arg_index<argc) {
		if(0 == strcmp("-d",argv[arg_index])) {
			if(++arg_index<argc) {
				directory = argv[arg_index];
			} else {
				directory = getenv("SYNCTEX_BUILD_DIRECTORY");
			}
		}
	}
	/* Arguments parsed */
	if(_synctex_get_name(output, directory, &synctex_name, &mode)) {
		_synctex_error("!  TEST FAILED\n");
	} else {
		printf("output:%s\n"
				"directory:%s\n"
				"file name:%s\n"
				"compression mode:%s\n",
				output,
				directory,
				synctex_name,
				(mode?"gz":"none"));
	}
	return 0;
}