kicad/eeschema/edit_label.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2004-2019 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 <fctsys.h>
#include <gr_basic.h>
#include <base_struct.h>
#include <gr_text.h>
#include <sch_draw_panel.h>
#include <confirm.h>
#include <sch_edit_frame.h>
#include <tool/tool_manager.h>
#include <tools/ee_actions.h>
#include <general.h>
#include <sch_text.h>
#include <sch_view.h>

#include <wx/tokenzr.h>

#include "invoke_sch_dialog.h"

static PINSHEETLABEL_SHAPE  lastGlobalLabelShape = PINSHEETLABEL_SHAPE::PS_INPUT;
static LABEL_SPIN_STYLE     lastTextOrientation  = LABEL_SPIN_STYLE::LEFT;
static bool                 lastTextBold = false;
static bool                 lastTextItalic = false;

static std::deque<std::unique_ptr<SCH_TEXT>> s_queuedTexts;

SCH_TEXT* SCH_EDIT_FRAME::GetNextNewText()
{
    if( s_queuedTexts.empty() )
        return nullptr;

    auto next_text = std::move( s_queuedTexts.front() );
    s_queuedTexts.pop_front();

    return next_text.release();
}


SCH_TEXT* SCH_EDIT_FRAME::CreateNewText( int aType )
{
    wxPoint  cursorPos = (wxPoint) GetCanvas()->GetViewControls()->GetCursorPosition();
    SCH_TEXT* textItem = nullptr;

    s_queuedTexts.clear();

    switch( aType )
    {
    case LAYER_NOTES:
        textItem = new SCH_TEXT( cursorPos );
        break;

    case LAYER_LOCLABEL:
        textItem = new SCH_LABEL( cursorPos );
        break;

    case LAYER_HIERLABEL:
        textItem = new SCH_HIERLABEL( cursorPos );
        textItem->SetShape( lastGlobalLabelShape );
        break;

    case LAYER_GLOBLABEL:
        textItem = new SCH_GLOBALLABEL( cursorPos );
        textItem->SetShape( lastGlobalLabelShape );
        break;

    default:
        DisplayError( this, wxT( "SCH_EDIT_FRAME::CreateNewText() Internal error" ) );
        return nullptr;
    }

    textItem->SetBold( lastTextBold );
    textItem->SetItalic( lastTextItalic );
    textItem->SetLabelSpinStyle( lastTextOrientation );
    textItem->SetTextSize( wxSize( GetDefaultTextSize(), GetDefaultTextSize() ) );
    textItem->SetFlags( IS_NEW | IS_MOVED );

    if( InvokeDialogLabelEditor( this, textItem ) != wxID_OK || textItem->GetText().IsEmpty() )
    {
        delete textItem;
        return nullptr;
    }

    if( aType != LAYER_NOTES )
    {
        UTF8 text( textItem->GetText() );
        int  brace_count = 0;
        int  bracket_count = 0;
        bool last_space = false;
        UTF8 token;

        for( auto chIt = text.ubegin(); chIt != text.uend(); chIt++ )
        {
            switch( *chIt )
            {
            case '{':
                brace_count++;
                last_space = false;
                break;

            case '[':
                bracket_count++;
                last_space = false;
                break;

            case '}':
                brace_count = std::max( 0, brace_count - 1 );
                last_space = false;
                break;

            case ']':
                bracket_count = std::max( 0, bracket_count - 1 );
                last_space = false;
                break;

            case ' ':
            case '\n':
            case '\r':
            case '\t':
                if( !token.empty() && bracket_count == 0 && brace_count == 0 )
                {
                    std::unique_ptr<SCH_TEXT> nextitem( static_cast<SCH_TEXT*>( textItem->Clone() ) );
                    nextitem->SetText( token.wx_str() );
                    s_queuedTexts.push_back( std::move( nextitem ) );
                    token.clear();
                    continue;
                }

                // Skip leading whitespace
                if( token.empty() || last_space )
                    continue;

                last_space = true;
                break;

            default:
                last_space = false;
                break;
            }

            token += *chIt;
        }

        if( !token.empty() )
        {
            std::unique_ptr<SCH_TEXT> nextitem( static_cast<SCH_TEXT*>( textItem->Clone() ) );
            nextitem->SetText( token.wx_str() );
            s_queuedTexts.push_back( std::move( nextitem ) );
        }

        delete textItem;
        textItem = GetNextNewText();

        if( !textItem )
            return nullptr;
    }

    lastTextBold = textItem->IsBold();
    lastTextItalic = textItem->IsItalic();
    lastTextOrientation = textItem->GetLabelSpinStyle();

    if( textItem->Type() == SCH_GLOBAL_LABEL_T || textItem->Type() == SCH_HIER_LABEL_T )
        lastGlobalLabelShape = textItem->GetShape();

    return textItem;
}


void SCH_EDIT_FRAME::ConvertTextType( SCH_TEXT* aText, KICAD_T aNewType )
{
    KICAD_T oldType = aText->Type();
    bool    selected = aText->IsSelected();

    wxCHECK_RET( aText->CanIncrementLabel(), "Cannot convert text type." );

    if( oldType == aNewType )
        return;

    SCH_TEXT*        newtext     = nullptr;
    const wxPoint&   position    = aText->GetPosition();
    LABEL_SPIN_STYLE orientation = aText->GetLabelSpinStyle();
    wxString         txt         = UnescapeString( aText->GetText() );

    // There can be characters in a SCH_TEXT object that can break labels so we have to
    // fix them here.
    if( oldType == SCH_TEXT_T )
    {
        txt.Replace( "\n", "_" );
        txt.Replace( "\r", "_" );
        txt.Replace( "\t", "_" );
        txt.Replace( " ", "_" );
    }

    // label strings are "escaped" i.e. a '/' is replaced by "{slash}"
    if( aNewType != SCH_TEXT_T )
        txt = EscapeString( txt, CTX_NETNAME );

    switch( aNewType )
    {
    case SCH_LABEL_T:        newtext = new SCH_LABEL( position, txt );        break;
    case SCH_GLOBAL_LABEL_T: newtext = new SCH_GLOBALLABEL( position, txt );  break;
    case SCH_HIER_LABEL_T:   newtext = new SCH_HIERLABEL( position, txt );    break;
    case SCH_TEXT_T:         newtext = new SCH_TEXT( position, txt );         break;

    default:
        wxFAIL_MSG( wxString::Format( "Invalid text type: %d.", aNewType ) );
        return;
    }

    // Copy the old text item settings to the new one.  Justifications are not copied
    // because they are not used in labels.  Justifications will be set to default value
    // in the new text item type.
    //
    newtext->SetFlags( aText->GetEditFlags() );
    newtext->SetShape( aText->GetShape() );
    newtext->SetLabelSpinStyle( orientation );
    newtext->SetTextSize( aText->GetTextSize() );
    newtext->SetThickness( aText->GetThickness() );
    newtext->SetItalic( aText->IsItalic() );
    newtext->SetBold( aText->IsBold() );
    newtext->SetIsDangling( aText->IsDangling() );

    if( selected )
        m_toolManager->RunAction( EE_ACTIONS::removeItemFromSel, true, aText );

    if( !aText->IsNew() )
    {
        SaveCopyInUndoList( aText, UR_DELETED );
        SaveCopyInUndoList( newtext, UR_NEW, true );

        RemoveFromScreen( aText );
        AddToScreen( newtext );
    }

    if( selected )
        m_toolManager->RunAction( EE_ACTIONS::addItemToSel, true, newtext );

    // Otherwise, pointer is owned by the undo stack
    if( aText->IsNew() )
        delete aText;

    if( aNewType == SCH_TEXT_T )
    {
        if( newtext->IsDangling() )
        {
            newtext->SetIsDangling( false );
            GetCanvas()->GetView()->Update( newtext, KIGFX::REPAINT );
        }
    }
    else
        TestDanglingEnds();

    OnModify();
}


/*
 * Function to increment bus label numbers.  Adds aIncrement to labels which end in numbers.
 */
void IncrementLabelMember( wxString& name, int aIncrement )
{
    int  ii, nn;
    long number = 0;

    ii = name.Len() - 1; nn = 0;

    if( !wxIsdigit( name.GetChar( ii ) ) )
        return;

    while( (ii >= 0) && wxIsdigit( name.GetChar( ii ) ) )
    {
        ii--; nn++;
    }

    ii++;   /* digits are starting at ii position */
    wxString litt_number = name.Right( nn );

    if( litt_number.ToLong( &number ) )
    {
        number += aIncrement;
        name.Remove( ii ); name << number;
    }
}