forked from TeXworks/texworks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TWSynchronizer.cpp
300 lines (256 loc) · 10.2 KB
/
TWSynchronizer.cpp
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
/*
This is part of TeXworks, an environment for working with TeX documents
Copyright (C) 2014 Stefan Löffler, Jonathan Kew
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, see <http://www.gnu.org/licenses/>.
For links to further information, or to contact the authors,
see <http://www.tug.org/texworks/>.
*/
#include "TWSynchronizer.h"
#include "TWApp.h"
#include "TeXDocument.h"
#include "PDFDocument.h"
#include <QFileInfo>
#include <QDir>
// TODO for fine-grained search:
// - Specially handle \commands (and possibly other TeX codes)
// - Allow to increase the context to neighboring lines (in case lines were
// added/removed above since the last typesetting)
// - Implement some diff-like algorithm to make use of the positions of
// substrings in the line (e.g., to properly sync lines like
// "abc\footnote{abc}")
TWSyncTeXSynchronizer::TWSyncTeXSynchronizer(const QString & filename)
{
_scanner = SyncTeX::synctex_scanner_new_with_output_file(filename.toLocal8Bit().data(), NULL, 1);
}
TWSyncTeXSynchronizer::~TWSyncTeXSynchronizer()
{
if (_scanner != NULL)
synctex_scanner_free(_scanner);
}
bool TWSyncTeXSynchronizer::isValid() const
{
return (_scanner != NULL);
}
QString TWSyncTeXSynchronizer::syncTeXFilename() const
{
if (!_scanner)
return QString();
return QString::fromLocal8Bit(SyncTeX::synctex_scanner_get_synctex(_scanner));
}
QString TWSyncTeXSynchronizer::pdfFilename() const
{
if (!_scanner)
return QString();
return QString::fromLocal8Bit(SyncTeX::synctex_scanner_get_output(_scanner));
}
//virtual
TWSynchronizer::PDFSyncPoint TWSyncTeXSynchronizer::syncFromTeX(const TWSynchronizer::TeXSyncPoint & src) const
{
PDFSyncPoint retVal;
// Find the name SyncTeX is using for this source file...
const QFileInfo sourceFileInfo(src.filename);
QDir curDir(QFileInfo(pdfFilename()).canonicalPath());
SyncTeX::synctex_node_t node = SyncTeX::synctex_scanner_input(_scanner);
QString name;
bool found = false;
while (node) {
name = QString::fromLocal8Bit(SyncTeX::synctex_scanner_get_name(_scanner, SyncTeX::synctex_node_tag(node)));
const QFileInfo fi(curDir, name);
if (fi == sourceFileInfo) {
found = true;
break;
}
node = synctex_node_sibling(node);
}
if (!found)
return retVal;
retVal.filename = pdfFilename();
if (SyncTeX::synctex_display_query(_scanner, name.toLocal8Bit().data(), src.line, src.col) > 0) {
retVal.page = -1;
while ((node = SyncTeX::synctex_next_result(_scanner)) != NULL) {
if (retVal.page < 0)
retVal.page = SyncTeX::synctex_node_page(node);
if (SyncTeX::synctex_node_page(node) != retVal.page)
continue;
QRectF nodeRect(synctex_node_box_visible_h(node),
synctex_node_box_visible_v(node) - synctex_node_box_visible_height(node),
synctex_node_box_visible_width(node),
synctex_node_box_visible_height(node) + synctex_node_box_visible_depth(node));
retVal.rects.append(nodeRect);
}
}
_syncFromTeXFine(src, retVal);
return retVal;
}
//virtual
TWSynchronizer::TeXSyncPoint TWSyncTeXSynchronizer::syncFromPDF(const TWSynchronizer::PDFSyncPoint & src) const
{
TeXSyncPoint retVal;
if (src.rects.length() != 1)
return retVal;
if (SyncTeX::synctex_edit_query(_scanner, src.page, src.rects[0].left(), src.rects[0].top()) > 0) {
SyncTeX::synctex_node_t node;
while ((node = SyncTeX::synctex_next_result(_scanner)) != NULL) {
retVal.filename = QString::fromLocal8Bit(SyncTeX::synctex_scanner_get_name(_scanner, SyncTeX::synctex_node_tag(node)));
retVal.line = SyncTeX::synctex_node_line(node);
retVal.col = -1;
break; // FIXME: currently we just take the first hit
}
}
_syncFromPDFFine(src, retVal);
return retVal;
}
void TWSyncTeXSynchronizer::_syncFromTeXFine(const TWSynchronizer::TeXSyncPoint & src, TWSynchronizer::PDFSyncPoint & dest) const
{
// FIXME: this does not work properly for text which is split across pages!
// If we get no sensible column information, there's no point in continuing
if (src.col < 0)
return;
QDir curDir(QFileInfo(src.filename).canonicalPath());
TeXDocument * tex = TeXDocument::findDocument(src.filename);
PDFDocument * pdf = PDFDocument::findDocument(QFileInfo(curDir, dest.filename).canonicalFilePath());
if (!tex || !pdf || !pdf->widget())
return;
// Get source context
QString srcContext = tex->getLineText(src.line);
if (srcContext.isEmpty())
return;
// Get destination context
QList<QPolygonF> selection;
foreach (QRectF r, dest.rects)
selection.append(r);
QMap<int, QRectF> boxes;
QString destContext = pdf->widget()->selectedText(selection, &boxes);
// FIXME: the string returned by selectedText() seems to twist the beginning
// (and ends) of footnotes sometimes.
// If the user clicked past the end of the line, start matching at the last
// character
int col = src.col;
if (col >= srcContext.length())
col = srcContext.length() - 1;
// Perform the text matching
bool unique = false;
int destCol = _findCorrespondingPosition(srcContext, destContext, col, unique);
// If we found no (unique) match bail out
if (destCol < 0 || !unique)
return;
// Update the matching destination rectangles
dest.rects.clear();
dest.rects.append(boxes[destCol]);
}
void TWSyncTeXSynchronizer::_syncFromPDFFine(const TWSynchronizer::PDFSyncPoint &src, TWSynchronizer::TeXSyncPoint &dest) const
{
QDir curDir(QFileInfo(src.filename).canonicalPath());
TeXDocument * tex = TeXDocument::openDocument(QFileInfo(curDir, dest.filename).canonicalFilePath(), false, false, dest.line);
PDFDocument * pdf = PDFDocument::findDocument(src.filename);
if (!tex || !pdf || !pdf->widget())
return;
// Get source context
// In order to get the full context corresponding to the whole input line,
// we use a forward search from the source to the PDF (which may turn up more
// than one PDF rect for multiline paragraphs).
// Note: this still does not help for paragraphs broken across pages
QList<QPolygonF> selection;
if (SyncTeX::synctex_display_query(_scanner, dest.filename.toLocal8Bit().data(), dest.line, -1) > 0) {
SyncTeX::synctex_node_t node;
while ((node = SyncTeX::synctex_next_result(_scanner)) != NULL) {
if (SyncTeX::synctex_node_page(node) != src.page)
continue;
QRectF nodeRect(synctex_node_box_visible_h(node),
synctex_node_box_visible_v(node) - synctex_node_box_visible_height(node),
synctex_node_box_visible_width(node),
synctex_node_box_visible_height(node) + synctex_node_box_visible_depth(node));
selection.append(nodeRect);
}
}
// Find the box the user clicked on
QMap<int, QRectF> boxes;
QString srcContext = pdf->widget()->selectedText(selection, NULL, &boxes);
int col;
for (col = 0; col < boxes.count(); ++col) {
if (boxes[col].contains(src.rects[0].center()))
break;
}
// If no valid box was found, bail out
if (col >= boxes.count())
return;
// Get destination context
QString destContext = tex->getLineText(dest.line);
if (destContext.isEmpty())
return;
// Perform the text matching
bool unique = false;
int destCol = _findCorrespondingPosition(srcContext, destContext, col, unique);
// If we found no (unique) match bail out
if (destCol < 0 || !unique)
return;
// cross-check in the other direction (i.e., from dest to src) to avoid false
// positives in case there is some crazy command expansion going on. E.g.:
// \newcommand{\A}{abc}
// \A abc\A
if (col != _findCorrespondingPosition(destContext, srcContext, destCol, unique) || !unique)
return;
dest.col = destCol;
}
// static
int TWSyncTeXSynchronizer::_findCorrespondingPosition(const QString & srcContext, const QString & destContext, const int col, bool & unique)
{
// Find the position in the destination corresponding to the one in the source
// Do this by enlarging the search string until a unique match is found
// Start by enlarging to the right (until a unique match is found, no match is
// found anymore (e.g., because we stumble across some TeX code like a
// \command or a math delimiter), or the end of the string is reached). Then,
// repeat the same process to the left.
int deltaFront = 0, deltaBack;
bool found = false;
unique = false;
// Search to the right
// FIXME: Possibly use some form of bisectioning
for (deltaBack = 1; col + deltaBack <= srcContext.length(); ++deltaBack) {
int c = destContext.count(srcContext.mid(col - deltaFront, deltaBack + deltaFront));
found = (c > 0);
unique = (c == 1);
if (!found || unique)
break;
}
if (!found) {
// If the string was not found in this round, it must have been found in the
// previous one, which must not have been unique (otherwise we'd never have
// gotten here
--deltaBack;
found = true;
unique = false;
}
if (!unique) {
// Search to the left
// FIXME: Possibly use some form of bisectioning
for (deltaFront = 1; deltaFront <= col; ++deltaFront) {
int c = destContext.count(srcContext.mid(col - deltaFront, deltaBack + deltaFront));
found = (c > 0);
unique = (c == 1);
if (!found || unique)
break;
}
if (!found) {
// If the string was not found in this round, it must have been found in the
// previous one, which must not have been unique (otherwise we'd never have
// gotten here
--deltaFront;
found = true;
unique = false;
}
}
// If we did not find any match return -1
if (!found || (deltaBack == 0 && deltaFront == 0))
return -1;
return destContext.indexOf(srcContext.mid(col - deltaFront, deltaBack + deltaFront)) + deltaFront;
}