// -*- C++ -*-
+/**
+ * \file lyxfunc.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
#ifndef LYXFUNC_H
#define LYXFUNC_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "commandtags.h"
#include "kbsequence.h"
-#include "insets/lyxinset.h"
-#include "LString.h"
+#include "lfuns.h"
+
+#include "support/docstring.h"
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/trackable.hpp>
+
+namespace lyx {
+
+class BufferView;
+class FuncRequest;
+class FuncStatus;
+class LyXKeySym;
+class LyXText;
class LyXView;
-class auto_mem_buffer;
-/** This class encapsulates all the LyX command operations.
+
+/** This class encapsulates all the LyX command operations.
This is the class of the LyX's "high level event handler".
Every user command is processed here, either invocated from
keyboard or from the GUI. All GUI objects, including buttons and
menus should use this class and never call kernel functions directly.
*/
-class LyXFunc {
+class LyXFunc : public boost::signals::trackable {
public:
- /// The status of a function.
- enum func_status {
- OK = 0, // No problem
- Unknown = 1,
- Disabled = 2, // Command cannot be executed
- ToggleOn = 4,
- ToggleOff = 8
- };
- ///
- explicit
- LyXFunc(LyXView *);
-
+ ///
+ explicit LyXFunc();
+
/// LyX dispatcher, executes lyx actions.
- string Dispatch(int action, char const * arg = 0);
-
- /// The same but uses the name of a lyx command.
- string Dispatch(string const & cmd);
+ void dispatch(FuncRequest const &);
+
+ ///
+ void setLyXView(LyXView * lv);
+
+ ///
+ void initKeySequences(kb_keymap * kb);
- /// Same again but for xtl buffers. Still looking for better idea.
- bool Dispatch(int action, auto_mem_buffer &);
+ /// return the status bar state string
+ docstring const viewStatusMessage();
- /// A keyboard event is processed to execute a lyx action.
- int processKeyEvent(XEvent * ev);
+ ///
+ void processKeySym(LyXKeySymPtr key, key_modifier::state state);
///
- func_status getStatus(int ac) const;
-
+ FuncStatus getStatus(FuncRequest const & action) const;
+
/// The last key was meta
bool wasMetaKey() const;
- // These can't be global because are part of the
- // internal state (ale970227)
- /// Get the current keyseq string
- string keyseqStr() const;
-
- /// Is the key sequence uncomplete?
- bool keyseqUncomplete() const;
-
- /// get options for the current keyseq
- string keyseqOptions() const;
-
- /// True if lyxfunc reports an error
- bool errorStat() const { return errorstat; }
- /// Buffer to store result messages
- void setMessage(string const & m);
- /// Buffer to store result messages
- void setErrorMessage(string const &) const;
- /// Buffer to store result messages
- string getMessage() const { return dispatch_buffer; }
- /// Get next inset of this class from current cursor position
- Inset * getInsetByCode(Inset::Code);
-
- /// Should a hint message be displayed?
- void setHintMessage(bool);
+ /// True if lyxfunc reports an error
+ bool errorStat() const { return errorstat; }
+ /// Buffer to store result messages
+ void setMessage(docstring const & m) const;
+ /// Buffer to store result messages
+ void setErrorMessage(docstring const &) const;
+ /// Buffer to store result messages
+ docstring const getMessage() const { return dispatch_buffer; }
+ /// Handle a accented char key sequence
+ void handleKeyFunc(kb_action action);
+ /// goto a bookmark
+ /// openFile: whether or not open a file if the file is not opened
+ /// switchToBuffer: whether or not switch to buffer if the buffer is
+ /// not the current buffer
+ void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
+
private:
///
- LyXView * owner;
+ BufferView * view() const;
+
///
- static int psd_idx;
- ///
- kb_sequence keyseq;
- ///
- kb_sequence cancel_meta_seq;
+ LyXView * lyx_view_;
+
+ /// the last character added to the key sequence, in UCS4 encoded form
+ char_type encoded_last_key;
+
///
- unsigned meta_fake_bit;
+ boost::scoped_ptr<kb_sequence> keyseq;
///
- void moveCursorUpdate(bool selecting = false);
+ boost::scoped_ptr<kb_sequence> cancel_meta_seq;
///
- void setupLocalKeymap();
- ///
- kb_action lyx_dead_action;
- ///
- kb_action lyx_calling_dead_action;
- /// Error status, only Dispatch can change this flag
- mutable bool errorstat;
+ key_modifier::state meta_fake_bit;
+
+ /// Error status, only Dispatch can change this flag
+ mutable bool errorstat;
- /** Buffer to store messages and result data. Is there a
+ /** Buffer to store messages and result data. Is there a
good reason to have this one as static in Dispatch? (Ale)
*/
- mutable string dispatch_buffer;
- /// Command name and shortcut information
- string commandshortcut;
+ mutable docstring dispatch_buffer;
- // I think the following should be moved to BufferView. (Asger)
-
- ///
- void MenuNew(bool fromTemplate);
+ /// send a post-dispatch status message
+ void sendDispatchMessage(docstring const & msg,
+ FuncRequest const & ev);
+ // I think the following should be moved to BufferView. (Asger)
///
- void MenuOpen();
-
+ void menuNew(std::string const & argument, bool fromTemplate);
///
- void doImport(string const &);
- void doImportHelper(string const &, string const &, string const &,
- bool func(BufferView *, string const &) );
-
+ void open(std::string const &);
///
- void MenuInsertLyXFile(string const &);
-
+ void doImport(std::string const &);
///
- void CloseBuffer();
+ void closeBuffer();
///
void reloadBuffer();
- /// This is the same for all lyxfunc objects
- static bool show_sc;
+ ///
+ bool ensureBufferClean(BufferView * bv);
};
-
-
-/*-------------------- inlines --------------------------*/
-
-inline
-bool LyXFunc::wasMetaKey() const
-{
- return (meta_fake_bit != 0);
-}
-
-
-inline
-string LyXFunc::keyseqStr() const
-{
- // Why not just remove this function
- string text;
- keyseq.print(text, true);
- return text;
-}
-
-
-inline
-string LyXFunc::keyseqOptions() const
-{
- // Why not just remove this function
- string text;
- keyseq.printOptions(text);
- return text;
-}
-
-
-inline
-bool LyXFunc::keyseqUncomplete() const
-{
- return (keyseq.length > 0);
-}
-
-
-inline
-void LyXFunc::setHintMessage(bool hm)
-{
- show_sc = hm;
-}
-
-
-inline
-void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
-{
- fs = static_cast<LyXFunc::func_status>(fs | f);
-}
+
+/// Implementation is in lyx_main.C
+extern LyXFunc & theLyXFunc();
+
+/// Implementation is in lyx_main.C
+extern FuncStatus getStatus(FuncRequest const & action);
+
+/// Implementation is in lyx_main.C
+extern void dispatch(FuncRequest const & action);
+
+} // namespace lyx
#endif
projects / lyx.git / blobdiff