code_editor.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; version 2 of the
 * License.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301  USA
 */

#ifndef _CODE_EDITOR_H_
#define _CODE_EDITOR_H_

#ifndef SCI_NAMESPACE
#define SCI_NAMESPACE
#endif
#include "Scintilla.h"

#include <mforms/view.h>
#include <mforms/utilities.h>

class TiXmlDocument;
class TiXmlElement;

namespace mforms {

  class CodeEditor;
  class Menu;
  class FindPanel;

  enum SyntaxHighlighterLanguage {
    LanguageNone,
    LanguageMySQL50,
    LanguageMySQL51,
    LanguageMySQL55,
    LanguageMySQL56,
    LanguageHtml,   // includes embedded xml, javascript, php, vb, python
    LanguageLua,
    LanguagePython,
    LanguageCpp,    // Lexer for C++, C, Java, and JavaScript (which includes JSON).

    LanguageMySQL = LanguageMySQL56, // Always the latest language.
  };

  enum LineMarkup {
    LineMarkupNone          = 0,      // No markup for the given line.
    LineMarkupBreakpoint    = 1 << 0, // Line has a marker set for a break point.
    LineMarkupBreakpointHit = 1 << 1, // Line has a marker set for a break point which is currently hit.
    LineMarkupError         = 1 << 2, // Line's background is drawn in red to mark an execution error.
    LineMarkupStatement     = 1 << 3, // Marks a line as having a statement starting on it.
    LineMarkupCurrent       = 1 << 4, // Current execution line.

    LineMarkupAll           = 0xFF,   // All markup, useful for remove_markup.
  };

#ifndef SWIG
  inline LineMarkup operator| (LineMarkup a, LineMarkup b)
  {
    return (LineMarkup) ((int) a | (int) b);
  }
#endif

  // Indicators for a portion of text. Can span more than a single line or only part of a line.
  enum RangeIndicator {
    RangeIndicatorNone   = 0,
    RangeIndicatorError  = 1 << 0, // Red squiggles under a range of text. 
  };

  enum CodeEditorFeature {
    FeatureNone              = 0,
    FeatureWrapText          = 1 << 0, // Enables word wrapping.
    FeatureGutter            = 1 << 1, // Show/Hide gutter.
    FeatureReadOnly          = 1 << 2,
    FeatureShowSpecial       = 1 << 3, // Show white spaces and line ends with special chars.
    FeatureUsePopup          = 1 << 4, // Use built-in context menu.
    FeatureConvertEolOnPaste = 1 << 5, // Convert line endings to the current value in the editor
                                       // when pasting text.
    FeatureScrollOnResize     = 1 << 6, // Scroll caret into view if it would be hidden by a resize action.
    FeatureFolding            = 1 << 7, // Enable code folding.

    FeatureAll               = 0xFFFF,
  };

#ifndef SWIG
  inline CodeEditorFeature operator| (CodeEditorFeature a, CodeEditorFeature b)
  {
    return (CodeEditorFeature) ((int) a | (int) b);
  }
#endif

  enum AutoCompletionEventType {
    AutoCompletionSelection,   // The user selected an entry in the auto completion list.
    AutoCompletionCancelled,   // Auto completion was cancelled.
    AutoCompletionCharDeleted, // A character was deleted while auto completion was active.
  };

  enum EndOfLineMode {
    EolCRLF = 0,
    EolCR   = 1,
    EolLF   = 2,   // Default
  };
  
  enum FindFlags {
    FindDefault =    0,
    FindMatchCase =  (1 << 0),
    FindWrapAround = (1 << 1),
    FindWholeWords = (1 << 2),
    FindRegex =      (1 << 3)
  };

#ifndef SWIG
  inline FindFlags operator | (FindFlags a, FindFlags b)
  {
    return (FindFlags) ((int) a | (int) b);
  }

  inline FindFlags& operator |= (FindFlags& a, FindFlags b)
  {
    a = (FindFlags)((int) a | (int) b);
    return a;
  }
#endif

#ifndef SWIG

class MFORMS_EXPORT CodeEditorConfig
{
private:
  std::vector<std::string> _languages;
  SyntaxHighlighterLanguage _used_language;

  std::map<std::string, std::string> _keywords;
  std::map<std::string, std::string> _properties;
  std::map<std::string, std::string> _settings;
  std::map<int, std::map<std::string, std::string> > _styles;

  TiXmlDocument *_document;
  TiXmlElement *_language_element;
protected:
  void parse_properties();
  void parse_settings();
  void parse_keywords();
  void parse_styles();

public:
  CodeEditorConfig(SyntaxHighlighterLanguage language);
  ~CodeEditorConfig();

  std::vector<std::string> get_languages() { return _languages; };

  // TODO: add setters when customization is required.
  std::map<std::string, std::string> get_keywords() { return _keywords; };
  std::map<std::string, std::string> get_properties() { return _properties; };
  std::map<std::string, std::string> get_settings() { return _settings; };
  std::map<int, std::map<std::string, std::string> > get_styles() { return _styles; };
};
#endif // !SWIG

#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifndef SWIG
  struct CodeEditorImplPtrs
  {
    bool (*create)(CodeEditor* self);
    sptr_t (*send_editor)(CodeEditor* self, unsigned int message, uptr_t wParam, sptr_t lParam);
    void (*set_status_text)(CodeEditor* self, const std::string &text);
  };
#endif
#endif

  class MFORMS_EXPORT CodeEditor : public View
  {
  public:
    CodeEditor(void *host = NULL);
    ~CodeEditor();

    void setup();

    void set_text(const char* text);

    void set_value(const std::string& text);

    void set_text_keeping_state(const char* text);

    void append_text(const char* text, int length);

    void replace_selected_text(const std::string& text);

    const std::string get_text(bool selection_only);
    virtual std::string get_string_value() { return get_text(false); };

    const std::string get_text_in_range(int start, int end);

    std::pair<const char*, size_t> get_text_ptr();

    void set_selection(int start, int length);

    void get_selection(int &start, int &length);

    void clear_selection();

    bool get_range_of_line(int line, int &start, int &end);
    
    void set_language(SyntaxHighlighterLanguage language);

    void show_markup(LineMarkup markup, int line);

    void remove_markup(LineMarkup markup, int line);

    void show_indicator(RangeIndicator indicator, int start, int length);

    RangeIndicator indicator_at(int position);

    void remove_indicator(RangeIndicator indicator, int start, int length);

    int line_count();

    int text_length();

    int position_from_line(int line_number);

    int line_from_position(int position);

    void set_font(const std::string &fontDescription); // e.g. "Trebuchet MS bold 9"
    
    void set_features(CodeEditorFeature features, bool flag);

    void toggle_features(CodeEditorFeature features);

    void reset_dirty();
    bool is_dirty();

    int get_caret_pos();
    void set_caret_pos(int position);
    
    void get_line_column_pos(int position, int &line, int &column);

    bool can_undo();
    void undo();
    bool can_redo();
    void redo();
    bool can_cut();
    void cut();
    bool can_copy();
    void copy();
    bool can_paste();
    void paste();
    bool can_delete();
    void do_delete();
    void select_all();

    void set_status_text(const std::string& text);
    
    // ----- Find and replace
    void show_find_panel(bool replace);
    void hide_find_panel();
    FindPanel* get_find_panel() { return _find_panel; };

    void set_show_find_panel_callback(boost::function<void (CodeEditor*, bool)> callback);

    bool find_and_highlight_text(const std::string& search_text, FindFlags flags,
      bool scroll_to, bool backwards);

    int find_and_replace_text(const std::string& search_text, const std::string& new_text, 
      FindFlags flags, bool do_all);

    void jump_to_next_placeholder();
    
    //----- Auto completion -----

    void auto_completion_show(int chars_entered, const std::vector<std::pair<int, std::string> >& entries);
    void auto_completion_show(int chars_entered, const std::vector<std::string>& entries);

    void auto_completion_cancel();

    void auto_completion_options(bool ignore_case, bool choose_single, bool auto_hide,
      bool drop_rest_of_word, bool cancel_at_start);

    void auto_completion_max_size(int width, int height);

    void auto_completion_register_images(const std::vector<std::pair<int, std::string> >& images);

    bool auto_completion_active();

    void auto_completion_stops(const std::string& stops);

    void auto_completion_fillups(const std::string& fillups);

    void show_calltip(bool show, int position, const std::string& value);

    void set_eol_mode(mforms::EndOfLineMode mode, bool convert = false);

    void set_context_menu(Menu *menu) { _context_menu = menu; };
    
    Menu *get_context_menu() { return _context_menu; }
    
    void *get_host() { return _host; }

    sptr_t send_editor(unsigned int message, uptr_t wParam, sptr_t lParam);
    
#ifndef SWIG

    boost::signals2::signal<void (int, int, int, bool)>* signal_changed() { return &_change_event; }

    boost::signals2::signal<void (int, int, mforms::ModifierKey)>* signal_gutter_clicked() { return &_gutter_clicked_event; }

    boost::signals2::signal<void (AutoCompletionEventType, int, const std::string&)>* signal_auto_completion() { return &_auto_completion_event; };

    boost::signals2::signal<void (bool, int, int, int)>* signal_dwell() { return &_dwell_event; }

    boost::signals2::signal<void (int)>* signal_char_added() { return &_char_added_event; }

    boost::signals2::signal<void ()>* signal_lost_focus() { return &_signal_lost_focus; }
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    void on_notify(Scintilla::SCNotification* notification);

    void on_command(int command);
    void lost_focus();

    virtual void resize();

#endif
#endif
  protected:
    CodeEditorImplPtrs* _code_editor_impl;
    Menu *_context_menu;
    FindPanel* _find_panel;
    std::map<int, void*> _images; // Registered RGBA images.
    void *_host;
    bool _scroll_on_resize;

    void setup_marker(int marker, const std::string& name);
    void load_configuration(SyntaxHighlighterLanguage language);

    boost::signals2::signal<void (int, int, int, bool)> _change_event;
    boost::signals2::signal<void (int, int, mforms::ModifierKey)> _gutter_clicked_event;
    boost::signals2::signal<void (AutoCompletionEventType, int, const std::string&)> _auto_completion_event;
    boost::signals2::signal<void (bool, int, int, int)> _dwell_event;
    boost::signals2::signal<void (int)> _char_added_event;
    boost::signals2::signal<void ()> _signal_lost_focus;

    boost::function<void (CodeEditor*, bool)> _show_find_panel;
  };
};

#endif // _CODE_EDITOR_H_