mirror of
https://github.com/reactos/CMake.git
synced 2025-01-24 20:55:22 +00:00
86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
102 lines
2.5 KiB
C++
102 lines
2.5 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmELF_h
|
|
#define cmELF_h
|
|
|
|
#include <cmConfigure.h>
|
|
|
|
#include <iosfwd>
|
|
#include <string>
|
|
|
|
#if !defined(CMAKE_USE_ELF_PARSER)
|
|
#error "This file may be included only if CMAKE_USE_ELF_PARSER is enabled."
|
|
#endif
|
|
|
|
class cmELFInternal;
|
|
|
|
/** \class cmELF
|
|
* \brief Executable and Link Format (ELF) parser.
|
|
*/
|
|
class cmELF
|
|
{
|
|
public:
|
|
/** Construct with the name of the ELF input file to parse. */
|
|
cmELF(const char* fname);
|
|
|
|
/** Destruct. */
|
|
~cmELF();
|
|
|
|
/** Get the error message if any. */
|
|
std::string const& GetErrorMessage() const { return this->ErrorMessage; }
|
|
|
|
/** Boolean conversion. True if the ELF file is valid. */
|
|
operator bool() const { return this->Valid(); }
|
|
|
|
/** Enumeration of ELF file types. */
|
|
enum FileType
|
|
{
|
|
FileTypeInvalid,
|
|
FileTypeRelocatableObject,
|
|
FileTypeExecutable,
|
|
FileTypeSharedLibrary,
|
|
FileTypeCore,
|
|
FileTypeSpecificOS,
|
|
FileTypeSpecificProc
|
|
};
|
|
|
|
/** Represent string table entries. */
|
|
struct StringEntry
|
|
{
|
|
// The string value itself.
|
|
std::string Value;
|
|
|
|
// The position in the file at which the string appears.
|
|
unsigned long Position;
|
|
|
|
// The size of the string table entry. This includes the space
|
|
// allocated for one or more null terminators.
|
|
unsigned long Size;
|
|
|
|
// The index of the section entry referencing the string.
|
|
int IndexInSection;
|
|
};
|
|
|
|
/** Get the type of the file opened. */
|
|
FileType GetFileType() const;
|
|
|
|
/** Get the number of ELF sections present. */
|
|
unsigned int GetNumberOfSections() const;
|
|
|
|
/** Get the number of DYNAMIC section entries before the first
|
|
DT_NULL. Returns zero on error. */
|
|
unsigned int GetDynamicEntryCount() const;
|
|
|
|
/** Get the position of a DYNAMIC section header entry. Returns
|
|
zero on error. */
|
|
unsigned long GetDynamicEntryPosition(int index) const;
|
|
|
|
/** Read bytes from the file. */
|
|
bool ReadBytes(unsigned long pos, unsigned long size, char* buf) const;
|
|
|
|
/** Get the SONAME field if any. */
|
|
bool GetSOName(std::string& soname);
|
|
StringEntry const* GetSOName();
|
|
|
|
/** Get the RPATH field if any. */
|
|
StringEntry const* GetRPath();
|
|
|
|
/** Get the RUNPATH field if any. */
|
|
StringEntry const* GetRunPath();
|
|
|
|
/** Print human-readable information about the ELF file. */
|
|
void PrintInfo(std::ostream& os) const;
|
|
|
|
private:
|
|
friend class cmELFInternal;
|
|
bool Valid() const;
|
|
cmELFInternal* Internal;
|
|
std::string ErrorMessage;
|
|
};
|
|
|
|
#endif
|