CMake/Source/cmFindLibraryCommand.h

65 lines
1.8 KiB
C
Raw Normal View History

Simplify CMake per-source license notices 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.
2016-09-27 19:01:08 +00:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
2001-01-18 16:20:24 +00:00
#ifndef cmFindLibraryCommand_h
#define cmFindLibraryCommand_h
2016-10-25 18:35:04 +00:00
#include <cmConfigure.h>
#include <string>
#include <vector>
2006-03-02 18:30:22 +00:00
#include "cmFindBase.h"
2016-10-25 18:35:04 +00:00
class cmCommand;
class cmExecutionStatus;
2001-01-18 16:20:24 +00:00
/** \class cmFindLibraryCommand
* \brief Define a command to search for a library.
2001-01-11 13:04:28 +00:00
*
2001-01-18 16:20:24 +00:00
* cmFindLibraryCommand is used to define a CMake variable
* that specifies a library. The command searches for a given
2001-01-11 13:04:28 +00:00
* file in a list of directories.
*/
2006-03-02 18:30:22 +00:00
class cmFindLibraryCommand : public cmFindBase
{
public:
2006-03-02 18:30:22 +00:00
cmFindLibraryCommand();
2001-01-11 13:04:28 +00:00
/**
2001-01-18 16:20:24 +00:00
* This is a virtual constructor for the command.
2001-01-11 13:04:28 +00:00
*/
2016-06-27 19:25:27 +00:00
cmCommand* Clone() CM_OVERRIDE { return new cmFindLibraryCommand; }
2001-01-11 13:04:28 +00:00
/**
2001-01-18 16:20:24 +00:00
* This is called when the command is first encountered in
2001-01-11 13:04:28 +00:00
* the CMakeLists.txt file.
*/
2016-06-27 19:25:27 +00:00
bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus& status) CM_OVERRIDE;
2001-01-11 13:04:28 +00:00
2004-02-23 03:07:02 +00:00
/**
* This determines if the command is invoked when in script mode.
*/
2016-06-27 19:25:27 +00:00
bool IsScriptable() const CM_OVERRIDE { return true; }
2004-02-23 03:07:02 +00:00
2001-01-11 13:04:28 +00:00
/**
2001-01-18 16:20:24 +00:00
* The name of the command as specified in CMakeList.txt.
2001-01-11 13:04:28 +00:00
*/
2016-06-27 19:25:27 +00:00
std::string GetName() const CM_OVERRIDE { return "find_library"; }
2006-03-02 18:30:22 +00:00
protected:
void AddArchitecturePaths(const char* suffix);
void AddArchitecturePath(std::string const& dir,
std::string::size_type start_pos,
const char* suffix, bool fresh = true);
std::string FindLibrary();
private:
std::string FindNormalLibrary();
std::string FindNormalLibraryNamesPerDir();
std::string FindNormalLibraryDirsPerName();
std::string FindFrameworkLibrary();
std::string FindFrameworkLibraryNamesPerDir();
std::string FindFrameworkLibraryDirsPerName();
};
#endif