88 lines
2.8 KiB
C++
88 lines
2.8 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
Module: $RCSfile$
|
|
Language: C++
|
|
Date: $Date$
|
|
Version: $Revision$
|
|
|
|
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
|
|
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notices for more information.
|
|
|
|
=========================================================================*/
|
|
#ifndef cmSubdirCommand_h
|
|
#define cmSubdirCommand_h
|
|
|
|
#include "cmCommand.h"
|
|
|
|
/** \class cmSubdirCommand
|
|
* \brief Specify a list of subdirectories to build.
|
|
*
|
|
* cmSubdirCommand specifies a list of subdirectories to process
|
|
* by CMake. For each subdirectory listed, CMake will descend
|
|
* into that subdirectory and process any CMakeLists.txt found.
|
|
*/
|
|
class cmSubdirCommand : public cmCommand
|
|
{
|
|
public:
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
return new cmSubdirCommand;
|
|
}
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool InitialPass(std::vector<std::string> const& args);
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() { return "SUBDIRS";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Add a list of subdirectories to the build.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" SUBDIRS(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n"
|
|
"Add a list of subdirectories to the build. The ADD_SUBDIRECTORY "
|
|
"command should be used instead of SUBDIRS although SUBDIRS will "
|
|
"still work. "
|
|
"This will cause any CMakeLists.txt files in the sub directories "
|
|
"to be processed by CMake. Any directories after the PREORDER flag "
|
|
"are traversed first by makefile builds, the PREORDER flag has no "
|
|
"effect on IDE projects. "
|
|
" Any directories after the EXCLUDE_FROM_ALL marker "
|
|
"will not be included in the top level makefile or project file. "
|
|
"This is useful for having CMake create makefiles or projects for "
|
|
"a set of examples in a project. You would want CMake to "
|
|
"generate makefiles or project files for all the examples at "
|
|
"the same time, but you would not want them to show up in the "
|
|
"top level project or be built each time make is run from the top.";
|
|
}
|
|
|
|
cmTypeMacro(cmSubdirCommand, cmCommand);
|
|
};
|
|
|
|
|
|
|
|
#endif
|