project_file_patch.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 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:
 * http://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 KICAD_DIFF_PROJECT_FILE_PATCH_H
#define KICAD_DIFF_PROJECT_FILE_PATCH_H
 
#include <kicommon.h>
#include <diff_merge/diff_doc_kind.h>
 
#include <nlohmann/json_fwd.hpp>
#include <wx/string.h>
 
#include <optional>
#include <set>
#include <string>
 
 
namespace KICAD_DIFF
{

KICOMMON_API std::optional<std::string> DocPropJsonPointer( const wxString& aDocProp,
                                                            DOC_KIND        aKind );
 
KICOMMON_API std::optional<std::string> DocPropJsonPointer( const wxString& aDocProp );
 

KICOMMON_API bool ApplyProjectFilePatch( nlohmann::json&       aTarget,
                                         const nlohmann::json& aSource,
                                         const wxString&       aDocProp,
                                         DOC_KIND              aKind );
 
KICOMMON_API bool ApplyProjectFilePatch( nlohmann::json&       aTarget,
                                         const nlohmann::json& aSource,
                                         const wxString&       aDocProp );
 

KICOMMON_API bool ApplyProjectFilePatches( const wxString&            aOutputProPath,
                                           const nlohmann::json&      aSource,
                                           const std::set<wxString>&  aDocProps,
                                           DOC_KIND                   aKind );
 
KICOMMON_API bool ApplyProjectFilePatches( const wxString&            aOutputProPath,
                                           const nlohmann::json&      aSource,
                                           const std::set<wxString>&  aDocProps );
 
} // namespace KICAD_DIFF
 
#endif // KICAD_DIFF_PROJECT_FILE_PATCH_H