CLion 1.2 Help

Edit Template Variables Dialog

File | Settings | Live Templates - Edit Variables

The dialog opens when you click the Edit Variables button in the Template Text area on the Live Templates page.

The Edit Variables button is enabled only if the template body contains at least one user-defined variable, that is, a variable different from $END$ or $SELECTION$.

Use this dialog box to create and edit expressions for variables in the selected live template.

On this page:


NameIn this text box, view or edit the variable name in the format $<variable_name>$.
ExpressionIn this text box, specify the expression to have the value of the corresponding template input field calculated automatically.

This expression may contain constructs of the following basic types:

  • String constants in double quotes.
  • The name of another variable defined in a live template.
  • Predefined functions with possible arguments.

Type an expression manually or select a predefined function from the drop-down list. The list shows also the number and type of parameters, if any, for the selected function. The available functions are listed alphabetically in the Functions table.

Default valueIn this text box, specify the default string to be entered in the corresponding input field of the expanded template, if the expression does not give any result after calculation.

Note that a default value of a variable is an expression that can refer to other live template variables. To define the default value as a literal, enclose it in quotation marks.

Skip if definedSelect this check box to have CLion proceed with the next input field, if the value of the current input field is defined.
Move Up / Move DownUse these buttons to change the order of variables in the list. The order of variables in the table determines the order in which CLion will switch between the corresponding input fields when the template is expanded.

Predefined Functions to Use in Live Template Variables

capitalize(sName) Capitalizes the first letter of the name passed as a parameter.
capitalizeAndUnderscore(sCamelCaseName) Capitalizes the all letters of a CamelCase name passed as a parameter, and inserts an underscore between the parts. For example, if the string passed as a parameter is FooBar, then the function returns FOO_BAR.
classNameComplete() This expression substitutes for the class name completion at the variable position.
clipboard() Returns the contents of the system clipboard.
complete()This expression substitutes for the code completion invocation at the variable position.
completeSmart()This expression substitutes for the smart type completion invocation at the variable position.
date(sDate) Returns the current system date in the specified format.

By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:

decapitalize(sName)Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter.
enum(sCompletionString1,sCompletionString2,...)List of comma-delimited strings suggested for completion at the template invocation.
escapeString(sEscapeString)Escapes the specified string.
fileName(sFileName)Returns file name with extension.
fileNameWithoutExtension()Returns file name without extension.
firstWord(sFirstWord)Returns the first word of the string passed as a parameter.
lineNumber()Returns the current line number.
objectWithFunctions(sFunctionName1,sFunctionName2,...) Returns a list of visible objects that contain the member functions, listed as parameters.
rightSideType()Declares the left-side variable with a type of the right-side expression. It is used in the iterations group to have a single template for generating both raw-type and Generics Collections.
snakeCase(sSnakeCaseText) Returns snake_case string out of CamelCase string.
suggestIndexName()Suggests the name of an index variable. Returns i if there is no such variable in scope, otherwise returns j if there is no such variable in scope, etc.
suggestVariableName()Suggests the name for a variable based on the variable type and its initializer expression, according to your code style settings that refer to the variable naming rules.
For example, if it is a variable that holds an element within iteration, CLion makes a guess on the most reasonable names, also taking into account the name of the container being iterated.
suggestFirstVariableName(sFirstVariableName)Doesn't suggest true, false, this, super.
time(sSystemTime)Returns the current system time.
underscoresToCamelCase(sCamelCaseText)Returns the string passed as a parameter with CamelHump letters substituting for underscores. For example, if the string passed as a parameter is foo_bar, then the function returns fooBar.
underscoresToSpaces(sParameterWithSpaces) Returns the string passed as a parameter with spaces substituting for underscores.
user() Returns the name of the current user.
variableForIteration() Returns a variable that is an instance of object used as a range-expression in a loop.
variableForRangeBasedIteration() Returns a variables that is an instance of object that contain begin and end functions.

See Also

Last modified: 10 December 2015