bom_plugins.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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 3
 * 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:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef BOM_GENERATOR_HANDLERS_H
#define BOM_GENERATOR_HANDLERS_H
 
#include <wx/arrstr.h>
#include <wx/file.h>
#include <wx/filename.h>
 
#include <memory>
 
extern const wxChar BOM_TRACE[];

class BOM_GENERATOR_HANDLER
{
public:
    BOM_GENERATOR_HANDLER( const wxString& aFile );

    bool IsOk() { return m_isOk; }

    static bool IsValidGenerator( const wxString& aFile );

    const wxString& GetInfo() const
    {
        return m_info;
    }

    const wxFileName& GetFile() const
    {
        return m_file;
    }
 
    wxString GetStoredPath() const { return m_storedPath; }

    wxFileName FindFilePath() const;

    const wxString& GetName() const
    {
        return m_name;
    }

    void SetName( const wxString& aName )
    {
        m_name = aName;
    }

    const wxString& GetCommand() const
    {
        return m_cmd;
    }

    void SetCommand( const wxString& aCommand )
    {
        m_cmd = aCommand;
    }

    wxArrayString& Options()
    {
        return m_options;
    }
 
protected:
    wxString readHeader( const wxString& aEndSection );

    static wxString getOutputExtension( const wxString& aHeader );

    bool m_isOk;

    wxFileName m_file;

    const wxString m_storedPath;

    wxString m_name;

    wxString m_cmd;

    wxString m_info;

    wxArrayString m_options;
};
 
#endif /* BOM_GENERATOR_HANDLERS_H */