CMake/Source/cmCustomCommand.h

95 lines
3.1 KiB
C
Raw Normal View History

/*=========================================================================
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
2002-01-21 23:30:43 +03:00
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmCustomCommand_h
#define cmCustomCommand_h
#include "cmStandardIncludes.h"
/** \class cmCustomCommand
* \brief A class to encapsulate a custom command
*
* cmCustomCommand encapsulates the properties of a custom command
*/
class cmCustomCommand
{
public:
/** Default and copy constructors for STL containers. */
cmCustomCommand();
cmCustomCommand(const cmCustomCommand& r);
/** Main constructor specifies all information for the command. */
cmCustomCommand(const std::vector<std::string>& outputs,
const std::vector<std::string>& depends,
const cmCustomCommandLines& commandLines,
2006-02-08 18:58:36 +03:00
const char* comment,
const char* workingDirectory);
/** Get the output file produced by the command. */
const std::vector<std::string>& GetOutputs() const;
2003-06-03 18:30:23 +04:00
2006-02-08 18:58:36 +03:00
/** Get the working directory. */
const char* GetWorkingDirectory() const;
/** Get the vector that holds the list of dependencies. */
const std::vector<std::string>& GetDepends() const;
/** Get the list of command lines. */
const cmCustomCommandLines& GetCommandLines() const;
/** Get the comment string for the command. */
const char* GetComment() const;
/** Append to the list of command lines. */
void AppendCommands(const cmCustomCommandLines& commandLines);
/** Append to the list of dependencies. */
void AppendDepends(const std::vector<std::string>& depends);
/** Set/Get whether old-style escaping should be used. */
bool GetEscapeOldStyle() const;
void SetEscapeOldStyle(bool b);
/** Set/Get whether the build tool can replace variables in
arguments to the command. */
bool GetEscapeAllowMakeVars() const;
void SetEscapeAllowMakeVars(bool b);
/** Set/Get whether to skip the dependency on the rule itself. */
bool GetSkipRuleDepends() const;
void SetSkipRuleDepends(bool b);
typedef std::pair<cmStdString, cmStdString> ImplicitDependsPair;
class ImplicitDependsList: public std::vector<ImplicitDependsPair> {};
void SetImplicitDepends(ImplicitDependsList const&);
void AppendImplicitDepends(ImplicitDependsList const&);
ImplicitDependsList const& GetImplicitDepends() const;
private:
std::vector<std::string> Outputs;
2006-03-15 19:02:08 +03:00
std::vector<std::string> Depends;
cmCustomCommandLines CommandLines;
bool HaveComment;
2006-03-15 19:02:08 +03:00
std::string Comment;
std::string WorkingDirectory;
bool EscapeAllowMakeVars;
bool EscapeOldStyle;
bool SkipRuleDepends;
ImplicitDependsList ImplicitDepends;
};
#endif