| /*============================================================================ |
| 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 cmStringCommand_h |
| #define cmStringCommand_h |
| |
| #include "cmCommand.h" |
| |
| class cmMakefile; |
| namespace cmsys |
| { |
| class RegularExpression; |
| } |
| |
| /** \class cmStringCommand |
| * \brief Common string operations |
| * |
| */ |
| class cmStringCommand : public cmCommand |
| { |
| public: |
| /** |
| * This is a virtual constructor for the command. |
| */ |
| virtual cmCommand* Clone() |
| { |
| return new cmStringCommand; |
| } |
| |
| /** |
| * 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); |
| |
| /** |
| * This determines if the command is invoked when in script mode. |
| */ |
| virtual bool IsScriptable() const { return true; } |
| |
| /** |
| * The name of the command as specified in CMakeList.txt. |
| */ |
| virtual const char* GetName() const { return "string";} |
| |
| /** |
| * Succinct documentation. |
| */ |
| virtual const char* GetTerseDocumentation() const |
| { |
| return "String operations."; |
| } |
| |
| /** |
| * More documentation. |
| */ |
| virtual const char* GetFullDocumentation() const |
| { |
| return |
| " string(REGEX MATCH <regular_expression>\n" |
| " <output variable> <input> [<input>...])\n" |
| " string(REGEX MATCHALL <regular_expression>\n" |
| " <output variable> <input> [<input>...])\n" |
| " string(REGEX REPLACE <regular_expression>\n" |
| " <replace_expression> <output variable>\n" |
| " <input> [<input>...])\n" |
| " string(REPLACE <match_string>\n" |
| " <replace_string> <output variable>\n" |
| " <input> [<input>...])\n" |
| " string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512>\n" |
| " <output variable> <input>)\n" |
| " string(COMPARE EQUAL <string1> <string2> <output variable>)\n" |
| " string(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n" |
| " string(COMPARE LESS <string1> <string2> <output variable>)\n" |
| " string(COMPARE GREATER <string1> <string2> <output variable>)\n" |
| " string(ASCII <number> [<number> ...] <output variable>)\n" |
| " string(CONFIGURE <string1> <output variable>\n" |
| " [@ONLY] [ESCAPE_QUOTES])\n" |
| " string(TOUPPER <string1> <output variable>)\n" |
| " string(TOLOWER <string1> <output variable>)\n" |
| " string(LENGTH <string> <output variable>)\n" |
| " string(SUBSTRING <string> <begin> <length> <output variable>)\n" |
| " string(STRIP <string> <output variable>)\n" |
| " string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]\n" |
| " [RANDOM_SEED <seed>] <output variable>)\n" |
| " string(FIND <string> <substring> <output variable> [REVERSE])\n" |
| " string(TIMESTAMP <output variable> [<format string>] [UTC])\n" |
| "REGEX MATCH will match the regular expression once and store the " |
| "match in the output variable.\n" |
| "REGEX MATCHALL will match the regular expression as many times as " |
| "possible and store the matches in the output variable as a list.\n" |
| "REGEX REPLACE will match the regular expression as many times as " |
| "possible and substitute the replacement expression for the match " |
| "in the output. The replace expression may refer to paren-delimited " |
| "subexpressions of the match using \\1, \\2, ..., \\9. Note that " |
| "two backslashes (\\\\1) are required in CMake code to get a " |
| "backslash through argument parsing.\n" |
| "REPLACE will replace all occurrences of match_string in the input with " |
| "replace_string and store the result in the output.\n" |
| "MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 " |
| "will compute a cryptographic hash of the input string.\n" |
| "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and " |
| "store true or false in the output variable.\n" |
| "ASCII will convert all numbers into corresponding ASCII characters.\n" |
| "CONFIGURE will transform a string like CONFIGURE_FILE transforms " |
| "a file.\n" |
| "TOUPPER/TOLOWER will convert string to upper/lower characters.\n" |
| "LENGTH will return a given string's length.\n" |
| "SUBSTRING will return a substring of a given string. If length is " |
| "-1 the remainder of the string starting at begin will be returned.\n" |
| "STRIP will return a substring of a given string with leading " |
| "and trailing spaces removed.\n" |
| "RANDOM will return a random string of given length consisting of " |
| "characters from the given alphabet. Default length is 5 " |
| "characters and default alphabet is all numbers and upper and " |
| "lower case letters. If an integer RANDOM_SEED is given, its " |
| "value will be used to seed the random number generator.\n" |
| "FIND will return the position where the given substring was found " |
| "in the supplied string. If the REVERSE flag was used, the command " |
| "will search for the position of the last occurrence of the " |
| "specified substring.\n" |
| "The following characters have special meaning in regular expressions:\n" |
| " ^ Matches at beginning of input\n" |
| " $ Matches at end of input\n" |
| " . Matches any single character\n" |
| " [ ] Matches any character(s) inside the brackets\n" |
| " [^ ] Matches any character(s) not inside the brackets\n" |
| " - Inside brackets, specifies an inclusive range between\n" |
| " characters on either side e.g. [a-f] is [abcdef]\n" |
| " To match a literal - using brackets, make it the first\n" |
| " or the last character e.g. [+*/-] matches basic\n" |
| " mathematical operators.\n" |
| " * Matches preceding pattern zero or more times\n" |
| " + Matches preceding pattern one or more times\n" |
| " ? Matches preceding pattern zero or once only\n" |
| " | Matches a pattern on either side of the |\n" |
| " () Saves a matched subexpression, which can be referenced \n" |
| " in the REGEX REPLACE operation. Additionally it is saved\n" |
| " by all regular expression-related commands, including \n" |
| " e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).\n" |
| "*, + and ? have higher precedence than concatenation. | has lower " |
| "precedence than concatenation. This means that the regular expression " |
| "\"^ab+d$\" matches \"abbd\" but not \"ababd\", and the regular " |
| "expression \"^(ab|cd)$\" matches \"ab\" but not \"abd\".\n" |
| "TIMESTAMP will write a string representation of " |
| "the current date and/or time to the output variable.\n" |
| "Should the command be unable to obtain a timestamp " |
| "the output variable will be set to the empty string \"\".\n" |
| "The optional UTC flag requests the current date/time " |
| "representation to be in Coordinated Universal Time (UTC) " |
| "rather than local time.\n" |
| "The optional <format string> may contain the following " |
| "format specifiers: \n" |
| " %d The day of the current month (01-31).\n" |
| " %H The hour on a 24-hour clock (00-23).\n" |
| " %I The hour on a 12-hour clock (01-12).\n" |
| " %j The day of the current year (001-366).\n" |
| " %m The month of the current year (01-12).\n" |
| " %M The minute of the current hour (00-59).\n" |
| " %S The second of the current minute.\n" |
| " 60 represents a leap second. (00-60)\n" |
| " %U The week number of the current year (00-53).\n" |
| " %w The day of the current week. 0 is Sunday. (0-6)\n" |
| " %y The last two digits of the current year (00-99)\n" |
| " %Y The current year. \n" |
| "Unknown format specifiers will be ignored " |
| "and copied to the output as-is.\n" |
| "If no explicit <format string> is given it will default to:\n" |
| " %Y-%m-%dT%H:%M:%S for local time.\n" |
| " %Y-%m-%dT%H:%M:%SZ for UTC."; |
| } |
| |
| cmTypeMacro(cmStringCommand, cmCommand); |
| static void ClearMatches(cmMakefile* mf); |
| static void StoreMatches(cmMakefile* mf, cmsys::RegularExpression& re); |
| protected: |
| bool HandleConfigureCommand(std::vector<std::string> const& args); |
| bool HandleAsciiCommand(std::vector<std::string> const& args); |
| bool HandleRegexCommand(std::vector<std::string> const& args); |
| bool RegexMatch(std::vector<std::string> const& args); |
| bool RegexMatchAll(std::vector<std::string> const& args); |
| bool RegexReplace(std::vector<std::string> const& args); |
| bool HandleHashCommand(std::vector<std::string> const& args); |
| bool HandleToUpperLowerCommand(std::vector<std::string> const& args, |
| bool toUpper); |
| bool HandleCompareCommand(std::vector<std::string> const& args); |
| bool HandleReplaceCommand(std::vector<std::string> const& args); |
| bool HandleLengthCommand(std::vector<std::string> const& args); |
| bool HandleSubstringCommand(std::vector<std::string> const& args); |
| bool HandleStripCommand(std::vector<std::string> const& args); |
| bool HandleRandomCommand(std::vector<std::string> const& args); |
| bool HandleFindCommand(std::vector<std::string> const& args); |
| bool HandleTimestampCommand(std::vector<std::string> const& args); |
| |
| class RegexReplacement |
| { |
| public: |
| RegexReplacement(const char* s): number(-1), value(s) {} |
| RegexReplacement(const std::string& s): number(-1), value(s) {} |
| RegexReplacement(int n): number(n), value() {} |
| RegexReplacement() {}; |
| int number; |
| std::string value; |
| }; |
| }; |
| |
| |
| #endif |
