summaryrefslogtreecommitdiff
path: root/Source/cmSourceGroupCommand.h
diff options
context:
space:
mode:
authorAnas Nashif <anas.nashif@intel.com>2012-10-30 22:39:57 (GMT)
committerAnas Nashif <anas.nashif@intel.com>2012-10-30 22:39:57 (GMT)
commit035c7fabc3b82cbc9a346c11abe2e9462b4c0379 (patch)
tree7e40f5a790eae329a8c5d3e59f046451767956ff /Source/cmSourceGroupCommand.h
downloadcmake-035c7fabc3b82cbc9a346c11abe2e9462b4c0379.zip
cmake-035c7fabc3b82cbc9a346c11abe2e9462b4c0379.tar.gz
cmake-035c7fabc3b82cbc9a346c11abe2e9462b4c0379.tar.bz2
Imported Upstream version 2.8.9upstream/2.8.9
Diffstat (limited to 'Source/cmSourceGroupCommand.h')
-rw-r--r--Source/cmSourceGroupCommand.h81
1 files changed, 81 insertions, 0 deletions
diff --git a/Source/cmSourceGroupCommand.h b/Source/cmSourceGroupCommand.h
new file mode 100644
index 0000000..6a29fc8
--- /dev/null
+++ b/Source/cmSourceGroupCommand.h
@@ -0,0 +1,81 @@
+/*============================================================================
+ 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 cmSourceGroupCommand_h
+#define cmSourceGroupCommand_h
+
+#include "cmCommand.h"
+
+/** \class cmSourceGroupCommand
+ * \brief Adds a cmSourceGroup to the cmMakefile.
+ *
+ * cmSourceGroupCommand is used to define cmSourceGroups which split up
+ * source files in to named, organized groups in the generated makefiles.
+ */
+class cmSourceGroupCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmSourceGroupCommand;
+ }
+
+ /**
+ * 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 "source_group";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Define a grouping for sources in the makefile.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation() const
+ {
+ return
+ " source_group(name [REGULAR_EXPRESSION regex] "
+ "[FILES src1 src2 ...])\n"
+ "Defines a group into which sources will be placed in project files. "
+ "This is mainly used to setup file tabs in Visual Studio. "
+ "Any file whose name is listed or matches the regular expression will "
+ "be placed in this group. If a file matches multiple groups, the LAST "
+ "group that explicitly lists the file will be favored, if any. If no "
+ "group explicitly lists the file, the LAST group whose regular "
+ "expression matches the file will be favored.\n"
+ "The name of the group may contain backslashes to specify subgroups:\n"
+ " source_group(outer\\\\inner ...)\n"
+ "For backwards compatibility, this command is also supports the "
+ "format:\n"
+ " source_group(name regex)";
+ }
+
+ cmTypeMacro(cmSourceGroupCommand, cmCommand);
+};
+
+
+
+#endif