summaryrefslogtreecommitdiffstats
path: root/Source/cmSubdirDependsCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2001-08-01 20:14:16 (GMT)
committerBrad King <brad.king@kitware.com>2001-08-01 20:14:16 (GMT)
commit8a03ccda075da86e9dcfc3ad5286aa0793d87619 (patch)
treead846f627db9aa6206b1d1ca61262dbe0ff2ab6d /Source/cmSubdirDependsCommand.h
parentfda98f856286aa5622e1fc00d7ef32196e04e9b5 (diff)
downloadCMake-8a03ccda075da86e9dcfc3ad5286aa0793d87619.zip
CMake-8a03ccda075da86e9dcfc3ad5286aa0793d87619.tar.gz
CMake-8a03ccda075da86e9dcfc3ad5286aa0793d87619.tar.bz2
ENH: Added SUBDIR_DEPENDS command and corresponding support code. This command allows specification that a set of subdirectories be built before a particular directory.
Diffstat (limited to 'Source/cmSubdirDependsCommand.h')
-rw-r--r--Source/cmSubdirDependsCommand.h105
1 files changed, 105 insertions, 0 deletions
diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h
new file mode 100644
index 0000000..29c235e
--- /dev/null
+++ b/Source/cmSubdirDependsCommand.h
@@ -0,0 +1,105 @@
+/*=========================================================================
+
+ Program: Insight Segmentation & Registration Toolkit
+ Module: $RCSfile$
+ Language: C++
+ Date: $Date$
+ Version: $Revision$
+
+Copyright (c) 2001 Insight Consortium
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+ * The name of the Insight Consortium, nor the names of any consortium members,
+ nor of any contributors, may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ * Modified source versions must be plainly marked as such, and must not be
+ misrepresented as being the original software.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS''
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=========================================================================*/
+#ifndef cmSubdirDependsCommand_h
+#define cmSubdirDependsCommand_h
+
+#include "cmStandardIncludes.h"
+#include "cmCommand.h"
+
+/** \class cmSubdirDependsCommand
+ * \brief Specify a set of subdirectories which must be built before the
+ * given subdirectory.
+ *
+ * cmSubdirDependsCommand specifies for one entry of a SUBDIRS command
+ * a set of the other entries that must be built before it. CMake
+ * will still walk the subdirectories in the order in which they
+ * appear in a SUBDIRS command, but the generated makefiles will be
+ * setup to be sure one directory is finished before another begins.
+ * This allows parallel builds to work correctly.
+ */
+class cmSubdirDependsCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmSubdirDependsCommand;
+ }
+
+ /**
+ * This is called when the command is first encountered in
+ * the CMakeLists.txt file.
+ */
+ virtual bool InitialPass(std::vector<std::string>& args);
+
+ /**
+ * The name of the command as specified in CMakeList.txt.
+ */
+ virtual const char* GetName() { return "SUBDIR_DEPENDS";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation()
+ {
+ return "Add a set of subdirectories on which another subdirectory depends.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation()
+ {
+ return
+ "SUBDIR_DEPENDS(subdir dep1 dep2 ...)\n"
+ "Add a set of subdirectories on which \"subdir\" depends.\n"
+ "This sets up the generated makefiles to build the subdirectries dep1, "
+ "dep2, ... before \"subdir\" itself.";
+ }
+
+ cmTypeMacro(cmSubdirDependsCommand, cmCommand);
+};
+
+
+
+#endif