4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief Editor non-inline non-template implementation */
27 //#include "Editor.ih"
30 #include <senf/Utils/membind.hh>
31 #include <senf/Scheduler/Scheduler.hh>
33 //#include "Editor.mpp"
35 ///////////////////////////////cc.p////////////////////////////////////////
37 prefix_ senf::term::BaseEditor::BaseEditor(AbstractTerminal & terminal)
38 : terminal_ (&terminal),
39 keyTimeout_ (senf::ClockService::milliseconds(DEFAULT_KEY_TIMEOUT_MS)),
40 timer_ ("senf::term::BaseEditor::keySequenceTimeout",
41 senf::membind(&BaseEditor::keySequenceTimeout, this)),
42 column_ (0u), displayHeight_ (1u), line_ (0u)
44 terminal_->setCallbacks(*this);
47 prefix_ void senf::term::BaseEditor::newline()
51 write(tifo_.getString(Terminfo::properties::ClrEol));
55 prefix_ void senf::term::BaseEditor::toColumn(unsigned c)
60 if (tifo_.hasProperty(Terminfo::properties::ParmRightCursor)) {
61 write(tifo_.formatString(Terminfo::properties::ParmRightCursor, c - column_));
65 char const * cuf1 (tifo_.getString(Terminfo::properties::CursorRight));
72 else if (c < column_) {
73 if (tifo_.hasProperty(Terminfo::properties::ParmLeftCursor)) {
74 write(tifo_.formatString(Terminfo::properties::ParmLeftCursor, column_ - c));
78 char const * cub1 (tifo_.getString(Terminfo::properties::CursorLeft));
87 prefix_ void senf::term::BaseEditor::put(char ch)
89 if (column_ >= width()-1)
95 prefix_ void senf::term::BaseEditor::put(std::string const & text)
97 if (text.size() > width()-column_-1) {
98 write(text.substr(0,width()-column_-1));
99 column_ = width() - 1;
103 column_ += text.size();
107 prefix_ void senf::term::BaseEditor::clearLine()
110 write(tifo_.getString(Terminfo::properties::ClrEol));
114 prefix_ void senf::term::BaseEditor::setBold()
116 if (tifo_.hasProperty(Terminfo::properties::EnterBoldMode) &&
117 tifo_.hasProperty(Terminfo::properties::ExitAttributeMode))
118 write(tifo_.getString(Terminfo::properties::EnterBoldMode));
121 prefix_ void senf::term::BaseEditor::setNormal()
123 if (tifo_.hasProperty(Terminfo::properties::EnterBoldMode) &&
124 tifo_.hasProperty(Terminfo::properties::ExitAttributeMode))
125 write(tifo_.getString(Terminfo::properties::ExitAttributeMode));
128 prefix_ void senf::term::BaseEditor::maybeClrScr()
130 if (tifo_.hasProperty(Terminfo::properties::ClearScreen))
131 write(tifo_.getString(Terminfo::properties::ClearScreen));
134 prefix_ void senf::term::BaseEditor::toLine(unsigned l)
139 if (ll >= displayHeight_)
140 ll = displayHeight_-1;
142 if (tifo_.hasProperty(Terminfo::properties::ParmDownCursor)) {
143 write(tifo_.formatString(Terminfo::properties::ParmDownCursor, ll - line_));
147 char const * cud1 (tifo_.getString(Terminfo::properties::CursorDown));
154 else if (ll < line_) {
155 if (tifo_.hasProperty(Terminfo::properties::ParmUpCursor)) {
156 write(tifo_.formatString(Terminfo::properties::ParmUpCursor, line_ - ll));
160 char const * cuu1 (tifo_.getString(Terminfo::properties::CursorUp));
169 write(tifo_.getString(Terminfo::properties::ClrEol));
177 prefix_ void senf::term::BaseEditor::reset()
179 for (unsigned i (1); i < displayHeight_; ++i) {
187 prefix_ unsigned senf::term::BaseEditor::currentColumn()
193 prefix_ unsigned senf::term::BaseEditor::currentLine()
199 prefix_ bool senf::term::BaseEditor::cb_init()
202 tifo_.load(terminal_->terminalType());
203 keyParser_.load(tifo_);
205 catch (Terminfo::InvalidTerminfoException & ex) {
209 typedef Terminfo::properties p;
210 if (! (tifo_.hasProperty(p::ClrEol) &&
211 (tifo_.hasProperty(p::ParmRightCursor) || tifo_.hasProperty(p::CursorRight)) &&
212 (tifo_.hasProperty(p::ParmLeftCursor) || tifo_.hasProperty(p::CursorLeft))))
215 if (tifo_.hasProperty(Terminfo::properties::KeypadXmit))
216 write(tifo_.getString(Terminfo::properties::KeypadXmit));
220 prefix_ void senf::term::BaseEditor::cb_charReceived(char c)
223 timer_.timeout(senf::scheduler::eventTime() + keyTimeout_);
227 prefix_ void senf::term::BaseEditor::cb_windowSizeChanged()
229 if (column_ >= width())
233 prefix_ void senf::term::BaseEditor::keySequenceTimeout()
235 while (!inputBuffer_.empty()) {
237 v_keyReceived(keycode_t(inputBuffer_[0]));
238 inputBuffer_.erase(0, 1);
242 prefix_ void senf::term::BaseEditor::processKeys()
245 std::pair<senf::term::KeyParser::keycode_t, std::string::size_type> result
246 (keyParser_.lookup(inputBuffer_));
247 if (result.first == senf::term::KeyParser::Incomplete)
249 v_keyReceived(result.first);
250 inputBuffer_.erase(0, result.second);
251 } while (! inputBuffer_.empty());
255 prefix_ unsigned senf::term::BaseEditor::width()
257 return terminal_->width();
260 prefix_ unsigned senf::term::BaseEditor::height()
262 return terminal_->height();
265 prefix_ void senf::term::BaseEditor::write(char ch)
267 terminal_->write(ch);
270 prefix_ void senf::term::BaseEditor::write(std::string const & s)
272 for (std::string::const_iterator i (s.begin()); i != s.end(); ++i)
276 ///////////////////////////////////////////////////////////////////////////
278 prefix_ senf::term::LineEditor::LineEditor(AbstractTerminal & terminal, AcceptCallback cb)
279 : BaseEditor(terminal), enabled_ (false), prompt_ ("$"), promptWidth_ (1u), editWidth_ (0u),
280 text_ (""), point_ (0u), displayPos_ (0u), lastKey_ (0u), callback_ (cb), historyPoint_ (0u)
282 defineKey(KeyParser::Return, &bindings::accept);
283 defineKey(KeyParser::Right, &bindings::forwardChar);
284 defineKey(KeyParser::Left, &bindings::backwardChar);
285 defineKey(KeyParser::Up, &bindings::prevHistory);
286 defineKey(KeyParser::Down, &bindings::nextHistory);
287 defineKey(KeyParser::Backspace, &bindings::backwardDeleteChar);
288 defineKey(KeyParser::Delete, &bindings::deleteChar);
289 defineKey(KeyParser::Home, &bindings::beginningOfLine);
290 defineKey(KeyParser::End, &bindings::endOfLine);
291 defineKey(KeyParser::Ctrl('K'), &bindings::deleteToEndOfLine);
292 defineKey(KeyParser::Ctrl('A'), &bindings::beginningOfLine);
293 defineKey(KeyParser::Ctrl('E'), &bindings::endOfLine);
294 defineKey(KeyParser::Ctrl('D'), &bindings::deleteChar);
295 defineKey(KeyParser::Ctrl('C'), &bindings::restartEdit);
296 defineKey(KeyParser::Ctrl('L'), &bindings::clearScreen);
299 prefix_ void senf::term::LineEditor::prompt(std::string const & text)
302 promptWidth_ = prompt_.size();
303 if (promptWidth_ > width() - 4 && width() > 4)
304 promptWidth_ = width() - 4;
305 editWidth_ = width() - promptWidth_ - 3;
310 prefix_ void senf::term::LineEditor::set(std::string const & text, unsigned pos)
314 if (point_ > text.size())
315 point_ = text.size();
317 if (point_ > editWidth_)
318 displayPos_ = point_ - editWidth_;
322 prefix_ void senf::term::LineEditor::show()
327 for (unsigned n (0); n < auxDisplay_.size(); ++n) {
335 prefix_ void senf::term::LineEditor::hide()
344 prefix_ void senf::term::LineEditor::accept()
349 pushHistory(text_, true);
354 prefix_ void senf::term::LineEditor::clear()
357 historyPoint_ = history_.size();
360 prefix_ void senf::term::LineEditor::redisplay()
362 redisplayNeeded_ = true;
365 prefix_ void senf::term::LineEditor::forceRedisplay()
371 if (prompt_.size() > promptWidth_)
372 put(prompt_.substr(prompt_.size()-promptWidth_));
375 put( displayPos_ > 0 ? '<' : ' ' );
376 if (text_.size() > displayPos_ + editWidth_) {
377 toColumn(editWidth_ + promptWidth_ + 1);
379 toColumn(promptWidth_ + 1);
382 put(text_.substr(displayPos_, editWidth_));
383 toColumn(point_ - displayPos_ + promptWidth_ + 1);
384 redisplayNeeded_ = false;
387 prefix_ void senf::term::LineEditor::gotoChar(unsigned n)
390 if (point_ > text_.size())
391 point_ = text_.size();
392 if (point_ < displayPos_)
393 displayPos_ = point_;
394 if (point_ > displayPos_+editWidth_)
395 displayPos_ = point_-editWidth_;
399 prefix_ void senf::term::LineEditor::scrollTo(unsigned n)
402 if (displayPos_ > text_.size())
403 displayPos_ = text_.size();
404 if (point_ < displayPos_)
405 point_ = displayPos_;
406 if (point_ > displayPos_+editWidth_)
407 point_ = displayPos_+editWidth_;
411 prefix_ void senf::term::LineEditor::deleteChar(unsigned n)
413 if (point_ >= text_.size())
415 text_.erase(point_, n);
419 prefix_ void senf::term::LineEditor::insert(char ch)
421 text_.insert(point_, std::string(1, ch));
426 prefix_ void senf::term::LineEditor::insert(std::string const & text)
428 text_.insert(point_, text);
429 gotoChar(point_+text.size());
433 prefix_ void senf::term::LineEditor::pushHistory(std::string const & text, bool accept)
436 && (accept || historyPoint_ == history_.size() || history_[historyPoint_] != text)
437 && (history_.empty() || history_.back() != text)) {
438 history_.push_back(text);
439 while (history_.size() > MAX_HISTORY_SIZE)
440 history_.erase(history_.begin());
442 historyPoint_ = history_.size() - 1;
446 prefix_ void senf::term::LineEditor::prevHistory()
448 if (historyPoint_ <= 0)
451 std::string entry (history_[--historyPoint_]);
452 set(entry, entry.size());
455 prefix_ void senf::term::LineEditor::nextHistory()
457 if (historyPoint_ >= history_.size())
461 if (historyPoint_ >= history_.size())
464 std::string entry (history_[historyPoint_]);
465 set(entry, entry.size());
469 prefix_ void senf::term::LineEditor::auxDisplay(unsigned line, std::string const & text)
474 while (auxDisplay_.size() < line+1)
475 auxDisplay_.push_back("");
476 auxDisplay_[line] = text;
479 prefix_ unsigned senf::term::LineEditor::maxAuxDisplayHeight()
484 prefix_ void senf::term::LineEditor::clearAuxDisplay()
490 prefix_ std::string const & senf::term::LineEditor::text()
495 prefix_ unsigned senf::term::LineEditor::point()
500 prefix_ unsigned senf::term::LineEditor::displayPos()
505 prefix_ senf::term::LineEditor::keycode_t senf::term::LineEditor::lastKey()
510 prefix_ void senf::term::LineEditor::defineKey(keycode_t key, KeyBinding binding)
512 bindings_[key] = binding;
515 prefix_ void senf::term::LineEditor::unsetKey(keycode_t key)
517 bindings_.erase(key);
520 prefix_ bool senf::term::LineEditor::cb_init()
522 if (!BaseEditor::cb_init())
529 prefix_ void senf::term::LineEditor::cb_windowSizeChanged()
531 BaseEditor::cb_windowSizeChanged();
538 prefix_ void senf::term::LineEditor::v_keyReceived(keycode_t key)
544 KeyMap::iterator i (bindings_.find(key));
545 if (i != bindings_.end())
547 else if (key >= ' ' && key < 256)
549 if (currentLine() != 0)
551 if (redisplayNeeded_)
554 toColumn(point_ - displayPos_ + promptWidth_ + 1);
557 ///////////////////////////////////////////////////////////////////////////
559 prefix_ void senf::term::bindings::selfInsertCommand(LineEditor & editor)
561 LineEditor::keycode_t key (editor.lastKey());
562 if (key >= ' ' && key < 256)
566 prefix_ void senf::term::bindings::forwardChar(LineEditor & editor)
568 editor.gotoChar(editor.point()+1);
571 prefix_ void senf::term::bindings::backwardChar(LineEditor & editor)
573 unsigned p (editor.point());
575 editor.gotoChar(p-1);
578 prefix_ void senf::term::bindings::accept(LineEditor & editor)
583 prefix_ void senf::term::bindings::backwardDeleteChar(LineEditor & editor)
585 unsigned p (editor.point());
587 editor.gotoChar(p-1);
592 prefix_ void senf::term::bindings::deleteChar(LineEditor & editor)
597 prefix_ void senf::term::bindings::beginningOfLine(LineEditor & editor)
602 prefix_ void senf::term::bindings::endOfLine(LineEditor & editor)
604 editor.gotoChar(editor.text().size());
607 prefix_ void senf::term::bindings::deleteToEndOfLine(LineEditor & editor)
609 editor.deleteChar(editor.text().size()-editor.point());
612 prefix_ void senf::term::bindings::restartEdit(LineEditor & editor)
619 prefix_ void senf::term::bindings::prevHistory(LineEditor & editor)
621 editor.prevHistory();
624 prefix_ void senf::term::bindings::nextHistory(LineEditor & editor)
626 editor.nextHistory();
629 prefix_ void senf::term::bindings::clearScreen(LineEditor & editor)
631 editor.maybeClrScr();
633 editor.forceRedisplay();
636 prefix_ void senf::term::bindings::complete(LineEditor & editor, Completer completer)
638 typedef std::vector<std::string> Completions;
640 Completions completions;
641 completer(editor, 0, editor.point(), completions);
642 if (completions.empty())
645 // Find common start string of all completions
646 unsigned commonStart (completions[0].size());
647 unsigned maxLen (commonStart);
648 for (Completions::const_iterator i (boost::next(completions.begin()));
649 i != completions.end(); ++i) {
650 if (i->size() > maxLen)
653 for (; n < commonStart && n < i->size() && completions[0][n] == (*i)[n]; ++n) ;
657 // Replace to-be-completed string with the common start string shared by all completions
658 std::string text (editor.text());
659 std::string completion (completions[0].substr(0, commonStart));
660 bool didComplete (false);
661 if (text.substr(0, editor.point()) != completion) {
662 text.erase(0, editor.point());
663 text.insert(0, completion);
667 // Otherwise place cursor directly after the (possibly partial) completion
668 editor.set(text, commonStart);
669 if (didComplete || completions.size() == 1)
672 // Text was not changed, show list of possible completions
673 unsigned colWidth (maxLen+2);
674 unsigned nColumns ((editor.width()-1) / colWidth);
675 if (nColumns < 1) nColumns = 1;
676 unsigned nRows ((completions.size()+nColumns-1) / nColumns);
677 if (nRows > editor.maxAuxDisplayHeight()) {
678 editor.auxDisplay(0, "(too many completions)");
681 Completions::iterator i (completions.begin());
682 for (unsigned row (0); row < nRows; ++row) {
684 for (unsigned column (0); column < nColumns && i != completions.end(); ++column) {
685 std::string entry (colWidth, ' ');
686 if (i->size() > colWidth-2)
687 std::copy(i->begin(), i->begin()+colWidth-2, entry.begin());
689 std::copy(i->begin(), i->end(), entry.begin());
693 editor.auxDisplay(row, line);
697 ///////////////////////////////cc.e////////////////////////////////////////
699 //#include "Editor.mpp"
705 // comment-column: 40
706 // c-file-style: "senf"
707 // indent-tabs-mode: nil
708 // ispell-local-dictionary: "american"
709 // compile-command: "scons -u test"