Rename to ansi_code, initialize components

Co-authored-by: Ian Giestas Pauli <[email protected]>

Author: awvwgk

doc/specs/stdlib_terminal_color.md

@@ -15,9 +15,9 @@ Support terminal escape sequences to produce styled and colored terminal output.
 ## Derived types provided
 
 
-### ``ansi_color`` type
+### ``ansi_code`` type
 
-The ``ansi_color`` type represent an ANSI escape sequence with a style, forground
+The ``ansi_code`` type represent an ANSI escape sequence with a style, forground
 color and background color attribute. By default the instances of this type are
 empty and represent no escape sequence.
 
@@ -29,10 +29,10 @@ Experimental
 
 ```fortran
 program demo_color
-  use stdlib_terminal_colors, only : fg_color_blue, style_bold, style_reset, ansi_color, &
+  use stdlib_terminal_colors, only : fg_color_blue, style_bold, style_reset, ansi_code, &
     & operator(//), operator(+)
   implicit none
-  type(ansi_color) :: highlight, reset
+  type(ansi_code) :: highlight, reset
 
   print '(a)', highlight // "Dull text message" // reset
 
@@ -202,7 +202,7 @@ Pure function.
 
 #### Argument
 
-``code``: Style, foreground or background code of ``ansi_color`` type,
+``code``: Style, foreground or background code of ``ansi_code`` type,
           this argument is ``intent(in)``.
 
 #### Result value
@@ -239,14 +239,14 @@ Pure function.
 
 #### Argument
 
-``lval``: Style, foreground or background code of ``ansi_color`` type,
+``lval``: Style, foreground or background code of ``ansi_code`` type,
           this argument is ``intent(in)``.
-``rval``: Style, foreground or background code of ``ansi_color`` type,
+``rval``: Style, foreground or background code of ``ansi_code`` type,
           this argument is ``intent(in)``.
 
 #### Result value
 
-The result is a style, foreground or background code of ``ansi_color`` type.
+The result is a style, foreground or background code of ``ansi_code`` type.
 
 #### Status
 
@@ -256,9 +256,9 @@ Experimental
 
 ```fortran
 program demo_combine
-  use stdlib_terminal_colors, only : fg_color_red, style_bold, ansi_color
+  use stdlib_terminal_colors, only : fg_color_red, style_bold, ansi_code
   implicit none
-  type(ansi_color) :: bold_red
+  type(ansi_code) :: bold_red
 
   bold_red = fg_color_red + style_bold
 end program demo_combine
@@ -279,9 +279,9 @@ Pure function.
 
 #### Argument
 
-``lval``: Style, foreground or background code of ``ansi_color`` type or a character string,
+``lval``: Style, foreground or background code of ``ansi_code`` type or a character string,
           this argument is ``intent(in)``.
-``rval``: Style, foreground or background code of ``ansi_color`` type or a character string,
+``rval``: Style, foreground or background code of ``ansi_code`` type or a character string,
           this argument is ``intent(in)``.
 
 #### Result value

src/stdlib_terminal_colors.f90

@@ -6,7 +6,7 @@ module stdlib_terminal_colors
     implicit none
     private
 
-    public :: ansi_color
+    public :: ansi_code
     public :: style_reset, style_bold, style_dim, style_italic, style_underline, &
         & style_blink, style_blink_fast, style_reverse, style_hidden, style_strikethrough
     public :: fg_color_black, fg_color_red, fg_color_green, fg_color_yellow, fg_color_blue, &
@@ -19,97 +19,97 @@ module stdlib_terminal_colors
 
 
     !> Container for terminal escape code
-    type :: ansi_color
+    type :: ansi_code
         private
         !> Style descriptor
         integer(i1) :: style = -1_i1
         !> Background color descriptor
         integer(i1) :: bg = -1_i1
         !> Foreground color descriptor
         integer(i1) :: fg = -1_i1
-    end type ansi_color
+    end type ansi_code
 
 
     !> Identifier for reset style
-    type(ansi_color), parameter :: style_reset = ansi_color(style=0)
+    type(ansi_code), parameter :: style_reset = ansi_code(style=0)
     !> Identifier for bold style
-    type(ansi_color), parameter :: style_bold = ansi_color(style=1)
+    type(ansi_code), parameter :: style_bold = ansi_code(style=1)
     !> Identifier for dim style
-    type(ansi_color), parameter :: style_dim = ansi_color(style=2)
+    type(ansi_code), parameter :: style_dim = ansi_code(style=2)
     !> Identifier for italic style
-    type(ansi_color), parameter :: style_italic = ansi_color(style=3)
+    type(ansi_code), parameter :: style_italic = ansi_code(style=3)
     !> Identifier for underline style
-    type(ansi_color), parameter :: style_underline = ansi_color(style=4)
+    type(ansi_code), parameter :: style_underline = ansi_code(style=4)
     !> Identifier for blink style
-    type(ansi_color), parameter :: style_blink = ansi_color(style=5)
+    type(ansi_code), parameter :: style_blink = ansi_code(style=5)
     !> Identifier for (fast) blink style
-    type(ansi_color), parameter :: style_blink_fast = ansi_color(style=6)
+    type(ansi_code), parameter :: style_blink_fast = ansi_code(style=6)
     !> Identifier for reverse style
-    type(ansi_color), parameter :: style_reverse = ansi_color(style=7)
+    type(ansi_code), parameter :: style_reverse = ansi_code(style=7)
     !> Identifier for hidden style
-    type(ansi_color), parameter :: style_hidden = ansi_color(style=8)
+    type(ansi_code), parameter :: style_hidden = ansi_code(style=8)
     !> Identifier for strikethrough style
-    type(ansi_color), parameter :: style_strikethrough = ansi_color(style=9)
+    type(ansi_code), parameter :: style_strikethrough = ansi_code(style=9)
 
     !> Identifier for black foreground color
-    type(ansi_color), parameter :: fg_color_black = ansi_color(fg=0)
+    type(ansi_code), parameter :: fg_color_black = ansi_code(fg=0)
     !> Identifier for red foreground color
-    type(ansi_color), parameter :: fg_color_red = ansi_color(fg=1)
+    type(ansi_code), parameter :: fg_color_red = ansi_code(fg=1)
     !> Identifier for green foreground color
-    type(ansi_color), parameter :: fg_color_green = ansi_color(fg=2)
+    type(ansi_code), parameter :: fg_color_green = ansi_code(fg=2)
     !> Identifier for yellow foreground color
-    type(ansi_color), parameter :: fg_color_yellow = ansi_color(fg=3)
+    type(ansi_code), parameter :: fg_color_yellow = ansi_code(fg=3)
     !> Identifier for blue foreground color
-    type(ansi_color), parameter :: fg_color_blue = ansi_color(fg=4)
+    type(ansi_code), parameter :: fg_color_blue = ansi_code(fg=4)
     !> Identifier for magenta foreground color
-    type(ansi_color), parameter :: fg_color_magenta = ansi_color(fg=5)
+    type(ansi_code), parameter :: fg_color_magenta = ansi_code(fg=5)
     !> Identifier for cyan foreground color
-    type(ansi_color), parameter :: fg_color_cyan = ansi_color(fg=6)
+    type(ansi_code), parameter :: fg_color_cyan = ansi_code(fg=6)
     !> Identifier for white foreground color
-    type(ansi_color), parameter :: fg_color_white = ansi_color(fg=7)
+    type(ansi_code), parameter :: fg_color_white = ansi_code(fg=7)
     !> Identifier for the default foreground color
-    type(ansi_color), parameter :: fg_color_default = ansi_color(fg=9)
+    type(ansi_code), parameter :: fg_color_default = ansi_code(fg=9)
 
     !> Identifier for black background color
-    type(ansi_color), parameter :: bg_color_black = ansi_color(bg=0)
+    type(ansi_code), parameter :: bg_color_black = ansi_code(bg=0)
     !> Identifier for red background color
-    type(ansi_color), parameter :: bg_color_red = ansi_color(bg=1)
+    type(ansi_code), parameter :: bg_color_red = ansi_code(bg=1)
     !> Identifier for green background color
-    type(ansi_color), parameter :: bg_color_green = ansi_color(bg=2)
+    type(ansi_code), parameter :: bg_color_green = ansi_code(bg=2)
     !> Identifier for yellow background color
-    type(ansi_color), parameter :: bg_color_yellow = ansi_color(bg=3)
+    type(ansi_code), parameter :: bg_color_yellow = ansi_code(bg=3)
     !> Identifier for blue background color
-    type(ansi_color), parameter :: bg_color_blue = ansi_color(bg=4)
+    type(ansi_code), parameter :: bg_color_blue = ansi_code(bg=4)
     !> Identifier for magenta background color
-    type(ansi_color), parameter :: bg_color_magenta = ansi_color(bg=5)
+    type(ansi_code), parameter :: bg_color_magenta = ansi_code(bg=5)
     !> Identifier for cyan background color
-    type(ansi_color), parameter :: bg_color_cyan = ansi_color(bg=6)
+    type(ansi_code), parameter :: bg_color_cyan = ansi_code(bg=6)
     !> Identifier for white background color
-    type(ansi_color), parameter :: bg_color_white = ansi_color(bg=7)
+    type(ansi_code), parameter :: bg_color_white = ansi_code(bg=7)
     !> Identifier for the default background color
-    type(ansi_color), parameter :: bg_color_default = ansi_color(bg=9)
+    type(ansi_code), parameter :: bg_color_default = ansi_code(bg=9)
 
 
     interface to_string
         !> Transform a color code into an actual ANSI escape sequence
-        pure module function to_string_ansi_color(code) result(str)
+        pure module function to_string_ansi_code(code) result(str)
             !> Color code to be used
-            type(ansi_color), intent(in) :: code
+            type(ansi_code), intent(in) :: code
             !> ANSI escape sequence representing the color code
             character(len=:), allocatable :: str
-        end function to_string_ansi_color
+        end function to_string_ansi_code
     end interface to_string
 
 
     interface operator(+)
         !> Add two escape sequences, attributes in the right value override the left value ones.
         pure module function add(lval, rval) result(code)
             !> First escape code
-            type(ansi_color), intent(in) :: lval
+            type(ansi_code), intent(in) :: lval
             !> Second escape code
-            type(ansi_color), intent(in) :: rval
+            type(ansi_code), intent(in) :: rval
             !> Combined escape code
-            type(ansi_color) :: code
+            type(ansi_code) :: code
         end function add
     end interface operator(+)
 
@@ -119,7 +119,7 @@ pure module function concat_left(lval, code) result(str)
             !> String to add the escape code to
             character(len=*), intent(in) :: lval
             !> Escape sequence
-            type(ansi_color), intent(in) :: code
+            type(ansi_code), intent(in) :: code
             !> Concatenated string
             character(len=:), allocatable :: str
         end function concat_left
@@ -129,7 +129,7 @@ pure module function concat_right(code, rval) result(str)
             !> String to add the escape code to
             character(len=*), intent(in) :: rval
             !> Escape sequence
-            type(ansi_color), intent(in) :: code
+            type(ansi_code), intent(in) :: code
             !> Concatenated string
             character(len=:), allocatable :: str
         end function concat_right

src/stdlib_terminal_colors_operator.f90

@@ -9,24 +9,23 @@
     !> Add two escape sequences, attributes in the right value override the left value ones.
     pure module function add(lval, rval) result(code)
         !> First escape code
-        type(ansi_color), intent(in) :: lval
+        type(ansi_code), intent(in) :: lval
         !> Second escape code
-        type(ansi_color), intent(in) :: rval
+        type(ansi_code), intent(in) :: rval
         !> Combined escape code
-        type(ansi_color) :: code
+        type(ansi_code) :: code
 
-        code = ansi_color( &
-            style=merge(rval%style, lval%style, rval%style >= 0), &
-            fg=merge(rval%fg, lval%fg, rval%fg >= 0), &
-            bg=merge(rval%bg, lval%bg, rval%bg >= 0))
+        code%style = merge(rval%style, lval%style, rval%style >= 0)
+        code%fg = merge(rval%fg, lval%fg, rval%fg >= 0)
+        code%bg = merge(rval%bg, lval%bg, rval%bg >= 0)
     end function add
 
     !> Concatenate an escape code with a string and turn it into an actual escape sequence
     pure module function concat_left(lval, code) result(str)
         !> String to add the escape code to
         character(len=*), intent(in) :: lval
         !> Escape sequence
-        type(ansi_color), intent(in) :: code
+        type(ansi_code), intent(in) :: code
         !> Concatenated string
         character(len=:), allocatable :: str
 
@@ -38,7 +37,7 @@ pure module function concat_right(code, rval) result(str)
         !> String to add the escape code to
         character(len=*), intent(in) :: rval
         !> Escape sequence
-        type(ansi_color), intent(in) :: code
+        type(ansi_code), intent(in) :: code
         !> Concatenated string
         character(len=:), allocatable :: str
 

src/stdlib_terminal_colors_to_string.f90

@@ -10,9 +10,9 @@
 contains
 
     !> Transform a color code into an actual ANSI escape sequence
-    pure module function to_string_ansi_color(code) result(str)
+    pure module function to_string_ansi_code(code) result(str)
         !> Color code to be used
-        type(ansi_color), intent(in) :: code
+        type(ansi_code), intent(in) :: code
         !> ANSI escape sequence representing the color code
         character(len=:), allocatable :: str
 
@@ -25,12 +25,12 @@ pure module function to_string_ansi_color(code) result(str)
         else
             str = ""
         end if
-    end function to_string_ansi_color
+    end function to_string_ansi_code
 
     !> Check whether the code describes any color or is just a stub
     pure function anycolor(code)
         !> Escape sequence
-        type(ansi_color), intent(in) :: code
+        type(ansi_code), intent(in) :: code
         !> Any color / style is active
         logical :: anycolor