Console.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.8.5
// ----------------------------------------------------------------------------
// pcl/Console.h - Released 2024-12-28T16:53:48Z
// ----------------------------------------------------------------------------
// 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_Console_h
#define __PCL_Console_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/StringList.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS View;
 
class PCL_CLASS Console
{
public:
 
   Console();
 
   Console( const Console& ) = delete;
 
   Console( Console&& x )
      : m_handle( x.m_handle )
      , m_thread( x.m_thread )
   {
      x.m_handle = x.m_thread = nullptr;
   }
 
   Console& operator =( const Console& ) = delete;
 
   Console& operator =( Console&& x )
   {
      if ( &x != this )
      {
         m_handle = x.m_handle;
         m_thread = x.m_thread;
         x.m_handle = x.m_thread = nullptr;
      }
      return *this;
   }
 
   virtual ~Console();
 
   void Write( const String& s );
 
   void WriteLn( const String& s );
 
   void WriteLn();
 
   void Note( const String& s )
   {
      Write( "\x1b[32m" + s + "\x1b[39m" );
   }
 
   void NoteLn( const String& s )
   {
      WriteLn( "\x1b[32m" + s + "\x1b[39m" );
   }
 
   void Warning( const String& s )
   {
      Write( "\x1b[35m" + s + "\x1b[39m" );
   }
 
   void WarningLn( const String& s )
   {
      WriteLn( "\x1b[35m" + s + "\x1b[39m" );
   }
 
   void Critical( const String& s )
   {
      Write( "\x1b[31m" + s + "\x1b[39m" );
   }
 
   void CriticalLn( const String& s )
   {
      WriteLn( "\x1b[31m" + s + "\x1b[39m" );
   }
 
   int ReadChar();
 
   String ReadString();
 
   bool Suspended() const;
 
   bool Waiting() const;
 
   bool AbortEnabled() const;
 
   bool AbortRequested() const;
 
   void ResetStatus();
 
   void EnableAbort();
 
   void DisableAbort();
 
   void Abort();
 
   bool IsValid() const;
 
   bool IsCurrentThreadConsole() const;
 
   void Flush();
 
   bool Show( bool show = true );
 
   bool Hide( bool hide = true )
   {
      return Show( !hide );
   }
 
   void Clear();
 
   void ExecuteCommand( const String& command );
 
   void ExecuteScript( const String& filePath, const StringKeyValueList& arguments = StringKeyValueList() );
 
   void ExecuteScriptGlobal( const String& filePath, const StringKeyValueList& arguments = StringKeyValueList() );
 
   void ExecuteScriptOn( const View& view, const String& filePath, const StringKeyValueList& arguments = StringKeyValueList() );
 
protected:
 
   void* m_handle = nullptr;
 
private:
 
   void* m_thread = nullptr;
};
 
// ----------------------------------------------------------------------------
 
template <typename T>
inline Console& operator <<( Console& o, T t )
{
   o.Write( String( t ) );
   return o;
}
 
inline Console& operator <<( Console& o, const char* s )
{
   o.Write( s );
   return o;
}
 
inline Console& operator <<( Console& o, const String& s )
{
   o.Write( s );
   return o;
}
 
inline Console& operator >>( Console& o, char& c )
{
   c = o.ReadChar();
   return o;
}
 
inline Console& operator >>( Console& o, String& s )
{
   s = o.ReadString();
   return o;
}
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_Console_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Console.h - Released 2024-12-28T16:53:48Z