| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the qmake application of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:GPL-EXCEPT$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef MAKEFILE_H |
| #define MAKEFILE_H |
| |
| #include "option.h" |
| #include "project.h" |
| #include "makefiledeps.h" |
| #include <qtextstream.h> |
| #include <qlist.h> |
| #include <qhash.h> |
| #include <qfileinfo.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| #ifdef Q_OS_WIN32 |
| #define QT_POPEN _popen |
| #define QT_POPEN_READ "rb" |
| #define QT_PCLOSE _pclose |
| #else |
| #define QT_POPEN popen |
| #define QT_POPEN_READ "r" |
| #define QT_PCLOSE pclose |
| #endif |
| |
| struct ReplaceExtraCompilerCacheKey; |
| |
| class MakefileGenerator : protected QMakeSourceFileInfo |
| { |
| QString spec; |
| bool no_io = false; |
| bool resolveDependenciesInFrameworks = false; |
| QHash<QString, bool> init_compiler_already; |
| QString makedir, chkexists; |
| QString fullBuildArgs(); |
| |
| //internal caches |
| mutable QHash<QString, QMakeLocalFileName> depHeuristicsCache; |
| mutable QHash<QString, QStringList> dependsCache; |
| mutable QHash<ReplaceExtraCompilerCacheKey, QString> extraCompilerVariablesCache; |
| |
| public: |
| // We can't make it visible to VCFilter in VS2008 except by making it public or directly friending it. |
| enum ReplaceFor { NoShell, LocalShell, TargetShell }; |
| |
| protected: |
| enum TARG_MODE { TARG_UNIX_MODE, TARG_MAC_MODE, TARG_WIN_MODE } target_mode; |
| |
| ProStringList createObjectList(const ProStringList &sources); |
| |
| //makefile style generator functions |
| void writeObj(QTextStream &, const char *src); |
| void writeInstalls(QTextStream &t, bool noBuild=false); |
| void writeHeader(QTextStream &t); |
| void writeSubDirs(QTextStream &t); |
| void writeMakeQmake(QTextStream &t, bool noDummyQmakeAll = false); |
| void writeExportedVariables(QTextStream &t); |
| void writeExtraVariables(QTextStream &t); |
| void writeExtraTargets(QTextStream &t); |
| QString resolveDependency(const QDir &outDir, const QString &file); |
| void callExtraCompilerDependCommand(const ProString &extraCompiler, |
| const QString &tmp_dep_cmd, const QString &inpf, |
| const QString &tmp_out, bool dep_lines, QStringList *deps, |
| bool existingDepsOnly, |
| bool checkCommandAvailability = false); |
| void writeExtraCompilerTargets(QTextStream &t); |
| void writeExtraCompilerVariables(QTextStream &t); |
| bool writeDummyMakefile(QTextStream &t); |
| virtual bool writeMakefile(QTextStream &t); |
| virtual void writeDefaultVariables(QTextStream &t); |
| |
| QString pkgConfigPrefix() const; |
| QString pkgConfigFileName(bool fixify=true); |
| QString pkgConfigFixPath(QString) const; |
| void writePkgConfigFile(); // for pkg-config |
| |
| //generating subtarget makefiles |
| struct SubTarget |
| { |
| QString name; |
| QString in_directory, out_directory; |
| QString profile, target, makefile; |
| ProStringList depends; |
| }; |
| enum SubTargetFlags { |
| SubTargetInstalls=0x01, |
| SubTargetOrdered=0x02, |
| SubTargetSkipDefaultVariables=0x04, |
| SubTargetSkipDefaultTargets=0x08, |
| |
| SubTargetsNoFlags=0x00 |
| }; |
| QList<MakefileGenerator::SubTarget*> findSubDirsSubTargets() const; |
| void writeSubTargetCall(QTextStream &t, |
| const QString &in_directory, const QString &in, const QString &out_directory, const QString &out, |
| const QString &out_directory_cdin, const QString &makefilein); |
| virtual void writeSubMakeCall(QTextStream &t, const QString &outDirectory_cdin, |
| const QString &makeFileIn); |
| virtual void writeSubTargets(QTextStream &t, QList<SubTarget*> subtargets, int flags); |
| virtual ProStringList extraSubTargetDependencies() { return {}; } |
| |
| //extra compiler interface |
| bool verifyExtraCompiler(const ProString &c, const QString &f); |
| virtual QString replaceExtraCompilerVariables(const QString &, const QStringList &, const QStringList &, ReplaceFor forShell); |
| inline QString replaceExtraCompilerVariables(const QString &val, const QString &in, const QString &out, ReplaceFor forShell) |
| { return replaceExtraCompilerVariables(val, QStringList(in), QStringList(out), forShell); } |
| |
| //interface to the source file info |
| QMakeLocalFileName fixPathForFile(const QMakeLocalFileName &, bool) override; |
| QMakeLocalFileName findFileForDep(const QMakeLocalFileName &, const QMakeLocalFileName &) override; |
| QFileInfo findFileInfo(const QMakeLocalFileName &) override; |
| QMakeProject *project = nullptr; |
| |
| //escape |
| virtual QString escapeFilePath(const QString &path) const = 0; |
| ProString escapeFilePath(const ProString &path) const; |
| QStringList escapeFilePaths(const QStringList &paths) const; |
| ProStringList escapeFilePaths(const ProStringList &paths) const; |
| virtual QString escapeDependencyPath(const QString &path) const; |
| ProString escapeDependencyPath(const ProString &path) const; |
| QStringList escapeDependencyPaths(const QStringList &paths) const; |
| ProStringList escapeDependencyPaths(const ProStringList &paths) const; |
| |
| QStringList finalizeDependencyPaths(const QStringList &paths) const; |
| |
| //initialization |
| void verifyCompilers(); |
| virtual void init(); |
| void initOutPaths(); |
| struct Compiler |
| { |
| QString variable_in; |
| enum CompilerFlag { |
| CompilerNoFlags = 0x00, |
| CompilerBuiltin = 0x01, |
| CompilerNoCheckDeps = 0x02, |
| CompilerRemoveNoExist = 0x04, |
| CompilerAddInputsAsMakefileDeps = 0x08 |
| }; |
| uint flags, type; |
| }; |
| friend class QTypeInfo<Compiler>; |
| |
| void initCompiler(const Compiler &comp); |
| enum VPATHFlag { |
| VPATH_NoFlag = 0x00, |
| VPATH_WarnMissingFiles = 0x01, |
| VPATH_RemoveMissingFiles = 0x02, |
| VPATH_NoFixify = 0x04 |
| }; |
| ProStringList findFilesInVPATH(ProStringList l, uchar flags, const QString &var=""); |
| |
| inline int findExecutable(const QStringList &cmdline) |
| { int ret; canExecute(cmdline, &ret); return ret; } |
| bool canExecute(const QStringList &cmdline, int *argv0) const; |
| inline bool canExecute(const QString &cmdline) const |
| { return canExecute(cmdline.split(' '), nullptr); } |
| |
| bool mkdir(const QString &dir) const; |
| QString mkdir_p_asstring(const QString &dir, bool escape=true) const; |
| |
| QString specdir(); |
| |
| //subclasses can use these to query information about how the generator was "run" |
| QString buildArgs(bool withExtra); |
| |
| virtual QStringList &findDependencies(const QString &file); |
| virtual bool doDepends() const { return Option::mkfile::do_deps; } |
| |
| void filterIncludedFiles(const char *); |
| void processSources() { |
| filterIncludedFiles("SOURCES"); |
| filterIncludedFiles("GENERATED_SOURCES"); |
| } |
| |
| //for installs |
| virtual QString defaultInstall(const QString &); |
| virtual QString installRoot() const; |
| |
| //for prl |
| QString prlFileName(bool fixify=true); |
| void writePrlFile(); |
| bool processPrlFile(QString &, bool baseOnly); |
| virtual void writePrlFile(QTextStream &); |
| |
| //make sure libraries are found |
| virtual bool findLibraries(bool linkPrl, bool mergeLflags); |
| |
| //for retrieving values and lists of values |
| virtual QString var(const ProKey &var) const; |
| QString varGlue(const ProKey &var, const QString &before, const QString &glue, const QString &after) const; |
| QString varList(const ProKey &var) const; |
| QString fixFileVarGlue(const ProKey &var, const QString &before, const QString &glue, const QString &after) const; |
| QString fileVarList(const ProKey &var) const; |
| QString fileVarGlue(const ProKey &var, const QString &before, const QString &glue, const QString &after) const; |
| QString fileVar(const ProKey &var) const; |
| QString depVar(const ProKey &var) const; |
| QString val(const ProStringList &varList) const; |
| QString val(const QStringList &varList) const; |
| QString valGlue(const QStringList &varList, const QString &before, const QString &glue, const QString &after) const; |
| QString valGlue(const ProStringList &varList, const QString &before, const QString &glue, const QString &after) const; |
| QString valList(const QStringList &varList) const; |
| QString valList(const ProStringList &varList) const; |
| |
| QString filePrefixRoot(const QString &, const QString &); |
| |
| enum LibFlagType { LibFlagLib, LibFlagPath, LibFlagFile, LibFlagOther }; |
| virtual LibFlagType parseLibFlag(const ProString &flag, ProString *arg); |
| ProStringList fixLibFlags(const ProKey &var); |
| virtual ProString fixLibFlag(const ProString &lib); |
| |
| public: |
| //file fixification to unify all file names into a single pattern |
| enum FileFixifyType { |
| FileFixifyFromIndir = 0, |
| FileFixifyFromOutdir = 1, |
| FileFixifyToOutDir = 0, |
| FileFixifyToIndir = 2, |
| FileFixifyBackwards = FileFixifyFromOutdir | FileFixifyToIndir, |
| FileFixifyDefault = 0, |
| FileFixifyAbsolute = 4, |
| FileFixifyRelative = 8 |
| }; |
| Q_DECLARE_FLAGS(FileFixifyTypes, FileFixifyType) |
| protected: |
| QString fileFixify(const QString &file, FileFixifyTypes fix = FileFixifyDefault, bool canon = true) const; |
| QStringList fileFixify(const QStringList &files, FileFixifyTypes fix = FileFixifyDefault, bool canon = true) const; |
| |
| QString installMetaFile(const ProKey &replace_rule, const QString &src, const QString &dst); |
| |
| virtual bool processPrlFileBase(QString &origFile, const QStringRef &origName, |
| const QStringRef &fixedBase, int slashOff); |
| bool processPrlFileCore(QString &origFile, const QStringRef &origName, |
| const QString &fixedFile); |
| void createResponseFile(const QString &fileName, const ProStringList &objList); |
| |
| public: |
| QMakeProject *projectFile() const; |
| void setProjectFile(QMakeProject *p); |
| |
| void setNoIO(bool o); |
| bool noIO() const; |
| |
| inline bool exists(QString file) const { return fileInfo(file).exists(); } |
| QFileInfo fileInfo(QString file) const; |
| |
| static MakefileGenerator *create(QMakeProject *); |
| virtual bool write(); |
| virtual bool writeProjectMakefile(); |
| virtual bool supportsMetaBuild() { return true; } |
| virtual bool supportsMergedBuilds() { return false; } |
| virtual bool mergeBuildProject(MakefileGenerator * /*other*/) { return false; } |
| virtual bool openOutput(QFile &, const QString &build) const; |
| bool isWindowsShell() const { return Option::dir_sep == QLatin1String("\\"); } |
| QString shellQuote(const QString &str); |
| virtual ProKey fullTargetVariable() const; |
| }; |
| Q_DECLARE_TYPEINFO(MakefileGenerator::Compiler, Q_MOVABLE_TYPE); |
| Q_DECLARE_OPERATORS_FOR_FLAGS(MakefileGenerator::FileFixifyTypes) |
| |
| inline void MakefileGenerator::setNoIO(bool o) |
| { no_io = o; } |
| |
| inline bool MakefileGenerator::noIO() const |
| { return no_io; } |
| |
| inline QString MakefileGenerator::defaultInstall(const QString &) |
| { return QString(""); } |
| |
| inline QString MakefileGenerator::installRoot() const |
| { return QStringLiteral("$(INSTALL_ROOT)"); } |
| |
| inline bool MakefileGenerator::findLibraries(bool, bool) |
| { return true; } |
| |
| struct ReplaceExtraCompilerCacheKey |
| { |
| mutable uint hash; |
| QString var, in, out, pwd; |
| MakefileGenerator::ReplaceFor forShell; |
| ReplaceExtraCompilerCacheKey(const QString &v, const QStringList &i, const QStringList &o, MakefileGenerator::ReplaceFor s); |
| bool operator==(const ReplaceExtraCompilerCacheKey &f) const; |
| inline uint hashCode() const { |
| if (!hash) |
| hash = (uint)forShell ^ qHash(var) ^ qHash(in) ^ qHash(out) /*^ qHash(pwd)*/; |
| return hash; |
| } |
| }; |
| inline uint qHash(const ReplaceExtraCompilerCacheKey &f) { return f.hashCode(); } |
| |
| QT_END_NAMESPACE |
| |
| #endif // MAKEFILE_H |