KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
IO_UTILS Namespace Reference

Functions

bool fileStartsWithPrefix (const wxString &aFilePath, const wxString &aPrefix, bool aIgnoreWhitespace)
 Check if a file starts with a defined string.
 
bool fileStartsWithBinaryHeader (const wxString &aFilePath, const std::vector< uint8_t > &aHeader)
 Check if a file starts with a defined binary header.
 

Variables

const std::vector< uint8_t > COMPOUND_FILE_HEADER
 

Function Documentation

◆ fileStartsWithBinaryHeader()

KICOMMON_API bool IO_UTILS::fileStartsWithBinaryHeader ( const wxString &  aFilePath,
const std::vector< uint8_t > &  aHeader 
)

Check if a file starts with a defined binary header.

Parameters
aFilePathpath to the file where we want to check the prefix
aHeadervector of bytes which need to match with the start of the file

Definition at line 59 of file io_utils.cpp.

Referenced by PCB_IO_ALTIUM_DESIGNER::checkFileHeader(), and SCH_IO_ALTIUM::isBinaryFile().

◆ fileStartsWithPrefix()

KICOMMON_API bool IO_UTILS::fileStartsWithPrefix ( const wxString &  aFilePath,
const wxString &  aPrefix,
bool  aIgnoreWhitespace 
)

Check if a file starts with a defined string.

Parameters
aFilePathpath to the file where we want to check the prefix
aPrefixprefix string which should match with the initial characters in the file
aIgnoreWhitespacetrue if whitespace characters should be ignored before the prefix

Definition at line 34 of file io_utils.cpp.

References text.

Referenced by PCB_IO_PCAD::CanReadBoard(), SCH_IO_KICAD_LEGACY::CanReadLibrary(), SCH_IO_KICAD_LEGACY::CanReadSchematicFile(), PCB_IO_CADSTAR_ARCHIVE::checkBoardHeader(), and SCH_IO_ALTIUM::isASCIIFile().

Variable Documentation

◆ COMPOUND_FILE_HEADER

KICOMMON_API const std::vector< uint8_t > IO_UTILS::COMPOUND_FILE_HEADER
Initial value:
= { 0xD0, 0xCF, 0x11, 0xE0,
0xA1, 0xB1, 0x1A, 0xE1 }

Definition at line 31 of file io_utils.cpp.

Referenced by PCB_IO_ALTIUM_DESIGNER::checkFileHeader(), and SCH_IO_ALTIUM::isBinaryFile().