kicad/common/io/io_utils.h

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

#ifndef IO_UTILS_H
#define IO_UTILS_H

#include <cstdint>
#include <vector>

#include <wx/string.h>

namespace IO_UTILS
{

static const std::vector<uint8_t> COMPOUND_FILE_HEADER{ 0xD0, 0xCF, 0x11, 0xE0, 0xA1, 0xB1, 0x1A, 0xE1};

/**
 * Check if a file starts with a defined string
 * @param aFilePath path to the file where we want to check the prefix
 * @param aPrefix prefix string which should match with the initial characters in the file
 * @param aIgnoreWhitespace true if whitespace characters should be ignored before the prefix
 */
bool fileStartsWithPrefix( const wxString& aFilePath, const wxString& aPrefix, bool aIgnoreWhitespace );

/**
 * Check if a file starts with a defined binary header
 * @param aFilePath path to the file where we want to check the prefix
 * @param aHeader vector of bytes which need to match with the start of the file
 */
bool fileStartsWithBinaryHeader( const wxString& aFilePath, const std::vector<uint8_t>& aHeader );

}


#endif // IO_UTILS_H