kicad/include/eda_units.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2022 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
 */


#ifndef EDA_UNITS_H
#define EDA_UNITS_H

#include <kicommon.h>
#include <wx/string.h>
#include <geometry/eda_angle.h>
#include <base_units.h>

/**
 * The type of unit.
 */
enum class EDA_DATA_TYPE
{
    DISTANCE = 0,
    AREA     = 1,
    VOLUME   = 2
};

enum class EDA_UNITS
{
    INCHES      = 0,
    MILLIMETRES = 1,
    UNSCALED    = 2,
    DEGREES     = 3,
    PERCENT     = 4,
    MILS        = 5,
};

namespace EDA_UNIT_UTILS
{
    KICOMMON_API bool IsImperialUnit( EDA_UNITS aUnit );

    KICOMMON_API bool IsMetricUnit( EDA_UNITS aUnit );

    /**
     *  Convert mm to mils.
     */
    KICOMMON_API int Mm2mils( double aVal );

    /**
     *  Convert mils to mm.
     */
    KICOMMON_API int Mils2mm( double aVal );

    /**
     * Writes any unit info found in the string to aUnits.
     * @return true - when unit was found, false - when unit could not be determined
     */
    KICOMMON_API bool FetchUnitsFromString( const wxString& aTextValue, EDA_UNITS& aUnits );

    /**
     * Get the units string for a given units type.
     *
     * This version is for appending to a value string.
     *
     * @param aUnits The units requested.
     * @param aType DISTANCE, AREA, or VOLUME
     * @return The human readable units string with appropriate separators.
     */
    KICOMMON_API wxString GetText( EDA_UNITS aUnits, EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

    /**
     * Get the units string for a given units type.
     *
     * This version is for setting a wxStaticText label.
     *
     * @param aUnits The units requested.
     * @param aType DISTANCE, AREA, or VOLUME
     * @return The human readable units string.
     */
    KICOMMON_API wxString GetLabel( EDA_UNITS     aUnits,
                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

    /**
     * Converts \a aAngle from board units to a string appropriate for writing to file.
     *
     * This should only be used for writing to files  as it ignores locale
     *
     * @note Internal angles for board items can be either degrees or tenths of degree
     *       on how KiCad is built.
     * @param aAngle A angle value to convert.
     * @return std::string object containing the converted angle.
     */
    KICOMMON_API std::string FormatAngle( const EDA_ANGLE& aAngle );

    /**
     * Converts \a aValue from internal units to a string appropriate for writing to file.
     *
     * This should only be used for writing to files as it ignores locale
     *
     * @note Internal units for board items can be either deci-mils or nanometers depending
     *       on how KiCad is built.
     *
     * @param aValue A coordinate value to convert.
     * @return A std::string object containing the converted value.
     */
    KICOMMON_API std::string FormatInternalUnits( const EDA_IU_SCALE& aIuScale, int aValue );
    KICOMMON_API std::string FormatInternalUnits( const EDA_IU_SCALE& aIuScale,
                                                  const VECTOR2I&     aPoint );

    constexpr inline int Mils2IU( const EDA_IU_SCALE& aIuScale, int mils )
    {
        double x = mils * aIuScale.IU_PER_MILS;
        return int( x < 0 ? x - 0.5 : x + 0.5 );
    }

    namespace UI
    {
        /**
         * Function To_User_Unit
         * convert \a aValue in internal units to the appropriate user units defined by \a aUnit.
         *
         * @return The converted value, in double
         * @param aUnit The units to convert \a aValue to.
         * @param aValue The value in internal units to convert.
         */
        KICOMMON_API double ToUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnit,
                                        double aValue );

        /**
         * Returns the string from \a aValue according to \a aUnits (inch, mm ...) for display.
         *
         * For readability, if the mantissa has 3 or more digits then any trailing 0's are removed.
         * 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 to preserve precision.
         *
         * @param aUnits Units (INCHES, MILLIMETRE ..)
         * @param aValue Value in internal units
         * @param aAddUnitsText Add units text with appropriate separators
         * @param aType DISTANCE, AREA, or VOLUME
         * @return A wxString object containing value and optionally the symbol unit (like 2.000 mm)
         */
        KICOMMON_API wxString StringFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                               double aValue,
                                               bool aAddUnitsText = false,
                                               EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        /**
         * A helper to convert the \a double length \a aValue to a string in inches, millimeters,
         * or unscaled units.
         *
         * Should be used only to display a coordinate in status, but not in dialogs, files, etc.,
         * because the mantissa of the number displayed has 4 digits max for readability.  The
         * actual internal value could need up to 8 digits to preserve precision.
         *
         * @param aUnits Units (INCHES, MILLIMETRE ..)
         * @param aValue The double value to convert.
         * @param aAddUnitsText If true, adds the unit label to the end of the string
         * @param aType DISTANCE, AREA, or VOLUME
         * @return The converted string for display in user interface elements.
         */
        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    double aValue, bool aAddUnitsText = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    int aValue, bool aAddUnitLabel = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API wxString MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    long long int aValue, bool aAddUnitLabel = true,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API wxString MessageTextFromValue( EDA_ANGLE aValue, bool aAddUnitLabel = true );


        /**
         * Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg"
         */
        KICOMMON_API double FromUserUnit( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnit, double aValue );


        /**
         * Function DoubleValueFromString
         * converts \a aTextValue to a double
         * @warning This utilizes the current locale and will break if decimal formats differ
         *
         * @param aIuScale The internal units scale for the current frame/app.
         * @param aUnits The units of \a aTextValue.
         * @param aTextValue A reference to a wxString object containing the string to convert.
         * @return A double representing that value in internal units
         */
        KICOMMON_API double DoubleValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                   const wxString& aTextValue,
                                                   EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API double DoubleValueFromString( const wxString& aTextValue );

        /**
         * Function ValueFromString
         * converts \a aTextValue in \a aUnits to internal units used by the application.
         * @warning This utilizes the current locale and will break if decimal formats differ
         *
         * @param aIuScale The internal units scale for the current frame/app.
         * @param aUnits The units of \a aTextValue.
         * @param aTextValue A reference to a wxString object containing the string to convert.
         * @return A long long int representing that value in internal units
         */
        KICOMMON_API long long int ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
                                                    const wxString& aTextValue,
                                                    EDA_DATA_TYPE aType = EDA_DATA_TYPE::DISTANCE );

        KICOMMON_API long long int ValueFromString( const wxString& aTextValue );
    }
}

#endif