CodeEditor.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/CodeEditor.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_CodeEditor_h
#define __PCL_CodeEditor_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Flags.h>
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/AutoPointer.h>
#include <pcl/Control.h>
 
#endif   // !__PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace FindMode
{
   enum mask_type
   {
      RegExp         = 0x00000001,  // Search with a regular expression
      Backward       = 0x00000010,  // Search toward the beginning of text
      CaseSensitive  = 0x00000020,  // Case-sensitive search
      WholeWords     = 0x00000040,  // Search for whole words
      SelectionOnly  = 0x00000100,  // Replace within the current selection
      Incremental    = 0x00000200,  // Perform an incremental find operation
      Default        = CaseSensitive|WholeWords
   };
}
 
using FindModes = Flags<FindMode::mask_type>  ;
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS CodeEditor : public Control
{
public:
 
   CodeEditor( Control& parent = Control::Null() );
 
   ~CodeEditor() override
   {
   }
 
   Control& LineNumbersControl();
 
   String FilePath() const;
 
   void SetFilePath( const String& path );
 
   String Text() const;
 
   void SetText( const String& text );
 
   IsoString EncodedText( const IsoString& encoding = "UTF-8" ) const;
 
   IsoString TextUTF8() const
   {
      return EncodedText( "UTF-8" );
   }
 
   IsoString TextISO88591() const
   {
      return EncodedText( "ISO-8859-1" );
   }
 
   void SetEncodedText( const IsoString& text, const IsoString& encoding = "UTF-8" );
 
   void SetTextUTF8( const IsoString& text )
   {
      SetEncodedText( text, "UTF-8" );
   }
 
   void SetTextISO88591( const IsoString& text )
   {
      SetEncodedText( text, "ISO-8859-1" );
   }
 
   void ClearText();
 
   bool IsReadOnly() const;
 
   void SetReadOnly( bool readOnly = true );
 
   bool Save( const String& filePath, const IsoString& encoding = "UTF-8" );
 
   bool SaveUTF8( const String& filePath )
   {
      return Save( filePath, "UTF-8" );
   }
 
   bool SaveISO88591( const String& filePath )
   {
      return Save( filePath, "ISO-8859-1" );
   }
 
   bool Load( const String& filePath, const IsoString& encoding = "UTF-8" );
 
   bool LoadUTF8( const String& filePath )
   {
      return Load( filePath, "UTF-8" );
   }
 
   bool LoadISO88591( const String& filePath )
   {
      return Load( filePath, "ISO-8859-1" );
   }
 
   int NumberOfLines() const;
 
   int NumberOfCharacters() const;
 
   Point CursorPosition() const;
 
   int CursorLine() const
   {
      return CursorPosition().y;
   }
 
   int CursorColumn() const
   {
      return CursorPosition().x;
   }
 
   void SetCursorPosition( int line, int column );
 
   void SetCursorPosition( const Point& pos )
   {
      SetCursorPosition( pos.y, pos.x );
   }
 
   bool IsInsertMode() const;
 
   void SetInsertMode( bool insert = true );
 
   void SetReplaceMode( bool replace = true )
   {
      SetInsertMode( !replace );
   }
 
   bool IsBlockSelectionMode() const;
 
   void SetBlockSelectionMode( bool blockMode = true );
 
   void SetLineSelectionMode( bool lineMode = true )
   {
      SetBlockSelectionMode( !lineMode );
   }
 
   bool IsDynamicWordWrapMode() const;
 
   void SetDynamicWordWrapMode( bool wrapMode = true );
 
   int UndoSteps() const;
 
   int RedoSteps() const;
 
   bool HasSelection() const;
 
   Rect Selection() const;
 
   void SetSelection( int fromLine, int fromCol, int toLine, int toCol );
 
   void SetSelection( const Rect& r )
   {
      SetSelection( r.y0, r.x0, r.y1, r.x1 );
   }
 
   String SelectedText() const;
 
   void InsertText( const String& text );
 
   void Undo();
 
   void Redo();
 
   void Cut();
 
   void Copy();
 
   void Paste();
 
   void Delete();
 
   void SelectAll();
 
   void Unselect();
 
   bool GotoMatchedParenthesis();
 
   int HighlightAllMatches( const String& toFind, FindModes mode );
 
   void ClearMatches();
 
   bool Find( const String& toFind, FindModes mode );
 
   bool ReplaceSelection( const String& replaceWith );
 
   int ReplaceAll( const String& toFind, const String& replaceWith, FindModes mode );
 
   using editor_event_handler = void (Control::*)( CodeEditor& sender );
 
   using cursor_event_handler = void (Control::*)( CodeEditor& sender, int line, int col );
 
   using selection_event_handler = void (Control::*)( CodeEditor& sender, int fromLine, int fromCol, int toLine, int toCol );
 
   using state_event_handler = void (Control::*)( CodeEditor& sender, bool state );
 
   void OnTextUpdated( editor_event_handler handler, Control& receiver );
 
   void OnCursorPositionUpdated( cursor_event_handler handler, Control& receiver );
 
   void OnSelectionUpdated( selection_event_handler handler, Control& receiver );
 
   void OnOverwriteModeUpdated( state_event_handler handler, Control& receiver );
 
   void OnSelectionModeUpdated( state_event_handler handler, Control& receiver );
 
   void OnDynamicWordWrapModeUpdated( state_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      editor_event_handler    onTextUpdated                = nullptr;
      cursor_event_handler    onCursorPositionUpdated      = nullptr;
      selection_event_handler onSelectionUpdated           = nullptr;
      state_event_handler     onOverwriteModeUpdated       = nullptr;
      state_event_handler     onSelectionModeUpdated       = nullptr;
      state_event_handler     onDynamicWordWrapModeUpdated = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
   Control                    m_lineNumbers;
 
   friend class CodeEditorEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_CodeEditor_h
 
// ----------------------------------------------------------------------------
// EOF pcl/CodeEditor.h - Released 2024-01-13T15:47:58Z