UIScaling.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/UIScaling.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// 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_UIScaling_h
#define __PCL_UIScaling_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/GlobalSettings.h>
#include <pcl/Math.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
#define PCL_UIScaling_LUT_Length 7
 
extern PCL_DATA const double PCL_UIScalingFactor_LUT[ PCL_UIScaling_LUT_Length ];
extern PCL_DATA const char*  PCL_UIScalingSubdir_LUT[ PCL_UIScaling_LUT_Length ];
 
inline int UIResourceScalingIndex( double scalingFactor )
{
   if ( scalingFactor > 1 )
   {
      int index = Min( RoundInt( 2*scalingFactor ), PCL_UIScaling_LUT_Length+1 );
      if ( index > 2 )
         return index-2;
   }
   return 0;
}
 
inline double UIResourceScalingFactor( double scalingFactor )
{
   return PCL_UIScalingFactor_LUT[UIResourceScalingIndex( scalingFactor )];
}
 
inline double UIResourceScalingFactorForIndex( int index )
{
   return PCL_UIScalingFactor_LUT[Range( index, 0, PCL_UIScaling_LUT_Length-1 )];
}
 
inline int UIScaled( double scalingFactor, int size )
{
   return (scalingFactor <= 1) ? size : RoundInt( scalingFactor*size );
}
 
inline int UIUnscaled( double scalingFactor, int size )
{
   return (scalingFactor <= 1) ? size : RoundInt( size/scalingFactor );
}
 
template <class R>
inline String UIScaledResourceForIndex( int index, R resource )
{
   String path( resource );
   index = Range( index, 0, PCL_UIScaling_LUT_Length-1 );
   if ( index > 0 )
   {
      size_type p = path.FindLast( '/' );
      if ( p != String::notFound && p > 0 ) // assume resource starts with ":/"
         return path.Left( p+1 ) + PCL_UIScalingSubdir_LUT[index] + path.Substring( p );
   }
   return path;
}
 
template <class R>
inline String UIScaledResource( double scalingFactor, R resource )
{
   return UIScaledResourceForIndex( UIResourceScalingIndex( scalingFactor ), resource );
}
 
/*
 * Auxiliary structure used by UIScaledStyleSheet().
 */
struct PCL_UIStringSection
{
   size_type pos = 0;
   size_type len = 0;
 
   PCL_UIStringSection( size_type i, size_type j )
      : pos( i )
      , len( j - i )
   {
   }
 
   PCL_UIStringSection() = default;
   PCL_UIStringSection( const PCL_UIStringSection& ) = default;
};
 
template <class S>
String UIScaledStyleSheet( double displayScalingFactor, double resourceScalingFactor, S styleSheet, int fontDPI = 0 )
{
#define PCL_UI_IS_NUMBER_DIGIT( c ) (CharTraits::IsDigit( c ) || CharTraits::IsDecimalSeparator( c ))
 
   String cssCode( styleSheet );
 
   /*
    * Scale resource file paths.
    */
   if ( resourceScalingFactor > 0 )
   {
      Array<PCL_UIStringSection> urlSections;
      for ( size_type p = 0; ; )
      {
         p = cssCode.Find( ":/", p );
         if ( p == String::notFound )
            break;
         size_type q = cssCode.Find( ')', p+2 );
         if ( q != String::notFound )
         {
            urlSections.Add( PCL_UIStringSection( p, q ) );
            p = q+1;
         }
         else
            p += 2;
      }
      if ( !urlSections.IsEmpty() )
      {
         int index = UIResourceScalingIndex( resourceScalingFactor );
         for ( const PCL_UIStringSection& s : ReverseIterable( urlSections ) )
            cssCode.Replace( s.pos, s.len, String( UIScaledResourceForIndex( index, cssCode.Substring( s.pos, s.len ) ) ) );
      }
   }
 
   /*
    * Scale pixel dimensions and convert points to scaled pixels.
    */
   if ( displayScalingFactor > 0 )
   {
      Array<PCL_UIStringSection> pxSections;
      for ( size_type q = 0; ; q += 2 )
      {
         q = cssCode.Find( "px", q );
         if ( q == String::notFound )
            break;
         size_type p = q;
         while ( p > 0 && PCL_UI_IS_NUMBER_DIGIT( cssCode[p-1] ) )
            --p;
         if ( p < q )
            pxSections.Add( PCL_UIStringSection( p, q ) );
      }
      for ( const PCL_UIStringSection& s : ReverseIterable( pxSections ) )
      {
         double px;
         if ( cssCode.Substring( s.pos, s.len ).TryToDouble( px ) )
            cssCode.Replace( s.pos, s.len, String().Format( "%d", RoundInt( px * displayScalingFactor ) ) );
      }
 
      /*
       * If fontDPI=0 (the default value), use core font resolution settings for
       * point-to-pixel conversions.
       */
      if ( fontDPI == 0 )
         fontDPI = PixInsightSettings::GlobalInteger( "Application/FontResolution" );
 
      /*
       * If a valid font resolution is available, convert points to scaled pixels.
       */
      if ( fontDPI > 0 )
      {
         Array<PCL_UIStringSection> ptSections;
         for ( size_type q = 0; ; q += 2 )
         {
            q = cssCode.Find( "pt", q );
            if ( q == String::notFound )
               break;
            size_type p = q;
            while ( p > 0 && PCL_UI_IS_NUMBER_DIGIT( cssCode[p-1] ) )
               --p;
            if ( p < q )
               ptSections.Add( PCL_UIStringSection( p, q ) );
         }
         for ( const PCL_UIStringSection& s : ReverseIterable( ptSections ) )
         {
            double pt;
            if ( cssCode.Substring( s.pos, s.len ).TryToDouble( pt ) )
               cssCode.Replace( s.pos, s.len+2, String().Format( "%dpx", RoundInt( displayScalingFactor*pt*fontDPI/72 ) ) );
         }
      }
   }
 
   return cssCode;
 
#undef PCL_UI_IS_NUMBER_DIGIT
}
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_UIScaling_h
 
// ----------------------------------------------------------------------------
// EOF pcl/UIScaling.h - Released 2024-05-07T15:27:32Z