octave-nkf: libgui/qterminal/libqterminal/unix/KeyboardTranslator.h annotate

annotate libgui/qterminal/libqterminal/unix/KeyboardTranslator.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

rev	line source
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	1 /*
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	2 This source file is part of Konsole, a terminal emulator.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	3
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 15681 diff changeset	4 Copyright (C) 2007, 2013 by Robert Knight <robertknight@gmail.com>
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	5
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	6 Rewritten for QT4 by e_k <e_k at users.sourceforge.net>, Copyright (C)2008
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	7
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	8 This program is free software; you can redistribute it and/or modify
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	9 it under the terms of the GNU General Public License as published by
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	10 the Free Software Foundation; either version 2 of the License, or
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	11 (at your option) any later version.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	12
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	13 This program is distributed in the hope that it will be useful,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	14 but WITHOUT ANY WARRANTY; without even the implied warranty of
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	16 GNU General Public License for more details.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	17
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	18 You should have received a copy of the GNU General Public License
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	19 along with this program; if not, write to the Free Software
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	21 02110-1301 USA.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	22 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	23
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	24 #ifndef KEYBOARDTRANSLATOR_H
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	25 #define KEYBOARDTRANSLATOR_H
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	26
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	27 // Qt
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	28 #include <QtCore/QHash>
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	29 #include <QtCore/QList>
17827 2de613986374 include Qt files with <QFoo> instead of <QtGui/QFoo> (bug #40252) John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	30 #include <QKeySequence>
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	31 #include <QtCore/QMetaType>
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	32 #include <QtCore/QVarLengthArray>
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	33 #include <QtCore>
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	34
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	35 typedef void (*CleanUpFunction)();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	36
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	37 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	38 * @internal
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	39 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	40 * Helper class for K_GLOBAL_STATIC to clean up the object on library unload or application
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	41 * shutdown.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	42 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	43 class CleanUpGlobalStatic
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	44 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	45 public:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	46 CleanUpFunction func;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	47
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	48 inline ~CleanUpGlobalStatic() { func(); }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	49 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	50
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	51
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	52 //these directives are taken from the heart of kdecore
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	53
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	54 # define K_GLOBAL_STATIC_STRUCT_NAME(NAME)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	55
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	56 #if QT_VERSION < 0x040400
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	57 # define Q_BASIC_ATOMIC_INITIALIZER Q_ATOMIC_INIT
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	58 # define testAndSetOrdered testAndSet
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	59 #endif
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	60
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	61 #define K_GLOBAL_STATIC(TYPE, NAME) K_GLOBAL_STATIC_WITH_ARGS(TYPE, NAME, ())
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	62
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	63 #define K_GLOBAL_STATIC_WITH_ARGS(TYPE, NAME, ARGS) \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	64 static QBasicAtomicPointer<TYPE > _k_static_##NAME = Q_BASIC_ATOMIC_INITIALIZER(0); \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	65 static bool _k_static_##NAME##_destroyed; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	66 static struct K_GLOBAL_STATIC_STRUCT_NAME(NAME) \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	67 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	68 bool isDestroyed() \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	69 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	70 return _k_static_##NAME##_destroyed; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	71 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	72 inline operator TYPE*() \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	73 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	74 return operator->(); \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	75 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	76 inline TYPE *operator->() \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	77 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	78 if (!_k_static_##NAME) { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	79 if (isDestroyed()) { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	80 qFatal("Fatal Error: Accessed global static '%s *%s()' after destruction. " \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	81 "Defined at %s:%d", #TYPE, #NAME, __FILE__, __LINE__); \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	82 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	83 TYPE *x = new TYPE ARGS; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	84 if (!_k_static_##NAME.testAndSetOrdered(0, x) \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	85 && _k_static_##NAME != x ) { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	86 delete x; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	87 } else { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	88 static CleanUpGlobalStatic cleanUpObject = { destroy }; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	89 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	90 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	91 return _k_static_##NAME; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	92 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	93 inline TYPE &operator*() \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	94 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	95 return *operator->(); \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	96 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	97 static void destroy() \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	98 { \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	99 _k_static_##NAME##_destroyed = true; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	100 TYPE *x = _k_static_##NAME; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	101 _k_static_##NAME = 0; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	102 delete x; \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	103 } \
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	104 } NAME;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	105
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	106
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	107
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	108
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	109
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	110 class QIODevice;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	111 class QTextStream;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	112
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	113 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	114 * A convertor which maps between key sequences pressed by the user and the
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	115 * character strings which should be sent to the terminal and commands
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	116 * which should be invoked when those character sequences are pressed.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	117 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	118 * Konsole supports multiple keyboard translators, allowing the user to
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	119 * specify the character sequences which are sent to the terminal
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	120 * when particular key sequences are pressed.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	121 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	122 * A key sequence is defined as a key code, associated keyboard modifiers
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	123 * (Shift,Ctrl,Alt,Meta etc.) and state flags which indicate the state
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	124 * which the terminal must be in for the key sequence to apply.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	125 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	126 class KeyboardTranslator
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	127 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	128 public:
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	129 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	130 * The meaning of a particular key sequence may depend upon the state which
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	131 * the terminal emulation is in. Therefore findEntry() may return a different
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	132 * Entry depending upon the state flags supplied.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	133 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	134 * This enum describes the states which may be associated with with a particular
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	135 * entry in the keyboard translation entry.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	136 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	137 enum State
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	138 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	139 /** Indicates that no special state is active */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	140 NoState = 0,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	141 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	142 * TODO More documentation
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	143 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	144 NewLineState = 1,
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	145 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	146 * Indicates that the terminal is in 'Ansi' mode.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	147 * TODO: More documentation
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	148 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	149 AnsiState = 2,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	150 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	151 * TODO More documentation
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	152 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	153 CursorKeysState = 4,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	154 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	155 * Indicates that the alternate screen ( typically used by interactive programs
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	156 * such as screen or vim ) is active
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	157 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	158 AlternateScreenState = 8,
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	159 /** Indicates that any of the modifier keys is active. */
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	160 AnyModifierState = 16
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	161 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	162 Q_DECLARE_FLAGS(States,State)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	163
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	164 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	165 * This enum describes commands which are associated with particular key sequences.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	166 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	167 enum Command
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	168 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	169 /** Indicates that no command is associated with this command sequence */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	170 NoCommand = 0,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	171 /** TODO Document me */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	172 SendCommand = 1,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	173 /** Scroll the terminal display up one page */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	174 ScrollPageUpCommand = 2,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	175 /** Scroll the terminal display down one page */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	176 ScrollPageDownCommand = 4,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	177 /** Scroll the terminal display up one line */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	178 ScrollLineUpCommand = 8,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	179 /** Scroll the terminal display down one line */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	180 ScrollLineDownCommand = 16,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	181 /** Toggles scroll lock mode */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	182 ScrollLockCommand = 32,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	183 /** Echos the operating system specific erase character. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	184 EraseCommand = 64
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	185 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	186 Q_DECLARE_FLAGS(Commands,Command)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	187
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	188 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	189 * Represents an association between a key sequence pressed by the user
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	190 * and the character sequence and commands associated with it for a particular
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	191 * KeyboardTranslator.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	192 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	193 class Entry
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	194 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	195 public:
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	196 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	197 * Constructs a new entry for a keyboard translator.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	198 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	199 Entry();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	200
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	201 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	202 * Returns true if this entry is null.
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	203 * This is true for newly constructed entries which have no properties set.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	204 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	205 bool isNull() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	206
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	207 /** Returns the commands associated with this entry */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	208 Command command() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	209 /** Sets the command associated with this entry. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	210 void setCommand(Command command);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	211
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	212 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	213 * Returns the character sequence associated with this entry, optionally replacing
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	214 * wildcard '*' characters with numbers to indicate the keyboard modifiers being pressed.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	215 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	216 * TODO: The numbers used to replace '*' characters are taken from the Konsole/KDE 3 code.
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	217 * Document them.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	218 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	219 * @param expandWildCards Specifies whether wild cards (occurrences of the '*' character) in
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	220 * the entry should be replaced with a number to indicate the modifier keys being pressed.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	221 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	222 * @param modifiers The keyboard modifiers being pressed.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	223 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	224 QByteArray text(bool expandWildCards = false,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	225 Qt::KeyboardModifiers modifiers = Qt::NoModifier) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	226
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	227 /** Sets the character sequence associated with this entry */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	228 void setText(const QByteArray& text);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	229
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	230 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	231 * Returns the character sequence associated with this entry,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	232 * with any non-printable characters replaced with escape sequences.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	233 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	234 * eg. \\E for Escape, \\t for tab, \\n for new line.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	235 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	236 * @param expandWildCards See text()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	237 * @param modifiers See text()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	238 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	239 QByteArray escapedText(bool expandWildCards = false,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	240 Qt::KeyboardModifiers modifiers = Qt::NoModifier) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	241
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	242 /** Returns the character code ( from the Qt::Key enum ) associated with this entry */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	243 int keyCode() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	244 /** Sets the character code associated with this entry */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	245 void setKeyCode(int keyCode);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	246
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	247 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	248 * Returns a bitwise-OR of the enabled keyboard modifiers associated with this entry.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	249 * If a modifier is set in modifierMask() but not in modifiers(), this means that the entry
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	250 * only matches when that modifier is NOT pressed.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	251 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	252 * If a modifier is not set in modifierMask() then the entry matches whether the modifier
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	253 * is pressed or not.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	254 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	255 Qt::KeyboardModifiers modifiers() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	256
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	257 /** Returns the keyboard modifiers which are valid in this entry. See modifiers() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	258 Qt::KeyboardModifiers modifierMask() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	259
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	260 /** See modifiers() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	261 void setModifiers( Qt::KeyboardModifiers modifiers );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	262 /** See modifierMask() and modifiers() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	263 void setModifierMask( Qt::KeyboardModifiers modifiers );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	264
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	265 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	266 * Returns a bitwise-OR of the enabled state flags associated with this entry.
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	267 * If flag is set in stateMask() but not in state(), this means that the entry only
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	268 * matches when the terminal is NOT in that state.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	269 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	270 * If a state is not set in stateMask() then the entry matches whether the terminal
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	271 * is in that state or not.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	272 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	273 States state() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	274
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	275 /** Returns the state flags which are valid in this entry. See state() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	276 States stateMask() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	277
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	278 /** See state() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	279 void setState( States state );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	280 /** See stateMask() */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	281 void setStateMask( States mask );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	282
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	283 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	284 * Returns the key code and modifiers associated with this entry
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	285 * as a QKeySequence
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	286 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	287 //QKeySequence keySequence() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	288
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	289 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	290 * Returns this entry's conditions ( ie. its key code, modifier and state criteria )
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	291 * as a string.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	292 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	293 QString conditionToString() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	294
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	295 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	296 * Returns this entry's result ( ie. its command or character sequence )
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	297 * as a string.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	298 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	299 * @param expandWildCards See text()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	300 * @param modifiers See text()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	301 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	302 QString resultToString(bool expandWildCards = false,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	303 Qt::KeyboardModifiers modifiers = Qt::NoModifier) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	304
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	305 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	306 * Returns true if this entry matches the given key sequence, specified
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	307 * as a combination of @p keyCode , @p modifiers and @p state.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	308 */
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	309 bool matches( int keyCode ,
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	310 Qt::KeyboardModifiers modifiers ,
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	311 States flags ) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	312
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	313 bool operator==(const Entry& rhs) const;
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	314
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	315 private:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	316 void insertModifier( QString& item , int modifier ) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	317 void insertState( QString& item , int state ) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	318 QByteArray unescape(const QByteArray& text) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	319
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	320 int _keyCode;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	321 Qt::KeyboardModifiers _modifiers;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	322 Qt::KeyboardModifiers _modifierMask;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	323 States _state;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	324 States _stateMask;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	325
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	326 Command _command;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	327 QByteArray _text;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	328 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	329
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	330 /** Constructs a new keyboard translator with the given @p name */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	331 KeyboardTranslator(const QString& name);
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	332
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	333 //KeyboardTranslator(const KeyboardTranslator& other);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	334
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	335 /** Returns the name of this keyboard translator */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	336 QString name() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	337
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	338 /** Sets the name of this keyboard translator */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	339 void setName(const QString& name);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	340
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	341 /** Returns the descriptive name of this keyboard translator */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	342 QString description() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	343
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	344 /** Sets the descriptive name of this keyboard translator */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	345 void setDescription(const QString& description);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	346
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	347 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	348 * Looks for an entry in this keyboard translator which matches the given
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	349 * key code, keyboard modifiers and state flags.
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	350 *
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	351 * Returns the matching entry if found or a null Entry otherwise ( ie.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	352 * entry.isNull() will return true )
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	353 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	354 * @param keyCode A key code from the Qt::Key enum
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	355 * @param modifiers A combination of modifiers
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	356 * @param state Optional flags which specify the current state of the terminal
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	357 */
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	358 Entry findEntry(int keyCode ,
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	359 Qt::KeyboardModifiers modifiers ,
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	360 States state = NoState) const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	361
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	362 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	363 * Adds an entry to this keyboard translator's table. Entries can be looked up according
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	364 * to their key sequence using findEntry()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	365 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	366 void addEntry(const Entry& entry);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	367
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	368 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	369 * Replaces an entry in the translator. If the @p existing entry is null,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	370 * then this is equivalent to calling addEntry(@p replacement)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	371 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	372 void replaceEntry(const Entry& existing , const Entry& replacement);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	373
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	374 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	375 * Removes an entry from the table.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	376 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	377 void removeEntry(const Entry& entry);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	378
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	379 /** Returns a list of all entries in the translator. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	380 QList<Entry> entries() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	381
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	382 private:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	383
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	384 QHash<int,Entry> _entries; // entries in this keyboard translation,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	385 // entries are indexed according to
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	386 // their keycode
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	387 QString _name;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	388 QString _description;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	389 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	390 Q_DECLARE_OPERATORS_FOR_FLAGS(KeyboardTranslator::States)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	391 Q_DECLARE_OPERATORS_FOR_FLAGS(KeyboardTranslator::Commands)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	392
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	393 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	394 * Parses the contents of a Keyboard Translator (.keytab) file and
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	395 * returns the entries found in it.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	396 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	397 * Usage example:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	398 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	399 * @code
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	400 * QFile source( "/path/to/keytab" );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	401 * source.open( QIODevice::ReadOnly );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	402 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	403 * KeyboardTranslator* translator = new KeyboardTranslator( "name-of-translator" );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	404 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	405 * KeyboardTranslatorReader reader(source);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	406 * while ( reader.hasNextEntry() )
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	407 * translator->addEntry(reader.nextEntry());
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	408 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	409 * source.close();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	410 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	411 * if ( !reader.parseError() )
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	412 * {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	413 * // parsing succeeded, do something with the translator
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	414 * }
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	415 * else
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	416 * {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	417 * // parsing failed
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	418 * }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	419 * @endcode
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	420 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	421 class KeyboardTranslatorReader
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	422 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	423 public:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	424 /** Constructs a new reader which parses the given @p source */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	425 KeyboardTranslatorReader( QIODevice* source );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	426
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	427 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	428 * Returns the description text.
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	429 * TODO: More documentation
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	430 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	431 QString description() const;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	432
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	433 /** Returns true if there is another entry in the source stream */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	434 bool hasNextEntry();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	435 /** Returns the next entry found in the source stream */
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	436 KeyboardTranslator::Entry nextEntry();
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	437
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	438 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	439 * Returns true if an error occurred whilst parsing the input or
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	440 * false if no error occurred.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	441 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	442 bool parseError();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	443
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	444 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	445 * Parses a condition and result string for a translator entry
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	446 * and produces a keyboard translator entry.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	447 *
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	448 * The condition and result strings are in the same format as in
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	449 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	450 static KeyboardTranslator::Entry createEntry( const QString& condition ,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	451 const QString& result );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	452 private:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	453 struct Token
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	454 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	455 enum Type
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	456 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	457 TitleKeyword,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	458 TitleText,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	459 KeyKeyword,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	460 KeySequence,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	461 Command,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	462 OutputText
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	463 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	464 Type type;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	465 QString text;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	466 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	467 QList<Token> tokenize(const QString&);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	468 void readNext();
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	469 bool decodeSequence(const QString& ,
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	470 int& keyCode,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	471 Qt::KeyboardModifiers& modifiers,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	472 Qt::KeyboardModifiers& modifierMask,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	473 KeyboardTranslator::States& state,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	474 KeyboardTranslator::States& stateFlags);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	475
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	476 static bool parseAsModifier(const QString& item , Qt::KeyboardModifier& modifier);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	477 static bool parseAsStateFlag(const QString& item , KeyboardTranslator::State& state);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	478 static bool parseAsKeyCode(const QString& item , int& keyCode);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	479 static bool parseAsCommand(const QString& text , KeyboardTranslator::Command& command);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	480
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	481 QIODevice* _source;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	482 QString _description;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	483 KeyboardTranslator::Entry _nextEntry;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	484 bool _hasNext;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	485 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	486
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	487 /** Writes a keyboard translation to disk. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	488 class KeyboardTranslatorWriter
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	489 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	490 public:
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	491 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	492 * Constructs a new writer which saves data into @p destination.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	493 * The caller is responsible for closing the device when writing is complete.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	494 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	495 KeyboardTranslatorWriter(QIODevice* destination);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	496 ~KeyboardTranslatorWriter();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	497
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	498 /**
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	499 * Writes the header for the keyboard translator.
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	500 * @param description Description of the keyboard translator.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	501 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	502 void writeHeader( const QString& description );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	503 /** Writes a translator entry. */
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	504 void writeEntry( const KeyboardTranslator::Entry& entry );
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	505
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	506 private:
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	507 QIODevice* _destination;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	508 QTextStream* _writer;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	509 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	510
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	511 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	512 * Manages the keyboard translations available for use by terminal sessions,
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	513 * see KeyboardTranslator.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	514 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	515 class KeyboardTranslatorManager
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	516 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	517 public:
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	518 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	519 * Constructs a new KeyboardTranslatorManager and loads the list of
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	520 * available keyboard translations.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	521 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	522 * The keyboard translations themselves are not loaded until they are
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	523 * first requested via a call to findTranslator()
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	524 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	525 KeyboardTranslatorManager();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	526 ~KeyboardTranslatorManager();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	527
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	528 /**
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	529 * Adds a new translator. If a translator with the same name
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	530 * already exists, it will be replaced by the new translator.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	531 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	532 * TODO: More documentation.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	533 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	534 void addTranslator(KeyboardTranslator* translator);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	535
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	536 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	537 * Deletes a translator. Returns true on successful deletion or false otherwise.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	538 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	539 * TODO: More documentation
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	540 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	541 bool deleteTranslator(const QString& name);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	542
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	543 /** Returns the default translator for Konsole. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	544 const KeyboardTranslator* defaultTranslator();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	545
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	546 /**
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	547 * Returns the keyboard translator with the given name or 0 if no translator
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	548 * with that name exists.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	549 *
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	550 * The first time that a translator with a particular name is requested,
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	551 * the on-disk .keyboard file is loaded and parsed.
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	552 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	553 const KeyboardTranslator* findTranslator(const QString& name);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	554 /**
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	555 * Returns a list of the names of available keyboard translators.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	556 *
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	557 * The first time this is called, a search for available
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	558 * translators is started.
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	559 */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	560 QList<QString> allTranslators();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	561
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	562 /** Returns the global KeyboardTranslatorManager instance. */
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	563 static KeyboardTranslatorManager* instance();
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	564
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	565 private:
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	566 static const char* defaultTranslatorText;
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	567
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	568 void findTranslators(); // locate the available translators
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	569 KeyboardTranslator* loadTranslator(const QString& name); // loads the translator
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	570 // with the given name
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	571 KeyboardTranslator* loadTranslator(QIODevice* device,const QString& name);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	572
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	573 bool saveTranslator(const KeyboardTranslator* translator);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	574 QString findTranslatorPath(const QString& name);
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	575
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	576 QHash<QString,KeyboardTranslator*> _translators; // maps translator-name -> KeyboardTranslator
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	577 // instance
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	578 bool _haveLoadedAll;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	579 };
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	580
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	581 inline int KeyboardTranslator::Entry::keyCode() const { return _keyCode; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	582 inline void KeyboardTranslator::Entry::setKeyCode(int keyCode) { _keyCode = keyCode; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	583
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	584 inline void KeyboardTranslator::Entry::setModifiers( Qt::KeyboardModifiers modifier )
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	585 {
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	586 _modifiers = modifier;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	587 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	588 inline Qt::KeyboardModifiers KeyboardTranslator::Entry::modifiers() const { return _modifiers; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	589
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	590 inline void KeyboardTranslator::Entry::setModifierMask( Qt::KeyboardModifiers mask )
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	591 {
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	592 _modifierMask = mask;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	593 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	594 inline Qt::KeyboardModifiers KeyboardTranslator::Entry::modifierMask() const { return _modifierMask; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	595
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	596 inline bool KeyboardTranslator::Entry::isNull() const
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	597 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	598 return ( *this == Entry() );
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	599 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	600
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	601 inline void KeyboardTranslator::Entry::setCommand( Command command )
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	602 {
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	603 _command = command;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	604 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	605 inline KeyboardTranslator::Command KeyboardTranslator::Entry::command() const { return _command; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	606
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	607 inline void KeyboardTranslator::Entry::setText( const QByteArray& text )
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	608 {
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	609 _text = unescape(text);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	610 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	611 inline int oneOrZero(int value)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	612 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	613 return value ? 1 : 0;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	614 }
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	615 inline QByteArray KeyboardTranslator::Entry::text(bool expandWildCards,Qt::KeyboardModifiers modifiers) const
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	616 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	617 QByteArray expandedText = _text;
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	618
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	619 if (expandWildCards)
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	620 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	621 int modifierValue = 1;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	622 modifierValue += oneOrZero(modifiers & Qt::ShiftModifier);
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	623 modifierValue += oneOrZero(modifiers & Qt::AltModifier) << 1;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	624 modifierValue += oneOrZero(modifiers & Qt::ControlModifier) << 2;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	625
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	626 for (int i=0;i<_text.length();i++)
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	627 {
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	628 if (expandedText[i] == '*')
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	629 expandedText[i] = '0' + modifierValue;
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	630 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	631 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	632
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	633 return expandedText;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	634 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	635
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	636 inline void KeyboardTranslator::Entry::setState( States state )
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	637 {
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	638 _state = state;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	639 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	640 inline KeyboardTranslator::States KeyboardTranslator::Entry::state() const { return _state; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	641
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	642 inline void KeyboardTranslator::Entry::setStateMask( States stateMask )
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	643 {
446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17827 diff changeset	644 _stateMask = stateMask;
15651 845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	645 }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	646 inline KeyboardTranslator::States KeyboardTranslator::Entry::stateMask() const { return _stateMask; }
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	647
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	648
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	649 #endif // KEYBOARDTRANSLATOR_H
845cebf281aa Added files of QConsole. Jacob Dawid <jacob.dawid@googlemail.com> parents: diff changeset	650

Mercurial > octave-nkf

annotate libgui/qterminal/libqterminal/unix/KeyboardTranslator.h @ 19627:446c46af4b42 stable