CP Editor – Preferences

Docs: Code Edit

Mon, 01 Jan 0001 00:00:00 +0000

Tab Width

The width (number of characters) of an indent. It is used when displaying the tab characters. It is also used in Auto Indent and Replace tabs by spaces .

Cursor Width

The width of the text cursor in pixels.

Auto Indent

When you start a new line, the new line will have the same indent (i.e. white spaces at the beginning of the line) as the old line.
If the old line ends with {, an extra indent (a tab character or Tab Width spaces, depending on whether Replace tabs by spaces is enabled) will be inserted at the beginning of the new line.

Wrap Text

If a line is too long to fit in a single line, the line will be separated into several lines.

Auto Complete Parentheses

Automatically add the right parenthesis when you type the left one. For example, when you type (, ) will be added.

When the character next to the cursor is a right parenthesis and you type this parenthesis, instead of typing this parenthesis, the cursor will jump out of the parenthesis.

You can choose the parentheses to auto-complete in the Parentheses settings.

Auto Remove Parentheses

When you delete a left parenthesis, if a corresponding right parenthesis is next to it, the right parenthesis will also be deleted.

You can choose the parentheses to auto-remove in the Parentheses settings.

Jump out of a parenthesis by pressing Tab

When the cursor is next to a right parenthesis, you can use the Tab key to jump out of it. If Auto Complete Parentheses is enabled, this is an alternative of typing the right parenthesis.

You can choose the parentheses to jump out by Tab in the Parentheses settings.

Replace tabs by spaces

When you insert an indent, insert spaces instead of a tab character. The number of spaces is equal to the Tab Width .

Note that this won’t replace the existing tab characters. In Auto Indent , the tab characters in the old line will remain in the new line (however, the new indent inserted after { will be spaces).

Docs: Language

Mon, 01 Jan 0001 00:00:00 +0000

General

Default Language

The default programming language. It’s used when opening a new tab and some other places.

Commands

C++ Commands

C++ Compile Command

The compilation command for C++. For example: g++ -Wall.

The command shouldn’t contain the source file and the output file, CP Editor automatically adds them.

For compilation flags, please refer to the manual of the compiler. For example, you may want to add -std=c++14 in the compile command to use C++14.

C++ Executable File Path

The path of the executable file, i.e. the argument of the -o option of the compiler.

If this path is relative, then it’s relative to the source file (if it’s an untitled tab, then relative to the Temporary Directory ).

You can use some place holders for this setting:

${filename}: The complete name of the source file. If it’s an untitled tab (i.e. an unsaved file), the complete file name is sol.cpp.
${basename}: ${filename} without the suffix (i.e. without .cpp, etc.).
${tmpdir} or ${tempdir}: The path of the Temporary Directory .

For example, you can use ${tmpdir}/${basename} if you don’t want to keep the executable files, or executables/${basename} if you want to keep all executable files in the executables directory under the directory of the source file.

C++ Run Arguments

The arguments passed to the program when executing it. It’s usually not needed in competitive programming.

C++ Compiler Output Codec

The text codec of the compiler output (warnings, errors, etc.), used to display the messages from the compiler in CP Editor.

It could be useful if you are using locales for your compiler and the compiler messages are not English.

Java Commands

Java Compile Command

The compilation command for Java. For example: javac.

The command shouldn’t contain the source file and the class path, CP Editor automatically adds them.

Java Class Path

The path to save the class files.

Please refer to C++ Executable File Path for the details.

Java Class Name

The name of the main class of your solution.

You can use an arbitrary name for your source file. When compiling, CP Editor automatically saves your code to a file with the class name.

Java Run Command

The command to run your solution. For example java.

This command shouldn’t contain the class path or the class name, CP Editor automatically adds them.

Java Run Arguments

The arguments passed to the program when executing it. It’s usually not needed in competitive programming.

Java Compiler Output Codec

Please refer to C++ Compiler Output Codec .

Python Commands

Python Run Command

The command to run a python code. It’s usually one of python/python2/python3.

Python Run Arguments

The arguments passed to the program when executing it. It’s usually not needed in competitive programming.

Template

The code template is a file. When opening a new tab, the content of the template will be the initial content in the code editor.

Template Path

The path to the code template.

Template Cursor Position

The initial position of the text cursor when opening the template.

It contains three parts:

Regex
Offset type: start or end.
Offset characters: a number, could be negative.

It works as below:

Find the first match of the regex in the template.
If nothing matches the regex, the cursor will be at the end of the template.
Otherwise, depending on the offset type, the cursor will be at the start/end of the first match, and then moved to the right by the number of the offset characters.

For example, if your template contains the following snippet:

int main()
{

}

Then you can use int main as the regex, end as the offset type, and 9 as the offset characters. After that, when opening a new tab, the cursor will be at the first line in the main function.

Snippets

Manage Snippets

You can add/delete/rename snippets in “Language->XXX->XXX Snippet”. You can use Ctrl+N for “Add”, Ctrl+W for “Del” and F2 for “Rename”.

You can also import snippets from files or extract your snippets to files in the “More” menu on the snippet page.

Use Snippets

You can insert a snippet into the code editor by either clicking “Actions->Use Snippets” or pressing Ctrl+T.

When choosing a snippet, you can enter the first few characters of the snippet name, and it will be auto-completed.

Parentheses

You can set the parentheses settings for each language and each parenthesis.

Each setting has three states: enable, disable and default. If it’s default, it uses the settings in the Code Edit page. Otherwise, it overwrites the settings in the Code Edit page.

Docs: Appearance

Mon, 01 Jan 0001 00:00:00 +0000

General

UI Language

The natural language used in the UI.

UI Style

The style used for the UI. The available options are different on different platforms.

The “default” style is either the most appropriate style on your platform or the style specified by the --style command-line option.

On Windows, there’s an extra option “Auto Fusion”. “Auto Fusion” is either dark or light depending on the system theme (i.e. whether the Windows application theme is dark or light).

If there’s anything wrong after you change the UI style, you can try restarting CP Editor.

Editor Theme

The syntax highlighting theme for the code editor.

Opacity

The opacity of the main window.

Test Case Maximum Height

The maximum height of a test case before the scrollbar occurs.

Show Compile And Run Only

Hide the compile only and run only buttons.

It can be useful if you don’t care about the time used on compilation.

Display EOLN in Diff

Use “¶” to visualize the end-of-line in the diff viewer. It is useful if you want to see differences of the end-of-line (i.e. extra empty lines at the end).

Add extra margin at the bottom of the code editor

Add an extra margin at the bottom of the code editor, so that you can scroll less.

Font

Show only Monospaced Font

When checked the font picker dialog shows only monospaced fonts.

Custom Application Font

Use a custom font for the UI (except for code editor, test cases, messages, etc.), instead of the system font.

Docs: Actions

Mon, 01 Jan 0001 00:00:00 +0000

Save

Save Files Faster

Use QFile instead of QSaveFile to save files.

This is slightly unsafer but notably faster.

Save Testcases on Save

Save the test cases on the disk when saving the code.

You can choose where to save the test cases in File Path/Testcases .

Auto Save

Auto Save Interval Type

It is easier to describe if we explain a little bit about the internal implementation: There is a countdown timer. When we “reset” it, it will be “running” in the next Auto Save Interval milliseconds, and after Auto Save Interval milliseconds, the timer will “timeout” and the code is auto-saved.

After the last modification

The timer is reset whenever you modify the code. i.e. Your codes will be saved if you haven’t modified it for Auto Save Interval milliseconds.

This mode is suitable for a small Auto Save Interval so that your codes will be auto-saved every time you take a short break from typing. If the interval is too long, likely, your codes will never be auto-saved.

After the first modification

The timer is reset when you modify the code if the timer is not running. i.e. Your codes will be saved if you modified it Auto Save Interval milliseconds ago.

This mode is suitable for a long Auto Save Interval, otherwise, it’s likely that the save happens when you are typing, which could affect your typing experience.

Without modification

The timer is reset when it timeouts. i.e. Your codes will be saved every Auto Save Interval milliseconds, no matter you have modified it or not.

This mode is suitable for saving test cases, etc. In the other modes, the test cases are not auto-saved if you don’t modify the codes.

Detached Execution

Terminal Program

Terminal Arguments

This setting is only available on Linux.

The terminal program is the name/path of the terminal emulator you want to use.

The arguments are used to execute a given command. i.e. <Terminal Program> <Terminal Arguments> <command> can be used to execute <command> in the terminal emulator.

In most terminal emulators including konsole, xterm and xfce-terminal, the argument is -e.

In gnome-terminal, it is --.

You can read the manual of your terminal emulator to get the suitable arguments.

Save Session

Restore last session at startup

Save the status of the editor, and restore most status from the last session when you start CP Editor.

You can use the --no-restore-session command-line option to temporarily disable this, in case that the last session is too big and the application hangs.

Auto-save the current session periodically

Save the current session periodically instead of only when exiting the application.

This is useful if you don’t want to lose your codes after abnormal terminations, such as power outage, forced shutdown, killing CP Editor, etc. However, if the files and test cases are too large, the editor hangs each time the auto-save happens.

Bind file and problem

Restore the problem URL when opening a file

If a problem URL was set for a file, when you open that file again, the problem URL will be restored.

Open the old file when parsing an old problem URL

If a problem URL was set for a file, when parsing that problem from Competitive Companion again, the old file will be opened.

Test Cases

Run your codes on empty test cases

Run your code on all non-hidden test cases even if the input is empty.

Check your answer on test cases with empty output

Check your answer even if your output or the expected output is empty.

Auto Uncheck Accepted Testcases

After the code is executed, the accepted test cases will be automatically unchecked. When test cases are unchecked, they are collapsed and won’t be tested on when you execute your code.

Load External File Changes

Auto-load external file changes if there’s no unsaved modification

If the file on the disk and the code in CP Editor was the same, and then the file is changed outside of CP Editor, load the external change without confirmation.

Ask whether to load external file changes

If the file is changed outside of CP Editor, ask whether to load the change or not.

If this setting is disabled, external changes won’t be loaded.

Auto-load external file changes if there’s no unsaved modification overrides this setting. i.e. if Auto-load external file changes if there’s no unsaved modification is enabled, external file changes will be loaded without confirmation regardless of Ask whether to load external file changes ; if Auto-load external file changes if there’s no unsaved modification is disabled, the user will be asked whether to load the changes only when Ask whether to load external file changes is enabled, otherwise the changes won’t be loaded.

Stopwatch

Display Stopwatch

Show a stopwatch in the UI. You can use it to track your time spent on solving a problem.

Start/Stop stopwatch on tab switch

When switching to a different tab, automatically start the stopwatch on the current tab and pause the stopwatch on the previous tab.

If you switch to the correct tab when solving a problem, with this setting enabled, you won’t need to manually start/stop the stopwatch.

Show stopwatch result only when the button is pressed

Hide the time of the stopwatch and only show the time when the “Show” button is pressed.

This may reduce distractions caused by stopwatch updates.

Docs: Extensions

Mon, 01 Jan 0001 00:00:00 +0000

Code Formatting

Clang Format

Clang Format is used to format the C/C++ and Java codes. You can click Actions->Format Code or press the shortcut Ctrl+Shift+I to format the codes. If you have selected a part of the code, only the selection (and its necessary adjacent codes) will be formatted.

See also Setup Clang Format .

Program

The path to the clang-format executable, or simply clang-format if it’s in the PATH environment variable.

Arguments

The arguments passed to clang-format. It should NOT contain -i (the in-place modification option).

Style

The Clang Format style. The content here is the same as the content of a .clang-format file.

You can read Clang-Format Style Options documentation or search for other materials to learn how to write the styles.

YAPF

YAPF is used to format the Python codes. You can click Actions->Format Code or press the shortcut Ctrl+Shift+I to format the codes. If you have selected a part of the code, only these lines will be formatted.

See also Setup YAPF .

Program

The program of YAPF. It could be one of:

yapf: You should be able to run yapf in the command line. The arguments can be empty.
A Python interpreter, i.e. python, python2, etc. or the path to an interpreter. The arguments should be -m yapf.

Note that you need to use Python 2 to format Python 2, use Python 3 to format Python 3 . So you may need to choose the correct Python interpreter.

Arguments

The arguments passed to the YAPF program. This should be -m yapf if the program is a Python interpreter. It should NOT contain -i (the in-place modification option).

Style

The YAPF Format style. The content here is the same as the content of a .style.yapf file. You can check all possible configurations by running yapf --style-help, read the documentation or search for other materials to learn how to write the styles.

Language Server

See also Setup Language Server .

Use Linting with Language Server

Use language server to lint errors, warnings, hints, etc.

You can hover over the squiggles to see the tooltips for the explanation of the errors/warnings.

Delay in Linting

Update linting if you haven’t been typing for delay milliseconds.

Path to LSP executable

The path to the language server program, or the name if it’s in the PATH environment variable.

Arguments for Language Server

Additional arguments for the language server program. See the documentation of the language server program you are using for more information.

For example, if you are using pyls for Python, you probably want to use python as the language server program, and use -m pyls as the arguments.

Competitive Companion

See also Setup Competitive Companion .

Open New Tabs

Open a new tab when a problem is parsed.

If this is disabled, when parsing a problem, the test cases in the current tab will be replaced by the new test cases.

Connection Port

Usually, you don’t have to modify this setting. The default port 10045 is supported by Competitive Companion, so if you are using the default port, you don’t have to add custom ports in Competitive Companion. However, in case of port conflicts, etc., you can change the port and add custom ports in Competitive Companion.

Use the time limit from Competitive Companion

Use the time limit parsed by Competitive Companion as the time limit of the corresponding tab.

Head Comments

The head comments are added at the head of the code when parsing a problem.

Content of the head comments

The content of the head comments. You can use the following place holders:

${time}: The time when the problem was parsed. The time format can be set in Time format for the head comments .
${json.X.Y}: An attribute of the data provided by Competitive Companion. You can read more about the attributes in the documentation of Competitive Companion . For example, ${json.name} is the name of the problem.

Time format for the head comments

The format of the ${time} place holder in the head comments. You can read the Qt documentation for available expressions:

CF Tool

You can use CF Tool to submit your solutions to Codeforces .

To submit a solution, you have to either parse a problem by Competitive Companion from Codeforces or manually set the problem URL of a tab in the context menu of it.

See also Setup CF Tool .

Path

The path to the cf executable file, or simply cf if it’s in the PATH environment variable.

Show toast messages for submission verdicts

Show a toast message when the verdict of a submission is determined.

A toast message is a “system notification”, which is visible outside of CP Editor.

This is useful if you want to get the verdict of the previous problem when reading/solving the next problem.

WakaTime

WakaTime can help you to track your time usage.

See also Setup WakaTime .

Enable WakaTime

Use WakaTime to track your time usage.

Path

The path to the wakatime executable file, or simply wakatime if it’s in the PATH environment variable.

Api Key

Can be found at WakaTime Settings .

It can be empty if you have the global wakatime config file ~/.wakatime.cfg.

Use Proxy

Use Network Proxy to send data to WakaTime.

Docs: File Path

Mon, 01 Jan 0001 00:00:00 +0000

Testcases

Input File Save Path

Answer File Save Path

The path where the test cases are saved . If it is a relative path, it is relative to the source file.

You can use the following place holders:

${filename}: the complete filename
${basename}: the base file name without the suffix
${0-index}: the index of the test case started from 0
${1-index}: the index of the test case started from 1

For example, a test case is the 3-rd test case of the source file /a/b/c.cpp, the place holders are:

${filename}: c.cpp
${basename}: c
${0-index}: 2
${1-index}: 3

If the path is testcases/${basename}-${1-index}.in, the input of this test case will be saved in /a/b/testcases/c-3.in.

Testcases Matching Rules

The rules used to match test cases when loading pairs of test cases.

Each rule is a pair of regular expression patterns . The first regex matches the whole input file name, and the second pattern is a replacement pattern which is the name of the answer file.

For example, you can use (.+)\.in and \1.out to match test-1.in and test-1.out, or use (.+)\.in\.(\d+) and \1.ans.\2 to match test.in.3 and test.ans.3.

When loading pairs of test cases, each rule which matches an input file will be used to try to find the corresponding answer file to the input file.

Problem URL

Default File Path For Problem URLs

The default path when choosing where to save an untitled tab with problem URL.

Each rule is a pair of regular expression patterns . The first regex matches a part of the problem URL, and the second pattern is a replacement pattern which is the default save path.

When saving a file with a problem URL, if the problem URL matches at least one regex in the rules, the default save path will be the replacement of the first matching regex.

Here’s an example of a rule:

The problem URL regex: codeforces.com/contest/([1-9]\d*)/problem/([A-Z][1-9]?)

The file path: /home/username/Codeforces/\1/\2

Default Paths

The default path used when the user is asked for a file path.

There are several actions, different actions can use different default paths.

The user can set multiple default paths, each default path has a name. A default path can be used as a place holder in the default path of an action. When the user chooses a path for an action, several default paths can be set to this path.

For example:

The default path for the action “Save File” is ${file}, and “Save File” changes file and testcase.
The default path for the action “Load Single Test Case” is ${testcase}, and “Load Single Test Case” only changes testcase.
At the beginning, file is /a/b and testcase is /a/c.

You are asked to choose the path for “Load Single Test Case”. The default path is /a/c, and you choose /a/d as the path. Now file is still /a/b, but testcase is changed to /a/d.
You are asked to choose the path for “Save File”. The default path is /a/b, and you choose /a/e as the path. Now both file and testcase are /a/e.
You are asked to choose the path for “Load Single Test Case”. The default path is /a/e because testcase was modified by choosing /a/e for “Save File”.

In the preferences window, the default paths changed by an action is a comma-separated list.

Docs: Key Bindings

Mon, 01 Jan 0001 00:00:00 +0000

You can set custom key bindings for many actions. You can change the key by clicking the edit and press the key you want. You can delete a custom key binding by clicking the button on the right.

Docs: Advanced

Mon, 01 Jan 0001 00:00:00 +0000

Update

Check for updates on startup

When CP Editor starts, checks whether there are new versions of CP Editor.

If there are new versions, a pop-up window will ask you whether to update or not.

Use the beta version

When checking for updates, check for beta versions. The beta versions usually have more features and improvements, but they are not as stable as the stable versions.

Limits

Default Time Limit

The default time limit when executing programs.

The program will be killed if it doesn’t terminate within the time limit.

Output Length Limit

The maximum number of characters in the output of the program.

The program will be killed if either of its stdout or stderr is too long.

Output Display Length Limit

The maximum number of characters to be displayed for the output of the program.

If the output is too long, it will be elided.

Message Length Limit

The maximum number of characters in each message in the top-right corner of the main window.

The message will be elided if it’s too long.

HTML Diff Viewer Length Limit

The maximum number of characters in the HTML Diff Viewer.

The Diff Viewer will fall back to plain text if either of the output or the expected output is too long.

Open File Length Limit

The maximum number of characters in a source file to open.

A source file won’t be opened if it’s too long.

Display Test Case Length Limit

The maximum number of characters in a test case to be displayed.

A test case will be elided and read-only if it’s too long.

Network Proxy

The proxy server used to check for updates.

Docs: General

Mon, 01 Jan 0001 00:00:00 +0000

Temporary Directory

In CP Editor, each file has a temporary directory, it can be used to save the executable files, etc.

You can treat it as a place to safely save something for each tab (i.e. each file) without affecting other files on your disk, and it will be automatically deleted when the tab is closed.

On Linux, it’s /tmp/cpeditor-XXXXXX. On Windows, it’s C:\Users\<username>\AppData\Local\Temp\cpeditor-XXXXXX.

Regular Expression

The regular expression is used to match patterns in a string and find and replace substrings.

You can find many online regex courses, for example https://regexone.com/ .

In CP Editor, you can use \1, \2, etc. for the content of the first/second capture group in the replacement patterns.

CP Editor – Preferences

Docs: Code Edit

Tab Width

Cursor Width

Auto Indent

Wrap Text

Auto Complete Parentheses

Auto Remove Parentheses

Jump out of a parenthesis by pressing Tab

Replace tabs by spaces

Docs: Language

General

Default Language

Commands

C++ Commands

C++ Compile Command

C++ Executable File Path

C++ Run Arguments

C++ Compiler Output Codec

Java Commands

Java Compile Command

Java Class Path

Java Class Name

Java Run Command

Java Run Arguments

Java Compiler Output Codec

Python Commands

Python Run Command

Python Run Arguments

Template

Template Path

Template Cursor Position

Snippets

Manage Snippets

Use Snippets

Parentheses

Auto Complete

Auto Remove

Tab Jump Out

Docs: Appearance

General

UI Language

UI Style

Editor Theme

Opacity

Test Case Maximum Height

Show Compile And Run Only

Display EOLN in Diff

Add extra margin at the bottom of the code editor

Font

Show only Monospaced Font

Custom Application Font

Docs: Actions

Save

Save Files Faster

Save Testcases on Save

Auto Save

Auto Save Interval Type

After the last modification

After the first modification

Without modification

Detached Execution

Terminal Program

Terminal Arguments

Save Session

Restore last session at startup

Auto-save the current session periodically

Bind file and problem

Restore the problem URL when opening a file

Open the old file when parsing an old problem URL

Test Cases

Run your codes on empty test cases

Check your answer on test cases with empty output

Auto Uncheck Accepted Testcases

Load External File Changes

Auto-load external file changes if there’s no unsaved modification

Ask whether to load external file changes

Stopwatch

Display Stopwatch

Start/Stop stopwatch on tab switch