altium_parser_utils.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Thomas Pointhuber <[email protected]>
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "altium_parser_utils.h"
 
#include <string_utils.h>
#include <lib_id.h>
#include <trigo.h>
#include <math/util.h>
#include <wx/arrstr.h>
 
LIB_ID AltiumToKiCadLibID( const wxString& aLibName, const wxString& aLibReference )
{
    wxString libName = LIB_ID::FixIllegalChars( aLibName, true );
    wxString libReference = EscapeString( aLibReference, CTX_LIBID );
 
    wxString key = !libName.empty() ? ( libName + ":" + libReference ) : libReference;
 
    LIB_ID libId;
    libId.Parse( key, true );
 
    return libId;
}
 
 
wxString AltiumPropertyToKiCadString( const wxString& aString )
{
    wxString  output;
    wxString  tempString;
    bool      hasPrev = false;
    wxUniChar prev;
 
    for( wxString::const_iterator it = aString.begin(); it != aString.end(); ++it )
    {
        char ch = 0;
 
        if( (*it).GetAsChar( &ch ) )
        {
            if( ch == '\\' )
            {
                if( hasPrev )
                {
                    tempString += prev;
                    hasPrev = false;
                }
 
                continue; // Backslash is ignored and not added to the output
            }
        }
 
        if( hasPrev ) // Two letters in a row with no backslash
        {
            if( !tempString.empty() )
            {
                output += "~{" + tempString + "}";
                tempString.Clear();
            }
 
            output += prev;
        }
 
        prev = *it;
        hasPrev = true;
    }
 
    // Append any leftover escaped string
    if( !tempString.IsEmpty() )
        output += "~{" + tempString + "}";
 
    if( hasPrev )
        output += prev;
 
    return output;
}
 
 
wxString AltiumEscapeTextVars( const wxString& aText )
{
    wxString result;
    int      depth = 0;
 
    for( size_t i = 0; i < aText.length(); i++ )
    {
        wxUniChar ch = aText[i];
 
        // KiCad copies an escaped reference through its closing brace, so only the outermost one is escaped
        if( depth == 0 && ( ch == '$' || ch == '@' ) && i + 1 < aText.length() && aText[i + 1] == '{' )
        {
            result += '\\';
            result += ch;
            result += '{';
            depth = 1;
            i++;
            continue;
        }
 
        if( depth > 0 && ch == '{' )
            depth++;
        else if( depth > 0 && ch == '}' )
            depth--;
 
        result += ch;
    }
 
    return result;
}
 
 
// https://www.altium.com/documentation/altium-designer/sch-obj-textstringtext-string-ad#!special-strings
wxString AltiumSchSpecialStringsToKiCadVariables( const wxString&                     aString,
                                                  const std::map<wxString, wxString>& aOverrides,
                                                  std::set<wxString>*                 aUnmapped )
{
    if( aString.IsEmpty() || aString.at( 0 ) != '=' )
        return AltiumEscapeTextVars( aString );
 
    wxString result;
 
    // adjacent quoted fragments are one literal, '$'+'{A}' included
    wxString literal;
 
    size_t start = 1;
    size_t delimiter = 0;
    size_t escaping_start = 0;
    do
    {
        delimiter = aString.find( "+", start );
        escaping_start = aString.find( "'", start );
 
        if( escaping_start < delimiter )
        {
            size_t text_start = escaping_start + 1;
            size_t escaping_end = aString.find( "'", text_start );
 
            if( escaping_end == wxString::npos )
            {
                escaping_end = aString.size();
            }
 
            literal += aString.substr( text_start, escaping_end - text_start );
 
            start = escaping_end + 1;
        }
        else
        {
            wxString specialString =
                    aString.substr( start, delimiter - start ).Trim().Trim( false );
 
            if( specialString.StartsWith( "\"" ) && specialString.EndsWith( "\"" ) )
                specialString = specialString.Mid( 1, specialString.Length() - 2 );
 
            if( !specialString.IsEmpty() )
            {
                // Note: Altium variable references are case-insensitive.  KiCad matches
                // case-sensitive OR to all-upper-case, so make the references all-upper-case.
                specialString.UpperCase();
 
                auto overrideIt = aOverrides.find( specialString );
 
                if( overrideIt != aOverrides.end() )
                    specialString = overrideIt->second;
                else if( aUnmapped )
                    aUnmapped->insert( specialString );
 
                result += AltiumEscapeTextVars( literal ) + wxString::Format( wxT( "${%s}" ), specialString );
                literal.clear();
            }
 
            start = delimiter + 1;
        }
    } while( delimiter != wxString::npos );
 
    result += AltiumEscapeTextVars( literal );
 
    return result;
}
 
 
// https://www.altium.com/documentation/altium-designer/text-objects-pcb
wxString AltiumPcbSpecialStringsToKiCadStrings( const wxString&                     aString,
                                                const std::map<wxString, wxString>& aOverrides,
                                                std::set<wxString>*                 aUnmapped )
{
    if( aString.IsEmpty() )
        return aString;
 
    // Convert a 'special string' to a KiCad variable, substituting any override.
    const auto getVariable = [&]( const wxString& aSpecialString )
    {
        wxString str = aSpecialString;
        str.UpperCase(); // matching is implemented using upper case strings
 
        auto it = aOverrides.find( str );
 
        if( it != aOverrides.end() )
            str = it->second;
        else if( aUnmapped )
            aUnmapped->insert( str );
 
        return wxString::Format( wxT( "${%s}" ), str );
    };
 
    // special case: string starts with dot -> whole string is special string, unless it is an assignment
    if( aString.at( 0 ) == '.' )
    {
        wxString specialString = aString.substr( 1 );
 
        if( specialString.Contains( '=' ) )
            return aString;
 
        return getVariable( specialString );
    }
 
    // Strings can also have one or more special strings using apostrophes to
    // delineate them, e.g. "foo '.bar' '.baz' = '.qux' quux"
 
    // In the common case, the string is a simple string with no special strings,
    // so bail out early.
    if( !aString.Contains( "'." ) )
    {
        return aString;
    }
 
    wxString stringCopy = aString;
 
    // Given a position of a dot, check if it is a special string variable
    // and replace it with a variable name if defined.
    const auto tryReplacement = [&]( wxString& aStr, unsigned aDotPos )
    {
        // Check that the dot has an apostrophe before it, if not, it's just a dot
        if( aDotPos == 0 || aStr.at( aDotPos - 1 ) != '\'' )
            return;
 
        // Scan forward for the next apostrophe
        size_t apostrophePos = aStr.find( '\'', aDotPos + 1 );
 
        // Didn't find it
        if( apostrophePos == wxString::npos )
            return;
 
        // Extract the special string
        wxString specialString = aStr.substr( aDotPos + 1, apostrophePos - aDotPos - 1 );
        wxString replacement = getVariable( specialString );
 
        aStr.replace( aDotPos - 1, apostrophePos - aDotPos + 2, replacement );
    };
 
    // Work backwards through the string checking any dots
    // (so we don't mess up the positions of the dots as we replace them)
    for( size_t pos = stringCopy.size() - 1; pos > 0; --pos )
    {
        if( stringCopy[pos] == '.' )
        {
            tryReplacement( stringCopy, pos );
        }
    }
 
    return stringCopy;
}
 
 
wxString AltiumPinNamesToKiCad( wxString& aString )
{
    if( aString.IsEmpty() )
        return wxEmptyString;
 
    wxString rest;
 
    if( aString.StartsWith( '\\', &rest ) && !rest.Contains( '\\' ) )
        return "~{" + rest + "}";
 
    return AltiumPropertyToKiCadString( aString );
}
 
 
wxString AltiumPinDesignatorToKiCad( const wxString& aDesignator )
{
    wxString designator = aDesignator;
    designator.Trim( true ).Trim( false );
 
    if( !designator.Contains( wxT( "," ) ) )
        return designator;
 
    // Rebuild as KiCad stacked notation "[a,b,c]".  If trimming collapses the list to a
    // single token, emit the bare token so well-formed single designators never get wrapped.
    wxArrayString cleaned;
 
    for( wxString token : wxSplit( designator, ',', '\0' ) )
    {
        token.Trim( true ).Trim( false );
 
        if( !token.IsEmpty() )
            cleaned.Add( EscapeStackedPinItem( token ) );
    }
 
    if( cleaned.IsEmpty() )
        return designator;
 
    if( cleaned.GetCount() == 1 )
        return cleaned[0];
 
    return wxT( "[" ) + wxJoin( cleaned, ',', '\0' ) + wxT( "]" );
}
 
 
VECTOR2I AltiumGetEllipticalPos( double aMajor, double aMinor, double aAngleRadians )
{
    if( aMajor == 0 || aMinor == 0 )
        return VECTOR2I( 0, 0 );
 
    double numerator = aMajor * aMinor;
    double majorTerm = aMajor * sin( aAngleRadians );
    double minorTerm = aMinor * cos( aAngleRadians );
    double denominator = sqrt( majorTerm * majorTerm + minorTerm * minorTerm );
 
    double radius = numerator / denominator;
 
    VECTOR2I retval( KiROUND( radius * cos( aAngleRadians ) ),
                     KiROUND( radius * sin( aAngleRadians ) ) );
 
    return retval;
 
}