fix crash due to invalidated iterator

[lyx.git] / src / frontends / controllers / Kernel.h

diff --git a/src/frontends/controllers/Kernel.h b/src/frontends/controllers/Kernel.h
index 60d7cfc47fce35d48383fe29865e06a9134f807f..f046c7f1509785478a4402783f9f22f2703a23f1 100644 (file)
--- a/src/frontends/controllers/Kernel.h
+++ b/src/frontends/controllers/Kernel.h
@@ -6,88 +6,92 @@
  *
  * \author Angus Leeming
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef KERNEL_H
 #define KERNEL_H
 
-
-#include "LString.h"
-
+#include <string>
 
 class Buffer;
 class BufferView;
 class FuncRequest;
 class LyXView;
 
+namespace lyx {
+namespace frontend {
 
-/** \class Kernel is a wrapper making the LyX kernel available to the dialog.
+/** \c Kernel is a wrapper making the LyX kernel available to the dialog.
  * (Ie, it provides an interface to the Model part of the Model-Controller-
  *  View split.
  *  In an ideal world, it will shrink as more info is passed to the
- *  Dialog::show() and update() methods.
+ *  Dialog::show() and Dialog::update() methods.
  */
 class Kernel {
 public:
        /// \param lv is the access point for the dialog to the LyX kernel.
        Kernel(LyXView & lv);
 
-       /** This method is the primary prupose of the class. It provides
-           the "gateway" by which the dialog can send a request (of a
-           change in the data, for more information) to the kernel,
-           encoded as \param fr.
-           \param verbose Set to true if the completed action should
-           be displayed in the minibuffer.
+       /** This method is the primary purpose of the class. It provides
+        *  the "gateway" by which the dialog can send a request (of a
+        *  change in the data, for more information) to the kernel.
+        *  \param fr is the encoding of the request.
         */
-       void dispatch(FuncRequest const & fr, bool verbose = false) const;
+       void dispatch(FuncRequest const & fr) const;
 
        /** The dialog has received a request from the user
-           (who pressed the "Restore" buuton) to update  contents.
-           It must, therefore, ask the kernel to provide this information.
-           \param name is used as an identifier by the kernel
-           when the information is posted.
+        *  (who pressed the "Restore" button) to update contents.
+        *  It must, therefore, ask the kernel to provide this information.
+        *  \param name is used to identify the dialog to the kernel.
         */
-       void updateDialog(string const & name) const;
+       void updateDialog(std::string const & name) const;
 
        /** A request from the Controller that future changes to the data
         *  stored by the dialog are not applied to the inset currently
         *  connected to the dialog. Instead, they will be used to generate
         *  a new inset at the cursor position.
+        *  \param name is used to identify the dialog to the kernel.
         */
-       void disconnect(string const & name) const;
+       void disconnect(std::string const & name) const;
 
+       /** \name Kernel Wrappers
+        *  Simple wrapper functions to Buffer methods.
+        */
        //@{
-       /// Simple wrapper functions to Buffer methods.
        bool isBufferAvailable() const;
        bool isBufferReadonly() const;
+       std::string const bufferFilepath() const;
        //@}
 
-       //@{
-       /** \enum DocTypes is used to flag the different kinds of buffer
+       /** \enum DocType used to flag the different kinds of buffer
         *  without making the kernel header files available to the
         *  dialog's Controller or View.
         */
-       enum DocTypes {
+       enum DocType {
                LATEX,
                LITERATE,
                LINUXDOC,
                DOCBOOK
        };
        /// The type of the current buffer.
-       DocTypes docType() const;
-       //@}
+       DocType docType() const;
 
+       /** A request that the GUI be redrawn,
+        *  e.g. because the colors have been remapped.
+        */
+       void redrawGUI() const;
 
-       //@{
-       /** Unpleasantly public internals of the LyX kernel.
+       /** \name Kernel Nasties
+        *  Unpleasantly public internals of the LyX kernel.
         *  We should aim to reduce/remove these from the interface.
         */
+       //@{
        LyXView & lyxview() { return lyxview_; }
        LyXView const & lyxview() const { return lyxview_; }
 
-       Buffer * buffer();
-       Buffer const * buffer() const;
+       Buffer & buffer();
+       Buffer const & buffer() const;
 
        BufferView * bufferview();
        BufferView const * bufferview() const;
@@ -98,4 +102,19 @@ private:
 };
 
 
+/** \c KernelDocType is a wrapper for Kernel::DocType.
+ *  It can be forward-declared and passed as a function argument without
+ *  having to expose Kernel.h.
+ */
+class KernelDocType {
+public:
+       KernelDocType(Kernel::DocType val) : val_(val) {}
+       operator Kernel::DocType() const { return val_; }
+private:
+       Kernel::DocType val_;
+};
+
+} // namespace frontend
+} // namespace lyx
+
 #endif // KERNEL_H