easypc_document.h

Go to the documentation of this file.

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

 
#ifndef EASYPC_DOCUMENT_H
#define EASYPC_DOCUMENT_H
 
#include <map>
#include <memory>
#include <optional>
#include <vector>
 
#include <wx/string.h>
#include <wx/arrstr.h> // for MSVC to see std::vector<wxString> is exported from wx
 
#include <io/easypc/easypc_archive.h>
#include <io/easypc/easypc_classes_project.h>
#include <io/easypc/easypc_file.h>
 
 
namespace EASYPC
{
 
struct DESIGN_DOCUMENT
{
    FILE_KIND                            FileKind = FILE_KIND::PCB_DESIGN;
    DOC_KIND                             Kind = DOC_KIND::PCB;
    std::unique_ptr<OBJECT>              Design; 
    std::vector<std::unique_ptr<OBJECT>> Objects;
    std::vector<uint8_t>                 SummaryInformation; 
};
 
 
struct LIBRARY_STREAM
{
    OBJECT*  Item = nullptr; 
    wxString StreamName;
};
 

struct LIBRARY_ITEM
{
    FILE_KIND                            FileKind = FILE_KIND::PCB_SYMBOL_LIBRARY;
    wxString                             Name;
    std::vector<LIBRARY_STREAM>          Streams; 
    std::vector<std::unique_ptr<OBJECT>> Objects;
};
 
 
struct PROJECT_DOCUMENT
{
    std::unique_ptr<SOURCE_PROJECT>      Project;
    std::vector<std::unique_ptr<OBJECT>> Objects;
};
 
 
struct FILE_INFO
{
    bool                     IsProject = false;
    std::optional<FILE_KIND> FileKind;
};
 

class LIBRARY_FILE
{
public:
    explicit LIBRARY_FILE( const wxString& aPath );

    static long long Timestamp( const wxString& aPath );
 
    FILE_KIND Kind() const { return m_kind; }

    const std::vector<wxString>& ItemNames() const { return m_names; }
    bool                         HasItem( const wxString& aItemName ) const { return m_byName.count( aItemName ) > 0; }

    const std::vector<wxString>& Warnings() const { return m_warnings; }

    std::unique_ptr<LIBRARY_ITEM> LoadItem( const wxString& aItemName ) const;
 
private:
    wxString                            m_path;
    COMPOUND_FILE                       m_file;
    FILE_KIND                           m_kind;
    int32_t                             m_product = PRODUCT_EASYPC;
    std::vector<const SOURCE_FB_ENTRY*> m_entries;
    std::vector<wxString>               m_names;
    std::map<wxString, size_t>          m_byName;
    std::vector<wxString>               m_warnings;
};
 
 
std::unique_ptr<DESIGN_DOCUMENT> LoadDesign( const wxString& aPath );
 
std::unique_ptr<PROJECT_DOCUMENT> LoadProject( const wxString& aPath );

wxString ResolveProjectItem( const wxString& aProjectPath, const wxString& aItemName );

FILE_INFO Probe( const wxString& aPath );
 
} // namespace EASYPC
 
#endif // EASYPC_DOCUMENT_H