614 lines
17 KiB
C++
614 lines
17 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* 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; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* 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, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#include <eda_units.h>
|
|
#include <fmt/core.h>
|
|
#include <math/util.h> // for KiROUND
|
|
#include <macros.h>
|
|
#include <charconv>
|
|
#include <wx/translation.h>
|
|
|
|
bool EDA_UNIT_UTILS::IsImperialUnit( EDA_UNITS aUnit )
|
|
{
|
|
switch( aUnit )
|
|
{
|
|
case EDA_UNITS::INCHES:
|
|
case EDA_UNITS::MILS:
|
|
return true;
|
|
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
bool EDA_UNIT_UTILS::IsMetricUnit( EDA_UNITS aUnit )
|
|
{
|
|
switch( aUnit )
|
|
{
|
|
case EDA_UNITS::MILLIMETRES:
|
|
return true;
|
|
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
int EDA_UNIT_UTILS::Mm2mils( double aVal )
|
|
{
|
|
return KiROUND( aVal * 1000. / 25.4 );
|
|
}
|
|
|
|
|
|
int EDA_UNIT_UTILS::Mils2mm( double aVal )
|
|
{
|
|
return KiROUND( aVal * 25.4 / 1000. );
|
|
}
|
|
|
|
|
|
bool EDA_UNIT_UTILS::FetchUnitsFromString( const wxString& aTextValue, EDA_UNITS& aUnits )
|
|
{
|
|
wxString buf( aTextValue.Strip( wxString::both ) );
|
|
unsigned brk_point = 0;
|
|
|
|
while( brk_point < buf.Len() )
|
|
{
|
|
wxChar c = buf[brk_point];
|
|
|
|
if( !( ( c >= '0' && c <= '9' ) || ( c == '.' ) || ( c == ',' ) || ( c == '-' )
|
|
|| ( c == '+' ) ) )
|
|
break;
|
|
|
|
++brk_point;
|
|
}
|
|
|
|
// Check the unit designator (2 ch significant)
|
|
wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );
|
|
|
|
if( unit == wxT( "mm" ) )
|
|
aUnits = EDA_UNITS::MILLIMETRES;
|
|
else if( unit == wxT( "mi" ) || unit == wxT( "th" ) ) // "mils" or "thou"
|
|
aUnits = EDA_UNITS::MILS;
|
|
else if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
|
|
aUnits = EDA_UNITS::INCHES;
|
|
else if( unit == wxT( "de" ) || unit == wxT( "ra" ) ) // "deg" or "rad"
|
|
aUnits = EDA_UNITS::DEGREES;
|
|
else
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
|
|
wxString EDA_UNIT_UTILS::GetText( EDA_UNITS aUnits, EDA_DATA_TYPE aType )
|
|
{
|
|
wxString label;
|
|
|
|
switch( aUnits )
|
|
{
|
|
case EDA_UNITS::MILLIMETRES: label = wxT( " mm" ); break;
|
|
case EDA_UNITS::DEGREES: label = wxT( "°" ); break;
|
|
case EDA_UNITS::MILS: label = wxT( " mils" ); break;
|
|
case EDA_UNITS::INCHES: label = wxT( " in" ); break;
|
|
case EDA_UNITS::PERCENT: label = wxT( "%" ); break;
|
|
case EDA_UNITS::UNSCALED: break;
|
|
default: UNIMPLEMENTED_FOR( wxS( "Unknown units" ) ); break;
|
|
}
|
|
|
|
switch( aType )
|
|
{
|
|
case EDA_DATA_TYPE::VOLUME: label += wxT( "³" ); break;
|
|
case EDA_DATA_TYPE::AREA: label += wxT( "²" ); break;
|
|
case EDA_DATA_TYPE::DISTANCE: break;
|
|
default: UNIMPLEMENTED_FOR( wxS( "Unknown measurement" ) ); break;
|
|
}
|
|
|
|
return label;
|
|
}
|
|
|
|
|
|
wxString EDA_UNIT_UTILS::GetLabel( EDA_UNITS aUnits, EDA_DATA_TYPE aType )
|
|
{
|
|
return GetText( aUnits, aType ).Trim( false );
|
|
}
|
|
|
|
|
|
std::string EDA_UNIT_UTILS::FormatAngle( const EDA_ANGLE& aAngle )
|
|
{
|
|
std::string temp = fmt::format( "{:.10g}", aAngle.AsDegrees() );
|
|
|
|
return temp;
|
|
}
|
|
|
|
|
|
std::string EDA_UNIT_UTILS::FormatInternalUnits( const EDA_IU_SCALE& aIuScale, int aValue )
|
|
{
|
|
std::string buf;
|
|
double engUnits = aValue;
|
|
|
|
engUnits /= aIuScale.IU_PER_MM;
|
|
|
|
if( engUnits != 0.0 && fabs( engUnits ) <= 0.0001 )
|
|
{
|
|
buf = fmt::format( "{:.10f}", engUnits );
|
|
|
|
// remove trailing zeros
|
|
while( !buf.empty() && buf[buf.size() - 1] == '0' )
|
|
{
|
|
buf.pop_back();
|
|
}
|
|
|
|
// if the value was really small
|
|
// we may have just stripped all the zeros after the decimal
|
|
if( buf[buf.size() - 1] == '.' )
|
|
{
|
|
buf.pop_back();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
buf = fmt::format( "{:.10g}", engUnits );
|
|
}
|
|
|
|
return buf;
|
|
}
|
|
|
|
|
|
std::string EDA_UNIT_UTILS::FormatInternalUnits( const EDA_IU_SCALE& aIuScale,
|
|
const VECTOR2I& aPoint )
|
|
{
|
|
return FormatInternalUnits( aIuScale, aPoint.x ) + " "
|
|
+ FormatInternalUnits( aIuScale, aPoint.y );
|
|
}
|
|
|
|
|
|
#if 0 // No support for std::from_chars on MacOS yet
|
|
|
|
bool EDA_UNIT_UTILS::ParseInternalUnits( const std::string& aInput, const EDA_IU_SCALE& aIuScale,
|
|
int& aOut )
|
|
{
|
|
double value;
|
|
|
|
if( std::from_chars( aInput.data(), aInput.data() + aInput.size(), value ).ec != std::errc() )
|
|
return false;
|
|
|
|
aOut = value * aIuScale.IU_PER_MM;
|
|
return true;
|
|
}
|
|
|
|
|
|
bool EDA_UNIT_UTILS::ParseInternalUnits( const std::string& aInput, const EDA_IU_SCALE& aIuScale,
|
|
VECTOR2I& aOut )
|
|
{
|
|
size_t pos = aInput.find( ' ' );
|
|
|
|
if( pos == std::string::npos )
|
|
return false;
|
|
|
|
std::string first = aInput.substr( 0, pos );
|
|
std::string second = aInput.substr( pos + 1 );
|
|
|
|
VECTOR2I vec;
|
|
|
|
if( !ParseInternalUnits( first, aIuScale, vec.x ) )
|
|
return false;
|
|
|
|
if( !ParseInternalUnits( second, aIuScale, vec.y ) )
|
|
return false;
|
|
|
|
aOut = vec;
|
|
|
|
return true;
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
#define IU_TO_MM( x, scale ) ( x / scale.IU_PER_MM )
|
|
#define IU_TO_IN( x, scale ) ( x / scale.IU_PER_MILS / 1000 )
|
|
#define IU_TO_MILS( x, scale ) ( x / scale.IU_PER_MILS )
|
|
#define MM_TO_IU( x, scale ) ( x * scale.IU_PER_MM )
|
|
#define IN_TO_IU( x, scale ) ( x * scale.IU_PER_MILS * 1000 )
|
|
#define MILS_TO_IU( x, scale ) ( x * scale.IU_PER_MILS )
|
|
|
|
double EDA_UNIT_UTILS::UI::ToUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnit,
|
|
double aValue )
|
|
{
|
|
switch( aUnit )
|
|
{
|
|
case EDA_UNITS::MILLIMETRES:
|
|
return IU_TO_MM( aValue, aIuScale );
|
|
|
|
case EDA_UNITS::MILS:
|
|
return IU_TO_MILS( aValue, aIuScale );
|
|
|
|
case EDA_UNITS::INCHES:
|
|
return IU_TO_IN( aValue, aIuScale );
|
|
|
|
case EDA_UNITS::DEGREES:
|
|
return aValue;
|
|
|
|
default:
|
|
return aValue;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Convert a value to a string using double notation.
|
|
*
|
|
* For readability, the mantissa has 3 or more digits,
|
|
* the trailing 0 are removed if the mantissa has more than 3 digits
|
|
* and some trailing 0
|
|
* This function should be used to display values in dialogs because a value
|
|
* entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa
|
|
* if displayed in inch to avoid truncation or rounding made just by the printf function.
|
|
* otherwise the actual value is rounded when read from dialog and converted
|
|
* in internal units, and therefore modified.
|
|
*/
|
|
wxString EDA_UNIT_UTILS::UI::StringFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
double aValue, bool aAddUnitsText,
|
|
EDA_DATA_TYPE aType )
|
|
{
|
|
double value_to_print = aValue;
|
|
|
|
switch( aType )
|
|
{
|
|
case EDA_DATA_TYPE::VOLUME:
|
|
value_to_print = ToUserUnit( aIuScale, aUnits, value_to_print );
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::AREA:
|
|
value_to_print = ToUserUnit( aIuScale, aUnits, value_to_print );
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::DISTANCE:
|
|
value_to_print = ToUserUnit( aIuScale, aUnits, value_to_print );
|
|
}
|
|
|
|
char buf[50];
|
|
|
|
if( value_to_print != 0.0 && fabs( value_to_print ) <= 0.0001 )
|
|
{
|
|
int len = snprintf( buf, sizeof( buf ) - 1, "%.10f", value_to_print );
|
|
|
|
while( --len > 0 && buf[len] == '0' )
|
|
buf[len] = '\0';
|
|
|
|
if( len >= 0 && ( buf[len] == '.' || buf[len] == ',' ) )
|
|
buf[len] = '\0';
|
|
}
|
|
else
|
|
{
|
|
snprintf( buf, sizeof( buf ) - 1, "%.10g", value_to_print );
|
|
}
|
|
|
|
wxString stringValue( buf, wxConvUTF8 );
|
|
|
|
if( aAddUnitsText )
|
|
stringValue += EDA_UNIT_UTILS::GetText( aUnits, aType );
|
|
|
|
return stringValue;
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Convert a value to a string using double notation.
|
|
*
|
|
* For readability, the mantissa has 0, 1, 3 or 4 digits, depending on units
|
|
* for unit = inch the mantissa has 3 digits (Eeschema) or 4 digits
|
|
* for unit = mil the mantissa has 0 digits (Eeschema) or 1 digits
|
|
* for unit = mm the mantissa has 3 digits (Eeschema) or 4 digits
|
|
* Should be used only to display info in status,
|
|
* but not in dialogs, because 4 digits only
|
|
* could truncate the actual value
|
|
*/
|
|
|
|
|
|
// A lower-precision (for readability) version of StringFromValue()
|
|
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
int aValue,
|
|
bool aAddUnitLabel,
|
|
EDA_DATA_TYPE aType )
|
|
{
|
|
return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType );
|
|
}
|
|
|
|
|
|
// A lower-precision (for readability) version of StringFromValue()
|
|
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
long long int aValue,
|
|
bool aAddUnitLabel,
|
|
EDA_DATA_TYPE aType )
|
|
{
|
|
return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType );
|
|
}
|
|
|
|
|
|
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( EDA_ANGLE aValue, bool aAddUnitLabel )
|
|
{
|
|
if( aAddUnitLabel )
|
|
return wxString::Format( wxT( "%.1f°" ), aValue.AsDegrees() );
|
|
else
|
|
return wxString::Format( wxT( "%.1f" ), aValue.AsDegrees() );
|
|
}
|
|
|
|
|
|
// A lower-precision (for readability) version of StringFromValue()
|
|
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
double aValue, bool aAddUnitsText,
|
|
EDA_DATA_TYPE aType )
|
|
{
|
|
wxString text;
|
|
const wxChar* format;
|
|
double value = aValue;
|
|
|
|
switch( aType )
|
|
{
|
|
case EDA_DATA_TYPE::VOLUME:
|
|
value = ToUserUnit( aIuScale, aUnits, value );
|
|
// Fall through to continue computation
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::AREA:
|
|
value = ToUserUnit( aIuScale, aUnits, value );
|
|
// Fall through to continue computation
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::DISTANCE:
|
|
value = ToUserUnit( aIuScale, aUnits, value );
|
|
}
|
|
|
|
switch( aUnits )
|
|
{
|
|
default:
|
|
case EDA_UNITS::MILLIMETRES:
|
|
#if defined( EESCHEMA )
|
|
format = wxT( "%.2f" );
|
|
#else
|
|
format = wxT( "%.4f" );
|
|
#endif
|
|
break;
|
|
|
|
case EDA_UNITS::MILS:
|
|
#if defined( EESCHEMA )
|
|
format = wxT( "%.0f" );
|
|
#else
|
|
format = wxT( "%.2f" );
|
|
#endif
|
|
break;
|
|
|
|
case EDA_UNITS::INCHES:
|
|
#if defined( EESCHEMA )
|
|
format = wxT( "%.3f" );
|
|
#else
|
|
format = wxT( "%.4f" );
|
|
#endif
|
|
break;
|
|
|
|
case EDA_UNITS::DEGREES:
|
|
// 3 digits in mantissa should be good for rotation in degree
|
|
format = wxT( "%.3f" );
|
|
break;
|
|
|
|
case EDA_UNITS::UNSCALED:
|
|
format = wxT( "%.0f" );
|
|
break;
|
|
}
|
|
|
|
text.Printf( format, value );
|
|
|
|
if( aAddUnitsText )
|
|
text += EDA_UNIT_UTILS::GetText( aUnits, aType );
|
|
|
|
return text;
|
|
}
|
|
|
|
|
|
wxString EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax( const EDA_IU_SCALE& aIuScale,
|
|
EDA_UNITS aUnits,
|
|
const MINOPTMAX<int>& aValue )
|
|
{
|
|
wxString msg;
|
|
|
|
if( aValue.HasMin() && aValue.Min() > 0 )
|
|
{
|
|
msg += _( "min" ) + wxS( " " ) + MessageTextFromValue( aIuScale, aUnits, aValue.Min() );
|
|
}
|
|
|
|
if( aValue.HasOpt() )
|
|
{
|
|
if( !msg.IsEmpty() )
|
|
msg += wxS( "; " );
|
|
|
|
msg += _( "opt" ) + wxS( " " ) + MessageTextFromValue( aIuScale, aUnits, aValue.Opt() );
|
|
}
|
|
|
|
if( aValue.HasMax() )
|
|
{
|
|
if( !msg.IsEmpty() )
|
|
msg += wxS( "; " );
|
|
|
|
msg += _( "max" ) + wxS( " " ) + MessageTextFromValue( aIuScale, aUnits, aValue.Max() );
|
|
}
|
|
|
|
return msg;
|
|
};
|
|
|
|
|
|
double EDA_UNIT_UTILS::UI::FromUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
double aValue )
|
|
{
|
|
switch( aUnits )
|
|
{
|
|
case EDA_UNITS::MILLIMETRES:
|
|
return MM_TO_IU( aValue, aIuScale );
|
|
|
|
case EDA_UNITS::MILS:
|
|
return MILS_TO_IU( aValue, aIuScale );
|
|
|
|
case EDA_UNITS::INCHES:
|
|
return IN_TO_IU( aValue, aIuScale );
|
|
|
|
default:
|
|
case EDA_UNITS::DEGREES:
|
|
case EDA_UNITS::UNSCALED:
|
|
case EDA_UNITS::PERCENT:
|
|
return aValue;
|
|
}
|
|
}
|
|
|
|
|
|
double EDA_UNIT_UTILS::UI::DoubleValueFromString( const wxString& aTextValue )
|
|
{
|
|
double dtmp = 0;
|
|
|
|
// Acquire the 'right' decimal point separator
|
|
const struct lconv* lc = localeconv();
|
|
|
|
wxChar decimal_point = lc->decimal_point[0];
|
|
wxString buf( aTextValue.Strip( wxString::both ) );
|
|
|
|
// Convert any entered decimal point separators to the 'right' one
|
|
buf.Replace( wxT( "." ), wxString( decimal_point, 1 ) );
|
|
buf.Replace( wxT( "," ), wxString( decimal_point, 1 ) );
|
|
|
|
// Find the end of the numeric part
|
|
unsigned brk_point = 0;
|
|
|
|
while( brk_point < buf.Len() )
|
|
{
|
|
wxChar ch = buf[brk_point];
|
|
|
|
if( !( ( ch >= '0' && ch <= '9' ) || ( ch == decimal_point ) || ( ch == '-' )
|
|
|| ( ch == '+' ) ) )
|
|
{
|
|
break;
|
|
}
|
|
|
|
++brk_point;
|
|
}
|
|
|
|
// Extract the numeric part
|
|
buf.Left( brk_point ).ToDouble( &dtmp );
|
|
|
|
return dtmp;
|
|
}
|
|
|
|
|
|
double EDA_UNIT_UTILS::UI::DoubleValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
const wxString& aTextValue, EDA_DATA_TYPE aType )
|
|
{
|
|
double dtmp = 0;
|
|
|
|
// Acquire the 'right' decimal point separator
|
|
const struct lconv* lc = localeconv();
|
|
|
|
wxChar decimal_point = lc->decimal_point[0];
|
|
wxString buf( aTextValue.Strip( wxString::both ) );
|
|
|
|
// Convert any entered decimal point separators to the 'right' one
|
|
buf.Replace( wxT( "." ), wxString( decimal_point, 1 ) );
|
|
buf.Replace( wxT( "," ), wxString( decimal_point, 1 ) );
|
|
|
|
// Find the end of the numeric part
|
|
unsigned brk_point = 0;
|
|
|
|
while( brk_point < buf.Len() )
|
|
{
|
|
wxChar ch = buf[brk_point];
|
|
|
|
if( !( (ch >= '0' && ch <= '9') || (ch == decimal_point) || (ch == '-') || (ch == '+') ) )
|
|
break;
|
|
|
|
++brk_point;
|
|
}
|
|
|
|
// Extract the numeric part
|
|
buf.Left( brk_point ).ToDouble( &dtmp );
|
|
|
|
// Check the optional unit designator (2 ch significant)
|
|
wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );
|
|
|
|
if( aUnits == EDA_UNITS::MILLIMETRES
|
|
|| aUnits == EDA_UNITS::MILS
|
|
|| aUnits == EDA_UNITS::INCHES )
|
|
{
|
|
if( unit == wxT( "mm" ) )
|
|
{
|
|
aUnits = EDA_UNITS::MILLIMETRES;
|
|
}
|
|
else if( unit == wxT( "mi" ) || unit == wxT( "th" ) )
|
|
{
|
|
aUnits = EDA_UNITS::MILS;
|
|
}
|
|
else if( unit == wxT( "in" ) || unit == wxT( "\"" ) )
|
|
{
|
|
aUnits = EDA_UNITS::INCHES;
|
|
}
|
|
else if( unit == wxT( "oz" ) ) // 1 oz = 1.37 mils
|
|
{
|
|
aUnits = EDA_UNITS::MILS;
|
|
dtmp *= 1.37;
|
|
}
|
|
}
|
|
else if( aUnits == EDA_UNITS::DEGREES )
|
|
{
|
|
if( unit == wxT( "ra" ) ) // Radians
|
|
dtmp *= 180.0f / M_PI;
|
|
}
|
|
|
|
switch( aType )
|
|
{
|
|
case EDA_DATA_TYPE::VOLUME:
|
|
dtmp = FromUserUnit( aIuScale, aUnits, dtmp );
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::AREA:
|
|
dtmp = FromUserUnit( aIuScale, aUnits, dtmp );
|
|
KI_FALLTHROUGH;
|
|
|
|
case EDA_DATA_TYPE::DISTANCE:
|
|
dtmp = FromUserUnit( aIuScale, aUnits, dtmp );
|
|
}
|
|
|
|
return dtmp;
|
|
}
|
|
|
|
|
|
long long int EDA_UNIT_UTILS::UI::ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
|
|
const wxString& aTextValue, EDA_DATA_TYPE aType )
|
|
{
|
|
double value = DoubleValueFromString( aIuScale, aUnits, aTextValue, aType );
|
|
|
|
return KiROUND<double, long long int>( value );
|
|
}
|
|
|
|
|
|
long long int EDA_UNIT_UTILS::UI::ValueFromString( const wxString& aTextValue )
|
|
{
|
|
double value = DoubleValueFromString( aTextValue );
|
|
|
|
return KiROUND<double, long long int>( value );
|
|
} |