CLion 2018.3 Help

Edit Template Variables Dialog

File | Settings | Editor | Live Templates - Edit Variables for Windows and Linux
CLion | Preferences | Editor | Live Templates - Edit Variables for macOS
Ctrl+Alt+S icons general settings svg


The dialog opens when you click Edit Variables in the Template Text area on the Editor | Live Templates page of CLion settings (Ctrl+Alt+S).

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

Controls

Item

Description

Name

In this text box, view or edit the variable name in the format $<variable_name>$.

Expression

In 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 value

In 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 defined

Select this checkbox to have CLion proceed with the next input field, if the value of the current input field is defined.

Move Up / Move Down

Use 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

Item

Description

camelCase(String)

Converts a string into camelCase. For example, camelCase(my-text-file), camelCase(my text file), and camelCase(my_text_file) all return myTextFile.

capitalize(String)

Capitalizes the first letter of the parameter.

capitalizeAndUnderscore(sCamelCaseName)

Capitalizes all the letters of a CamelCase name passed as the parameter, and inserts an underscore between the parts. For example, capitalizeAndUnderscore(FooBar) 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()

Invokes code completion at the position of the variable.

completeSmart()

Invokes smart type completion at the position of the variable.

concat(expressions...)

Returns a concatenation of all the strings passed to the function as parameters.

date(sDate)

Returns the current system date in the specified format.

Without a parameter, the current date is returned in the default system format.

date_format
decapitalize(sName)

Replaces the first letter of the parameter with the corresponding lowercase letter.

defaultReturnValues

Returns the default value if the expression is used in the return statement. Uses the errorVariableName parameter if the expression is of the error type.

enum(sCompletionString1,sCompletionString2,...)

Returns a list of comma-separated strings suggested for completion when the template is expanded.

escapeString(sEscapeString)

Escapes the string specified as the parameter.

fileName()

Returns the name of the current file with its extension.

fileNameWithoutExtension()

Returns the name of the current file without its extension.

firstWord(sFirstWord)

Returns the first word of the string passed as the parameter.

lineNumber()

Returns the current line number.

lowercaseAndDash(String)

Converts a camelCase string into lower case and inserts n-dashes as separators. For example, lowercaseAndDash(MyExampleName) returns my-example-name.

regularExpression(String, Pattern, Replacement)

Makes a replacement in a string according to a specified pattern.

objectWithFunctions(sFunctionName1,sFunctionName2,...)

Returns the list of visible objects that contain 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(String)

Converts a string into snake_case. For example, snakeCase(fooBar) returns foo_bar.

spaceSeparated(String)

Converts a string into lowercase and inserts spaces as separators. For example, spaceSeparated(fooBar) returns foo bar.

spacesToUnderscores(sParameterWithSpaces)

Replaces spaces with underscores in the string passed as the parameter. For example, spacesToUnderscores(foo bar) returns foo_bar.

substringBefore(String,Delimiter)

Removes the extension after the specified delimiter and returns only the file name. This is helpful for test file names (for example, substringBefore($FileName$,".") returns component-test in component-test.js).

suggestFirstVariableName(sFirstVariableName)

Doesn't suggest true, false, this, super.

suggestIndexName()

Suggests the name of an index variable from most commonly used ones: i, j, k, and so on (first one that is not used in the current scope).

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 an iteration, CLion makes a guess on the most reasonable name, taking into account the name of the container being iterated.

time(sSystemTime)

Returns the current system time in the specified format.

underscoresToCamelCase(String)

Replaces underscores with camelCase letters in the string passed as the parameter. For example, underscoresToCamelCase(foo_bar) returns fooBar.

underscoresToSpaces(sParameterWithUnderscores)

Replaces underscores with spaces in the string passed as the parameter. For example, underscoresToSpaces(foo_bar) returns foo bar.

user()

Returns the name of the current user.

variableForIteration()

Returns a variable that is an instance of the object used as a range expression in a loop.

variableForRangeBasedIteration()

Returns a variables that is an instance of the object that contains begin and end functions.

Last modified: 14 February 2019

See Also