source/texk/web2c/synctexdir/synctex.h

   1 /* synctex.h
   2
   3 Copyright (c) 2008, 2009 jerome DOT laurens AT u-bourgogne DOT fr
   4
   5 This file is part of the SyncTeX package.
   6
   7 Permission is hereby granted, free of charge, to any person
   8 obtaining a copy of this software and associated documentation
   9 files (the "Software"), to deal in the Software without
  10 restriction, including without limitation the rights to use,
  11 copy, modify, merge, publish, distribute, sublicense, and/or sell
  12 copies of the Software, and to permit persons to whom the
  13 Software is furnished to do so, subject to the following
  14 conditions:
  15
  16 The above copyright notice and this permission notice shall be
  17 included in all copies or substantial portions of the Software.
  18
  19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  21 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  23 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  24 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26 OTHER DEALINGS IN THE SOFTWARE
  27
  28 Acknowledgments:
  29 ----------------
  30 The author received useful remarks from the pdfTeX developers, especially Hahn The Thanh,
  31 and significant help from XeTeX developer Jonathan Kew
  32
  33 Nota Bene:
  34 ----------
  35 If you include or use a significant part of the synctex package into a software,
  36 I would appreciate to be listed as contributor and see "SyncTeX" highlighted.
  37
  38 Version 1
  39 Latest Revision: Wed Jul  1 08:17:50 UTC 2009
  40
  41 */
  42
  43 #  ifndef __SYNCTEX_HEADER__
  44 #    define __SYNCTEX_HEADER__
  45
  46 #include "synctex-common.h"
  47
  48 /*  Free all memory used, close and remove the file if any. */
  49 void synctexabort(boolean log_opened);
  50
  51 /*  Send this message when starting a new input.  */
  52 extern void synctexstartinput(void);
  53
  54 /*  Recording the "{..." line.  In *tex.web, use synctex_sheet(pdf_output) at
  55  *  the very beginning of the ship_out procedure.
  56 */
  57 extern void synctexsheet(integer mag);
  58
  59 /*  Recording the "}..." line.  In *tex.web, use synctex_teehs at
  60  *  the very end of the ship_out procedure.
  61 */
  62 extern void synctexteehs(void);
  63
  64 /*  This message is sent when a vlist will be shipped out, more precisely at
  65  *  the beginning of the vlist_out procedure in *TeX.web.  It will be balanced
  66  *  by a synctex_tsilv, sent at the end of the vlist_out procedure.  p is the
  67  *  address of the vlist We assume that p is really a vlist node! */
  68 extern void synctexvlist(halfword this_box);
  69
  70 /*  Recording a "}" line ending a vbox: this message is sent whenever a vlist
  71  *  has been shipped out. It is used to close the vlist nesting level. It is
  72  *  sent at the end of each vlist_out procedure in *TeX.web to balance a former
  73  *  synctex_vlist sent at the beginning of that procedure.    */
  74 extern void synctextsilv(halfword this_box);
  75
  76 /*  This message is sent when a void vlist will be shipped out.
  77  *  There is no need to balance a void vlist.  */
  78 extern void synctexvoidvlist(halfword p, halfword this_box);
  79
  80 /*  Send this message when an hlist will be shipped out, more precisely at
  81  *  the beginning of the hlist_out procedure in *TeX.web.  It must be balanced
  82  *  by a synctex_tsilh, sent at the end of the hlist_out procedure.  p is the
  83  *  address of the hlist. */
  84 extern void synctexhlist(halfword this_box);
  85
  86 /*  Send this message at the end of the various hlist_out procedure in *TeX.web
  87  *  to balance a former synctex_hlist.    */
  88 extern void synctextsilh(halfword this_box);
  89
  90 /*  This message is sent when a void hlist will be shipped out.
  91  *  There is no need to balance a void hlist.  */
  92 extern void synctexvoidhlist(halfword p, halfword this_box);
  93
  94 /*  Send this message whenever an inline math node will ship out. */
  95 extern void synctexmath(halfword p, halfword this_box);
  96
  97 /*  Send this message whenever an horizontal rule or glue node will ship out. */
  98 extern void synctexhorizontalruleorglue(halfword p, halfword this_box);
  99
 100 /*  Send this message whenever a kern node will ship out. */
 101 extern void synctexkern(halfword p, halfword this_box);
 102
 103 /*  this message is sent whenever a char node ships out    */
 104 extern void synctexchar(halfword p, halfword this_box);
 105
 106 /*  this message should be sent to record information
 107          for a node of an unknown type    */
 108 extern void synctexnode(halfword p, halfword this_box);
 109
 110 /*  For debugging purpose only    */
 111 extern void synctexcurrent(void);
 112
 113 #  endif