CMake/Source/cmListCommand.h

112 lines
3.7 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.
2006-05-16 16:42:14 +04:00
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 cmListCommand_h
#define cmListCommand_h
#include "cmCommand.h"
/** \class cmListCommand
* \brief Common list operations
*
*/
class cmListCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
2006-05-16 16:42:14 +04:00
virtual cmCommand* Clone()
{
return new cmListCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "list";}
/**
* Succinct documentation.
*/
2006-05-16 16:42:14 +04:00
virtual const char* GetTerseDocumentation()
{
return "List operations.";
}
2006-05-16 16:42:14 +04:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" list(LENGTH <list> <output variable>)\n"
" list(GET <list> <element index> [<element index> ...] "
2006-03-10 21:54:57 +03:00
"<output variable>)\n"
" list(APPEND <list> <element> [<element> ...])\n"
" list(FIND <list> <value> <output variable>)\n"
" list(INSERT <list> <element_index> <element> [<element> ...])\n"
" list(REMOVE_ITEM <list> <value> [<value> ...])\n"
" list(REMOVE_AT <list> <index> [<index> ...])\n"
" list(REVERSE <list>)\n"
" list(SORT <list>)\n"
"LENGTH will return a given list's length.\n"
"GET will return list of elements specified by indices from the list.\n"
2006-05-11 21:56:58 +04:00
"APPEND will append elements to the list.\n"
"FIND will return the index of the element specified in the list or -1 "
"if it wasn't found.\n"
"INSERT will insert elements to the list to the specified location.\n"
2006-03-10 21:54:57 +03:00
"When specifying an index, negative value corresponds to index from the"
" end of the list.\n"
"REMOVE_AT and REMOVE_ITEM will remove items from the list. The "
2006-05-16 16:42:14 +04:00
"difference is that REMOVE_ITEM will remove the given items, while "
"REMOVE_AT will remove the items at the given indices.\n"
"REVERSE reverses the contents of the list in-place.\n"
"SORT sorts the list in-place alphabetically.\n"
;
}
2006-05-16 16:42:14 +04:00
cmTypeMacro(cmListCommand, cmCommand);
protected:
bool HandleLengthCommand(std::vector<std::string> const& args);
bool HandleGetCommand(std::vector<std::string> const& args);
bool HandleAppendCommand(std::vector<std::string> const& args);
bool HandleFindCommand(std::vector<std::string> const& args);
bool HandleInsertCommand(std::vector<std::string> const& args);
bool HandleRemoveAtCommand(std::vector<std::string> const& args);
bool HandleRemoveItemCommand(std::vector<std::string> const& args);
2006-08-22 18:16:46 +04:00
bool HandleSortCommand(std::vector<std::string> const& args);
bool HandleReverseCommand(std::vector<std::string> const& args);
bool GetList(std::vector<std::string>& list, const char* var);
bool GetListString(std::string& listString, const char* var);
};
#endif