summaryrefslogtreecommitdiff
path: root/Source/cmOutputRequiredFilesCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmOutputRequiredFilesCommand.h')
-rw-r--r--Source/cmOutputRequiredFilesCommand.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/Source/cmOutputRequiredFilesCommand.h b/Source/cmOutputRequiredFilesCommand.h
new file mode 100644
index 000000000..85d9095e2
--- /dev/null
+++ b/Source/cmOutputRequiredFilesCommand.h
@@ -0,0 +1,88 @@
+/*============================================================================
+ CMake - Cross Platform Makefile Generator
+ Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
+
+ Distributed under the OSI-approved BSD License (the "License");
+ see accompanying file Copyright.txt for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the License for more information.
+============================================================================*/
+#ifndef cmOutputRequiredFilesCommand_h
+#define cmOutputRequiredFilesCommand_h
+
+#include "cmCommand.h"
+#include "cmMakeDepend.h"
+
+/** \class cmOutputRequiredFilesCommand
+ * \brief Output a list of required files for a source file
+ *
+ */
+class cmOutputRequiredFilesCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmOutputRequiredFilesCommand;
+ }
+
+ /**
+ * This is called when the command is first encountered in
+ * the CMakeLists.txt file.
+ */
+ virtual bool InitialPass(std::vector<std::string> const& args,
+ cmExecutionStatus &status);
+
+ /**
+ * The name of the command as specified in CMakeList.txt.
+ */
+ virtual const char* GetName() const { return "output_required_files";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Deprecated. Approximate C preprocessor dependency scanning.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation() const
+ {
+ return
+ "This command exists only because ancient CMake versions provided it. "
+ "CMake handles preprocessor dependency scanning automatically using a "
+ "more advanced scanner.\n"
+ " output_required_files(srcfile outputfile)\n"
+ "Outputs a list of all the source files that are required by the "
+ "specified srcfile. This list is written into outputfile. This is "
+ "similar to writing out the dependencies for srcfile except that it "
+ "jumps from .h files into .cxx, .c and .cpp files if possible.";
+ }
+
+ /** This command is kept for compatibility with older CMake versions. */
+ virtual bool IsDiscouraged() const
+ {
+ return true;
+ }
+
+
+ cmTypeMacro(cmOutputRequiredFilesCommand, cmCommand);
+ void ListDependencies(cmDependInformation const *info,
+ FILE *fout,
+ std::set<cmDependInformation const*> *visited);
+
+private:
+ std::string File;
+ std::string OutputFile;
+};
+
+
+
+#endif