octave-nkf: libgui/qterminal/libqterminal/unix/Emulation.h comparison

comparison libgui/qterminal/libqterminal/unix/Emulation.h @ 19627:446c46af4b42 stable

strip trailing whitespace from most source files * Makefile.am, NEWS, build-aux/common.mk, configure.ac, doc/Makefile.am, doc/doxyhtml/Makefile.am, doc/interpreter/Makefile.am, doc/interpreter/arith.txi, doc/interpreter/audio.txi, doc/interpreter/basics.txi, doc/interpreter/bugs.txi, doc/interpreter/container.txi, doc/interpreter/cp-idx.txi, doc/interpreter/data.txi, doc/interpreter/debug.txi, doc/interpreter/diagperm.txi, doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README, doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/fn-idx.txi, doc/interpreter/func.txi, doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m, doc/interpreter/gpl.txi, doc/interpreter/grammar.txi, doc/interpreter/gui.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/interpimages.m, doc/interpreter/intro.txi, doc/interpreter/io.txi, doc/interpreter/java.txi, doc/interpreter/linalg.txi, doc/interpreter/macros.texi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi, doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1, doc/interpreter/octave.texi, doc/interpreter/oop.txi, doc/interpreter/op-idx.txi, doc/interpreter/optim.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/poly.txi, doc/interpreter/preface.txi, doc/interpreter/quad.txi, doc/interpreter/set.txi, doc/interpreter/signal.txi, doc/interpreter/sparse.txi, doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m, doc/interpreter/stats.txi, doc/interpreter/stmt.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/testfun.txi, doc/interpreter/tips.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, doc/liboctave/Makefile.am, doc/liboctave/array.texi, doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi, doc/liboctave/dae.texi, doc/liboctave/diffeq.texi, doc/liboctave/error.texi, doc/liboctave/factor.texi, doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi, doc/liboctave/install.texi, doc/liboctave/intro.texi, doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi, doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi, doc/liboctave/ode.texi, doc/liboctave/optim.texi, doc/liboctave/preface.texi, doc/liboctave/quad.texi, doc/liboctave/range.texi, doc/refcard/Makefile.am, doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2, etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog, etc/OLD-ChangeLogs/doc-ChangeLog, etc/OLD-ChangeLogs/scripts-ChangeLog, etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog, etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW, etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am, examples/@polynomial/end.m, examples/@polynomial/subsasgn.m, examples/Makefile.am, examples/standalonebuiltin.cc, libgui/Makefile.am, libgui/qterminal/libqterminal/README, libgui/qterminal/libqterminal/unix/BlockArray.cpp, libgui/qterminal/libqterminal/unix/BlockArray.h, libgui/qterminal/libqterminal/unix/Character.h, libgui/qterminal/libqterminal/unix/CharacterColor.h, libgui/qterminal/libqterminal/unix/Emulation.cpp, libgui/qterminal/libqterminal/unix/Emulation.h, libgui/qterminal/libqterminal/unix/Filter.cpp, libgui/qterminal/libqterminal/unix/Filter.h, libgui/qterminal/libqterminal/unix/History.cpp, libgui/qterminal/libqterminal/unix/History.h, libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp, libgui/qterminal/libqterminal/unix/KeyboardTranslator.h, libgui/qterminal/libqterminal/unix/LineFont.h, libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp, libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h, libgui/qterminal/libqterminal/unix/Screen.cpp, libgui/qterminal/libqterminal/unix/Screen.h, libgui/qterminal/libqterminal/unix/ScreenWindow.cpp, libgui/qterminal/libqterminal/unix/ScreenWindow.h, libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp, libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h, libgui/qterminal/libqterminal/unix/Vt102Emulation.h, libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp, libgui/qterminal/qterminal/main.cpp, libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc, libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc, libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc, libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy, libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc, libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc, libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl, libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add, libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs, libinterp/mkops, libinterp/octave-value/ov-java.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/octave.gperf, liboctave/Makefile.am, liboctave/array/Array.cc, liboctave/array/module.mk, liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f, liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f, liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f, liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f, liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f, liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f, liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f, liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f, liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f, liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f, liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f, liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f, liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f, liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f, liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f, liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f, liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk, liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f, liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f, liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f, liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f, liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f, liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc, liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f, liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f, liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f, liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f, liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc, liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for, liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f, liboctave/cruft/slatec-fn/datanh.f, liboctave/cruft/slatec-fn/xgmainc.f, liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk, liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops, liboctave/operators/sparse-mk-ops.awk, liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops, liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m, scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m, scripts/deprecated/java_new.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m, scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m, scripts/general/display.m, scripts/general/fieldnames.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/isa.m, scripts/general/methods.m, scripts/general/sortrows.m, scripts/geometry/convhull.m, scripts/geometry/delaunay.m, scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m, scripts/geometry/griddata.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/geometry/voronoin.m, scripts/gui/guihandles.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m, scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m, scripts/image/bone.m, scripts/image/cmpermute.m, scripts/image/cmunique.m, scripts/image/colorcube.m, scripts/image/colormap.m, scripts/image/contrast.m, scripts/image/gray2ind.m, scripts/image/image.m, scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m, scripts/image/rgb2ntsc.m, scripts/image/spinmap.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m, scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m, scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m, scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m, scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m, scripts/mk-pkg-add, scripts/mkdoc.pl, scripts/optimization/fminsearch.m, scripts/optimization/optimset.m, scripts/optimization/sqp.m, scripts/pkg/pkg.m, scripts/pkg/private/create_pkgadddel.m, scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m, scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m, scripts/plot/util/clf.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/gcbo.m, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m, scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m, scripts/polynomial/conv.m, scripts/polynomial/poly.m, scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m, scripts/polynomial/polyval.m, scripts/polynomial/private/__splinefit__.m, scripts/polynomial/spline.m, scripts/prefs/prefdir.m, scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m, scripts/prefs/rmpref.m, scripts/signal/freqz.m, scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m, scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/specfun/expint.m, scripts/specfun/factor.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m, scripts/special-matrix/toeplitz.m, scripts/startup/inputrc, scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m, scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m, scripts/statistics/distributions/betarnd.m, scripts/statistics/distributions/binoinv.m, scripts/statistics/distributions/binopdf.m, scripts/statistics/distributions/binornd.m, scripts/statistics/distributions/cauchy_rnd.m, scripts/statistics/distributions/chi2rnd.m, scripts/statistics/distributions/discrete_pdf.m, scripts/statistics/distributions/discrete_rnd.m, scripts/statistics/distributions/empirical_rnd.m, scripts/statistics/distributions/exprnd.m, scripts/statistics/distributions/frnd.m, scripts/statistics/distributions/gamrnd.m, scripts/statistics/distributions/geornd.m, scripts/statistics/distributions/hygernd.m, scripts/statistics/distributions/kolmogorov_smirnov_cdf.m, scripts/statistics/distributions/laplace_cdf.m, scripts/statistics/distributions/laplace_pdf.m, scripts/statistics/distributions/logistic_cdf.m, scripts/statistics/distributions/logistic_pdf.m, scripts/statistics/distributions/lognrnd.m, scripts/statistics/distributions/nbincdf.m, scripts/statistics/distributions/nbininv.m, scripts/statistics/distributions/nbinpdf.m, scripts/statistics/distributions/nbinrnd.m, scripts/statistics/distributions/normrnd.m, scripts/statistics/distributions/poissinv.m, scripts/statistics/distributions/poissrnd.m, scripts/statistics/distributions/tinv.m, scripts/statistics/distributions/trnd.m, scripts/statistics/distributions/unidcdf.m, scripts/statistics/distributions/unidpdf.m, scripts/statistics/distributions/unidrnd.m, scripts/statistics/distributions/unifrnd.m, scripts/statistics/distributions/wblrnd.m, scripts/statistics/models/module.mk, scripts/statistics/tests/kruskal_wallis_test.m, scripts/strings/base2dec.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjoin.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m, scripts/testfun/test.m, scripts/time/asctime.m, scripts/time/datenum.m, scripts/time/datevec.m, scripts/time/weekday.m, src/Makefile.am, test/Makefile.am, test/build-bc-overload-tests.sh, test/build-sparse-tests.sh, test/jit.tst, test/line-continue.tst: Strip trailing whitespace.

author	John W. Eaton <jwe@octave.org>
date	Tue, 20 Jan 2015 08:26:57 -0500
parents	2de613986374
children

comparison

equal deleted inserted replaced

-:8dbd55742112
+:446c46af4b42
 /*
 This file is part of Konsole, an X terminal.
 Copyright (C) 2007, 2013 by Robert Knight <robertknight@gmail.com>
 Copyright (C) 1997,1998 by Lars Doelle <lars.doelle@on-line.de>
 Rewritten for QT4 by e_k <e_k at users.sourceforge.net>, Copyright (C)2008
 #define EMULATION_H
 // System
 #include <stdio.h>
 // Qt
 #include <QKeyEvent>
 #include <QtCore/QTextCodec>
 #include <QtCore/QTextStream>
 #include <QtCore/QTimer>
 class HistoryType;
 class Screen;
 class ScreenWindow;
 class TerminalCharacterDecoder;
 /**
 * This enum describes the available states which
 * the terminal emulation may be set to.
 *
 * These are the values used by Emulation::stateChanged()
 */
 enum
 {
 /** The emulation is currently receiving user input. */
 NOTIFYNORMAL=0,
 /**
 * The terminal program has triggered a bell event
 * to get the user's attention.
 */
 NOTIFYBELL=1,
 /**
 * The emulation is currently receiving data from its
 * terminal input.
 */
 NOTIFYACTIVITY=2,
 // unused here?
 NOTIFYSILENCE=3
 };
 /**
 * Base class for terminal emulation back-ends.
 *
 * The back-end is responsible for decoding an incoming character stream and
 * producing an output image of characters.
 *
 * When input from the terminal is received, the receiveData() slot should be called with
 * the data which has arrived.  The emulation will process the data and update the
 * screen image accordingly.  The codec used to decode the incoming character stream
 * into the unicode characters used internally can be specified using setCodec()
 *
 * The size of the screen image can be specified by calling setImageSize() with the
 * desired number of lines and columns.  When new lines are added, old content
 * is moved into a history store, which can be set by calling setHistory().
 *
 * The screen image can be accessed by creating a ScreenWindow onto this emulation
 * by calling createWindow().  Screen windows provide access to a section of the
 * output.  Each screen window covers the same number of lines and columns as the
 * image size returned by imageSize().  The screen window can be moved up and down
 * and provides transparent access to both the current on-screen image and the
 * previous output.  The screen windows emit an outputChanged signal
 * when the section of the image they are looking at changes.
 * Graphical views can then render the contents of a screen window, listening for notifications
 * of output changes from the screen window which they are associated with and updating
 * accordingly.
 *
 * The emulation also is also responsible for converting input from the connected views such
 * as keypresses and mouse activity into a character string which can be sent
 * to the terminal program.  Key presses can be processed by calling the sendKeyEvent() slot,
 * while mouse events can be processed using the sendMouseEvent() slot.  When the character
 * process.  The translation of key presses into an output character stream is performed
 * using a lookup in a set of key bindings which map key sequences to output
 * character sequences.  The name of the key bindings set used can be specified using
 * setKeyBindings()
 *
 * The emulation maintains certain state information which changes depending on the
 * input received.  The emulation can be reset back to its starting state by calling
 * reset().
 *
 * The emulation also maintains an activity state, which specifies whether
 * terminal is currently active ( when data is received ), normal
 * ( when the terminal is idle or receiving user input ) or trying
 * to alert the user ( also known as a "Bell" event ).  The stateSet() signal
 * is emitted whenever the activity state is set.  This can be used to determine
 * how long the emulation has been active/idle for and also respond to
 * a 'bell' event in different ways.
 */
 class Emulation : public QObject
 {
 Q_OBJECT
 public:
 /** Constructs a new terminal emulation */
 Emulation();
 ~Emulation();
 /**
 * Creates a new window onto the output from this emulation.  The contents
 /** Returns the size of the screen image which the emulation produces */
 QSize imageSize();
 /**
 * Returns the total number of lines, including those stored in the history.
 */
 int lineCount();
 /**
 * Sets the history store used by this emulation.  When new lines
 * are added to the output, older lines at the top of the screen are transferred to a history
 * store.
 *
 * The number of lines which are kept and the storage location depend on the
 * type of store.
 */
 void setHistory(const HistoryType&);
 /** Returns the history store used by this emulation.  See setHistory() */
 const HistoryType& history();
 /** Clears the history scroll. */
 void clearHistory();
 /**
 * Copies the output history from @p startLine to @p endLine
 * into @p stream, using @p decoder to convert the terminal
 * characters into text.
 *
 * @param decoder A decoder which converts lines of terminal characters with
 * appearance attributes into output text.  PlainTextDecoder is the most commonly
 * used decoder.
 * @param startLine The first
 */
 virtual void writeToStream(TerminalCharacterDecoder* decoder,int startLine,int endLine);
 /** Returns the codec used to decode incoming characters.  See setCodec() */
 const QTextCodec* codec() { return _codec; }
 /** Sets the codec used to decode incoming characters.  */
 void setCodec(const QTextCodec*);
 /**
 * Convenience method.
 * Returns true if the current codec used to decode incoming
 * characters is UTF-8
 */
 bool utf8() { Q_ASSERT(_codec); return _codec->mibEnum() == 106; }
 /** TODO Document me */
 virtual char getErase() const;
 /**
 * Sets the key bindings used to key events
 * ( received through sendKeyEvent() ) into character
 * streams to send to the terminal.
 */
 void setKeyBindings(const QString& name);
 /**
 * Returns the name of the emulation's current key bindings.
 * See setKeyBindings()
 */
 QString keyBindings();
 /**
 * Copies the current image into the history and clears the screen.
 */
 virtual void clearEntireScreen() =0;
 /** Resets the state of the terminal. */
 virtual void reset() =0;
 /**
 * Returns true if the active terminal program wants
 * mouse input events.
 *
 * The programUsesMouseChanged() signal is emitted when this
 * changes.
 */
 bool programUsesMouse() const;
 public slots:
 /** Change the size of the emulation's image */
 virtual void setImageSize(int lines, int columns);
 /**
 * Interprets a sequence of characters and sends the result to the terminal.
 * This is equivalent to calling sendKeyEvent() for each character in @p text in succession.
 */
 virtual void sendText(const QString& text) = 0;
 /**
 * Interprets a key press event and emits the sendData() signal with
 * the resulting character stream.
 */
 virtual void sendKeyEvent(QKeyEvent*);
 /**
 * Converts information about a mouse event into an xterm-compatible escape
 * sequence and emits the character sequence via sendData()
 */
 virtual void sendMouseEvent(int buttons, int column, int line, int eventType);
 /**
 * Sends a string of characters to the foreground terminal process.
 *
 * @param string The characters to send.
 * @param length Length of @p string or if set to a negative value, @p string will
 * be treated as a null-terminated string and its length will be determined automatically.
 */
 virtual void sendString(const char* string, int length = -1) = 0;
 /**
 * Processes an incoming stream of characters.  receiveData() decodes the incoming
 * character buffer using the current codec(), and then calls receiveChar() for
 * each unicode character in the resulting buffer.
 *
 * receiveData() also starts a timer which causes the outputChanged() signal
 * to be emitted when it expires.  The timer allows multiple updates in quick
 * succession to be buffered into a single outputChanged() signal emission.
 *
 */
 void receiveData(const char* buffer,int len);
 signals:
 /**
 * Emitted when a buffer of data is ready to send to the
 * standard input of the terminal.
 *
 * @param data The buffer of data ready to be sent
 * @paran len The length of @p data in bytes
 */
 void sendData(const char* data,int len);
 /**
 * Requests that sending of input to the emulation
 * from the terminal process be suspended or resumed.
 *
 * @param suspend If true, requests that sending of
 * input from the terminal process' stdout be
 * suspended.  Otherwise requests that sending of
 * input be resumed.
 */
 void lockPtyRequest(bool suspend);
 /**
 * Requests that the pty used by the terminal process
 * be set to UTF 8 mode.
 *
 * TODO: More documentation
 */
 void useUtf8Request(bool);
 *
 * TODO: Document how the parameter works.
 */
 void changeTabTextColorRequest(int color);
 /**
 * This is emitted when the program running in the shell indicates whether or
 * not it is interested in mouse events.
 *
 * @param usesMouse This will be true if the program wants to be informed about
 * mouse events or false otherwise.
 */
 void programUsesMouseChanged(bool usesMouse);
 /**
 * Emitted when the contents of the screen image change.
 * The emulation buffers the updates from successive image changes,
 * and only emits outputChanged() at sensible intervals when
 * there is a lot of terminal activity.
 *
 * Normally there is no need for objects other than the screen windows
 * created with createWindow() to listen for this signal.
 *
 * ScreenWindow objects created using createWindow() will emit their
 * own outputChanged() signal in response to this signal.
 */
 void outputChanged();
 /**
 * Emitted when the program running in the terminal wishes to update the
 * session's title.  This also allows terminal programs to customize other
 * aspects of the terminal emulation display.
 *
 * This signal is emitted when the escape sequence "\033]ARG;VALUE\007"
 * is received in the input string, where ARG is a number specifying what
 * should change and VALUE is a string specifying the new value.
 *
 * TODO:  The name of this method is not very accurate since this method
 * is used to perform a whole range of tasks besides just setting
 * the user-title of the session.
 *
 * @param title Specifies what to change.
 * <ul>
 * <li>0 - Set window icon text and session title to @p newTitle</li>
 * <li>1 - Set window icon text to @p newTitle</li>
 * <li>2 - Set session title to @p newTitle</li>
 * <li>11 - Set the session's default background color to @p newTitle,
 *         where @p newTitle can be an HTML-style string (#RRGGBB) or a named
 *         color (eg 'red', 'blue').
 *         See http://doc.trolltech.com/4.2/qcolor.html#setNamedColor for more
 *         details.
 * </li>
 * <li>31 - Supposedly treats @p newTitle as a URL and opens it (NOT IMPLEMENTED)</li>
 * <li>32 - Sets the icon associated with the session.  @p newTitle is the name
 *    of the icon to use, which can be the name of any icon in the current KDE icon
 *    theme (eg: 'konsole', 'kate', 'folder_home')</li>
 * </ul>
 * @param newTitle Specifies the new title
 */
 void titleChanged(int title,const QString& newTitle);
 /**
 * Emitted when the program running in the terminal changes the
 * screen size.
 */
 void imageSizeChanged(int lineCount , int columnCount);
 /**
 * Emitted when the terminal program requests to change various properties
 * of the terminal display.
 *
 * A profile change command occurs when a special escape sequence, followed
 * by a string containing a series of name and value pairs is received.
 * This string can be parsed using a ProfileCommandParser instance.
 *
 void profileChangeCommandReceived(const QString& text);
 protected:
 virtual void setMode  (int mode) = 0;
 virtual void resetMode(int mode) = 0;
 /**
 * Processes an incoming character.  See receiveData()
 * @p ch A unicode character code.
 */
 virtual void receiveChar(int ch);
 /**
 * Sets the active screen.  The terminal has two screens, primary and alternate.
 * The primary screen is used by default.  When certain interactive programs such
 * as Vim are run, they trigger a switch to the alternate screen.
 *
 * @param index 0 to switch to the primary screen, or 1 to switch to the alternate screen
 */
 void setScreen(int index);
 enum EmulationCodec
 {
 LocaleCodec = 0,
 Utf8Codec   = 1
 };
 void setCodec(EmulationCodec codec); // codec number, 0 = locale, 1=utf8
 QList<ScreenWindow*> _windows;
 Screen* _currentScreen;  // pointer to the screen which is currently active,
 // this is one of the elements in the screen[] array
 Screen* _screen[2];      // 0 = primary screen ( used by most programs, including the shell
 //                      scrollbars are enabled in this mode )
 // 1 = alternate      ( used by vi , emacs etc.
 //                      scrollbars are not enabled in this mode )
 //decodes an incoming C-style character stream into a unicode QString using
 //the current text codec.  (this allows for rendering of non-ASCII characters in text files etc.)
 const QTextCodec* _codec;
 QTextDecoder* _decoder;
 const KeyboardTranslator* _keyTranslator; // the keyboard layout
 protected slots:
 /**
 * Schedules an update of attached views.
 * Repeated calls to bufferedUpdate() in close succession will result in only a single update,
 * much like the Qt buffered update of widgets.
 */
 void bufferedUpdate();
 private slots:
 // triggered by timer, causes the emulation to send an updated screen image to each
 // view
 void showBulk();
 void usesMouseChanged(bool usesMouse);
 private:
 bool _usesMouse;
 QTimer _bulkTimer1;
 QTimer _bulkTimer2;
 };
 #endif // ifndef EMULATION_H

Mercurial > octave-nkf

comparison libgui/qterminal/libqterminal/unix/Emulation.h @ 19627:446c46af4b42 stable