lib_id.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
 * Copyright (C) 2012 Wayne Stambaugh <stambaughw@gmail.com>
 * Copyright (C) 2010-2020 KiCad Developers, see change_log.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 _LIB_ID_H_
#define _LIB_ID_H_

#include <richio.h>
#include <utf8.h>

class LIB_ID
{
public:

    enum LIB_ID_TYPE { ID_SCH, ID_PCB };

    LIB_ID() {}

    // NOTE: don't define any constructors which call Parse() on their arguments.  We want it
    // to be obvious to callers that parsing is involved (and that valid IDs are guaranteed in
    // the presence of disallowed characters, malformed ids, etc.).

    LIB_ID( const wxString& aLibName, const wxString& aLibItemName,
            const wxString& aRevision = wxEmptyString );

    int Parse( const UTF8& aId, LIB_ID_TYPE aType, bool aFix = false );

    const UTF8& GetLibNickname() const
    {
        return nickname;
    }

    int SetLibNickname( const UTF8& aNickname );

    const UTF8& GetLibItemName() const { return item_name; }

    const wxString GetUniStringLibItemName() const { return item_name.wx_str(); }

    int SetLibItemName( const UTF8& aLibItemName, bool aTestForRev = true );

    int SetRevision( const UTF8& aRevision );

    const UTF8& GetRevision() const { return revision; }

    UTF8 GetLibItemNameAndRev() const;

    UTF8 Format() const;

    wxString GetUniStringLibId() const
    {
        return Format().wx_str();
    }

    static UTF8 Format( const UTF8& aLibNickname, const UTF8& aLibItemName,
                        const UTF8& aRevision = "" );

    bool IsValid() const { return !nickname.empty() && !item_name.empty(); }

    bool IsLegacy() const { return nickname.empty() && !item_name.empty() && revision.empty(); }

    void clear();

    bool empty() const { return nickname.empty() && item_name.empty() && revision.empty(); }

    int compare( const LIB_ID& aLibId ) const;

    bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
    bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }
    bool operator ==( const LIB_ID& aLibId ) const { return this->compare( aLibId ) == 0; }
    bool operator !=( const LIB_ID& aLibId ) const { return !(*this == aLibId); }

    static int HasIllegalChars( const UTF8& aLibItemName, LIB_ID_TYPE aType );

    static UTF8 FixIllegalChars( const UTF8& aLibItemName, LIB_ID_TYPE aType, bool aLib = false );

    static unsigned FindIllegalLibNicknameChar( const UTF8& aNickname, LIB_ID_TYPE aType );

protected:
    static bool isLegalChar( unsigned aUniChar, LIB_ID_TYPE aType );

    static bool isLegalLibNicknameChar( unsigned aUniChar, LIB_ID_TYPE aType );

    UTF8    nickname;       
    UTF8    item_name;      
    UTF8    revision;       
};


#endif // _LIB_ID_H_