Configuring variables used in a template

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$.

The Edit Template Variables dialog box opens, where you can define how
the variables will be processed when the template is used.

In the Name text box, specify the variable name to be used in the template body.

In the Expression drop-down list, specify the expression to be calculated by
CLion when the template is expanded. Do one of the following:

Type a string constant in double quotes.

Type a predefined function with possible arguments or select one from the drop-down list.

An argument of a function can be either a line constant or another predefined function. See the list of predefined functions below on this page.

To enable CLion to proceed with the next input field, if an input field associated with the
current variable is already defined, select the Skip if defined check box.

To arrange variables in the order you want CLion to switch between associated input fields,
use the Move Up and Move Down buttons.

Predefined functions to use in live template variables

Item

Description

camelCase(String)

Returns the string passed as a parameter, converted to camel case. For example,
my-text-file/my text file/my_text_file will be converted to
myTextFile.

capitalize(String)

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.

Returns CamelCase string out of snake_case string. For example, if the string passed as a parameter is
foo_bar, then the function returns fooBar.

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.

lowercaseAndDash(String)

Returns lower case separated by dashes, of the string passed as a parameter. For example, the string
MyExampleName is converted to my-example-name.

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(sCamelCaseText)

Returns snake_case string out of CamelCase string passed as a parameter.

spaceSeparated(String)

Returns string separated with spaces out of CamelCase string passed as a parameter. For example, if the
string passed as a parameter is fooBar, then the function returns
foo bar.

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.