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
|
/***************************************************************************
plugin_katexmlcheck.cpp - checks XML files using xmllint
-------------------
begin : 2002-07-06
copyright : (C) 2002 by Daniel Naber
email : daniel.naber@t-online.de
***************************************************************************/
/***************************************************************************
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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
***************************************************************************/
/*
-fixme: show dock if "Validate XML" is selected (doesn't currently work when Kate
was just started and the dockwidget isn't yet visible)
-fixme(?): doesn't correctly disappear when deactivated in config
*/
#include "plugin_katexmlcheck.h"
#include <QHBoxLayout>
#include "plugin_katexmlcheck.moc"
#include <cassert>
#include <qfile.h>
#include <qinputdialog.h>
#include <qregexp.h>
#include <qstring.h>
#include <qtextstream.h>
#include <kactioncollection.h>
//Added by qt3to4:
#include <Q3CString>
#include <QApplication>
#include <kdefakes.h> // for setenv
#include <kaction.h>
#include <kcursor.h>
#include <kdebug.h>
#include <k3dockwidget.h>
#include <kcomponentdata.h>
#include <klocale.h>
#include <kmessagebox.h>
#include <kstandarddirs.h>
#include <ktemporaryfile.h>
#include <kpluginfactory.h>
#include <kprocess.h>
K_PLUGIN_FACTORY(PluginKateXMLCheckFactory, registerPlugin<PluginKateXMLCheck>();)
K_EXPORT_PLUGIN(PluginKateXMLCheckFactory("katexmlcheck"))
PluginKateXMLCheck::PluginKateXMLCheck( QObject* parent, const QVariantList& )
: Kate::Plugin ( (Kate::Application *)parent )
{
}
PluginKateXMLCheck::~PluginKateXMLCheck()
{
}
Kate::PluginView *PluginKateXMLCheck::createView(Kate::MainWindow *mainWindow)
{
return new PluginKateXMLCheckView(mainWindow);
}
//---------------------------------
PluginKateXMLCheckView::PluginKateXMLCheckView(Kate::MainWindow *mainwin)
: Kate::PluginView (mainwin), Kate::XMLGUIClient(PluginKateXMLCheckFactory::componentData()),win(mainwin)
{
dock = win->createToolView("kate_plugin_xmlcheck_ouputview", Kate::MainWindow::Bottom, SmallIcon("misc"), i18n("XML Checker Output"));
listview = new Q3ListView( dock );
m_tmp_file=0;
m_proc=0;
QAction *a = actionCollection()->addAction("xml_check");
a->setText(i18n("Validate XML"));
connect(a, SIGNAL(triggered()), this, SLOT(slotValidate()));
// TODO?:
//(void) new KAction ( i18n("Indent XML"), KShortcut(), this,
// SLOT(slotIndent()), actionCollection(), "xml_indent" );
listview->setFocusPolicy(Qt::NoFocus);
listview->addColumn(i18n("#"), -1);
listview->addColumn(i18n("Line"), -1);
listview->setColumnAlignment(1, Qt::AlignRight);
listview->addColumn(i18n("Column"), -1);
listview->setColumnAlignment(2, Qt::AlignRight);
listview->addColumn(i18n("Message"), -1);
listview->setAllColumnsShowFocus(true);
listview->setResizeMode(Q3ListView::LastColumn);
connect(listview, SIGNAL(clicked(Q3ListViewItem*)), SLOT(slotClicked(Q3ListViewItem*)));
/* TODO?: invalidate the listview when document has changed
Kate::View *kv = application()->activeMainWindow()->activeView();
if( ! kv ) {
kDebug() << "Warning: no Kate::View";
return;
}
connect(kv, SIGNAL(modifiedChanged()), this, SLOT(slotUpdate()));
*/
m_proc = new KProcess();
connect(m_proc, SIGNAL(finished(int,QProcess::ExitStatus)), this, SLOT(slotProcExited(int,QProcess::ExitStatus)));
// we currently only want errors:
m_proc->setOutputChannelMode(KProcess::OnlyStderrChannel);
mainWindow()->guiFactory()->addClient(this);
}
PluginKateXMLCheckView::~PluginKateXMLCheckView()
{
mainWindow()->guiFactory()->removeClient( this );
delete m_proc;
delete m_tmp_file;
}
void PluginKateXMLCheckView::slotProcExited(int exitCode, QProcess::ExitStatus exitStatus)
{
Q_UNUSED(exitCode);
// FIXME: doesn't work correct the first time:
//if( m_dockwidget->isDockBackPossible() ) {
// m_dockwidget->dockBack();
// }
if (exitStatus != QProcess::NormalExit) {
(void)new Q3ListViewItem(listview, QString("1").rightJustified(4,' '), "", "",
"Validate process crashed.");
return;
}
kDebug() << "slotProcExited()";
QApplication::restoreOverrideCursor();
delete m_tmp_file;
QString proc_stderr = QString::fromLocal8Bit(m_proc->readAllStandardError());
m_tmp_file=0;
listview->clear();
uint list_count = 0;
uint err_count = 0;
if( ! m_validating ) {
// no i18n here, so we don't get an ugly English<->Non-english mixup:
QString msg;
if( m_dtdname.isEmpty() ) {
msg = "No DOCTYPE found, will only check well-formedness.";
} else {
msg = '\'' + m_dtdname + "' not found, will only check well-formedness.";
}
(void)new Q3ListViewItem(listview, QString("1").rightJustified(4,' '), "", "", msg);
list_count++;
}
if( ! proc_stderr.isEmpty() ) {
QStringList lines = QStringList::split("\n", proc_stderr);
Q3ListViewItem *item = 0;
QString linenumber, msg;
int line_count = 0;
for(QStringList::Iterator it = lines.begin(); it != lines.end(); ++it) {
QString line = *it;
line_count++;
int semicolon_1 = line.find(':');
int semicolon_2 = line.find(':', semicolon_1+1);
int semicolon_3 = line.find(':', semicolon_2+2);
int caret_pos = line.find('^');
if( semicolon_1 != -1 && semicolon_2 != -1 && semicolon_3 != -1 ) {
linenumber = line.mid(semicolon_1+1, semicolon_2-semicolon_1-1).trimmed();
linenumber = linenumber.rightJustified(6, ' '); // for sorting numbers
msg = line.mid(semicolon_3+1, line.length()-semicolon_3-1).trimmed();
} else if( caret_pos != -1 || line_count == lines.size() ) {
// TODO: this fails if "^" occurs in the real text?!
if( line_count == lines.size() && caret_pos == -1 ) {
msg = msg+'\n'+line;
}
QString col = QString::number(caret_pos);
if( col == "-1" ) {
col = "";
}
err_count++;
list_count++;
item = new Q3ListViewItem(listview, QString::number(list_count).rightJustified(4,' '), linenumber, col, msg);
item->setMultiLinesEnabled(true);
} else {
msg = msg+'\n'+line;
}
}
listview->sort(); // TODO?: insert in right order
}
if( err_count == 0 ) {
QString msg;
if( m_validating ) {
msg = "No errors found, document is valid."; // no i18n here
} else {
msg = "No errors found, document is well-formed."; // no i18n here
}
(void)new Q3ListViewItem(listview, QString::number(list_count+1).rightJustified(4,' '), "", "", msg);
}
}
void PluginKateXMLCheckView::slotClicked(Q3ListViewItem *item)
{
kDebug() << "slotClicked";
if( item ) {
bool ok = true;
uint line = item->text(1).toUInt(&ok);
bool ok2 = true;
uint column = item->text(2).toUInt(&ok);
if( ok && ok2 ) {
KTextEditor::View *kv = win->activeView();
if( ! kv )
return;
kv->setCursorPosition(KTextEditor::Cursor (line-1, column));
}
}
}
void PluginKateXMLCheckView::slotUpdate()
{
kDebug() << "slotUpdate() (not implemented yet)";
}
bool PluginKateXMLCheckView::slotValidate()
{
kDebug() << "slotValidate()";
win->showToolView (dock);
m_proc->clearProgram();
m_validating = false;
m_dtdname = "";
KTextEditor::View *kv = win->activeView();
if( ! kv )
return false;
delete m_tmp_file;
m_tmp_file = new KTemporaryFile();
if( !m_tmp_file->open() ) {
kDebug() << "Error (slotValidate()): could not create '" << m_tmp_file->fileName() << "': " << m_tmp_file->errorString();
KMessageBox::error(0, i18n("<b>Error:</b> Could not create "
"temporary file '%1'.", m_tmp_file->fileName()));
delete m_tmp_file;
m_tmp_file=0L;
return false;
}
QTextStream s ( m_tmp_file );
s << kv->document()->text();
s.flush();
QString exe = KStandardDirs::findExe("xmllint");
if( exe.isEmpty() ) {
exe = KStandardDirs::locate("exe", "xmllint");
}
// use catalogs for KDE docbook:
if( ! getenv("XML_CATALOG_FILES") ) {
KComponentData ins("katexmlcheckplugin");
QString catalogs;
catalogs += ins.dirs()->findResource("data", "ksgmltools2/customization/catalog.xml");
kDebug() << "catalogs: " << catalogs;
setenv("XML_CATALOG_FILES", QFile::encodeName( catalogs ).data(), 1);
}
//kDebug() << "**catalogs: " << getenv("XML_CATALOG_FILES");
*m_proc << exe << "--noout";
// tell xmllint the working path of the document's file, if possible.
// otherweise it will not find relative DTDs
QString path = kv->document()->url().directory();
kDebug() << path;
if (!path.isEmpty()) {
*m_proc << "--path" << path;
}
// heuristic: assume that the doctype is in the first 10,000 bytes:
QString text_start = kv->document()->text().left(10000);
// remove comments before looking for doctype (as a doctype might be commented out
// and needs to be ignored then):
QRegExp re("<!--.*-->");
re.setMinimal(true);
text_start.remove(re);
QRegExp re_doctype("<!DOCTYPE\\s+(.*)\\s+(?:PUBLIC\\s+[\"'].*[\"']\\s+[\"'](.*)[\"']|SYSTEM\\s+[\"'](.*)[\"'])", false);
re_doctype.setMinimal(true);
if( re_doctype.search(text_start) != -1 ) {
QString dtdname;
if( ! re_doctype.cap(2).isEmpty() ) {
dtdname = re_doctype.cap(2);
} else {
dtdname = re_doctype.cap(3);
}
if( !dtdname.startsWith("http:") ) { // todo: u_dtd.isLocalFile() doesn't work :-(
// a local DTD is used
m_validating = true;
*m_proc << "--valid";
} else {
m_validating = true;
*m_proc << "--valid";
}
} else if( text_start.find("<!DOCTYPE") != -1 ) {
// DTD is inside the XML file
m_validating = true;
*m_proc << "--valid";
}
*m_proc << m_tmp_file->fileName();
m_proc->start();
if( ! m_proc->waitForStarted(-1) ) {
KMessageBox::error(0, i18n("<b>Error:</b> Failed to execute xmllint. Please make "
"sure that xmllint is installed. It is part of libxml2."));
return false;
}
QApplication::setOverrideCursor(Qt::WaitCursor);
return true;
}
|