From d0d4108085a96f996277e666c047c01541be532b Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Sat, 12 Jul 2014 10:55:50 +0100 Subject: [PATCH] Rename :colalias to :face and update documentation --- README.asciidoc | 67 +++++++++++++++++++++++++++++-------------------- share/kak/kakrc | 20 +++++++-------- src/commands.cc | 16 ++++++------ 3 files changed, 58 insertions(+), 45 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index 954e544c..94b59569 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -588,21 +588,20 @@ and general highlighters are: - * +regex ...+: highlight a regex, takes the regex as first parameter, - followed by any number of color parameters. color format is: - :[,] + * +regex :...+: highlight a regex, takes the regex as + first parameter, followed by any number of face parameters. For example: `:addhl regex //(\h+TODO:)?[^\n]+ 0:cyan 1:yellow,red` will highlight C++ style comments in cyan, with an eventual 'TODO:' in yellow on red background. - * +search +: highlight every matches to the current search pattern. takes - one parameter for the color to apply to highlighted elements. + * +search+: highlight every matches to the current search pattern with the + +Search+ face * +flag_lines +: add a column in front of text, and display the given flag in it for everly lines contained in the int-list option named . * +show_matching+: highlight matching char of the character under the selections - cursor using +MatchingChar+ color alias. + cursor using +MatchingChar+ face. * +number_lines+: show line numbers - * +fill +: fill with given color, mostly useful with region highlighters + * +fill +: fill using given face, mostly useful with region highlighters (see below) Highlighting Groups @@ -814,15 +813,25 @@ with +scope+ being one of +global, buffer or window+ (or any prefix), mode being +insert, normal, prompt or menu+ (or any prefix), +key+ being a single key name and +keys+ a list of keys. -Color Aliases -------------- +Faces +----- -Color aliases give a name to a pair of foreground/background colors, and -can be used in place of them. +A Face refer the how specified text is displayed, a Face has a foreground +color, a background color, and some attributes. --------------------------- -:colalias --------------------------- +Faces can be defined and modified with the face command. + +----------------------- +:face +----------------------- + +Any place requiring a face can take either a face name defined with the +face+ +command or a direct face description (called _facespec_) with the following +syntax: + +-------------------------------- +fg_color[,bg_color][+attributes] +-------------------------------- fg_color and bg_color can be: @@ -832,27 +841,31 @@ fg_color and bg_color can be: not specifying bg_color uses +default+ -In place of ++, another color alias name can be referenced. +attributes is a string of letters each defining an attributes: -Using color alias instead of colorspec permits to change the effective colors + * +u+: Underline + * +r+: Reverse + * +b+: Bold + +Using named faces instead of facespec permits to change the effective faces afterward. -there are some builtins color aliases used by internal Kakoune functionalities: +there are some builtins faces used by internal Kakoune functionalities: - * +PrimarySelection+: main selection color for every selected character except + * +PrimarySelection+: main selection face for every selected character except the cursor - * +SecondarySelection+: secondary selection color for every selected character + * +SecondarySelection+: secondary selection face for every selected character except the cursor * +PrimaryCursor+: cursor of the primary selection * +SecondaryCursor+: cursor of the secondary selection - * +LineNumbers+: colors used by the number_lines highlighter - * +MenuForeground+: colors for the selected element in menus - * +MenuBackground+: colors for the not selected elements in menus - * +Information+: colors the informations windows and information messages - * +Error+: colors of error messages - * +StatusLine+: colors used for the status line - * +StatusCursor+: colors used for the status line cursor - * +Prompt+: colors used prompt displayed on the status line + * +LineNumbers+: face used by the number_lines highlighter + * +MenuForeground+: face for the selected element in menus + * +MenuBackground+: face for the not selected elements in menus + * +Information+: face for the informations windows and information messages + * +Error+: face of error messages + * +StatusLine+: face used for the status line + * +StatusCursor+: face used for the status line cursor + * +Prompt+: face used prompt displayed on the status line Shell expansion --------------- diff --git a/share/kak/kakrc b/share/kak/kakrc index 81ec831b..9ec0eb47 100644 --- a/share/kak/kakrc +++ b/share/kak/kakrc @@ -1,14 +1,14 @@ # define color scheme -colalias value red -colalias type yellow -colalias identifier cyan -colalias string magenta -colalias error default,red -colalias keyword blue -colalias operator yellow -colalias attribute green -colalias comment cyan -colalias macro magenta +face value red +face type yellow +face identifier cyan +face string magenta +face error default,red +face keyword blue +face operator yellow +face attribute green +face comment cyan +face macro magenta def -shell-params runtime %{ %sh{ while [ $# -gt 0 ]; do diff --git a/src/commands.cc b/src/commands.cc index d9756c58..2fb93b7c 100644 --- a/src/commands.cc +++ b/src/commands.cc @@ -1245,20 +1245,20 @@ const CommandDesc try_catch_cmd = { } }; -static Completions complete_colalias(const Context&, CompletionFlags flags, - const String& prefix, ByteCount cursor_pos) +static Completions complete_face(const Context&, CompletionFlags flags, + const String& prefix, ByteCount cursor_pos) { return {0_byte, cursor_pos, FaceRegistry::instance().complete_alias_name(prefix, cursor_pos)}; } -const CommandDesc define_color_alias_cmd = { - "colalias", - "ca", - "colalias : set to refer to color (which can be an alias itself)", +const CommandDesc face_cmd = { + "face", + nullptr, + "face : set face to refer to \n", ParameterDesc{ SwitchMap{}, ParameterDesc::Flags::None, 2, 2 }, CommandFlags::None, - PerArgumentCommandCompleter({ complete_colalias, complete_colalias }), + PerArgumentCommandCompleter({ complete_face, complete_face }), [](const ParametersParser& parser, Context& context) { FaceRegistry::instance().register_alias(parser[0], parser[1], true); @@ -1382,7 +1382,7 @@ void register_commands() register_command(cm, menu_cmd); register_command(cm, info_cmd); register_command(cm, try_catch_cmd); - register_command(cm, define_color_alias_cmd); + register_command(cm, face_cmd); register_command(cm, set_client_name_cmd); register_command(cm, set_register_cmd); register_command(cm, change_working_directory_cmd);