00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029 #include "docwordcompletion.h"
00030
00031 #include <ktexteditor/document.h>
00032 #include <ktexteditor/viewcursorinterface.h>
00033 #include <ktexteditor/editinterface.h>
00034 #include <ktexteditor/variableinterface.h>
00035
00036 #include <kapplication.h>
00037 #include <kconfig.h>
00038 #include <kdialog.h>
00039 #include <kgenericfactory.h>
00040 #include <klocale.h>
00041 #include <kaction.h>
00042 #include <knotifyclient.h>
00043 #include <kparts/part.h>
00044 #include <kiconloader.h>
00045
00046 #include <qregexp.h>
00047 #include <qstring.h>
00048 #include <qdict.h>
00049 #include <qspinbox.h>
00050 #include <qlabel.h>
00051 #include <qlayout.h>
00052 #include <qhbox.h>
00053 #include <qwhatsthis.h>
00054 #include <qcheckbox.h>
00055
00056
00057
00058
00059
00060 K_EXPORT_COMPONENT_FACTORY( ktexteditor_docwordcompletion, KGenericFactory<DocWordCompletionPlugin>( "ktexteditor_docwordcompletion" ) )
00061 DocWordCompletionPlugin::DocWordCompletionPlugin( QObject *parent,
00062 const char* name,
00063 const QStringList& )
00064 : KTextEditor::Plugin ( (KTextEditor::Document*) parent, name )
00065 {
00066 readConfig();
00067 }
00068
00069 void DocWordCompletionPlugin::readConfig()
00070 {
00071 KConfig *config = kapp->config();
00072 config->setGroup( "DocWordCompletion Plugin" );
00073 m_treshold = config->readNumEntry( "treshold", 3 );
00074 m_autopopup = config->readBoolEntry( "autopopup", true );
00075 }
00076
00077 void DocWordCompletionPlugin::writeConfig()
00078 {
00079 KConfig *config = kapp->config();
00080 config->setGroup("DocWordCompletion Plugin");
00081 config->writeEntry("autopopup", m_autopopup );
00082 config->writeEntry("treshold", m_treshold );
00083 }
00084
00085 void DocWordCompletionPlugin::addView(KTextEditor::View *view)
00086 {
00087 DocWordCompletionPluginView *nview = new DocWordCompletionPluginView (m_treshold, m_autopopup, view, "Document word completion");
00088 m_views.append (nview);
00089 }
00090
00091 void DocWordCompletionPlugin::removeView(KTextEditor::View *view)
00092 {
00093 for (uint z=0; z < m_views.count(); z++)
00094 if (m_views.at(z)->parentClient() == view)
00095 {
00096 DocWordCompletionPluginView *nview = m_views.at(z);
00097 m_views.remove (nview);
00098 delete nview;
00099 }
00100 }
00101
00102 KTextEditor::ConfigPage* DocWordCompletionPlugin::configPage( uint, QWidget *parent, const char *name )
00103 {
00104 return new DocWordCompletionConfigPage( this, parent, name );
00105 }
00106
00107 QString DocWordCompletionPlugin::configPageName( uint ) const
00108 {
00109 return i18n("Word Completion Plugin");
00110 }
00111
00112 QString DocWordCompletionPlugin::configPageFullName( uint ) const
00113 {
00114 return i18n("Configure the Word Completion Plugin");
00115 }
00116
00117
00118 QPixmap DocWordCompletionPlugin::configPagePixmap( uint, int size ) const
00119 {
00120 return UserIcon( "kte_wordcompletion", size );
00121 }
00122
00123
00124
00125 struct DocWordCompletionPluginViewPrivate
00126 {
00127 uint line, col;
00128 uint cline, ccol;
00129 uint lilen;
00130 QString last;
00131 QString lastIns;
00132 QRegExp re;
00133 KToggleAction *autopopup;
00134 uint treshold;
00135 };
00136
00137 DocWordCompletionPluginView::DocWordCompletionPluginView( uint treshold, bool autopopup, KTextEditor::View *view, const char *name )
00138 : QObject( view, name ),
00139 KXMLGUIClient( view ),
00140 m_view( view ),
00141 d( new DocWordCompletionPluginViewPrivate )
00142 {
00143 d->treshold = treshold;
00144 view->insertChildClient( this );
00145 setInstance( KGenericFactory<DocWordCompletionPlugin>::instance() );
00146
00147 (void) new KAction( i18n("Reuse Word Above"), CTRL+Key_8, this,
00148 SLOT(completeBackwards()), actionCollection(), "doccomplete_bw" );
00149 (void) new KAction( i18n("Reuse Word Below"), CTRL+Key_9, this,
00150 SLOT(completeForwards()), actionCollection(), "doccomplete_fw" );
00151 (void) new KAction( i18n("Pop Up Completion List"), 0, this,
00152 SLOT(popupCompletionList()), actionCollection(), "doccomplete_pu" );
00153 (void) new KAction( i18n("Shell Completion"), 0, this,
00154 SLOT(shellComplete()), actionCollection(), "doccomplete_sh" );
00155 d->autopopup = new KToggleAction( i18n("Automatic Completion Popup"), 0, this,
00156 SLOT(toggleAutoPopup()), actionCollection(), "enable_autopopup" );
00157
00158 d->autopopup->setChecked( autopopup );
00159 toggleAutoPopup();
00160
00161 setXMLFile("docwordcompletionui.rc");
00162
00163 KTextEditor::VariableInterface *vi = KTextEditor::variableInterface( view->document() );
00164 if ( vi )
00165 {
00166 QString e = vi->variable("wordcompletion-autopopup");
00167 if ( ! e.isEmpty() )
00168 d->autopopup->setEnabled( e == "true" );
00169
00170 connect( view->document(), SIGNAL(variableChanged(const QString &, const QString &)),
00171 this, SLOT(slotVariableChanged(const QString &, const QString &)) );
00172 }
00173 }
00174
00175 void DocWordCompletionPluginView::settreshold( uint t )
00176 {
00177 d->treshold = t;
00178 }
00179
00180 void DocWordCompletionPluginView::completeBackwards()
00181 {
00182 complete( false );
00183 }
00184
00185 void DocWordCompletionPluginView::completeForwards()
00186 {
00187 complete();
00188 }
00189
00190
00191 void DocWordCompletionPluginView::popupCompletionList( QString w )
00192 {
00193 if ( w.isEmpty() )
00194 w = word();
00195 if ( w.isEmpty() )
00196 return;
00197
00198 KTextEditor::CodeCompletionInterface *cci = codeCompletionInterface( m_view );
00199 cci->showCompletionBox( allMatches( w ), w.length() );
00200 }
00201
00202 void DocWordCompletionPluginView::toggleAutoPopup()
00203 {
00204 if ( d->autopopup->isChecked() ) {
00205 if ( ! connect( m_view->document(), SIGNAL(charactersInteractivelyInserted(int ,int ,const QString&)),
00206 this, SLOT(autoPopupCompletionList()) ))
00207 {
00208 connect( m_view->document(), SIGNAL(textChanged()), this, SLOT(autoPopupCompletionList()) );
00209 }
00210 } else {
00211 disconnect( m_view->document(), SIGNAL(textChanged()), this, SLOT(autoPopupCompletionList()) );
00212 disconnect( m_view->document(), SIGNAL(charactersInteractivelyInserted(int ,int ,const QString&)),
00213 this, SLOT(autoPopupCompletionList()) );
00214
00215 }
00216 }
00217
00218
00219 void DocWordCompletionPluginView::autoPopupCompletionList()
00220 {
00221 if ( ! m_view->hasFocus() ) return;
00222 QString w = word();
00223 if ( w.length() >= d->treshold )
00224 {
00225 popupCompletionList( w );
00226 }
00227 }
00228
00229
00230 void DocWordCompletionPluginView::shellComplete()
00231 {
00232
00233 KTextEditor::EditInterface * ei = KTextEditor::editInterface(m_view->document());
00234
00235 uint cline, ccol;
00236 viewCursorInterface(m_view)->cursorPositionReal(&cline, &ccol);
00237 QString wrd = word();
00238 if (wrd.isEmpty())
00239 return;
00240
00241 QValueList < KTextEditor::CompletionEntry > matches = allMatches(wrd);
00242 if (matches.size() == 0)
00243 return;
00244 QString partial = findLongestUnique(matches);
00245 if (partial.length() == wrd.length())
00246 {
00247 KTextEditor::CodeCompletionInterface * cci = codeCompletionInterface(m_view);
00248 cci->showCompletionBox(matches, wrd.length());
00249 }
00250 else
00251 {
00252 partial.remove(0, wrd.length());
00253 ei->insertText(cline, ccol, partial);
00254 }
00255 }
00256
00257
00258
00259 void DocWordCompletionPluginView::complete( bool fw )
00260 {
00261
00262 KTextEditor::EditInterface *ei = KTextEditor::editInterface( m_view->document() );
00263
00264 uint cline, ccol;
00265 viewCursorInterface( m_view )->cursorPositionReal( &cline, &ccol );
00266 QString wrd = word();
00267 if ( wrd.isEmpty() ) return;
00268
00269
00270
00271
00272
00273
00274
00275 if ( cline == d-> cline &&
00276 ccol - d->lilen == d->ccol &&
00277 wrd.endsWith( d->lastIns ) )
00278 {
00279
00280 ccol = d->ccol;
00281 wrd = d->last;
00282 }
00283 else
00284 {
00285 d->cline = cline;
00286 d->ccol = ccol;
00287 d->last = wrd;
00288 d->lastIns = QString::null;
00289 d->line = d->cline;
00290 d->col = d->ccol - wrd.length();
00291 d->lilen = 0;
00292 }
00293
00294 d->re.setPattern( "\\b" + wrd + "(\\w+)" );
00295 int inc = fw ? 1 : -1;
00296 int pos ( 0 );
00297 QString ln = ei->textLine( d->line );
00298
00299 if ( ! fw )
00300 ln = ln.mid( 0, d->col );
00301
00302 while ( true )
00303 {
00304 pos = fw ?
00305 d->re.search( ln, d->col ) :
00306 d->re.searchRev( ln, d->col );
00307
00308 if ( pos > -1 )
00309 {
00310 QString m = d->re.cap( 1 );
00311 if ( m != d->lastIns )
00312 {
00313 d->col = pos;
00314
00315 if ( fw )
00316 d->col += m.length();
00317
00318
00319 if ( pos + wrd.length() == ccol )
00320 {
00321 d->col = pos + inc;
00322 continue;
00323 }
00324
00325
00326 if ( d->lilen )
00327 ei->removeText( d->cline, d->ccol, d->cline, d->ccol + d->lilen );
00328 ei->insertText( d->cline, d->ccol, m );
00329
00330 d->lilen = m.length();
00331 d->lastIns = m;
00332
00333 return;
00334 }
00335
00336
00337 else
00338 d->col = pos + inc;
00339 }
00340
00341 else
00342 {
00343 if ( ! fw && d->line == 0)
00344 {
00345 KNotifyClient::beep();
00346 return;
00347 }
00348 else if ( fw && d->line >= ei->numLines() )
00349 {
00350 KNotifyClient::beep();
00351 return;
00352 }
00353
00354 d->line += inc;
00355 if ( fw )
00356 d->col++;
00357
00358 ln = ei->textLine( d->line );
00359 d->col = fw ? 0 : ln.length();
00360 }
00361 }
00362 }
00363
00364
00365 QString DocWordCompletionPluginView::findLongestUnique(const QValueList < KTextEditor::CompletionEntry > &matches)
00366 {
00367 QString partial = matches.front().text;
00368 QValueList < KTextEditor::CompletionEntry >::const_iterator i = matches.begin();
00369 for (++i; i != matches.end(); ++i)
00370 {
00371 if (!(*i).text.startsWith(partial))
00372 {
00373 while(partial.length() > 0)
00374 {
00375 partial.remove(partial.length() - 1, 1);
00376 if ((*i).text.startsWith(partial))
00377 {
00378 break;
00379 }
00380 }
00381 if (partial.length() == 0)
00382 return QString();
00383 }
00384 }
00385
00386 return partial;
00387 }
00388
00389
00390 QString DocWordCompletionPluginView::word()
00391 {
00392 uint cline, ccol;
00393 viewCursorInterface( m_view )->cursorPositionReal( &cline, &ccol );
00394 if ( ! ccol ) return QString::null;
00395 KTextEditor::EditInterface *ei = KTextEditor::editInterface( m_view->document() );
00396 d->re.setPattern( "\\b(\\w+)$" );
00397 if ( d->re.searchRev(
00398 ei->text( cline, 0, cline, ccol )
00399 ) < 0 )
00400 return QString::null;
00401 return d->re.cap( 1 );
00402 }
00403
00404
00405
00406 QValueList<KTextEditor::CompletionEntry> DocWordCompletionPluginView::allMatches( const QString &word )
00407 {
00408 QValueList<KTextEditor::CompletionEntry> l;
00409 uint i( 0 );
00410 int pos( 0 );
00411 d->re.setPattern( "\\b("+word+"\\w+)" );
00412 QString s, m;
00413 KTextEditor::EditInterface *ei = KTextEditor::editInterface( m_view->document() );
00414 QDict<int> seen;
00415 int sawit(1);
00416 uint cline, ccol;
00417 viewCursorInterface( m_view )->cursorPositionReal( &cline, &ccol );
00418
00419 while( i < ei->numLines() )
00420 {
00421 s = ei->textLine( i );
00422 pos = 0;
00423 while ( pos >= 0 )
00424 {
00425 pos = d->re.search( s, pos );
00426 if ( pos >= 0 )
00427 {
00428
00429 if ( i == cline && pos + word.length() == ccol )
00430 {
00431 pos += word.length();
00432 continue;
00433 }
00434
00435 m = d->re.cap( 1 );
00436 if ( ! seen[ m ] ) {
00437 seen.insert( m, &sawit );
00438 KTextEditor::CompletionEntry e;
00439 e.text = m;
00440 l.append( e );
00441 }
00442 pos += d->re.matchedLength();
00443 }
00444 }
00445 i++;
00446 }
00447 return l;
00448 }
00449
00450 void DocWordCompletionPluginView::slotVariableChanged( const QString &var, const QString &val )
00451 {
00452 if ( var == "wordcompletion-autopopup" )
00453 d->autopopup->setEnabled( val == "true" );
00454 else if ( var == "wordcompletion-treshold" )
00455 d->treshold = val.toInt();
00456 }
00457
00458
00459
00460 DocWordCompletionConfigPage::DocWordCompletionConfigPage( DocWordCompletionPlugin *completion, QWidget *parent, const char *name )
00461 : KTextEditor::ConfigPage( parent, name )
00462 , m_completion( completion )
00463 {
00464 QVBoxLayout *lo = new QVBoxLayout( this );
00465 lo->setSpacing( KDialog::spacingHint() );
00466
00467 cbAutoPopup = new QCheckBox( i18n("Automatically &show completion list"), this );
00468 lo->addWidget( cbAutoPopup );
00469
00470 QHBox *hb = new QHBox( this );
00471 hb->setSpacing( KDialog::spacingHint() );
00472 lo->addWidget( hb );
00473 QLabel *l = new QLabel( i18n(
00474 "Translators: This is the first part of two strings wich will comprise the "
00475 "sentence 'Show completions when a word is at least N characters'. The first "
00476 "part is on the right side of the N, which is represented by a spinbox "
00477 "widget, followed by the second part: 'characters long'. Characters is a "
00478 "ingeger number between and including 1 and 30. Feel free to leave the "
00479 "second part of the sentence blank if it suits your language better. ",
00480 "Show completions &when a word is at least"), hb );
00481 sbAutoPopup = new QSpinBox( 1, 30, 1, hb );
00482 l->setBuddy( sbAutoPopup );
00483 lSbRight = new QLabel( i18n(
00484 "This is the second part of two strings that will comprise teh sentence "
00485 "'Show completions when a word is at least N characters'",
00486 "characters long."), hb );
00487
00488 QWhatsThis::add( cbAutoPopup, i18n(
00489 "Enable the automatic completion list popup as default. The popup can "
00490 "be disabled on a view basis from the 'Tools' menu.") );
00491 QWhatsThis::add( sbAutoPopup, i18n(
00492 "Define the length a word should have before the completion list "
00493 "is displayed.") );
00494
00495 cbAutoPopup->setChecked( m_completion->autoPopupEnabled() );
00496 sbAutoPopup->setValue( m_completion->treshold() );
00497
00498 lo->addStretch();
00499 }
00500
00501 void DocWordCompletionConfigPage::apply()
00502 {
00503 m_completion->setAutoPopupEnabled( cbAutoPopup->isChecked() );
00504 m_completion->setTreshold( sbAutoPopup->value() );
00505 m_completion->writeConfig();
00506 }
00507
00508 void DocWordCompletionConfigPage::reset()
00509 {
00510 cbAutoPopup->setChecked( m_completion->autoPopupEnabled() );
00511 sbAutoPopup->setValue( m_completion->treshold() );
00512 }
00513
00514 void DocWordCompletionConfigPage::defaults()
00515 {
00516 cbAutoPopup->setChecked( true );
00517 sbAutoPopup->setValue( 3 );
00518 }
00519
00520
00521
00522 #include "docwordcompletion.moc"
00523