CMake/Source/cmIncludeExternalMSProjectC...

85 lines
2.8 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2002-01-21 23:30:43 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2002-01-21 23:30:43 +03:00
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.
============================================================================*/
2001-10-31 15:03:32 +03:00
#ifndef cmIncludeExternalMSProjectCommand_h
#define cmIncludeExternalMSProjectCommand_h
#include "cmCommand.h"
/** \class cmIncludeExternalMSProjectCommand
* \brief Specify an external MS project file for inclusion in the workspace.
*
2006-05-11 23:50:11 +04:00
* cmIncludeExternalMSProjectCommand is used to specify an externally
* generated Microsoft project file for inclusion in the default workspace
* generated by CMake.
2001-10-31 15:03:32 +03:00
*/
class cmIncludeExternalMSProjectCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
2001-10-31 15:03:32 +03:00
{
return new cmIncludeExternalMSProjectCommand;
}
/**
* 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);
2001-10-31 15:03:32 +03:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const {return "include_external_msproject";}
2001-10-31 15:03:32 +03:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2001-10-31 15:03:32 +03:00
{
return "Include an external Microsoft project file in a workspace.";
}
2001-10-31 15:03:32 +03:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
2001-10-31 15:03:32 +03:00
{
return
" include_external_msproject(projectname location\n"
" [TYPE projectTypeGUID]\n"
" [GUID projectGUID]\n"
" [PLATFORM platformName]\n"
" dep1 dep2 ...)\n"
"Includes an external Microsoft project in the generated workspace "
2008-11-21 22:57:07 +03:00
"file. Currently does nothing on UNIX. This will create a "
"target named [projectname]. This can be used in the add_dependencies "
"command to make things depend on the external project."
"\n"
"TYPE, GUID and PLATFORM are optional parameters that allow one "
"to specify the type of project, id (GUID) of the project and "
"the name of the target platform. "
"This is useful for projects requiring values other than the default "
"(e.g. WIX projects). "
"These options are not supported by the Visual Studio 6 generator.";
2001-10-31 15:03:32 +03:00
}
2001-10-31 15:03:32 +03:00
cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);
};
#endif