pyWidget.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_VIEW_WIDGETS_PYWIDGET_H
#define BALL_VIEW_WIDGETS_PYWIDGET_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_STRING_H
# include <BALL/DATATYPE/string.h>
#endif

#ifndef BALL_VIEW_WIDGETS_DOCKWIDGET_H
# include <BALL/VIEW/WIDGETS/dockWidget.h>
#endif

#ifndef BALL_VIEW_WIDGETS_TEXTEDITORWIDGET_H
# include <BALL/VIEW/WIDGETS/textEditorWidget.h>
#endif

#include <QtGui/QDragEnterEvent>
#include <QtGui/QKeyEvent>
#include <QtGui/QDropEvent>
#include <QtGui/QLineEdit>
#include <QtGui/QComboBox>
#include <QtGui/QTabWidget>
#include <QtGui/QSyntaxHighlighter>
#include <QtGui/QValidator>
#include <QtCore/QStringList>

#include <QtCore/QThread>

// currently doesnt work right
#undef BALL_QT_HAS_THREADS

namespace BALL
{
  namespace VIEW
  {

class PythonSettings;
class Preferences;

class RunPythonThread;

class BALL_VIEW_EXPORT PythonHighlighter
  : public QSyntaxHighlighter
{
  public:

  PythonHighlighter();

  ~PythonHighlighter() {};

  void compilePattern();
  void highlightBlock(const QString& text);

  QStringList python_keywords;
  QStringList BALL_keywords;
  QTextCharFormat my_class_format;
  QTextCharFormat python_format;
  QTextCharFormat string_format;
  QTextCharFormat comment_format;
  vector<QRegExp> python_patterns;
  vector<QRegExp> BALL_patterns;
  QRegExp         string_pattern;
  QRegExp         comment_pattern;
};

class BALL_VIEW_EXPORT PythonValidator
  : public QValidator
{
  public:
    PythonValidator(QObject* parent = 0);
    virtual ~PythonValidator();
    
    virtual State validate(QString& input, int& pos) const;   
};

class BALL_VIEW_EXPORT RunPythonThread
  : public QThread
{
  public:
    RunPythonThread();

    virtual void run();

    bool state;
    String input;
    String output;
};

struct BALL_VIEW_EXPORT Hotkey
{

  public:

  static Hotkey createHotkey(String modifier, String key, String command, 
                             bool& ok, String comment = "");

  bool operator == (const Hotkey& hotkey) const;

  bool operator == (const QKeyEvent& e) const;

  const Hotkey& operator = (const Hotkey& s);

  bool operator < (const Hotkey& key) { return this < &key;}

  bool set(const String& data);

  void get(String& data) const;

  String                comment;
  String                action;
  Qt::KeyboardModifiers button_state;
  Qt::Key               key;
};

class BALL_VIEW_EXPORT PyWidget
  : public DockWidget
{
  class MyLineEdit
    : public QLineEdit
  {
    public:
      MyLineEdit(QWidget* parent)
        : QLineEdit(parent) {};

      void setPyWidget(PyWidget* pw) { pw_ = pw;}

    protected:

      virtual void keyPressEvent(QKeyEvent* event);

      PyWidget* pw_;
  };

  class MyTextEdit
    : public TextEditorWidget
  {
    public:
      MyTextEdit(QWidget* parent)
        : TextEditorWidget(parent) {};

      void setPyWidget(PyWidget* pw) { pw_ = pw;}

    protected:

      virtual void keyPressEvent(QKeyEvent* event);

      PyWidget* pw_;
  };

  friend class MyLineEdit;

  Q_OBJECT

  public:
  
  BALL_EMBEDDABLE(PyWidget, Embeddable)

  

  PyWidget(QWidget* parent = 0, const char* name = 0);

  PyWidget(const PyWidget& p);

  ~PyWidget();
  
  bool isValid() const 
    { return valid_;}


  virtual void initializeWidget(MainControl& main_control);

  virtual void finalizeWidget(MainControl& main_control);
  
  void initializePreferencesTab(Preferences &preferences);
  
  void finalizePreferencesTab(Preferences &preferences);

  virtual void applyPreferences();
  
  virtual void scriptDialog(bool run = false);

  bool toAbortScript();

  void map(String modifier, String key, String command, String comment = "");

  void unmap(String modifier, String key);

  void insertHotkey(const Hotkey& hotkey);

  void removeHotkey(const Hotkey& hotkey);

  void reactTo(const QKeyEvent& e);

  virtual bool canHandle(const String& fileformat) const;

  virtual bool openFile(const String& filename);

  bool openFile(const String& filename, bool run, bool is_current = false);

  //
  bool runString(String command);

  //
  String getCurrentLine() const;

  //
  void dump(std::ostream& s, Size depth) const;

  //
  void showClassDocu(String classname, String member);

  //
  virtual void fetchPreferences(INIFile& inifile);
  
  //
  virtual void writePreferences(INIFile& inifile);

  //
  void checkMenu(MainControl& main_control);

  QString getCurrentScript();

  bool isInDirectMode() const;

  public slots:

  //
  void showEditContextMenu(const QPoint& point);

  //
  void showContextMenu(const QPoint& point);

  //
  void showCompletion();

  //
  void clear();

  //
  void exportHistory();

  //
  void abortScript();

  // Show the docu for the current line
  void showDocumentation();

  bool runCurrentScript();

  void loadScript();
  
  void execScript();

  void saveScript();

  void clearScript();

  virtual void hotkeyItem();

  virtual void modifyHotkeys();

  void appendText(const String& text, bool output = false, bool state_message = false);

  bool getMembers(const String& classname, QStringList& sl, const String& prefix);

  protected slots:

  virtual bool returnPressed();

  virtual bool completionSelected_();

  virtual void showHelp_();

  virtual void printCursorPosition_();

  virtual void createScript_();

  virtual void clearHistory_();

  protected:

  bool getClassAndMember_(String toc);

  void setError_(bool state);

  virtual void startInterpreter();

  virtual void paste();

  bool parseLine_(String line);

  void appendToHistory_(const String& line);
  
  void newPrompt_();

  bool testMultilineStart_(const String& line);

  //_
  const char* getPrompt_() const;

  //_
  bool storeScript_();

  //_ Wrapper for multi and single threading call
  String runCommand_(const String& command, bool& state);

  void appendText_(TextEditorWidget* te, String text);

  void retrieveHistoryLine_(Position index);

  virtual void contentsDragEnterEvent(QDragEnterEvent* e);

  virtual void contentsDropEvent(QDropEvent* e);

  bool keyPressed(QKeyEvent* e);

  void createMenuHelpEntry_(QMenu* menu, TextEditorWidget* text_edit, const QPoint& point);

  void findError_(String result);

  String getCurrentWord_(QTextCursor& text_cursor);

  QComboBox* getCompletionBox_();

  std::list<Hotkey>::iterator findKey_(Hotkey& hotkey);

  TextEditorWidget*         text_edit_, *script_output_;
  MyTextEdit*       script_edit_;
  QTabWidget*       tab_widget_;
  PythonHighlighter highlighter_1_, highlighter_2_;
  PythonValidator   validator_;
  MyLineEdit*       line_edit_;
  QComboBox*        combo_box_, *editor_combo_box_;
  std::list<Hotkey> hotkeys_;
  //                we use an own working dir to find Python Scripts
  String            working_dir_;
  bool              valid_;
  bool              started_startup_script_;
  Preferences*      preferences_;

  Position          current_line_;
  bool              multi_line_mode_;
  Size              multi_lines_;
  String            multi_line_text_;
  vector<String>    history_;
  vector<bool>      results_;
  Position          history_position_;
  String            startup_script_;
  PythonSettings*   python_settings_;
  RunPythonThread*  thread_;
  bool              stop_script_;
  Size              complete_prefix_;
  String            class_, member_;
  Position          intend_;
  bool              running_;
  bool              silent_, full_silent_;
  bool              script_mode_;
  String            current_script_;
};

  } // namespaces 
} // namespaces
  
#endif // BALL_VIEW_WIDGETS_PYWIDGET_H