/**
 * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */

/**
 * @module code-block/codeblockconfig
 */

/**
 * The configuration of the {@link module:code-block/codeblock~CodeBlock code block feature}.
 *
 * ```ts
 * ClassicEditor
 * 	.create( {
 * 		attachTo: editorElement,
 * 		codeBlock:  ... // The code block feature configuration.
 * 	} )
 * 	.then( ... )
 * 	.catch( ... );
 * ```
 *
 * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
 */
export interface CodeBlockConfig {

	/**
	 * The list of code languages available in the user interface to choose for a particular code block.
	 *
	 * The language of the code block is represented as a CSS class (by default prefixed by "language-") set on the
	 * `<code>` element, both when editing and in the editor data. The CSS class associated with the language
	 * can be used by third–party code syntax highlighters to detect and apply the correct highlighting.
	 *
	 * For instance, this language configuration:
	 *
	 * ```ts
	 * ClassicEditor
	 * 	.create( {
	 * 		attachTo: document.querySelector( '#editor' ),
	 * 		codeBlock: {
	 * 			languages: [
	 * 				// ...
	 * 				{ language: 'javascript', label: 'JavaScript' },
	 * 				// ...
	 * 			]
	 * 		}
	 * 	} )
	 * 	.then( ... )
	 * 	.catch( ... );
	 * ```
	 *
	 * will result in the following structure of JavaScript code blocks in the editor editing and data:
	 *
	 * ```html
	 * <pre><code class="language-javascript">window.alert( 'Hello world!' )</code></pre>
	 * ```
	 *
	 * You can customize the CSS class by specifying an optional `class` property in the language definition.
	 * You can set **multiple classes** but **only the first one** will be used as defining language class:
	 *
	 * ```ts
	 * ClassicEditor
	 * 	.create( {
	 * 		attachTo: document.querySelector( '#editor' ),
	 * 		codeBlock: {
	 * 			languages: [
	 * 				// Do not render the CSS class for the plain text code blocks.
	 * 				{ language: 'plaintext', label: 'Plain text', class: '' },
	 *
	 * 				// Use the "php-code" class for PHP code blocks.
	 * 				{ language: 'php', label: 'PHP', class: 'php-code' },
	 *
	 * 				// Use the "js" class for JavaScript code blocks.
	 * 				// Note that only the first ("js") class will determine the language of the block when loading data.
	 * 				{ language: 'javascript', label: 'JavaScript', class: 'js javascript js-code' },
	 *
	 * 				// Python code blocks will have the default "language-python" CSS class.
	 * 				{ language: 'python', label: 'Python' }
	 * 			]
	 * 		}
	 * } )
	 * .then( ... )
	 * .catch( ... );
	 * ```
	 *
	 * The default value of the language configuration is as follows:
	 *
	 * ```ts
	 * languages: [
	 * 	{ language: 'plaintext', label: 'Plain text' }, // The default language.
	 * 	{ language: 'c', label: 'C' },
	 * 	{ language: 'cs', label: 'C#' },
	 * 	{ language: 'cpp', label: 'C++' },
	 * 	{ language: 'css', label: 'CSS' },
	 * 	{ language: 'diff', label: 'Diff' },
	 * 	{ language: 'go', label: 'Go' },
	 * 	{ language: 'html', label: 'HTML' },
	 * 	{ language: 'java', label: 'Java' },
	 * 	{ language: 'javascript', label: 'JavaScript' },
	 * 	{ language: 'php', label: 'PHP' },
	 * 	{ language: 'python', label: 'Python' },
	 * 	{ language: 'ruby', label: 'Ruby' },
	 * 	{ language: 'typescript', label: 'TypeScript' },
	 * 	{ language: 'xml', label: 'XML' }
	 * ]
	 * ```
	 *
	 * **Note**: The first language defined in the configuration is considered the default one. This means it will be
	 * applied to code blocks loaded from the data that have no CSS `class` specified (or no matching `class` in the configuration).
	 * It will also be used when creating new code blocks using the main UI button. By default it is "Plain text".
	 */
	languages?: Array<CodeBlockLanguageDefinition>;

	/**
	 * A sequence of characters inserted or removed from the code block lines when its indentation
	 * is changed by the user, for instance, using <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys.
	 *
	 * The default value is a single tab character ("	", `\u0009` in Unicode).
	 *
	 * This configuration is used by `indentCodeBlock` and `outdentCodeBlock` commands (instances of
	 * {@link module:code-block/indentcodeblockcommand~IndentCodeBlockCommand}).
	 *
	 * **Note**: Setting this configuration to `false` will disable the code block indentation commands
	 * and associated keystrokes.
	 *
	 */
	indentSequence?: string;
}

/**
 * The code block language descriptor. See {@link module:code-block/codeblockconfig~CodeBlockConfig#languages} to learn more.
 *
 * ```ts
 * {
 * 	language: 'javascript',
 * 	label: 'JavaScript'
 * }
 * ```
 */
export interface CodeBlockLanguageDefinition {

	/**
	 * The name of the language that will be stored in the model attribute. Also, when `class`
	 * is not specified, it will be used to create the CSS class associated with the language (prefixed by "language-").
	 */
	language: string;

	/**
	 * The human–readable label associated with the language and displayed in the UI.
	 */
	label: string;

	/**
	 * The CSS class associated with the language. When not specified the `language`
 	 * property is used to create a class prefixed by "language-".
	 */
	class?: string;
}

