Add the --synctex command line option, gzip synctex

  - Update tests.

Author: rekka

src/cli_driver.rs

@@ -260,6 +260,7 @@ struct ProcessingSession {
     keep_intermediates: bool,
     keep_logs: bool,
     noted_tex_warnings: bool,
+    synctex_enabled: bool,
 }
 
 
@@ -345,6 +346,7 @@ impl ProcessingSession {
             keep_intermediates: args.is_present("keep_intermediates"),
             keep_logs: args.is_present("keep_logs"),
             noted_tex_warnings: false,
+            synctex_enabled: args.is_present("synctex"),
         })
     }
 
@@ -639,6 +641,7 @@ impl ProcessingSession {
             let mut engine = TexEngine::new();
             engine.set_halt_on_error_mode(true);
             engine.set_initex_mode(true);
+            engine.set_synctex(false);
             engine.process(&mut stack, &mut self.events, status, "UNUSED.fmt.gz",
                            &format!("tectonic-format-{}.tex", stem))
         };
@@ -700,6 +703,7 @@ impl ProcessingSession {
             let mut engine = TexEngine::new();
             engine.set_halt_on_error_mode(true);
             engine.set_initex_mode(self.output_format == OutputFormat::Format);
+            engine.set_synctex(self.synctex_enabled);
             if let Some(s) = rerun_explanation {
                 status.note_highlighted("Rerunning ", "TeX", &format!(" because {} ...", s));
             } else {
@@ -848,6 +852,9 @@ fn main() {
         .arg(Arg::with_name("keep_logs")
              .long("keep-logs")
              .help("Keep the log files generated during processing."))
+        .arg(Arg::with_name("synctex")
+             .long("synctex")
+             .help("Generate SyncTeX data."))
         .arg(Arg::with_name("hide")
              .long("hide")
              .value_name("PATH")

src/engines/tex.rs

@@ -46,6 +46,11 @@ impl TexEngine {
         unsafe { super::tt_set_int_variable(b"in_initex_mode\0".as_ptr(), v); }
     }
 
+    pub fn set_synctex (&mut self, synctex_enabled: bool) {
+        let v = if synctex_enabled { 1 } else { 0 };
+        unsafe { super::tt_set_int_variable(b"synctex_enabled\0".as_ptr(), v); }
+    }
+
     // This function can't be generic across the IoProvider trait, for now,
     // since the global pointer that stashes the ExecutionState must have a
     // complete type.

tectonic/engine-interface.c

@@ -17,6 +17,8 @@ tt_set_int_variable (char *var_name, int value)
         halt_on_error_p = value;
     else if (STREQ (var_name, "in_initex_mode"))
         in_initex_mode = (value != 0);
+    else if (STREQ (var_name, "synctex_enabled"))
+        synctex_enabled = (value != 0);
     else
         return 1; /* Uh oh: unrecognized variable */
 

tectonic/synctex.c

@@ -151,7 +151,11 @@ synctex_init_command(void)
     synctex_ctxt.flags.warn = 0;
     synctex_ctxt.flags.output_p = 0;
 
-    INTPAR(synctex) = 0; /* \synctex=0 : don't record stuff */
+    if (synctex_enabled) {
+        INTPAR(synctex) = 1;
+    } else {
+        INTPAR(synctex) = 0; /* \synctex=0 : don't record stuff */
+    }
 }
 
 
@@ -233,10 +237,11 @@ synctex_dot_open(void)
                             + 1);
     strcpy(the_name, tmp);
     strcat(the_name, synctex_suffix);
+    strcat(the_name, synctex_suffix_gz);
     free(tmp);
     tmp = NULL;
 
-    synctex_ctxt.file = ttstub_output_open(the_name, 0);
+    synctex_ctxt.file = ttstub_output_open(the_name, 1);
     if (synctex_ctxt.file == NULL)
         goto fail;
 

tectonic/xetexd.h

@@ -687,6 +687,7 @@ scaled base_x_height;
 scaled base_width, base_height;
 scaled accent_width, accent_height;
 scaled delta;
+int synctex_enabled;
 
 /*:1683*/
 

tests/tex-outputs.rs

@@ -148,7 +148,7 @@ fn do_one(stem: &str, check_synctex: bool) {
     test_file(&xdvname, &expected_xdv, observed_xdv);
 
     if check_synctex {
-        p.set_extension("synctex");
+        p.set_extension("synctex.gz");
         let expected_synctex = read_file(&p);
         let synctexname = p.file_name().unwrap().to_owned();
         let observed_synctex = files.get(&synctexname).unwrap();